pr-pin 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 351423e96e140be0cfc71d237c63843bb817c7c18412b61cef905dca087a6c81
-  data.tar.gz: 3dd044b2514e87abc637f079800422d553a393e491b0b7455270e723259f6869
+  metadata.gz: e52cacf6c475aff3f5bce1ae540a40311d62907bb7384b797a63daa8e064434d
+  data.tar.gz: 8f45f062ed9148fb0a8c3e85b6d8ce3b3176193404b2479d4fc3404421457b48
 SHA512:
-  metadata.gz: e959f6b6d6d2999789fec7333556dea26f4ee37e90177e00c003804bcc88b21e771b408703468e4a692d4cf38281418181070574aeda4b3b649a719e5d2e0292
-  data.tar.gz: b49f72a07fe9bcd745f427ea44883c349b931f9bd8c5d155361ce6234e59ae73fedd4363a71e757c361d27169c5655335c77b4a7c50e1e90507e28ebddf0bef5
+  metadata.gz: 7647fc611ae51dd161fa406344f7fed7dca217aba9779e01ef06287f556a1f9ac2a29a5163183bd8dd8421c471ee06f123e1fe3121b8aec3b49061e8b88c72a2
+  data.tar.gz: b6a18bd913ec606128be3a7db21dddc3a42d62bd4cc24cfaec6a2158670811bb4d27eb2955353ea09b026a64f7e0afe04a64eb1243825cc77446d1a597571bee

data/README.md

@@ -18,16 +18,41 @@ Or install it yourself as:
 
 ## Usage
 
+### Registering Connections
 ```ruby
 # Require the gem
 require 'pr-pin'
 
-# Connect using your Pin Payments secret key
-PR::Pin.connect(
+# Register a connection using your Pin Payments secret key
+PR::Pin.register_connection(
   secret_key: 'your_secret_key',
+  # raise on error, defaults to returning PR::Pin::API::Error instance
+  error_handler: ->(exception) { raise(exception) },
   sandbox: true # Defaults to true, false for production
 )
 
+# You can register another connection by passsing an identifier to
+# PR::Pin.register_connection, i.e.
+PR::Pin.register_connection(
+  :admin, # defaults to :default
+  secret_key: 'your_secret_key',
+  sandbox: true
+)
+
+# Then, you can specify the connection to use when resolving the
+# endpoint repository from the PR::Pin container
+customers = PR::Pin.customers(:admin).list(page: 1)
+# => [#<PR::Pin::Struct::Customer>, ...]
+customers.current_page # => 1
+customers.per_page # => 25
+customers.prev_page # => nil
+customers.next_page # => 2
+customers.total_count # => 53
+customers.total_pages # => 3
+```
+
+### One-off charge
+```ruby
 # Create a charge using a token, you can get a card token
 # using Pin Payments hosted fields, or by creating a card
 # via the API, this can be used to take a one-off payment
@@ -38,11 +63,13 @@ charge = PR::Pin.charges.create(
   ip_address: '127.0.0.1',
   card_token: 'card_58b6c52f131956c4394ba7'
 )
-
 charge.success? # => true
 charge.error? # => false
 charge # => #<PR::Pin::Struct::Charge>
+```
 
+### Recurring payments
+```ruby
 # For a subscription, create a customer using a card token
 customer = PR::Pin.customers.create(
   email: 'a.user@petrescue.com.au',
@@ -53,7 +80,7 @@ customer.error? # => false
 customer # => #<PR::Pin::Struct::Customer>
 
 # And then attach a subscription using the plan token from
-# the plans endpoint (you may need to create the plan first)
+# the plans endpoint (you will need to create the plan first)
 subscription = PR::Pin.subscriptions.create(
   plan_token: 'plan_2d16b31863015a57820b70',
   customer_token: 'cus_9d18a4516a6ae777-NDecB'
@@ -63,6 +90,18 @@ subscription.error? # => false
 subscription # => #<PR::Pin::Struct::Subscription>
 ```
 
+### Errors - See [PR::Pin::API::Error](https://github.com/PetRescue/pr-pin/blob/master/lib/pr/pin/api/error.rb)
+```ruby
+charge = PR::Pin.charges.create(
+  email: 'a.user@petrescue.com.au'
+)
+charge.success? # => false
+charge.error? # => true
+charge.code # => "invalid_resource"
+charge.description # => "One or more parameters were missing or invalid"
+charge # => => #<PR::Pin::API::Error>
+```
+
 ## API Coverage
 
 Coverage of https://pinpayments.com/developers/api-reference

data/lib/pr/pin.rb

@@ -19,7 +19,7 @@ module PR
     register(:default_error_handler) { |error| error }
 
     class << self
-      def connect(
+      def register_connection(
         identifier = :default,
         secret_key:,
         sandbox: true,

data/lib/pr/pin/version.rb

@@ -1,5 +1,5 @@
 module PR
   module Pin
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pr-pin
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - AMHOL
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-18 00:00:00.000000000 Z
+date: 2019-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler