synapse_client 0.0.1

data/lib/synapse_client/util.rb

@@ -0,0 +1,55 @@
+
+module SynapseClient
+  module Util
+
+    def self.url_encode(key)
+      URI.escape(key.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+    end
+
+    def self.flatten_params(params, parent_key=nil)
+      result = []
+      params.each do |key, value|
+        calculated_key = parent_key ? "#{parent_key}[#{url_encode(key)}]" : url_encode(key)
+        if value.is_a?(Hash)
+          result += flatten_params(value, calculated_key)
+        elsif value.is_a?(Array)
+          result += flatten_params_array(value, calculated_key)
+        else
+          result << [calculated_key, value]
+        end
+      end
+      result
+    end
+
+    def self.flatten_params_array(value, calculated_key)
+      result = []
+      value.each do |elem|
+        if elem.is_a?(Hash)
+          result += flatten_params(elem, calculated_key)
+        elsif elem.is_a?(Array)
+          result += flatten_params_array(elem, calculated_key)
+        else
+          result << ["#{calculated_key}[]", elem]
+        end
+      end
+      result
+    end
+
+    def self.symbolize_names(object)
+      case object
+      when Hash
+        new_hash = Map.new
+        object.each do |key, value|
+          key = (key.to_sym rescue key) || key
+          new_hash[key] = symbolize_names(value)
+        end
+        new_hash
+      when Array
+        object.map { |value| symbolize_names(value) }
+      else
+        object
+      end
+    end
+
+  end
+end

data/lib/synapse_client/version.rb

@@ -0,0 +1,3 @@
+module SynapseClient
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,78 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'pry'
+require 'synapse_client'
+
+
+#
+  def test_credentials
+    Map.new({
+      :client_id              => "e06fa0f143a267c2ed8e",
+      :client_secret          => "f578105bf9ae03d9310e0af6f4637c1bf363998b",
+      :merchant_synapse_id    => 536,
+      :merchant_oauth_token   => "16688788f22d8b46a83711b42ad9b0dec39b09ce",
+      :merchant_refresh_token => "37e6f092e3c9a5ad0c1a2f2c62fec6ab8cb44808",
+      :merchant_username      => "0537fa5d0cb94aaea9e79900bc0cab",
+      :dev                    => true
+    })
+  end
+  SynapseClient.client_id           = test_credentials.client_id
+  SynapseClient.client_secret       = test_credentials.client_secret
+  SynapseClient.merchant_synapse_id = test_credentials.merchant_synapse_id
+  SynapseClient.dev                 = test_credentials.dev
+
+
+#
+# Most of this dummy data is taken from the examples at dev.synapsepay.com.
+
+#
+  def dummy_customer_data
+    hex = SecureRandom.hex(4)
+    hex[0] = hex[0].upcase
+
+    Map.new({
+      :email       => "foo+" + hex.downcase + "@example.com",
+      :fullname    => "Foo Bar " + hex,
+      :phonenumber => sprintf('%010d', rand(10**10)),
+      :ip_address  => Array.new(4){rand(256)}.join('.')
+    })
+  end
+
+  def get_dummy_customer
+    SynapseClient::Customer.create(dummy_customer_data)
+  end
+
+#
+  def dummy_add_bank_account_info
+    Map.new({
+      :account_num   => "1111111111",
+      :routing_num   => "084000026",
+      :nickname      => "Example bank account",
+      :account_type  => "1",
+      :account_class => "1"
+    })
+  end
+
+  def dummy_link_bank_account_info
+    Map.new({
+      :username => "synapse_good",
+      :password => "test1234",
+      :pin      => "1234",
+      :bank     => "Bank of America"
+    })
+  end
+
+  def dummy_finish_linking_bank_account_info
+    Map.new({
+      :mfa  => "test_answer",
+      :bank => "Bank of America"
+    })
+  end
+
+  def get_dummy_bank
+    
+    SynapseClient::Customer.create(dummy_customer_data)
+  end
+
+

data/spec/synapse_client_bank_account_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe SynapseClient::BankAccount do
+
+  before(:each) do
+    @customer = get_dummy_customer
+  end
+
+  describe "listing bank accounts" do
+    it "should return an empty array when a customer has 0 bank accounts" do
+      bank_accounts = @customer.bank_accounts
+
+      expect(bank_accounts).to be_an(Array)
+      expect(bank_accounts.count).to eq(0)
+    end
+  end
+
+  describe "adding a bank account" do
+    it "should successfully return the bank account." do
+      bank_account = @customer.add_bank_account(dummy_add_bank_account_info)
+
+      expect(bank_account).to be_a SynapseClient::BankAccount
+
+      expect(bank_account.id).to be_a Fixnum
+      expect(bank_account.account_number_string).to be_a String
+      expect(bank_account.routing_number_string).to be_a String
+      expect(bank_account.nickname).to be_a String
+      expect(bank_account.account_type).to be_a Fixnum
+      expect(bank_account.account_class).to be_a Fixnum
+    end
+  end
+
+  describe "linking a bank account" do
+    it "should successfully return an mfa." do
+      mfa = @customer.link_bank_account(dummy_link_bank_account_info)
+
+      expect(mfa).to be_a SynapseClient::MFA
+
+      expect(mfa.type).to be_a String
+      expect(mfa.bank_access_token).to be_a String
+      expect(mfa.questions).to be_an Array
+    end
+
+    it "should successfully finish linking with an mfa." do
+      mfa           = @customer.link_bank_account(dummy_link_bank_account_info)
+      bank_accounts = @customer.finish_linking_bank_account(dummy_finish_linking_bank_account_info.merge({
+        :bank_account_token => mfa.bank_access_token
+      }))
+
+      expect(bank_accounts).to be_a Array
+      expect(bank_accounts.count).to be > 0
+
+      bank_accounts.each do |ba|
+        expect(ba.account_number_string).to be_a String
+        expect(ba.routing_number_string).to be_a String
+        expect(ba.bank_name).to be_a String
+        expect(ba.nickname).to be_a String
+        expect(ba.name_on_account).to be_a String
+        expect(ba.account_type).to be_a Fixnum
+        expect(ba.account_class).to be_a Fixnum
+      end
+    end
+  end
+
+end
+
+

data/spec/synapse_client_customer_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe SynapseClient::Customer do
+
+  before(:each) do
+    @dummy_customer_data = dummy_customer_data
+    @customer = SynapseClient::Customer.create(@dummy_customer_data)
+  end
+
+
+  describe "creating a customer" do
+    it "should successfully return a customer object with tokens and other info." do
+      expect(@customer).to be_a SynapseClient::Customer
+
+      expect(@customer.email).to be @dummy_customer_data.email
+      expect(@customer.fullname).to be @dummy_customer_data.fullname
+      expect(@customer.phonenumber).to be @dummy_customer_data.phonenumber
+      expect(@customer.ip_address).to be @dummy_customer_data.ip_address
+
+      expect(@customer.access_token).to be_a String
+      expect(@customer.refresh_token).to be_a String
+      expect(@customer.expires_in).to be_a Fixnum
+      expect(@customer.username).to be_a String
+    end
+  end
+
+  describe "retrieving a customer" do
+    it "should successfully return a customer object with tokens and other info." do
+      customer = SynapseClient::Customer.retrieve(@customer.access_token)
+
+      expect(customer).to be_a SynapseClient::Customer
+
+      expect(customer.id).to be_a Fixnum
+      expect(customer.email).to eq @dummy_customer_data.email
+      expect(customer.fullname).to eq @dummy_customer_data.fullname
+      expect(customer.phonenumber).to eq @dummy_customer_data.phonenumber
+      expect(customer.username).to be_a String
+    end
+  end
+
+end
+

data/spec/synapse_client_order_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe SynapseClient::Order do
+
+  before(:each) do
+    @customer         = get_dummy_customer
+    @bank             = @customer.add_bank_account(dummy_add_bank_account_info)
+    @amount_to_charge = rand(1..1000)
+  end
+
+  describe "getting orders for a customer" do
+    it "should return an empty array" do
+      orders = @customer.orders
+
+      expect(orders).to be_an(Array)
+      expect(orders.count).to eq(0)
+    end
+  end
+
+  describe "adding an order" do
+    it "should successfully return an order." do
+      order = @customer.add_order({
+        :amount  => @amount_to_charge,
+        :bank_id => @bank.id
+      })
+      expect(order).to be_a SynapseClient::Order
+
+      expect(order.amount).to eq(@amount_to_charge)
+      expect(order.id).to be_a Fixnum
+      expect(order.status).to be_a Fixnum
+    end
+  end
+
+  describe "retrieving an order" do
+    it "should successfully return an order." do
+      new_order = @customer.add_order({
+        :amount  => @amount_to_charge,
+        :bank_id => @bank.id
+      })
+      order     = SynapseClient::Order.retrieve(new_order.id)
+
+      expect(order).to be_a SynapseClient::Order
+
+      #expect(order.amount).to eq(@amount_to_charge)
+      #expect(order.id).to be_a Fixnum
+      expect(order.status).to be_a Fixnum
+    end
+  end
+
+end
+
+
+

data/spec/synapse_client_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe SynapseClient do
+
+  before(:each) do
+    SynapseClient.client_id           = test_credentials.client_id
+    SynapseClient.client_secret       = test_credentials.client_secret
+    SynapseClient.merchant_synapse_id = test_credentials.merchant_synapse_id
+    SynapseClient.dev                 = test_credentials.dev
+  end
+
+  describe "api keys should be stored" do
+    it 'stores the client_id on the top level module' do
+      expect(SynapseClient.client_id).to eq(test_credentials.client_id)
+    end
+
+    it 'stores the client_secret on the top level module' do
+      expect(SynapseClient.client_secret).to eq(test_credentials.client_secret)
+    end
+
+    it 'stores the merchant_synapse_id on the top level module' do
+      expect(SynapseClient.merchant_synapse_id).to eq(test_credentials.merchant_synapse_id)
+    end
+
+    it 'stores that dev is true' do
+      expect(SynapseClient.dev).to eq(test_credentials.dev)
+      expect(SynapseClient.dev?).to eq(test_credentials.dev)
+    end
+  end
+
+
+  describe "url generation is correct" do
+    it "should have the is_dev query param" do
+      expect(SynapseClient.api_url).to eq("https://sandbox.synapsepay.com?is_dev=true")
+    end
+
+    it "should have the sandbox domain" do
+      expect(SynapseClient.api_url).to match("https://sandbox.synapsepay.com")
+    end
+
+    it "should append a path to the url with a trailing slash" do
+      expect(SynapseClient.api_url("/foo")).to match("https://sandbox.synapsepay.com/foo/")
+    end
+  end
+
+
+  describe "base request method" do
+    it "should raise an error when api keys are absent" do
+      SynapseClient.client_id = nil
+      expect { SynapseClient.request("get", "users") }.to raise_error
+    end
+
+    it "should raise an error when api keys contain whitespace" do
+      SynapseClient.client_id = " foo bar "
+      expect { SynapseClient.request("get", "users") }.to raise_error
+    end
+
+    it "should be able to do a basic get of bank statuses" do
+      response = SynapseClient.request("get", "/api/v2/bankstatus/show/")
+
+      expect(response).to be_an(SynapseClient::APIOperations::Response)
+      expect(response.successful?).to be true
+
+      expect(response.data.banks).to be_an(Array)
+      expect(response.data.banks.count).to be > 0
+    end
+  end
+
+end
+

data/synapse_client.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'synapse_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "synapse_client"
+  spec.version       = SynapseClient::VERSION
+  spec.authors       = ["Miles Matthias"]
+  spec.email         = ["miles.matthias@gmail.com"]
+  spec.summary       = %q{A ruby client for the SynapsePay.com API.}
+  spec.description   = %q{A ruby client for the SynapsePay.com API. Read SynapsePay API documentation at dev.synapsepay.com.}
+  spec.homepage      = "https://github.com/milesmatthias/synapse_client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'rest-client', '~> 1.7', '>= 1.7.2'
+  spec.add_runtime_dependency 'map'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-nc"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry", "~> 0.9.0"
+  spec.add_development_dependency "pry-remote"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "coveralls"
+end

metadata

@@ -0,0 +1,253 @@
+--- !ruby/object:Gem::Specification
+name: synapse_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Miles Matthias
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+- !ruby/object:Gem::Dependency
+  name: map
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rspec
+  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: rspec-nc
+  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: guard
+  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: guard-rspec
+  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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  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: pry-nav
+  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: coveralls
+  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'
+description: A ruby client for the SynapsePay.com API. Read SynapsePay API documentation
+  at dev.synapsepay.com.
+email:
+- miles.matthias@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/synapse_client.rb
+- lib/synapse_client/api_operations/create.rb
+- lib/synapse_client/api_operations/list.rb
+- lib/synapse_client/api_operations/response.rb
+- lib/synapse_client/api_resource.rb
+- lib/synapse_client/bank_account.rb
+- lib/synapse_client/customer.rb
+- lib/synapse_client/error.rb
+- lib/synapse_client/merchant.rb
+- lib/synapse_client/mfa.rb
+- lib/synapse_client/order.rb
+- lib/synapse_client/refreshed_tokens.rb
+- lib/synapse_client/security_question.rb
+- lib/synapse_client/util.rb
+- lib/synapse_client/version.rb
+- spec/spec_helper.rb
+- spec/synapse_client_bank_account_spec.rb
+- spec/synapse_client_customer_spec.rb
+- spec/synapse_client_order_spec.rb
+- spec/synapse_client_spec.rb
+- synapse_client.gemspec
+homepage: https://github.com/milesmatthias/synapse_client
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A ruby client for the SynapsePay.com API.
+test_files:
+- spec/spec_helper.rb
+- spec/synapse_client_bank_account_spec.rb
+- spec/synapse_client_customer_spec.rb
+- spec/synapse_client_order_spec.rb
+- spec/synapse_client_spec.rb