promisepay 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81abebc5923d9af216511284d1940b4856ec1ff5
-  data.tar.gz: 048efbbeb3acb567028438500473b64c277850e8
+  metadata.gz: 7dacee9ed6f0901b5ffc85139e1d62d1d7c89436
+  data.tar.gz: f99a7de4228a3c7a6190b6bbe478d40d6822c1d9
 SHA512:
-  metadata.gz: b9d25d958566d6a19773f0b76b7c4b05dd4d2657a981810577bf367cb09ab1573f6082962bd1fd8d86f87997366a0592514ad53f498dbb6b66254e810d89a5de
-  data.tar.gz: 6bee0b0b9e0a808abc3089eb4884c59999da7fb72c078be950d69d79e2bf8a89b72845807d14a77ce416d3fe439f84ac543691f91173827ce2a3dd7d79b44f93
+  metadata.gz: 9359c5c0411da5ad38c1ebeaa7253a0279996106f849d2dc38220e8c5c67a146d2ccb8036b26f3da1c09693b6ff0a0587b3e8212e9a0ea82a56b4c474d6c4733
+  data.tar.gz: c578ec4260aa6293eb095ea1962921132e74fec94e268a5c7c4b4fe358597933c4c427d9f0e2d326e714835ecff470196699436aa0237d2cdd10c6eec16c3b33

data/README.md

@@ -3,13 +3,15 @@
 [![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)
+[![Build Status](https://travis-ci.org/PromisePay/promisepay-ruby.svg?branch=master)](https://travis-ci.org/PromisePay/promisepay-ruby)
+[![Coverage Status](https://coveralls.io/repos/PromisePay/promisepay-ruby/badge.svg?branch=master)](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)
 
+To see a completed integration in a Ruby on Rails app, visit this [repository](https://github.com/dannyshafer/PromisePay_api_integration).
+
 #1. Installation
 
-Add this line to your application's Gemfile:
+Add these lines to your application's Gemfile:
 
 ```ruby
 gem 'promisepay'
@@ -27,27 +29,16 @@ Or install it yourself as:
 
 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.
+See [PromisePay documentation](https://promisepay-docs.readme.io/v1.0/docs/fetching-your-api-key) 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()
+# In your environment file
+PROMISEPAY_USERNAME ||= youremailaddress
+PROMISEPAY_TOKEN ||= y0urt0k3n12345678910123456789101
 ```
 
 The following parameters are configurable through the client:
@@ -57,11 +48,17 @@ The following parameters are configurable through the client:
   * `: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')
 
+ Instantiate the PromisePay client.
+
+```ruby
+client = Promisepay::Client.new(username: ENV['PROMISEPAY_USERNAME'], token: ENV['PROMISEPAY_TOKEN'])
+```
+
 #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.
+The below example shows the controller request for a marketplace configured to have the Item and User IDs generated automatically for them. Note: by default, the ability to have PromisePay auto generate IDs is turned off. However, it can easily be requested by contacting PromisePay support.
 
 ```ruby
 token_request = client.tokens.create(:session, {
@@ -115,10 +112,10 @@ item = client.items.create(
   id: '12345',
   name: 'test item for 5AUD',
   amount: '500',
-  payement_type: '1',
+  payment_type: '1',
   buyer_id: buyer.id,
   seller_id: seller.id,
-  fee_id: fee.id,
+  fee_ids: fee.id,
   description: '5AUD transfer'
 )
 ```
@@ -180,7 +177,23 @@ user = client.users.create(
   state: 'vic',
   city: 'Mel',
   zip: '3000',
-  country: 'AUS'
+  country: 'AUS',
+  dob:'12/06/1980'
+)
+```
+#####Update a user
+```ruby
+user = client.users.update(
+  id: '123456',
+  first_name: 'test',
+  last_name: 'buyer',
+  email: 'buyer@test.com',
+  address_line1: '48 collingwood',
+  state: 'vic',
+  city: 'Mel',
+  zip: '3000',
+  country: 'AUS',
+  dob:'12/06/1980'
 )
 ```
 #####Get a user
@@ -191,15 +204,15 @@ user = client.users.find('1')
 ```ruby
 users = client.users.find_all
 ```
-#####Get a user's card accounts
+#####Get a user's card account
 ```ruby
 user.card_account
 ```
-#####Get a user's PayPal accounts
+#####Get a user's PayPal account
 ```ruby
 user.paypal_account
 ```
-#####Get a user's bank accounts
+#####Get a user's bank account
 ```ruby
 user.bank_account
 ```
@@ -207,6 +220,10 @@ user.bank_account
 ```ruby
 user.items
 ```
+#####Get a user's address
+```ruby
+user.address
+```
 #####Set a user's disbursement account
 ```ruby
 user.disbursement_account(bank_account.id)
@@ -220,7 +237,7 @@ item.make_payment(
 ```
 #####Request payment
 ```ruby
-item.request_payement
+item.request_payment
 ```
 #####Release payment
 ```ruby
@@ -248,11 +265,14 @@ item.revert_wire
 ```
 #####Request refund
 ```ruby
-item.release_payment
+item.request_refund(
+  refund_amount: '1000',
+  refund_message: 'because'
+)
 ```
 #####Refund
 ```ruby
-item.request_refund(
+item.refund(
   refund_amount: '1000',
   refund_message: 'because'
 )
@@ -302,19 +322,23 @@ bank_account = client.bank_accounts.find('1')
 ```
 #####Deactivate a bank account
 ```ruby
-bank_account.deactivate('mobile_pin')
+bank_account.deactivate
 ```
 #####Get a bank account's users
 ```ruby
 bank_account.user
 ```
+#####Validate Routing Number
+```ruby
+client.bank_accounts.validate('122235821')
+```
 
 ##PayPal Accounts
 #####Create a PayPal account
 ```ruby
 paypal_account = client.paypal_accounts.create(
-  user_id: seller.id,
-  paypal_email: 'seller@promisepay.com'
+	user_id: seller.id,
+	paypal_email: 'seller@promisepay.com'
 )
 ```
 #####Get a PayPal account
@@ -329,6 +353,56 @@ paypal_account.deactivate
 ```ruby
 paypal_account.user
 ```
+##Companies
+
+#####Create a company
+```ruby
+client.companies.create(
+	user_id: "1",
+	name: "Acme Co",
+	legal_name: "Acme Co Pty Ltd",
+	tax_number: "1231231",
+	charge_tax: true,
+	address_line1: "123 Test St",
+	address_line2: "",
+	city: "Melbourne",
+	state: "VIC",
+	zip: "3000",
+	country: "AUS"
+)
+```
+
+#####Get a company
+```ruby
+client.companies.find('compamy_id')
+```
+
+#####Get a list of companies
+```ruby
+client.companies.find_all
+```
+
+#####Get a company's address
+```ruby
+company.address
+```
+
+#####Update a company
+```ruby
+client.companies.update(
+	id: "8d578b9c-5b79-11e5-885d-feff819cdc9f",
+	name: "Acme Co",
+	legal_name: "Acme Co Pty Ltd",
+	tax_number: "1231231",
+	charge_tax: true,
+	address_line1: "123 Test St",
+	address_line2: "",
+	city: "Melbourne",
+	state: "VIC",
+	zip: "3000",
+	country: "AUS"
+)
+```
 
 ##Fees
 #####Get a list of fees

data/Rakefile

@@ -1 +1,9 @@
 require 'bundler/gem_tasks'
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'promisepay'
+  ARGV.clear
+  IRB.start
+end

data/lib/promisepay/client.rb

@@ -1,8 +1,10 @@
 require_relative 'configurable'
+require_relative 'error'
 require_relative 'models/base_model'
 require_relative 'models/account'
 require_relative 'models/bank_account'
 require_relative 'models/card_account'
+require_relative 'models/company'
 require_relative 'models/fee'
 require_relative 'models/item'
 require_relative 'models/paypal_account'
@@ -12,6 +14,7 @@ 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/company_resource'
 require_relative 'resources/fee_resource'
 require_relative 'resources/item_resource'
 require_relative 'resources/paypal_account_resource'
@@ -52,9 +55,9 @@ module Promisepay
     # @param url [String] The path, relative to {#api_endpoint}
     # @param parameters [Hash] Query params for request
     # @return [Faraday::Response]
-    def get(url, parameters = {})
+    def get(url, parameters = {}, skip_status_check = false)
       response = connection.get("#{api_endpoint}#{url}", parameters)
-      on_complete(response)
+      on_complete(response) unless skip_status_check
       response
     end
 
@@ -110,6 +113,7 @@ module Promisepay
       {
         bank_accounts: BankAccountResource,
         card_accounts: CardAccountResource,
+        companies: CompanyResource,
         fees: FeeResource,
         items: ItemResource,
         paypal_accounts: PaypalAccountResource,

data/lib/promisepay/error.rb

@@ -39,9 +39,7 @@ module Promisepay
       message = ''
       message << json_response['message'] if json_response.key?('message')
       if json_response.key?('errors')
-        json_response['errors'].each do |attribute, content|
-          message << "#{attribute}: #{content}"
-        end
+        message << json_response['errors'].map{|attribute, content| "#{attribute}: #{content}"}.join(", ")
       end
 
       message

data/lib/promisepay/models/bank_account.rb

@@ -3,7 +3,7 @@ module Promisepay
   class BankAccount < Account
     # Get the user the bank account belongs to.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/bank_accountsidusers
+    # @see https://reference.promisepay.com/#show-bank-account-user
     #
     # @return [Promisepay::User]
     def user
@@ -14,7 +14,7 @@ module Promisepay
     # Deletes a bank account for a user on a marketplace.
     # Sets the account to in-active.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/bank_accountsid
+    # @see https://reference.promisepay.com/#redact-bank-account
     #
     # @param mobile_pin [String] Mobile PIN.
     #

data/lib/promisepay/models/card_account.rb

@@ -3,7 +3,7 @@ module Promisepay
   class CardAccount < Account
     # Get the user the card account belongs to.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/card_accountsidusers
+    # @see https://reference.promisepay.com/#show-card-account-user
     #
     # @return [Promisepay::User]
     def user
@@ -14,7 +14,7 @@ module Promisepay
     # Deletes a card account for a user on a marketplace.
     # Sets the account to in-active.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/card_accountsid
+    # @see https://reference.promisepay.com/#redact-card-account
     #
     # @return [Boolean]
     def deactivate

data/lib/promisepay/models/company.rb

@@ -0,0 +1,38 @@
+module Promisepay
+  # Manage Companies
+  class Company < BaseModel
+    # Update the attributes of an item.
+    #
+    # @see https://reference.promisepay.com/#update-item
+    #
+    # @param attributes [Hash] Item's attributes to be updated.
+    #
+    # @return [self]
+    def update(attributes)
+      response = JSON.parse(@client.patch("companies/#{send(:id)}", attributes).body)
+      @attributes = response['companies']
+      self
+    end
+
+  	# Get the user the company belongs to.
+    #
+    # @see
+    #
+    # @return [Promisepay::User]
+    def user
+      response = JSON.parse(@client.get("companies/#{send(:id)}/users").body)
+      Promisepay::User.new(@client, response['users'])
+    end
+
+    # Gets company address.
+    #
+    # @see https://reference.promisepay.com/#addresses
+    #
+    # @return [Hash]
+    def address
+      return nil unless @attributes.key?('related')
+      response = JSON.parse(@client.get("addresses/#{send(:related)['addresses']}").body)
+      response['addresses']
+    end
+  end
+end

data/lib/promisepay/models/item.rb

@@ -3,7 +3,7 @@ module Promisepay
   class Item < BaseModel
     # Update the attributes of an item.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/itemsiduseraction
+    # @see https://reference.promisepay.com/#update-item
     #
     # @param attributes [Hash] Item's attributes to be updated.
     #
@@ -16,7 +16,7 @@ module Promisepay
 
     # Show the item status for a marketplace.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/itemsidstatus
+    # @see https://reference.promisepay.com/#show-item-status
     #
     # @return [Hash]
     def status
@@ -26,7 +26,7 @@ module Promisepay
 
     # Show the buyer detail for a single item for a marketplace.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/itemsidbuyers
+    # @see https://reference.promisepay.com/#show-item-buyer
     #
     # @return [Promisepay::User]
     def buyer
@@ -36,7 +36,7 @@ module Promisepay
 
     # Show the seller detail for a single item for a marketplace.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/itemsidbuyers
+    # @see https://reference.promisepay.com/#show-item-seller
     #
     # @return [Promisepay::User]
     def seller
@@ -46,7 +46,7 @@ module Promisepay
 
     # Get fees associated to the item.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/itemsidfees
+    # @see https://reference.promisepay.com/#show-item-fees
     #
     # @param options [Hash] Optional options.
     # @option options [Integer] :limit Can ask for up to 200 fees. default: 10
@@ -61,7 +61,7 @@ module Promisepay
 
     # Get historical transaction for the item.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/itemsidtransactions
+    # @see https://reference.promisepay.com/#list-item-transactions
     #
     # @param options [Hash] Optional options.
     # @option options [Integer] :limit Can ask for up to 200 transactions. default: 10
@@ -76,7 +76,7 @@ module Promisepay
 
     # Show the wire details for payment.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/itemsidwire_details
+    # @see https://reference.promisepay.com/#show-item-wire-details
     #
     # @return [Hash]
     def wire_details
@@ -86,7 +86,7 @@ module Promisepay
 
     # Show the bpay details details for payment.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/itemsidbpay_details
+    # @see https://reference.promisepay.com/#show-item-bpay-details
     #
     # @return [Hash]
     def bpay_details
@@ -94,53 +94,60 @@ module Promisepay
       response['items']['bpay_details']
     end
 
-    # .
+    # Make a payment for an Item.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/itemsidaction
+    # @see https://reference.promisepay.com/#make-payment
     #
     # @return [Boolean]
     def make_payment(options = {})
-      @client.patch("items/#{send(:id)}/make_payment", options).body
+      response = JSON.parse(@client.patch("items/#{send(:id)}/make_payment", options).body)
+      @attributes = response['items']
       true
     end
 
-    # .
+    # Request payment for an Item.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/itemsidrequest_payment
+    # @see https://reference.promisepay.com/#request-payment
     #
     # @return [Boolean]
     def request_payment(options = {})
-      @client.patch("items/#{send(:id)}/request_payment", options).body
+      response = JSON.parse(@client.patch("items/#{send(:id)}/request_payment", options).body)
+      @attributes = response['items']
       true
     end
 
-    # .
+    # Release funds held in escrow from an Item with an Escrow or Escrow Partial Release
+    # payment type.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/itemsidrequest_payment
+    # @see https://reference.promisepay.com/#release-payment
     #
     # @return [Boolean]
     def release_payment(options = {})
-      @client.patch("items/#{send(:id)}/release_payment", options).body
+      response = JSON.parse(@client.patch("items/#{send(:id)}/release_payment", options).body)
+      @attributes = response['items']
       true
     end
 
-    # .
+    # Request release of funds held in escrow, from an Item with an Escrow or Escrow Partial
+    # Release payment type.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/itemsidrequest_release
+    # @see https://reference.promisepay.com/#request-release
     #
     # @return [Boolean]
     def request_release(options = {})
-      @client.patch("items/#{send(:id)}/request_release", options).body
+      response = JSON.parse(@client.patch("items/#{send(:id)}/request_release", options).body)
+      @attributes = response['items']
       true
     end
 
-    # .
+    # Acknowledge that funds are being wired for payment.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/itemsidacknowledge_wire
+    # @see https://reference.promisepay.com/#acknowledge-wire-transfer
     #
     # @return [Boolean]
     def acknowledge_wire(options = {})
-      @client.patch("items/#{send(:id)}/acknowledge_wire", options).body
+      response = JSON.parse(@client.patch("items/#{send(:id)}/acknowledge_wire", options).body)
+      @attributes = response['items']
       true
     end
 
@@ -150,47 +157,52 @@ module Promisepay
     #
     # @return [Boolean]
     def acknowledge_paypal(options = {})
-      @client.patch("items/#{send(:id)}/acknowledge_paypal", options).body
+      response = JSON.parse(@client.patch("items/#{send(:id)}/acknowledge_paypal", options).body)
+      @attributes = response['items']
       true
     end
 
-    # .
+    # Revert an acknowledge wire Item Action.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/itemsidrevert_wire
+    # @see https://reference.promisepay.com/#revert-wire-transfer
     #
     # @return [Boolean]
     def revert_wire(options = {})
-      @client.patch("items/#{send(:id)}/revert_wire", options).body
+      response = JSON.parse(@client.patch("items/#{send(:id)}/revert_wire", options).body)
+      @attributes = response['items']
       true
     end
 
-    # .
+    # Request a refund for an Item.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/itemsidrequest_refund
+    # @see https://reference.promisepay.com/#request-refund
     #
     # @return [Boolean]
     def request_refund(options = {})
-      @client.patch("items/#{send(:id)}/request_refund", options).body
+      response = JSON.parse(@client.patch("items/#{send(:id)}/request_refund", options).body)
+      @attributes = response['items']
       true
     end
 
-    # .
+    # Refund an Item’s funds held in escrow.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/itemsidrefund
+    # @see https://reference.promisepay.com/#refund
     #
     # @return [Boolean]
     def refund(options = {})
-      @client.patch("items/#{send(:id)}/refund", options).body
+      response = JSON.parse(@client.patch("items/#{send(:id)}/refund", options).body)
+      @attributes = response['items']
       true
     end
 
-    # .
+    # Cancel an Item.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/itemsidcancel
+    # @see https://reference.promisepay.com/#cancel
     #
     # @return [Boolean]
     def cancel
-      @client.patch("items/#{id}/cancel")
+      response = JSON.parse(@client.patch("items/#{id}/cancel").body)
+      @attributes = response['items']
       true
     end
   end

data/lib/promisepay/models/paypal_account.rb

@@ -3,7 +3,7 @@ module Promisepay
   class PaypalAccount < Account
     # Get the user the paypal account belongs to.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/paypal_accountsidusers
+    # @see https://reference.promisepay.com/#show-paypal-account-user
     #
     # @return [Promisepay::User]
     def user
@@ -14,7 +14,7 @@ module Promisepay
     # Deletes a Paypal account for a user on a marketplace.
     # Sets the account to in-active.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/paypal_accountsid
+    # @see https://reference.promisepay.com/#redact-paypal-account
     #
     # @return [Boolean]
     def deactivate

data/lib/promisepay/models/transaction.rb

@@ -1,9 +1,9 @@
 module Promisepay
   # Manage Transactions
   class Transaction < Account
-    # .
+    # Show the User associated with the Transaction.
     #
-    # @see https://test.api.promisepay.com/transactions/:id/users
+    # @see https://reference.promisepay.com/#show-transaction-user
     #
     # @return [Promisepay::User]
     def user
@@ -13,7 +13,7 @@ module Promisepay
 
     # Gets a transactions fee details if applicable.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/transactionsidfees
+    # @see https://reference.promisepay.com/#shows-transaction-fees
     #
     # @return [Promisepay::Fee]
     def fee

data/lib/promisepay/models/user.rb

@@ -2,9 +2,22 @@
 module Promisepay
   # Manage Users
   class User < BaseModel
+    # Update the attributes of an item.
+    #
+    # @see https://reference.promisepay.com/#update-item
+    #
+    # @param attributes [Hash] Item's attributes to be updated.
+    #
+    # @return [self]
+    def update(attributes)
+      response = JSON.parse(@client.patch("users/#{send(:id)}", attributes).body)
+      @attributes = response['users']
+      self
+    end
+
     # Lists items for a user on a marketplace.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/usersiditems
+    # @see https://reference.promisepay.com/#list-user-items
     #
     # @return [Array<Promisepay::Item>]
     def items
@@ -15,7 +28,7 @@ module Promisepay
 
     # Gets Bank account for a user on a marketplace.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/usersidbank_accounts
+    # @see https://reference.promisepay.com/#show-user-bank-account
     #
     # @return [Promisepay::BankAccount]
     def bank_account
@@ -27,7 +40,7 @@ module Promisepay
 
     # Gets Card account for a user on a marketplace.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/usersidcard_accounts
+    # @see https://reference.promisepay.com/#show-user-card-account
     #
     # @return [Promisepay::CardAccount]
     def card_account
@@ -39,7 +52,7 @@ module Promisepay
 
     # Gets PayPal account for a user on a marketplace.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/usersidpaypal_accounts
+    # @see https://reference.promisepay.com/#show-user-paypal-account
     #
     # @return [Promisepay::PaypalAccount]
     def paypal_account
@@ -51,7 +64,7 @@ module Promisepay
 
     # Set the disbursement account for a user.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/usersiddisbursement_account
+    # @see https://reference.promisepay.com/#set-user-disbursement-account
     #
     # @return [Boolean]
     def disbursement_account(account_id)
@@ -59,5 +72,28 @@ module Promisepay
       JSON.parse(@client.post("users/#{send(:id)}/disbursement_account", options).body)
       true
     end
+
+    # Gets company for a user on a marketplace.
+    #
+    # @see
+    #
+    # @return [Promisepay::Company]
+    def company
+      response = JSON.parse(@client.get("users/#{send(:id)}/companies").body)
+      Promisepay::Company.new(@client, response['companies'])
+    rescue Promisepay::NotFound
+      nil
+    end
+
+    # Gets user address.
+    #
+    # @see https://reference.promisepay.com/#addresses
+    #
+    # @return [Hash]
+    def address
+      return nil unless @attributes.key?('related')
+      response = JSON.parse(@client.get("addresses/#{send(:related)['addresses']}").body)
+      response['addresses']
+    end
   end
 end

data/lib/promisepay/resources/bank_account_resource.rb

@@ -7,7 +7,7 @@ module Promisepay
 
     # Get bank account for a user on a marketplace.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/bank_accountsid-1
+    # @see https://reference.promisepay.com/#show-bank-account
     #
     # @param id [String] Bank Account ID.
     #
@@ -19,7 +19,7 @@ module Promisepay
 
     # Create a bank account for a user on a marketplace.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/bank_accountsid-2
+    # @see https://reference.promisepay.com/#create-bank-account
     #
     # @param attributes [Hash] Bank Account's attributes.
     #
@@ -28,5 +28,19 @@ module Promisepay
       response = JSON.parse(@client.post('bank_accounts', attributes).body)
       Promisepay::BankAccount.new(@client, response['bank_accounts'])
     end
+
+    # Validate a US bank routing number before creating an account.
+    # This can be used to provide on-demand verification,
+    # and further information of the bank information a User is providing.
+    #
+    # @see https://reference.promisepay.com/#validate-routing-number
+    #
+    # @param routing_number [String] Bank account Routing Number
+    #
+    # @return [Hash]
+    def validate(routing_number)
+      response = @client.get('tools/routing_number', { routing_number: routing_number }, true)
+      (response.status == 200) ? JSON.parse(response.body)['routing_number'] : {}
+    end
   end
 end

data/lib/promisepay/resources/card_account_resource.rb

@@ -7,7 +7,7 @@ module Promisepay
 
     # Get card account for a user on a marketplace.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/card_accountsid-1
+    # @see https://reference.promisepay.com/#show-card-account
     #
     # @param id [String] Bank Account ID.
     #
@@ -19,7 +19,7 @@ module Promisepay
 
     # Create a card account for a user on a marketplace.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/card_accountsid-2
+    # @see https://reference.promisepay.com/#create-card-account
     #
     # @param attributes [Hash] Bank Account's attributes.
     #

data/lib/promisepay/resources/company_resource.rb

@@ -0,0 +1,59 @@
+module Promisepay
+  # Resource for the Fees API
+  class CompanyResource < BaseResource
+    def model
+      Promisepay::Company
+    end
+
+    # List all companies for a marketplace
+    #
+    # @see https://reference.promisepay.com/#list-companies
+    #
+    # @param options [Hash] Optional options.
+    # @option options [Integer] :limit Can ask for up to 200 users. default: 10
+    # @option options [Integer] :offset Pagination help. default: 0
+    #
+    # @return [Array<Promisepay::Company>] List all companies for a marketplace.
+    def find_all(options = {})
+      response = JSON.parse(@client.get('companies', options).body)
+      users = response.key?('companies') ? response['companies'] : []
+      users.map { |attributes| Promisepay::Company.new(@client, attributes) }
+    end
+
+    # Get a company
+    #
+    # @see https://reference.promisepay.com/#show-company
+    #
+    # @param id [String] Company id
+    #
+    # @return [Promisepay::Company]
+    def find(id)
+      response = JSON.parse(@client.get("companies/#{id}").body)
+      Promisepay::Company.new(@client, response['companies'])
+    end
+
+    # Create a company for a user
+    #
+    # @see https://reference.promisepay.com/#create-company
+    #
+    # @param attributes [Hash] Company's attributes.
+    #
+    # @return [Promisepay::Company]
+    def create(attributes)
+      response = JSON.parse(@client.post('companies', attributes).body)
+      Promisepay::Company.new(@client, response['companies'])
+    end
+
+    # Update a company for a user
+    #
+    # @see https://reference.promisepay.com/#update-company
+    #
+    # @param attributes [Hash] Company's attributes.
+    #
+    # @return [Promisepay::Company]
+    def update(attributes)
+      response = JSON.parse(@client.patch('companies', attributes).body)
+      Promisepay::Company.new(@client, response['companies'])
+    end
+  end
+end

data/lib/promisepay/resources/fee_resource.rb

@@ -7,7 +7,7 @@ module Promisepay
 
     # List all fees for a marketplace
     #
-    # @see http://docs.promisepay.com/v2.2/docs/fees-1
+    # @see https://reference.promisepay.com/#list-fees
     #
     # @param options [Hash] Optional options.
     # @option options [Integer] :limit Can ask for up to 200 fees. default: 10
@@ -22,7 +22,7 @@ module Promisepay
 
     # Get a single fee for a marketplace
     #
-    # @see http://docs.promisepay.com/v2.2/docs/feesid
+    # @see https://reference.promisepay.com/#show-fee
     #
     # @param id [String] Marketplace Fee ID.
     #
@@ -34,7 +34,7 @@ module Promisepay
 
     # Create a fee for a marketplace
     #
-    # @see http://docs.promisepay.com/v2.2/docs/fee_lists
+    # @see https://reference.promisepay.com/#create-fee
     #
     # @param attributes [Hash] Item's attributes.
     #

data/lib/promisepay/resources/item_resource.rb

@@ -7,7 +7,7 @@ module Promisepay
 
     # List all items for a marketplace
     #
-    # @see http://docs.promisepay.com/v2.2/docs/items
+    # @see https://reference.promisepay.com/#list-items
     #
     # @param options [Hash] Optional options.
     # @option options [Integer] :limit Can ask for up to 200 items. default: 10
@@ -22,7 +22,7 @@ module Promisepay
 
     # Get a single item for a marketplace
     #
-    # @see http://docs.promisepay.com/v2.2/docs/itemsid
+    # @see https://reference.promisepay.com/#show-item
     #
     # @param id [String] Marketplace item ID.
     #
@@ -40,7 +40,7 @@ module Promisepay
 
     # Create an item for a marketplace
     #
-    # @see http://docs.promisepay.com/v2.2/docs/items-1
+    # @see https://reference.promisepay.com/#create-item
     #
     # @param attributes [Hash] Item's attributes.
     #

data/lib/promisepay/resources/paypal_account_resource.rb

@@ -7,7 +7,7 @@ module Promisepay
 
     # Get paypal account for a user on a marketplace.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/paypal_accountsid-1
+    # @see https://reference.promisepay.com/#show-paypal-account
     #
     # @param id [String] Paypal Account ID.
     #
@@ -19,7 +19,7 @@ module Promisepay
 
     # Create a Paypal account for a user on a marketplace.
     #
-    # @see http://docs.promisepay.com/v2.2/docs/paypal_accountsid-2
+    # @see https://reference.promisepay.com/#create-paypal-account
     #
     # @param attributes [Hash] Paypal Account's attributes.
     #

data/lib/promisepay/resources/token_resource.rb

@@ -3,19 +3,31 @@ module Promisepay
   class TokenResource < BaseResource
     # Create a new token for an item
     #
-    # @see http://docs.promisepay.com/v2.2/docs/request_session_token
+    # @see https://reference.promisepay.com/#generate-card-token
     #
     # @param attributes [Hash] Token's attributes.
     #
     # @return [Hash]
     def create(type = :session, attributes)
       case type
-      when :session
-        if attributes && attributes[:fee_ids] && attributes[:fee_ids].is_a?(Array)
-          attributes[:fee_ids] = attributes[:fee_ids].join(',')
-        end
-        response = @client.get('request_session_token', attributes)
-        JSON.parse(response.body)
+        when :session
+          if attributes && attributes[:fee_ids] && attributes[:fee_ids].is_a?(Array)
+            attributes[:fee_ids] = attributes[:fee_ids].join(',')
+          end
+          response = @client.get('request_session_token', attributes)
+          JSON.parse(response.body)
+        when :eui
+          attributes[:token_type] = 'eui'
+          response = @client.post('token_auths/', attributes)
+          JSON.parse(response.body)
+        when :card
+          attributes[:token_type] = 'card'
+          response = @client.post('token_auths/', attributes)
+          JSON.parse(response.body)
+        when :approve
+          attributes[:token_type] = '4'
+          response = @client.post('token_auths/', attributes)
+          JSON.parse(response.body)
       end
     end
   end

data/lib/promisepay/resources/transaction_resource.rb

@@ -7,7 +7,7 @@ module Promisepay
 
     # List all transactions for a marketplace
     #
-    # @see http://docs.promisepay.com/v2.2/docs/transactions
+    # @see https://reference.promisepay.com/#list-transactions
     #
     # @param options [Hash] Optional options.
     # @option options [Integer] :limit Can ask for up to 200 transactions. default: 10
@@ -22,7 +22,7 @@ module Promisepay
 
     # Get a single transaction for a marketplace
     #
-    # @see http://docs.promisepay.com/v2.2/docs/transactionsid
+    # @see https://reference.promisepay.com/#show-transaction
     #
     # @param id [String] transaction ID.
     #

data/lib/promisepay/resources/user_resource.rb

@@ -7,7 +7,7 @@ module Promisepay
 
     # List all users for a marketplace
     #
-    # @see http://docs.promisepay.com/v2.2/docs/users
+    # @see https://reference.promisepay.com/#list-users
     #
     # @param options [Hash] Optional options.
     # @option options [Integer] :limit Can ask for up to 200 users. default: 10
@@ -22,7 +22,7 @@ module Promisepay
 
     # Get a single user
     #
-    # @see http://docs.promisepay.com/v2.2/docs/usersid
+    # @see https://reference.promisepay.com/#show-user
     #
     # @param id [String] Marketplace user ID.
     #
@@ -34,7 +34,7 @@ module Promisepay
 
     # Create a new user for a marketplace
     #
-    # @see http://docs.promisepay.com/v2.2/docs/users-1
+    # @see https://reference.promisepay.com/#create-user
     #
     # @param attributes [Hash] User's attributes.
     #
@@ -46,7 +46,7 @@ module Promisepay
 
     # Update a user for a marketplace
     #
-    # @see http://docs.promisepay.com/v2.2/docs/users-1
+    # @see https://reference.promisepay.com/#update-user
     #
     # @param attributes [Hash] User's attributes.
     #

data/lib/promisepay/version.rb

@@ -1,4 +1,4 @@
 # Gem version
 module Promisepay
-  VERSION = '0.0.5'
+  VERSION = '1.0.0'
 end

data/promisepay.gemspec

@@ -5,7 +5,7 @@ require 'promisepay/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'promisepay'
-  spec.version       = Promisepay::VERSION
+  spec.version       = '0.0.6'
   spec.authors       = ['Romain Vigo Benia']
   spec.email         = ['romain.vigobenia@gmail.com']
   spec.summary       = 'Gem to wrap promisepay.com API.'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promisepay
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Romain Vigo Benia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-30 00:00:00.000000000 Z
+date: 2016-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -85,6 +85,7 @@ files:
 - lib/promisepay/models/bank_account.rb
 - lib/promisepay/models/base_model.rb
 - lib/promisepay/models/card_account.rb
+- lib/promisepay/models/company.rb
 - lib/promisepay/models/fee.rb
 - lib/promisepay/models/item.rb
 - lib/promisepay/models/paypal_account.rb
@@ -94,6 +95,7 @@ files:
 - lib/promisepay/resources/bank_account_resource.rb
 - lib/promisepay/resources/base_resource.rb
 - lib/promisepay/resources/card_account_resource.rb
+- lib/promisepay/resources/company_resource.rb
 - lib/promisepay/resources/fee_resource.rb
 - lib/promisepay/resources/item_resource.rb
 - lib/promisepay/resources/paypal_account_resource.rb
@@ -122,9 +124,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Gem to wrap promisepay.com API.
 test_files: []
-has_rdoc: