datatrans 2.4.0 → 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 00dfb98ec54350ac1a4d6d2a932a4ee08ed1ddd5
+  data.tar.gz: 599f998c0f9bd6e489d9571e171893c3b463be24
+SHA512:
+  metadata.gz: 06eeebeafc026f0fdfc1296be4f2a2e8201aa7de21a12f950b4f938225bcee6b0ffe19f2e47a4a5432c30d68c478c9733bca30b20a55dda593d5e1135e898738
+  data.tar.gz: 2a285a435167deae93bca53229ad7b01f4b536c739b50ca293c54f599312ad179fe90fbcc06789a4c6b0d94eb45650a585d0cea10d0e6bf7f36895da9fe93d81

data/.travis.yml

@@ -3,5 +3,6 @@ rvm:
   - 1.8.7
   - 1.9.3
   - ree
+  - 2.0.0
 gemfile:
   - Gemfile

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    datatrans (2.4.0)
+    datatrans (3.0.0)
       activesupport (>= 3.0.0)
       builder
       httparty
       i18n
+      multi_xml (>= 0.5.1)
 
 GEM
   remote: http://rubygems.org/
@@ -30,13 +31,13 @@ GEM
     diff-lcs (1.1.3)
     erubis (2.7.0)
     hike (1.2.1)
-    httparty (0.10.2)
+    httparty (0.11.0)
       multi_json (~> 1.0)
       multi_xml (>= 0.5.2)
     i18n (0.6.1)
     journey (1.0.4)
     multi_json (1.5.0)
-    multi_xml (0.5.2)
+    multi_xml (0.5.5)
     rack (1.4.4)
     rack-cache (1.2)
       rack (>= 0.4)

data/README.markdown

@@ -6,21 +6,23 @@ Ruby adapter for the Datatrans payment gateway (http://www.datatrans.ch).
 Configuration
 -------------
 
-Set your datatrans credentials in your environment.
-
-    Datatrans.configure do |config|
-      config.merchant_id = '1234567'
-      config.sign_key = 'ab739fd5b7c2a1...'
-      config.environment = :production
-      config.proxy = {
-        :host => "proxy.com",
-        :port => 80,
-        :user => "hans",
-        :password => "xxx",
+Buidl your Datatrans Configuration like so:
+
+    datatrans = Datatrans::Config.new(
+      :merchant_id => '1234567',
+      :sign_key => 'ab739fd5b7c2a1...',
+      :environment => :production,
+      :proxy => {
+        :http_proxyaddr => "proxy.com",
+        :http_proxyport => 80,
+        :http_proxyuser => "hans",
+        :http_proxpass => "xxx",
       }
-    end
+    )
 
-If you don't want to use signed requests (disabled in datatrans web console), you must set `config.sign_key` to `false`.
+
+If you don't want to use signed requests (disabled in datatrans web console), you can set `config.sign_key` to `false`.
+The configuration is then used as parameter to all the constructors and helpers, see examples below.
 
 Possible values for the environment: `:production`, `:development`
 
@@ -30,14 +32,13 @@ Web Authorization
 If you want to process a credit card the first time a web authorization is
 necessary. Add the following code to a controller action that shows the form.
 You need to pass at least `amount`, `currency` and `refno` (order number).
-
-    @transaction = Datatrans::Web::Transaction.new({
+    @transaction = datatrans.web_transaction(
       :amount => 1000, # in cents!
       :currency => 'CHF',
       :refno => 'ABCDEF',
-      :uppCustomerEmail => 'customer@email.com'
+      :uppCustomerEmail => 'customer@email.com',
       # feel free to add more upp infos here ...
-    })
+    )
 
 In your View your show the credit card form with a convenient helper:
 
@@ -53,7 +54,7 @@ In your View your show the credit card form with a convenient helper:
       = hidden_field_tag :cancelUrl, <your_application_return_url>
       = hidden_field_tag :errorUrl, <your_application_return_url>
 
-      = datatrans_notification_request_hidden_fields(@transaction)
+      = datatrans_notification_request_hidden_fields(datatrans, @transaction)
 
       = submit_tag "send"
 
@@ -66,7 +67,7 @@ After you submit the request to Datatrans they redirect back to your application
 Now you can process the transaction like this:
 
     begin
-      transaction = Datatrans::Web::Transaction.new(params)
+      transaction = datatrans.web_transaction(params)
 
       if transaction.authorize
         # transaction was successful, access the following attributes
@@ -94,13 +95,13 @@ use the convenient XML methods to process payments.
 Authorize
 ---------
 
-    transaction = Datatrans::XML::Transaction.new(
+    transaction = datatrans.xml_transaction(
       :refno => 'ABCDEF',
       :amount => 1000, # in cents!
       :currency => 'CHF',
       :aliasCC => '8383843729284848348',
       :expm => 12,
-      :expy => 15
+      :expy => 15,
     )
 
     if transaction.authorize
@@ -116,11 +117,11 @@ Capture
 
 To capture an authorized transaction you use the following code:
 
-    transaction = Datatrans::XML::Transaction.new(
+    transaction = datatrans.xml_transaction(
       :refno => 'ABCDEF',
       :amount => 1000, # in cents!
       :currency => 'CHF',
-      :transaction_id => 19834324987349723948729834
+      :transaction_id => 19834324987349723948729834,
     )
 
     if transaction.capture
@@ -135,11 +136,11 @@ Void
 
 To make an authorized transaction invalid use void.
 
-    transaction = Datatrans::XML::Transaction.new(
+    transaction = datatrans.xml_transaction(
       :refno => 'ABCDEF',
       :amount => 1000, # in cents!
       :currency => 'CHF',
-      :transaction_id => 19834324987349723948729834
+      :transaction_id => 19834324987349723948729834,
     )
 
     if transaction.void
@@ -152,6 +153,11 @@ To make an authorized transaction invalid use void.
 CHANGELOG
 =========
 
+3.0.0
+-------
+* Refactored Code to allow multiple configurations
+* Proxy config now uses HTTParty naming convention.
+
 2.2.2
 -------
 * added ability to skip signing by setting config.sign_key = false

data/datatrans.gemspec

@@ -5,8 +5,8 @@ require "datatrans/version"
 Gem::Specification.new do |s|
   s.name        = "datatrans"
   s.version     = Datatrans::VERSION
-  s.authors     = ["Tobias Miesel", "Thomas Maurer", "Corin Langosch"]
-  s.email       = ["tobias.miesel@simplificator.com", "thomas.maurer@simplificator.com", "corin.langosch@simplificator.com"]
+  s.authors     = ["Tobias Miesel", "Thomas Maurer", "Corin Langosch", "Pascal Betz"]
+  s.email       = ["info@simplificator.com"]
   s.homepage    = ""
   s.summary     = %q{Datatrans Integration for Ruby on Rails}
   s.description = %q{Datatrans Integration for Ruby on Rails}
@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'activesupport', '>= 3.0.0'
   s.add_dependency 'i18n'
   s.add_dependency 'builder'
+  s.add_dependency 'multi_xml', '>= 0.5.1'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'

data/lib/datatrans.rb

@@ -1,59 +1,18 @@
 require 'active_support/core_ext/module'
-require 'action_view'
 
 module Datatrans
-  BASE_URL = 'https://payment.datatrans.biz'
-  WEB_AUTHORIZE_URL = "#{BASE_URL}/upp/jsp/upStart.jsp"
-  XML_AUTHORIZE_URL = "#{BASE_URL}/upp/jsp/XML_authorize.jsp"
-  XML_SETTLEMENT_URL = "#{BASE_URL}/upp/jsp/XML_processor.jsp"
-  XML_STATUS_URL = "#{BASE_URL}/upp/jsp/XML_status.jsp"
-
-  TEST_BASE_URL = 'https://pilot.datatrans.biz'
-  TEST_WEB_AUTHORIZE_URL = "#{TEST_BASE_URL}/upp/jsp/upStart.jsp"
-  TEST_XML_AUTHORIZE_URL = "#{TEST_BASE_URL}/upp/jsp/XML_authorize.jsp"
-  TEST_XML_SETTLEMENT_URL = "#{TEST_BASE_URL}/upp/jsp/XML_processor.jsp"
-  TEST_XML_STATUS_URL = "#{TEST_BASE_URL}/upp/jsp/XML_status.jsp"
-
-  mattr_accessor :merchant_id
-  mattr_accessor :sign_key
-  mattr_accessor :proxy
-
-  mattr_reader :base_url
-  mattr_reader :web_authorize_url
-  mattr_reader :xml_authorize_url
-  mattr_reader :xml_settlement_url
-  mattr_reader :xml_status_url
-
-  def self.configure
-    self.environment = :development # default
-    yield self
-  end
-
-  def self.environment=(environment)
-    case environment
-    when :development
-      @@base_url           = TEST_BASE_URL
-      @@web_authorize_url  = TEST_WEB_AUTHORIZE_URL
-      @@xml_authorize_url  = TEST_XML_AUTHORIZE_URL
-      @@xml_settlement_url = TEST_XML_SETTLEMENT_URL
-      @@xml_status_url     = TEST_XML_STATUS_URL
-    when :production
-      @@base_url           = BASE_URL
-      @@web_authorize_url  = WEB_AUTHORIZE_URL
-      @@xml_authorize_url  = XML_AUTHORIZE_URL
-      @@xml_settlement_url = XML_SETTLEMENT_URL
-      @@xml_status_url     = XML_STATUS_URL
-    else
-      raise "Unknown environment '#{environment}'. Available: :development, :production."
-    end
-  end
-
-  class InvalidSignatureError < StandardError; end
+  InvalidSignatureError = Class.new(StandardError)
 end
 
 require 'datatrans/version'
 require 'datatrans/common'
+require 'datatrans/config'
 require 'datatrans/xml/transaction'
 require 'datatrans/web/transaction'
 
-ActionView::Base.send :include, Datatrans::Web::ViewHelper if defined? ActionView
+begin
+  require 'action_view'
+  require 'datatrans/web/view_helper'
+  ActionView::Base.send(:include, Datatrans::Web::ViewHelper)
+rescue LoadError
+end

data/lib/datatrans/common.rb

@@ -2,8 +2,8 @@ require 'openssl'
 
 module Datatrans::Common
   def sign(*fields)
-    return nil unless Datatrans.sign_key
-    key = Datatrans.sign_key.split(/([a-f0-9][a-f0-9])/).reject(&:empty?)
+    return nil unless self.datatrans.sign_key
+    key = self.datatrans.sign_key.split(/([a-f0-9][a-f0-9])/).reject(&:empty?)
     key = key.pack("H*" * key.size)
     OpenSSL::HMAC.hexdigest(OpenSSL::Digest::MD5.new, key, fields.join)
   end

data/lib/datatrans/config.rb

@@ -0,0 +1,63 @@
+module Datatrans
+  class Config
+    ENVIRONMENTS = [:development, :production].freeze
+    DEFAULT_ENVIRONMENT = :development
+
+    DEFAULT_SIGN_KEY = false
+
+    BASE_URL_PRODUCTION = 'https://payment.datatrans.biz'.freeze
+    BASE_URL_DEVELOPMENT = 'https://pilot.datatrans.biz'.freeze
+
+    URLS = {
+      :development => {
+        :web_authorize_url  => "#{BASE_URL_PRODUCTION}/upp/jsp/upStart.jsp".freeze,
+        :xml_authorize_url  => "#{BASE_URL_PRODUCTION}/upp/jsp/XML_authorize.jsp".freeze,
+        :xml_settlement_url => "#{BASE_URL_PRODUCTION}/upp/jsp/XML_processor.jsp".freeze,
+        :xml_status_url     => "#{BASE_URL_PRODUCTION}/upp/jsp/XML_status.jsp".freeze
+      },
+      :production => {
+        :web_authorize_url  => "#{BASE_URL_DEVELOPMENT}/upp/jsp/upStart.jsp".freeze,
+        :xml_authorize_url  => "#{BASE_URL_DEVELOPMENT}/upp/jsp/XML_authorize.jsp".freeze,
+        :xml_settlement_url => "#{BASE_URL_DEVELOPMENT}/upp/jsp/XML_processor.jsp".freeze,
+        :xml_status_url     => "#{BASE_URL_DEVELOPMENT}/upp/jsp/XML_status.jsp".freeze
+      }.freeze
+    }.freeze
+
+    attr_reader :environment, :merchant_id, :sign_key, :proxy
+
+    # Configure with following options
+    # * :merchant_id (required)
+    # * :sign_key (defaults to false)
+    # * :environment (defaults to :development, available environments are defined in ENVIRONMENTS)
+    # * :proxy (a hash containing :http_proxyaddr, :http_proxyport, :http_proxyuser, :http_proxypass)
+    def initialize(options = {})
+      @merchant_id = options[:merchant_id]
+      raise ArgumentError.new(":merchant_id is required") unless self.merchant_id
+      self.environment = options[:environment] || DEFAULT_ENVIRONMENT
+      @sign_key = options[:sign_key] || DEFAULT_SIGN_KEY
+      @proxy = options[:proxy] || {}
+    end
+
+    def environment=(environment)
+      environment = environment.try(:to_sym)
+      if ENVIRONMENTS.include?(environment)
+        @environment = environment
+      else
+        raise "Unknown environment '#{environment}'. Available: #{ENVIRONMENTS.join(', ')}"
+      end
+    end
+
+    # Access a url, is automatically scoped to environment
+    def url(what)
+      URLS[self.environment][what]
+    end
+
+    def web_transaction(*args)
+      Web::Transaction.new(self, *args)
+    end
+
+    def xml_transaction(*args)
+      XML::Transaction.new(self, *args)
+    end
+  end
+end

data/lib/datatrans/version.rb

@@ -1,3 +1,3 @@
 module Datatrans
-  VERSION = "2.4.0"
+  VERSION = "3.0.0"
 end

data/lib/datatrans/web/transaction.rb

@@ -5,11 +5,10 @@ module Datatrans::Web
     include Datatrans::Common
 
     attr_accessor :request
-    attr_reader :response, :params
-
-    def initialize(params)
-      raise 'Please define Datatrans.sign_key or set it to false!' unless Datatrans.sign_key == false || Datatrans.sign_key.present?
+    attr_reader :response, :params, :datatrans
 
+    def initialize(datatrans, params)
+      @datatrans = datatrans
       params = params.to_hash
       params.symbolize_keys!
       params.reverse_merge!(:reqtype => 'NOA', :useAlias => 'yes', :hiddenMode => 'yes')
@@ -17,11 +16,11 @@ module Datatrans::Web
     end
 
     def signature
-      sign(Datatrans.merchant_id, params[:amount], params[:currency], params[:refno])
+      sign(self.datatrans.merchant_id, params[:amount], params[:currency], params[:refno])
     end
 
     def authorize
-      @response = AuthorizeResponse.new(params)
+      @response = AuthorizeResponse.new(datatrans, params)
       @response.successful?
     end
 
@@ -33,30 +32,6 @@ module Datatrans::Web
       end
     end
   end
-
-  module ViewHelper
-    def datatrans_notification_request_hidden_fields(transaction)
-      fields = [
-        hidden_field_tag(:merchantId, Datatrans.merchant_id),
-        hidden_field_tag(:hiddenMode, transaction.params[:hiddenMode]),
-        hidden_field_tag(:reqtype, transaction.params[:reqtype]),
-        hidden_field_tag(:amount, transaction.params[:amount]),
-        hidden_field_tag(:currency, transaction.params[:currency]),
-        hidden_field_tag(:useAlias, transaction.params[:useAlias]),
-        hidden_field_tag(:sign, transaction.signature),
-        hidden_field_tag(:refno, transaction.params[:refno]),
-        hidden_field_tag(:uppCustomerDetails, transaction.params[:uppCustomerDetails]),
-      ]
-
-      [:uppCustomerName, :uppCustomerEmail].each do |field_name|
-        if transaction.params[field_name].present?
-          fields << hidden_field_tag(field_name, transaction.params[field_name])
-        end
-      end
-
-      fields.join.html_safe
-    end
-  end
 end
 
 require 'datatrans/web/transaction/authorize'

data/lib/datatrans/web/transaction/authorize.rb

@@ -1,41 +1,43 @@
 class Datatrans::Web::Transaction
   class AuthorizeResponse
-    attr_accessor :params
-    
-    def initialize(params)
+    attr_accessor :params, :datatrans
+
+    def initialize(datatrans, params)
+      @datatrans = datatrans
       @params = params
     end
-    
+
     def successful?
       raise Datatrans::InvalidSignatureError unless valid_signature?
       response_code == '01' && response_message == 'Authorized' && !errors_occurred?
     end
-    
+
     def valid_signature?
+      # TODO: does not make sense... true if errors?
       return true if errors_occurred? # no sign2 sent on error
-      sign(Datatrans.merchant_id, params[:amount], params[:currency], params[:uppTransactionId]) == params[:sign2]
+      sign(self.datatrans.merchant_id, params[:amount], params[:currency], params[:uppTransactionId]) == params[:sign2]
     end
-    
+
     def response_code
       params[:responseCode] rescue nil
     end
-    
+
     def response_message
       params[:responseMessage] rescue nil
     end
-    
+
     def transaction_id
-      params[:uppTransactionId] rescue nil 
+      params[:uppTransactionId] rescue nil
     end
-    
+
     def reference_number
-      params[:refno] rescue nil 
+      params[:refno] rescue nil
     end
-    
+
     def authorization_code
       params[:authorizationCode] rescue nil
     end
-    
+
     def payment_method
       params[:pmethod] rescue nil
     end
@@ -43,38 +45,38 @@ class Datatrans::Web::Transaction
     def masked_cc
       params[:maskedCC] rescue nil
     end
-    
+
     def exp_year
       params[:expy] rescue nil
     end
-    
+
     def exp_month
       params[:expm] rescue nil
     end
-    
+
     def creditcard_alias
       params[:aliasCC] rescue nil
     end
-    
+
     def error_code
       params[:errorCode] rescue nil
     end
-    
+
     def error_message
       params[:errorMessage] rescue nil
     end
-    
+
     def error_detail
       params[:errorDetail] rescue nil
     end
-    
-    
+
+
     private
-    
+
     def errors_occurred?
       error_code || error_message || error_detail
     end
-    
+
     include Datatrans::Common
   end
 end