synapse_pay_rest 0.0.11 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef0de243116afb622eb99e91833b0bfc2084101f
-  data.tar.gz: 3467d9cf79f9f7bf9b0d235539d4b2450b3d1a55
+  metadata.gz: 4dbdc072bf2803c60e736b7dd86c3ee77a116051
+  data.tar.gz: 54a9502bfcabffb266b2cb9b7a0b98f95ecd3fbe
 SHA512:
-  metadata.gz: 53779eec31d4480ac9e2c1c4afe0ee66851f717e80a1f2849c8a20719b87f113b76f09863657d5a4d5fc53bec4aa4fc5b190729d41c462ff0c2dd0261d912d9c
-  data.tar.gz: 16cfa1aaae00c28147f1034b7205422ee5bb1b08f28e222c5fb418c127f0397da8cfb41768b3c1051d5996e3e85bcc616a31cc0701459de0e5a950ad7b50ec2b
+  metadata.gz: 4fd8d2bf9dadecaed2e2e54e97cffb8bc0a5f318638916b270987bc5ca752133a837de4d9f9c68e02bc182411973f4b6bd1f83dc0c5e23dbbea127010a0c8231
+  data.tar.gz: 57b16b876a60d60109a812c487609fefdd0c91ece4d86c456049f7762ad8ae9b400bc0ee43f6973b6f795f7930a652ca03f3c2fbfc144dba6721acf0e07423f8

data/.gitignore

@@ -0,0 +1,39 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+
+.DS_Store

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    synapse_pay_rest (0.0.10)
+      rest-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.2)
+    domain_name (0.5.25)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    mime-types (2.6.2)
+    minitest (5.8.2)
+    minitest-reporters (1.1.5)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    netrc (0.11.0)
+    rake (10.4.2)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    ruby-progressbar (1.7.5)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  minitest
+  minitest-reporters
+  rake (~> 10.0)
+  synapse_pay_rest!
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -0,0 +1,35 @@
+## SynapsePayRest-Ruby
+
+Simple API wrapper for SynapsePay REST V3 API.  This wrapper aims to handle the headers for each API request and appropriate error handling.
+
+
+## Code Example
+
+Check out the samples.md and our API documentation(http://docs.synapsepay.com/v3.1) for examples.
+
+## Installation
+
+gem install synapse_pay_rest
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2014 SynapsePay LLC
+
+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/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/lib/synapse_pay_rest.rb

@@ -1,30 +1,25 @@
-# Basic wrapper around the the requests library.
-require_relative "synapse_pay_rest/http_client"
-# Assign all the api classes
-require_relative "synapse_pay_rest/api/Users"
-require_relative "synapse_pay_rest/api/Nodes"
-require_relative "synapse_pay_rest/api/Trans"
+require "synapse_pay_rest/http_client"
+require "synapse_pay_rest/error"
+require "synapse_pay_rest/version"
+require "synapse_pay_rest/api/users"
+require "synapse_pay_rest/api/nodes"
+require "synapse_pay_rest/api/trans"
 
 module SynapsePayRest
-	class Client
+  class Client
+    attr_accessor :client, :users, :nodes, :trans
 
-		attr_accessor :client
-		attr_accessor :users
-		attr_accessor :nodes
-		attr_accessor :trans
+    def initialize(options: raise("options is required"), user_id: nil)
+      base_url = if options['development_mode']
+                   'https://sandbox.synapsepay.com/api/3'
+                 else
+                   'https://synapsepay.com/api/3'
+                 end
 
-		def initialize(options: raise("options is required"), user_id: nil)
-			base_url = 'https://synapsepay.com/api/3'
-			if options.has_key?('development_mode')
-				if options['development_mode']
-					base_url = 'https://sandbox.synapsepay.com/api/3'
-				end
-			end
-
-			@client = HTTPClient.new options, base_url, user_id: user_id
-			@users = Users.new @client
-			@nodes = Nodes.new @client
-			@trans = Trans.new @client
-		end
-	end
+      @client = HTTPClient.new options, base_url, user_id: user_id
+      @users = Users.new @client
+      @nodes = Nodes.new @client
+      @trans = Trans.new @client
+    end
+  end
 end

data/lib/synapse_pay_rest/api/nodes.rb

@@ -0,0 +1,46 @@
+module SynapsePayRest
+  class Nodes
+
+    attr_accessor :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def create_node_path(node_id: nil)
+      path = ['/users', client.user_id, 'nodes' ]
+      path << node_id if node_id
+      return path.join('/')
+    end
+
+    def add(payload: raise("payload is required"))
+      path = create_node_path
+      client.post(path, payload)
+    end
+
+    def get(node_id: nil, page: nil)
+      # If node_id is nil then create_node_path will handle it just fine
+      path = create_node_path(node_id: node_id)
+      path += "?page=#{page}" if page
+      client.get(path)
+    end
+
+    def verify(node_id: nil, payload: raise("payload is required"))
+      if node_id
+        # verify microdeposits
+        path = create_node_path(node_id: node_id)
+        response = @client.patch(path, payload)
+      else
+        # verify MFA question(s)
+        path = create_node_path
+        response = @client.post(path, payload)
+      end
+      response
+    end
+
+    def delete(node_id: raise("node_id is required"))
+      path = create_node_path(node_id: node_id)
+      client.delete(path)
+    end
+  end
+end

data/lib/synapse_pay_rest/api/trans.rb

@@ -0,0 +1,38 @@
+module SynapsePayRest
+  class Trans
+
+    attr_accessor :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def create_transaction_path(node_id: raise("node_id is required"), trans_id: nil)
+      path = ['/users', client.user_id, 'nodes', node_id, 'trans' ]
+      path << trans_id if trans_id
+      return path.join('/')
+    end
+
+    def create(node_id: raise("node_id is required"), payload: raise("payload is required"))
+      path = create_transaction_path(node_id: node_id)
+      client.post(path, payload)
+    end
+
+    def update(node_id: raise("node_id is required"), trans_id: raise("trans_id is required"), payload: raise("payload is required"))
+      path = create_transaction_path(node_id: node_id, trans_id: trans_id)
+      client.patch(path, payload)
+    end
+
+    def get(node_id: raise("node_id is required"), trans_id: nil, page: nil)
+      path = create_transaction_path(node_id: node_id, trans_id: trans_id)
+      # This part really should just be a generic params generator
+      path += "?page=#{page}" if page
+      client.get(path)
+    end
+
+    def delete(node_id: raise("node_id is required"), trans_id: raise("trans_id is required"))
+      path = create_transaction_path(node_id: node_id, trans_id: trans_id)
+      client.delete(path)
+    end
+  end
+end

data/lib/synapse_pay_rest/api/users.rb

@@ -0,0 +1,97 @@
+require 'mime-types'
+require 'base64'
+require 'open-uri'
+
+module SynapsePayRest
+  class Users
+    # Should refactor this to HTTPClient
+    VALID_QUERY_PARAMS = [:query, :page, :per_page].freeze
+
+    attr_accessor :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def create_user_path(user_id: nil)
+      path = ['/users']
+      path << user_id if user_id
+      return path.join('/')
+    end
+
+    def refresh(payload: raise("payload is required"))
+      path = "/oauth/#{@client.user_id}"
+      response = @client.post(path, payload)
+      client.update_headers(oauth_key: response['oauth_key']) if response['oauth_key']
+      return response
+    end
+
+    def get(user_id: nil, options: {})
+      path = create_user_path(user_id: user_id)
+
+      if options[:user_id]
+        response = client.get(path)
+        client.update_headers(user_id: response['_id']) if response['_id']
+        return response
+      end
+
+      # Should factor this out into HTTPClient
+      params = VALID_QUERY_PARAMS.map do |p|
+        options[p] ? "#{p}=#{options[p]}" : nil
+      end.compact
+
+      # Probably should use CGI or RestClient's param builder instead of
+      # rolling our own, probably error-prone and untested version
+      # https://github.com/rest-client/rest-client#usage-raw-url
+      path += '?' + params.join('&') if params.any?
+      client.get(path)
+    end
+
+    def update(payload: raise("payload is required"))
+      path = create_user_path(user_id: client.user_id)
+      client.patch(path, payload)
+    end
+
+    def create(payload: raise("payload is required"))
+      path = create_user_path
+      response = client.post(path, payload)
+      client.update_headers(user_id: response['_id']) if response['_id']
+      return response
+    end
+
+    def add_doc(payload: raise("payload is required"))
+      path = create_user_path(user_id: client.user_id)
+      client.patch(path, payload)
+    end
+
+    def answer_kba(payload: raise("payload is required"))
+      path = create_user_path(user_id: client.user_id)
+      client.patch(path, payload)
+    end
+
+    def attach_file(file_path: raise("file_path is required"))
+      file_contents = open(file_path) { |f| f.read }
+      file_type = MIME::Types.type_for(file_path).first.try(:content_type)
+      if file_type.nil?
+        raise("File type not found. Use attach_file_with_file_type(file_path: <file_path>, file_type: <file_type>)")
+      else
+        attach_file_with_file_type(file_path: file_path, file_type: file_type)
+      end
+    end
+
+    def attach_file_with_file_type(file_path: raise("file_path is required"), file_type: raise("file_type is required"))
+      path = create_user_path(user_id: @client.user_id)
+      file_contents = open(file_path) { |f| f.read }
+      encoded = Base64.encode64(file_contents)
+      mime_padding = "data:#{file_type};base64,"
+      base64_attachment = mime_padding + encoded
+
+      payload = {
+        'doc' => {
+          'attachment' => base64_attachment
+        }
+      }
+      client.patch(path, payload)
+    end
+  end
+end

data/lib/synapse_pay_rest/error.rb

@@ -0,0 +1,114 @@
+module SynapsePayRest
+  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 => SynapsePayRest::Error::BadRequest,
+      401 => SynapsePayRest::Error::Unauthorized,
+      402 => SynapsePayRest::Error::RequestDeclined,
+      403 => SynapsePayRest::Error::Forbidden,
+      404 => SynapsePayRest::Error::NotFound,
+      406 => SynapsePayRest::Error::NotAcceptable,
+      409 => SynapsePayRest::Error::Conflict,
+      415 => SynapsePayRest::Error::UnsupportedMediaType,
+      422 => SynapsePayRest::Error::UnprocessableEntity,
+      429 => SynapsePayRest::Error::TooManyRequests,
+      500 => SynapsePayRest::Error::InternalServerError,
+      502 => SynapsePayRest::Error::BadGateway,
+      503 => SynapsePayRest::Error::ServiceUnavailable,
+      504 => SynapsePayRest::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 [SynapsePayRest::Error]
+      def error_from_response(body, code)
+        klass = ERRORS[code] || SynapsePayRest::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 [SynapsePayRest::Error]
+    def initialize(message: '', code: nil, response: {})
+      super(message)
+      @code = code
+      @response = response
+    end
+  end
+end