pensio_api 0.2.3 → 0.3.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 781ea82badd4f553a0041c19c1e6e0dca9caf62b971550c55b4aa932b24e2d80
+  data.tar.gz: 7699c92bd15352c2a54183e35f03362062295ccd0c840d94b8aed1dba9eba77c
+SHA512:
+  metadata.gz: 06c96a50bc88c4d0e766c87909e7c787710b571d6221c3feed4e7c06c4f4567890639b63730243012e9f42d442e6026d57b127b663dab0a63efbf6c44a607bf8
+  data.tar.gz: 332ee83a97dc3a3eb8b9bac31fecf930dd4ef3bc2051d7da8e4e4be4177251f3ba4b2cda6ae7030cd904a23ea7a106a764d4dff1bfdccc3481029119fd676230

data/.gitignore

@@ -0,0 +1,3 @@
+.idea/*
+.ruby-version
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pensio_api (0.2.3)
+    pensio_api (0.3.4)
       activesupport (>= 3.2)
       httparty (>= 0.12.0)
       multi_xml (>= 0.5.2)
@@ -9,65 +9,73 @@ PATH
 GEM
   remote: https://www.rubygems.org/
   specs:
-    activesupport (4.0.4)
-      i18n (~> 0.6, >= 0.6.9)
-      minitest (~> 4.2)
-      multi_json (~> 1.3)
-      thread_safe (~> 0.1)
-      tzinfo (~> 0.3.37)
-    addressable (2.3.5)
-    celluloid (0.15.2)
-      timers (~> 1.1.0)
-    coderay (1.1.0)
-    crack (0.4.1)
-      safe_yaml (~> 0.9.0)
-    diff-lcs (1.2.5)
-    ffi (1.9.3)
-    formatador (0.2.4)
+    activesupport (5.2.4.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    crack (0.4.4)
+    diff-lcs (1.4.4)
+    ffi (1.13.1)
+    formatador (0.2.5)
     guard (2.2.5)
       formatador (>= 0.2.4)
       listen (~> 2.1)
       lumberjack (~> 1.0)
       pry (>= 0.9.12)
       thor (>= 0.18.1)
-    guard-rspec (4.2.4)
+    guard-rspec (4.2.10)
       guard (~> 2.1)
       rspec (>= 2.14, < 4.0)
-    httparty (0.13.0)
-      json (~> 1.8)
+    hitimes (2.0.0)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    i18n (0.6.9)
-    json (1.8.1)
-    listen (2.4.0)
-      celluloid (>= 0.15.2)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    listen (2.10.1)
+      celluloid (~> 0.16.0)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
-    lumberjack (1.0.4)
-    method_source (0.8.2)
-    minitest (4.7.5)
-    multi_json (1.9.2)
-    multi_xml (0.5.5)
-    pry (0.9.12.4)
-      coderay (~> 1.0)
-      method_source (~> 0.8)
-      slop (~> 3.4)
-    rb-fsevent (0.9.4)
-    rb-inotify (0.9.3)
-      ffi (>= 0.5.0)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.7)
-    rspec-expectations (2.14.4)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.4)
-    safe_yaml (0.9.7)
-    slop (3.4.7)
-    thor (0.18.1)
-    thread_safe (0.3.2)
-    timers (1.1.0)
-    tzinfo (0.3.39)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    minitest (5.14.2)
+    multi_xml (0.6.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    timers (4.0.4)
+      hitimes
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
     webmock (1.16.1)
       addressable (>= 2.2.7)
       crack (>= 0.3.2)
@@ -81,3 +89,6 @@ DEPENDENCIES
   pensio_api!
   rspec (>= 2.14)
   webmock (~> 1.16.1)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -1,5 +1,7 @@
 # PensioAPI
-This gem covers most of the Merchant and eCommerce API functionality provided by Pensio (http://www.pensio.com).
+This gem covers most of the Merchant and eCommerce API functionality provided by AltaPay, formerly Pensio (https://altapay.com).
+
+Ruby 2.4.x or later is recommended.
 
 ## Getting Started
 
@@ -11,6 +13,10 @@ PensioAPI::Credentials.username = 'Your pensio username'
 PensioAPI::Credentials.password = 'Your pensio password'
 ```
 
+This is sufficient in the simple case where you only have a single integration with Pensio, using a single set of credentials.
+
+If you require support for multiple connections to Pensio's API, using different sets of credentials, you must define named 'credentials sets' - see below under [Multiple Credentials Sets](#multiple-credentials-sets).
+
 ## Transactions
 
 To query transactions in your Pensio gateway, use the method `PensioAPI::Transaction.find`. This takes a number of parameters as defined in the Pensio documentation. For example:
@@ -67,6 +73,38 @@ The library provides two generic error classes for requests.
 
 Additionally, a third error class `PensioAPI::NoCredentials` is raised if credentials have not been provided. See "Getting Started" for more details.
 
+## Multiple Credentials Sets
+
+If you require multiple connections to Pensio's API using different credentials, you must set up named credentials sets.  For example, if you need separate credentials for your membership payments and ticket sales, you can configure them as follows:
+
+```
+PensioAPI::Credentials.for(:membership).base_uri = 'Your pensio gateway URI for memberships'
+PensioAPI::Credentials.for(:membership).username = 'Your pensio username for memberships'
+PensioAPI::Credentials.for(:membership).password = 'Your pensio password for memberships'
+```
+
+```
+PensioAPI::Credentials.for(:tickets).base_uri = 'Your pensio gateway URI for tickets'
+PensioAPI::Credentials.for(:tickets).username = 'Your pensio username for tickets'
+PensioAPI::Credentials.for(:tickets).password = 'Your pensio password for tickets'
+```
+
+In this case, you *must* also pass the credential set to each request, by including a 'credentials' key in the options hash.  The value should be a String or Symbol with the credential set name (e.g. :tickets, 'tickets'), or the PensioAPI::Credentials instance itself (e.g. PensioAPI::Credentials.for(:tickets)).  For example, these three examples are equivalent:
+
+```
+PensioAPI::Transaction.find(credentials: :tickets, transaction_id: '123')
+PensioAPI::Transaction.find(credentials: 'tickets', transaction_id: '123')
+PensioAPI::Transaction.find(credentials: PensioAPI::Credentials.for(:tickets), transaction_id: '123')
+```
+
+Typically if you have multiple credentials sets, the default credentials (i.e. PensioAPI::Credentials.base_uri etc) are ignored, and making any Pensio API requests without explicitly passing a 'credentials' argument will raise  `PensioAPI::NoCredentials`. However, if you have an existing Pensio integration using the simple default credentials approach and now want to also use a named credentials set, you can tell the library to explicitly allow this, by setting:
+
+```
+PensioAPI::Credentials.allow_defaults = true
+```
+
+In this scenario, requests performed without an explicit credentials set will use the default set, and those with named credentials will use those.  BE CAREFUL: If you accidentally omit the 'credentials' options key when making a request, it will use the default credentials set, which could lead to undesired behaviour.  This is why, by default, if you have multiple credentials sets, the default set is disabled.
+
 ## TODO
 
 * Better documentation - more examples, RDoc docs

data/lib/pensio_api.rb

@@ -1,5 +1,7 @@
 require 'active_support/core_ext/string/inflections'
 
+require 'pensio_api/version'
+
 require 'pensio_api/mixins/id'
 require 'pensio_api/mixins/has_transactions'
 require 'pensio_api/mixins/method_missing'
@@ -8,6 +10,7 @@ require 'pensio_api/mixins/timestamps'
 
 require 'pensio_api/billing_address'
 require 'pensio_api/callback'
+require 'pensio_api/chargeback_event'
 require 'pensio_api/credentials'
 require 'pensio_api/ecommerce'
 require 'pensio_api/funding_list'
@@ -32,5 +35,6 @@ require 'pensio_api/responses/reservation'
 require 'pensio_api/responses/reservation_capture'
 require 'pensio_api/responses/reservation_release'
 require 'pensio_api/responses/subscription_charge'
+require 'pensio_api/responses/chargeback_callback'
 require 'pensio_api/responses/success_callback'
 require 'pensio_api/responses/subscription_failure_callback'

data/lib/pensio_api/callback.rb

@@ -3,16 +3,20 @@ module PensioAPI
     FakeRequest = Struct.new(:headers, :body)
  
     def self.parse_success(xml)
-      parse(xml, true)
+      parse(xml, :success)
     end
     
     def self.parse_failure(xml)
-      parse(xml, false)
+      parse(xml, :failure)
+    end
+
+    def self.parse_chargeback(xml)
+      parse(xml, :chargeback)
     end
     
     private 
     
-    def self.parse(xml, success)
+    def self.parse(xml, handler)
       params = MultiXml.parse(xml)
       
       request = FakeRequest.new(
@@ -20,11 +24,14 @@ module PensioAPI
         params['APIResponse']['Body']
       )
       
-      if success
+      case handler
+      when :success
         PensioAPI::Responses::SuccessCallback.new(request)
-      else
+      when :failure
         PensioAPI::Responses::SubscriptionFailureCallback.new(request)
+      when :chargeback
+        PensioAPI::Responses::ChargebackCallback.new(request)
       end
     end
   end
-end
+end

data/lib/pensio_api/chargeback_event.rb

@@ -0,0 +1,25 @@
+module PensioAPI
+  class ChargebackEvent
+    attr_reader :type
+    attr_reader :reason_code
+    attr_reader :reason
+    attr_reader :amount
+    attr_reader :currency
+    attr_reader :acquirer_transaction_id
+
+    def initialize(chargeback_body)
+      @raw = chargeback_body
+
+      @type = @raw['Type']
+      @reason_code = @raw['ReasonCode'].to_i
+      @reason = @raw['Reason']
+      @amount = BigDecimal(@raw['Amount'])
+      @currency = @raw['Currency']
+      @acquirer_transaction_id = @raw['AcquirerTransactionId']
+    end
+
+    def created_at
+      @created_at ||= Time.parse(@raw['Date'])
+    end
+  end
+end

data/lib/pensio_api/credentials.rb

@@ -1,7 +1,53 @@
 module PensioAPI
-  module Credentials
+  class Credentials
     class << self
-      attr_accessor :base_uri, :username, :password
+      attr_accessor :credentials_sets, :allow_defaults
+      
+      # backwards compatability - set default credentials
+      
+      def base_uri
+        default_credentials.base_uri
+      end
+      
+      def base_uri=(value)
+        default_credentials.base_uri = value
+      end
+      
+      def username
+        default_credentials.username
+      end
+      
+      def username=(value)
+        default_credentials.username = value
+      end
+      
+      def password
+        default_credentials.password
+      end
+      
+      def password=(value)
+        default_credentials.password = value
+      end
+      
+      def for(context)
+        self.credentials_sets ||= {}
+        self.credentials_sets[context.to_sym] ||= PensioAPI::Credentials.new
+      end
+      
+      def default_credentials
+        self.for(:default)
+      end
+      
+      def credentials_mode
+        self.for(:default)
+        self.credentials_sets.count == 1 ? :default : :multiple
+      end
     end
+    
+    def supplied?
+      !!(base_uri && username && password)
+    end
+    
+    attr_accessor :base_uri, :username, :password
   end
 end

data/lib/pensio_api/funding_list.rb

@@ -20,11 +20,11 @@ module PensioAPI
       @acquirer = @raw['Acquirer']
       @funding_date = Date.parse(@raw['FundingDate'])
       @created_at = Date.parse(@raw['CreatedDate'])
-      @download_link = @raw['DownloadLink']
+      @download_link = @raw['DownloadLink'].strip
     end
 
-    def download
-      @result ||= FundingListRequest.new(@download_link).result
+    def download(options={})
+      @result ||= FundingListRequest.new(@download_link, options).result
     end
   end
 end

data/lib/pensio_api/funding_list_request.rb

@@ -9,7 +9,7 @@ module PensioAPI
     def initialize(path, options={})
       super(path, options)
 
-      @result = CSV.parse(@response.parsed_response, col_sep: ';', headers: true).reject(&:empty?)
+      @result = CSV.parse(@response.body, col_sep: ';', headers: true).reject(&:empty?)
     end
   end
 end

data/lib/pensio_api/mixins/request_defaults.rb

@@ -4,23 +4,21 @@ module PensioAPI
       def self.included(base)
         base.send(:include, HTTParty)
         base.send(:attr_reader, :response)
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-        def set_base_uri
-          self.base_uri PensioAPI::Credentials.base_uri unless self.base_uri
-        end
+        base.send(:attr_accessor, :credentials)
       end
 
       HEADERS = {
-        'Content-Type' => 'application/x-www-form-urlencoded; charset=utf-8'
+        'Content-Type' => 'application/x-www-form-urlencoded; charset=utf-8',
+        'x-altapay-client-version' => "RUBYSDK/#{PensioAPI::VERSION}"
       }
 
       def initialize(path, options={})
-        self.class.set_base_uri
+        @credentials = options.delete(:credentials)
+        @credentials = PensioAPI::Credentials.for(@credentials.to_sym) unless @credentials.nil? || @credentials.is_a?(PensioAPI::Credentials)
+        @credentials ||= PensioAPI::Credentials.default_credentials if PensioAPI::Credentials.credentials_mode == :default || PensioAPI::Credentials.allow_defaults
+        raise Errors::NoCredentials unless @credentials && @credentials.supplied?
 
-        raise Errors::NoCredentials unless credentials_supplied?
+        self.class.base_uri @credentials.base_uri unless self.class.base_uri
 
         @response = self.class.post(path, request_options(options))
       end
@@ -28,23 +26,23 @@ module PensioAPI
       private
 
       def request_options(options)
+        timeout = options.delete(:timeout)
         {
           basic_auth: auth,
           headers: (options.delete(:headers) || {}).merge(HEADERS),
           body: options
-        }
+        }.tap do |request_options|
+          request_options[:timeout] = timeout if timeout
+        end
       end
 
       def auth
         {
-          username: PensioAPI::Credentials.username,
-          password: PensioAPI::Credentials.password
+          username: @credentials.username,
+          password: @credentials.password
         }
       end
 
-      def credentials_supplied?
-        Credentials.base_uri && Credentials.username && Credentials.password
-      end
     end
   end
 end

data/lib/pensio_api/request.rb

@@ -12,7 +12,7 @@ module PensioAPI
     end
 
     def response_contains?(key)
-      @body && @body.has_key?(key)
+      !!@body && @body.has_key?(key)
     end
   end
 end