synapse_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c31d65fc404f16de0c7758b1006ad8eda2a3037
+  data.tar.gz: 025e61fa99b415922116894a44bb2b5a37c7defa
+SHA512:
+  metadata.gz: dd5ea5ccec30485c2db93c12f7a4bd4482cd45b344991d77c2e1e41f11cb75975f1199505102b355ddd16fdcb1a408d8b4806a9c6e4b649f9389e0c1d64d1708
+  data.tar.gz: f1820556c5b92b014be2152f6a29ebe719676be918ece522d0d4facdc2e2983133b12e6c56734420c45bf3650cfd2f987e2618168fa54ccf782a2a9fd641e643

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/notes/

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.1.4
+
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      - miles.matthias@gmail.com
+    on_failure: change
+    on_success: never
+

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec', cmd: 'bundle exec rspec' do
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Miles Matthias
+
+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,116 @@
+[![Build Status](https://travis-ci.org/milesmatthias/synapse_client.png?branch=master)](https://travis-ci.org/milesmatthias/synapse_client)  [![Gem Version](https://badge.fury.io/rb/synapse_client.png)](http://badge.fury.io/rb/synapse_client) [![Coverage Status](https://coveralls.io/repos/milesmatthias/synapse_client/badge.png)](https://coveralls.io/r/milesmatthias/synapse_client)
+
+# synapse_client
+
+A ruby client for the SynapsePay.com API.
+
+I ripped originally wrote this in a rails app of mine and stripped this out. There's some work left to do to really make it a true ruby gem. See that in the todo section.
+
+## Notes
+
+* This is written with the perspective of being the merchant. This gem doesn't support marketplace payments yet, although SynapsePay does support that.
+* This is also written with the assumption that a customer has no knowledge of their Synapse account. This means:
+  * that this gem says "Customers" when Synapse says "Users"
+  * all orders are bank pay orders
+  * customers do not have passwords
+
+## Usage
+
+_See the specs for the most up to date usage demo._
+
+#### configuration
+
+```ruby
+  SynapseClient.client_id           = "e06fa0f143a267c2ed8e"
+  SynapseClient.client_secret       = "f578105bf9ae03d9310e0af6f4637c1bf363998b"
+  SynapseClient.merchant_synapse_id = 1
+  SynapseClient.dev                 = true
+```
+
+#### create a customer
+
+```ruby
+  SynapseClient::Customer.create({
+    :email       => "foo@example.com",
+    :fullname    => "Foo Bar,
+    :phonenumber => "5555555555",
+    :ip_address  => "8.8.8.8"
+  })
+```
+
+#### retrieve a customer
+
+```ruby
+  SynapseClient::Customer.retrieve("_customer_access_token_")
+```
+
+#### list bank accounts for a customer
+
+```ruby
+  @customer.bank_accounts
+```
+
+#### add a bank account to a customer with just account & routing number
+
+```ruby
+  @customer.add_bank_account({
+    :account_num   => "1111111111",
+    :routing_num   => "084000026",
+    :nickname      => "Example bank account",
+    :account_type  => "1",
+    :account_class => "1"
+  })
+```
+
+#### link a bank account to a customer with bank username/password
+
+```ruby
+  @customer.link_bank_account({
+    :username => "synapse_good",
+    :password => "test1234",
+    :pin      => "1234",
+    :bank     => "Bank of America"
+  })
+```
+
+#### get recent orders for a customer
+
+```ruby
+  @customer.orders
+```
+
+#### add an order for a customer
+
+```ruby
+  @customer.add_order({
+    :amount  => 500,      # $500 USD
+    :bank_id => 1
+  })
+```
+
+#### retrieve an order
+
+```ruby
+  SynapseClient::Order.retrieve(4)
+```
+
+## TODO (in order of priority)
+
+* MFAs
+* MassPay
+* View bank account
+* Refresh access tokens
+* Security Questions
+* Deposits
+* Withdrawals
+* Better synapse error handling
+* HTTP Error handling
+* Logging
+* Callbacks?
+
+
+# Links
+
+* [dev.synapsepay.com](http://dev.synapsepay.com)
+* [rubygems.org/gems/synapse_client](https://rubygems.org/gems/synapse_client)
+

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation']
+end
+
+task :default => :spec
+

data/lib/synapse_client.rb

@@ -0,0 +1,137 @@
+# http://dev.synapsepay.com/
+
+require "map"
+require "restclient"
+require "synapse_client/api_resource"
+require "synapse_client/api_operations/response"
+require "synapse_client/api_operations/list"
+require "synapse_client/bank_account"
+require "synapse_client/error"
+require "synapse_client/merchant"
+require "synapse_client/mfa"
+require "synapse_client/order"
+require "synapse_client/refreshed_tokens"
+require "synapse_client/security_question"
+require "synapse_client/customer"
+require "synapse_client/util"
+require "synapse_client/version"
+
+module SynapseClient
+
+  class << self
+    attr_accessor :client_id, :client_secret
+    attr_accessor :merchant_oauth_key, :merchant_email, :merchant_synapse_id
+    attr_accessor :dev
+    alias_method :dev?, :dev
+  end
+
+  def self.ensure_trailing_slash(url='')
+    return url if url.empty?
+    return url if url[-1] == "/"
+    return url + "/"
+  end
+
+  def self.api_url(url='')
+    base_api_url = "https://synapsepay.com"
+    base_api_url = "https://sandbox.synapsepay.com" if dev?
+
+    ret = base_api_url + ensure_trailing_slash(url)
+
+    if dev?
+      ret + "?is_dev=true"
+    else
+      ret
+    end
+  end
+
+  def self.request(method, path, params={}, headers={}, client_id=nil, client_secret=nil, api_base_url=nil)
+
+    #
+      unless (client_id ||= @client_id) && (client_secret ||= @client_secret)
+        # TODO - use a custom Error class here
+        raise StandardError.new("You need to enter API credentials first.")
+      end
+
+      if client_id =~ /\s/ || client_secret =~ /\s/
+        # TODO - use a custom Error class here
+        raise StandardError.new("Your API credentials are invalid, as they contain whitespace.")
+      end
+
+    #
+      url     = api_url(path)
+      cookies = params.delete("cookies")
+
+      case method.to_s.downcase.to_sym
+      when :get, :head, :delete
+        # Make params into GET parameters
+        url += "#{URI.parse(url).query ? '&' : '?'}#{uri_encode(params)}" if params && params.any?
+        payload = nil
+      else
+        if path.include?("oauth2")
+          payload = params.to_query
+          headers[:content_type] = "application/x-www-form-urlencoded"
+        else
+          payload = creds(client_id, client_secret).update(params)
+
+          # dealing with some naming inconsistencies in the api
+          payload[:oauth_consumer_key] = payload.delete(:access_token) if payload[:access_token]
+          payload[:oauth_consumer_key] = payload.delete("access_token") if payload["access_token"]
+          payload[:access_token] = payload.delete("bank_account_token") if payload["bank_account_token"]
+          payload[:access_token] = payload.delete(:bank_account_token) if payload[:bank_account_token]
+
+          payload = payload.to_json
+          headers[:content_type] = :json
+        end
+      end
+
+    #
+      request_opts = {
+        :headers => headers,
+        :method => method, :open_timeout => 30,
+        :payload => payload,
+        :url => url, :timeout => 80, :cookies => cookies
+      }
+
+    #
+      #begin
+        response = execute_request(request_opts)
+      # TODO: https://github.com/stripe/stripe-ruby/blob/master/lib/stripe.rb#L127
+      #rescue 
+      #end
+
+      parse(response)
+  end
+
+  def self.creds(client_id, client_secret)
+    {
+      :client_id     => client_id,
+      :client_secret => client_secret
+    }
+  end
+
+  def self.execute_request(opts)
+puts "\n"
+puts "SynapseClient: About to send a request with the following opts:"
+puts opts
+puts "\n"
+    RestClient::Request.execute(opts)
+  end
+
+  def self.uri_encode(params)
+    Util.flatten_params(params).
+      map { |k,v| "#{k}=#{Util.url_encode(v)}" }.join('&')
+  end
+
+  def self.parse(response)
+    #begin
+      body = JSON.parse(response.body)
+    #rescue JSON::ParserError
+    #   TODO
+    #  raise general_api_error(response.code, response.body)
+    #end
+
+    APIOperations::Response.new(body, response.cookies)
+  end
+
+end
+

data/lib/synapse_client/api_operations/create.rb

@@ -0,0 +1,16 @@
+module Stripe
+  module APIOperations
+    module Create
+      module ClassMethods
+        def create(params={}, opts={})
+          response, opts = SynapseClient.request(:post, url, params, opts)
+          response
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/synapse_client/api_operations/list.rb

@@ -0,0 +1,17 @@
+module SynapseClient
+  module APIOperations
+    module List
+      module ClassMethods
+        def list(params={}, list_action="show")
+          response = SynapseClient.request(:post, url + list_action, params)
+          return response unless response.successful?
+          response.data
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/synapse_client/api_operations/response.rb

@@ -0,0 +1,20 @@
+module SynapseClient
+  module APIOperations
+    class Response
+      attr_reader :data
+      attr_reader :error_msg
+      attr_reader :success
+      attr_reader :cookies
+      alias_method :successful?, :success
+
+      def initialize(response, cookies=nil)
+        response = Map.new(response)
+
+        @success   = response.delete(:success)
+        @error_msg = response.delete(:reason)
+        @data      = response
+        @cookies   = cookies
+      end
+    end
+  end
+end

data/lib/synapse_client/api_resource.rb

@@ -0,0 +1,50 @@
+
+module SynapseClient
+  class APIResource
+
+    attr_accessor :id
+
+    def self.class_name
+      self.name.split('::')[-1]
+    end
+
+    def self.api_resource_name
+      class_name.downcase
+    end
+
+    def to_hash
+      hash = {}
+      instance_variables.each do |var|
+        value = instance_variable_get(var)
+        hash[var[1..-1].to_sym] = value if value
+      end
+      hash
+    end
+
+    def self.url
+      if self == APIResource
+        raise NotImplementedError.new('APIResource is an abstract class.  You should perform actions on its subclasses (Customer, Bank Account, Order, etc.)')
+      end
+      "/api/v2/#{CGI.escape( api_resource_name )}/"
+    end
+
+    def url
+      self.class.url
+    end
+
+    def refresh(endpoint="")
+      response = SynapseClient.request(:post, url + endpoint, retrieve_params)
+
+      return response unless response.successful?
+      update_attributes(response.data[self.class.class_name.downcase])
+    end
+
+    def self.retrieve(id, opts={})
+      opts.merge!(:id => id)
+      instance = self.new(opts)
+      instance.refresh(retrieve_endpoint)
+      instance
+    end
+
+  end
+end