judopay 1.0.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ba2d46d3aa3dea80dba33739e877dc9c36b067dd
+  data.tar.gz: 09b41cc8a321db7a5d1c3072ecbb408340bde1cc
+SHA512:
+  metadata.gz: c7c37cc2a0c0c88f758afb3c139b89c87fe2feeca6b9b4b85558e80a83aae309ab4c80cdb80379f3766c4cc0e0e836b2baa72cd656c76de65bf5a7caf6f599d1
+  data.tar.gz: 5aa13ae6190a479d239462093c13f2f842abf825cbfd90f79a1b26e50187590a9b9c0ccbfeb444449d8aa92385e2366c15459edbda9b56c6eae91f3f928594a9

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+log.txt
+
+cmd.txt
+
+output.txt

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,47 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-06-26 17:06:45 +0100 using RuboCop version 0.23.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+# Offense count: 1
+Style/CyclomaticComplexity:
+  Max: 10
+
+# Offense count: 15
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 18
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/DotPosition:
+  Enabled: false
+
+# Offense count: 73
+# Cop supports --auto-correct.
+# Configuration parameters: SupportedStyles.
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+# Offense count: 18
+Style/Lambda:
+  Enabled: false
+
+# Offense count: 25
+Style/LineLength:
+  Max: 138
+
+# Offense count: 3
+# Configuration parameters: CountComments.
+Style/MethodLength:
+  Max: 32
+
+# Offense count: 2
+Style/RegexpLiteral:
+  MaxSlashes: 0

data/.yardopts

@@ -0,0 +1 @@
+- README.md

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Judopay
+
+MIT License
+
+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,43 @@
+# Judopay
+
+The Judopay gem supports Ruby 1.9.3 and above (including 2.0.x and 2.1.x).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+	gem 'judopay'
+
+And then execute:
+
+	$ bundle
+
+Or install it yourself as:
+
+	$ gem install judopay
+
+## Configuration
+
+You configure the Judopay gem by passing a block. For example:
+
+	Judopay.configure do |config|
+	  config.judo_id = 12345
+	end
+
+## Authentication
+You can authenticate either with basic authentication by passing your login and password credentials or using an existing OAuth2 access token.
+
+### Basic authentication
+
+	Judopay.configure do |config|
+	  config.judo_id = 12345
+	  config.api_token = 'your-token'
+	  config.api_secret = 'your-secret'
+	end
+
+### OAuth2 access token authentication
+
+	Judopay.configure do |config|
+	  config.judo_id = 12345
+	  config.oauth_access_token = 'your-oauth-token'
+	end

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/judopay.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'judopay/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'judopay'
+  spec.version       = Judopay::VERSION
+  spec.authors       = ['Chris Rosser']
+  spec.email         = ['developersupport@judopay.com']
+  spec.summary       = 'Ruby SDK wrapper for the Judopay REST API'
+  spec.description   = ''
+  spec.homepage      = 'http://www.judopay.com'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split("\n")
+  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.required_ruby_version = '>= 1.9.3'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'yard-xml'
+  spec.add_development_dependency 'factory_girl'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'webmock'
+  spec.add_dependency 'virtus', '=1.0.2'
+  spec.add_dependency 'httpclient', '=2.4.0'
+  spec.add_dependency 'activemodel', '=4.1.1'
+  spec.add_dependency 'faraday', '=0.9.0'
+  spec.add_dependency 'faraday_middleware', '=0.9.1'
+  spec.add_dependency 'rash', '=0.4.0'
+  spec.add_dependency 'addressable', '=2.3.6'
+end

data/lib/certs/rapidssl_ca.crt

@@ -0,0 +1,64 @@
+-----BEGIN CERTIFICATE-----
+MIIDVDCCAjygAwIBAgIDAjRWMA0GCSqGSIb3DQEBBQUAMEIxCzAJBgNVBAYTAlVT
+MRYwFAYDVQQKEw1HZW9UcnVzdCBJbmMuMRswGQYDVQQDExJHZW9UcnVzdCBHbG9i
+YWwgQ0EwHhcNMDIwNTIxMDQwMDAwWhcNMjIwNTIxMDQwMDAwWjBCMQswCQYDVQQG
+EwJVUzEWMBQGA1UEChMNR2VvVHJ1c3QgSW5jLjEbMBkGA1UEAxMSR2VvVHJ1c3Qg
+R2xvYmFsIENBMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA2swYYzD9
+9BcjGlZ+W988bDjkcbd4kdS8odhM+KhDtgPpTSEHCIjaWC9mOSm9BXiLnTjoBbdq
+fnGk5sRgprDvgOSJKA+eJdbtg/OtppHHmMlCGDUUna2YRpIuT8rxh0PBFpVXLVDv
+iS2Aelet8u5fa9IAjbkU+BQVNdnARqN7csiRv8lVK83Qlz6cJmTM386DGXHKTubU
+1XupGc1V3sjs0l44U+VcT4wt/lAjNvxm5suOpDkZALeVAjmRCw7+OC7RHQWa9k0+
+bw8HHa8sHo9gOeL6NlMTOdReJivbPagUvTLrGAMoUgRx5aszPeE4uwc2hGKceeoW
+MPRfwCvocWvk+QIDAQABo1MwUTAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBTA
+ephojYn7qwVkDBF9qn1luMrMTjAfBgNVHSMEGDAWgBTAephojYn7qwVkDBF9qn1l
+uMrMTjANBgkqhkiG9w0BAQUFAAOCAQEANeMpauUvXVSOKVCUn5kaFOSPeCpilKIn
+Z57QzxpeR+nBsqTP3UEaBU6bS+5Kb1VSsyShNwrrZHYqLizz/Tt1kL/6cdjHPTfS
+tQWVYrmm3ok9Nns4d0iXrKYgjy6myQzCsplFAMfOEVEiIuCl6rYVSAlk6l5PdPcF
+PseKUgzbFbS9bZvlxrFUaKnjaZC2mqUPuLk/IH2uSrW4nOQdtqvmlKXBx4Ot2/Un
+hw4EbNX/3aBd7YdStysVAq45pmp06drE57xNNB6pXE0zX5IJL4hmXXeXxx12E6nV
+5fEWCRE11azbJHFwLJhWC9kXtNHjUStedejV0NxPNO3CBWaAocvmMw==
+-----END CERTIFICATE-----
+-----BEGIN CERTIFICATE-----
+MIID1TCCAr2gAwIBAgIDAjbRMA0GCSqGSIb3DQEBBQUAMEIxCzAJBgNVBAYTAlVT
+MRYwFAYDVQQKEw1HZW9UcnVzdCBJbmMuMRswGQYDVQQDExJHZW9UcnVzdCBHbG9i
+YWwgQ0EwHhcNMTAwMjE5MjI0NTA1WhcNMjAwMjE4MjI0NTA1WjA8MQswCQYDVQQG
+EwJVUzEXMBUGA1UEChMOR2VvVHJ1c3QsIEluYy4xFDASBgNVBAMTC1JhcGlkU1NM
+IENBMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAx3H4Vsce2cy1rfa0
+l6P7oeYLUF9QqjraD/w9KSRDxhApwfxVQHLuverfn7ZB9EhLyG7+T1cSi1v6kt1e
+6K3z8Buxe037z/3R5fjj3Of1c3/fAUnPjFbBvTfjW761T4uL8NpPx+PdVUdp3/Jb
+ewdPPeWsIcHIHXro5/YPoar1b96oZU8QiZwD84l6pV4BcjPtqelaHnnzh8jfyMX8
+N8iamte4dsywPuf95lTq319SQXhZV63xEtZ/vNWfcNMFbPqjfWdY3SZiHTGSDHl5
+HI7PynvBZq+odEj7joLCniyZXHstXZu8W1eefDp6E63yoxhbK1kPzVw662gzxigd
+gtFQiwIDAQABo4HZMIHWMA4GA1UdDwEB/wQEAwIBBjAdBgNVHQ4EFgQUa2k9ahhC
+St2PAmU5/TUkhniRFjAwHwYDVR0jBBgwFoAUwHqYaI2J+6sFZAwRfap9ZbjKzE4w
+EgYDVR0TAQH/BAgwBgEB/wIBADA6BgNVHR8EMzAxMC+gLaArhilodHRwOi8vY3Js
+Lmdlb3RydXN0LmNvbS9jcmxzL2d0Z2xvYmFsLmNybDA0BggrBgEFBQcBAQQoMCYw
+JAYIKwYBBQUHMAGGGGh0dHA6Ly9vY3NwLmdlb3RydXN0LmNvbTANBgkqhkiG9w0B
+AQUFAAOCAQEAq7y8Cl0YlOPBscOoTFXWvrSY8e48HM3P8yQkXJYDJ1j8Nq6iL4/x
+/torAsMzvcjdSCIrYA+lAxD9d/jQ7ZZnT/3qRyBwVNypDFV+4ZYlitm12ldKvo2O
+SUNjpWxOJ4cl61tt/qJ/OCjgNqutOaWlYsS3XFgsql0BYKZiZ6PAx2Ij9OdsRu61
+04BqIhPSLT90T+qvjF+0OJzbrs6vhB6m9jRRWXnT43XcvNfzc9+S7NIgWW+c+5X4
+knYYCnwPLKbK3opie9jzzl9ovY8+wXS7FXI6FoOpC+ZNmZzYV+yoAVHHb1c0XqtK
+LEL2TxyJeN4mTvVvk0wVaydWTQBUbHq3tw==
+-----END CERTIFICATE-----
+-----BEGIN CERTIFICATE-----
+MIIDfTCCAuagAwIBAgIDErvmMA0GCSqGSIb3DQEBBQUAME4xCzAJBgNVBAYTAlVT
+MRAwDgYDVQQKEwdFcXVpZmF4MS0wKwYDVQQLEyRFcXVpZmF4IFNlY3VyZSBDZXJ0
+aWZpY2F0ZSBBdXRob3JpdHkwHhcNMDIwNTIxMDQwMDAwWhcNMTgwODIxMDQwMDAw
+WjBCMQswCQYDVQQGEwJVUzEWMBQGA1UEChMNR2VvVHJ1c3QgSW5jLjEbMBkGA1UE
+AxMSR2VvVHJ1c3QgR2xvYmFsIENBMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB
+CgKCAQEA2swYYzD99BcjGlZ+W988bDjkcbd4kdS8odhM+KhDtgPpTSEHCIjaWC9m
+OSm9BXiLnTjoBbdqfnGk5sRgprDvgOSJKA+eJdbtg/OtppHHmMlCGDUUna2YRpIu
+T8rxh0PBFpVXLVDviS2Aelet8u5fa9IAjbkU+BQVNdnARqN7csiRv8lVK83Qlz6c
+JmTM386DGXHKTubU1XupGc1V3sjs0l44U+VcT4wt/lAjNvxm5suOpDkZALeVAjmR
+Cw7+OC7RHQWa9k0+bw8HHa8sHo9gOeL6NlMTOdReJivbPagUvTLrGAMoUgRx5asz
+PeE4uwc2hGKceeoWMPRfwCvocWvk+QIDAQABo4HwMIHtMB8GA1UdIwQYMBaAFEjm
+aPkr0rKV10fYIyAQTzOYkJ/UMB0GA1UdDgQWBBTAephojYn7qwVkDBF9qn1luMrM
+TjAPBgNVHRMBAf8EBTADAQH/MA4GA1UdDwEB/wQEAwIBBjA6BgNVHR8EMzAxMC+g
+LaArhilodHRwOi8vY3JsLmdlb3RydXN0LmNvbS9jcmxzL3NlY3VyZWNhLmNybDBO
+BgNVHSAERzBFMEMGBFUdIAAwOzA5BggrBgEFBQcCARYtaHR0cHM6Ly93d3cuZ2Vv
+dHJ1c3QuY29tL3Jlc291cmNlcy9yZXBvc2l0b3J5MA0GCSqGSIb3DQEBBQUAA4GB
+AHbhEm5OSxYShjAGsoEIz/AIx8dxfmbuwu3UOx//8PDITtZDOLC5MH0Y0FWDomrL
+NhGc6Ehmo21/uBPUR/6LWlxz/K7ZGzIZOKuXNBSqltLroxwUCEm2u+WR74M26x1W
+b8ravHNjkOR/ez4iyz0H7V84dJzjA1BOoa+Y7mHyhD8S
+-----END CERTIFICATE-----

data/lib/faraday/judo_mashify.rb

@@ -0,0 +1,13 @@
+require 'faraday_middleware/response/rashify'
+require_relative '../judopay/mash'
+
+# @private
+module FaradayMiddleware
+  # Convert parsed response bodies to a Hashie::Rash if they are a Hash or Array
+  class JudoMashify < Rashify
+    dependency do
+      require 'rash'
+      self.mash_class = ::Judopay::Mash
+    end
+  end
+end

data/lib/faraday/raise_http_exception.rb

@@ -0,0 +1,36 @@
+require 'faraday'
+require_relative '../judopay/error'
+
+# @private
+module FaradayMiddleware
+  # Raise an appropriate exception for failure HTTP response codes
+  class RaiseHttpException < Faraday::Middleware
+    def call(env)
+      @app.call(env).on_complete do |response|
+        case response.status.to_i
+        when 400
+          fail Judopay::BadRequest, response
+        when 401, 403
+          fail Judopay::NotAuthorized, response
+        when 404
+          fail Judopay::NotFound, response
+        when 409
+          fail Judopay::Conflict, response
+        when 500
+          fail Judopay::InternalServerError, response
+        when 502
+          fail Judopay::BadGateway, response
+        when 503
+          fail Judopay::ServiceUnavailable, response
+        when 504
+          fail Judopay::GatewayTimeout, response
+        end
+      end
+    end
+
+    def initialize(app)
+      super app
+      @parser = nil
+    end
+  end
+end

data/lib/judopay.rb

@@ -0,0 +1,67 @@
+require_relative 'judopay/version'
+require_relative 'judopay/api'
+require_relative 'judopay/response'
+require_relative 'judopay/serializer'
+require_relative 'judopay/error'
+require_relative 'judopay/null_logger'
+
+module Judopay
+  class << self
+    attr_accessor :configuration
+  end
+
+  # Configure the gem by passing a block
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+    configure_endpoint_for_environment
+  end
+
+  # Record a new log message if a logger is configured
+  def self.log(log_level, message)
+    logger = self.configuration.logger
+    return unless logger.is_a?(Logger)
+    logger.progname = 'judopay'
+    logger.add(log_level) { message }
+  end
+
+  protected
+
+  # Based on the use_production flag, which endpoint should we use?
+  def self.configure_endpoint_for_environment
+    if self.configuration.use_production == true
+      self.configuration.endpoint_url = self.configuration.api_endpoints[:production]
+    else
+      self.configuration.endpoint_url = self.configuration.api_endpoints[:sandbox]
+    end
+  end
+
+  class Configuration
+    attr_accessor :api_version,
+                  :api_token,
+                  :api_secret,
+                  :oauth_access_token,
+                  :format,
+                  :endpoint_url,
+                  :user_agent,
+                  :judo_id,
+                  :logger,
+                  :use_production
+
+    attr_reader :api_endpoints
+
+    # Set sensible configuration defaults
+    def initialize
+      @api_version = '4.0.0'
+      @format = 'json'
+      @use_production = false
+      @user_agent = 'Judopay Ruby SDK gem v' + Judopay::VERSION
+      @logger = Judopay::NullLogger.new
+      @api_endpoints = {
+        :sandbox => 'https://partnerapi.judopay-sandbox.com',
+        :production => 'https://production.local'
+      }.freeze
+      @endpoint_url = @api_endpoints[:sandbox]
+    end
+  end
+end

data/lib/judopay/api.rb

@@ -0,0 +1,10 @@
+require File.expand_path('../connection', __FILE__)
+require File.expand_path('../request', __FILE__)
+
+module Judopay
+  # @private
+  class API
+    include Connection
+    include Request
+  end
+end

data/lib/judopay/connection.rb

@@ -0,0 +1,67 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'openssl'
+require_relative '../faraday/raise_http_exception'
+require_relative '../faraday/judo_mashify'
+
+module Judopay
+  # @private
+  module Connection
+    private
+
+    def connection(raw = false)
+      options = {
+        :headers => request_headers,
+        :url => Judopay.configuration.endpoint_url,
+        :ssl => {
+          :ca_file => File.dirname(File.dirname(__FILE__)) + '/certs/rapidssl_ca.crt',
+          :cert_store => false,
+          :verify => true
+        }
+      }
+
+      connection = Faraday::Connection.new(options) do |faraday|
+        faraday.adapter :httpclient
+        faraday.use Faraday::Request::UrlEncoded
+        faraday.use Faraday::Response::Logger, Judopay.configuration.logger
+        faraday.use FaradayMiddleware::JudoMashify unless raw
+        unless raw
+          case Judopay.configuration.format.to_s
+          when 'json' then faraday.use Faraday::Response::ParseJson
+          end
+        end
+        faraday.use FaradayMiddleware::RaiseHttpException
+      end
+
+      # Authentication with basic auth if there is no OAuth2 access token
+      if Judopay.configuration.oauth_access_token.nil?
+        connection.basic_auth(
+          Judopay.configuration.api_token,
+          Judopay.configuration.api_secret
+        )
+        Judopay.log(Logger::DEBUG, 'Using HTTP basic auth')
+      end
+
+      connection
+    end
+
+    def request_headers
+      format = Judopay.configuration.format
+
+      headers = {
+        'Accept' => "application/#{format}; charset=utf-8",
+        'User-Agent' => Judopay.configuration.user_agent,
+        'API-Version' => Judopay.configuration.api_version,
+        'Content-Type' => 'application/json'
+      }
+
+      # Do we have an OAuth2 access token?
+      unless Judopay.configuration.oauth_access_token.nil?
+        headers['Authorization'] = 'Bearer ' + Judopay.configuration.oauth_access_token
+        Judopay.log(Logger::DEBUG, 'Using OAuth2 access token')
+      end
+
+      headers
+    end
+  end
+end