payoneer-client 0.3 → 0.4

checksums.yaml

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

data/.gitignore

@@ -4,3 +4,4 @@
 /.bundle
 /coverage
 .DS_Store
+.idea

data/.rubocop.yml

@@ -24,6 +24,8 @@ Lint/EndAlignment:
 
 Style/Documentation:
   Enabled: false
+Style/FormatStringToken:
+  Enabled: false
 Style/IndentationWidth:
   Enabled: false
 Style/ElseAlignment:

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+ - 2.2
+# branches:
+#   only:
+#     - master
+script:
+  - bundle exec rubocop
+  - bundle exec rake
+cache: bundler

data/README.md

@@ -1,10 +1,15 @@
-### Install
+[![Build Status](https://travis-ci.org/tophatter/payoneer-api-ruby.svg?branch=master)](https://travis-ci.org/tophatter/payoneer-api-ruby)
+[![Coverage Status](https://coveralls.io/repos/github/tophatter/payoneer-api-ruby/badge.svg?branch=master)](https://coveralls.io/github/tophatter/payoneer-api-ruby?branch=master)
+
+### Payoneer SDK for Ruby:
+
+#### Install:
 
 ```
 gem install payoneer-client
 ```
 
-### Usage
+#### Usage:
 
 ```ruby
 client = Payoneer::Client.new(
@@ -58,8 +63,59 @@ client.payee_details('fake-payee-id').body
     "AccountNumber"=>"123456789",
     "RoutingNumber"=>"121042882",
     "AccountType"=>"S"}}
+    
+```
+
+##### Performing a normal payout:
+```ruby
+response = client.payout(
+  program_id: 'fake-partner-id',
+  payment_id: 43,
+  amount: 100.0,
+  payee_id: 42,
+  description: "Foo Bar's order"
+)
+
+response.body
+=> {
+    "Description" => "",
+      "PaymentID" => "1234",
+         "Status" => "000",
+     "PayoneerID" => "42"
+}
+````
+
+##### Performing a payout with expanded params:
+If the orders type is `"url"`, `credentials` must be a dictionary containing one of the following:
+- `type: "AUTHORIZATION"` with a required `token` field
+- `type: "PASSWORD"` with required `user_name` and `password` fields
+```ruby
+response = client.expanded_payout(
+  payee_id: 42,
+  client_reference_id: 43,
+  amount: 100.0, 
+  currency: 'USD',
+  description: "Foo Bar's order",
+  seller_id: 44, 
+  seller_name: "Foo Bar", 
+  seller_url: "foo@bar.com", 
+  seller_type: 'ECOMMERCE', 
+  path: 'orders@path.com', 
+  credentials: { type: 'AUTHORIZATION', token: 'fake_token'}
+)
+
+response.body
+=> {
+       "audit_id" => 123456789,
+           "code" => 0,
+    "description" => "Success",
+      "payout_id" => "1234",
+         "amount" => 100.0,
+       "currency" => "USD",
+      "PaymentID" => "1234"
+}
 ```
 
-### Development
+#### Console:
 
-After checking out the repo, run `bin/payoneer-console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/payoneer-console` for an interactive console that will allow you to experiment.

data/lib/payoneer/client.rb

@@ -39,6 +39,47 @@ module Payoneer
       )
     end
 
+    # Includes additional items as needed to be Payoneer SAFE compliant
+    def expanded_payout(payee_id:, client_reference_id:, amount:, currency:, description:, payout_date: Time.now, seller_id:, seller_name:, seller_url:, seller_type: 'ECOMMERCE', orders_type: 'url', path:, credentials:)
+      params = {
+        payee_id: payee_id,
+        client_reference_id: client_reference_id,
+        amount: amount,
+        currency: currency,
+        description: description,
+        payout_date: payout_date.strftime('%Y-%m-%d'),
+        orders_report: {
+          merchant: {
+            id: seller_id,
+            store: {
+              name: seller_name,
+              url: seller_url,
+              type: seller_type
+            }
+          },
+          orders: {
+            type: orders_type,
+            path: path,
+            credentials: credentials
+          }
+        }
+      }
+
+      encoded_credentials = 'Basic ' + Base64.encode64("#{configuration.username}:#{configuration.api_password}").chomp
+      response = RestClient.post "#{configuration.json_base_uri}/payouts", params.to_json, content_type: 'application/json', accept: :json, Authorization: encoded_credentials
+      raise ResponseError.new(code: response.code, body: response.body) if response.code != 200
+
+      hash = JSON.parse(response.body)
+      hash['PaymentID'] = hash['payout_id'] # Keep consistent with the normal payout response body
+
+      if hash.key?('Code')
+        Response.new(hash['Code'], hash['Description'])
+      else
+        hash = block_given? ? yield(hash) : hash
+        Response.new(Response::OK_STATUS_CODE, hash)
+      end
+    end
+
     def payout_details(payee_id:, payment_id:)
       post('GetPaymentStatus', p4: payee_id, p5: payment_id)
     end
@@ -46,7 +87,7 @@ module Payoneer
     private
 
     def post(method_name, params = {})
-      response = RestClient.post(configuration.base_uri, {
+      response = RestClient.post(configuration.xml_base_uri, {
         mname: method_name,
         p1: configuration.username,
         p2: configuration.api_password,
@@ -61,12 +102,7 @@ module Payoneer
       if hash.key?('Code')
         Response.new(hash['Code'], hash['Description'])
       else
-        hash = if block_given?
-          yield(hash)
-        else
-          hash
-        end
-
+        hash = block_given? ? yield(hash) : hash
         Response.new(Response::OK_STATUS_CODE, hash)
       end
     end

data/lib/payoneer/configuration.rb

@@ -18,8 +18,12 @@ module Payoneer
       @host || 'api.payoneer.com'
     end
 
-    def base_uri
-      @base_uri || "#{protocol}://#{host}/Payouts/HttpApi/API.aspx"
+    def xml_base_uri
+      @xml_base_uri || "#{protocol}://#{host}/Payouts/HttpApi/API.aspx"
+    end
+
+    def json_base_uri
+      @json_base_uri || "#{protocol}://#{host}/v2/programs/#{@partner_id}"
     end
   end
 end

data/lib/payoneer/response.rb

@@ -12,9 +12,5 @@ module Payoneer
     def ok?
       code == OK_STATUS_CODE
     end
-
-    def ==(other)
-      code == other.code && body == other.body
-    end
   end
 end

data/payoneer-client.gemspec

@@ -3,7 +3,7 @@
 # gem push payoneer-client-{VERSION}.gem
 Gem::Specification.new do |s|
   s.name        = 'payoneer-client'
-  s.version     = '0.3'
+  s.version     = '0.4'
   s.platform    = Gem::Platform::RUBY
   s.licenses    = ['MIT']
   s.authors     = ['Chris Estreich']
@@ -14,10 +14,10 @@ Gem::Specification.new do |s|
 
   s.extra_rdoc_files = ['README.md']
 
-  s.required_ruby_version = '~> 2.0'
+  s.required_ruby_version = '~> 2.2'
 
-  s.add_dependency 'rest-client', '~> 1.6'
   s.add_dependency 'activesupport', '~> 4.2'
+  s.add_dependency 'rest-client', '~> 1.6'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/client_spec.rb

@@ -83,4 +83,59 @@ describe Payoneer::Client do
       expect(response.body).to include('FirstName' => 'Foo', 'LastName' => 'Bar')
     end
   end
+
+  describe '#expanded_payout' do
+    let(:payee_id) { 42 }
+    let(:client_reference_id) { 43 }
+    let(:amount) { 100 }
+    let(:currency) { 'USD' }
+    let(:description) { (Time.now - 10.days).strftime('%Y-%m-%d') }
+    let(:seller_id) { 44 }
+    let(:seller_name) { 'Fake Seller' }
+    let(:seller_url) { 'http://tophatter.dev/users/1' }
+    let(:path) { 'fake_s3@path.com' }
+    let(:credentials) { { type: 'AUTHORIZATION', token: 'fake' } }
+    let(:endpoint) { "#{configuration.json_base_uri}/payouts" }
+    let(:headers) { { content_type: 'application/json', accept: :json, Authorization: 'Basic ' + Base64.encode64("#{configuration.username}:#{configuration.api_password}").chomp } }
+    let(:response) do
+      mock = double
+      allow(mock).to receive(:code).and_return(200)
+      allow(mock).to receive(:body).and_return(params.to_json)
+      mock
+    end
+
+    let(:params) do
+      { payee_id: payee_id,
+        client_reference_id: client_reference_id,
+        amount: amount,
+        currency: 'USD',
+        description: description,
+        payout_date: Time.now.strftime('%Y-%m-%d'),
+        orders_report: {
+          merchant: {
+            id: seller_id,
+            store: {
+              name: seller_name,
+              url: seller_url,
+              type: 'ECOMMERCE'
+            }
+          },
+          orders: {
+            type: 'url',
+            path: path,
+            credentials: credentials
+          }
+        } }
+    end
+
+    it 'generates the correct response' do
+      expect(RestClient).to receive(:post).exactly(1).times.with(endpoint, params.to_json, headers).and_return(response)
+      response = client.expanded_payout(payee_id: payee_id, client_reference_id: client_reference_id, amount: amount, description: description, currency: currency, seller_id: seller_id, seller_name: seller_name, seller_url: seller_url, path: path, credentials: credentials)
+      expect(response.ok?).to be_truthy
+      expect(response.body).to include('payee_id' => payee_id, 'amount' => amount)
+      expect(response.body).to include('orders_report')
+      expect(response.body['orders_report']).to include('orders')
+      expect(response.body['orders_report']['orders']).to include('path' => path)
+    end
+  end
 end

data/spec/spec_helper.rb

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

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: payoneer-client
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
 platform: ruby
 authors:
 - Chris Estreich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-10 00:00:00.000000000 Z
+date: 2018-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '1.6'
 description: Payoneer SDK for ruby.
 email:
 - chris@tophatter.com
@@ -51,6 +51,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE.md
 - README.md
@@ -77,7 +78,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -85,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Payoneer SDK for ruby.