payoneer_api 0.1.0 → 1.0.0

data/spec/fixtures/vcr_cassettes/PayoneerApi_Client/_new_payee_prefilled_signup_url/returns_a_url_to_the_prefilled_registration_page.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: https://api.sandbox.payoneer.com/Payouts/HttpApi/API.aspx
     body:
       encoding: US-ASCII
-      string: mname=GetTokenXML&p1=Room5620&p2=12Gauh3uSe&p3=100035620&p4=1&xml=%3C%3Fxml+version%3D%221.0%22+encoding%3D%22UTF-8%22%3F%3E%0A%3CPayoneerDetails%3E%0A++%3CDetails%3E%0A++++%3CuserName%3ERoom5620%3C%2FuserName%3E%0A++++%3Cpassword%3E12Gauh3uSe%3C%2Fpassword%3E%0A++++%3Cprid%3E100035620%3C%2Fprid%3E%0A++++%3Capuid%3E1%3C%2Fapuid%3E%0A++%3C%2FDetails%3E%0A++%3CPersonalDetails%3E%0A++++%3Caddress1%2F%3E%0A++%3C%2FPersonalDetails%3E%0A%3C%2FPayoneerDetails%3E%0A
+      string: mname=GetTokenXML&p1=<PAYONEER_USERNAME>&p2=<PAYONEER_PASSWORD>&p3=<PAYONEER_PARTNER_ID>&p4=1&xml=%3C%3Fxml+version%3D%221.0%22+encoding%3D%22UTF-8%22%3F%3E%0A%3CPayoneerDetails%3E%0A++%3CDetails%3E%0A++++%3CuserName%3E<PAYONEER_USERNAME>%3C%2FuserName%3E%0A++++%3Cpassword%3E<PAYONEER_PASSWORD>%3C%2Fpassword%3E%0A++++%3Cprid%3E<PAYONEER_PARTNER_ID>%3C%2Fprid%3E%0A++++%3Capuid%3E1%3C%2Fapuid%3E%0A++%3C%2FDetails%3E%0A++%3CPersonalDetails%3E%0A++++%3Caddress1%2F%3E%0A++%3C%2FPersonalDetails%3E%0A%3C%2FPayoneerDetails%3E%0A
     headers:
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
@@ -29,16 +29,16 @@ http_interactions:
       Expires:
       - '-1'
       Set-Cookie:
-      - ASP.NET_SessionId=xrr5vet2zjf1nh330dbhx2y1; domain=.sandbox.payoneer.com;
+      - ASP.NET_SessionId=qhhjerg0ugvkzex5fxmmfe3n; domain=.sandbox.payoneer.com;
         path=/; secure; HttpOnly
-      - pid=100035620; domain=.sandbox.payoneer.com; expires=Fri, 01-May-2015 05:52:51
+      - pid=<PAYONEER_PARTNER_ID>; domain=.sandbox.payoneer.com; expires=Fri, 01-May-2015 08:54:06
         GMT; path=/; secure
       P3p:
       - CP="IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT"
       X-Powered-By:
       - ASP.NET
       Date:
-      - Fri, 02 May 2014 05:52:52 GMT
+      - Fri, 02 May 2014 08:54:06 GMT
       Content-Length:
       - '185'
       Connection:
@@ -47,5 +47,5 @@ http_interactions:
       encoding: UTF-8
       string: <?xml version="1.0" encoding="UTF-8"?><PayoneerToken><Token>http://payouts.sandbox.payoneer.com/partners/lp.aspx?token=b8e8eab41931475cb4b66b54996a7cb1A9A9579049</Token></PayoneerToken>
     http_version: 
-  recorded_at: Fri, 02 May 2014 05:52:50 GMT
+  recorded_at: Fri, 02 May 2014 08:54:03 GMT
 recorded_with: VCR 2.9.0

data/spec/fixtures/vcr_cassettes/PayoneerApi_Client/_new_payee_signup_url/returns_a_url_to_the_registration_page_implicit_credentials_through_environment_variables_.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.sandbox.payoneer.com/Payouts/HttpApi/API.aspx?mname=GetToken&p1=Room5620&p2=12Gauh3uSe&p3=100035620&p4=1
+    uri: https://api.sandbox.payoneer.com/Payouts/HttpApi/API.aspx?mname=GetToken&p1=<PAYONEER_USERNAME>&p10=True&p2=<PAYONEER_PASSWORD>&p3=<PAYONEER_PARTNER_ID>&p4=1
     body:
       encoding: US-ASCII
       string: ''
@@ -27,23 +27,23 @@ http_interactions:
       Expires:
       - '-1'
       Set-Cookie:
-      - ASP.NET_SessionId=vswidgodnjjgszj1rybaxt5d; domain=.sandbox.payoneer.com;
+      - ASP.NET_SessionId=y5xefqow1tkcowwnuehbmbaf; domain=.sandbox.payoneer.com;
         path=/; secure; HttpOnly
-      - pid=100035620; domain=.sandbox.payoneer.com; expires=Fri, 01-May-2015 05:52:43
+      - pid=<PAYONEER_PARTNER_ID>; domain=.sandbox.payoneer.com; expires=Fri, 01-May-2015 11:01:07
         GMT; path=/; secure
       P3p:
       - CP="IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT"
       X-Powered-By:
       - ASP.NET
       Date:
-      - Fri, 02 May 2014 05:52:49 GMT
+      - Fri, 02 May 2014 11:01:14 GMT
       Content-Length:
-      - '101'
+      - '186'
       Connection:
       - Keep-Alive
     body:
       encoding: UTF-8
-      string: http://payouts.sandbox.payoneer.com/partners/lp.aspx?token=b8e8eab41931475cb4b66b54996a7cb1A9A9579049
+      string: <?xml version="1.0" encoding="UTF-8" ?><PayoneerToken><Token>http://payouts.sandbox.payoneer.com/partners/lp.aspx?token=b8e8eab41931475cb4b66b54996a7cb1A9A9579049</Token></PayoneerToken>
     http_version: 
-  recorded_at: Fri, 02 May 2014 05:52:48 GMT
+  recorded_at: Fri, 02 May 2014 11:01:10 GMT
 recorded_with: VCR 2.9.0

data/spec/payoneer_api/api/payees_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe PayoneerApi::API::Payees do
+  let(:client) { PayoneerApi::Client.new }
+
+  describe '#payee_signup_url', vcr: true do
+    it 'returns payoneer token' do
+      response = client.payee_signup_url('1')
+      expect(response).to be_a(PayoneerApi::PayoneerToken)
+    end
+
+    it 'allows you to us the to_s method on that object to obtain the registration url' do
+      response = client.payee_signup_url('1')
+      expect(response.to_s).to match(/payouts\.sandbox\.payoneer\.com/)
+    end
+
+    it 'allows you to use the uri method to get the URI object directly' do
+      response = client.payee_signup_url('1')
+      expect(response.uri.host).to eq('payouts.sandbox.payoneer.com')
+    end
+  end
+
+  describe '#payee_prefilled_signup_url', vcr: true do
+    context 'with incorrect login credentials' do
+      it 'returns a parsed error notification' do
+        client = PayoneerApi::Client.new(
+          partner_id: 'bogus',
+          username: 'bogus',
+          password: 'bogus',
+          environment: 'sandbox'
+        )
+        expect {
+          client.payee_prefilled_signup_url('1', {})
+        }.to raise_error(PayoneerApi::PayoneerException,
+          'Unauthorized Access or invalid parameters, please check your IP address and parameters.')
+      end
+    end
+
+    context 'with all correct params passed in' do
+      let(:params) {{
+        redirect_url: 'http://test.com/redirect',
+        redirect_time: 10,
+        payout_methods: 'PrepaidCard',
+        first_name: 'Donald',
+        last_name: 'Piret',
+        date_of_birth: '04011984',
+        address: '115 Amoy street',
+        city: 'Singapore',
+        county_code: 'SG',
+        zip_code: '069935',
+        phone: '+123456789',
+        email: 'donald@roomorama.com'
+      }}
+
+      it 'returns a url to the prefilled registration page' do
+        response = client.payee_prefilled_signup_url('1', params)
+        expect(response).to be_a(PayoneerApi::PayoneerToken)
+        expect(response.uri.host).to eq('payouts.sandbox.payoneer.com')
+      end
+
+      it 'includes a token parameter in this url' do
+        response = client.payee_prefilled_signup_url('1', params)
+        expect(CGI.parse(response.uri.query)).to have_key('token')
+      end
+    end
+  end
+
+  describe '#payee_details', vcr: true do
+    it 'returns an instance of a Payee object' do
+      response = client.payee_details('1')
+      expect(response).to be_a(PayoneerApi::Payee)
+    end
+
+    # Data comes from cassette
+    it 'associates basic contact data with the payee object' do
+      response = client.payee_details('1')
+      expect(response.first_name).to eq('Test')
+      expect(response.last_name).to eq('Test')
+      expect(response.email).to eq('test@roomorama.com')
+      expect(response.cards).to be_a(Hash)
+    end
+  end
+end

data/spec/payoneer_api/client_spec.rb

@@ -11,66 +11,17 @@ describe PayoneerApi::Client do
 
   describe '.new_payee_signup_url', vcr: true do
     it 'returns a url to the registration page (implicit credentials through environment variables)' do
-      response = PayoneerApi::Client.new_payee_signup_url('1')
-      expect(URI.parse(response).host).to eq('payouts.sandbox.payoneer.com')
+      response = PayoneerApi::Client.payee_signup_url('1')
+      expect(response).to be_a(PayoneerApi::PayoneerToken)
+      expect(response.uri.host).to eq('payouts.sandbox.payoneer.com')
     end
   end
 
   describe '.new_payee_prefilled_signup_url', vcr: true do
     it 'returns a url to the prefilled registration page' do
-      response = PayoneerApi::Client.new_payee_prefilled_signup_url('1', {})
-      expect(URI.parse(response).host).to eq('payouts.sandbox.payoneer.com')
-    end
-  end
-
-  describe '#payee_signup_url', vcr: true do
-    it 'returns a url to the registration page' do
-      response = client.payee_signup_url('1')
-      expect(URI.parse(response).host).to eq('payouts.sandbox.payoneer.com')
-    end
-  end
-
-  describe '#payee_prefilled_signup_url', vcr: true do
-    context 'with incorrect login credentials' do
-      it 'returns a parsed error notification' do
-        client = PayoneerApi::Client.new(
-          partner_id: 'bogus',
-          username: 'bogus',
-          password: 'bogus',
-          environment: 'sandbox'
-        )
-        expect {
-          client.payee_prefilled_signup_url('1', {})
-        }.to raise_error(PayoneerApi::PayoneerException,
-          'Unauthorized Access or invalid parameters, please check your IP address and parameters.')
-      end
-    end
-
-    context 'with all correct params passed in' do
-      let(:params) {{
-        redirect_url: 'http://test.com/redirect',
-        redirect_time: 10,
-        payout_methods: 'PrepaidCard',
-        first_name: 'Donald',
-        last_name: 'Piret',
-        date_of_birth: Date.parse('1984-04-01'),
-        address: '115 Amoy street',
-        city: 'Singapore',
-        county_code: 'SG',
-        zip_code: '069935',
-        phone: '+123456789',
-        email: 'donald@roomorama.com'
-      }}
-
-      it 'returns a url to the prefilled registration page' do
-        response = client.payee_prefilled_signup_url('1', params)
-        expect(URI.parse(response).host).to eq('payouts.sandbox.payoneer.com')
-      end
-
-      it 'includes a token parameter in this url' do
-        response = client.payee_prefilled_signup_url('1', params)
-        expect(CGI.parse(URI.parse(response).query)).to have_key('token')
-      end
+      response = PayoneerApi::Client.payee_prefilled_signup_url('1', {})
+      expect(response).to be_a(PayoneerApi::PayoneerToken)
+      expect(response.uri.host).to eq('payouts.sandbox.payoneer.com')
     end
   end
 end

data/spec/payoneer_api/payee_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+describe PayoneerApi::Payee do
+  let(:response_hash) {
+    {"GetPayeeDetails"=>
+      {"Payee"=>
+        {"FirstName"=>"Test",
+          "LastName"=>"Test",
+          "Email"=>"test@roomorama.com",
+          "Address1"=>"Test Address",
+          "Address2"=>"Test Address2",
+          "City"=>"New York",
+          "State"=>"NY",
+          "Zip"=>"10018",
+          "Country"=>"US",
+          "Phone"=>"6594576031",
+          "Mobile"=>nil,
+          "PayOutMethod"=>"Prepaid Card",
+          "Cards"=>
+            {"Card"=>
+              {"CardID"=>"0000000000000000",
+                "ActivationStatus"=>"Not\n        Issued, Pending Approval",
+                "CardStatus"=>"InActive"}},
+          "RegDate"=>"5/4/2014 11:09:24 PM"}}}
+  }
+
+  it 'correctly initializes from a payoneer response' do
+    payee = PayoneerApi::Payee.new(response_hash)
+    expect(payee.first_name).to eq('Test')
+  end
+end

data/spec/spec_helper.rb

@@ -17,4 +17,7 @@ VCR.configure do |c|
   c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
   c.hook_into :webmock
   c.configure_rspec_metadata!
+  c.filter_sensitive_data('<PAYONEER_PARTNER_ID>') { ENV['PAYONEER_PARTNER_ID'] }
+  c.filter_sensitive_data('<PAYONEER_USERNAME>') { ENV['PAYONEER_USERNAME'] }
+  c.filter_sensitive_data('<PAYONEER_PASSWORD>') { ENV['PAYONEER_PASSWORD'] }
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: payoneer_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Donald Piret
@@ -24,6 +24,26 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -103,18 +123,34 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/payoneer_api.rb
+- lib/payoneer_api/api.rb
+- lib/payoneer_api/api/payees.rb
+- lib/payoneer_api/base.rb
 - lib/payoneer_api/client.rb
 - lib/payoneer_api/core_ext/hash.rb
+- lib/payoneer_api/payee.rb
 - lib/payoneer_api/payoneer_exception.rb
+- lib/payoneer_api/payoneer_response.rb
+- lib/payoneer_api/payoneer_token.rb
+- lib/payoneer_api/request.rb
+- lib/payoneer_api/response.rb
+- lib/payoneer_api/utils.rb
 - lib/payoneer_api/version.rb
 - payoneer_api.gemspec
+- spec/fixtures/vcr_cassettes/PayoneerApi_API_Payees/_payee_details/associates_basic_contact_data_with_the_payee_object.yml
+- spec/fixtures/vcr_cassettes/PayoneerApi_API_Payees/_payee_details/returns_an_instance_of_a_Payee_object.yml
+- spec/fixtures/vcr_cassettes/PayoneerApi_API_Payees/_payee_prefilled_signup_url/with_all_correct_params_passed_in/includes_a_token_parameter_in_this_url.yml
+- spec/fixtures/vcr_cassettes/PayoneerApi_API_Payees/_payee_prefilled_signup_url/with_all_correct_params_passed_in/returns_a_url_to_the_prefilled_registration_page.yml
+- spec/fixtures/vcr_cassettes/PayoneerApi_API_Payees/_payee_prefilled_signup_url/with_incorrect_login_credentials/returns_a_parsed_error_notification.yml
+- spec/fixtures/vcr_cassettes/PayoneerApi_API_Payees/_payee_signup_url/allows_you_to_us_the_to_s_method_on_that_object_to_obtain_the_registration_url.yml
+- spec/fixtures/vcr_cassettes/PayoneerApi_API_Payees/_payee_signup_url/allows_you_to_use_the_uri_method_to_get_the_URI_object_directly.yml
+- spec/fixtures/vcr_cassettes/PayoneerApi_API_Payees/_payee_signup_url/returns_a_url_to_the_registration_page.yml
+- spec/fixtures/vcr_cassettes/PayoneerApi_API_Payees/_payee_signup_url/returns_payoneer_token.yml
 - spec/fixtures/vcr_cassettes/PayoneerApi_Client/_new_payee_prefilled_signup_url/returns_a_url_to_the_prefilled_registration_page.yml
 - spec/fixtures/vcr_cassettes/PayoneerApi_Client/_new_payee_signup_url/returns_a_url_to_the_registration_page_implicit_credentials_through_environment_variables_.yml
-- spec/fixtures/vcr_cassettes/PayoneerApi_Client/_payee_prefilled_signup_url/with_all_correct_params_passed_in/includes_a_token_parameter_in_this_url.yml
-- spec/fixtures/vcr_cassettes/PayoneerApi_Client/_payee_prefilled_signup_url/with_all_correct_params_passed_in/returns_a_url_to_the_prefilled_registration_page.yml
-- spec/fixtures/vcr_cassettes/PayoneerApi_Client/_payee_prefilled_signup_url/with_incorrect_login_credentials/returns_a_parsed_error_notification.yml
-- spec/fixtures/vcr_cassettes/PayoneerApi_Client/_payee_signup_url/returns_a_url_to_the_registration_page.yml
+- spec/payoneer_api/api/payees_spec.rb
 - spec/payoneer_api/client_spec.rb
+- spec/payoneer_api/payee_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/donaldpiret/payoneer_api
 licenses:
@@ -141,11 +177,18 @@ signing_key:
 specification_version: 4
 summary: Ruby wrapper for Payoneer API
 test_files:
+- spec/fixtures/vcr_cassettes/PayoneerApi_API_Payees/_payee_details/associates_basic_contact_data_with_the_payee_object.yml
+- spec/fixtures/vcr_cassettes/PayoneerApi_API_Payees/_payee_details/returns_an_instance_of_a_Payee_object.yml
+- spec/fixtures/vcr_cassettes/PayoneerApi_API_Payees/_payee_prefilled_signup_url/with_all_correct_params_passed_in/includes_a_token_parameter_in_this_url.yml
+- spec/fixtures/vcr_cassettes/PayoneerApi_API_Payees/_payee_prefilled_signup_url/with_all_correct_params_passed_in/returns_a_url_to_the_prefilled_registration_page.yml
+- spec/fixtures/vcr_cassettes/PayoneerApi_API_Payees/_payee_prefilled_signup_url/with_incorrect_login_credentials/returns_a_parsed_error_notification.yml
+- spec/fixtures/vcr_cassettes/PayoneerApi_API_Payees/_payee_signup_url/allows_you_to_us_the_to_s_method_on_that_object_to_obtain_the_registration_url.yml
+- spec/fixtures/vcr_cassettes/PayoneerApi_API_Payees/_payee_signup_url/allows_you_to_use_the_uri_method_to_get_the_URI_object_directly.yml
+- spec/fixtures/vcr_cassettes/PayoneerApi_API_Payees/_payee_signup_url/returns_a_url_to_the_registration_page.yml
+- spec/fixtures/vcr_cassettes/PayoneerApi_API_Payees/_payee_signup_url/returns_payoneer_token.yml
 - spec/fixtures/vcr_cassettes/PayoneerApi_Client/_new_payee_prefilled_signup_url/returns_a_url_to_the_prefilled_registration_page.yml
 - spec/fixtures/vcr_cassettes/PayoneerApi_Client/_new_payee_signup_url/returns_a_url_to_the_registration_page_implicit_credentials_through_environment_variables_.yml
-- spec/fixtures/vcr_cassettes/PayoneerApi_Client/_payee_prefilled_signup_url/with_all_correct_params_passed_in/includes_a_token_parameter_in_this_url.yml
-- spec/fixtures/vcr_cassettes/PayoneerApi_Client/_payee_prefilled_signup_url/with_all_correct_params_passed_in/returns_a_url_to_the_prefilled_registration_page.yml
-- spec/fixtures/vcr_cassettes/PayoneerApi_Client/_payee_prefilled_signup_url/with_incorrect_login_credentials/returns_a_parsed_error_notification.yml
-- spec/fixtures/vcr_cassettes/PayoneerApi_Client/_payee_signup_url/returns_a_url_to_the_registration_page.yml
+- spec/payoneer_api/api/payees_spec.rb
 - spec/payoneer_api/client_spec.rb
+- spec/payoneer_api/payee_spec.rb
 - spec/spec_helper.rb