promisepay 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7dcb61a47f74888de0ae910a8d72760ff8bfec29
+  data.tar.gz: 75b9d99aead5fbc6aaef117ca81fc61e6540f1a9
+SHA512:
+  metadata.gz: 7da53336edb95c96705fcc4f87d57a1295e7b595f2c58d8a58e434e8f925bb8fb54ed81bbab9895eda4c657c0c3297659787732049520d7139e59f7333427811
+  data.tar.gz: c5e43c9926709b9f108387f93f238af7c1e7d9e2dfa99df75493e49fd9edb6d3e49ce85dba0bc81e890866cd0f7f62bbd146af2da4514b6ff65acabdce39cd9c

data/LICENSE.txt

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

data/README.md

@@ -0,0 +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

data/Rakefile

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

data/lib/promisepay.rb

@@ -0,0 +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

data/lib/promisepay/client.rb

@@ -0,0 +1,144 @@
+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

data/lib/promisepay/configurable.rb

@@ -0,0 +1,49 @@
+module Promisepay
+  # Configuration options for {Client}, defaulting to values in {Default}.
+  module Configurable
+    # @!attribute api_domain
+    #   @return [String] Promisepay API domain name. default: api.promisepay.com
+    # @!attribute environment
+    #   @see http://docs.promisepay.com/v2.2/docs/environments
+    #   @return [String] Promisepay environment. default: test
+    # @!attribute token
+    #   @see http://docs.promisepay.com/v2.2/docs/overview-2
+    #   @return [String] Promisepay token for Basic Authentication.
+    # @!attribute username
+    #   @see http://docs.promisepay.com/v2.2/docs/overview-2
+    #   @return [String] Promisepay username for Basic Authentication.
+
+    attr_accessor :api_domain, :environment, :token, :username
+
+    class << self
+      # List of configurable keys for {Promisepay::Client}.
+      #
+      # @return [Array] of option keys
+      def keys
+        @keys ||= [
+          :environment,
+          :api_domain,
+          :token,
+          :username
+        ]
+      end
+    end
+
+    # Reset configuration options to default values.
+    def reset!
+      Promisepay::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", Promisepay::Default.options[key])
+      end
+      self
+    end
+    alias_method :setup, :reset!
+
+    # API endpoint to be used by {Promisepay::Client}.
+    # Built from {#environment} and {#api_domain}
+    #
+    # @return [String]
+    def api_endpoint
+      "https://#{@environment}.#{@api_domain}/"
+    end
+  end
+end

data/lib/promisepay/default.rb

@@ -0,0 +1,47 @@
+module Promisepay
+  # Default configuration options for {Client}
+  module Default
+    # Default API domain
+    API_DOMAIN = 'api.promisepay.com'.freeze
+
+    # Default environment
+    ENVIRONMENT = 'test'.freeze
+
+    class << self
+      # Configuration options.
+      #
+      # @return [Hash]
+      def options
+        Hash[Promisepay::Configurable.keys.map { |key| [key, send(key)] }]
+      end
+
+      # Default environment from ENV or {ENVIRONMENT}.
+      #
+      # @return [String]
+      def environment
+        ENV['PROMISEPAY_ENVIRONMENT'] || ENVIRONMENT
+      end
+
+      # Default API domain from ENV or {API_DOMAIN}.
+      #
+      # @return [String]
+      def api_domain
+        ENV['PROMISEPAY_API_DOMAIN'] || API_DOMAIN
+      end
+
+      # Default token from ENV.
+      #
+      # @return [String]
+      def token
+        ENV['PROMISEPAY_TOKEN']
+      end
+
+      # Default username from ENV.
+      #
+      # @return [String]
+      def username
+        ENV['PROMISEPAY_USERNAME']
+      end
+    end
+  end
+end