pci_proxy 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a88f474d4153735ec851a18cbdfc91aded2a3b9ab310b29887e9a05e3943fc9
-  data.tar.gz: 46fb731fb0604451d084d29bf8cf0c1d7ab7e54475447fe22a594379fbd6d8ff
+  metadata.gz: 47c687f9c8597bf60929b77d33f0849ed847381885eb7a17a82e1658e98a35bc
+  data.tar.gz: 361afd9f1839a8661cf9116ba4739e7844e290a974cc0a745721683ac09df7b3
 SHA512:
-  metadata.gz: 43fb21c87681f6c3953259561beb31196231ff75e5b0d7df470c204f301c2a3d0e9230598d0c02dcc1295a7635b8a1bfa6044745e8c523256355f96a5ffdc295
-  data.tar.gz: 99d59b3029c316d64325a003b3f835bb9e0aeccda201450119f72bfccf7dc0e280a33bdd091283028a3f5ea2290d6442caee3d531196e063bd4476769c405f6b
+  metadata.gz: 2c93bb9d784fdd2e513cdb37b7a3168997563307068f552f2071cc6a5d9f1d0d503fd4c860866e8dc640bd5921b1f2b30c153525a0283d8a12242468e4e55787
+  data.tar.gz: 74047acd5ee6bc8f197fb25d4bcb90e9ff84cd9bd73809281d0bc624ebbbf927fefebcbb792918e09b98d8dcbf557192b3875e7f3c8124c90ad7e42657094bcf

data/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 A simple client library for [PCI Proxy](https://pci-proxy.com)'s API
 
+v1.2.1 - 30th January 2020 - Minor tweaks; cleanups; update documentation
+
 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pci_proxy (1.1.0)
+    pci_proxy (1.2.0)
       faraday (>= 0.8.9)
       multi_json (>= 1.10.0)
 
@@ -26,4 +26,4 @@ DEPENDENCIES
   rake (~> 10.0)
 
 BUNDLED WITH
-   2.1.2
+   2.1.4

data/README.md

@@ -20,7 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
-Initially, this gem only covers the [Token API](https://docs.pci-proxy.com/collect-and-store-cards/capture-iframes/token-api), which converts a transactionId from the [secure fields](https://docs.pci-proxy.com/collect-and-store-cards/capture-iframes) mechanism into tokenised card PAN and CVV.
+Initially, this gem only covers the [Token API](https://docs.pci-proxy.com/collect-and-store-cards/capture-iframes/token-api), which converts a transactionId from the [secure fields](https://docs.pci-proxy.com/collect-and-store-cards/capture-iframes) mechanism into tokenised card PAN and CVV, and the [Check API](https://docs.pci-proxy.com/use-stored-cards/check) which allows verification of a card token.
 
 Pull requests are most welcome for coverage of other PCI Proxy APIs :)
 ### Token API - Usage
@@ -38,8 +38,17 @@ client.execute(transaction_id: '1234567890')
 In the event of a 200 OK response, an instance of PciProxy::Model::TokenisedCard is returned:
 
 ```ruby
-#<PciProxy::Model::TokenisedCard:0x00007fda073453f8 @response={"aliasCC"=>"411111GGCMUJ1111", "aliasCVV"=>"b8XeAbhQQES6OVWTpOCaAscj", "paymentMethod"=>"VIS"}, @pan_token="411111GGCMUJ1111", @cvv_token="b8XeAbhQQES6OVWTpOCaAscj", @type_slug=:visa>
+#<PciProxy::Model::TokenisedCard:0x00007fda073453f8 @pan_token="411111GGCMUJ1111", @cvv_token="b8XeAbhQQES6OVWTpOCaAscj", @type_slug=:visa>
 ```
+(```response``` attr_reader value omitted for clarity)
+
+This object has attr_readers for ```pan_token```, ```cvv_token``` and ```type_slug``` which will return one of the following symbols:
+
+```ruby
+[:visa, :mastercard, :amex, :diners, :discovery, :jcb, :elo, :cup, :unknown]
+```
+
+It also has an attr_reader for ```response``` which is the raw parsed JSON response, as a hash.
 
 In the event of an error, a subclass of ```PciProxyAPIError``` will be raised.
 
@@ -49,6 +58,38 @@ The most likely error is that the transactionId temporary token has expired, res
 PciProxy::BadRequestError (HTTP status: 400, Response: Tokenization not found)
 ```
 
+### Check API - Usage
+
+Create an instance of ```PciProxy::Check``` and call ```execute``` as follows:
+
+```ruby
+client = PciProxy::Check.new(api_username: 'username', api_password: 'password')
+```
+
+And execute a card verification like so:
+
+```ruby
+client.execute(reference: 'foo', card_token: '411111GGCMUJ1111', card_type: :visa, expiry_month: 1, expiry_year: 2022)
+```
+
+In all cases (success, denoted by 200 OK from the API, or error, denoted by non-200 response), an instance of ```PciProxy::Model::CheckResult``` is returned.
+
+This object has attr_readers for ```auth_code```, ```transaction_id```, ```status``` and ```error```
+
+It also has an attr_reader for ```response``` which is the raw parsed JSON response, as a hash.
+
+With a successful response, the object's ```status``` attribute will have the value ```:success```, and the ```auth_code``` and ```transaction_id``` values will be available:
+```ruby
+#<PciProxy::Model::CheckResult:0x00007fbda2186fe8 @auth_code="124101", @transaction_id="190828124101219812", @error=nil, @status=:success>
+```
+(```response``` attr_reader value omitted for clarity)
+
+With an unsuccessful response, the object's ```status``` attribute will have the value ```:error```:
+```ruby
+#<PciProxy::Model::CheckResult:0x00007fbda2186fe8 @auth_code=nil, @transaction_id=nil, @error={"code"=>"UNAUTHORIZED", "message"=>"The account is not configured to use this API."}, @status=:error>
+```
+(```response``` attr_reader value omitted for clarity)
+
 ## Changes
 See [Changelog](CHANGELOG.md)
 

data/lib/pci_proxy/model/check_result.rb

@@ -10,7 +10,7 @@ module PciProxy
         @transaction_id = response["transactionId"]
         @error = response["error"]
 
-        @status = @auth_code && @transaction_id && !@error ? 'success' : 'error'
+        @status = @auth_code && @transaction_id && !@error ? :success : :error
       end
 
     end

data/lib/pci_proxy/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pci_proxy
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Rory Sinclair