View on GitHub

Paymill on rails

Paymill subscriptions with Rails 4.2

Download this project as a .zip file Download this project as a tar.gz file

PaymillOnRails:

Dependency Status

Paymill subscriptions on Rails 4.2 and ruby-2.1.5p273, deployed on Heroku. This code is adapted from Railscast #288 and based on ruby wrapper for the Paymill API gem paymill-ruby. See also Paymill API reference: Paymill API/v2 documentation

Security Standards

Important information for the credit card data in your HTML form:

With the payment form, it is essential that you do not put a name attribute with the <input> tags for credit card data! In this way, the credit card data will not be returned to your server, and you will stay outside the legal provisions concerning the storage of such data (PCI compliance). The only data which Paymill on Rails stores locally infact, are Plans and Subscriptions, which are not sensible and absolutely PCI compliant.

See current Paymill on Rails data model 

  ActiveRecord::Schema.define(version: 20121207103300) do

    create_table "plans", force: true do |t|
      t.string "paymill_id"
      t.string "name"
      t.float "price"
      t.datetime "created_at"
      t.datetime "updated_at"
    end

    create_table "subscriptions", force: true do |t|
      t.integer "plan_id"
      t.string "email"
      t.string "name"
      t.string "paymill_id"
      t.datetime "created_at"
      t.datetime "updated_at"
    end

  end

For further reading see also payment form and security standards

Usage

Since the release of paymillonrails gem 0.1.1, PaymillOnRails becomes a Mountable Rails Engine for Rails 4.1.X. Set up a subscription payment integrating it with your existing Rails application service is now very simple just following nex steps:

1) register for a test account at paymill.com and create the subscription plans, also called Offers (read more, which are how Subscription Plans are called in Paymill.
2) build a new Rails app from scratch (or use your existing one) :
  $ rails new myapp && cd myapp
  $ echo "gem 'paymill_on_rails'" >> Gemfile
  $ bundle update
  $ rake paymill_on_rails:install:migrations
  $ rake db:migrate
3) now mount the engine adding the following to config/routes.rb :
  Myapp::Application.routes.draw do
     root 'paymill_on_rails/plans#index' #(or use another path)
     mount PaymillOnRails::Engine => "/paymill_on_rails"
  end
4) Login in with your Paymill account and follow Dasboard --> My Account --> Settings --> APY Keys, to see your keys and set PAYMILLPUBLICKEY/API_KEY accordingly.
5) set OS env variables, with your own paymill test keys :
   $ env | grep _KEY
   PAYMILL_PUBLIC_KEY=11111111111111111111111
   API_KEY=a1b2c3d4e5f6g7h8i9l1i2m3
6) get the plans and their IDs from paymill :
    $ rake paymill_on_rails:import_plans
7) That's it! Run $ rails server and it should work.

Deploy on Heroku

In your rails app run 

   # if new rails app (not initialized by git) 

   $ git init
   $ git add .
   $ git commit -am "first commit"

   # then create & push on Heroku

   $ heroku create
   $ heroku config:add BUNDLE_WITHOUT="development:test"
   $ git push heroku master

   # set up le DB & import Paymill's plans

   $ heroku rake db:migrate
   $ heroku rake paymill_on_rails:import_plans

   # set up Heroku environment variables

   $ heroku config:add API_KEY='your-own-api-key'
   $ heroku config:add PAYMILL_PUBLIC_KEY='your-own-public-key'

Current Bundle

PATH
  remote: .
  specs:
    paymill_on_rails (0.2.0)
      paymill (~> 0.5.1)
      rails (~> 4.2)
      sqlite3

GEM
  remote: https://rubygems.org/
  specs:
    actionmailer (4.2.0)
      actionpack (= 4.2.0)
      actionview (= 4.2.0)
      activejob (= 4.2.0)
      mail (~> 2.5, >= 2.5.4)
      rails-dom-testing (~> 1.0, >= 1.0.5)
    actionpack (4.2.0)
      actionview (= 4.2.0)
      activesupport (= 4.2.0)
      rack (~> 1.6.0)
      rack-test (~> 0.6.2)
      rails-dom-testing (~> 1.0, >= 1.0.5)
      rails-html-sanitizer (~> 1.0, >= 1.0.1)
    actionview (4.2.0)
      activesupport (= 4.2.0)
      builder (~> 3.1)
      erubis (~> 2.7.0)
      rails-dom-testing (~> 1.0, >= 1.0.5)
      rails-html-sanitizer (~> 1.0, >= 1.0.1)
    activejob (4.2.0)
      activesupport (= 4.2.0)
      globalid (>= 0.3.0)
    activemodel (4.2.0)
      activesupport (= 4.2.0)
      builder (~> 3.1)
    activerecord (4.2.0)
      activemodel (= 4.2.0)
      activesupport (= 4.2.0)
      arel (~> 6.0)
    activesupport (4.2.0)
      i18n (~> 0.7)
      json (~> 1.7, >= 1.7.7)
      minitest (~> 5.1)
      thread_safe (~> 0.3, >= 0.3.4)
      tzinfo (~> 1.1)
    arel (6.0.0)
    builder (3.2.2)
    erubis (2.7.0)
    globalid (0.3.0)
      activesupport (>= 4.1.0)
    hike (1.2.3)
    i18n (0.7.0)
    json (1.8.1)
    loofah (2.0.1)
      nokogiri (>= 1.5.9)
    mail (2.6.3)
      mime-types (>= 1.16, < 3)
    mime-types (2.4.3)
    mini_portile (0.6.1)
    minitest (5.5.0)
    multi_json (1.10.1)
    nokogiri (1.6.5)
      mini_portile (~> 0.6.0)
    paymill (0.5.1)
      json
    rack (1.6.0)
    rack-test (0.6.2)
      rack (>= 1.0)
    rails (4.2.0)
      actionmailer (= 4.2.0)
      actionpack (= 4.2.0)
      actionview (= 4.2.0)
      activejob (= 4.2.0)
      activemodel (= 4.2.0)
      activerecord (= 4.2.0)
      activesupport (= 4.2.0)
      bundler (>= 1.3.0, < 2.0)
      railties (= 4.2.0)
      sprockets-rails
    rails-deprecated_sanitizer (1.0.3)
      activesupport (>= 4.2.0.alpha)
    rails-dom-testing (1.0.5)
      activesupport (>= 4.2.0.beta, < 5.0)
      nokogiri (~> 1.6.0)
      rails-deprecated_sanitizer (>= 1.0.1)
    rails-html-sanitizer (1.0.1)
      loofah (~> 2.0)
    railties (4.2.0)
      actionpack (= 4.2.0)
      activesupport (= 4.2.0)
      rake (>= 0.8.7)
      thor (>= 0.18.1, < 2.0)
    rake (10.4.2)
    sprockets (2.12.3)
      hike (~> 1.2)
      multi_json (~> 1.0)
      rack (~> 1.0)
      tilt (~> 1.1, != 1.3.0)
    sprockets-rails (2.2.2)
      actionpack (>= 3.0)
      activesupport (>= 3.0)
      sprockets (>= 2.8, < 4.0)
    sqlite3 (1.3.10)
    thor (0.19.1)
    thread_safe (0.3.4)
    tilt (1.4.1)
    tzinfo (1.2.2)
      thread_safe (~> 0.1)

PLATFORMS
  ruby

DEPENDENCIES
  paymill_on_rails!

Related works

See apalancat gem paymill-rails. More in general see the Search repository results on github.

Copyright

(The MIT License)

Copyright (c) 2013 Luca G. Soave

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.