payoneer-rb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6f5be0cce0d48ed1d8eb4686046eff0a6a756fbcba0e31a756cbe0c728a9640d
+  data.tar.gz: e9cb9ed894823c95fdf64680a53c11131dcee08d9e22db16c3ea2c965b262de2
+SHA512:
+  metadata.gz: caffc29dd685ba87d5e40f5832db06536416f5ad84f823284b7c143e466250091475da8889ecc73540e5c7186d614438d8647988b62afb921802d21a6402e039
+  data.tar.gz: 913bd4543b18a7d756e83ec7c1b17717e2ce51ffc947dc0be361cab4a37c2c444de7e57a11511ff3744c902dde5b443637274677ab5297a7aaecef1bfc7aa464

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## 1.0.0
+- Initial version

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Amir Zametica
+
+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,41 @@
+# Installation
+Add gem to your Gemfile and run bundle
+```ruby
+gem 'payoneer-rb'
+```
+
+# Usage
+## Configuration
+All of the following properties have to be set in order for gem to work properly
+```ruby
+# config/initializers/payoneer.rb
+
+Payoneer.configure do |c|
+  c.environment = # payoneer env (:sandbox (default) | :production)
+  c.callback_url = # callback url used for sending auth codes (Optional)
+  c.program_id = # program id
+end
+```
+
+## Examples
+
+### Create signup url
+```ruby
+Payoneer::Payee.create_link(params: { payee_id: '<payee_id>' })
+```
+
+### Create a payout
+```ruby
+Payoneer::Payout.create(
+  payment_id: '<internal_payment_ref>',
+  payee_id: '<payee_id>',
+  amount: 170.45,
+  description: '',
+  currency: 'USD'
+)
+```
+
+### Check the program balance
+```ruby
+Payoneer::Program.balance
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/payoneer/configuration.rb

@@ -0,0 +1,42 @@
+module Payoneer
+  module Configuration
+    def configure
+      yield self
+    end
+
+    ENV_URLS = {
+      sandbox: {
+        api: 'https://api.sandbox.payoneer.com/v4',
+        auth: 'https://login.sandbox.payoneer.com/api/v2/oauth2'
+      },
+      production: {
+        api: 'https://api.payoneer.com/v4',
+        auth: 'https://login.payoneer.com/api/v2/oauth2'
+      }
+    }.freeze
+
+    def self.authorize_url
+      "#{auth_url}/authorize?"\
+      "redirect_uri=#{callback_url}&"\
+      'scope=read%20write%20openid%20personal-details&'\
+      'response_type=code'
+    end
+
+    def self.api_url
+      ENV_URLS[environment][:api]
+    end
+
+    def self.auth_url
+      ENV_URLS[environment][:auth]
+    end
+
+    mattr_accessor :environment
+    @@environment = :sandbox
+
+    mattr_accessor :callback_url
+    @@callback_url = nil
+
+    mattr_accessor :program_id
+    @@program_id = nil
+  end
+end

data/lib/payoneer/error.rb

@@ -0,0 +1,12 @@
+module Payoneer
+  class Error < StandardError
+    attr_reader :description, :details, :code
+
+    def initialize(description: '', details: {}, code: 0)
+      super(description)
+      @description = description
+      @details = details
+      @code = code
+    end
+  end
+end

data/lib/payoneer/modules/account.rb

@@ -0,0 +1,22 @@
+module Payoneer
+  module Account
+    extend Payoneer::RemoteApi
+
+    def details(account_id:, **args)
+      return unless args[:access_token] && account_id
+
+      get_details(args[:access_token], account_id)
+    end
+
+    private
+
+    def get_details(access_token, account_id)
+      get(
+        path: "/accounts/#{account_id}/details",
+        options: {
+          access_token: access_token
+        }
+      )
+    end
+  end
+end

data/lib/payoneer/modules/auth.rb

@@ -0,0 +1,66 @@
+module Payoneer
+  module Auth
+    extend Payoneer::RemoteApi
+
+    def application_token(client_id:, client_secret:)
+      token(
+        body: {
+          grant_type: 'client_credentials',
+          scope: 'read write',
+          client_id: client_id,
+          client_secret: client_secret
+        }
+      )
+    end
+
+    def access_token(code:, client_id:, client_secret:)
+      token(
+        body: {
+          grant_type: 'authorization_code',
+          redirect_uri: Payoneer::Configuration.callback_url,
+          code: code,
+          client_id: client_id,
+          client_secret: client_secret
+        }
+      )
+    end
+
+    def refresh_token(refresh_token:, client_id:, client_secret:)
+      token(
+        body: {
+          grant_type: 'refresh_token',
+          refresh_token: refresh_token,
+          client_id: client_id,
+          client_secret: client_secret
+        }
+      )
+    end
+
+    def revoke_token(token:, client_id:, client_secret:)
+      token(
+        path: '/revoke',
+        body: {
+          token_type_hint: 'access_token',
+          token: token,
+          client_id: client_id,
+          client_secret: client_secret,
+        }
+      )
+    end
+
+    private
+
+    def token(body:, path: '/token')
+      post(
+        path: path,
+        body: body,
+        options: {
+          base_url: Payoneer::Configuration.auth_url,
+          headers: {
+            'Content-Type' => 'application/x-www-form-urlencoded'
+          }
+        }
+      )
+    end
+  end
+end

data/lib/payoneer/modules/payee.rb

@@ -0,0 +1,53 @@
+module Payoneer
+  module Payee
+    extend Payoneer::RemoteApi
+
+    def create_link(params: {}, **args)
+      post(
+        path: "/programs/#{Payoneer::Configuration.program_id}/payees/registration-link",
+        body: registration_params(params),
+        options: args
+      )
+    end
+
+    def status(payee_id:, **args)
+      get(
+        path: "/programs/#{Payoneer::Configuration.program_id}/payees/#{payee_id}/status",
+        options: args
+      )
+    end
+
+    def release(payee_id:, **args)
+      delete(
+        path: "/programs/#{Payoneer::Configuration.program_id}/payees/#{payee_id}",
+        options: args
+      )
+    end
+
+    def details(payee_id:, **args)
+      get(
+        path: "/programs/#{Payoneer::Configuration.program_id}/payees/#{payee_id}/details",
+        options: args
+      )
+    end
+
+    private
+
+    def registration_params(params)
+      registration_params = {
+        payee_id: params[:payee_id],
+        already_have_an_account: params[:existing] || false,
+      }
+
+      if params[:consent]
+        registration_params.merge!(
+          redirect_url: "#{Payoneer::Configuration.authorize_url}&\
+                         client_id=#{params[:client_id]}&\
+                         state=#{params[:user_id]}"
+        )
+      end
+
+      registration_params
+    end
+  end
+end

data/lib/payoneer/modules/payout.rb

@@ -0,0 +1,66 @@
+module Payoneer
+  module Payout
+    extend Payoneer::RemoteApi
+
+    def create(payment_id:, payee_id:, amount:, description:, currency: 'USD', **args)
+      submit_payout(
+        {
+          payments: [
+            {
+              client_reference_id: payment_id,
+              payee_id: payee_id,
+              amount: amount,
+              description: description,
+              currency: currency
+            }
+          ]
+        },
+        args
+      )
+    end
+
+    def status(payment_id:, **args)
+      payout_status(payment_id, args)
+    end
+
+    private
+
+    def submit_payout(params, args)
+      post(
+        path: "/programs/#{Payoneer::Configuration.program_id}/masspayouts",
+        body: params,
+        options: {
+          response_params: {
+            payment_id: params[:payments][0][:client_reference_id]
+          },
+          **args
+        }
+      )
+    end
+
+    def payout_status(payment_id, args)
+      get(
+        path: "/programs/#{Payoneer::Configuration.program_id}/payouts"\
+              "/#{payment_id}/status",
+        options: {
+          serializer: Status,
+          response_params: {
+            payment_id: payment_id
+          },
+          **args
+        }
+      )
+    rescue Payoneer::Error => e
+      Status.convert(
+        {
+          status: 'Failed',
+          payment_id: payment_id,
+          error: {
+            description: e.description,
+            reason: e.details
+          }
+        }
+      )
+    end
+  end
+end

data/lib/payoneer/modules/program.rb

@@ -0,0 +1,12 @@
+module Payoneer
+  module Program
+    extend Payoneer::RemoteApi
+
+    def balance(**args)
+      get(
+        path: "/programs/#{Payoneer::Configuration.program_id}/balance",
+        options: args
+      )
+    end
+  end
+end

data/lib/payoneer/modules/util.rb

@@ -0,0 +1,11 @@
+module Payoneer
+  module Util
+    extend self
+
+    def parse_account_id(id_token)
+      payload = id_token.split('.')[1]
+      payload_decoded = Base64.decode64(payload)
+      JSON.parse(payload_decoded)['account_id']
+    end
+  end
+end

data/lib/payoneer/remote_api.rb

@@ -0,0 +1,106 @@
+require 'httparty'
+
+module Payoneer
+  module RemoteApi
+    def self.extended(base)
+      return unless base.is_a? Module
+
+      base.extend base
+    end
+
+    def post(path:, body: {}, options: {})
+      request(
+        method: :post,
+        path: path,
+        body: body,
+        options: options
+      )
+    end
+
+    def get(path:, options: {})
+      request(
+        method: :get,
+        path: path,
+        options: options
+      )
+    end
+
+    def put(path:, body: {}, options: {})
+      request(
+        method: :put,
+        path: path,
+        body: body,
+        options: options
+      )
+    end
+
+    def delete(path:, body: {}, options: {})
+      request(
+        method: :delete,
+        path: path,
+        body: body,
+        options: options
+      )
+    end
+
+    private
+
+    def request(method:, path:, body: {}, options: {})
+      body = parse(
+        HTTParty.send(
+          method,
+          "#{options[:base_url] || Payoneer::Configuration.api_url}#{path}",
+          body: request_body(body, options),
+          headers: options[:headers] || headers(options)
+        )
+      )
+
+      convert(body['result'] || body, options)
+    rescue HTTParty::Error => e
+      raise Payoneer::Error.new(description: e.message)
+    end
+
+    def parse(response)
+      body = JSON.parse(response.body)
+
+      unless response.code == 200
+        raise Payoneer::Error.new(
+          description: body['error_description'] || 'Server Error',
+          details: body['error_details'],
+          code: response.code
+        )
+      end
+
+      body
+    end
+
+    def convert(result, options)
+      result = { result: result } unless result.is_a? Hash
+
+      serializer = if options[:serializer]&.superclass == Payoneer::Response
+                     options[:serializer]
+                   else
+                     Payoneer::Response
+                   end
+
+      result.merge!(options[:response_params]) if options[:response_params].is_a? Hash
+      serializer.convert(result)
+    end
+
+    def request_body(body, options)
+      content_type = options.stringify_keys.dig('headers', 'Content-Type')
+      return body if content_type && content_type != 'application/json'
+
+      body.to_json
+    end
+
+    def headers(options)
+      headers = {
+        'Content-Type' => 'application/json'
+      }
+
+      headers.merge!('Authorization' => "Bearer #{options[:access_token]}") if options[:access_token]
+      headers
+    end
+  end
+end

data/lib/payoneer/responses/payout/status.rb

@@ -0,0 +1,19 @@
+module Payoneer::Payout
+  class Status < Payoneer::Response
+    def rejected?
+      reason_code.present?
+    end
+
+    def cancelled?
+      status == 'Cancelled'
+    end
+
+    def success?
+      status == 'Transferred'
+    end
+
+    def pending?
+      %w[Pending Pending \Payee].include? status
+    end
+  end
+end

data/lib/payoneer/responses/response.rb

@@ -0,0 +1,39 @@
+module Payoneer
+  class Response
+    attr_reader :body
+
+    delegate :[], to: :body
+
+    def self.convert(response)
+      case response
+      when Array
+        response.map { |i| convert(i) }
+      when Hash
+        new(response)
+      else
+        response
+      end
+    end
+
+    def initialize(response = {})
+      @body = {}.with_indifferent_access
+
+      add_methods(response.keys)
+      update_attributes(response)
+    end
+
+    private
+
+    def add_methods(keys)
+      instance_eval do
+        keys.each do |k|
+          self.class.send(:define_method, k.to_s.underscore) { @body[k] }
+        end
+      end
+    end
+
+    def update_attributes(response)
+      response.each { |k, v| @body[k] = v }
+    end
+  end
+end

data/lib/payoneer/version.rb

@@ -0,0 +1,3 @@
+module Payoneer
+  VERSION = '1.0.0'
+end

data/lib/payoneer-rb.rb

@@ -0,0 +1 @@
+require "#{File.dirname(__FILE__)}/payoneer"

data/lib/payoneer.rb

@@ -0,0 +1,22 @@
+require 'active_support'
+require 'active_support/time'
+require 'active_support/core_ext/hash/indifferent_access'
+
+require 'payoneer/version'
+require 'payoneer/configuration'
+require 'payoneer/remote_api'
+require 'payoneer/error'
+
+require 'payoneer/responses/response'
+require 'payoneer/responses/payout/status'
+
+require 'payoneer/modules/account'
+require 'payoneer/modules/auth'
+require 'payoneer/modules/payee'
+require 'payoneer/modules/payout'
+require 'payoneer/modules/program'
+require 'payoneer/modules/util'
+
+module Payoneer
+  extend Configuration
+end

data/payoneer-rb.gemspec

@@ -0,0 +1,27 @@
+require File.expand_path('lib/payoneer/version', __dir__)
+
+Gem::Specification.new do |s|
+  s.name          = 'payoneer-rb'
+  s.version       = Payoneer::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.license       = 'MIT'
+  s.authors       = ['Amir Zametica']
+  s.email         = ['amirzametica@gmail.com']
+  s.description   = 'This library provides integration with Payoneer V4 API'
+  s.summary       = 'Payoneer V4 integration'
+  s.homepage      = 'https://github.com/zametica/payoneer-rb'
+
+  s.files         =  Dir.glob('{lib, spec}/**/*')
+  s.files         += %w[CHANGELOG.md LICENSE README.md]
+  s.files         += %w[Rakefile payoneer-rb.gemspec]
+
+  s.require_path = 'lib'
+
+  s.add_dependency 'httparty', '~> 0.20', '>= 0.20.0'
+  s.add_dependency 'activesupport', '>= 5.2.4'
+
+  s.add_development_dependency 'bundler', '~> 2.3.0', '>= 2.3.0'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'pry', '~> 0.14.0'
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: payoneer-rb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Amir Zametica
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: This library provides integration with Payoneer V4 API
+email:
+- amirzametica@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/payoneer-rb.rb
+- lib/payoneer.rb
+- lib/payoneer/configuration.rb
+- lib/payoneer/error.rb
+- lib/payoneer/modules/account.rb
+- lib/payoneer/modules/auth.rb
+- lib/payoneer/modules/payee.rb
+- lib/payoneer/modules/payout.rb
+- lib/payoneer/modules/program.rb
+- lib/payoneer/modules/util.rb
+- lib/payoneer/remote_api.rb
+- lib/payoneer/responses/payout/status.rb
+- lib/payoneer/responses/response.rb
+- lib/payoneer/version.rb
+- payoneer-rb.gemspec
+homepage: https://github.com/zametica/payoneer-rb
+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: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Payoneer V4 integration
+test_files: []