payoneer_api 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33e43fd7651b0a58cdd851610958734328104830
-  data.tar.gz: d7ae4ae60dd310df87921b0f0c083ebdcd3443e4
+  metadata.gz: ef5defb10e6a13b020c469cff3a96da579859bc2
+  data.tar.gz: e0f6421510031fb627bb75582bf28e01115d4b0d
 SHA512:
-  metadata.gz: 20b193951555db211b5ecd9896e060cc14c02ac175efaedb1fa4fe8e68aa250273b904a7096176de67c29c8fffdd7ab63a852006d2b2a7fedc0658300d9a9c6c
-  data.tar.gz: 6cdef89c4d3669568b7d948a6d9a2ce7c002e407d8adc323e727bab81246cb2c33a07c445e7f90d293330bdd17eaf692b5e789b4032e77138c45c2241cb691d7
+  metadata.gz: 5a9f441a4b18ecba8b8470875f1b409d2d4b8bbbf3a4330fc88ebb2b10a7ce65f915dfeae9818720bc48386a53d985a8d65b7ff3891c2bff669598540e6f3d06
+  data.tar.gz: 79e919905afac856e721d32e23b470cae9597a5fa9a83686f022f59e3bfb9b73c034bb7a47bbbc3315e97005b76adf7248dfa40401b24ba33e451117f5674054

data/lib/payoneer_api.rb

@@ -1,7 +1,19 @@
 require 'net/http'
 require 'net/https'
 
+require 'active_support/core_ext/hash/slice'
+require 'active_support/core_ext/hash/conversions'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/concern'
 require 'payoneer_api/core_ext/hash'
 
+require 'payoneer_api/base'
+require 'payoneer_api/utils'
 require 'payoneer_api/payoneer_exception'
 require 'payoneer_api/client'
+require 'payoneer_api/request'
+require 'payoneer_api/response'
+require 'payoneer_api/api'
+require 'payoneer_api/payee'
+require 'payoneer_api/payoneer_token'
+

data/lib/payoneer_api/api.rb

@@ -0,0 +1,9 @@
+require 'payoneer_api/api/payees'
+
+module PayoneerApi
+  module API
+    extend ActiveSupport::Concern
+
+    include PayoneerApi::API::Payees
+  end
+end

data/lib/payoneer_api/api/payees.rb

@@ -0,0 +1,99 @@
+require 'payoneer_api/utils'
+require 'payoneer_api/payee'
+
+module PayoneerApi
+  module API
+    module Payees
+      extend ActiveSupport::Concern
+      include PayoneerApi::Utils
+
+      module ClassMethods
+        def payee_signup_url(member_name, options = {})
+          new(options).payee_signup_url(member_name)
+        end
+
+        def payee_prefilled_signup_url(member_name, options = {})
+          attributes = options.slice!(:partner_id, :username, :password)
+          new(options).payee_prefilled_signup_url(member_name, attributes)
+        end
+
+        def payee_details(payee_id, options = {})
+          new(options).payee_details(payee_id)
+        end
+      end
+
+      def payee_signup_url(payee_id, attributes = {})
+        perform_with_object :get,
+          payee_signup_args(attributes.merge(payee_id: payee_id)),
+          PayoneerApi::PayoneerToken
+      end
+
+      def payee_prefilled_signup_url(payee_id, attributes = {})
+        perform_with_object :post,
+          payee_prefilled_signup_args(attributes.merge(payee_id: payee_id)),
+          PayoneerApi::PayoneerToken
+      end
+
+      def payee_details(payee_id)
+        perform_with_object :get,
+          payee_request_args('GetPayeeDetails', payee_id),
+          PayoneerApi::Payee
+      end
+
+      protected
+
+      def payee_request_args(method_name, member_name)
+        request_args(method_name).merge(p4: member_name)
+      end
+
+      def payee_signup_args(args)
+        payee_request_args('GetToken', args[:payee_id]).merge(
+          p5: args[:session_id],
+          p6: args[:redirect_url],
+          p8: args[:redirect_time],
+          p9: bool_to_string(args[:test_card]),
+          p10: 'True',
+          p11: payout_methods_list(args[:payout_methods]),
+          p12: args[:registration_mode],
+          p13: bool_to_string(args[:hold_approval])
+        ).delete_blank
+      end
+
+      def payee_prefilled_signup_args(args)
+        builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+          xml.PayoneerDetails do
+            xml.Details do
+              xml.userName @username
+              xml.password @password
+              xml.prid @partner_id
+              xml.apuid args[:payee_id]
+              xml.sessionid args[:session_id] if args[:session_id]
+              xml.redirect args[:redirect_url] if args[:redirect_url]
+              xml.redirectTime args[:redirect_time] if args[:redirect_time]
+              xml.cardType args[:card_type] if args[:card_type]
+              xml.BlockType args[:block_type] if args[:block_type]
+              xml.PayoutMethodList payout_methods_list(args[:payout_methods]) if args[:payout_methods]
+              xml.regMode args[:registration_mode] if args[:registration_mode]
+              xml.holdApproval bool_to_string(args[:hold_approval]) if args[:hold_approval]
+            end
+            xml.PersonalDetails do
+              xml.firstName args[:first_name] if args[:first_name]
+              xml.lastName args[:last_name] if args[:last_name]
+              xml.dateOfBirth args[:date_of_birth] if args[:date_of_birth]
+              xml.address1 args[:address].is_a?(Array) ? args[:address].first : args[:address]
+              xml.address2 args[:address].last if args[:address].is_a?(Array)
+              xml.city args[:city] if args[:city]
+              xml.country args[:country_code] if args[:country_code]
+              xml.state args[:state_code] if args[:state_code]
+              xml.zipCode args[:zip_code] if args[:zip_code]
+              xml.mobile args[:mobile_phone] if args[:mobile_phone]
+              xml.phone args[:phone] if args[:phone]
+              xml.email args[:email] if args[:email]
+            end
+          end
+        end
+        payee_request_args('GetTokenXML', args[:payee_id]).merge(xml: builder.to_xml)
+      end
+    end
+  end
+end

data/lib/payoneer_api/base.rb

@@ -0,0 +1,17 @@
+module PayoneerApi
+  class Base
+    attr_reader :attrs
+
+    # Initializes a new object
+    #
+    # @param attrs [Hash]
+    # @return [PayoneerApi::Base]
+    def initialize(attrs = {})
+      @attrs = attrs.deep_find(self.class.to_s.demodulize) if attrs.is_a?(Hash)
+      @attrs ||= attrs
+      @attrs.each do |k, v|
+        instance_variable_set("@#{k.to_s.underscore}", v) unless v.nil?
+      end
+    end
+  end
+end

data/lib/payoneer_api/client.rb

@@ -1,18 +1,15 @@
+require 'payoneer_api/utils'
+require 'payoneer_api/api'
+
 module PayoneerApi
   class Client
+    include PayoneerApi::Utils
+    include PayoneerApi::API
+
     SANDBOX_API_URL = 'https://api.sandbox.payoneer.com/Payouts/HttpApi/API.aspx?'
     PRODUCTION_API_URL = 'https://api.payoneer.com/payouts/HttpAPI/API.aspx?'
     API_PORT = '443'
 
-    def self.new_payee_signup_url(member_name, options = {})
-      new(options).payee_signup_url(member_name)
-    end
-
-    def self.new_payee_prefilled_signup_url(member_name, options = {})
-      attributes = options.slice!(:partner_id, :username, :password)
-      new(options).payee_prefilled_signup_url(member_name, attributes)
-    end
-
     def initialize(options = {})
       @partner_id, @username, @password = options[:partner_id], options[:username], options[:password]
       @partner_id ||= ENV['PAYONEER_PARTNER_ID']
@@ -26,43 +23,8 @@ module PayoneerApi
       @environment ||= 'sandbox'
     end
 
-    def payee_signup_url(member_name)
-      response = get_api_call(payee_link_args(payee_id: member_name))
-      api_result(response)
-    end
-
-    def payee_prefilled_signup_url(member_name, attributes = {})
-      response = post_api_call(payee_prefill_args(attributes.merge(payee_id: member_name)))
-      xml_api_result(response)
-    end
-
     private
 
-    def api_result(response)
-      if response.code == '200'
-        return response.body
-      else
-        raise PayoneerException, api_error_description(response)
-      end
-    end
-
-    def xml_api_result(response)
-      if response.code == '200'
-        result = Nokogiri::XML.parse(response.body)
-        token = result.css('PayoneerToken Token').first
-        return token.text if token
-      end
-      raise PayoneerException, api_error_description(response)
-    end
-
-    def api_error_description(response)
-      return unless response and response.body
-      result = Nokogiri::XML.parse(response.body)
-      error_message = result.css('PayoneerResponse Description').first
-      return error_message if error_message
-      result.to_s
-    end
-
     def get_api_call(args_hash)
       uri = URI.parse(api_url)
       uri.query = URI.encode_www_form(args_hash)
@@ -83,66 +45,15 @@ module PayoneerApi
       http.request(request)
     end
 
-    def payee_link_args(args)
+    def request_args(method_name)
       {
-        mname: 'GetToken',
+        mname: method_name.to_s.camelize,
         p1: @username,
         p2: @password,
         p3: @partner_id,
-        p4: args[:payee_id],
-        p5: args[:session_id],
-      }.delete_if { |_, value| value.nil? || value.empty? }
-    end
-
-    def payee_prefill_args(args)
-      {
-        mname: 'GetTokenXML',
-        p1: @username,
-        p2: @password,
-        p3: @partner_id,
-        p4: args[:payee_id],
-        xml: prefill_xml_data(args)
       }
     end
 
-    def prefill_xml_data(args)
-      builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
-        xml.PayoneerDetails do
-          xml.Details do
-            xml.userName @username
-            xml.password @password
-            xml.prid @partner_id
-            xml.apuid args[:payee_id]
-            xml.sessionid args[:session_id] if args[:session_id]
-            xml.redirect args[:redirect_url] if args[:redirect_url]
-            xml.redirectTime args[:redirect_time] if args[:redirect_time]
-            xml.cardType args[:card_type] if args[:card_type]
-            xml.BlockType args[:block_type] if args[:block_type]
-            xml.PayoutMethodList (args[:payout_methods].is_a?(Array) ?
-              args[:payout_methods].join(',') :
-              args[:payout_methods]) if args[:payout_methods]
-            xml.regMode args[:registration_mode] if args[:registration_mode]
-            xml.holdApproval args[:hold_approval] if args[:hold_approval]
-          end
-          xml.PersonalDetails do
-            xml.firstName args[:first_name] if args[:first_name]
-            xml.lastName args[:last_name] if args[:last_name]
-            xml.dateOfBirth args[:date_of_birth] if args[:date_of_birth]
-            xml.address1 args[:address].is_a?(Array) ? args[:address].first : args[:address]
-            xml.address2 args[:address].last if args[:address].is_a?(Array)
-            xml.city args[:city] if args[:city]
-            xml.country args[:country_code] if args[:country_code]
-            xml.state args[:state_code] if args[:state_code]
-            xml.zipCode args[:zip_code] if args[:zip_code]
-            xml.mobile args[:mobile_phone] if args[:mobile_phone]
-            xml.phone args[:phone] if args[:phone]
-            xml.email args[:email] if args[:email]
-          end
-        end
-      end
-      builder.to_xml#.tap { |x| puts x.to_s if sandbox? }
-    end
-
     def api_url
       sandbox? ? SANDBOX_API_URL : PRODUCTION_API_URL
     end

data/lib/payoneer_api/core_ext/hash.rb

@@ -1,44 +1,9 @@
-# Taken from activesupport
-
 class Hash
-  # Slice a hash to include only the given keys. This is useful for
-  # limiting an options hash to valid keys before passing to a method:
-  #
-  #   def search(criteria = {})
-  #     criteria.assert_valid_keys(:mass, :velocity, :time)
-  #   end
-  #
-  #   search(options.slice(:mass, :velocity, :time))
-  #
-  # If you have an array of keys you want to limit to, you should splat them:
-  #
-  #   valid_keys = [:mass, :velocity, :time]
-  #   search(options.slice(*valid_keys))
-  def slice(*keys)
-    keys.map! { |key| convert_key(key) } if respond_to?(:convert_key, true)
-    keys.each_with_object(self.class.new) { |k, hash| hash[k] = self[k] if has_key?(k) }
-  end
-
-  # Replaces the hash with only the given keys.
-  # Returns a hash containing the removed key/value pairs.
-  #
-  #   { a: 1, b: 2, c: 3, d: 4 }.slice!(:a, :b)
-  #   # => {:c=>3, :d=>4}
-  def slice!(*keys)
-    keys.map! { |key| convert_key(key) } if respond_to?(:convert_key, true)
-    omit = slice(*self.keys - keys)
-    hash = slice(*keys)
-    hash.default      = default
-    hash.default_proc = default_proc if default_proc
-    replace(hash)
-    omit
+  def delete_blank
+    delete_if{|k, v| v.nil? or (v.respond_to?(:empty?) && v.empty?) or (v.instance_of?(Hash) && v.delete_blank.empty?)}
   end
 
-  # Removes and returns the key/value pairs matching the given keys.
-  #
-  #   { a: 1, b: 2, c: 3, d: 4 }.extract!(:a, :b) # => {:a=>1, :b=>2}
-  #   { a: 1, b: 2 }.extract!(:a, :x)             # => {:a=>1}
-  def extract!(*keys)
-    keys.each_with_object(self.class.new) { |key, result| result[key] = delete(key) if has_key?(key) }
+  def deep_find(key)
+    key?(key) ? self[key] : self.values.inject(nil) {|memo, v| memo ||= v.deep_find(key) if v.respond_to?(:deep_find) }
   end
 end

data/lib/payoneer_api/payee.rb

@@ -0,0 +1,34 @@
+module PayoneerApi
+  class Payee < PayoneerApi::Base
+    attr_reader :first_name, :last_name, :address1, :address2, :city, :state, :zip, :country, :email, :phone,
+      :mobile, :pay_out_method, :payee_status, :reg_date, :cards,
+      :card_id, :card_activation_status, :card_ship_date, :card_status
+
+    def initialize(attrs = {})
+      super
+      initialize_card_attrs if card?
+    end
+
+    def card?
+      pay_out_method == 'Prepaid Card'
+    end
+
+    def direct_deposit?
+      pay_out_method == 'Direct deposit'
+    end
+
+    def iach?
+      pay_out_method == 'iACH'
+    end
+
+    private
+
+    def initialize_card_attrs
+      card_data = @attrs.fetch('Cards', {}).fetch('Card', {})
+      @card_id = card_data['CardID']
+      @card_activation_status = card_data['ActivationStatus']
+      @card_ship_date = card_data['CardShipDate']
+      @card_status = card_data['CardStatus']
+    end
+  end
+end

data/lib/payoneer_api/payoneer_response.rb

@@ -0,0 +1,5 @@
+module PayoneerApi
+  class PayoneerResponse < PayoneerApi::Base
+    attr_reader :status, :description, :version, :result
+  end
+end

data/lib/payoneer_api/payoneer_token.rb

@@ -0,0 +1,18 @@
+module PayoneerApi
+  class PayoneerToken < PayoneerApi::Base
+    attr_reader :token
+
+    def initialize(attrs = {})
+      super
+      raise PayoneerException, attrs unless token
+    end
+
+    def uri
+      URI.parse(token)
+    end
+
+    def to_s
+      uri.to_s
+    end
+  end
+end

data/lib/payoneer_api/request.rb

@@ -0,0 +1,27 @@
+module PayoneerApi
+  class Request
+    attr_accessor :client, :request_method, :options
+
+    # @param client [PayoneerApi::Client]
+    # @param request_method [String, Symbol]
+    # @param options [Hash]
+    # @return [PayoneerApi::Request]
+    def initialize(client, request_method, options = {})
+      @client = client
+      @request_method = request_method.to_sym
+      @options = options
+    end
+
+    # @return [Hash]
+    def perform
+      PayoneerApi::Response.new(@client.send("#{@request_method.to_s}_api_call".to_sym, @options)).body
+    end
+
+    # @param klass [Class]
+    # @param request [PayoneerApi::Request]
+    # @return [Object]
+    def perform_with_object(klass)
+      klass.new(perform)
+    end
+  end
+end

data/lib/payoneer_api/response.rb

@@ -0,0 +1,37 @@
+module PayoneerApi
+  class Response
+    def initialize(response)
+      @response = response
+      raise PayoneerException, api_error_description if @response.code != '200'
+      check_for_errors
+    end
+
+    def body
+      xml?(@response.body) ? Hash.from_xml(@response.body) : @response.body
+    end
+
+    def xml_body
+      @xml_body ||= Nokogiri::XML.parse(@response.body)
+    end
+
+    def xml?(text)
+      !Nokogiri::XML.parse(text).errors.any?
+    end
+
+    private
+
+    def api_error_description
+      return unless @response and @response.body
+      result = xml_body
+      error_message = result.css('PayoneerResponse Description').first
+      return error_message.text if error_message
+      result.to_s
+    end
+
+    def check_for_errors
+      if (result = xml_body.css('PayoneerResponse Result').first) && result.text == 'A00B556F'
+        raise PayoneerException, api_error_description
+      end
+    end
+  end
+end