pensio_api 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8df2a4f55de1b2a15095fcb0eae66ec28a0556f2
-  data.tar.gz: 1e65cb234c4d22f00599fcc15821519322ebe2c6
+  metadata.gz: f9543dfa7d71a3752517ac385c643f887f78bdb4
+  data.tar.gz: 0fe99ac756ee3145f76f29eae0a993d5e36af8d0
 SHA512:
-  metadata.gz: 808300554a974100f949ec893f789cc36ca686c9e8b5d6a8afd36ea890e884847e5ff6837b86b4cdba5f8c3c3c91da8be81894f1f4053e259ece8105814f01db
-  data.tar.gz: 96af16fe19782e17c5f6be0cbc3ca625ac1faee1fb57036f956f2b7a3a5e32d95decde08fb09954fcc2ad1c8e6fe2209efea79073e874bb1a04cb5447b50e47e
+  metadata.gz: 630b0086874a418ca44e8f9a0eb34174a89bbabd840e0fa8571ffea67a6179d45b83551b36239c3ac066a8fd0e05e335c9e7c389473b33e2c2a9aeadeb50bfd0
+  data.tar.gz: 3c0f93a5fca86731e5b784c32d9dfebae6a43b94274d06ac839ad9f61b1373cca937d491615bb6e9f126b6775dc297e9b832de46b86c8eb3a160a917e25948c1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pensio_api (0.3.0)
+    pensio_api (0.3.1)
       activesupport (>= 3.2)
       httparty (>= 0.12.0)
       multi_xml (>= 0.5.2)
@@ -9,12 +9,12 @@ 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)
+    activesupport (4.2.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
     addressable (2.3.5)
     celluloid (0.15.2)
       timers (~> 1.1.0)
@@ -36,16 +36,15 @@ GEM
     httparty (0.13.0)
       json (~> 1.8)
       multi_xml (>= 0.5.2)
-    i18n (0.6.9)
-    json (1.8.1)
+    i18n (0.7.0)
+    json (1.8.2)
     listen (2.4.0)
       celluloid (>= 0.15.2)
       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)
+    minitest (5.5.1)
     multi_xml (0.5.5)
     pry (0.9.12.4)
       coderay (~> 1.0)
@@ -65,9 +64,10 @@ GEM
     safe_yaml (0.9.7)
     slop (3.4.7)
     thor (0.18.1)
-    thread_safe (0.3.2)
+    thread_safe (0.3.5)
     timers (1.1.0)
-    tzinfo (0.3.39)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
     webmock (1.16.1)
       addressable (>= 2.2.7)
       crack (>= 0.3.2)

data/README.md

@@ -11,6 +11,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 +71,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/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

@@ -23,8 +23,8 @@ module PensioAPI
       @download_link = @raw['DownloadLink']
     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/mixins/request_defaults.rb

@@ -4,13 +4,7 @@ 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 = {
@@ -18,9 +12,12 @@ module PensioAPI
       }
 
       def initialize(path, options={})
-        self.class.set_base_uri
-
-        raise Errors::NoCredentials unless credentials_supplied?
+        @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?
+        
+        self.class.base_uri @credentials.base_uri unless self.class.base_uri
 
         @response = self.class.post(path, request_options(options))
       end
@@ -37,14 +34,11 @@ module PensioAPI
 
       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/pensio_api.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'pensio_api'
-  s.version = '0.3.0'
+  s.version = '0.3.1'
   s.license = 'BSD-3-Clause'
   s.summary = "Provides integration for the Pensio Merchant API"
   s.authors = ['Michael Sell', 'Rory Sinclair']

data/spec/lib/pensio_api/request_spec.rb

@@ -18,8 +18,8 @@ describe PensioAPI::Request do
       before :each do
         PensioAPI::Request.stub(:post).and_return(
           construct_response({
-            'Test' => 'true'
-          })
+              'Test' => 'true'
+            })
         )
       end
 
@@ -82,6 +82,27 @@ describe PensioAPI::Request do
         expect(p.send(:request_options, {transaction_id: 5432})[:body][:transaction_id]).to eq(5432)
       end
     end
+    
+    context 'with alternative credentials' do
+      it 'sends the correct credentials' do
+        creds = PensioAPI::Credentials.for(:ticketing)
+        creds.base_uri = 'https://www.test.com'
+        creds.username = 'ticketing_username'
+        creds.password = 'ticketing_password'
+        
+        # pass credentials instance
+        req1 = PensioAPI::Request.new('/test', credentials: creds) 
+        
+        # or pass credentials set name
+        req2 = PensioAPI::Request.new('/test', credentials: :ticketing)
+        
+        expect(req1.send(:request_options, {})[:basic_auth]).to_not be_nil
+        expect(req1.send(:request_options, {})[:basic_auth]).to eq({ username: creds.username, password: creds.password})
+        
+        expect(req2.send(:request_options, {})[:basic_auth]).to_not be_nil
+        expect(req2.send(:request_options, {})[:basic_auth]).to eq({ username: creds.username, password: creds.password})
+      end
+    end
   end
 
   describe 'error handling' do
@@ -107,11 +128,7 @@ describe PensioAPI::Request do
 
     context 'with incomplete credentials' do
       before :each do
-        PensioAPI::Credentials = OpenStruct.new({
-          base_uri: nil,
-          username: nil,
-          password: nil
-        })
+        PensioAPI::Credentials.base_uri = nil
       end
 
       it 'raises a PensioAPI::Errors::NoCredentials error' do

data/spec/spec_helper.rb

@@ -16,6 +16,7 @@ RSpec.configure do |config|
     PensioAPI::Credentials.base_uri = 'https://testgateway.pensio.com'
     PensioAPI::Credentials.username = 'test_user'
     PensioAPI::Credentials.password = 'password'
+    PensioAPI::Credentials.allow_defaults = true # because some spec examples set up additional creds
   end
 
   # Run specs in random order to surface order dependencies. If you find an

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pensio_api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Michael Sell
@@ -9,104 +9,104 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-25 00:00:00.000000000 Z
+date: 2015-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.16.1
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.2.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.2.5
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.2.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.2.4
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: multi_xml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.2
 description: 
@@ -115,7 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .rspec
+- ".rspec"
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -217,17 +217,17 @@ 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.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Provides integration for the Pensio Merchant API