pci_proxy 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3809fc9d53de874082c4b1c7ffb7ad715adcfeb2fea22fef66266d4072d41bd
-  data.tar.gz: 176d0778aa1f90c0e6f95fc141da290fd951ace11c3a5232a617bc9db21ba474
+  metadata.gz: 6a88f474d4153735ec851a18cbdfc91aded2a3b9ab310b29887e9a05e3943fc9
+  data.tar.gz: 46fb731fb0604451d084d29bf8cf0c1d7ab7e54475447fe22a594379fbd6d8ff
 SHA512:
-  metadata.gz: 154eb6fd451665825ba0eb146fa12c51448c815cfc13dd1dbea93a65f49c35053c2ae1ae9691622ba198770cfc8ddbed7e01030e13504445cdf255d8010ac9b0
-  data.tar.gz: 44975973ccded51daa015e25000291f7a992ec1ecd642119491a5c589bf16bf6e10f9a145c2164e344242425edf40de0b7f26fc6a64016bac3c67b94d104af97
+  metadata.gz: 43fb21c87681f6c3953259561beb31196231ff75e5b0d7df470c204f301c2a3d0e9230598d0c02dcc1295a7635b8a1bfa6044745e8c523256355f96a5ffdc295
+  data.tar.gz: 99d59b3029c316d64325a003b3f835bb9e0aeccda201450119f72bfccf7dc0e280a33bdd091283028a3f5ea2290d6442caee3d531196e063bd4476769c405f6b

data/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 A simple client library for [PCI Proxy](https://pci-proxy.com)'s API
 
+v1.2.0 - 30th January 2020 - Add support for the [Check API](https://docs.pci-proxy.com/use-stored-cards/check)
+
 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

data/lib/pci_proxy.rb

@@ -2,7 +2,9 @@ require 'bundler'
 require "pci_proxy/version"
 
 require 'pci_proxy/base'
+require 'pci_proxy/check'
 require 'pci_proxy/token'
+require 'pci_proxy/model/check_result'
 require 'pci_proxy/model/tokenised_card'
 
 module PciProxy
@@ -20,4 +22,5 @@ module PciProxy
   HTTP_FORBIDDEN_CODE = 403
   HTTP_NOT_FOUND_CODE = 404
   HTTP_UNPROCESSABLE_ENTITY_CODE = 429
+
 end

data/lib/pci_proxy/base.rb

@@ -4,6 +4,8 @@ require 'multi_json'
 module PciProxy
   class Base
 
+    JSON_UTF8_CONTENT_TYPE = 'application/json; charset=UTF-8'.freeze
+
     attr_reader :api_endpoint, :api_username, :api_password
 
     ##
@@ -17,19 +19,35 @@ module PciProxy
     end
 
     ##
-    # Perform the API request
+    # Perform an API request via HTTP GET
     #
     # @param +endpoint+ [String] (Optional) - the API endpoint to hit - defaults to the value of the api_endpoint reader
-    # @param +http_method+ [Symbol] (Optional) - the HTTP method to use - defaults to GET
-    # @param +params+ [Hash] (Optional) - any parameters to supply to the API call
+    # @param +params+ [Hash] (Optional) - any URL parameters to supply to the API call
     #
     # @raise [PciProxyAPIError] in cases where the API responds with a non-200 response code
     # @return [Hash] parsed JSON response
+    def api_get(endpoint: @api_endpoint, params: {}, raise_on_error: true)
+      response = client.get(endpoint, params)
+
+      if raise_on_error == false || response.status == HTTP_OK_CODE
+        return MultiJson.load(response.body)
+      end
+
+      raise error_class(response), "HTTP status: #{response.status}, Response: #{response.body}"
+    end
+
+    ##
+    # Perform an API request via HTTP POST
+    #
+    # @param +endpoint+ [String] (Optional) - the API endpoint to hit - defaults to the value of the api_endpoint reader
+    # @param +body+ [Hash] (Optional) - the API request payload (will be converted to JSON)
     #
-    def request(endpoint: @api_endpoint, http_method: :get, params: {})
-      response = client.public_send(http_method, endpoint, params)
+    # @raise [PciProxyAPIError] in cases where the API responds with a non-200 response code
+    # @return [Hash] parsed JSON response
+    def api_post(endpoint: @api_endpoint, body: {}, raise_on_error: true)
+      response = client.post(endpoint, MultiJson.dump(body), "Content-Type" => JSON_UTF8_CONTENT_TYPE)
 
-      if response.status == HTTP_OK_CODE
+      if raise_on_error == false || response.status == HTTP_OK_CODE
         return MultiJson.load(response.body)
       end
 

data/lib/pci_proxy/check.rb

@@ -0,0 +1,62 @@
+module PciProxy
+  class Check < Base
+
+    SANDBOX_ENDPOINT = 'https://api.sandbox.datatrans.com/v1/transactions/validate'.freeze
+    LIVE_ENDPOINT = 'https://api.datatrans.com/v1/transactions/validate'.freeze
+
+    CHF = 'CHF'.freeze
+    EUR = 'EUR'.freeze
+
+    # error codes
+    # "UNKNOWN_ERROR", "UNRECOGNIZED_PROPERTY", "INVALID_PROPERTY", "INVALID_TRANSACTION_STATUS", "TRANSACTION_NOT_FOUND", "INVALID_JSON_PAYLOAD", "UNAUTHORIZED", "EXPIRED_CARD", "INVALID_CARD", "UNSUPPORTED_CARD", "DUPLICATED_REFNO", "DECLINED", "BLOCKED_BY_VELOCITY_CHECKER", "CLIENT_ERROR" , "SERVER_ERROR"
+
+    ##
+    # Initialise with the specified +api_username+ and +api_password+ from PCI Proxy.
+    #
+    # Defaults to the sandbox API endpoint - to use the live environment,
+    # supply the LIVE_ENDPOINT constant as the value of the +endpoint+ kwarg
+    def initialize(api_username:, api_password:, endpoint: SANDBOX_ENDPOINT)
+      @api_endpoint = endpoint
+      @api_username = api_username
+      @api_password = api_password
+    end
+
+    ##
+    # Perform a check API request to verify the card token
+    #
+    # @param +reference+ [String] - caller's unique reference (any non-empty string value)
+    # @param +card_token+ [String] - card token obtained from the Token API - see PciProxy::Token
+    # @param +card_type+ [Symbol / String] - one of 'visa', 'mastercard' or 'amex'
+    # @param +expiry_month+ [Integer / String] - integer 1-12, or string '01' - '12'
+    # @param +expiry_year+ [Integer / String] - two or four digit year as a string or integer
+    # @param +currency+ [Integer / String] (Optional) - one of 'CHF' or 'EUR' - will default by card type where not specified
+    #
+    # @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(reference:, card_token:, card_type:, expiry_month:, expiry_year:, currency: nil)
+      raise "reference is required" if reference.empty?
+      raise "card_token is required" unless card_token && !card_token.empty?
+      raise "card_type must be one of 'visa', 'mastercard' or 'amex'" unless [:visa, :mastercard, :amex].include?(card_type.to_sym)
+      raise "invalid expiry_month" unless (1..12).include?(expiry_month.to_i)
+      raise "invalid expiry_year" unless expiry_year.to_i > 0
+
+      # default the currency where not specified - according to the documentation Amex should use EUR, Visa and MC should use CHF
+      currency ||= :amex == card_type ? EUR : CHF
+
+      card = {
+          alias: card_token,
+          expiryMonth: expiry_month.to_s,
+          expiryYear: expiry_year.to_s.chars.last(2).join
+      }
+
+      body = {
+          refno: reference,
+          currency: currency,
+          card: card
+      }
+
+      PciProxy::Model::CheckResult.new(api_post(endpoint: @api_endpoint, body: body, raise_on_error: false))
+    end
+
+  end
+end

data/lib/pci_proxy/model/check_result.rb

@@ -0,0 +1,18 @@
+module PciProxy
+  module Model
+    class CheckResult
+
+      attr_reader :response, :status, :error, :auth_code, :transaction_id
+
+      def initialize(response)
+        @response = response
+        @auth_code = response["acquirerAuthorizationCode"]
+        @transaction_id = response["transactionId"]
+        @error = response["error"]
+
+        @status = @auth_code && @transaction_id && !@error ? 'success' : 'error'
+      end
+
+    end
+  end
+end

data/lib/pci_proxy/model/tokenised_card.rb

@@ -2,7 +2,7 @@ module PciProxy
   module Model
     class TokenisedCard
 
-      attr_reader :pan_token, :cvv_token, :type_slug, :response
+      attr_reader :response, :pan_token, :cvv_token, :type_slug
 
       def initialize(response)
         @response = response

data/lib/pci_proxy/token.rb

@@ -1,25 +1,35 @@
 module PciProxy
   class Token < Base
 
+    SANDBOX_ENDPOINT = 'https://api.sandbox.datatrans.com/upp/services/v1/inline/token'.freeze
+    LIVE_ENDPOINT = 'https://api.datatrans.com/upp/services/v1/inline/token'.freeze
+
     ##
     # Initialise with the specified +api_username+ and +api_password+ from PCI Proxy.
-    def initialize(api_username:, api_password:)
-      @api_endpoint = 'https://api.sandbox.datatrans.com/upp/services/v1/inline/token'.freeze
+    #
+    # Defaults to the sandbox API endpoint - to use the live environment,
+    # supply the LIVE_ENDPOINT constant as the value of the +endpoint+ kwarg
+    def initialize(api_username:, api_password:, endpoint: SANDBOX_ENDPOINT)
+      @api_endpoint = endpoint
       @api_username = api_username
       @api_password = api_password
     end
 
     ##
-    # Perform a token request to turn the specified +transaction_id+ into card and CVV tokens
+    # Perform a token API request to turn the specified +transaction_id+ into card and CVV tokens
     #
     # @param +return_payment_method+ (true/false) - whether or not to return the identified payment method (default: true)
     # @param +cvv_mandatory+ (true/false) - whether or not to consider the CVV alias should be mandatory (default: false)
     #
     # @raise [PciProxyAPIError] in cases where the API responds with a non-200 response code
-    # @return [Hash] result from PCI Proxy, decoded from JSON
+    # @return [PciProxy::Model::TokenisedCard] wrapper object around the JSON response
     def execute(transaction_id:, return_payment_method: true, cvv_mandatory: false)
-      response = request(params: { transactionId: transaction_id, returnPaymentMethod: return_payment_method, mandatoryAliasCVV: cvv_mandatory })
-      PciProxy::Model::TokenisedCard.new(response)
+      raise "transaction_id is required" unless transaction_id && !transaction_id.empty?
+
+      PciProxy::Model::TokenisedCard.new(api_get(params: {
+          transactionId: transaction_id,
+          returnPaymentMethod: return_payment_method,
+          mandatoryAliasCVV: cvv_mandatory }))
     end
 
   end

data/lib/pci_proxy/version.rb

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

metadata

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