promisepay 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed9b3ebad1d27848ce0b1e11a9ec1aa0e7efa76a
-  data.tar.gz: 90149cfd350f8a64bc69b63da43e803f533d69a2
+  metadata.gz: 23ea2e12b7d1d4f35d341d41172be42221ee8291
+  data.tar.gz: 132b72a092ec9ad83e6d5ae6c8b01e156a3410df
 SHA512:
-  metadata.gz: 6bb6af619be1ce789fcf0f958b5de64fdbd4f0a01e18a3e9df347e14fa2a8a599bc30d01cee7a2bb7f42c42368d5f5accabd2e9f5a3a8284525995885f29d5ee
-  data.tar.gz: 5b1ef57cc159e7321da2e80dcc441ab9fc83840d29f838ea91932a85fbaef7f795a4945771185604927cd4b9796cdea1d56f5e8a846f549c34d7f671f1335629
+  metadata.gz: f3c30eec78f309ef4750b9f8d719b65e04ddcea609e0b45aed746b1c1065e29806f0087e97ded5740b12915f099eb0b12a218d6801652ddb9095ef60d6be1dab
+  data.tar.gz: 5ef05d8c96a61ef9452d5d4ad0b62a90912c69a14bd06fb2ea625259f78637a53f98c664905c9a7e2ed2c94990ad41eac48e6f0ddc76b2660adcaf52935b6992

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,163 @@
-# 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
+# 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

data/Rakefile

@@ -1 +1 @@
-require 'bundler/gem_tasks'
+require 'bundler/gem_tasks'

data/lib/promisepay.rb

@@ -1,13 +1,13 @@
-require_relative 'promisepay/client'
-require_relative 'promisepay/default'
-require_relative 'promisepay/error'
-require_relative 'promisepay/version'
-
-# Ruby toolkit for the Promisepay API
-module Promisepay
-  class << self
-    include Promisepay::Configurable
-  end
-end
-
-Promisepay.setup
+require_relative 'promisepay/client'
+require_relative 'promisepay/default'
+require_relative 'promisepay/error'
+require_relative 'promisepay/version'
+
+# Ruby toolkit for the Promisepay API
+module Promisepay
+  class << self
+    include Promisepay::Configurable
+  end
+end
+
+Promisepay.setup

data/lib/promisepay/client.rb

@@ -1,144 +1,147 @@
-require_relative 'configurable'
-require_relative 'models/base_model'
-require_relative 'models/account'
-require_relative 'models/bank_account'
-require_relative 'models/card_account'
-require_relative 'models/fee'
-require_relative 'models/item'
-require_relative 'models/paypal_account'
-require_relative 'models/transaction'
-require_relative 'models/user'
-require_relative 'resources/base_resource'
-require_relative 'resources/account_resource'
-require_relative 'resources/bank_account_resource'
-require_relative 'resources/card_account_resource'
-require_relative 'resources/fee_resource'
-require_relative 'resources/item_resource'
-require_relative 'resources/paypal_account_resource'
-require_relative 'resources/transaction_resource'
-require_relative 'resources/user_resource'
-require 'json'
-require 'faraday'
-
-module Promisepay
-  # Client for the Promisepay API
-  #
-  # @see http://docs.promisepay.com/v2.2/docs/overview
-  class Client
-    include Promisepay::Configurable
-
-    def initialize(options = {})
-      # Use options passed in, but fall back to module defaults
-      Promisepay::Configurable.keys.each do |key|
-        instance_variable_set(
-          :"@#{key}", options[key] || Promisepay.instance_variable_get(:"@#{key}")
-        )
-      end
-    end
-
-    # Create a new Faraday connection
-    #
-    # @return [Faraday::Connection]
-    def connection
-      Faraday.new(url: @api_endpoint) do |builder|
-        builder.request :basic_auth, @username, @token
-        builder.adapter :net_http
-      end
-    end
-
-    # Make a HTTP GET request
-    #
-    # @param url [String] The path, relative to {#api_endpoint}
-    # @param parameters [Hash] Query params for request
-    # @return [Faraday::Response]
-    def get(url, parameters = {})
-      response = connection.get("#{api_endpoint}#{url}", parameters)
-      on_complete(response)
-      response
-    end
-
-    # Make a HTTP POST request
-    #
-    # @param url [String] The path, relative to {#api_endpoint}
-    # @param parameters [Hash] Query params for request
-    # @return [Faraday::Response]
-    def post(url, parameters = {})
-      response = connection.post do |req|
-        req.url "#{api_endpoint}#{url}"
-        req.headers['Content-Type'] = 'application/json'
-        req.body = parameters.to_json
-      end
-      on_complete(response)
-      response
-    end
-
-    # Make a HTTP PATCH request
-    #
-    # @param url [String] The path, relative to {#api_endpoint}
-    # @param parameters [Hash] Query params for request
-    # @return [Faraday::Response]
-    def patch(url, parameters = {})
-      response = connection.patch do |req|
-        req.url "#{api_endpoint}#{url}"
-        req.headers['Content-Type'] = 'application/json'
-        req.body = parameters.to_json
-      end
-      on_complete(response)
-      response
-    end
-
-    # Make a HTTP DELETE request
-    #
-    # @param url [String] The path, relative to {#api_endpoint}
-    # @param parameters [Hash] Query params for request
-    # @return [Faraday::Response]
-    def delete(url, parameters = {})
-      response = connection.delete do |req|
-        req.url "#{api_endpoint}#{url}"
-        req.headers['Content-Type'] = 'application/json'
-        req.body = parameters.to_json
-      end
-      on_complete(response)
-      response
-    end
-
-    # Available resources for {Client}
-    #
-    # @return [Hash]
-    def self.resources
-      {
-        bank_accounts: BankAccountResource,
-        card_accounts: CardAccountResource,
-        fees: FeeResource,
-        items: ItemResource,
-        paypal_accounts: PaypalAccountResource,
-        transactions: TransactionResource,
-        users: UserResource
-      }
-    end
-
-    # Catch calls for resources
-    #
-    def method_missing(name, *args, &block)
-      if self.class.resources.keys.include?(name)
-        resources[name] ||= self.class.resources[name].new(self)
-        resources[name]
-      else
-        super
-      end
-    end
-
-    # Resources being currently used
-    #
-    # @return [Hash]
-    def resources
-      @resources ||= {}
-    end
-
-    private
-
-    def on_complete(response)
-      fail Promisepay::Error.from_response(response) unless response.success?
-    end
-  end
-end
+require_relative 'configurable'
+require_relative 'models/base_model'
+require_relative 'models/account'
+require_relative 'models/bank_account'
+require_relative 'models/card_account'
+require_relative 'models/fee'
+require_relative 'models/item'
+require_relative 'models/paypal_account'
+require_relative 'models/token'
+require_relative 'models/transaction'
+require_relative 'models/user'
+require_relative 'resources/base_resource'
+require_relative 'resources/account_resource'
+require_relative 'resources/bank_account_resource'
+require_relative 'resources/card_account_resource'
+require_relative 'resources/fee_resource'
+require_relative 'resources/item_resource'
+require_relative 'resources/paypal_account_resource'
+require_relative 'resources/token_resource'
+require_relative 'resources/transaction_resource'
+require_relative 'resources/user_resource'
+require 'json'
+require 'faraday'
+
+module Promisepay
+  # Client for the Promisepay API
+  #
+  # @see http://docs.promisepay.com/v2.2/docs/overview
+  class Client
+    include Promisepay::Configurable
+
+    def initialize(options = {})
+      # Use options passed in, but fall back to module defaults
+      Promisepay::Configurable.keys.each do |key|
+        instance_variable_set(
+          :"@#{key}", options[key] || Promisepay.instance_variable_get(:"@#{key}")
+        )
+      end
+    end
+
+    # Create a new Faraday connection
+    #
+    # @return [Faraday::Connection]
+    def connection
+      Faraday.new(url: @api_endpoint) do |builder|
+        builder.request :basic_auth, @username, @token
+        builder.adapter :net_http
+      end
+    end
+
+    # Make a HTTP GET request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param parameters [Hash] Query params for request
+    # @return [Faraday::Response]
+    def get(url, parameters = {})
+      response = connection.get("#{api_endpoint}#{url}", parameters)
+      on_complete(response)
+      response
+    end
+
+    # Make a HTTP POST request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param parameters [Hash] Query params for request
+    # @return [Faraday::Response]
+    def post(url, parameters = {})
+      response = connection.post do |req|
+        req.url "#{api_endpoint}#{url}"
+        req.headers['Content-Type'] = 'application/json'
+        req.body = parameters.to_json
+      end
+      on_complete(response)
+      response
+    end
+
+    # Make a HTTP PATCH request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param parameters [Hash] Query params for request
+    # @return [Faraday::Response]
+    def patch(url, parameters = {})
+      response = connection.patch do |req|
+        req.url "#{api_endpoint}#{url}"
+        req.headers['Content-Type'] = 'application/json'
+        req.body = parameters.to_json
+      end
+      on_complete(response)
+      response
+    end
+
+    # Make a HTTP DELETE request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param parameters [Hash] Query params for request
+    # @return [Faraday::Response]
+    def delete(url, parameters = {})
+      response = connection.delete do |req|
+        req.url "#{api_endpoint}#{url}"
+        req.headers['Content-Type'] = 'application/json'
+        req.body = parameters.to_json
+      end
+      on_complete(response)
+      response
+    end
+
+    # Available resources for {Client}
+    #
+    # @return [Hash]
+    def self.resources
+      {
+        bank_accounts: BankAccountResource,
+        card_accounts: CardAccountResource,
+        fees: FeeResource,
+        items: ItemResource,
+        paypal_accounts: PaypalAccountResource,
+        transactions: TransactionResource,
+        users: UserResource,
+        tokens: TokenResource
+      }
+    end
+
+    # Catch calls for resources
+    #
+    def method_missing(name, *args, &block)
+      if self.class.resources.keys.include?(name)
+        resources[name] ||= self.class.resources[name].new(self)
+        resources[name]
+      else
+        super
+      end
+    end
+
+    # Resources being currently used
+    #
+    # @return [Hash]
+    def resources
+      @resources ||= {}
+    end
+
+    private
+
+    def on_complete(response)
+      fail Promisepay::Error.from_response(response) unless response.success?
+    end
+  end
+end