synapse_payments 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ddd2a41ccc17df99fb5fe4db0ac880ab279c7435
+  data.tar.gz: 7af2509dd87a509263c946d4f18ca892f903af49
+SHA512:
+  metadata.gz: 518d596a730d075ba628eb364df903adbb906ea641588ec814d6cddc16b20998825ae065f98d9683a23b57e72e39e00648644dbfa35bb1b59ec44888a598424c
+  data.tar.gz: b16a8975143fbe27fac7538210432c76e1390218bc7897f1078db858ee8f3ad6fef26ca34eed1c1e4fc5767b7ac8a0c8035259c4960303ae67ec0786e1efd573

data/.env.sample

@@ -0,0 +1,2 @@
+SYNAPSE_PAYMENTS_CLIENT_ID="YOUR_CLIENT_ID"
+SYNAPSE_PAYMENTS_CLIENT_SECRET="YOUR_CLIENT_SECRET"

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 2.1.5
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6
+cache: bundler
+sudo: false
+fast_finish: true
+env:
+  - USER_ID=
+notifications:
+  email:
+    on_success: always
+    on_failure: always

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in synapse_payments.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Javier Julio
+
+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,67 @@
+# The SynapsePayments Ruby Gem
+
+A tested Ruby interface to the [SynapsePay v3 API](http://docs.synapsepay.com/v3.1). Note: Requires **Ruby 2.1 and up**. Not all API actions are supported. Find out more in the TODO section.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'synapse_payments'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install synapse_payments
+
+To try out the gem and experiment, you're better off following the development instructions.
+
+## Usage
+
+Check out [samples.md](samples.md) to review how to use this library.
+
+## Development
+
+1. Clone the repo: `git clone https://github.com/javierjulio/synapse_payments.git`
+2. Use Ruby 2.1 and up. If you need to install use [rbenv](https://github.com/sstephenson/rbenv) and [ruby-build](https://github.com/sstephenson/ruby-build) and then run:
+
+        gem update --system
+        gem update
+        gem install bundler --no-rdoc --no-ri
+
+3. From project root run `./bin/setup` script
+4. Run `./bin/console` for an interactive prompt with an authenticated client for you to experiment:
+
+  ```ruby
+  users = client.users.all
+  puts users
+  # => {...
+  ```
+
+### TODO
+
+* add pagination/querying to `users.all`, `nodes.all`, and `transactions.all`
+* add support for new `subscriptions` resource
+* add new methods to UserClient: `link_bank_account`, `verify_mfa`, `attach_photo_id`, `add_escrow_account`
+* add `Banks` object with `list` method which returns supported banks from https://synapsepay.com/api/v3/institutions/show
+* consider creating a `Response` object wrapper
+
+### Tests
+
+Run `bundle exec rake test`. To include integration tests run with `USER_ID=YOUR_USER_ID` being a user you created in sandbox.
+
+### Releasing
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/javierjulio/synapse_payments. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "synapse_payments"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'dotenv'
+Dotenv.load
+
+def client
+  @client ||= SynapsePayments::Client.new do |config|
+    config.client_id = ENV['SYNAPSE_PAYMENTS_CLIENT_ID']
+    config.client_secret = ENV['SYNAPSE_PAYMENTS_CLIENT_SECRET']
+  end
+end
+
+def reset_client
+  @client = nil
+  client
+  true
+end
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,29 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+read -r -p 'Do you have a SynapsePay sandbox account? (y/n) ' has_account
+
+if [[ "$has_account" =~ ^(Yes|yes|Y|y)$ ]]; then
+  echo "Great! You can get your account credentials from:"
+  echo "  https://sandbox.synapsepay.com/v3/dashboard/#/profile"
+  echo
+else
+  echo "Then you'll need to create an account first at:"
+  echo "  http://docs.synapsepay.com/docs/sandbox-keys"
+  echo
+  read -s -p "Press Enter key if you're ready to continue..."
+  echo
+fi
+
+echo "Enter your account credentials below."
+read -p 'Client ID: ' client_id
+read -p 'Client Secret: ' client_secret
+
+cp .env.sample .env
+sed -i -e s/YOUR_CLIENT_ID/"$client_id"/g .env
+sed -i -e s/YOUR_CLIENT_SECRET/"$client_secret"/g .env
+
+echo "Done."

data/lib/synapse_payments.rb

@@ -0,0 +1,9 @@
+require "synapse_payments/version"
+require "synapse_payments/error"
+require "synapse_payments/client"
+require "synapse_payments/user_client"
+require "synapse_payments/request"
+require "synapse_payments/users"
+require "synapse_payments/nodes"
+require "synapse_payments/node"
+require "synapse_payments/transactions"

data/lib/synapse_payments/client.rb

@@ -0,0 +1,60 @@
+require 'http'
+
+module SynapsePayments
+  class Client
+
+    API_TEST = 'https://sandbox.synapsepay.com/api/3'
+    API_LIVE = 'https://synapsepay.com/api/3'
+
+    attr_accessor :client_id, :client_secret, :sandbox_mode
+    attr_reader :api_base, :users
+
+    # Initializes a new Client object
+    #
+    # @param options [Hash]
+    # @return [SynapsePayments::Client]
+    def initialize(options={})
+      @sandbox_mode = true
+
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+
+      yield(self) if block_given?
+
+      @api_base = @sandbox_mode ? API_TEST : API_LIVE
+
+      @users = Users.new(self)
+    end
+
+    # @return [Hash]
+    def credentials
+      {
+        client_id: client_id,
+        client_secret: client_secret
+      }
+    end
+
+    # @return [Boolean]
+    def credentials?
+      credentials.values.all?
+    end
+
+    def get(path:, oauth_key: nil)
+      Request.new(client: self, method: :get, path: path, oauth_key: oauth_key).perform
+    end
+
+    def post(path:, json:, oauth_key: nil)
+      Request.new(client: self, method: :post, path: path, oauth_key: oauth_key, json: json).perform
+    end
+
+    def patch(path:, json:, oauth_key: nil)
+      Request.new(client: self, method: :patch, path: path, oauth_key: oauth_key, json: json).perform
+    end
+
+    def delete(path:, oauth_key: nil)
+      Request.new(client: self, method: :delete, path: path, oauth_key: oauth_key).perform
+    end
+
+  end
+end

data/lib/synapse_payments/error.rb

@@ -0,0 +1,114 @@
+module SynapsePayments
+  class Error < StandardError
+    # Raised on a 4xx HTTP status code
+    ClientError = Class.new(self)
+
+    # Raised on the HTTP status code 400
+    BadRequest = Class.new(ClientError)
+
+    # Raised on the HTTP status code 401
+    Unauthorized = Class.new(ClientError)
+
+    # Raised on the HTTP status code 402
+    RequestDeclined = Class.new(ClientError)
+
+    # Raised on the HTTP status code 403
+    Forbidden = Class.new(ClientError)
+
+    # Raised on the HTTP status code 404
+    NotFound = Class.new(ClientError)
+
+    # Raised on the HTTP status code 406
+    NotAcceptable = Class.new(ClientError)
+
+    # Raised on the HTTP status code 409
+    Conflict = Class.new(ClientError)
+
+    # Raised on the HTTP status code 415
+    UnsupportedMediaType = Class.new(ClientError)
+
+    # Raised on the HTTP status code 422
+    UnprocessableEntity = Class.new(ClientError)
+
+    # Raised on the HTTP status code 429
+    TooManyRequests = Class.new(ClientError)
+
+    # Raised on a 5xx HTTP status code
+    ServerError = Class.new(self)
+
+    # Raised on the HTTP status code 500
+    InternalServerError = Class.new(ServerError)
+
+    # Raised on the HTTP status code 502
+    BadGateway = Class.new(ServerError)
+
+    # Raised on the HTTP status code 503
+    ServiceUnavailable = Class.new(ServerError)
+
+    # Raised on the HTTP status code 504
+    GatewayTimeout = Class.new(ServerError)
+
+    ERRORS = {
+      400 => SynapsePayments::Error::BadRequest,
+      401 => SynapsePayments::Error::Unauthorized,
+      402 => SynapsePayments::Error::RequestDeclined,
+      403 => SynapsePayments::Error::Forbidden,
+      404 => SynapsePayments::Error::NotFound,
+      406 => SynapsePayments::Error::NotAcceptable,
+      409 => SynapsePayments::Error::Conflict,
+      415 => SynapsePayments::Error::UnsupportedMediaType,
+      422 => SynapsePayments::Error::UnprocessableEntity,
+      429 => SynapsePayments::Error::TooManyRequests,
+      500 => SynapsePayments::Error::InternalServerError,
+      502 => SynapsePayments::Error::BadGateway,
+      503 => SynapsePayments::Error::ServiceUnavailable,
+      504 => SynapsePayments::Error::GatewayTimeout,
+    }
+
+    # The SynapsePay API Error Code
+    #
+    # @return [Integer]
+    attr_reader :code
+
+    # The JSON HTTP response in Hash form
+    #
+    # @return [Hash]
+    attr_reader :response
+
+    class << self
+      # Create a new error from an HTTP response
+      #
+      # @param body [String]
+      # @param code [Integer]
+      # @return [SynapsePayments::Error]
+      def error_from_response(body, code)
+        klass = ERRORS[code] || SynapsePayments::Error
+        message, error_code = parse_error(body)
+        klass.new(message: message, code: error_code, response: body)
+      end
+
+    private
+
+      def parse_error(body)
+        if body.nil? || body.empty?
+          ['', nil]
+        elsif body.is_a?(Hash) && body['error'].is_a?(Hash)
+          [body['error']['en'], body['error_code']]
+        end
+      end
+
+    end
+
+    # Initializes a new Error object
+    #
+    # @param message [Exception, String]
+    # @param code [Integer]
+    # @param response [Hash]
+    # @return [SynapsePayments::Error]
+    def initialize(message: '', code: nil, response: {})
+      super(message)
+      @code = code
+      @response = response
+    end
+  end
+end

data/lib/synapse_payments/node.rb

@@ -0,0 +1,16 @@
+module SynapsePayments
+  class Node
+
+    attr_reader :transactions
+
+    def initialize(client, user_id, node_id, oauth_key)
+      @client = client
+      @user_id = user_id
+      @node_id = node_id
+      @oauth_key = oauth_key
+      @transactions = Transactions.new(@client, user_id, node_id, oauth_key)
+    end
+
+  end
+
+end

data/lib/synapse_payments/nodes.rb

@@ -0,0 +1,28 @@
+module SynapsePayments
+  class Nodes
+
+    def initialize(client, user_id, oauth_key)
+      @client = client
+      @user_id = user_id
+      @oauth_key = oauth_key
+    end
+
+    def all
+      @client.get(path: "/users/#{@user_id}/nodes", oauth_key: @oauth_key)
+    end
+
+    def find(id)
+      @client.get(path: "/users/#{@user_id}/nodes/#{id}", oauth_key: @oauth_key)
+    end
+
+    def create(data)
+      @client.post(path: "/users/#{@user_id}/nodes", oauth_key: @oauth_key, json: data)
+    end
+
+    def delete(id)
+      @client.delete(path: "/users/#{@user_id}/nodes/#{id}", oauth_key: @oauth_key)
+    end
+
+  end
+
+end

data/lib/synapse_payments/request.rb

@@ -0,0 +1,57 @@
+module SynapsePayments
+  class Request
+
+    HEADERS = {
+      'Accept'          => 'application/json',
+      'User-Agent'      => "SynapsePaymentsRubyGem/#{SynapsePayments::VERSION}",
+      'X-Ruby-Version'  => RUBY_VERSION,
+      'X-Ruby-Platform' => RUBY_PLATFORM
+    }
+
+    def initialize(client:, method:, path:, oauth_key: nil, json: nil)
+      @client = client
+      @method = method
+      @path = path
+      @oauth_key = oauth_key
+      @json = json
+    end
+
+    def perform
+      options_key = @method == :get ? :params : :json
+      response = http_client.public_send(@method, "#{@client.api_base}#{@path}", options_key => @json)
+      response_body = symbolize_keys!(response.parse)
+      fail_or_return_response_body(response.code, response_body)
+    end
+
+    def http_client
+      headers = HEADERS.merge({
+        'X-SP-GATEWAY' => "#{@client.client_id}|#{@client.client_secret}",
+        'X-SP-USER' => "#{@oauth_key}|",
+        'X-SP-USER-IP' => ''
+      })
+      HTTP.headers(headers).timeout(write: 2, connect: 5, read: 10)
+    end
+
+    def symbolize_keys!(object)
+      if object.is_a?(Array)
+        object.each_with_index do |val, index|
+          object[index] = symbolize_keys!(val)
+        end
+      elsif object.is_a?(Hash)
+        object.keys.each do |key|
+          object[key.to_sym] = symbolize_keys!(object.delete(key))
+        end
+      end
+      object
+    end
+
+    def fail_or_return_response_body(code, body)
+      if code < 200 || code >= 206
+        error = SynapsePayments::Error.error_from_response(body, code)
+        fail(error)
+      end
+      body
+    end
+
+  end
+end

data/lib/synapse_payments/transactions.rb

@@ -0,0 +1,47 @@
+module SynapsePayments
+  class Transactions
+
+    def initialize(client, user_id, node_id, oauth_key)
+      @client = client
+      @user_id = user_id
+      @node_id = node_id
+      @oauth_key = oauth_key
+    end
+
+    def all
+      @client.get(path: "/users/#{@user_id}/nodes/#{@node_id}/trans", oauth_key: @oauth_key)
+    end
+
+    def create(node_id:, node_type:, amount:, currency:, ip_address:, **args)
+      data = {
+        to: {
+          type: node_type,
+          id: node_id
+        },
+        amount: {
+          amount: amount,
+          currency: currency
+        },
+        extra: {
+          ip: ip_address
+        }.merge(args)
+      }
+
+      @client.post(path: "/users/#{@user_id}/nodes/#{@node_id}/trans", oauth_key: @oauth_key, json: data)
+    end
+
+    def delete(id)
+      @client.delete(path: "/users/#{@user_id}/nodes/#{@node_id}/trans/#{id}", oauth_key: @oauth_key)
+    end
+
+    def find(id)
+      @client.get(path: "/users/#{@user_id}/nodes/#{@node_id}/trans/#{id}", oauth_key: @oauth_key)
+    end
+
+    def update(id, data)
+      @client.patch(path: "/users/#{@user_id}/nodes/#{@node_id}/trans/#{id}", oauth_key: @oauth_key, json: data)
+    end
+
+  end
+
+end

data/lib/synapse_payments/user_client.rb

@@ -0,0 +1,105 @@
+module SynapsePayments
+  class UserClient
+
+    def initialize(client, user_id, response)
+      @client = client
+      @user_id = user_id
+      @response = response
+      @oauth_key = response[:oauth_key]
+
+      response.each do |key, value|
+        (class << self; self; end).class_eval do
+          define_method key do |*args|
+            response[key]
+          end
+        end
+      end
+
+      @nodes = Nodes.new(@client, user_id, oauth_key)
+    end
+
+    def user
+      @client.get(path: "/users/#{@user_id}", oauth_key: @oauth_key)
+    end
+
+    # Adds a virtual document for KYC
+    #
+    # @param birthdate [Date]
+    # @param first_name [String]
+    # @param last_name [String]
+    # @param street [String]
+    # @param postal_code [String]
+    # @param country_code [String] The country code in ISO format e.g. US
+    # @param document_type [String] Acceptable document types: SSN, PASSPORT, DRIVERS_LICENSE, PERSONAL_IDENTIFICATION, NONE
+    # @param document_value [String]
+    # @return [Hash]
+    def add_document(birthdate:, first_name:, last_name:, street:, postal_code:, country_code:, document_type:, document_value:)
+      data = {
+        doc: {
+          birth_day: birthdate.day,
+          birth_month: birthdate.month,
+          birth_year: birthdate.year,
+          name_first: first_name,
+          name_last: last_name,
+          address_street1: street,
+          address_postal_code: postal_code,
+          address_country_code: country_code,
+          document_type: document_type,
+          document_value: document_value
+        }
+      }
+
+      @client.patch(path: "/users/#{@user_id}", oauth_key: @oauth_key, json: data)
+    end
+
+    def answer_kba(question_set_id:, answers:)
+      data = {
+        doc: {
+          question_set_id: question_set_id,
+          answers: answers
+        }
+      }
+
+      @client.patch(path: "/users/#{@user_id}", oauth_key: @oauth_key, json: data)
+    end
+
+    # Adds a bank account by creating a node of node type ACH-US.
+    #
+    # @param name [String] the name of the account holder
+    # @param account_number [String]
+    # @param routing_number [String]
+    # @param category [String] the account category, `personal` or `business`
+    # @param type [String] the account type, `checking` or `savings`
+    # @return [Hash]
+    def add_bank_account(name:, account_number:, routing_number:, category:, type:, **args)
+      data = {
+        type: 'ACH-US',
+        info: {
+          nickname: args[:nickname] || name,
+          name_on_account: name,
+          account_num: account_number,
+          routing_num: routing_number,
+          type: category,
+          class: type
+        },
+        extra: {
+          supp_id: args[:supp_id]
+        }
+      }
+      nodes.create(data)
+    end
+
+    def send_money(from:, to:, to_node_type:, amount:, currency:, ip_address:)
+      nodes(from).transactions.create(node_id: to, node_type: to_node_type, amount: amount, currency: currency, ip_address: ip_address)
+    end
+
+    def nodes(id=nil)
+      if id.nil?
+        @nodes
+      else
+        Node.new(@client, @user_id, id, @oauth_key)
+      end
+    end
+
+  end
+end

data/lib/synapse_payments/users.rb

@@ -0,0 +1,38 @@
+module SynapsePayments
+  class Users
+
+    def initialize(client)
+      @client = client
+    end
+
+    def all
+      @client.get(path: '/users')
+    end
+
+    def authenticate_as(id:, refresh_token:)
+      response = @client.post(path: "/oauth/#{id}", json: { refresh_token: refresh_token })
+      UserClient.new(@client, id, response)
+    end
+
+    def create(name:, email:, phone:, is_business: false, **args)
+      data = {
+        logins: email.is_a?(Array) ? email : [{ email: email }],
+        phone_numbers: phone.is_a?(Array) ? phone : [phone],
+        legal_names: name.is_a?(Array) ? name : [name],
+        extra: {
+          note: args[:note],
+          supp_id: args[:supp_id],
+          is_business: is_business
+        }
+      }
+
+      @client.post(path: '/users', json: data)
+    end
+
+    def find(id)
+      @client.get(path: "/users/#{id}")
+    end
+
+  end
+
+end

data/lib/synapse_payments/version.rb

@@ -0,0 +1,3 @@
+module SynapsePayments
+  VERSION = "0.1.0"
+end

data/samples.md

@@ -0,0 +1,150 @@
+## Initialization
+
+```ruby
+require 'synapse_payments'
+
+client = SynapsePayments::Client.new(client_id: 'client_id', client_secret: 'client_secret')
+
+# or configure with a block (note: sandbox_mode is true by default)
+
+client = SynapsePayments::Client.new do |config|
+  config.client_id = 'your_client_id'
+  config.client_secret = 'your_client_id'
+  config.sandbox_mode = false
+end
+```
+
+### Users
+
+#### Retrieve all users (paginated)
+
+```ruby
+response = client.users.all
+```
+
+#### Create a user
+
+```ruby
+response = client.users.create(
+  name: 'John Smith', 
+  email: 'johnsmith@example.com', 
+  phone: '123-456-7890'
+)
+
+# or specify multiple names, logins, phones...
+
+response = client.users.create(
+  name: ['John Smith', 'Bill Smith'], 
+  email: [
+    { email: 'johnsmith@example.com' },
+    { email: 'billsmith@example.com' }
+  ],
+  phone: ['123-456-7890','123-555-6677']
+)
+```
+
+#### Retrieve a user
+
+```ruby
+response = client.users.find(id)
+```
+
+#### Authenticate as a user
+
+```ruby
+response = client.users.find(id)
+
+user_client = client.users.authenticate_as(id: id, refresh_token: response[:refresh_token])
+
+user = user_client.user # returns user representation
+```
+
+#### Update a user
+
+NOTE: Action needs to be implemented.
+
+#### Add a document
+
+```ruby
+response = user_client.add_document(
+  birthdate: Date.parse('1970/3/14'),
+  first_name: 'John',
+  last_name: 'Doe',
+  street: '1 Infinite Loop',
+  postal_code: '95014',
+  country_code: 'US',
+  document_type: 'SSN',
+  document_value: '2222'
+)
+```
+
+#### Answer KBA questions
+
+```ruby
+response = user_client.answer_kba(
+  question_set_id: "557520ad343463000300005a", 
+  answers: [
+  	{ question_id: 1, answer_id: 1 },
+  	{ question_id: 2, answer_id: 1 },
+  	{ question_id: 3, answer_id: 1 },
+  	{ question_id: 4, answer_id: 1 },
+  	{ question_id: 5, answer_id: 1 }
+  ]
+)
+```
+
+#### Attach photo ID
+
+NOTE: Action needs to be implemented.
+
+#### Add a bank account
+
+```ruby
+response = user_client.add_bank_account(
+  name: 'John Doe',
+  account_number: '72347235423',
+  routing_number: '051000017',
+  category: 'PERSONAL',
+  type: 'CHECKING'
+)
+```
+
+#### Send money 💸
+
+```ruby
+response = user_client.send_money(
+  from: node_id, 
+  to: to_node_id, 
+  to_node_type: 'SYNAPSE-US', 
+  amount: 24.00, 
+  currency: 'USD', 
+  ip_address: '192.168.0.1'
+)
+```
+
+#### Nodes
+
+TODO: add more detail
+
+```ruby
+user_client.nodes.all
+user_client.nodes.create(data)
+user_client.nodes.delete(id)
+user_client.nodes.find(id)
+```
+
+#### Transactions
+
+TODO: add more detail
+
+```ruby
+user_client.nodes(node_id).transactions.all
+user_client.nodes(node_id).transactions.create(node_id:, node_type:, amount:, currency:, ip_address:)
+user_client.nodes(node_id).transactions.delete(id)
+user_client.nodes(node_id).transactions.find(id)
+user_client.nodes(node_id).transactions.update(id, data)
+```
+
+#### Error Handling
+
+TODO: add detail

data/synapse_payments.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'synapse_payments/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "synapse_payments"
+  spec.version       = SynapsePayments::VERSION
+  spec.authors       = ["Javier Julio"]
+  spec.email         = ["jjfutbol@gmail.com"]
+
+  spec.summary       = "A tested Ruby interface to the SynapsePay v3 API."
+  spec.description   = "Requires Ruby 2.1 and up. Not all API actions are supported. Find out more in the readme todo section."
+  spec.homepage      = "https://github.com/javierjulio/synapse_payments"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "http", '~> 0.9.8'
+
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: synapse_payments
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Javier Julio
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+description: Requires Ruby 2.1 and up. Not all API actions are supported. Find out
+  more in the readme todo section.
+email:
+- jjfutbol@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.sample"
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/synapse_payments.rb
+- lib/synapse_payments/client.rb
+- lib/synapse_payments/error.rb
+- lib/synapse_payments/node.rb
+- lib/synapse_payments/nodes.rb
+- lib/synapse_payments/request.rb
+- lib/synapse_payments/transactions.rb
+- lib/synapse_payments/user_client.rb
+- lib/synapse_payments/users.rb
+- lib/synapse_payments/version.rb
+- samples.md
+- synapse_payments.gemspec
+homepage: https://github.com/javierjulio/synapse_payments
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A tested Ruby interface to the SynapsePay v3 API.
+test_files: []