paysimple-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a26074b9683b716e2a6db729e0859d11d32179f8
+  data.tar.gz: e94335c05375789b558572bbeba8570fccc2effc
+SHA512:
+  metadata.gz: 0ce84fc7b7c3124b35b2d83f7608f6ebec246cf54401b9cf4878f3f46b1f21ea4d1a7a3ef955471e07715e6bbd1777c16f3687c09ca5e09c4b3533bb6f1e0256
+  data.tar.gz: 6495fbca110a86add9be0c8bfcd0294391459afd15d966d80c6b55169f6609524c72633e963c47718b3c7ed4816aae96f53b540d3993706f8f87815a4e4883f8

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Konstantin Lebedev
+
+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,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "paysimple"
+
+# 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 "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/paysimple.rb

@@ -0,0 +1,152 @@
+require 'time'
+require 'digest'
+require 'base64'
+
+require 'rest-client'
+require 'json'
+
+# Common
+require 'paysimple/version'
+require 'paysimple/endpoint'
+require 'paysimple/util'
+
+# Resources
+require 'paysimple/resources/customer'
+require 'paysimple/resources/credit_card'
+require 'paysimple/resources/ach'
+require 'paysimple/resources/payment'
+
+# Errors
+require 'paysimple/errors/paysimple_error'
+require 'paysimple/errors/api_connection_error'
+require 'paysimple/errors/api_error'
+require 'paysimple/errors/invalid_request_error'
+require 'paysimple/errors/authentication_error'
+
+module Paysimple
+
+  @api_endpoint = Endpoint::PRODUCTION
+
+  class << self
+    attr_accessor :api_key, :api_user, :api_endpoint
+  end
+
+  def self.request(method, url, params={})
+
+    raise AuthenticationError.new('API key is not provided.') unless @api_key
+    raise AuthenticationError.new('API user is not provided.') unless @api_user
+
+    url = api_url(url)
+    case method
+      when :get, :head
+        url += "#{URI.parse(url).query ? '&' : '?'}#{uri_encode(params)}" if params && params.any?
+        payload = nil
+      when :delete
+        payload = nil
+      else
+        payload = Util.camelize_and_symbolize_keys(params).to_json
+    end
+
+    request_opts = { headers: request_headers, method: method, open_timeout: 30,
+                     payload: payload, url: url, timeout: 80 }
+
+    begin
+      response = execute_request(request_opts)
+    rescue SocketError => e
+      handle_restclient_error(e)
+    rescue RestClient::ExceptionWithResponse => e
+      if rcode = e.http_code and rbody = e.http_body
+        handle_api_error(rcode, rbody)
+      else
+        handle_restclient_error(e)
+      end
+    rescue RestClient::Exception, Errno::ECONNREFUSED => e
+      handle_restclient_error(e)
+    end
+
+    parse(response)
+  end
+
+  def self.api_url(url='')
+    @api_endpoint + '/v4' + url
+  end
+
+  def self.execute_request(opts)
+    RestClient::Request.execute(opts)
+  end
+
+  def self.request_headers
+    {
+        authorization: authorization_header,
+        content_type: :json,
+        accept: :json
+    }
+  end
+
+  def self.uri_encode(params)
+    Util.flatten_params(params).map { |k,v| "#{k}=#{Util.url_encode(v)}" }.join('&')
+  end
+
+  def self.parse(response)
+    if response.body.empty?
+      {}
+    else
+      response = JSON.parse(response.body)
+      Util.underscore_and_symbolize_names(response)[:response]
+    end
+  rescue JSON::ParserError
+    raise general_api_error(response.code, response.body)
+  end
+
+  def self.general_api_error(rcode, rbody)
+    APIError.new("Invalid response object from API: #{rbody.inspect} " +
+                     "(HTTP response code was #{rcode})", rcode, rbody)
+  end
+
+  def self.authorization_header
+    utc_timestamp = Time.now.getutc.iso8601.encode(Encoding::UTF_8)
+    secret_key = @api_key.encode(Encoding::UTF_8)
+    hash = OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new('sha256'), secret_key, utc_timestamp)
+    signature = Base64.encode64(hash)
+
+    "PSSERVER accessid=#{@api_user}; timestamp=#{utc_timestamp}; signature=#{signature}"
+  end
+
+  def self.handle_api_error(rcode, rbody)
+    begin
+      error_obj = rbody.empty? ? {} : Util.underscore_and_symbolize_names(JSON.parse(rbody))
+    rescue JSON::ParserError
+      raise general_api_error(rcode, rbody)
+    end
+
+    case rcode
+      when 400, 404
+        error = error_obj[:meta][:errors][:error_messages].collect { |e| e[:message]}
+        raise InvalidRequestError.new(error, nil, rcode, rbody, error_obj)
+      when 401
+        raise  AuthenticationError.new(error, rcode, rbody, error_obj)
+      else
+        raise APIError.new(error, rcode, rbody, error_obj)
+    end
+  end
+
+  def self.handle_restclient_error(e, api_base_url=nil)
+    connection_message = 'Please check your internet connection and try again.'
+
+    case e
+      when RestClient::RequestTimeout
+        message = "Could not connect to Paysimple (#{@api_endpoint}). #{connection_message}"
+      when RestClient::ServerBrokeConnection
+        message = "The connection to the server (#{@api_endpoint}) broke before the " \
+        "request completed. #{connection_message}"
+      when SocketError
+        message = 'Unexpected error communicating when trying to connect to Paysimple. ' \
+        'You may be seeing this message because your DNS is not working. '
+      else
+        message = 'Unexpected error communicating with Paysimple. '
+    end
+
+    raise APIConnectionError.new(message + "\n\n(Network error: #{e.message})")
+  end
+
+end

data/lib/paysimple/endpoint.rb

@@ -0,0 +1,8 @@
+module Paysimple
+
+  class Endpoint
+    PRODUCTION = 'https://api.paysimple.com'
+    SANDBOX = 'https://sandbox-api.paysimple.com'
+  end
+
+end

data/lib/paysimple/errors/api_connection_error.rb

@@ -0,0 +1,6 @@
+module Paysimple
+
+  class APIConnectionError < PaysimpleError
+  end
+
+end

data/lib/paysimple/errors/api_error.rb

@@ -0,0 +1,5 @@
+module Paysimple
+  class APIError < PaysimpleError
+
+  end
+end

data/lib/paysimple/errors/authentication_error.rb

@@ -0,0 +1,6 @@
+module Paysimple
+
+  class AuthenticationError  < PaysimpleError
+  end
+
+end

data/lib/paysimple/errors/invalid_request_error.rb

@@ -0,0 +1,12 @@
+module Paysimple
+
+  class InvalidRequestError < PaysimpleError
+    attr_accessor :param
+
+    def initialize(message, param, http_status=nil, http_body=nil, json_body=nil)
+      super(message, http_status, http_body, json_body)
+      @param = param
+    end
+  end
+
+end

data/lib/paysimple/errors/paysimple_error.rb

@@ -0,0 +1,22 @@
+module Paysimple
+
+  class PaysimpleError < StandardError
+    attr_reader :message
+    attr_reader :http_status
+    attr_reader :http_body
+    attr_reader :json_body
+
+    def initialize(message=nil, http_status=nil, http_body=nil, json_body=nil)
+      @message = message
+      @http_status = http_status
+      @http_body = http_body
+      @json_body = json_body
+    end
+
+    def to_s
+      status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+      "#{status_string}#{@message}"
+    end
+  end
+
+end

data/lib/paysimple/resources/ach.rb

@@ -0,0 +1,23 @@
+module Paysimple
+  class ACH
+
+    def self.create(opts)
+      Paysimple.request(:post, url, opts)
+    end
+
+    def self.update(opts)
+      Paysimple.request(:put, url, opts)
+    end
+
+    def self.delete(id)
+      Paysimple.request(:delete, "#{url}/#{id}")
+    end
+
+  protected
+
+    def self.url
+      '/account/ach'
+    end
+
+  end
+end

data/lib/paysimple/resources/credit_card.rb

@@ -0,0 +1,23 @@
+module Paysimple
+  class CreditCard
+
+    def self.create(opts)
+      Paysimple.request(:post, url, opts)
+    end
+
+    def self.update(opts)
+      Paysimple.request(:put, url, opts)
+    end
+
+    def self.delete(id)
+      Paysimple.request(:delete, "#{url}/#{id}")
+    end
+
+  protected
+
+    def self.url
+      '/account/creditcard'
+    end
+
+  end
+end

data/lib/paysimple/resources/customer.rb

@@ -0,0 +1,23 @@
+module Paysimple
+  class Customer
+
+    def self.create(opts)
+      Paysimple.request(:post, url, opts)
+    end
+
+    def self.update(opts)
+      Paysimple.request(:put, url, opts)
+    end
+
+    def self.delete(id)
+      Paysimple.request(:delete, "#{url}/#{id}")
+    end
+
+  protected
+
+    def self.url
+      '/customer'
+    end
+
+  end
+end

data/lib/paysimple/resources/payment.rb

@@ -0,0 +1,23 @@
+module Paysimple
+  class Payment
+
+    def self.create(opts)
+      Paysimple.request(:post, url, opts)
+    end
+
+    def self.void(id)
+      Paysimple.request(:put, "#{url}/#{id}/void")
+    end
+
+    def self.get(id)
+      Paysimple.request(:get, "#{url}/#{id}")
+    end
+
+  protected
+
+    def self.url
+      '/payment'
+    end
+
+  end
+end

data/lib/paysimple/util.rb

@@ -0,0 +1,85 @@
+module Paysimple
+  module Util
+
+    # class ::Hash
+    #   def method_missing(name)
+    #     return self[name] if key? name
+    #     self.each { |k,v| return v if k.to_s.to_sym == name }
+    #     super.method_missing name
+    #   end
+    # end
+
+    def self.underscore(str)
+      str.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+          tr('-', '_').
+          downcase
+    end
+
+    def self.camelize(str)
+      str.split('_').collect(&:capitalize).join
+    end
+
+    def self.camelize_and_symbolize_keys(object)
+      transform_names object do |key|
+        camelize(key.to_s).to_sym
+      end
+    end
+
+    def self.underscore_and_symbolize_names(object)
+      transform_names object do |key|
+        underscore(key).to_sym
+      end
+    end
+
+    def self.transform_names(object, &block)
+      case object
+        when Hash
+          new_hash = {}
+          object.each do |key, value|
+            key = block.call(key) || key
+            new_hash[key] = transform_names(value, &block)
+          end
+          new_hash
+        when Array
+          object.map { |value| transform_names(value, &block) }
+        else
+          object
+      end
+    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.url_encode(key)
+      URI.escape(key.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+    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
+
+  end
+end

data/lib/paysimple/version.rb

@@ -0,0 +1,3 @@
+module Paysimple
+  VERSION = '0.1.0'
+end

data/paysimple.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'paysimple/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'paysimple-ruby'
+  spec.version       = Paysimple::VERSION
+  spec.authors       = ['Konstantin Lebedev']
+  spec.email         = ['koss.lebedev@gmail.com']
+
+  spec.summary       = 'Ruby bindings for Paysimple API'
+  spec.description   = ''
+  spec.homepage      = 'http://developer.paysimple.com'
+  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.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+
+  spec.add_dependency('rest-client', '~> 1.4')
+  spec.add_dependency('json', '~> 1.8.1')
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: paysimple-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Konstantin Lebedev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+description: ''
+email:
+- koss.lebedev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/paysimple.rb
+- lib/paysimple/endpoint.rb
+- lib/paysimple/errors/api_connection_error.rb
+- lib/paysimple/errors/api_error.rb
+- lib/paysimple/errors/authentication_error.rb
+- lib/paysimple/errors/invalid_request_error.rb
+- lib/paysimple/errors/paysimple_error.rb
+- lib/paysimple/resources/ach.rb
+- lib/paysimple/resources/credit_card.rb
+- lib/paysimple/resources/customer.rb
+- lib/paysimple/resources/payment.rb
+- lib/paysimple/util.rb
+- lib/paysimple/version.rb
+- paysimple.gemspec
+homepage: http://developer.paysimple.com
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for Paysimple API
+test_files: []