quickpay-ruby-client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8dce85d735cd476ba333dcfe8acfbd28b4520a32
+  data.tar.gz: 37f806252c5c55f0a486e32b6e7dbfeb2520ac13
+SHA512:
+  metadata.gz: e03e6f97162e7652eb00865b142d506de7a8c9fa62355e17a5228097aad2f2f958997eaad89faab88b9ba5e6ab625d8088930f6af8e2a101ad4033aaf94f6604
+  data.tar.gz: 109568135f5bf9b144ccb35591285cd84038b67f3221403ec095ff0882a83df704c8f6b0cb10dbffe0e61ee53bb3c6b2f79ab33fd7459eb259640a4fda63b577

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.1.2
+cache: bundler
+script: bundle exec rspec --format documentation --color
+notifications:
+  slack:
+    secure: SixeTgiVsOaeWyKwICxLJ0GLN/C9j6qW1ZdaEytIDuZaBAn9oArrRGkJiehFdlzcPUHwzMWC0vl9GQzyBhZ7dbq+B53QY1mH9LTb9A53Y2d1OO1kBjJAkC5Yprvpjm52+x889Dwlz0bfLETvLsC2ej0NZDvSSLKFjpZZIZMOWkg=

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 QuickPay
+
+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,113 @@
+quickpay-ruby-client
+======================
+[![Build Status](https://travis-ci.org/QuickPay/quickpay-ruby-client.svg)](https://travis-ci.org/QuickPay/quickpay-ruby-client)
+
+`quickpay-ruby-client` is a official client for [QuickPay API](http://tech.quickpay.net/api). The Quickpay API enables you to accept payments in a secure and reliable manner. This gem currently support QuickPay `v10` api.
+
+## Installation
+
+Add to your Gemfile
+  
+    $ gem 'quickpay-ruby-client'
+
+or install from Rubygems:
+  
+    $ gem install quickpay-ruby-client
+  
+It is currently tested with Ruby ( >= 2.1.x)
+
+* MRI
+* Rubinius (2.0)
+
+## Usage
+
+Before doing anything you should register yourself with QuickPay and get access credentials. If you haven't please [click](https://quickpay.net/) here to apply.
+
+### Create a new API client
+
+First you should create a client instance that is anonymous or authorized with `api_key` or login credentials provided by QuickPay. 
+
+To initialise an anonymous client:
+
+```
+require 'quickpay/api/client'
+client = QuickPay::API::Client.new
+```
+
+To initialise a client with QuickPay Api Key:
+
+```
+require 'quickpay/api/client'
+client = QuickPay::API::Client.new(api_key: ENV['QUICKPAY_API_KEY'])
+```
+
+Or you can provide login credentials like:
+
+```
+require 'quickpay/api/client'
+client = QuickPay::API::Client.new(email: ENV['QUICKPAY_LOGIN'], password: ENV['QUICKPAY_PASSWORD'])
+```
+
+To pass request specific headers:
+
+```
+client = Quickpay::API::Client.new({ email: ENV['QUICKPAY_LOGIN'], password: ENV['QUICKPAY_PASSWORD'] }, 
+                                   :headers => { 'QuickPay-Callback-URL' => 'https://webshop.com' }) 
+```
+
+
+### API Calls
+
+You can afterwards call any method described in QuickPay api with corresponding http method and endpoint. These methods are supported currently: `get`, `post`, `put`, `patch` and `delete`.
+
+```
+client.get("/activities").each do |activity|
+  puts activity.id
+end
+
+```
+
+If you want raw http response, headers Please add `:raw => true` parameter:
+
+```
+status, body, headers = client.get("/activities", :raw => true)
+
+if status == 200
+  JSON.parse(body).each do |activity|
+    puts activity.id
+  end
+else
+  puts "Error: #{body}"
+end
+
+```
+
+### Handling API exceptions
+
+By default `(get|post|patch|put|delete)` will return JSON parsed body on success (i.e. `2xx` response code) otherwise it will raise appropriate error. Your code should handle the errors appropriately. Following error codes are supported currently:
+
+
+Response status |  Error    |
+----------------| ----------|
+`400` | `QuickPay::API::BadRequest`
+`401` | `QuickPay::API::Unauthorized` 
+`402` | `QuickPay::API::PaymentRequired`
+`403` | `QuickPay::API::Forbidden`
+`404` | `QuickPay::API::NotFound`
+`405` | `QuickPay::API::MethodNotAllowed`
+`406` | `QuickPay::API::NotAcceptable`
+`409` | `QuickPay::API::Conflict`
+`500` | `QuickPay::API::ServerError`
+
+All exceptions inherits `QuickPay::API::Error`, so you can listen for any api error like:
+
+```
+begin
+  client.post("/payments", :currency => :DKK, :order_id => '1212')
+  ... 
+rescue QuickPay::API::Error => e
+  puts e.body
+end
+```
+
+You can read more about api responses at [http://tech.quickpay.net/api/](http://tech.quickpay.net/api).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/quickpay.rb

@@ -0,0 +1,5 @@
+require 'json'
+require 'httparty'
+require 'quickpay/version'
+require 'quickpay/logger'
+require 'quickpay/constants'

data/lib/quickpay/api/client.rb

@@ -0,0 +1,36 @@
+require 'quickpay'
+require 'quickpay/api/request'
+require 'quickpay/api/errors'
+
+module QuickPay
+  class << self
+    attr_accessor :base_uri
+  end
+
+  module API
+    class Client
+      attr_accessor :options
+      
+      def initialize(auth_params = {}, opts = {})
+        opts[:secret]   ||= extract_auth(auth_params)
+        opts[:base_uri] ||= (QuickPay.base_uri || QuickPay::BASE_URI)
+
+        @options = opts.dup
+      end
+      
+      def extract_auth params
+        if params[:email] and params[:password]  
+          "#{params[:email]}:#{params[:password]}"
+        elsif params[:api_key]
+          ":#{params[:api_key]}"
+        end
+      end
+
+      [:get, :post, :patch, :put, :delete].each do |method|
+        define_method(method) do |*args|
+          Request.new(options).request(method, *args)
+        end
+      end
+    end
+  end
+end

data/lib/quickpay/api/errors.rb

@@ -0,0 +1,10 @@
+
+[:quickpay_error, :bad_request, :unauthorized, :payment_required, 
+ :forbidden, :not_found, :method_not_allowed, :not_acceptable, 
+ :conflict, :server_error].each do |err_code|   
+    require "quickpay/api/errors/#{err_code}"
+end
+
+
+
+

data/lib/quickpay/api/errors/bad_request.rb

@@ -0,0 +1,7 @@
+
+module QuickPay
+  module API
+    class BadRequest < Error
+    end
+  end
+end

data/lib/quickpay/api/errors/conflict.rb

@@ -0,0 +1,7 @@
+
+module QuickPay
+  module API
+    class Conflict < Error
+    end
+  end
+end

data/lib/quickpay/api/errors/forbidden.rb

@@ -0,0 +1,7 @@
+
+module QuickPay
+  module API
+    class Forbidden < Error
+    end
+  end
+end

data/lib/quickpay/api/errors/method_not_allowed.rb

@@ -0,0 +1,7 @@
+
+module QuickPay
+  module API
+    class MethodNotAllowed < Error
+    end
+  end
+end

data/lib/quickpay/api/errors/not_acceptable.rb

@@ -0,0 +1,7 @@
+
+module QuickPay
+  module API
+    class NotAcceptable < Error
+    end
+  end
+end

data/lib/quickpay/api/errors/not_found.rb

@@ -0,0 +1,7 @@
+
+module QuickPay
+  module API
+    class NotFound < Error
+    end
+  end
+end

data/lib/quickpay/api/errors/payment_required.rb

@@ -0,0 +1,7 @@
+
+module QuickPay
+  module API
+    class PaymentRequired < Error
+    end
+  end
+end

data/lib/quickpay/api/errors/quickpay_error.rb

@@ -0,0 +1,13 @@
+module QuickPay
+  module API
+    class Error < StandardError
+      attr_reader :code, :status, :body
+
+      def initialize(code, status, body)
+        @code   = code
+        @status = status
+        @body   = body
+      end
+    end
+  end  
+end

data/lib/quickpay/api/errors/server_error.rb

@@ -0,0 +1,7 @@
+
+module QuickPay
+  module API
+    class ServerError < Error
+    end
+  end
+end

data/lib/quickpay/api/errors/unauthorized.rb

@@ -0,0 +1,7 @@
+
+module QuickPay
+  module API
+    class Unauthorized < Error
+    end
+  end
+end

data/lib/quickpay/api/request.rb

@@ -0,0 +1,87 @@
+
+module QuickPay
+  module API
+    class Request
+      include HTTParty
+      
+      def initialize (options = {})
+        @secret = options[:secret]
+        self.class.base_uri(options[:base_uri] || BASE_URI)
+      end
+      
+      def request method, path, data = {}
+        raw = data.delete(:raw)
+        req_headers = headers.merge(data.delete(:headers) || {})
+
+        options = case method
+                  when :get, :delete
+                    { query: data }
+                  when :post, :patch, :put
+                    { body: data }
+                  end || {}
+        
+        options = options.merge(:headers => headers.merge(req_headers))
+        QuickPay.logger.debug { "#{method.to_s.upcase} #{base_uri}#{path} #{options}" }
+        create_response(raw, self.class.send(method, path, options))
+      end
+      
+      def create_response raw, res
+        if raw
+          [res.code, res.body, res.headers]
+        else
+          response = res.parsed_response
+          raise_error(response, res.code) if res.code >= 400
+          response
+        end
+      end
+      
+      def raise_error body, status
+        code = API_STATUS_CODES[status].to_s
+        args = [code, status, body]
+        
+        klass =
+          begin
+            require "quickpay/api/errors/#{code}"
+            class_name = code.split('_').map(&:capitalize).join('')
+            QuickPay::API.const_get(class_name)
+          rescue LoadError, NameError
+            QuickPay::API::Error
+          end
+          
+        fail klass.new(*args), error_description(body)
+      end
+      
+      private
+        
+        def base_uri
+          self.class.default_options[:base_uri]
+        end
+
+        def error_description msg
+          msg
+        end
+        
+        def headers
+          heads = {
+            'User-Agent'     => user_agent,
+            'Accept-Version' => "v#{QuickPay::API_VERSION}"
+          }
+          heads['Authorization'] = "Basic #{authorization}" if @secret != nil
+          heads
+        end
+
+        def user_agent
+          user_agent = "quickpay-ruby-client, v#{QuickPay::VERSION}"
+          user_agent += ", #{RUBY_VERSION}, #{RUBY_PLATFORM}, #{RUBY_PATCHLEVEL}"
+          if defined?(RUBY_ENGINE)
+            user_agent += ", #{RUBY_ENGINE}"
+          end
+          user_agent  
+        end
+        
+        def authorization
+          Base64.strict_encode64(@secret)
+        end   
+    end
+  end    
+end

data/lib/quickpay/constants.rb

@@ -0,0 +1,21 @@
+
+module QuickPay
+  BASE_URI    = 'https://api.quickpay.net'
+  API_VERSION = 10
+  
+  API_STATUS_CODES = {
+    200 => :ok,
+    201 => :created,
+    202 => :accepted,
+    400 => :bad_request,
+    401 => :unauthorized,
+    402 => :payment_required,
+    403 => :forbidden,
+    404 => :not_found,
+    405 => :method_not_allowed,
+    406 => :not_acceptable,
+    409 => :conflict,
+    500 => :server_error
+  }  
+end
+

data/lib/quickpay/logger.rb

@@ -0,0 +1,16 @@
+require 'logger'
+
+module QuickPay
+  class << self
+    attr_writer :logger
+    
+    def logger
+      @logger ||= lambda {
+        logger = Logger.new($stdout)
+        logger.level = Logger::INFO
+        logger  
+      }.call 
+    end
+    
+  end
+end

data/lib/quickpay/version.rb

@@ -0,0 +1,3 @@
+module QuickPay
+  VERSION = "1.0.0"
+end

data/quickpay-ruby-client.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'quickpay/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "quickpay-ruby-client"
+  spec.version       = QuickPay::VERSION
+  spec.authors       = ["QuickPay Developers"]
+  spec.email         = ["support@quickpay.net"]
+  
+  spec.summary       = "Ruby client for QuickPay API"
+  spec.description   = "Embed QuickPay's secure payments directly into your Ruby applications. more at https://tech.quickpay.net"
+  spec.homepage      = "https://github.com/QuickPay/quickpay-ruby-client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "rspec-mocks"
+  spec.add_development_dependency "webmock"
+  
+  spec.add_dependency "httparty", "~> 0.13"
+    
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: quickpay-ruby-client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- QuickPay Developers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  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: webmock
+  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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+description: Embed QuickPay's secure payments directly into your Ruby applications.
+  more at https://tech.quickpay.net
+email:
+- support@quickpay.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/quickpay.rb
+- lib/quickpay/api/client.rb
+- lib/quickpay/api/errors.rb
+- lib/quickpay/api/errors/bad_request.rb
+- lib/quickpay/api/errors/conflict.rb
+- lib/quickpay/api/errors/forbidden.rb
+- lib/quickpay/api/errors/method_not_allowed.rb
+- lib/quickpay/api/errors/not_acceptable.rb
+- lib/quickpay/api/errors/not_found.rb
+- lib/quickpay/api/errors/payment_required.rb
+- lib/quickpay/api/errors/quickpay_error.rb
+- lib/quickpay/api/errors/server_error.rb
+- lib/quickpay/api/errors/unauthorized.rb
+- lib/quickpay/api/request.rb
+- lib/quickpay/constants.rb
+- lib/quickpay/logger.rb
+- lib/quickpay/version.rb
+- quickpay-ruby-client.gemspec
+homepage: https://github.com/QuickPay/quickpay-ruby-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.0.14
+signing_key: 
+specification_version: 4
+summary: Ruby client for QuickPay API
+test_files: []