promisepay 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23ea2e12b7d1d4f35d341d41172be42221ee8291
-  data.tar.gz: 132b72a092ec9ad83e6d5ae6c8b01e156a3410df
+  metadata.gz: 81abebc5923d9af216511284d1940b4856ec1ff5
+  data.tar.gz: 048efbbeb3acb567028438500473b64c277850e8
 SHA512:
-  metadata.gz: f3c30eec78f309ef4750b9f8d719b65e04ddcea609e0b45aed746b1c1065e29806f0087e97ded5740b12915f099eb0b12a218d6801652ddb9095ef60d6be1dab
-  data.tar.gz: 5ef05d8c96a61ef9452d5d4ad0b62a90912c69a14bd06fb2ea625259f78637a53f98c664905c9a7e2ed2c94990ad41eac48e6f0ddc76b2660adcaf52935b6992
+  metadata.gz: b9d25d958566d6a19773f0b76b7c4b05dd4d2657a981810577bf367cb09ab1573f6082962bd1fd8d86f87997366a0592514ad53f498dbb6b66254e810d89a5de
+  data.tar.gz: 6bee0b0b9e0a808abc3089eb4884c59999da7fb72c078be950d69d79e2bf8a89b72845807d14a77ce416d3fe439f84ac543691f91173827ce2a3dd7d79b44f93

data/LICENSE.txt

@@ -1,22 +1,22 @@
-Copyright (c) 2015 Romain Vigo Benia
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 2015 Romain Vigo Benia
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,163 +1,378 @@
-# The PromisePay Ruby Gem
-[![Gem Version](https://badge.fury.io/rb/promisepay.svg)](http://badge.fury.io/rb/promisepay)
-[![Build Status](https://travis-ci.org/PromisePay/promisepay-ruby.svg?branch=develop)](https://travis-ci.org/PromisePay/promisepay-ruby)
-[![Coverage Status](https://coveralls.io/repos/PromisePay/promisepay-ruby/badge.svg?branch=develop)](https://coveralls.io/r/PromisePay/promisepay-ruby?branch=develop)
-[![Code Climate](https://codeclimate.com/github/PromisePay/promisepay-ruby/badges/gpa.svg)](https://codeclimate.com/github/PromisePay/promisepay-ruby)
-
-A Ruby interface to the Promisepay API.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'promisepay'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install promisepay
-
-## Usage
-
-Before interacting with Promispay API you need to generate an access token.
-
-See http://docs.promisepay.com/v2.2/docs/request_token for more information.
-
-### Client
-
-Create a client as following:
-
-```ruby
-require 'promisepay'
-
-client = Promisepay::Client.new(username: 'YOUR_USERNAME', token: 'YOUR_TOKEN')
-```
-
-Alternatively Promisepay Gem handles client configuration through environment variables.
-
-```ruby
-ENV['PROMISEPAY_USERNAME'] = 'YOUR_USERNAME'
-ENV['PROMISEPAY_TOKEN'] = 'YOUR_TOKEN'
-```
-
-```ruby
-require 'promisepay'
-
-client = Promisepay::Client.new()
-```
-
-_All configurable parameters are available in the Client Configuration section of this README._
-
-### Calls
-
-The example below is translating [use case #1](http://docs.promisepay.com/v2.2/docs/charge-a-buyer-hold-funds-in-escrow-then-release-t) available on Promispay online documentation.
-
-```ruby
-# 1- Create buyer
-buyer = client.users.create(
-  id: '123456',
-  first_name: 'test',
-  last_name: 'buyer',
-  email: 'buyer@test.com',
-  address_line1: '48 collingwood',
-  state: 'vic',
-  city: 'Mel',
-  zip: '3000',
-  country: 'AUS'
-)
-
-# 2- Create buyer's card account
-buyer_card_account = client.card_accounts.create(
-  user_id: buyer.id,
-  full_name: 'test Buyer',
-  number: '4111 1111 1111 1111',
-  expiry_month: Time.now.month,
-  expiry_year: Time.now.year + 1,
-  cvv: '123'
-)
-
-# 3- Create seller
-seller = client.users.create(
-  id: '123457',
-  first_name: 'test',
-  last_name: 'seller',
-  email: 'seller@test.com',
-  mobile: '+61416452321',
-  address_line1: 'abc',
-  state: 'vic',
-  city: 'Mel',
-  zip: '3000',
-  country: 'AUS'
-)
-
-# 4- Create seller's bank account
-seller_bank_account = client.bank_accounts.create(
-  user_id: seller.id,
-  bank_name: 'Nab',
-  account_name: 'test seller',
-  routing_number: '22222222',
-  account_number: '1234567890',
-  account_type: 'savings',
-  holder_type: 'personal',
-  country: 'AUS'
-)
-
-# 5. Create seller's disbursement account
-seller.disbursement_account(seller_bank_account.id)
-
-# 6. Create fee
-fee = client.fees.create(
-  name: 'test fee for 5 AUD',
-  fee_type_id: '1',
-  amount: '75',
-  to: 'seller'
-)
-
-# 7. Create item and link buyer, seller and fee to it
-item = client.items.create(
-  id: '12345',
-  name: 'test item for 5AUD',
-  amount: '500',
-  payement_type: '1',
-  buyer_id: buyer.id,
-  seller_id: seller.id,
-  fee_id: fee.id,
-  description: '5AUD transfer'
-)
-
-# 8. Pay for item using the buyer's CC account
-item.make_payment(
-  user_id: buyer.id,
-  account_id: buyer_card_account.id
-)
-
-# 9. Buyer releases payment
-item.release_payment(user_id: buyer.id)
-
-# 10. Check payment status at any time (optional)
-item.status
-```
-
-_Check out the [online documentation](http://promisepay.github.io/promisepay-ruby/) to get a list of available resources and methods._
-
-## Client Configuration
-
-The following parameters are configurable through the client:
-
-  * `:username` / `ENV['PROMISEPAY_USERNAME']`: username for [basic authentication](http://docs.promisepay.com/v2.2/docs/overview-2)
-  * `:token` / `ENV['PROMISEPAY_TOKEN']`: token for [basic authentication](http://docs.promisepay.com/v2.2/docs/overview-2)
-  * `:environment` / `ENV['PROMISEPAY_ENVIRONMENT']`: API [environment](http://docs.promisepay.com/v2.2/docs/environments) to use (default: 'test')
-  * `:api_domain` / `ENV['PROMISEPAY_API_DOMAIN']`: API domain name to use (default: 'api.promisepay.com')
-
-## Contributing
-
-1. Fork it ( https://github.com/PromisePay/promisepay-ruby/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+# Ruby SDK - PromisePay API
+
+[![Join the chat at https://gitter.im/PromisePay/promisepay-ruby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/PromisePay/promisepay-ruby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+[![Gem Version](https://badge.fury.io/rb/promisepay.svg)](http://badge.fury.io/rb/promisepay)
+[![Build Status](https://travis-ci.org/PromisePay/promisepay-ruby.svg?branch=develop)](https://travis-ci.org/PromisePay/promisepay-ruby)
+[![Coverage Status](https://coveralls.io/repos/PromisePay/promisepay-ruby/badge.svg?branch=develop)](https://coveralls.io/r/PromisePay/promisepay-ruby?branch=develop)
+[![Code Climate](https://codeclimate.com/github/PromisePay/promisepay-ruby/badges/gpa.svg)](https://codeclimate.com/github/PromisePay/promisepay-ruby)
+
+#1. Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'promisepay'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install promisepay
+
+#2. Configuration
+
+Before interacting with Promispay API you need to generate an access token.
+
+See http://docs.promisepay.com/v2.2/docs/request_token for more information.
+
+**Create a PromisePay client**
+
+```ruby
+require 'promisepay'
+
+client = Promisepay::Client.new(username: 'YOUR_USERNAME', token: 'YOUR_TOKEN')
+```
+
+The client can be configured through environment variables.
+
+```ruby
+ENV['PROMISEPAY_USERNAME'] = 'YOUR_USERNAME'
+ENV['PROMISEPAY_TOKEN'] = 'YOUR_TOKEN'
+```
+
+```ruby
+require 'promisepay'
+
+client = Promisepay::Client.new()
+```
+
+The following parameters are configurable through the client:
+
+  * `:username` / `ENV['PROMISEPAY_USERNAME']`: username for [basic authentication](http://docs.promisepay.com/v2.2/docs/overview-2)
+  * `:token` / `ENV['PROMISEPAY_TOKEN']`: token for [basic authentication](http://docs.promisepay.com/v2.2/docs/overview-2)
+  * `:environment` / `ENV['PROMISEPAY_ENVIRONMENT']`: API [environment](http://docs.promisepay.com/v2.2/docs/environments) to use (default: 'test')
+  * `:api_domain` / `ENV['PROMISEPAY_API_DOMAIN']`: API domain name to use (default: 'api.promisepay.com')
+
+#3. Examples
+
+##Tokens
+##### Example 1 - Request session token
+The below example shows the request for a marketplace configured to have the Item and User IDs generated automatically for them.
+
+```ruby
+token_request = client.tokens.create(:session, {
+  current_user: 'seller',
+  item_name: 'Test Item',
+  amount: '2500',
+  seller_lastname: 'Seller',
+  seller_firstname: 'Sally',
+  buyer_lastname: 'Buyer',
+  buyer_firstname: 'Bobby',
+  buyer_country: 'AUS',
+  seller_country: 'USA',
+  seller_email: 'sally.seller@promisepay.com',
+  buyer_email: 'bobby.buyer@promisepay.com',
+  fee_ids: [],
+  payment_type_id: 2
+})
+token = token_request['token']
+item_id = token_request['item']
+buyer_id = token_request['buyer']
+seller_id = token_request['seller']
+```
+#####Example 2 - Request session token
+The below example shows the request for a marketplace that passes the Item and User IDs.
+
+```ruby
+token = client.tokens.create(:session, {
+  current_user_id: 'seller1234',
+  item_name: 'Test Item',
+  amount: '2500',
+  seller_lastname: 'Seller',
+  seller_firstname: 'Sally',
+  buyer_lastname: 'Buyer',
+  buyer_firstname: 'Bobby',
+  buyer_country: 'AUS',
+  seller_country: 'USA',
+  seller_email: 'sally.seller@promisepay.com',
+  buyer_email: 'bobby.buyer@promisepay.com',
+  external_item_id: 'TestItemId1234',
+  external_seller_id: 'seller1234',
+  external_buyer_id: 'buyer1234',
+  fee_ids: [],
+  payment_type_id: 2
+})['token']
+```
+##Items
+
+#####Create an item
+```ruby
+item = client.items.create(
+  id: '12345',
+  name: 'test item for 5AUD',
+  amount: '500',
+  payement_type: '1',
+  buyer_id: buyer.id,
+  seller_id: seller.id,
+  fee_id: fee.id,
+  description: '5AUD transfer'
+)
+```
+#####Get an item
+```ruby
+item = client.items.find('1')
+```
+#####Get a list of items
+```ruby
+items = client.items.find_all
+```
+#####Update an item
+```ruby
+item.update(name: 'new name')
+```
+#####Cancel an item
+```ruby
+item.cancel
+```
+#####Get an item status
+```ruby
+item.status
+```
+#####Get an item's buyer
+```ruby
+item.buyer
+```
+#####Get an item's seller
+```ruby
+item.seller
+```
+#####Get an item's fees
+```ruby
+item.fees
+```
+#####Get an item's transactions
+```ruby
+item.transaction
+```
+#####Get an item's wire details
+```ruby
+item.wire_details
+```
+#####Get an item's BPAY details
+```ruby
+item.bpay_details
+```
+
+##Users
+
+#####Create a user
+```ruby
+user = client.users.create(
+  id: '123456',
+  first_name: 'test',
+  last_name: 'buyer',
+  email: 'buyer@test.com',
+  address_line1: '48 collingwood',
+  state: 'vic',
+  city: 'Mel',
+  zip: '3000',
+  country: 'AUS'
+)
+```
+#####Get a user
+```ruby
+user = client.users.find('1')
+```
+#####Get a list of users
+```ruby
+users = client.users.find_all
+```
+#####Get a user's card accounts
+```ruby
+user.card_account
+```
+#####Get a user's PayPal accounts
+```ruby
+user.paypal_account
+```
+#####Get a user's bank accounts
+```ruby
+user.bank_account
+```
+#####Get a user's items
+```ruby
+user.items
+```
+#####Set a user's disbursement account
+```ruby
+user.disbursement_account(bank_account.id)
+```
+##Item Actions
+#####Make payment
+```ruby
+item.make_payment(
+  account_id: buyer_card_account.id
+)
+```
+#####Request payment
+```ruby
+item.request_payement
+```
+#####Release payment
+```ruby
+item.release_payment
+```
+#####Request release
+```ruby
+item.request_release
+```
+#####Cancel
+```ruby
+item.cancel
+```
+#####Acknowledge wire
+```ruby
+item.acknowledge_wire
+```
+#####Acknowledge PayPal
+```ruby
+item.acknowledge_paypal
+```
+#####Revert wire
+```ruby
+item.revert_wire
+```
+#####Request refund
+```ruby
+item.release_payment
+```
+#####Refund
+```ruby
+item.request_refund(
+  refund_amount: '1000',
+  refund_message: 'because'
+)
+```
+##Card Accounts
+#####Create a card account
+```ruby
+card_account = client.card_accounts.create(
+  user_id: buyer.id,
+  full_name: 'test Buyer',
+  number: '4111 1111 1111 1111',
+  expiry_month: Time.now.month,
+  expiry_year: Time.now.year + 1,
+  cvv: '123'
+)
+```
+#####Get a card account
+```ruby
+card_account = client.card_accounts.find('1')
+```
+#####Deactivate a card account
+```ruby
+card_account.deactivate
+```
+#####Get a card account's users
+```ruby
+card_account.user
+```
+
+##Bank Accounts
+#####Create a bank account
+```ruby
+bank_account = client.bank_accounts.create(
+  user_id: seller.id,
+  bank_name: 'Nab',
+  account_name: 'test seller',
+  routing_number: '22222222',
+  account_number: '1234567890',
+  account_type: 'savings',
+  holder_type: 'personal',
+  country: 'AUS'
+)
+```
+#####Get a bank account
+```ruby
+bank_account = client.bank_accounts.find('1')
+```
+#####Deactivate a bank account
+```ruby
+bank_account.deactivate('mobile_pin')
+```
+#####Get a bank account's users
+```ruby
+bank_account.user
+```
+
+##PayPal Accounts
+#####Create a PayPal account
+```ruby
+paypal_account = client.paypal_accounts.create(
+  user_id: seller.id,
+  paypal_email: 'seller@promisepay.com'
+)
+```
+#####Get a PayPal account
+```ruby
+paypal_account = client.paypal_accounts.find('1')
+```
+#####Deactivate a PayPal account
+```ruby
+paypal_account.deactivate
+```
+#####Get a PayPal account's users
+```ruby
+paypal_account.user
+```
+
+##Fees
+#####Get a list of fees
+```ruby
+fees = client.fees.find_all
+```
+#####Get a fee
+```ruby
+fees = client.fees.find('1')
+```
+#####Create a fee
+```ruby
+fee = client.fees.create(
+  name: 'test fee for 5 AUD',
+  fee_type_id: '1',
+  amount: '75',
+  to: 'seller'
+)
+```
+
+##Transactions
+#####Get a list of transactions
+```ruby
+transactions = client.transactions.find_all
+```
+#####Get a transaction
+```ruby
+transaction = client.transactions.find('1')
+```
+#####Get a transaction's users
+```ruby
+transaction.users
+```
+#####Get a transaction's fees
+```ruby
+transaction.fees
+```
+
+_Check out the [online documentation](http://promisepay.github.io/promisepay-ruby/) to get a full list of available resources and methods._
+
+#4. Contributing
+
+	1. Fork it ( https://github.com/PromisePay/promisepay-ruby/fork )
+	2. Create your feature branch (`git checkout -b my-new-feature`)
+	3. Commit your changes (`git commit -am 'Add some feature'`)
+	4. Push to the branch (`git push origin my-new-feature`)
+	5. Create a new Pull Request