payoneer_ruby_sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93ec7b28f44c376843c059ff34195120e76f863b
+  data.tar.gz: 9d913cbdcb45faa1f94ab919bbbee2c8f0592caf
+SHA512:
+  metadata.gz: 76e6fdeed27314eb0a62da6b9617df5d68bf29131c89b4cb59164984d0fa9ab05f661e42a2c3bbf90fe5f3931ebe0ce74eeb5dd57cd6fe458e116a8d27288cd3
+  data.tar.gz: 04a35bb17cc879b4b1a1560b740f71cd5a820110c646df5bcc7b0e072d67d913b596dab8de6bd1543969e2dcdf6010077c56ce6a22db00c5b20eb1cc19459ddf

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 kissrobber
+
+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,149 @@
+# Payoneer Ruby SDK
+
+Payoneer Ruby SDK.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'payoneer_ruby_sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install payoneer_ruby_sdk
+
+## Configuration
+
+```ruby
+Payoneer.configure({
+  partner_username: '<payoneer_username>',
+  partner_api_password: '<payoneer_api_password>',
+  partner_id: '<payoneer_partner_id>',
+  program_id: '<payoneer_program_id>',
+  env: 'production'
+})
+```
+
+## Usage
+
+### General APIs
+
+#### Echo
+```ruby
+Payoneer::Api::Echo.request
+```
+
+#### GetVersion
+```ruby
+Payoneer::Api::GetVersion.request
+```
+
+### Payee Registration
+
+#### Payee Sign-up
+```ruby
+Payoneer::Api::GetToken.request(payee_id: 1000011)
+```
+
+#### Payee Sign-up / Auto Population
+```ruby
+data = '<?xml version="1.0" encoding="utf-8"?>
+<PayoneerDetails>
+ <Details>
+ <apuid>123</apuid>
+ <sessionid></sessionid>
+ <redirect></redirect>
+ <redirectTime></redirectTime>
+ <PayoutMethodList></PayoutMethodList>
+ <RegMode></RegMode>
+ </Details>
+ <PersonalDetails>
+ <firstName></firstName>
+ <lastName></lastName>
+ <dateOfBirth></dateOfBirth>
+ <address1></address1>
+ <address2></address2>
+ <city></city>
+ <country></country>
+ <state></state>
+ <zipCode></zipCode>
+ <mobile></mobile>
+ <phone></phone>
+ <email></email>
+ </PersonalDetails>
+</PayoneerDetails>
+'
+Payoneer::Api::GetTokenXml.request(xml: data)
+```
+
+### Payees
+
+#### Get Payee Details
+```ruby
+Payoneer::Api::GetPayeeDetails.request(payee_id: 1000011)
+```
+
+#### Get Single Payee Report
+```ruby
+Payoneer::Api::GetSinglePayeeReport.request(payee_id: 1000011)
+```
+
+#### Get Payees Report
+```ruby
+Payoneer::Api::GetPayeesReport.request(start_date: '2015/09/01', end_date: '2015/10/2')
+```
+
+#### Change Payee Id
+```ruby
+Payoneer::Api::ChangePayeeId.request(old_payee_id: 1000002, new_payee_id: 2000002)
+```
+
+### Perform a Payment
+
+#### Perform Payout Payment
+```ruby
+Payoneer::Api::PerformPayoutPayment.request(payment_id: 1, payee_id: 2000002, amount: 20, description: 'unko', currency: 'USD', payment_date: '2015/10/2')
+```
+
+### Payments
+
+#### Cancel Payment
+```ruby
+Payoneer::Api::CancelPayment.request(payment_id: 1)
+```
+
+#### Get Payment Status
+```ruby
+Payoneer::Api::GetPaymentStatus.request(payee_id: 1000011, payment_id: 1)
+```
+
+#### Get Unclaimed Payments XML
+```ruby
+Payoneer::Api::GetUnclaimedPaymentsXML.request
+```
+
+#### Get Unclaimed Payments CSV
+```ruby
+Payoneer::Api::GetUnclaimedPaymentsCSV.request
+```
+
+### Account
+
+#### Get Account Details
+```ruby
+Payoneer::Api::GetAccountDetails.request
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/kissrobber/payoneer_ruby_sdk/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "payoneer"
+
+require "irb"
+require "byebug"
+
+IRB.start

data/lib/payoneer/api/cancel_payment.rb

@@ -0,0 +1,13 @@
+module Payoneer
+  module Api
+    # Payoneer::Api::CancelPayment.request(payment_id: 1)
+    module CancelPayment
+      include Payoneer::Api::Core
+      def self.to_api_params(payment_id: nil)
+        {
+          p4: payment_id
+        }
+      end
+    end
+  end
+end

data/lib/payoneer/api/change_payee_id.rb

@@ -0,0 +1,14 @@
+module Payoneer
+  module Api
+    # Payoneer::Api::ChangePayeeId.request(old_payee_id: 1000002, new_payee_id: 2000002)
+    module ChangePayeeId
+      include Payoneer::Api::Core
+      def self.to_api_params(old_payee_id: nil, new_payee_id: nil)
+        {
+          p4: old_payee_id,
+          p5: new_payee_id
+        }
+      end
+    end
+  end
+end

data/lib/payoneer/api/core.rb

@@ -0,0 +1,48 @@
+module Payoneer
+  module Api
+    module Core
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+      module ClassMethods
+        def get_method_name
+          self.name.split('::').last
+        end
+        def to_api_params(params)
+          params
+        end
+        def to_response(response)
+          hash_response = Hash.from_xml(response.body)
+          inner_content = hash_response.values.first
+          ::Payoneer::Response.new inner_content
+        end
+
+        def request(params = {})
+          params = to_api_params(params)
+          method_name = get_method_name
+          config.validate!
+
+          request_params = default_params.merge(mname: method_name).merge(params)
+
+          response = RestClient.post(config.api_url, request_params)
+
+          fail Errors::ApiError.new(response.code, response.body) unless response.code == 200
+
+          to_response(response)
+        end
+
+        def config
+          ::Payoneer.config
+        end
+
+        def default_params
+          {
+            p1: config.partner_username,
+            p2: config.partner_api_password,
+            p3: config.partner_id,
+          }
+        end
+      end
+    end
+  end
+end

data/lib/payoneer/api/echo.rb

@@ -0,0 +1,8 @@
+module Payoneer
+  module Api
+    # Payoneer::Api::Echo.request
+    module Echo
+      include Payoneer::Api::Core
+    end
+  end
+end

data/lib/payoneer/api/get_account_details.rb

@@ -0,0 +1,8 @@
+module Payoneer
+  module Api
+    # Payoneer::Api::GetAccountDetails.request
+    module GetAccountDetails
+      include Payoneer::Api::Core
+    end
+  end
+end

data/lib/payoneer/api/get_payee_details.rb

@@ -0,0 +1,11 @@
+module Payoneer
+  module Api
+    # Payoneer::Api::GetPayeeDetails.request(payee_id: 1000011)
+    module GetPayeeDetails
+      include Payoneer::Api::Core
+      def self.to_api_params(payee_id: nil)
+        { p4: payee_id }
+      end
+    end
+  end
+end

data/lib/payoneer/api/get_payees_report.rb

@@ -0,0 +1,15 @@
+module Payoneer
+  module Api
+    # Payoneer::Api::GetPayeesReport.request(start_date: '2015/09/01', end_date: '2015/10/2')
+    module GetPayeesReport
+      include Payoneer::Api::Core
+      def self.to_api_params(report_type: nil, start_date: nil, end_date: nil)
+        {
+          p4: report_type,
+          p5: start_date,
+          p6: end_date
+        }
+      end
+    end
+  end
+end

data/lib/payoneer/api/get_payment_status.rb

@@ -0,0 +1,14 @@
+module Payoneer
+  module Api
+    # Payoneer::Api::GetPaymentStatus.request(payee_id: 1000011, payment_id: 1)
+    module GetPaymentStatus
+      include Payoneer::Api::Core
+      def self.to_api_params(payee_id: nil, payment_id: nil)
+        {
+          p4: payee_id,
+          p5: payment_id
+        }
+      end
+    end
+  end
+end

data/lib/payoneer/api/get_single_payee_report.rb

@@ -0,0 +1,11 @@
+module Payoneer
+  module Api
+    # Payoneer::Api::GetSinglePayeeReport.request(payee_id: 1000011)
+    module GetSinglePayeeReport
+      include Payoneer::Api::Core
+      def self.to_api_params(payee_id: nil)
+        { p4: payee_id }
+      end
+    end
+  end
+end

data/lib/payoneer/api/get_token.rb

@@ -0,0 +1,14 @@
+module Payoneer
+  module Api
+    # Payoneer::Api::GetToken.request(payee_id: 1000011)
+    module GetToken
+      include Payoneer::Api::Core
+      def self.to_api_params(payee_id: nil)
+        { p4: payee_id }
+      end
+      def self.to_response(response)
+        response
+      end
+    end
+  end
+end

data/lib/payoneer/api/get_token_xml.rb

@@ -0,0 +1,14 @@
+module Payoneer
+  module Api
+    # Payoneer::Api::GetTokenXml.request(xml: data)
+    module GetTokenXml
+      include Payoneer::Api::Core
+      def self.to_api_params(xml: nil)
+        { xml: xml }
+      end
+      def self.to_response(response)
+        response
+      end
+    end
+  end
+end

data/lib/payoneer/api/get_unclaimed_payments_csv.rb

@@ -0,0 +1,11 @@
+module Payoneer
+  module Api
+    # Payoneer::Api::GetUnclaimedPaymentsCSV.request
+    module GetUnclaimedPaymentsCSV
+      include Payoneer::Api::Core
+      def self.to_response(response)
+        response
+      end
+    end
+  end
+end

data/lib/payoneer/api/get_unclaimed_payments_xml.rb

@@ -0,0 +1,11 @@
+module Payoneer
+  module Api
+    # Payoneer::Api::GetUnclaimedPaymentsXML.request
+    module GetUnclaimedPaymentsXML
+      include Payoneer::Api::Core
+      def self.to_response(response)
+        response
+      end
+    end
+  end
+end

data/lib/payoneer/api/get_version.rb

@@ -0,0 +1,8 @@
+module Payoneer
+  module Api
+    # Payoneer::Api::GetVersion.request
+    module GetVersion
+      include Payoneer::Api::Core
+    end
+  end
+end

data/lib/payoneer/api/perform_payout_payment.rb

@@ -0,0 +1,19 @@
+module Payoneer
+  module Api
+    # Payoneer::Api::PerformPayoutPayment.request(payment_id: 1, payee_id: 2000002, amount: 20, description: 'unkounkounko', currency: 'USD', payment_date: '2015/10/2')
+    module PerformPayoutPayment
+      include Payoneer::Api::Core
+      def self.to_api_params(payment_id: nil, payee_id: nil, amount: nil, description: nil, payment_date: nil, currency: nil)
+        {
+          p4: config.program_id,
+          p5: payment_id,
+          p6: payee_id,
+          p7: amount,
+          p8: description,
+          p9: payment_date,
+          currency: currency
+        }
+      end
+    end
+  end
+end

data/lib/payoneer/api.rb

@@ -0,0 +1,15 @@
+require 'payoneer/api/core'
+require 'payoneer/api/echo'
+require 'payoneer/api/get_token'
+require 'payoneer/api/get_token_xml'
+require 'payoneer/api/get_version'
+require 'payoneer/api/get_payee_details'
+require 'payoneer/api/get_single_payee_report'
+require 'payoneer/api/get_payees_report'
+require 'payoneer/api/change_payee_id'
+require 'payoneer/api/perform_payout_payment'
+require 'payoneer/api/cancel_payment'
+require 'payoneer/api/get_payment_status'
+require 'payoneer/api/get_unclaimed_payments_xml'
+require 'payoneer/api/get_unclaimed_payments_csv'
+require 'payoneer/api/get_account_details'

data/lib/payoneer/configuration.rb

@@ -0,0 +1,46 @@
+require 'erb'
+require 'yaml'
+
+module Payoneer
+  module Configuration
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def config
+        @@config
+      rescue
+        raise ::Payoneer::Errors::ConfigurationError.new
+      end
+
+      def configure(options)
+        @@config = ::Payoneer::Config.new(options)
+      end
+    end
+
+    class Config
+      SANDBOX_API_URL = 'https://api.sandbox.payoneer.com/Payouts/HttpApi/API.aspx'
+      PRODUCTION_API_URL = 'https://api.payoneer.com/Payouts/HttpApi/API.aspx'
+      attr_accessor :partner_username, :partner_api_password, :partner_id, :program_id, :env
+
+      def initialize(options)
+        options.each do |key, value|
+          send("#{key}=", value)
+        end
+      end
+
+      def validate!
+        raise ConfigurationError.new unless %w(partner_username partner_api_password partner_id program_id env).all?{|k| self.send(k).present? }
+      end
+
+      def production?
+        self.env == 'production'
+      end
+
+      def api_url
+        production? ? PRODUCTION_API_URL : SANDBOX_API_URL
+      end
+    end
+  end
+end

data/lib/payoneer/errors/api_error.rb

@@ -0,0 +1,17 @@
+module Payoneer
+  module Errors
+    class ApiError < StandardError
+      attr_reader :http_status
+      attr_reader :http_body
+
+      def initialize(http_status = nil, http_body = nil)
+        @http_status = http_status
+        @http_body = http_body
+      end
+
+      def to_s
+        "(Status #{http_status}) Unexpected http response code"
+      end
+    end
+  end
+end

data/lib/payoneer/errors/configuration_error.rb

@@ -0,0 +1,6 @@
+module Payoneer
+  module Errors
+    class ConfigurationError < StandardError
+    end
+  end
+end

data/lib/payoneer/errors.rb

@@ -0,0 +1,2 @@
+require 'payoneer/errors/api_error'
+require 'payoneer/errors/configuration_error'

data/lib/payoneer/response.rb

@@ -0,0 +1,24 @@
+module Payoneer
+  class Response < OpenStruct
+    OK_STATUS_CODE = '000'
+
+    def initialize(hash)
+      super(convert_hash_keys(hash))
+    end
+
+    def convert_hash_keys(value)
+      case value
+        when Array
+          value.map { |v| convert_hash_keys(v) }
+        when Hash
+          Hash[value.map { |k, v| [k.underscore, convert_hash_keys(v)] }]
+        else
+          value
+       end
+    end
+
+    def ok?
+      self.status == OK_STATUS_CODE
+    end
+  end
+end

data/lib/payoneer/version.rb

@@ -0,0 +1,3 @@
+module Payoneer
+  VERSION = "0.1.0"
+end

data/lib/payoneer.rb

@@ -0,0 +1,13 @@
+require "payoneer/version"
+require 'rest-client'
+require 'active_support'
+require 'active_support/core_ext'
+
+require 'payoneer/configuration'
+require 'payoneer/response'
+require 'payoneer/errors'
+require 'payoneer/api'
+
+module Payoneer
+  include ::Payoneer::Configuration
+end

data/lib/payoneer_ruby_sdk/version.rb

@@ -0,0 +1 @@
+require "payoneer/version"

data/lib/payoneer_ruby_sdk.rb

@@ -0,0 +1 @@
+require 'payoneer'

data/payoneer_ruby_sdk.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'payoneer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "payoneer_ruby_sdk"
+  spec.version       = Payoneer::VERSION
+  spec.authors       = ["kissrobber"]
+  spec.email         = ["kissrobber@gmail.com"]
+  spec.summary       = %q{Payoneer Ruby SDK}
+  spec.description   = %q{Payoneer Ruby SDK}
+  spec.homepage      = "https://github.com/kissrobber/payoneer_ruby_sdk"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.add_dependency 'rest-client'
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "byebug"
+
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: payoneer_ruby_sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kissrobber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: byebug
+  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'
+description: Payoneer Ruby SDK
+email:
+- kissrobber@gmail.com
+executables:
+- console
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- lib/payoneer.rb
+- lib/payoneer/api.rb
+- lib/payoneer/api/cancel_payment.rb
+- lib/payoneer/api/change_payee_id.rb
+- lib/payoneer/api/core.rb
+- lib/payoneer/api/echo.rb
+- lib/payoneer/api/get_account_details.rb
+- lib/payoneer/api/get_payee_details.rb
+- lib/payoneer/api/get_payees_report.rb
+- lib/payoneer/api/get_payment_status.rb
+- lib/payoneer/api/get_single_payee_report.rb
+- lib/payoneer/api/get_token.rb
+- lib/payoneer/api/get_token_xml.rb
+- lib/payoneer/api/get_unclaimed_payments_csv.rb
+- lib/payoneer/api/get_unclaimed_payments_xml.rb
+- lib/payoneer/api/get_version.rb
+- lib/payoneer/api/perform_payout_payment.rb
+- lib/payoneer/configuration.rb
+- lib/payoneer/errors.rb
+- lib/payoneer/errors/api_error.rb
+- lib/payoneer/errors/configuration_error.rb
+- lib/payoneer/response.rb
+- lib/payoneer/version.rb
+- lib/payoneer_ruby_sdk.rb
+- lib/payoneer_ruby_sdk/version.rb
+- payoneer_ruby_sdk.gemspec
+homepage: https://github.com/kissrobber/payoneer_ruby_sdk
+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: Payoneer Ruby SDK
+test_files: []
+has_rdoc: