pci_proxy 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3b3d7fc9150a054af99f760133f3f0e0c61b4101b9c9aaa6226697b2d19fa05
-  data.tar.gz: 9f0a96730a817e58c296f5c27b338204ba6d8fc007e15b051fa8785670dfc18c
+  metadata.gz: e3809fc9d53de874082c4b1c7ffb7ad715adcfeb2fea22fef66266d4072d41bd
+  data.tar.gz: 176d0778aa1f90c0e6f95fc141da290fd951ace11c3a5232a617bc9db21ba474
 SHA512:
-  metadata.gz: c48acd895516a36dc3d5d3980b22164db5711e79baec8f96a3268748dc73d00fa220013cd764480eeaf4702787495aeee904e22b86acaf8aa3e008e85f2d0fec
-  data.tar.gz: 5cfaa045d5167aa2da4a5c6a477ccdc59ed34f7e05af5789fbbffced9d4536335cedf29d4371889d03b237114ed30383fb7f9ebd0764cb0ded29655c406bd468
+  metadata.gz: 154eb6fd451665825ba0eb146fa12c51448c815cfc13dd1dbea93a65f49c35053c2ae1ae9691622ba198770cfc8ddbed7e01030e13504445cdf255d8010ac9b0
+  data.tar.gz: 44975973ccded51daa015e25000291f7a992ec1ecd642119491a5c589bf16bf6e10f9a145c2164e344242425edf40de0b7f26fc6a64016bac3c67b94d104af97

data/CHANGELOG.md

@@ -2,4 +2,8 @@
 
 A simple client library for [PCI Proxy](https://pci-proxy.com)'s API
 
-v1.0.0 - 14th January 2020 - Initial release - covers the [Token API](https://docs.pci-proxy.com/collect-and-store-cards/capture-iframes/token-api)
+v1.1.0 - 17th January 2020 - Return an instance of PciProxy::Model::TokenisedCard instead of plain Hash
+
+v1.0.1 - 14th January 2020 - Relax dependency version requirements
+
+v1.0.0 - 14th January 2020 - Initial release - covering the [Token API](https://docs.pci-proxy.com/collect-and-store-cards/capture-iframes/token-api)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pci_proxy (1.0.1)
+    pci_proxy (1.1.0)
       faraday (>= 0.8.9)
       multi_json (>= 1.10.0)
 

data/README.md

@@ -35,10 +35,10 @@ And execute a token exchange like so:
 client.execute(transaction_id: '1234567890')
 ```
 
-In the event of a 200 OK response, the JSON response body is returned as a hash, for example:
+In the event of a 200 OK response, an instance of PciProxy::Model::TokenisedCard is returned:
 
 ```ruby
-{"aliasCC"=>"411111GGCMUJ1111", "aliasCVV"=>"vCslSwP0SQ9JXJy-nDzLKHaS"}
+#<PciProxy::Model::TokenisedCard:0x00007fda073453f8 @response={"aliasCC"=>"411111GGCMUJ1111", "aliasCVV"=>"b8XeAbhQQES6OVWTpOCaAscj", "paymentMethod"=>"VIS"}, @pan_token="411111GGCMUJ1111", @cvv_token="b8XeAbhQQES6OVWTpOCaAscj", @type_slug=:visa>
 ```
 
 In the event of an error, a subclass of ```PciProxyAPIError``` will be raised.

data/lib/pci_proxy.rb

@@ -3,6 +3,7 @@ require "pci_proxy/version"
 
 require 'pci_proxy/base'
 require 'pci_proxy/token'
+require 'pci_proxy/model/tokenised_card'
 
 module PciProxy
   PciProxyAPIError = Class.new(StandardError)

data/lib/pci_proxy/model/tokenised_card.rb

@@ -0,0 +1,43 @@
+module PciProxy
+  module Model
+    class TokenisedCard
+
+      attr_reader :pan_token, :cvv_token, :type_slug, :response
+
+      def initialize(response)
+        @response = response
+        @pan_token = response["aliasCC"]
+        @cvv_token = response["aliasCVV"]
+        @type_slug = slug_for(response["paymentMethod"])
+      end
+
+      private
+
+      def slug_for(payment_method)
+        return nil if payment_method.nil?
+
+        case payment_method
+        when 'VIS'
+          :visa
+        when 'ECA'
+          :mastercard
+        when 'AMX'
+          :amex
+        when 'DIN'
+          :diners
+        when 'DIS'
+          :discovery
+        when 'JCB'
+          :jcb
+        when 'ELO'
+          :elo
+        when 'CUP'
+          :cup
+        else
+          :unknown
+        end
+
+      end
+    end
+  end
+end

data/lib/pci_proxy/token.rb

@@ -18,7 +18,8 @@ module PciProxy
     # @raise [PciProxyAPIError] in cases where the API responds with a non-200 response code
     # @return [Hash] result from PCI Proxy, decoded from JSON
     def execute(transaction_id:, return_payment_method: true, cvv_mandatory: false)
-      request(params: { transactionId: transaction_id, returnPaymentMethod: return_payment_method, mandatoryAliasCVV: cvv_mandatory })
+      response = request(params: { transactionId: transaction_id, returnPaymentMethod: return_payment_method, mandatoryAliasCVV: cvv_mandatory })
+      PciProxy::Model::TokenisedCard.new(response)
     end
 
   end

data/lib/pci_proxy/version.rb

@@ -1,3 +1,3 @@
 module PciProxy
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pci_proxy
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Rory Sinclair
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-14 00:00:00.000000000 Z
+date: 2020-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,6 +100,7 @@ files:
 - bin/setup
 - lib/pci_proxy.rb
 - lib/pci_proxy/base.rb
+- lib/pci_proxy/model/tokenised_card.rb
 - lib/pci_proxy/token.rb
 - lib/pci_proxy/version.rb
 - pci_proxy.gemspec