promisepay 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3efbba09ad1693661066cd70cc8eaf4da701934
-  data.tar.gz: a576fd9343df156c15d989e84b0ef60583860f84
+  metadata.gz: adf04a3bdbb2d06fb8ac5c9d227472472ae2f848
+  data.tar.gz: ae1993be85c0a4dcfe2b7d85c417210d09ea4018
 SHA512:
-  metadata.gz: 872575fef51332bb6ae059113d6cfabdce8310d5fb20cf9af11bdf6234dcd7a2ad02b6ff71c0437b90ba216537016b789093aed2d7dea7561c4fbf22cb6c94e0
-  data.tar.gz: 5074bf9962a4b14f5a8318fae8e45602c900d4af17d8f4b97762e1bbb53c17592963314ee79ff4dee05595493a71a041e7f4e4abe548702c8efa8a5899cf9b53
+  metadata.gz: 21df78755f2183845a671aa0b94f0cf6c56c3e9ed713df5199da036dd72d14475a99c1f0f96e38b7e8fe24b7d45698a6df45e8ecd4fd72b2988982b5085a8fc8
+  data.tar.gz: b414646de24bfbd94a7246de6658891ac4617974c4eca4736f7d4d4934a239e37f5067da612fd036906d07909cfb01d2f3a7091b2f2253a3392e4444b197b5ee

data/README.md

@@ -3,8 +3,8 @@
 [![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).
@@ -33,11 +33,6 @@ See [PromisePay documentation](https://promisepay-docs.readme.io/v1.0/docs/fetch
 
 **Create a PromisePay client**
 
-```ruby
-#In the Gemfile
-gem 'promisepay'
-```
-
 The client can be configured through environment variables.
 
 ```ruby
@@ -53,7 +48,7 @@ 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 client in the appropriate controller
+ Instantiate the PromisePay client.
 
 ```ruby
 client = Promisepay::Client.new(username: ENV['PROMISEPAY_USERNAME'], token: ENV['PROMISEPAY_TOKEN'])
@@ -63,7 +58,7 @@ client = Promisepay::Client.new(username: ENV['PROMISEPAY_USERNAME'], token: ENV
 
 ##Tokens
 ##### Example 1 - Request session token
-The below example shows the controller 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, {
@@ -221,10 +216,18 @@ user.paypal_account
 ```ruby
 user.bank_account
 ```
+#####Get a user's wallet account
+```ruby
+user.wallet_account
+```
 #####Get a user's items
 ```ruby
 user.items
 ```
+#####Get a user's address
+```ruby
+user.address
+```
 #####Set a user's disbursement account
 ```ruby
 user.disbursement_account(bank_account.id)
@@ -329,13 +332,17 @@ bank_account.deactivate
 ```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
@@ -350,22 +357,47 @@ paypal_account.deactivate
 ```ruby
 paypal_account.user
 ```
+
+##Wallet Accounts
+#####Get a Wallet account
+```ruby
+wallet_account = client.wallet_accounts.find('1')
+```
+#####Deposit funds
+```ruby
+wallet_account.deposit(
+  account_id: '123',
+  amount: 500
+)
+```
+#####Withdraw funds
+```ruby
+wallet_account.withdraw(
+  account_id: '123',
+  amount: 200
+)
+```
+#####Get a Wallet account's users
+```ruby
+wallet_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"
+  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"
 )
 ```
 
@@ -379,20 +411,25 @@ client.companies.find('compamy_id')
 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"
+  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"
 )
 ```
 
@@ -433,12 +470,46 @@ transaction.users
 transaction.fees
 ```
 
+##Charges
+#####Get a list of charges
+```ruby
+charges = client.charges.find_all
+```
+#####Get a charge
+```ruby
+charge = client.charges.find('1')
+```
+#####Create a charge
+```ruby
+charge = client.charges.create(
+  account_id: '123',
+  user_id: '456',
+  name: 'Charge for Delivery',
+  email: 'anonymous+buyer+1@promisepay.com',
+  amount: 4_500,
+  zip: '3000',
+  curency: 'AUD',
+  country: 'AUS',
+  retain_account: true,
+  device_id: '0900JapG4txqVP4Nf...',
+  ip_address: '172.16.81.100'
+)
+```
+#####Get a charge's buyer
+```ruby
+charge.buyer
+```
+#####Get a charge's status
+```ruby
+charge.status
+```
+
 _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
+  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,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

@@ -4,16 +4,19 @@ require_relative 'models/base_model'
 require_relative 'models/account'
 require_relative 'models/bank_account'
 require_relative 'models/card_account'
+require_relative 'models/charge'
 require_relative 'models/company'
 require_relative 'models/fee'
 require_relative 'models/item'
 require_relative 'models/paypal_account'
 require_relative 'models/transaction'
 require_relative 'models/user'
+require_relative 'models/wallet_account'
 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/charge_resource'
 require_relative 'resources/company_resource'
 require_relative 'resources/fee_resource'
 require_relative 'resources/item_resource'
@@ -21,6 +24,7 @@ require_relative 'resources/paypal_account_resource'
 require_relative 'resources/token_resource'
 require_relative 'resources/transaction_resource'
 require_relative 'resources/user_resource'
+require_relative 'resources/wallet_account_resource'
 require 'json'
 require 'faraday'
 
@@ -55,9 +59,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
 
@@ -113,13 +117,15 @@ module Promisepay
       {
         bank_accounts: BankAccountResource,
         card_accounts: CardAccountResource,
+        charges: ChargeResource,
         companies: CompanyResource,
         fees: FeeResource,
         items: ItemResource,
         paypal_accounts: PaypalAccountResource,
         transactions: TransactionResource,
         users: UserResource,
-        tokens: TokenResource
+        tokens: TokenResource,
+        wallet_accounts: WalletAccountResource
       }
     end
 

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/charge.rb

@@ -0,0 +1,25 @@
+
+module Promisepay
+  # Manage Charges
+  class Charge < BaseModel
+    # Get the buyer associated with the charge.
+    #
+    # @see https://reference.promisepay.com/#show-charge-buyer
+    #
+    # @return [Promisepay::User]
+    def buyer
+      response = JSON.parse(@client.get("charges/#{send(:id)}/buyers").body)
+      Promisepay::User.new(@client, response['users'])
+    end
+
+    # Get current status.
+    #
+    # @see https://reference.promisepay.com/#show-charge-status
+    #
+    # @return [Hash]
+    def status
+      response = JSON.parse(@client.get("charges/#{send(:id)}/status").body)
+      response['charges']
+    end
+  end
+end

data/lib/promisepay/models/company.rb

@@ -1,15 +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 
+    # @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
@@ -49,9 +62,21 @@ module Promisepay
       nil
     end
 
+    # Show the User’s Wallet Account.
+    #
+    # @see https://reference.promisepay.com/#show-user-wallet-account
+    #
+    # @return [Promisepay::WalletAccount]
+    def wallet_account
+      response = JSON.parse(@client.get("users/#{send(:id)}/wallet_accounts").body)
+      Promisepay::WalletAccount.new(@client, response['wallet_accounts'])
+    rescue Promisepay::UnprocessableEntity
+      nil
+    end
+
     # 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)
@@ -62,7 +87,7 @@ module Promisepay
 
     # Gets company for a user on a marketplace.
     #
-    # @see 
+    # @see
     #
     # @return [Promisepay::Company]
     def company
@@ -71,5 +96,16 @@ module Promisepay
     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/models/wallet_account.rb

@@ -0,0 +1,40 @@
+module Promisepay
+  # Manage Wallet Accounts
+  class WalletAccount < BaseModel
+    # Withdraw funds from a Wallet Account to a specified disbursement account.
+    #
+    # @see https://reference.promisepay.com/#withdraw-funds
+    #
+    # @param options [Hash] Optional options.
+    # @option options [String] :account_id Account to withdraw to.
+    # @option options [Integer] :amount Amount (in cents) to withdraw.
+    #
+    # @return [Hash]
+    def withdraw(options = {})
+      response = JSON.parse(@client.post("wallet_accounts/#{send(:id)}/withdraw", options).body)
+      response.key?('disbursements') ? response['disbursements'] : {}
+    end
+
+    # Deposit funds to a Wallet Account from a specified payment account.
+    #
+    # @see https://reference.promisepay.com/#deposit-funds
+    #
+    # @param options [Hash] Optional options.
+    # @option options [String] :account_id Account to deposit from.
+    # @option options [Integer] :amount Amount (in cents) to deposit.
+    #
+    # @return [Hash]
+    def deposit(options = {})
+      response = JSON.parse(@client.post("wallet_accounts/#{send(:id)}/deposit", options).body)
+      response.key?('disbursements') ? response['disbursements'] : {}
+    end
+
+    # Show the User the Wallet Account is associated with
+    #
+    # @return [Promisepay::User]
+    def user
+      response = JSON.parse(@client.get("wallet_accounts/#{send(:id)}/users").body)
+      response.key?('users') ? Promisepay::User.new(@client, response['users']) : nil
+    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/charge_resource.rb

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

data/lib/promisepay/resources/company_resource.rb

@@ -7,7 +7,7 @@ module Promisepay
 
     # List all companies for a marketplace
     #
-    # @see http://docs.promisepay.com/v2.2/docs/companies
+    # @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
@@ -22,7 +22,7 @@ module Promisepay
 
     # Get a company
     #
-    # @see 
+    # @see https://reference.promisepay.com/#show-company
     #
     # @param id [String] Company id
     #
@@ -34,7 +34,7 @@ module Promisepay
 
     # Create a company for a user
     #
-    # @see 
+    # @see https://reference.promisepay.com/#create-company
     #
     # @param attributes [Hash] Company's attributes.
     #
@@ -46,7 +46,7 @@ module Promisepay
 
     # Update a company for a user
     #
-    # @see 
+    # @see https://reference.promisepay.com/#update-company
     #
     # @param attributes [Hash] Company's attributes.
     #

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

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/resources/wallet_account_resource.rb

@@ -0,0 +1,20 @@
+module Promisepay
+  # Resource for the Wallet Accounts API
+  class WalletAccountResource < BaseResource
+    def model
+      Promisepay::WalletAccount
+    end
+
+    # Get a single wallet account
+    #
+    # @see https://reference.promisepay.com/#show-wallet-account
+    #
+    # @param id [String] account ID.
+    #
+    # @return [Promisepay::WalletAccount]
+    def find(id)
+      response = JSON.parse(@client.get("wallet_accounts/#{id}").body)
+      Promisepay::WalletAccount.new(@client, response['wallet_accounts'])
+    end
+  end
+end

data/lib/promisepay/version.rb

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

data/promisepay.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 1.9.3'
 
   spec.add_dependency 'faraday'
-  spec.add_dependency 'json'
+  spec.add_dependency 'json', '~> 1.8.3'
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promisepay
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Romain Vigo Benia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-23 00:00:00.000000000 Z
+date: 2016-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -28,16 +28,16 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -85,16 +85,19 @@ files:
 - lib/promisepay/models/bank_account.rb
 - lib/promisepay/models/base_model.rb
 - lib/promisepay/models/card_account.rb
+- lib/promisepay/models/charge.rb
 - lib/promisepay/models/company.rb
 - lib/promisepay/models/fee.rb
 - lib/promisepay/models/item.rb
 - lib/promisepay/models/paypal_account.rb
 - lib/promisepay/models/transaction.rb
 - lib/promisepay/models/user.rb
+- lib/promisepay/models/wallet_account.rb
 - lib/promisepay/resources/account_resource.rb
 - lib/promisepay/resources/bank_account_resource.rb
 - lib/promisepay/resources/base_resource.rb
 - lib/promisepay/resources/card_account_resource.rb
+- lib/promisepay/resources/charge_resource.rb
 - lib/promisepay/resources/company_resource.rb
 - lib/promisepay/resources/fee_resource.rb
 - lib/promisepay/resources/item_resource.rb
@@ -102,6 +105,7 @@ files:
 - lib/promisepay/resources/token_resource.rb
 - lib/promisepay/resources/transaction_resource.rb
 - lib/promisepay/resources/user_resource.rb
+- lib/promisepay/resources/wallet_account_resource.rb
 - lib/promisepay/version.rb
 - promisepay.gemspec
 homepage: https://github.com/PromisePay/promisepay-ruby
@@ -124,9 +128,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Gem to wrap promisepay.com API.
 test_files: []
-has_rdoc: