affiliate_window 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 879c6696972ede3c678d902070ada3515332070a
+  data.tar.gz: 99fdd2cc8dcbc40799a681eb1dbe33e981c95e02
+SHA512:
+  metadata.gz: add29aba090cd27d2cb35652d4b8236c425538a84029b9008d9d34d9e5fd0fb4952b7ae62cce4b406469f3f4ebbb6ebc47a3d8efcd4fc44a30371f316d38c414
+  data.tar.gz: 20b094621c3c50d30c623ac5f1f24891b7f3139e9dd42bdea3bc77d85adc7578b4b50feae194dacd53ce7f888d8dacfee32054991f4f2584c8606a8b7c95f77b

data/README.md

@@ -0,0 +1,67 @@
+## Affiliate Window
+
+This gem lets you make requests to Affiliate Window's Publisher Service API.
+At the time of writing, it is on version 6. The API is documented
+[here](http://wiki.affiliatewindow.com/index.php/Publisher_Service_API).
+
+There is [an existing gem](https://github.com/andyt/affiliate-window) for
+communicating with Affiliate Window but it looks to be unsupported and doesn't
+work with its Publisher Service API.
+
+## Usage
+
+```ruby
+client = AffiliateWindow.login(
+  account_id: 1234,
+  affiliate_api_password: "your api key",
+)
+
+response = client.get_transaction_list(
+  start_date: "2006-08-04T00:00:00",
+  end_date: "2006-08-14T23:59:59",
+  date_type: "transaction",
+)
+
+response.dig(:results, :transaction, 0)
+#=> {
+#  i_id: "1",
+#  s_status: "confirmed",
+#  b_paid: true,
+#  m_sale_amount: {
+#    d_amount: "50.00",
+#    s_currency: "GBP"
+#  },
+#  ...
+```
+
+The gem follows the convention that all API methods are called by their
+snake case name. Parameter names mirror the API, for example:
+
+```
+iMerchantId -> merchant_id
+aTransactionIds -> transaction_ids
+aStatus -> status
+```
+
+If the endpoint returns metadata about how many records were returned, this is
+returned in the `pagination` key of the output, e.g.
+
+```ruby
+response
+#=> {
+#  pagination: {
+#    i_rows_returned: "10",
+#    i_rows_available: "50"
+#  }
+```
+
+## Debugging
+
+You can print the SOAP request bodies by enabling debug mode:
+
+```ruby
+client.debug = true
+client.get_merchant_list
+# <?xml version='1.0' encoding='UTF-8'?>
+# ...
+```

data/lib/affiliate_window.rb

@@ -0,0 +1,7 @@
+require "savon"
+require "rexml/document"
+
+require "affiliate_window/base"
+require "affiliate_window/client"
+require "affiliate_window/error_handler"
+require "affiliate_window/parser"

data/lib/affiliate_window/base.rb

@@ -0,0 +1,132 @@
+# For full API documentation, refer to:
+# http://wiki.affiliatewindow.com/index.php/Publisher_Service_API
+
+class AffiliateWindow
+  attr_accessor :client, :error_handler, :parser, :debug
+
+  def self.login(account_id:, affiliate_api_password:)
+    client = Client.new(
+      account_id: account_id,
+      affiliate_api_password: affiliate_api_password,
+    )
+
+    new(client: client)
+  end
+
+  def initialize(client:, error_handler: ErrorHandler, parser: Parser)
+    self.client = client
+    self.error_handler = error_handler
+    self.parser = parser
+  end
+
+  # Gets the commission values for a given commission group and advertiser
+  # http://wiki.affiliatewindow.com/index.php/AS:getCommissionGroup
+  def get_commission_group(merchant_id:, commission_group_code:)
+    call(
+      :get_commission_group,
+      iMerchantId: merchant_id,
+      sCommissionGroupCode: commission_group_code,
+    )
+  end
+
+  # Gets an array of commission groups for an advertiser
+  # http://wiki.affiliatewindow.com/index.php/AS:getCommissionGroupList
+  def get_commission_group_list(merchant_id:)
+    call(:get_commission_group_list, iMerchantId: merchant_id)
+  end
+
+  # Gets products for the specified transaction # http://wiki.affiliatewindow.com/index.php/AS:getTransactionProduct
+  def get_transaction_product(transaction_ids:)
+    call(:get_transaction_product, aTransactionIds: transaction_ids)
+  end
+
+  # Gets the transactions that fall under the specified criteria
+  # http://wiki.affiliatewindow.com/index.php/AS:getTransactionList
+  def get_transaction_list(merchant_ids: nil, start_date:, end_date:, date_type:, transaction_status: nil, limit: nil, offset: nil)
+    call(
+      :get_transaction_list,
+      aMerchantIds: merchant_ids,
+      dStartDate: start_date,
+      dEndDate: end_date,
+      sDateType: date_type,
+      sTransactionStatus: transaction_status,
+      iLimit: limit,
+      iOffset: offset,
+    )
+  end
+
+  # Gets the requested transactions
+  # http://wiki.affiliatewindow.com/index.php/AS:getTransaction
+  def get_transaction(transaction_ids:)
+    call(:get_transaction, aTransactionIds: transaction_ids)
+  end
+
+  # Gets the requested advertisers
+  # http://wiki.affiliatewindow.com/index.php/AS:getMerchant
+  def get_merchant(merchant_ids:)
+    call(:get_merchant, aMerchantIds: merchant_ids)
+  end
+
+  # Gets the advertisers that fall under the specified criteria
+  # http://wiki.affiliatewindow.com/index.php/AS:getMerchantList
+  def get_merchant_list(relationship: nil)
+    call(:get_merchant_list, sRelationship: relationship)
+  end
+
+  # Gets the requested transaction queries
+  # http://wiki.affiliatewindow.com/index.php/AS:getTransactionQuerys
+  def get_transaction_queries(merchant_ids: nil, status: nil, click_refs:, offset: nil, limit: nil)
+    call(
+      :get_transaction_queries,
+      aMerchantIds: merchant_ids,
+      aStatus: status,
+      aClickRefs: click_refs,
+      iOffset: offset,
+      iLimit: limit,
+    )
+  end
+
+  # Gets the requested link click stats
+  # http://wiki.affiliatewindow.com/index.php/AS:getClickStats
+  def get_click_stats(start_date:, end_date:, merchant_ids: nil, date_type:, offset: nil, limit: nil)
+    call(
+      :get_click_stats,
+      dStartDate: start_date,
+      dEndDate: end_date,
+      aMerchantIds: merchant_ids,
+      sDateType: date_type,
+      iOffset: offset,
+      iLimit: limit,
+    )
+  end
+
+  # Gets the requested link impression stats
+  # http://wiki.affiliatewindow.com/index.php/AS:getImpressionStats
+  def get_impression_stats(start_date:, end_date:, merchant_ids: nil, date_type:, offset: nil, limit: nil)
+    call(
+      :get_impression_stats,
+      dStartDate: start_date,
+      dEndDate: end_date,
+      aMerchantIds: merchant_ids,
+      sDateType: date_type,
+      iOffset: offset,
+      iLimit: limit,
+    )
+  end
+
+  private
+
+  def call(method, params)
+    params = remove_nils(params)
+
+    response = error_handler.handle do
+      client.call(method, params, debug)
+    end
+
+    parser.parse(response, method)
+  end
+
+  def remove_nils(params)
+    params.reject { |_, value| value.nil? }
+  end
+end

data/lib/affiliate_window/client.rb

@@ -0,0 +1,43 @@
+class AffiliateWindow
+  class Client
+    def initialize(account_id:, affiliate_api_password:)
+      self.savon_client = Savon.client(
+        wsdl: "http://api.affiliatewindow.com/v6/AffiliateService?wsdl",
+        namespace: "http://api.affiliatewindow.com/",
+        soap_header: {
+          "api:UserAuthentication" => {
+            "api:iId" => account_id.to_s,
+            "api:sPassword" => affiliate_api_password,
+            "api:sType" => "affiliate",
+          },
+        },
+      )
+    end
+
+    def call(method, params, debug = false)
+      params = convert_to_soap_arrays(params)
+
+      print_request(method, params) if debug
+      savon_client.call(method, message: params)
+    end
+
+    def print_request(method, params)
+      request = savon_client.build_request(method, message: params)
+      document = REXML::Document.new(request.body)
+
+      formatter = REXML::Formatters::Pretty.new
+      formatter.write(document, $stdout)
+    end
+
+    private
+
+    def convert_to_soap_arrays(params)
+      params.each.with_object({}) do |(key, value), hash|
+        value = value.is_a?(Array) ? { int: value } : value
+        hash.merge!(key => value)
+      end
+    end
+
+    attr_accessor :savon_client
+  end
+end

data/lib/affiliate_window/error_handler.rb

@@ -0,0 +1,13 @@
+class AffiliateWindow
+  module ErrorHandler
+    def self.handle(&block)
+      begin
+        block.call
+      rescue Savon::Error => e
+        raise Error, e.message
+      end
+    end
+  end
+
+  class Error < StandardError; end
+end

data/lib/affiliate_window/parser.rb

@@ -0,0 +1,17 @@
+class AffiliateWindow
+  module Parser
+    def self.parse(response, method)
+      body = response.body
+      root = body.fetch(:"#{method}_response")
+
+      results = root.fetch(:"#{method}_return")
+      pagination = root.fetch(:"#{method}_count_return", nil)
+
+      if pagination
+        { pagination: pagination, results: results }
+      else
+        results
+      end
+    end
+  end
+end

data/lib/affiliate_window/version.rb

@@ -0,0 +1,3 @@
+class AffiliateWindow
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: affiliate_window
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Reevoo Developers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+description: A gem for communicating with Affiliate Window's Publisher Service API.
+email: developers@reevoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/affiliate_window.rb
+- lib/affiliate_window/base.rb
+- lib/affiliate_window/client.rb
+- lib/affiliate_window/error_handler.rb
+- lib/affiliate_window/parser.rb
+- lib/affiliate_window/version.rb
+homepage: https://github.com/reevoo/affiliate_window
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: 'Affiliate Window: Publisher Service API'
+test_files: []