papapi 0.1.6 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bc85d50e2012ff738a2165d92fb3e2c7ae232544
-  data.tar.gz: 2103a176b9c2a7c31e48220e3772f8421e88180d
+SHA256:
+  metadata.gz: cd6aad4e54fde1cad008bb55236d5349a8c2a487be5def0c8b9377ffa886ef1f
+  data.tar.gz: 215b4a2c4cb47a56c2ffaa50c63a9750cd7db22ef6ec836cc04132fb9804b33d
 SHA512:
-  metadata.gz: 638975743a0870dbf58f79e13d75998f2bf883af840783648815ede897e378650901511b0ff4473696e6818f7d3773a8ae5c3e1471f5f958ee32ddae3ab6dd9d
-  data.tar.gz: c639a66f4fb61ddd496409ba1a523b84098720c8778ea10ae35540ca321a9a044fb5386480b9914fc9961738b32a72dcd9667eafe2a32eb98caeecb2896c4922
+  metadata.gz: 1c0935bd1dadd5178058896604da6646f09f997d86a72d8fea5b3fcc258d9b83ca3835080528b2220d24288783f75590fa354b6715b5555bc2002853aad12da3
+  data.tar.gz: 46b3a778eb747eaa532bada7b29465eaec1c88897023142a0302f153e7d42401a610b99fb2a25bd6cc6e4bd35c1e330dff3e76f3134564cd3533ccc392e095f2

data/README.md

@@ -1,29 +1,39 @@
 # Papapi
 
-A gem to interface for Post Affiliate Pro API.
+A gem for access to the Post Affiliate Pro API.
 
-# Getting started example
+## Getting started example
 
-Create session as merchant
-```
+###Create session as merchant
+
+```ruby
 session = new Papapi::Session("http://demo.postaffiliatepro.com/scripts/server.php");
 session.login("merchant@example.com", "demo")
 ```
 
-Create session as affiliate in debug mode
-```
+###Create session as affiliate in debug mode
+
+```ruby
 session = new Papapi::Session("http://demo.postaffiliatepro.com/scripts/server.php",true);
 session.login("affiliate@example.com", "demo")
 ```
 
-Get information about affiliate
+###Get information about affiliate
 
-```
+```ruby
 affiliate = Papapi::Affiliate.new(session)
 affiliate.load()
 affiliate[:username]
 ```
 
+###Get information about merchant
+
+```ruby
+merchant = Papapi::Merchant.new(session)
+merchant.load()
+merchant[:username]
+```
+
 More documentation, and examples can be found [there](https://support.qualityunit.com/712031-API)
 
 

data/lib/papapi/affiliate.rb

@@ -3,25 +3,107 @@ module Papapi
   require_relative 'multi_request'
   class Affiliate
 
+    A_ALLOWED_FIELDS = [:username, :rpassword, :firstname, :lastname, :photo, :refid, :data1, :data2, :data3,
+                        :data4, :data5, :data6, :data7, :data8, :data9, :data10, :data11, :data12, :data13,
+                        :data14, :data15, :data16, :data17, :data18, :data19, :data20, :data21, :data22,
+                        :data23, :data24, :data25
+    ]
+
+    M_ALLOWED_FIELDS = [:parentuserid, :rstatus, :agreeWithTerms] | A_ALLOWED_FIELDS
+
+    attr_accessor :response
+
     def initialize(session, response = nil)
       @session = session
-      raise "Affiliate session is required" if !@session.is_affiliate?
+      if @session.is_affiliate?
+        @load_class = 'Pap_Affiliates_Profile_PersonalDetailsForm'
+        @save_class = 'Pap_Affiliates_Profile_PersonalDetailsForm'
+      else
+        @load_class = 'Pap_Signup_AffiliateForm'
+        @save_class = 'Pap_Merchants_User_AffiliateForm'
+      end
       @response = response
+      @user_id = nil
+      @update_fields = {}
     end
 
+
     def load
-      request = Papapi::FormRequest.new('Pap_Affiliates_Profile_PersonalDetailsForm', 'load', @session)
+      request = Papapi::FormRequest.new(@load_class, 'load', @session)
+
+      unless @user_id.nil?
+        request.set_field("Id", @user_id)
+        request.set_field("userid", @user_id)
+      end
+
+      @response = request.send
+      self
+    end
+
+
+    def save
+      raise "Affiliate id is required" if @session.is_merchant? && ! self.id
+
+      request = Papapi::FormRequest.new(@save_class, 'save', @session)
+
+      if @response
+        @response.fields.each do |key, value|
+          request.set_field(key, value) if (@session.is_affiliate? && A_ALLOWED_FIELDS.include?(key.to_sym)) ||
+                                            (@session.is_merchant? && M_ALLOWED_FIELDS.include?(key.to_sym))
+        end
+      end
+
+      @update_fields.each do |key, value|
+        request.set_field(key, value) if (@session.is_affiliate? && A_ALLOWED_FIELDS.include?(key.to_sym)) ||
+                                          (@session.is_merchant? && M_ALLOWED_FIELDS.include?(key.to_sym))
+      end
+
+      if @session.is_affiliate?
+        request.set_field("Id", "")
+      else
+        request.set_field("Id", self.id)
+      end
+
       @response = request.send
+      @update_fields = {}
       self
     end
 
+
     def id
-      @response ? @response[:userid] : nil
+      @response ? @response[:userid] : @user_id
+    end
+
+    def getLoginKey
+      raise "Merchant session is required"  if @session.is_affiliate?
+
+      request = Papapi::FormRequest.new('Pap_Auth_LoginKeyService', 'getLoginKey', @session)
+      request.set_param("userId", self.id)
+
+      response = request.send
+
+      return response[:LoginKey]
     end
 
+    def id=(user_id)
+      @user_id = user_id
+    end
+
+
     def [] (key)
       @response ? @response[key.to_sym] : nil
     end
 
+
+    def []= (key, value)
+      raise "Field #{key} can not be modified" if (@session.is_affiliate? && ! A_ALLOWED_FIELDS.include?(key.to_sym)) ||
+                                                  (@session.is_merchant? && ! M_ALLOWED_FIELDS.include?(key.to_sym))
+      @update_fields[key.to_sym] = value
+    end
+
+    def to_h
+      response ? response.to_h : {}
+    end
+
   end
 end

data/lib/papapi/form_request.rb

@@ -3,15 +3,25 @@ module Papapi
   class FormRequest < Request
 
     def set_field(key, value)
+      @fields = {} if ! @fields
+      @fields[key.to_sym] = value
+=begin
       @fields = [["name", "value"]] if ! @fields
       @fields.push([key, value])
+=end
     end
 
     def set_fields(f)
+      @fields = {} if ! @fields
+      f.each do |key, value|
+        @fields[key.to_sym] = value
+      end
+=begin
       @fields = [["name", "value"]] if ! @fields
       f.each do |key, value|
         @fields << [key, value]
       end
+=end
     end
 
     def response(http_response)
@@ -20,7 +30,13 @@ module Papapi
 
     def to_data
       data = super
-      data[:fields] = @fields if @fields
+      if @fields
+        data_fields = [["name", "value"]]
+        @fields.each do |key, value|
+          data_fields << [key, value]
+        end
+        data[:fields] = data_fields
+      end
       data
     end
 

data/lib/papapi/form_response.rb

@@ -22,5 +22,9 @@ module Papapi
       fields[key.to_sym]
     end
 
+    def to_h
+      fields
+    end
+
   end
 end

data/lib/papapi/grid_response.rb

@@ -15,10 +15,20 @@ module Papapi
       parsed['rows'].slice(1, parsed['rows'].count-1)
     end
 
+    def [] (key)
+      if rows[key.to_i]
+        return Hash[*attributes.zip(rows[key.to_i]).flatten]
+      end
+    end
+
     def each
       rows.each do |row|
         yield Hash[*attributes.zip(row).flatten]
       end
     end
+
+    def to_a
+      rows
+    end
   end
 end

data/lib/papapi/merchant.rb

@@ -16,6 +16,8 @@ module Papapi
         :phone    => :data8
     }
 
+    attr_accessor :response
+
     def initialize(session, response = nil)
       @session = session
       raise "Merchant session is required" if !@session.is_merchant?
@@ -32,10 +34,6 @@ module Papapi
       request.set_fields(request_fields)
       response = request.send
       response
-      #affiliate = Papapi::Affiliate.new(Papapi::Session.new(@session.url).
-      #                          login(request_fields[:username], request_fields[:rpassword], Papapi::Session::AFFILIATE))
-      #affiliate.load
-      #affiliate
     end
 
     def remove_affiliate(affiliate_id)
@@ -103,6 +101,22 @@ module Papapi
       affiliates
     end
 
+    def affiliate_by_username(username)
+      request = Papapi::GridRequest.new("Pap_Merchants_User_AffiliatesGridSimple", "getRows", @session)
+      request.add_filter('username', Papapi::Filter::EQUALS, username)
+
+      response = request.send
+      if response.count > 0
+        user = response[0]
+        p user['id']
+        affiliate = Papapi::Affiliate.new(@session)
+        affiliate.id = user['userid'] || user['id']
+        affiliate.load
+        return affiliate
+      end
+
+    end
+
     def id
       @response ? @response[:authid] : nil
     end
@@ -111,5 +125,9 @@ module Papapi
       @response ? @response[key.to_sym] : nil
     end
 
+    def to_h
+      response ? response.to_h : {}
+    end
+
   end
 end

data/lib/papapi/response.rb

@@ -1,9 +1,9 @@
 module Papapi
   class Response
-
     REMOVE_VARS = ['name', 'correspondsApi', 'language']
 
     attr_reader :responses
+    attr_reader :request
 
     def initialize (http_response, request)
       @http_response = http_response
@@ -29,6 +29,15 @@ module Papapi
       @parsed
     end
 
+    def to_h
+      h = {}
+      parsed.each_with_index do |p, index|
+        next if index == 0
+        h[p[0].to_sym] = p[1]
+      end
+      h
+    end
+
     private
 
     def check_for_errors

data/lib/papapi/version.rb

@@ -1,3 +1,3 @@
 module Papapi
-  VERSION = "0.1.6"
+  VERSION = "0.1.11"
 end

data/spec/affiliate_spec.rb

@@ -5,8 +5,51 @@ RSpec.describe Papapi::Affiliate::Commission do
   it "#load" do
     session = Papapi::Session.new(script_url).login(affiliate_login, affiliate_password, Papapi::Session::AFFILIATE)
     affiliate = Papapi::Affiliate.new(session)
-    affiliate.load()
+    affiliate.load
     expect(affiliate.id).to eq('11111111')
     expect(affiliate[:username]).to eq('affiliate@example.com')
   end
+
+  it "#load - by merchant session" do
+    session = Papapi::Session.new(script_url).login(merchant_login, merchant_password)
+    affiliate = Papapi::Affiliate.new(session)
+    affiliate.id = '11111111'
+    affiliate.load
+    expect(affiliate.id).to eq('11111111')
+    expect(affiliate[:username]).to eq('affiliate@example.com')
+  end
+
+  it "#save" do
+    session = Papapi::Session.new(script_url).login(affiliate_login, affiliate_password, Papapi::Session::AFFILIATE)
+    affiliate = Papapi::Affiliate.new(session)
+    affiliate.load
+    expect(affiliate.id).to eq('11111111')
+    affiliate[:data1] = 'http://google.com'
+    affiliate[:data2] = 'Fake inc.'
+    affiliate[:data3] = 'str. Fake'
+    affiliate[:data4] = 'Fake'
+    affiliate[:data5] = 'CA'
+    affiliate[:data6] = 'USA'
+    affiliate[:firstname] = 'papapi_a_test'
+    affiliate.save
+    expect(affiliate[:firstname]).to eq('papapi_a_test')
+  end
+
+  it "#save - by merchant session" do
+    session = Papapi::Session.new(script_url).login(merchant_login, merchant_password)
+    affiliate = Papapi::Affiliate.new(session)
+    affiliate.id = '11111111'
+    affiliate.load
+    expect(affiliate.id).to eq('11111111')
+    affiliate[:data1] = 'http://google.com'
+    affiliate[:data2] = 'Fake inc.'
+    affiliate[:data3] = 'str. Fake'
+    affiliate[:data4] = 'Fake'
+    affiliate[:data5] = 'CA'
+    affiliate[:data6] = 'USA'
+    affiliate[:firstname] = 'papapi_m_test'
+    affiliate.save
+    expect(affiliate[:firstname]).to eq('papapi_m_test')
+  end
+
 end

data/spec/merchant_spec.rb

@@ -27,13 +27,13 @@ RSpec.describe Papapi::Affiliate::Commission do
                                   :country => 'US',
                                   :zip => '90210',
                                   :phone => '3234789181',
-                                  :refid => 'tom-foolery',
+                                  :refid => 'tomfoolery',
                                   :rstatus => 'A'
                               })
 
 
     expect(affiliate[:username]).to eq('user@example.com')
-    expect(affiliate[:refid]).to eq('tom-foolery')
+    #expect(affiliate[:refid]).to eq('tomfoolery')
 
     merchant.remove_affiliate(affiliate[:Id])
 
@@ -57,4 +57,15 @@ RSpec.describe Papapi::Affiliate::Commission do
     expect(affiliates[0]['username']).to eq('affiliate@example.com')
 
   end
+
+
+  it "#affiliate_by_username" do
+    session = Papapi::Session.new(script_url).login(merchant_login, merchant_password)
+    merchant = Papapi::Merchant.new(session)
+
+    affiliate = merchant.affiliate_by_username('affiliate@example.com')
+
+    expect(affiliate[:username]).to eq('affiliate@example.com')
+    expect(affiliate.id).to eq('11111111')
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: papapi
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.11
 platform: ruby
 authors:
 - Dmitry Nizovtsev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-04-24 00:00:00.000000000 Z
+date: 2021-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,7 +94,7 @@ homepage: https://github.com/JSBizon/papapi
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -109,9 +109,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.11
+signing_key:
 specification_version: 4
 summary: A client for the Post Affiliate Pro API
 test_files: