promisepay 0.0.2

data/lib/promisepay/error.rb

@@ -0,0 +1,92 @@
+module Promisepay
+  # Custom error class for rescuing from all Promisepau errors
+  class Error < StandardError
+    # Returns the appropriate Promisepay::Error subclass based on status
+    #
+    # @param [Faraday::Response] response Faraday HTTP response
+    # @return [Promisepay::Error]
+    def self.from_response(response)
+      klass = case response.status
+              when 400      then Promisepay::BadRequest
+              when 401      then Promisepay::Unauthorized
+              when 403      then Promisepay::Forbidden
+              when 404      then Promisepay::NotFound
+              when 405      then Promisepay::MethodNotAllowed
+              when 406      then Promisepay::NotAcceptable
+              when 409      then Promisepay::Conflict
+              when 422      then Promisepay::UnprocessableEntity
+              when 400..499 then Promisepay::ClientError
+              when 500      then Promisepay::InternalServerError
+              when 501      then Promisepay::NotImplemented
+              when 502      then Promisepay::BadGateway
+              when 503      then Promisepay::ServiceUnavailable
+              when 500..599 then Promisepay::ServerError
+              end
+      (klass) ? klass.new(response) : new(response)
+    end
+
+    def initialize(response = nil)
+      @response = response
+      super(build_error_message)
+    end
+
+    private
+
+    def build_error_message
+      return nil if @response.nil? || @response.body.nil?
+
+      json_response = JSON.parse(@response.body)
+      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
+      end
+
+      message
+    end
+  end
+
+  # Raised on errors in the 400-499 range
+  class ClientError < Error; end
+
+  # Raised when Promisepay returns a 400 HTTP status code
+  class BadRequest < ClientError; end
+
+  # Raised when Promisepay returns a 401 HTTP status code
+  class Unauthorized < ClientError; end
+
+  # Raised when Promisepay returns a 403 HTTP status code
+  class Forbidden < ClientError; end
+
+  # Raised when Promisepay returns a 404 HTTP status code
+  class NotFound < ClientError; end
+
+  # Raised when Promisepay returns a 405 HTTP status code
+  class MethodNotAllowed < ClientError; end
+
+  # Raised when Promisepay returns a 406 HTTP status code
+  class NotAcceptable < ClientError; end
+
+  # Raised when Promisepay returns a 409 HTTP status code
+  class Conflict < ClientError; end
+
+  # Raised when Promisepay returns a 422 HTTP status code
+  class UnprocessableEntity < ClientError; end
+
+  # Raised on errors in the 500-599 range
+  class ServerError < Error; end
+
+  # Raised when Promisepay returns a 500 HTTP status code
+  class InternalServerError < ServerError; end
+
+  # Raised when Promisepay returns a 501 HTTP status code
+  class NotImplemented < ServerError; end
+
+  # Raised when Promisepay returns a 502 HTTP status code
+  class BadGateway < ServerError; end
+
+  # Raised when Promisepay returns a 503 HTTP status code
+  class ServiceUnavailable < ServerError; end
+end

data/lib/promisepay/models/account.rb

@@ -0,0 +1,5 @@
+module Promisepay
+  # Manage Accounts
+  class Account < BaseModel
+  end
+end

data/lib/promisepay/models/bank_account.rb

@@ -0,0 +1,28 @@
+module Promisepay
+  # Manage Bank accounts
+  class BankAccount < Account
+    # Get the user the bank account belongs to.
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/bank_accountsidusers
+    #
+    # @return [Promisepay::User]
+    def user
+      response = JSON.parse(@client.get("bank_accounts/#{send(:id)}/users").body)
+      Promisepay::User.new(@client, response['users'])
+    end
+
+    # 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
+    #
+    # @param mobile_pin [String] Mobile PIN.
+    #
+    # @return [Boolean]
+    def deactivate(mobile_pin)
+      @client.delete("bank_accounts/#{id}", mobile_pin: mobile_pin)
+      @attributes['active'] = false
+      true
+    end
+  end
+end

data/lib/promisepay/models/base_model.rb

@@ -0,0 +1,23 @@
+module Promisepay
+  # Base model for all the other models to inherit from
+  class BaseModel
+    def initialize(client, attributes = {})
+      @client = client
+      @attributes = stringify_keys(attributes)
+    end
+
+    def method_missing(name, *args, &block)
+      if @attributes.key?(name.to_s)
+        @attributes[name.to_s]
+      else
+        super
+      end
+    end
+
+    private
+
+    def stringify_keys(hash)
+      Hash[hash.map { |k, v| [k.to_s, v] }]
+    end
+  end
+end

data/lib/promisepay/models/card_account.rb

@@ -0,0 +1,26 @@
+module Promisepay
+  # Manage Card accounts
+  class CardAccount < Account
+    # Get the user the card account belongs to.
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/card_accountsidusers
+    #
+    # @return [Promisepay::User]
+    def user
+      response = JSON.parse(@client.get("card_accounts/#{send(:id)}/users").body)
+      Promisepay::User.new(@client, response['users'])
+    end
+
+    # 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
+    #
+    # @return [Boolean]
+    def deactivate
+      @client.delete("card_accounts/#{id}")
+      @attributes['active'] = false
+      true
+    end
+  end
+end

data/lib/promisepay/models/fee.rb

@@ -0,0 +1,5 @@
+module Promisepay
+  # Manage Fees
+  class Fee < BaseModel
+  end
+end

data/lib/promisepay/models/item.rb

@@ -0,0 +1,197 @@
+module Promisepay
+  # Manage Items
+  class Item < BaseModel
+    # Update the attributes of an item.
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/itemsiduseraction
+    #
+    # @param attributes [Hash] Item's attributes to be updated.
+    #
+    # @return [self]
+    def update(attributes)
+      response = JSON.parse(@client.patch("items/#{send(:id)}", attributes).body)
+      @attributes = response['items']
+      self
+    end
+
+    # Show the item status for a marketplace.
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/itemsidstatus
+    #
+    # @return [Hash]
+    def status
+      response = JSON.parse(@client.get("items/#{send(:id)}/status").body)
+      response['items']
+    end
+
+    # Show the buyer detail for a single item for a marketplace.
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/itemsidbuyers
+    #
+    # @return [Promisepay::User]
+    def buyer
+      response = JSON.parse(@client.get("items/#{send(:id)}/buyers").body)
+      Promisepay::User.new(@client, response['users'])
+    end
+
+    # Show the seller detail for a single item for a marketplace.
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/itemsidbuyers
+    #
+    # @return [Promisepay::User]
+    def seller
+      response = JSON.parse(@client.get("items/#{send(:id)}/sellers").body)
+      Promisepay::User.new(@client, response['users'])
+    end
+
+    # Get fees associated to the item.
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/itemsidfees
+    #
+    # @param options [Hash] Optional options.
+    # @option options [Integer] :limit Can ask for up to 200 fees. default: 10
+    # @option options [Integer] :offset Pagination help. default: 0
+    #
+    # @return [Array<Promisepay::Fee>]
+    def fees(options = {})
+      response = JSON.parse(@client.get("items/#{send(:id)}/fees", options).body)
+      fees = response.key?('fees') ? response['fees'] : []
+      fees.map { |attributes| Promisepay::Fee.new(@client, attributes) }
+    end
+
+    # Get historical transaction for the item.
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/itemsidtransactions
+    #
+    # @param options [Hash] Optional options.
+    # @option options [Integer] :limit Can ask for up to 200 transactions. default: 10
+    # @option options [Integer] :offset Pagination help. default: 0
+    #
+    # @return [Array<Promisepay::Transaction>]
+    def transactions(options = {})
+      response = JSON.parse(@client.get("items/#{send(:id)}/transactions", options).body)
+      transactions = response.key?('transactions') ? response['transactions'] : []
+      transactions.map { |attributes| Promisepay::Transaction.new(@client, attributes) }
+    end
+
+    # Show the wire details for payment.
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/itemsidwire_details
+    #
+    # @return [Hash]
+    def wire_details
+      response = JSON.parse(@client.get("items/#{send(:id)}/wire_details").body)
+      response['items']['wire_details']
+    end
+
+    # Show the bpay details details for payment.
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/itemsidbpay_details
+    #
+    # @return [Hash]
+    def bpay_details
+      response = JSON.parse(@client.get("items/#{send(:id)}/bpay_details").body)
+      response['items']['bpay_details']
+    end
+
+    # .
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/itemsidaction
+    #
+    # @return [Boolean]
+    def make_payment(options = {})
+      @client.patch("items/#{send(:id)}/make_payment", options).body
+      true
+    end
+
+    # .
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/itemsidrequest_payment
+    #
+    # @return [Boolean]
+    def request_payment(options = {})
+      @client.patch("items/#{send(:id)}/request_payment", options).body
+      true
+    end
+
+    # .
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/itemsidrequest_payment
+    #
+    # @return [Boolean]
+    def release_payment(options = {})
+      @client.patch("items/#{send(:id)}/release_payment", options).body
+      true
+    end
+
+    # .
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/itemsidrequest_release
+    #
+    # @return [Boolean]
+    def request_release(options = {})
+      @client.patch("items/#{send(:id)}/request_release", options).body
+      true
+    end
+
+    # .
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/itemsidacknowledge_wire
+    #
+    # @return [Boolean]
+    def acknowledge_wire(options = {})
+      @client.patch("items/#{send(:id)}/acknowledge_wire", options).body
+      true
+    end
+
+    # .
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/itemsidacknowledge_paypal
+    #
+    # @return [Boolean]
+    def acknowledge_paypal(options = {})
+      @client.patch("items/#{send(:id)}/acknowledge_paypal", options).body
+      true
+    end
+
+    # .
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/itemsidrevert_wire
+    #
+    # @return [Boolean]
+    def revert_wire(options = {})
+      @client.patch("items/#{send(:id)}/revert_wire", options).body
+      true
+    end
+
+    # .
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/itemsidrequest_refund
+    #
+    # @return [Boolean]
+    def request_refund(options = {})
+      @client.patch("items/#{send(:id)}/request_refund", options).body
+      true
+    end
+
+    # .
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/itemsidrefund
+    #
+    # @return [Boolean]
+    def refund(options = {})
+      @client.patch("items/#{send(:id)}/refund", options).body
+      true
+    end
+
+    # .
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/itemsidcancel
+    #
+    # @return [Boolean]
+    def cancel
+      @client.patch("items/#{id}/cancel")
+      true
+    end
+  end
+end

data/lib/promisepay/models/paypal_account.rb

@@ -0,0 +1,26 @@
+module Promisepay
+  # Manage Paypal accounts
+  class PaypalAccount < Account
+    # Get the user the paypal account belongs to.
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/paypal_accountsidusers
+    #
+    # @return [Promisepay::User]
+    def user
+      response = JSON.parse(@client.get("paypal_accounts/#{send(:id)}/users").body)
+      Promisepay::User.new(@client, response['users'])
+    end
+
+    # 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
+    #
+    # @return [Boolean]
+    def deactivate
+      @client.delete("paypal_accounts/#{id}")
+      @attributes['active'] = false
+      true
+    end
+  end
+end

data/lib/promisepay/models/transaction.rb

@@ -0,0 +1,24 @@
+module Promisepay
+  # Manage Transactions
+  class Transaction < Account
+    # .
+    #
+    # @see https://test.api.promisepay.com/transactions/:id/users
+    #
+    # @return [Promisepay::User]
+    def user
+      response = JSON.parse(@client.get("transactions/#{send(:id)}/users").body)
+      response.key?('users') ? Promisepay::User.new(@client, response['users']) : nil
+    end
+
+    # Gets a transactions fee details if applicable.
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/transactionsidfees
+    #
+    # @return [Promisepay::Fee]
+    def fee
+      response = JSON.parse(@client.get("transactions/#{send(:id)}/fees").body)
+      response.key?('fees') ? Promisepay::Fee.new(@client, response['fees']) : nil
+    end
+  end
+end

data/lib/promisepay/models/user.rb

@@ -0,0 +1,63 @@
+
+module Promisepay
+  # Manage Users
+  class User < BaseModel
+    # Lists items for a user on a marketplace.
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/usersiditems
+    #
+    # @return [Array<Promisepay::Item>]
+    def items
+      response = JSON.parse(@client.get("users/#{send(:id)}/items").body)
+      users = response.key?('items') ? response['items'] : []
+      users.map { |attributes| Promisepay::Item.new(@client, attributes) }
+    end
+
+    # Gets Bank account for a user on a marketplace.
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/usersidbank_accounts
+    #
+    # @return [Promisepay::BankAccount]
+    def bank_account
+      response = JSON.parse(@client.get("users/#{send(:id)}/bank_accounts").body)
+      Promisepay::BankAccount.new(@client, response['bank_accounts'])
+    rescue Promisepay::UnprocessableEntity
+      nil
+    end
+
+    # Gets Card account for a user on a marketplace.
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/usersidcard_accounts
+    #
+    # @return [Promisepay::CardAccount]
+    def card_account
+      response = JSON.parse(@client.get("users/#{send(:id)}/card_accounts").body)
+      Promisepay::CardAccount.new(@client, response['card_accounts'])
+    rescue Promisepay::UnprocessableEntity
+      nil
+    end
+
+    # Gets PayPal account for a user on a marketplace.
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/usersidpaypal_accounts
+    #
+    # @return [Promisepay::PaypalAccount]
+    def paypal_account
+      response = JSON.parse(@client.get("users/#{send(:id)}/paypal_accounts").body)
+      Promisepay::PaypalAccount.new(@client, response['paypal_accounts'])
+    rescue Promisepay::UnprocessableEntity
+      nil
+    end
+
+    # Set the disbursement account for a user.
+    #
+    # @see http://docs.promisepay.com/v2.2/docs/usersiddisbursement_account
+    #
+    # @return [Boolean]
+    def disbursement_account(account_id)
+      options = { account_id: account_id }
+      JSON.parse(@client.post("users/#{send(:id)}/disbursement_account", options).body)
+      true
+    end
+  end
+end