payoneer-client 0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3403735dba6cf4fdebc3909ea215bbc5a3c49058
+  data.tar.gz: e85cc201eee353b81693000785003e79cc31445d
+SHA512:
+  metadata.gz: bcaf96cb747a67d9952a9263257ea6c0de6d65b9890f18293f79762369bf8a911666c65b63499b28c58c9062e27465c69844ca4d3ffa9662c5209d9c928ae120
+  data.tar.gz: 2107242700e6d088bf73596310f8142a6a10635ee6a254a6af64e8cf38940ddded833a75d46a015997e1b3282867e3283a1962a29fb3e5422d3d9b0add884c63

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+/Gemfile.lock
+/.approvals
+/.bundle
+/coverage
+.DS_Store

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,38 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+
+Lint/EndAlignment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+Style/IndentationWidth:
+  Enabled: false
+Style/ElseAlignment:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Style/NumericLiterals:
+  Enabled: false
+
+# This is temporary - it can be remove after updating rubocop to the latest.
+Style/PercentLiteralDelimiters:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+gemspec
+
+group :development, :test do
+  gem 'awesome_print'
+  gem 'pry'
+  gem 'rake'
+  gem 'rubocop'
+end
+
+group :test do
+  gem 'coveralls', require: false
+  gem 'rspec'
+  gem 'webmock'
+end

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tophatter
+
+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,65 @@
+### Install
+
+```
+gem install payoneer-client
+```
+
+### Usage
+
+```ruby
+client = Payoneer::Client.new(
+  Payoneer::Configuration.new(
+    username: 'fake-username',
+    api_password: 'fake-api-password',
+    partner_id: 'fake-partner-id'
+  )
+)
+=> <Payoneer::Client @configuration=<Payoneer::Configuration @partner_id="fake-partner-id", @username="fake-username", @api_password="fake-api-password", @host="api.sandbox.payoneer.com", @auto_approve_sandbox_accounts=true>>
+
+response = client.status
+response.ok?
+=> true
+
+response.body
+=> {
+         "Status" => "000",
+    "Description" => "Echo Ok - All systems are up."
+}
+
+client.version.body
+=> {
+    "Version" => "4.15"
+}
+
+client.payee_signup_url('test').body
+=> "https://payouts.sandbox.payoneer.com/partners/lp.aspx?token=fake-token"
+
+client.payee_details('fake-payee-id').body
+=> {"FirstName"=>"Foo",
+  "LastName"=>"Bar",
+  "Email"=>"foo@bar.com",
+  "Address1"=>"123 Main Street",
+  "Address2"=>nil,
+  "City"=>"Palo Alto",
+  "State"=>"CA",
+  "Zip"=>"94306",
+  "Country"=>"US",
+  "Phone"=>"555-867-5309",
+  "Mobile"=>nil,
+  "PayeeStatus"=>"InActive",
+  "PayOutMethod"=>"Direct Deposit",
+  "RegDate"=>"12/21/2015 8:03:19 PM",
+  "PayoutMethodDetails"=>
+   {"Currency"=>"USD",
+    "Country"=>"US",
+    "BankAccountType"=>"Individual",
+    "BankName"=>"Wells Fargo",
+    "AccountName"=>"Foo Bar",
+    "AccountNumber"=>"123456789",
+    "RoutingNumber"=>"121042882",
+    "AccountType"=>"S"}}
+```
+
+### Development
+
+After checking out the repo, run `bin/payoneer-console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/bin/payoneer-console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup' # Otherwise "require 'payoneer'" won't work.
+require 'payoneer'
+require 'awesome_print'
+require 'pry'
+
+# Payoneer.logger = Logger.new(STDOUT)
+# Payoneer.logger.level = Logger::DEBUG
+
+AwesomePrint.pry!
+Pry.start

data/lib/payoneer.rb

@@ -0,0 +1,7 @@
+require 'rest-client'
+require 'active_support/core_ext/hash' # For Hash.to_xml.
+
+require File.dirname(__FILE__) + '/payoneer/configuration'
+require File.dirname(__FILE__) + '/payoneer/client'
+require File.dirname(__FILE__) + '/payoneer/response'
+require File.dirname(__FILE__) + '/payoneer/response_error'

data/lib/payoneer/client.rb

@@ -0,0 +1,74 @@
+module Payoneer
+  class Client
+    attr_reader :configuration
+
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def status
+      post('Echo')
+    end
+
+    def version
+      post('GetVersion')
+    end
+
+    def payee_signup_url(payee_id, redirect_url: nil, redirect_time: nil)
+      post('GetToken', p4: payee_id, p6: redirect_url, p8: redirect_time, p9: configuration.auto_approve_sandbox_accounts, p10: true) do |response|
+        response['Token']
+      end
+    end
+
+    def payee_details(payee_id)
+      post('GetPayeeDetails', p4: payee_id, p10: true) do |response|
+        response['CompanyDetails'].present? ? response['Payee'].merge(response['CompanyDetails']) : response['Payee']
+      end
+    end
+
+    def payout(program_id:, payment_id:, payee_id:, amount:, description:, payment_date: Time.now, currency: 'USD')
+      post(
+        'PerformPayoutPayment',
+        p4: program_id,
+        p5: payment_id,
+        p6: payee_id,
+        p7: format('%.2f', amount),
+        p8: description,
+        p9: payment_date.strftime('%m/%d/%Y %H:%M:%S'),
+        Currency: currency
+      )
+    end
+
+    def payout_details(payee_id:, payment_id:)
+      post('GetPaymentStatus', p4: payee_id, p5: payment_id)
+    end
+
+    private
+
+    def post(method_name, params = {})
+      response = RestClient.post(configuration.base_uri, {
+        mname: method_name,
+        p1: configuration.username,
+        p2: configuration.api_password,
+        p3: configuration.partner_id
+      }.merge(params))
+
+      raise ResponseError.new(code: response.code, body: response.body) if response.code != 200
+
+      # @TODO: Validate that the response is XML?
+      hash = Hash.from_xml(response.body).values.first
+
+      if hash.key?('Code')
+        Response.new(hash['Code'], hash['Description'])
+      else
+        hash = if block_given?
+          yield(hash)
+        else
+          hash
+        end
+
+        Response.new(Response::OK_STATUS_CODE, hash)
+      end
+    end
+  end
+end

data/lib/payoneer/configuration.rb

@@ -0,0 +1,25 @@
+module Payoneer
+  class Configuration
+    attr_reader :partner_id, :username, :api_password, :auto_approve_sandbox_accounts
+
+    def initialize(partner_id:, username:, api_password:, environment: 'development', auto_approve_sandbox_accounts: true)
+      @partner_id                    = partner_id
+      @username                      = username
+      @api_password                  = api_password
+      @host                          = 'api.sandbox.payoneer.com' if environment != 'production'
+      @auto_approve_sandbox_accounts = auto_approve_sandbox_accounts && environment != 'production'
+    end
+
+    def protocol
+      @protocol || 'https'
+    end
+
+    def host
+      @host || 'api.payoneer.com'
+    end
+
+    def base_uri
+      @base_uri || "#{protocol}://#{host}/Payouts/HttpApi/API.aspx"
+    end
+  end
+end

data/lib/payoneer/response.rb

@@ -0,0 +1,20 @@
+module Payoneer
+  class Response
+    OK_STATUS_CODE = '000'.freeze
+
+    attr_reader :code, :body
+
+    def initialize(code, body)
+      @code = code
+      @body = body
+    end
+
+    def ok?
+      code == OK_STATUS_CODE
+    end
+
+    def ==(other)
+      code == other.code && body == other.body
+    end
+  end
+end

data/lib/payoneer/response_error.rb

@@ -0,0 +1,10 @@
+module Payoneer
+  class ResponseError < StandardError
+    attr_reader :code, :body
+
+    def initialize(code:, body:)
+      @code = code
+      @body = body
+    end
+  end
+end

data/payoneer-client.gemspec

@@ -0,0 +1,26 @@
+# To publish the next version:
+# gem build payoneer-client.gemspec
+# gem push payoneer-client-{VERSION}.gem
+Gem::Specification.new do |s|
+  s.name        = 'payoneer-client'
+  s.version     = '0.3'
+  s.platform    = Gem::Platform::RUBY
+  s.licenses    = ['MIT']
+  s.authors     = ['Chris Estreich']
+  s.email       = ['chris@tophatter.com']
+  s.homepage    = 'https://github.com/tophatter/payoneer-api-ruby'
+  s.summary     = 'Payoneer SDK for ruby.'
+  s.description = 'Payoneer SDK for ruby.'
+
+  s.extra_rdoc_files = ['README.md']
+
+  s.required_ruby_version = '~> 2.0'
+
+  s.add_dependency 'rest-client', '~> 1.6'
+  s.add_dependency 'activesupport', '~> 4.2'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

data/spec/client_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+# rspec spec/client_spec.rb
+describe Payoneer::Client do
+  let(:response) do
+    mock = double
+    allow(mock).to receive(:code).and_return(200)
+    allow(mock).to receive(:body).and_return(xml)
+    mock
+  end
+
+  let(:endpoint) { 'https://api.payoneer.com/Payouts/HttpApi/API.aspx' }
+  let(:configuration) { Payoneer::Configuration.new(username: 'fake-username', api_password: 'fake-password', partner_id: 'fake-partner-id', environment: 'production') }
+  let(:client) { Payoneer::Client.new(configuration) }
+
+  describe '#status' do
+    context 'when the response is valid' do
+      let(:xml) { "<?xml version='1.0' encoding='ISO-8859-1' ?><PayoneerResponse><Status>000</Status><Description>Echo Ok - All systems are up.</Description></PayoneerResponse>" }
+
+      it 'returns a successful response' do
+        expect(RestClient).to receive(:post).exactly(1).times.with(endpoint, hash_including(mname: 'Echo')).and_return(response)
+        response = client.status
+        expect(response.ok?).to be_truthy
+        expect(response.body['Description']).to eq('Echo Ok - All systems are up.')
+      end
+    end
+
+    context 'when the response specifies a non-200 code' do
+      let(:xml) { "<?xml version='1.0' encoding='ISO-8859-1' ?><PayoneerResponse><Code>999</Code><Description>Echo Failure - All systems are down.</Description></PayoneerResponse>" }
+
+      it 'returns a failure response' do
+        expect(RestClient).to receive(:post).exactly(1).times.with(endpoint, hash_including(mname: 'Echo')).and_return(response)
+        response = client.status
+        expect(response.ok?).to be_falsey
+        expect(response.body).to eq('Echo Failure - All systems are down.')
+      end
+    end
+
+    context 'when the response is invalid' do
+      let(:response) do
+        mock = double
+        allow(mock).to receive(:code).and_return(500)
+        allow(mock).to receive(:body).and_return('Server Error')
+        mock
+      end
+
+      it 'raises an error' do
+        expect(RestClient).to receive(:post).exactly(1).times.with(endpoint, hash_including(mname: 'Echo')).and_return(response)
+        expect { client.status }.to raise_error(Payoneer::ResponseError)
+      end
+    end
+  end
+
+  describe '#version' do
+    let(:xml) { "<?xml version='1.0' encoding='ISO-8859-1' ?><PayoneerResponse><Version>4.15</Version></PayoneerResponse>" }
+
+    it 'generates the correct request' do
+      expect(RestClient).to receive(:post).exactly(1).times.with(endpoint, hash_including(mname: 'GetVersion')).and_return(response)
+      response = client.version
+      expect(response.ok?).to be_truthy
+      expect(response.body['Version']).to eq('4.15')
+    end
+  end
+
+  describe '#payee_signup_url' do
+    let(:xml) { '<?xml version="1.0" encoding="UTF-8" ?><PayoneerToken><Token>https://payouts.sandbox.payoneer.com/partners/lp.aspx?token=fake-token</Token></PayoneerToken>' }
+
+    it 'generates the correct request' do
+      expect(RestClient).to receive(:post).exactly(1).times.with(endpoint, hash_including(mname: 'GetToken')).and_return(response)
+      response = client.payee_signup_url('test')
+      expect(response.ok?).to be_truthy
+      expect(response.body).to eq('https://payouts.sandbox.payoneer.com/partners/lp.aspx?token=fake-token')
+    end
+  end
+
+  describe '#payee_details' do
+    let(:xml) { '<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?><GetPayeeDetails><Payee><FirstName>Foo</FirstName><LastName>Bar</LastName><Email>foo@bar.com</Email><Address1>185 Berry Street</Address1><Address2>Suite 2400</Address2><City>San Francisco</City><State>CA</State><Zip>94107</Zip><Country>US</Country><Phone></Phone><Mobile>15552223333</Mobile><PayeeStatus>Active</PayeeStatus><PayOutMethod>Prepaid Card</PayOutMethod><Cards><Card><CardID>123456789</CardID><Currency>USD</Currency><ActivationStatus>Card Issued, Not Activated</ActivationStatus><CardShipDate>11/25/2015</CardShipDate><CardStatus>Active</CardStatus></Card></Cards><RegDate>10/9/2017 7:58:44 PM</RegDate></Payee><CompanyDetails><CompanyName></CompanyName></CompanyDetails></GetPayeeDetails>' }
+
+    it 'generates the correct request' do
+      expect(RestClient).to receive(:post).exactly(1).times.with(endpoint, hash_including(mname: 'GetPayeeDetails')).and_return(response)
+      response = client.payee_details('fake-payee-id')
+      expect(response.ok?).to be_truthy
+      expect(response.body).to include('FirstName' => 'Foo', 'LastName' => 'Bar')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'payoneer'
+require 'awesome_print'
+
+gemspec = Gem::Specification.find_by_name('payoneer')
+Dir["#{gemspec.gem_dir}/spec/support/**/*.rb"].each { |f| require f }

data/spec/support/webmock.rb

@@ -0,0 +1,3 @@
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!(allow_localhost: true)

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: payoneer-client
+version: !ruby/object:Gem::Version
+  version: '0.3'
+platform: ruby
+authors:
+- Chris Estreich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Payoneer SDK for ruby.
+email:
+- chris@tophatter.com
+executables:
+- payoneer-console
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/payoneer-console
+- lib/payoneer.rb
+- lib/payoneer/client.rb
+- lib/payoneer/configuration.rb
+- lib/payoneer/response.rb
+- lib/payoneer/response_error.rb
+- payoneer-client.gemspec
+- spec/client_spec.rb
+- spec/spec_helper.rb
+- spec/support/webmock.rb
+homepage: https://github.com/tophatter/payoneer-api-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Payoneer SDK for ruby.
+test_files:
+- spec/client_spec.rb
+- spec/spec_helper.rb
+- spec/support/webmock.rb