lolita-paypal 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 09da372aaf3d0b64e4a10fd10afe861747fe7cdb
+  data.tar.gz: 8e41057f08152f4ca1b85027f1392ac97c46d26d
+SHA512:
+  metadata.gz: 6f9fed96e82014183fca3425ad51dd5855d5991ec844081bb375832e2707545e9f0ef58b98ebcbbe6f244f42a9f6b5ab87fdb6ae1b73aa566f9b47d9e76fcd4a
+  data.tar.gz: cdfcfcb5b5e2a2afc027d19d832491e8fca3f742a82d2f7de480efa39549b744b7546dc89667bb43d2c79c73cfbd447fe08ad2655c5566730a73c9f789ef8701

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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.

data/README.md

@@ -0,0 +1,17 @@
+# LolitaPaypal
+
+Paypal plugin for Lolita
+
+## Usage
+
+Add to your Gemfile `gem "lolita-paypal"`
+
+Then run generator `rails g lolita_paypal`
+
+To setup your paymentable object see `spec/dummy/app/models/reservation.rb`
+
+## ENV variables
+
+    PAYPAL_CERT_PEM: ~/production/shared/config/paypal_cert.pem"
+    PAYPAL_APP_CERT_PEM: ~/production/shared/config/my-pubcert.pem"
+    PAYPAL_APP_KEY_PEM: ~/production/shared/config/my-key.pem

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+Bundler::GemHelper.install_tasks

data/app/controllers/lolita_paypal/application_controller.rb

@@ -0,0 +1,5 @@
+module LolitaPaypal
+  class ApplicationController < ActionController::Base
+    skip_before_filter :verify_authenticity_token
+  end
+end

data/app/controllers/lolita_paypal/transactions_controller.rb

@@ -0,0 +1,74 @@
+module LolitaPaypal
+  class TransactionsController < LolitaPaypal::ApplicationController
+    protect_from_forgery except: :answer
+    before_filter :is_ssl_required
+    before_filter :set_active_payment, :check_valid_payment, only: :checkout
+
+    include ActiveMerchant::Billing::Integrations
+
+    # renders form with encrypted data and redirects to Paypal web interface
+    def checkout
+      @payment_request = LolitaPaypal::Request.new(@payment)
+      render 'lolita_paypal/payment_form'
+    ensure
+      LolitaPaypal.logger.info("[#{session_id}][#{@payment.id}][checkout]")
+    end
+
+    # process ipn request
+    # POST is sent from paypal and will create transaction
+    # GET is a redirect from paypal and will redirect back to return_path
+    def answer
+      if request.post?
+        if ipn_notify.acknowledge
+          LolitaPaypal::Transaction.create_transaction(ipn_notify, payment_from_ipn, request)
+        end
+        render nothing: true
+      else
+        if payment_from_ipn
+          redirect_to payment_from_ipn.paypal_return_path
+        else
+          render text: I18n.t('lolita_paypal.wrong_request'), status: 400
+        end
+      end
+    ensure
+      LolitaPaypal.logger.info("[#{session_id}][#{payment_from_ipn && payment_from_ipn.id}][answer] #{params}")
+    end
+
+    private
+
+    def ipn_notify
+      @ipn_notify ||= Paypal::Notification.new(request.raw_post)
+    end
+
+    def payment_from_ipn
+      if subject = params['custom'] || params['cm']
+        klass, id = subject.split('___')
+        payment = klass.constantize.find(id)
+      end
+    end
+
+    # returns current payment instance from session
+    def set_active_payment
+      @payment ||= session[:payment_data][:billing_class].constantize.find(session[:payment_data][:billing_id])
+    rescue
+      render text: I18n.t('lolita_paypal.wrong_request'), status: 400
+    end
+
+    # payment should not be paid
+    def check_valid_payment
+      if @payment.paid?
+        render text: I18n.t('lolita_paypal.wrong_request'), status: 400
+      end
+    end
+
+    # forces SSL in production mode if availab:le
+    def is_ssl_required
+      ssl_required(:answer, :checkout) if defined?(ssl_required)
+    end
+
+
+    def session_id
+      request.session_options[:id]
+    end
+  end
+end

data/app/helpers/lolita_paypal/application_helper.rb

@@ -0,0 +1,15 @@
+module LolitaPaypal
+  module ApplicationHelper
+    include Rails.application.routes.url_helpers
+
+    # returns encrypted request variables
+    def encrypt_request(payment_request)
+      variables = payment_request.request_variables.reverse_merge({
+        'notify_url'=> answer_paypal_url(protocol: 'https')
+      })
+      LolitaPaypal::Request.encrypt_for_paypal variables
+    ensure
+      LolitaPaypal.logger.info "[#{payment_request.payment_id}] #{variables}"
+    end
+  end
+end

data/app/models/lolita_paypal/transaction.rb

@@ -0,0 +1,49 @@
+require "ipaddr"
+# Available statuses
+# -----------------
+# Canceled-Reversal
+# Completed
+# Denied
+# Expired
+# Failed
+# In-Progress
+# Partially-Refunded
+# Pending
+# Processed
+# Refunded
+# Reversed
+# Voided
+module LolitaPaypal
+  class Transaction < ActiveRecord::Base
+    self.table_name = "paypal_transactions"
+    belongs_to :paymentable, polymorphic: true
+    after_save :touch_paymentable
+    default_scope -> { order(:id) }
+    validates_associated :paymentable
+
+    def ip
+      IPAddr.new(self[:ip], Socket::AF_INET).to_s
+    end
+
+    def ip=(x)
+      self[:ip] = IPAddr.new(x).to_i
+    end
+
+    # add new transaction after IPN response
+    def self.create_transaction notify, payment, request
+      self.create!(
+        transaction_id: notify.transaction_id,
+        status: notify.status,
+        paymentable: payment,
+        ip: request.remote_ip
+      )
+    end
+
+    private
+
+    # trigger "paypal_trx_saved" on our paymentable model
+    def touch_paymentable
+      paymentable.paypal_trx_saved(self)
+    end
+  end
+end

data/app/views/lolita_paypal/payment_form.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <title>Paypal payment</title>
+  </head>
+<body>
+  <form method="POST" name="paypal_form" action="<%= ActiveMerchant::Billing::Integrations::Paypal.service_url %>">
+    <input type="hidden" name="cmd" value="_s-xclick" />
+    <input type="hidden" name="encrypted" value="<%= encrypt_request(@payment_request) %>" />
+    <button type="submit" id="submit_button" name="submit" style="display:none;"></button>
+  </form>
+  <script type="text/javascript">
+    document.getElementById("submit_button").click();
+  </script>
+</body>
+</html>

data/config/locales/en.yml

@@ -0,0 +1,3 @@
+en:
+  lolita_paypal:
+    wrong_request: Wrong request

data/config/locales/lv.yml

@@ -0,0 +1,3 @@
+lv:
+  lolita_paypal:
+    wrong_request: Nepareizs pieprasījums

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  get "/paypal/checkout" => "lolita_paypal/transactions#checkout", as: "checkout_paypal"
+  get "/paypal/answer" => "lolita_paypal/transactions#answer", as: "answer_paypal"
+  post "/paypal/answer" => "lolita_paypal/transactions#answer"
+end

data/lib/generators/lolita_paypal/USAGE

@@ -0,0 +1,4 @@
+Run
+=============
+
+rails generate lolita_paypal

data/lib/generators/lolita_paypal/lolita_paypal_generator.rb

@@ -0,0 +1,12 @@
+class LolitaPaypalGenerator < Rails::Generator::Base
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if @args.first == "help"
+  end
+
+  def manifest
+    record do |m|
+      m.migration_template "paypal_transactions.erb", "db/migrate", :migration_file_name => "create_paypal_transactions"
+    end
+  end
+end

data/lib/generators/lolita_paypal/templates/paypal_transactions.erb

@@ -0,0 +1,17 @@
+class CreatePaypalTransactions < ActiveRecord::Migration
+  def self.up
+    create_table :paypal_transactions do |t|
+      t.string   :transaction_id
+      t.string   :status
+      t.references :paymentable, polymorphic: true
+      t.string   :ip
+      t.timestamps
+    end
+    add_index :paypal_transactions, :status
+    add_index :paypal_transactions, [:paymentable_type, :paymentable_id]
+  end
+
+  def self.down
+    drop_table :paypal_transactions
+  end
+end

data/lib/lolita-paypal/billing.rb

@@ -0,0 +1,74 @@
+module LolitaPaypal
+  module Billing
+    def self.included(base)
+      base.has_many :paypal_transactions, as: :paymentable, class_name: 'LolitaPaypal::Transaction', dependent: :destroy
+      base.class_eval do
+
+        # Payment description
+        def description
+          raise 'Redefine this method in your billing model.'
+        end
+
+        # Price of payment in cents
+        def price
+          raise 'Redefine this method in your billing model.'
+        end
+
+        # Currency as 3 letter code as in ISO 4217
+        def currency
+          raise 'Redefine this method in your billing model.'
+        end
+
+        def paypal_trx_saved trx
+          raise 'Redefine this method in your billing model.'
+        end
+
+        # Paypal will redirect to this path after payment
+        def paypal_return_path
+          raise 'Redefine this method in your billing model.'
+        end
+
+        # To pass any extra parameter to paypal, redefine 'paypal_request_variables'
+        # with any of these keys. Keys business, item_name, amount, currency_code - already are added.
+        #+---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+        #| business      | Email address on your PayPal account                                                                                                                                                              |
+        #| quantity      | Number of items. This will multiply the amount if greater than one                                                                                                                                |
+        #| item_name     | Name of the item (or a name for the shopping cart). Must be alpha-numeric, with a 127character limit                                                                                              |
+        #| item_number   | Optional pass-through variable for you to track payments. Must be alpha-numeric, with a 127 character limit                                                                                       |
+        #| amount        | Price of the item (the total price of all items in the shopping cart)                                                                                                                             |
+        #| shipping      | The cost of shipping the item                                                                                                                                                                     |
+        #| shipping2     | The cost of shipping each additional item                                                                                                                                                         |
+        #| handling      | The cost of handling                                                                                                                                                                              |
+        #| tax           | Transaction-based tax value. If present, the value passed here will override any profile tax settings you may have (regardless of the buyer's location).                                          |
+        #| no_shipping   | Shipping address. If set to "1," your customer will not be asked for a shipping address. This is optional; if omitted or set to "0," your customer will be prompted to include a shipping address |
+        #| cn            | Optional label that will appear above the note field (maximum 40 characters)                                                                                                                      |
+        #| no_note       | Including a note with payment. If set to "1," your customer will not be prompted to include a note. This is optional; if omitted or set to "0," your customer will be prompted to include a note. |
+        #| on0           | First option field name. 64 character limit                                                                                                                                                       |
+        #| os0           | First set of option value(s). 200 character limit. "on0" must be defined for "os0" to be recognized.                                                                                              |
+        #| on1           | Second option field name. 64 character limit                                                                                                                                                      |
+        #| os1           | Second set of option value(s). 200 character limit. "on1" must be defined for "os1" to be recognized.                                                                                             |
+        #| custom        | Optional pass-through variable that will never be presented to your customer. Can be used to track inventory                                                                                      |
+        #| invoice       | Optional pass-through variable that will never be presented to your customer. Can be used to track invoice numbers                                                                                |
+        #| notify_url    | Only used with IPN. An internet URL where IPN form posts will be sent                                                                                                                             |
+        #| return        | An internet URL where your customer will be returned after completing payment                                                                                                                     |
+        #| cancel_return | An internet URL where your customer will be returned after cancelling payment                                                                                                                     |
+        #| image_url     | The internet URL of the 150 X 50 pixel image you would like to use as your logo                                                                                                                   |
+        #| cs            | Sets the background color of your payment pages. If set to "1," the background color will be black. This is optional; if omitted or set to "0," the background color will be white                |
+        #+---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+        # more info at https://www.paypal.com/cgi-bin/webscr?cmd=p/pdn/howto_checkout-outside
+        def paypal_request_variables
+          {}
+        end
+
+        # Add this to your paid? method along with other payment methods
+        # Example:
+        #     def paid?
+        #       paypal_paid? || first_data_paid?
+        #     end
+        def paypal_paid?
+          self.paypal_transactions.where(status: 'Completed').count >= 1
+        end
+      end
+    end
+  end
+end

data/lib/lolita-paypal/custom_logger.rb

@@ -0,0 +1,8 @@
+module LolitaPaypal
+  # custom log formatter
+  class LogFormatter < Logger::Formatter
+    def call(severity, time, program_name, message)
+      "%5s [%s] (%s) %s :: %s\n" % [severity, time.strftime('%Y-%m-%d %H:%M:%S'), $$, program_name, message]
+    end
+  end
+end

data/lib/lolita-paypal/engine.rb

@@ -0,0 +1,9 @@
+module LolitaPaypal
+  class Engine < ::Rails::Engine
+    isolate_namespace LolitaPaypal
+
+    config.after_initialize do
+      ActiveMerchant::Billing::PaypalGateway.pem_file = LolitaPaypal.paypal_cert_pem
+    end
+  end
+end

data/lib/lolita-paypal/request.rb

@@ -0,0 +1,42 @@
+module LolitaPaypal
+
+  class Request
+    attr_reader :payment
+
+    def initialize(payment = nil)
+      @payment = payment
+    end
+
+    def self.encrypt_for_paypal(values)
+      signed = OpenSSL::PKCS7::sign(OpenSSL::X509::Certificate.new(LolitaPaypal.app_cert_pem), OpenSSL::PKey::RSA.new(LolitaPaypal.app_key_pem, ''), values.map { |k, v| "#{k}=#{v}" }.join("\n"), [], OpenSSL::PKCS7::BINARY)
+      OpenSSL::PKCS7::encrypt([OpenSSL::X509::Certificate.new(LolitaPaypal.paypal_cert_pem)], signed.to_der, OpenSSL::Cipher::Cipher::new('DES3'), OpenSSL::PKCS7::BINARY).to_s.gsub("\n", "")
+    end
+
+    def amount(money)
+      cents = money.respond_to?(:cents) ? money.cents : money
+      if money.nil? || cents.to_i <= 0
+        raise ArgumentError, 'money amount must be either a Money object or a positive integer in cents.'
+      end
+      sprintf("%.2f", cents.to_f / 100)
+    end
+
+    def payment_id
+      payment.id
+    end
+
+    def request_variables
+      {
+        'cert_id' => LolitaPaypal.cert_id,
+        'cmd' => '_xclick',
+        'business' =>  LolitaPaypal.account_name,
+        'item_name' => payment.description,
+        'custom' =>"#{payment.class}___#{payment_id}",
+        'amount' => amount(payment.price),
+        'currency_code' => payment.currency,
+        'no_note' => '1',
+        'no_shipping' => '1',
+        'return' => payment.paypal_return_path
+      }.merge(payment.paypal_request_variables)
+    end
+  end
+end

data/lib/lolita-paypal/version.rb

@@ -0,0 +1,3 @@
+module LolitaPaypal
+  VERSION = "1.0.0"
+end

data/lib/lolita-paypal.rb

@@ -0,0 +1,47 @@
+require 'digest/md5'
+require 'openssl'
+require 'activemerchant'
+require 'lolita-paypal/custom_logger'
+require 'lolita-paypal/request'
+require 'lolita-paypal/engine'
+require 'lolita-paypal/version'
+require 'lolita-paypal/billing'
+
+module LolitaPaypal
+  mattr_accessor :custom_logger
+
+  def self.cert_id
+    @cert_id ||= ENV['PAYPAL_CERT_ID']
+  end
+
+  def self.account_name
+    @account_name ||= ENV['PAYPAL_ACCOUNT_NAME']
+  end
+
+  def self.paypal_cert_pem
+    @paypal_cert_pem ||= File.read ENV['PAYPAL_CERT_PEM']
+  end
+
+  def self.app_cert_pem
+    @app_cert_pem ||= File.read ENV['PAYPAL_APP_CERT_PEM']
+  end
+
+  def self.app_key_pem
+    @app_key_pem ||= File.read ENV['PAYPAL_APP_KEY_PEM']
+  end
+
+  def self.logger
+    unless @logger
+      @logger = custom_logger ? custom_logger : default_logger
+    end
+    @logger
+  end
+
+  protected
+
+  def self.default_logger
+    logger = Logger.new(Rails.root.join('log', 'lolita_paypal.log'))
+    logger.formatter = LolitaPaypal::LogFormatter.new
+    logger
+  end
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: lolita-paypal
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- ITHouse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: activemerchant
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: fabrication
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+description: Paypal payment plugin using ActiveMerchant for use with Lolita CMS
+email:
+- info@ithouse.lv
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/lolita_paypal/application_controller.rb
+- app/controllers/lolita_paypal/transactions_controller.rb
+- app/helpers/lolita_paypal/application_helper.rb
+- app/models/lolita_paypal/transaction.rb
+- app/views/lolita_paypal/payment_form.html.erb
+- config/locales/en.yml
+- config/locales/lv.yml
+- config/routes.rb
+- lib/generators/lolita_paypal/USAGE
+- lib/generators/lolita_paypal/lolita_paypal_generator.rb
+- lib/generators/lolita_paypal/templates/paypal_transactions.erb
+- lib/lolita-paypal.rb
+- lib/lolita-paypal/billing.rb
+- lib/lolita-paypal/custom_logger.rb
+- lib/lolita-paypal/engine.rb
+- lib/lolita-paypal/request.rb
+- lib/lolita-paypal/version.rb
+homepage: http://github.com/ithouse/lolita-paypal
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Paypal payment plugin for Lolita
+test_files: []