pin-ruby 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 356743431583ed5f8d65d66afc14b86284e78673
-  data.tar.gz: fdb3e0727ac8ca496c00046a52a6540c681804d9
+  metadata.gz: 01730b41395bb4905a13620dd2e88fa0f1a303f6
+  data.tar.gz: 9e61e9bdbc7a6814003645521e28efd4c301c40b
 SHA512:
-  metadata.gz: fffa9b5c27e783bac2d2641805c0520dd2849fb701f18a8484b1b3d1163635695d8aa88cbd6f3c56d0bb91c7792de2df5c7692027748357c135a78c60035591e
-  data.tar.gz: 32125fab08f51c572997cc27c4c3152a1ec1bfc54ce173da8c6ff2e74e9d7cfc998c3ab84c5b50c2398eebeb5c1f5f3799c85c8be49c57433b8733867e21c7ba
+  metadata.gz: 643cb647fbaf356ee77ee02794a5e4a4e0c3be65bec0b8ba20b84fc1aa2356e56d706a4aceb9d88f91813594c6cb8216406ff0e2639eb8b67c5a2f3c24de1107
+  data.tar.gz: cfe17f44af91a1b1c36462eeff55632eac04c09a8195c153c03d36b4e9732188ff9485ccb2b4de1c47d17d71d62c888a9f2b45092eaa0f77daae8c382b87b0ae

data/README.md

@@ -1,8 +1,6 @@
-# Pin::Ruby
-
 A Ruby library for interacting with v1 of the [Pin Payments API](https://pin.net.au/docs/api).
 
-## Installation
+# Installation
 
 Add this line to your application's Gemfile:
 
@@ -45,11 +43,169 @@ When using the Pin library in a non-rails application, you must configure it to
         config.endpoint = 'api.pin.net.au'
     end
 
-## Usage
+# Usage
+
+    require 'pin/api'
+
+    client = Pin::API::Client.new()
+
+## Charges
+
+### List Charges
+
+Return a paginated list of `Pin::Models::Charge` objects:
+
+    client.charges()
+
+Optionally pass the `page` parameter to specify a different page of results:
+
+    client.charges(2)
+
+Will get the second page of charges.
+
+### Fetch Charge
+
+Get a specific customer by their token:
+
+    client.charge('ch_1234')
+
+Returns a `Pin::Models::Charge` object, or raises a `Pin::Error`:
+
+    HTTP Error 404: not_found
+
+### Search charges
+
+Search for charges by description, amount and date, as per [Pin's Documentation](https://pin.net.au/docs/api/charges#search-charges):
+
+    client.charge_search({:query => 'Test Transaction'})
+
+Returns a paginated list of `Pin::Models::Charges`.
+
+### Create Charge
+
+Charges a customer or card, and returns the newly created charge object:
+
+    client.create_charge('me@some.net', 'Test Transaction', '1295', 'AUD', request.remote_ip, 'cus_1234')
+
+The last parameter (`token_or_card`) can be either a customer token, a card token or a card hash.
+
+Returns a `Pin::Models::Charge` of the charge, or a `Pin::Error`, as per  [Pin's Documentation](https://pin.net.au/docs/api/charges#post-charges).
+
+## Customers
+
+### List Customers
+
+Return a paginated list of `Pin::Models::Customer` objects:
+
+    client.customers()
+
+Optionally pass the `page` parameter to specify a different page of results:
+
+    client.customers(2)
+
+Will get the second page of customers.
+
+### Fetch customer
+
+Get a specific customer by their token:
+
+    client.customer('cus_1234')
+
+Returns a `Pin::Models::Customer` object, or raises a `Pin::Error`:
+
+    HTTP Error 404: not_found
+
+### Customer's charges
+
+Gets a paginated list of charges against a customer:
+
+    client.customer_charges('cus_1234')
+
+Optionally pass a second parameter `page` to specify a different page of results:
+
+    client.customer_charges('cus_1234', 2)
+
+Returns a list of `Pin::Models::Charge` object, or raises a `Pin::Error`:
+
+    HTTP Error 404: not_found
+
+### Create Customer
+
+Create a new customer with either an existing card token, or a hash of card details):
+
+    client.create_customer('me@some.net', 'card_1234')
+
+or
+
+    client.create_customer('me@some.net', {:number => '5520000000000000', ... })
+
+Card hash should be supplied as per [Pin's documentation](https://pin.net.au/docs/api/cards):
+
+    {
+      "token": "card_nytGw7koRg23EEp9NTmz9w",
+      "display_number": "XXXX-XXXX-XXXX-0000",
+      "scheme": "master",
+      "address_line1": "42 Sevenoaks St",
+      "address_line2": null,
+      "address_city": "Lathlain",
+      "address_postcode": "6454",
+      "address_state": "WA",
+      "address_country": "Australia"
+    }  
+
+Returns the newly created customer as a `Pin::Models::Customer` object.
+
+### Update customer
+
+Update's a customer's card and/or email address:
+
+    client.update_customer('cus_1234', {:email => 'new@some.net', :card => {:number => '5520000000000000', ... } })
+
+Returns the updated customer as a `Pin::Models::Customer` object.
+
+## Refunds
+
+### List Refunds
+
+Return a paginated list of `Pin::Models::Refund` objects for the specified charge token:
+
+    client.refunds('ch_1234')
+
+Optionally pass the `page` parameter to specify a different page of results:
+
+    client.refunds('ch_1234', 2)
+
+Will get the second page of refunds for the specified charge.
+
+### Refund a charge
+
+Refunds the specified amount against an existing charge, and returns the refund object created, or a `Pin::Error`:
+
+    client.create_refund('ch_1234')
+
+By default `create_refund` refunds the full amount of the original charge. To specify a different amount, pass the amount as cents to the optional second parameter:
+
+    client.create_refund('ch_1234', '1000')
+
+Returns the refund object created, or a `Pin::Error`. 
+
+## Tokens
+
+### Create a token for a card
+
+Takes a card and stores it returning a reusable token for charges.
+
+    client.create_token('5520000000000000', '01', '2015', '123', 'John Appleseed', {
+        :line1 => '1 Main Street', 
+        :city => 'Melbourne', 
+        :postcode => '3000', 
+        :state => 'Victoria', 
+        :country => 'Australia'
+    })
 
-TODO: Write usage instructions here
+Returns a `Pin::Models::Card` containing the non-sensitive card details.
 
-## Contributing
+# Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/lib/pin/api/customers.rb

@@ -11,8 +11,8 @@ module Pin::API::Customers
     pin_response(raw_response, Pin::Models::Customer.new(raw_response['response']))
   end
 
-  def customer_charges(token)
-    raw_response = api_call(:get, "customers/#{token}/charges")
+  def customer_charges(token, page=1)
+    raw_response = api_call(:get, "customers/#{token}/charges", {:page => page})
 
     pin_response(raw_response, raw_response['response'].map { |e| Pin::Models::Charge.new(e) })
   end

data/lib/pin/api/refunds.rb

@@ -1,7 +1,7 @@
 module Pin::API::Refunds
 
-  def refunds(charge_token, params={})
-    raw_response = api_call(:get, "charges/#{charge_token}/refunds", params)
+  def refunds(charge_token, page=1)
+    raw_response = api_call(:get, "charges/#{charge_token}/refunds", {:page => page})
 
     pin_response(raw_response, raw_response['response'].map { |e| Pin::Models::Refund.new(e) })
   end

data/lib/pin/api/tokens.rb

@@ -34,6 +34,6 @@ module Pin::API::Tokens
     end
 
     raw_response = api_call(:post, 'cards', params)
-    pin_response(raw_response, Pin::Models::Charge.new(raw_response['response']))
+    pin_response(raw_response, Pin::Models::Card.new(raw_response['response']))
   end
 end

data/lib/pin/version.rb

@@ -1,3 +1,3 @@
 module Pin
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pin-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Michael Shimmins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-07 00:00:00.000000000 Z
+date: 2013-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json