offsite_payments 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60fab7379e2aa8af845311fceb0297f9de6e3d23
+  data.tar.gz: d29d896b0ba13ff9c9a7107259e943119fea1ab9
+SHA512:
+  metadata.gz: 7086fa9f0af0f153a4acea72ab207dc95f359fa3e469fc27d206f5965a83c04e130374940dd8717c361490839b84314862330210a636db32991bb00737a2d51e
+  data.tar.gz: 2453d36da9d1ab052608ca92c59f2ffeac1025f8466fa2543b49039bc7dd5d6b737f82d3d2b07a80379f22638d4f6696a004b8b4b7db34a03a8e9936fe9ab380

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2005-2014 Tobias Luetke
+
+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,70 @@
+# Offsite Payments
+[![Build Status](https://travis-ci.org/Shopify/offsite_payments.png?branch=master)](https://travis-ci.org/Shopify/offsite_payments)
+[![Code Climate](https://codeclimate.com/github/Shopify/offsite_payments.png)](https://codeclimate.com/github/Shopify/offsite_payments)
+
+Offsite Payments is an extraction from the ecommerce system [Shopify](http://www.shopify.com). Shopify's requirements for a simple and unified API to handle dozens of different offsite payment pages (often called hosted payment pages) with very different exposed APIs was the chief principle in designing the library.
+
+It was developed for usage in Ruby on Rails web applications and integrates seamlessly
+as a Rails plugin. It should also work as a stand alone Ruby library, but much of the benefit is in the ActionView helpers which are Rails-specific.
+
+Offsite Payments has been in production use (originally as part of the [ActiveMerchant](https://github.com/Shopify/active_merchant) project) since June 2006. It is maintained by the [Shopify](http://www.shopify.com) team, with much help from an ever-growing set of contributors.
+
+## Installation
+
+### From Git
+
+You can check out the latest source from git:
+
+    git clone https://github.com/Shopify/offsite_payments.git
+
+### From RubyGems
+
+Installation from RubyGems:
+
+    gem install offsite_payments
+
+Or, if you're using Bundler, just add the following to your Gemfile:
+
+    gem 'offsite_payments'
+
+[API documentation](http://rubydoc.info/github/Shopify/offsite_payments/master/file/README.md).
+
+## Supported Integrations
+
+* [2 Checkout](http://www.2checkout.com)
+* [A1Agregator](http://a1agregator.ru/) - RU
+* [Authorize.Net SIM](http://developer.authorize.net/api/sim/) - US
+* [Banca Sella GestPay](https://www.gestpay.it/)
+* [Chronopay](http://www.chronopay.com)
+* [DirecPay](http://www.timesofmoney.com/direcpay/jsp/home.jsp)
+* [Direct-eBanking / sofortueberweisung.de by Payment-Networks AG](https://www.payment-network.com/deb_com_en/merchantarea/home) - DE, AT, CH, BE, UK, NL
+* [Dotpay](http://dotpay.pl)
+* [Doku](http://doku.com)
+* [Dwolla](https://www.dwolla.com/default.aspx)
+* [ePay](http://www.epay.dk/epay-payment-solutions/)
+* [First Data](https://firstdata.zendesk.com/entries/407522-first-data-global-gateway-e4sm-payment-pages-integration-manual)
+* [HiTRUST](http://www.hitrust.com.hk/)
+* [Moneybookers](http://www.moneybookers.com)
+* [Nochex](http://www.nochex.com)
+* [PagSeguro](http://www.pagseguro.com.br/) - BR
+* [Paxum](https://www.paxum.com/)
+* [PayPal Website Payments Standard](https://www.paypal.com/cgi-bin/webscr?cmd#_wp-standard-overview-outside)
+* [Paysbuy](https://www.paysbuy.com/) - TH
+* [Platron](https://www.platron.ru/) - RU
+* [RBK Money](https://rbkmoney.ru/) - RU
+* [Robokassa](http://robokassa.ru/) - RU
+* [SagePay Form](http://www.sagepay.com/products_services/sage_pay_go/integration/form)
+* [Suomen Maksuturva](https://www.maksuturva.fi/services/vendor_services/integration_guidelines.html)
+* [Valitor](http://www.valitor.is/) - IS
+* [Verkkomaksut](http://www.verkkomaksut.fi) - FI
+* [WebMoney](http://www.webmoney.ru) - RU
+* [WebPay](http://webpay.by/)
+* [WorldPay](http://www.worldpay.com)
+
+## Contributing
+
+The source code is hosted at [GitHub](http://github.com/Shopify/offsite_payments), and can be fetched using:
+
+    git clone https://github.com/Shopify/offsite_payments.git
+
+Please don't touch the CHANGELOG in your pull requests, we'll add the appropriate CHANGELOG entries at release time.

data/lib/offsite_payments.rb

@@ -0,0 +1,46 @@
+require 'securerandom'
+require 'cgi'
+
+require 'active_support/core_ext/class/delegating_attributes'
+
+require 'active_utils/common/network_connection_retries'
+require 'active_utils/common/connection'
+require 'active_utils/common/requires_parameters'
+require 'active_utils/common/country'
+require 'active_utils/common/error'
+require 'active_utils/common/post_data'
+require 'active_utils/common/posts_data'
+require 'active_utils/common/currency_code'
+
+require "offsite_payments/helper"
+require "offsite_payments/notification"
+require "offsite_payments/return"
+require "offsite_payments/integrations"
+require "offsite_payments/action_view_helper"
+
+I18n.enforce_available_locales = false
+
+module OffsitePayments
+  # Return the matching integration module
+  # You can then get the notification from the module
+  # * <tt>bogus</tt>: Bogus - Does nothing (for testing)
+  # * <tt>chronopay</tt>: Chronopay
+  # * <tt>paypal</tt>: Paypal
+  #
+  #   chronopay = OffsitePayments.integration('chronopay')
+  #   notification = chronopay.notification(raw_post)
+  #
+  def self.integration(name)
+    Integrations.const_get("#{name.to_s.downcase}".camelize)
+  end
+
+  mattr_accessor :mode
+  self.mode = :production
+
+  # A check to see if we're in test mode
+  def self.test?
+    self.mode == :test
+  end
+
+  CURRENCIES_WITHOUT_FRACTIONS = [ 'BIF', 'BYR', 'CLP', 'CVE', 'DJF', 'GNF', 'HUF', 'ISK', 'JPY', 'KMF', 'KRW', 'PYG', 'RWF', 'TWD', 'UGX', 'VND', 'VUV', 'XAF', 'XOF', 'XPF' ]
+end

data/lib/offsite_payments/action_view_helper.rb

@@ -0,0 +1,72 @@
+require 'action_pack'
+
+module OffsitePayments #:nodoc:
+  ActionViewHelperError = Class.new(StandardError)
+
+  module ActionViewHelper
+    # This helper allows the usage of different payment integrations
+    # through a single form helper.  Payment integrations are the
+    # type of service where the user is redirected to the secure
+    # site of the service, like Paypal or Chronopay.
+    #
+    # The helper creates a scope around a payment service helper
+    # which provides the specific mapping for that service.
+    #
+    #  <% payment_service_for 1000, 'paypalemail@mystore.com',
+    #                               :amount => 50.00,
+    #                               :currency => 'CAD',
+    #                               :service => :paypal,
+    #                               :html => { :id => 'payment-form' } do |service| %>
+    #
+    #    <% service.customer :first_name => 'Cody',
+    #                       :last_name => 'Fauser',
+    #                       :phone => '(555)555-5555',
+    #                       :email => 'cody@example.com' %>
+    #
+    #    <% service.billing_address :city => 'Ottawa',
+    #                              :address1 => '21 Snowy Brook Lane',
+    #                              :address2 => 'Apt. 36',
+    #                              :state => 'ON',
+    #                              :country => 'CA',
+    #                              :zip => 'K1J1E5' %>
+    #
+    #    <% service.invoice '#1000' %>
+    #    <% service.shipping '0.00' %>
+    #    <% service.tax '0.00' %>
+    #
+    #    <% service.notify_url url_for(:only_path => false, :action => 'notify') %>
+    #    <% service.return_url url_for(:only_path => false, :action => 'done') %>
+    #    <% service.cancel_return_url 'http://mystore.com' %>
+    #  <% end %>
+    #
+    def payment_service_for(order, account, options = {}, &proc)
+      raise ArgumentError, "Missing block" unless block_given?
+
+      integration_module = OffsitePayments::integration(options.delete(:service).to_s)
+      service_class = integration_module.const_get('Helper')
+
+      form_options = options.delete(:html) || {}
+      service = service_class.new(order, account, options)
+      form_options[:method] = service.form_method
+      result = []
+      service_url = service.respond_to?(:credential_based_url) ? service.credential_based_url : integration_module.service_url
+      result << form_tag(service_url, form_options)
+
+      result << capture(service, &proc)
+
+      service.form_fields.each do |field, value|
+        result << hidden_field_tag(field, value)
+      end
+
+      service.raw_html_fields.each do |field, value|
+        result << "<input id=\"#{field}\" name=\"#{field}\" type=\"hidden\" value=\"#{value}\" />\n"
+      end
+
+      result << '</form>'
+      result= result.join("\n")
+
+      concat(result.respond_to?(:html_safe) ? result.html_safe : result)
+      nil
+    end
+  end
+end

data/lib/offsite_payments/helper.rb

@@ -0,0 +1,119 @@
+module OffsitePayments #:nodoc:
+  class Helper #:nodoc:
+    attr_reader :fields
+    class_attribute :service_url
+    class_attribute :mappings
+    class_attribute :country_format
+    self.country_format = :alpha2
+
+    # The application making the calls to the gateway
+    # Useful for things like the PayPal build notation (BN) id fields
+    class_attribute :application_id
+    self.application_id = 'ActiveMerchant'
+
+    def self.inherited(subclass)
+      subclass.mappings ||= {}
+    end
+
+    def initialize(order, account, options = {})
+      options.assert_valid_keys([:amount, :currency, :test, :credential2, :credential3, :credential4, :country, :account_name, :description, :transaction_type, :authcode, :notify_url, :return_url, :redirect_param, :forward_url])
+      @fields             = {}
+      @raw_html_fields    = []
+      @test               = options[:test]
+      self.order          = order
+      self.account        = account
+      self.amount         = options[:amount]
+      self.currency       = options[:currency]
+      self.credential2    = options[:credential2]
+      self.credential3    = options[:credential3]
+      self.credential4    = options[:credential4]
+      self.notify_url     = options[:notify_url]
+      self.return_url     = options[:return_url]
+      self.redirect_param = options[:redirect_param]
+    end
+
+    def self.mapping(attribute, options = {})
+      self.mappings[attribute] = options
+    end
+
+    def add_field(name, value)
+      return if name.blank? || value.blank?
+      @fields[name.to_s] = value.to_s
+    end
+
+    def add_fields(subkey, params = {})
+      params.each do |k, v|
+        field = mappings[subkey][k]
+        add_field(field, v) unless field.blank?
+      end
+    end
+
+    # Add a field that has characters that CGI::escape would mangle. Allows
+    # for multiple fields with the same name (e.g., to support line items).
+    def add_raw_html_field(name, value)
+      return if name.blank? || value.blank?
+      @raw_html_fields << [name, value]
+    end
+
+    def raw_html_fields
+      @raw_html_fields
+    end
+
+    def billing_address(params = {})
+      add_address(:billing_address, params)
+    end
+
+    def shipping_address(params = {})
+      add_address(:shipping_address, params)
+    end
+
+    def form_fields
+      @fields
+    end
+
+    def test?
+      @test_mode ||= OffsitePayments.mode == :test || !!@test
+    end
+
+    def form_method
+      "POST"
+    end
+
+    private
+
+    def add_address(key, params)
+      return if mappings[key].nil?
+
+      code = lookup_country_code(params.delete(:country))
+      add_field(mappings[key][:country], code)
+      add_fields(key, params)
+    end
+
+    def lookup_country_code(name_or_code, format = country_format)
+      country = ActiveMerchant::Country.find(name_or_code)
+      country.code(format).to_s
+    rescue ActiveMerchant::InvalidCountryCodeError
+      name_or_code
+    end
+
+    def method_missing(method_id, *args)
+      method_id = method_id.to_s.gsub(/=$/, '').to_sym
+      # Return and do nothing if the mapping was not found. This allows
+      # for easy substitution of the different integrations
+      return if mappings[method_id].nil?
+
+      mapping = mappings[method_id]
+
+      case mapping
+      when Array
+        mapping.each{ |field| add_field(field, args.last) }
+      when Hash
+        options = args.last.is_a?(Hash) ? args.pop : {}
+
+        mapping.each{ |key, field| add_field(field, options[key]) }
+      else
+        add_field(mapping, args.last)
+      end
+    end
+  end
+end

data/lib/offsite_payments/integrations.rb

@@ -0,0 +1,14 @@
+module OffsitePayments
+  module Integrations
+    Dir[File.dirname(__FILE__) + '/integrations/*.rb'].each do |f|
+      # Get camelized class name
+      filename = File.basename(f, '.rb')
+
+      # Camelize the string to get the class name
+      integration_class = filename.camelize.to_sym
+
+      # Register for autoloading
+      autoload integration_class, f
+    end
+  end
+end

data/lib/offsite_payments/integrations/a1agregator.rb

@@ -0,0 +1,245 @@
+module OffsitePayments #:nodoc:
+  module Integrations #:nodoc:
+    module A1agregator
+      mattr_accessor :service_url
+      self.service_url = 'https://partner.a1agregator.ru/a1lite/input/'
+
+      mattr_accessor :signature_parameter_name
+      self.signature_parameter_name = 'check'
+
+      def self.notification(*args)
+        Notification.new(*args)
+      end
+
+      def self.status(login, password)
+        Status.new(login, password)
+      end
+
+      class Helper < OffsitePayments::Helper
+        # public key
+        mapping :account, 'key'
+
+        mapping :amount, 'cost'
+
+        mapping :order, 'order_id'
+
+        mapping :customer, :email => 'email',
+                           :phone => 'phone_number'
+
+         # payment description
+        mapping :credential2, 'name'
+
+        mapping :credential3, 'comment'
+
+        # on error
+        # 1 - raise error
+        # 0 - redirect
+        mapping :credential4, 'verbose'
+      end
+
+      class Notification < OffsitePayments::Notification
+        self.production_ips = [
+          '78.108.178.206',
+          '79.137.235.129',
+          '95.163.96.79',
+          '212.24.38.100'
+        ]
+
+        def initialize(*args)
+          super
+          guess_notification_type
+        end
+
+        # Simple notification request params:
+        # tid
+        # name
+        # comment
+        # partner_id
+        # service_id
+        # order_id
+        # type
+        # partner_income
+        # system_income
+
+        def complete?
+          true
+        end
+
+        def transaction_id
+          params['tid']
+        end
+
+        def title
+          params['name']
+        end
+
+        def comment
+          params['comment']
+        end
+
+        def partner_id
+          params['partner_id']
+        end
+
+        def service_id
+          params['service_id']
+        end
+
+        def item_id
+          params['order_id']
+        end
+
+        def type
+          params['type']
+        end
+
+        def partner_income
+          params['partner_income']
+        end
+
+        def system_income
+          params['system_income']
+        end
+
+        # Additional notification request params:
+        # tid
+        # name
+        # comment
+        # partner_id
+        # service_id
+        # order_id
+        # type
+        # cost
+        # income_total
+        # income
+        # partner_income
+        # system_income
+        # command
+        # phone_number
+        # email
+        # resultStr
+        # date_created
+        # version
+        # check
+
+        def inclome_total
+          params['income_total']
+        end
+
+        def income
+          params['income']
+        end
+
+        def partner_income
+          params['partner_income']
+        end
+
+        def system_income
+          params['system_income']
+        end
+
+        def command
+          params['command']
+        end
+
+        def phone_number
+          params['phone_number']
+        end
+
+        def payer_email
+          params['email']
+        end
+
+        def result_string
+          params['resultStr']
+        end
+
+        def received_at
+          params['date_created']
+        end
+
+        def version
+          params['version']
+        end
+
+        def security_key
+          params[A1agregator.signature_parameter_name].to_s.downcase
+        end
+
+        # the money amount we received in X.2 decimal.
+        alias_method :gross, :system_income
+
+        def currency
+          'RUB'
+        end
+
+        # Was this a test transaction?
+        def test?
+          params['test'] == '1'
+        end
+
+        def simple_notification?
+          @notification_type == :simple
+        end
+
+        def additional_notification?
+          @notification_type == :additional
+        end
+
+        def acknowledge(authcode = nil)
+          security_key == signature
+        end
+
+        private
+
+        def signature
+          data = "#{params['tid']}\
+#{params['name']}\
+#{params['comment']}\
+#{params['partner_id']}\
+#{params['service_id']}\
+#{params['order_id']}\
+#{params['type']}\
+#{params['partner_income']}\
+#{params['system_income']}\
+#{params['test']}\
+#{@options[:secret]}"
+          Digest::MD5.hexdigest(data)
+        end
+
+        def guess_notification_type
+          @notification_type = params['version'] ? :additional : :simple
+        end
+      end
+
+      class Status
+        include ActiveMerchant::PostsData
+
+        STATUS_TEST_URL = 'https://partner.a1pay.ru/a1lite/info/'
+
+        attr_accessor :login, :password
+
+        def initialize(login, password)
+          @login, @password = login, password
+        end
+
+        # agregator provides two methods:
+        # by tid - transaction id
+        # by order_id & service_id
+        def update(options = {})
+          data = PostData.new
+          data[:user] = @login
+          data[:pass] = @password
+          if options[:tid]
+            data[:tid] = options[:tid]
+          else
+            data[:ord_id] = options[:ord_id]
+            data[:service_id] = options[:service_id]
+          end
+
+          ssl_post(STATUS_TEST_URL, data.to_post_data)
+        end
+      end
+    end
+  end
+end