affiliate-window 0.2.0.pre1 → 0.2.1.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09a0b44675f1e1152a6bbeb360477a476bc0dc23
-  data.tar.gz: 7cead014031b5890df62655fa1856aab4d8638ed
+  metadata.gz: 9111b0e915d1b9ad173bb31f8eb7b75754d5cc39
+  data.tar.gz: 94b8e9859831f34d6b5b3384fa936a416a9f9fbb
 SHA512:
-  metadata.gz: 3ee50bb4caf934327a14ae606ea343a3bad9566e4629002493154c8e5cc5324449921734e9fc248fa533a3fdf9c68521b8ac027b19c21026eb0e30e862fc4042
-  data.tar.gz: cf74a49976d3648cdebfb2f665bec204c0e46647c22fa72c98d4dc6ae782d1aa1dd741f4e9d86a20e30a50d8c4adb63a901d10916a8b3bdec0a6768691ae76b9
+  metadata.gz: 5cb0c3655d7049a0850f436b9a546bd71ca2dcf93c6c4131a77c0cea812504a5f2dea360a6870632157a9fadfb16da88ab6ccee145669fbcd166672bbac9dd53
+  data.tar.gz: 42b1d02a62e570d392baaffe3f9839f5b03f8a7f36aec4b96252a0e5c1ca32614581dbdea530cc72754d1f89f1d488c9aa2bad5a5ec9bab6e94f7ab2e316118d

data/.gitignore

@@ -0,0 +1,48 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/Gemfile.lock

@@ -0,0 +1,70 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    akami (1.0.0)
+      gyoku (>= 0.4.0)
+    ansi (1.4.1)
+    builder (3.0.0)
+    fakeweb (1.3.0)
+    git (1.2.5)
+    gyoku (0.4.4)
+      builder (>= 2.1.2)
+    hashie (1.2.0)
+    httpi (0.9.5)
+      rack
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.6.1)
+    metaclass (0.0.1)
+    minitest (2.8.1)
+    minitest-reporters (0.4.0)
+      ansi
+      minitest (~> 2.0)
+      ruby-progressbar
+    mocha (0.10.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.0.3)
+    nokogiri (1.5.0)
+    nori (1.0.2)
+    rack (1.3.5)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rdoc (3.11)
+      json (~> 1.4)
+    ruby-progressbar (0.0.10)
+    savon (0.9.7)
+      akami (~> 1.0)
+      builder (>= 2.1.2)
+      gyoku (>= 0.4.0)
+      httpi (~> 0.9)
+      nokogiri (>= 1.4.0)
+      nori (~> 1.0)
+      wasabi (~> 2.0)
+    savon_model (1.1.0)
+      httpi (>= 0.7.8)
+      savon (>= 0.8.2)
+    simplecov (0.5.4)
+      multi_json (~> 1.0.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    wasabi (2.0.0)
+      nokogiri (>= 1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  fakeweb
+  hashie (>= 0.0.0)
+  jeweler (~> 1.6.4)
+  minitest
+  minitest-reporters
+  mocha
+  rcov
+  rdoc
+  savon (>= 0.9.7)
+  savon_model (>= 0.0.0)
+  simplecov

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/affiliate-window.gemspec

@@ -0,0 +1,68 @@
+require File.expand_path('../lib/affiliate-window/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = "affiliate-window"
+  s.version = AffiliateWindow::Version::STRING
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["andy.triggs@gmail.com"]
+  s.date = "2011-11-30"
+  s.description = "Affiliate Window provide APIs for interacting with their merchant, product and transaction data via your publisher account. This gem provides clients for those APIs."
+  s.email = "andy.triggs@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files    = `git ls-files`.split("\n")
+  s.homepage = "http://github.com/andyt/affiliate-window"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Clients and other publisher tools for using Affiliate Window APIs"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<savon>, [">= 0.9.7"])
+      s.add_runtime_dependency(%q<savon_model>, [">= 0.0.0"])
+      s.add_runtime_dependency(%q<hashie>, [">= 0.0.0"])
+      s.add_development_dependency(%q<minitest>, [">= 0"])
+      s.add_development_dependency(%q<minitest-reporters>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+    else
+      s.add_dependency(%q<savon>, [">= 0.9.7"])
+      s.add_dependency(%q<savon_model>, [">= 0.0.0"])
+      s.add_dependency(%q<hashie>, [">= 0.0.0"])
+      s.add_dependency(%q<minitest>, [">= 0"])
+      s.add_dependency(%q<minitest-reporters>, [">= 0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<savon>, [">= 0.9.7"])
+    s.add_dependency(%q<savon_model>, [">= 0.0.0"])
+    s.add_dependency(%q<hashie>, [">= 0.0.0"])
+    s.add_dependency(%q<minitest>, [">= 0"])
+    s.add_dependency(%q<minitest-reporters>, [">= 0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+  end
+end
+

data/lib/affiliate-window/account.rb

@@ -0,0 +1,48 @@
+module AffiliateWindow
+  class Account
+    attr_reader :user, :api_password, :api_key, :datafeed_password, :format, :compression
+
+    VALID_FORMATS = %w{CSV} # XML not yet supported.
+
+    # Unzipping is not supported for portability, but you can specify it to download a zipped file.
+    # CSV helper methods won't work with zipped downloads.
+    VALID_COMPRESSIONS = %w{none zip}
+
+    def initialize(options)
+      @user ||= options[:user] || raise(ArgumentError, ":user option is required.")
+      @api_password ||= options[:api_password] || raise(ArgumentError, ":api_password option is required.")
+      @api_key ||= options[:api_key] || raise(ArgumentError, ":api_key option is required.")
+      @datafeed_password ||= options[:datafeed_password] || raise(ArgumentError, ":datafeed_password option is required.")
+      self.format = options[:format] || VALID_FORMATS.first
+      self.compression = options[:compression] || VALID_COMPRESSIONS.first
+    end
+
+    def format=(value)
+      value = value.upcase.to_s
+      raise ArgumentError, "Invalid format #{value} - use #{VALID_FORMATS.join(', ')}." unless VALID_FORMATS.include?(value)
+      @format = value
+    end
+
+    def compression=(value)
+      value = value.downcase.to_s
+      raise ArgumentError, "Invalid compression #{value} - use #{VALID_COMPRESSIONS.join(', ')}." unless VALID_COMPRESSIONS.include?(value)
+      @compression = value
+    end
+
+    def compression_parameter
+      @compression == 'none' ? '' : @compression
+    end
+
+    def attributes
+      {
+        :user => user,
+        :api_password => api_password,
+        :api_key => api_key,
+        :datafeed_password => datafeed_password,
+        :format => format,
+        :compression => compression
+      }
+    end
+
+  end
+end

data/lib/affiliate-window/clients/affiliate_service.rb

@@ -0,0 +1,45 @@
+module AffiliateWindow::Clients
+
+  # SOAP client for the AffiliateWindow AffiliateService API.
+  #
+  # Instantiate carefully! This parses the WSDL document every time.
+  class AffiliateService < Savon::Client
+
+    include AffiliateWindow::Helpers::Account
+
+    ENDPOINT_URL = 'http://api.affiliatewindow.com/v3/AffiliateService'
+    
+    WSDL_URL = ENDPOINT_URL + '?wsdl'
+
+    CACHED_WSDL_PATH = File.join(File.dirname(__FILE__), '..', '..', '..', 'wsdl', 'affiliate_service_v3.wsdl')
+
+    ACTIONS = [:get_transaction_list, :get_transaction_product, :get_transaction, :get_merchant_list, :get_merchant, :get_transaction_querys, :set_transaction_query, :get_impression_stats, :get_click_stats, :get_commission_group, :get_commission_group_list]
+
+    def initialize(account = nil)
+      set_account(account)
+      super(CACHED_WSDL_PATH)
+    end
+
+    # Override the request method so that we can inject the authentication header.
+    def request(*args, &block)
+      super(*args) do        
+        soap.header = header
+        process &block if block
+      end
+    end
+
+    private
+
+      # We need 'UserAuthenication' as a string due to the odd capitalisation.
+      def header
+        {
+          'UserAuthentication' => {
+            :i_id => user,
+            :s_password => api_password,
+            :s_type => 'affiliate'
+          }
+        }
+      end
+
+  end
+end

data/lib/affiliate-window/clients/category.rb

@@ -0,0 +1,19 @@
+module AffiliateWindow::Clients
+
+  class Category
+
+    include AffiliateWindow::Helpers::Account
+    include AffiliateWindow::Helpers::Csv
+
+    URL_TEMPLATE = 'http://datafeeds.productserve.com/datafeed_category.php?user=#{user}&password=#{datafeed_password}&format=#{format}&compression=#{compression_parameter}'
+    
+    def initialize(account = nil)
+      set_account(account)
+    end
+
+    def url
+      @url ||= eval(%Q|"#{URL_TEMPLATE}"|)
+    end
+
+  end
+end

data/lib/affiliate-window/clients/merchant.rb

@@ -0,0 +1,32 @@
+module AffiliateWindow::Clients
+
+  class Merchant
+
+    include AffiliateWindow::Helpers::Account
+    include AffiliateWindow::Helpers::Csv
+
+    attr :filter
+
+    URL_TEMPLATE = 'https://www.affiliatewindow.com/affiliates/shopwindow/datafeed_metadata.php?user=#{user}&password=#{datafeed_password}&format=#{format}&filter=#{filter}&compression='
+
+    VALID_FILTERS = %w{SUBSCRIBED_ALL SUBSCRIBED_ENABLED ALL_ALL ALL_ENABLED}
+
+    def initialize(filter = nil, account = nil)
+      set_account(account)
+      self.filter = filter || VALID_FILTERS.first
+    end
+
+    def url
+      @url ||= eval(%Q|"#{URL_TEMPLATE}"|)
+    end
+
+    private
+
+      def filter=(value)
+        value = value.to_s.upcase
+        raise ArgumentError unless VALID_FILTERS.include?(value)
+        @filter = value
+      end
+
+  end
+end

data/lib/affiliate-window/clients/shop_window.rb

@@ -0,0 +1,45 @@
+module AffiliateWindow
+  module Clients
+
+    class ShopWindow
+
+      include AffiliateWindow::Helpers::Client
+      include AffiliateWindow::Helpers::Account
+      include AffiliateWindow::Helpers::Csv
+
+      attr :merchant_ids
+
+      # This URL template only works for a selection of merchants by ID.
+      # It ignores the compression setting in account. Valid options are zip or gzip. We use zip.
+      URL_TEMPLATE = 'http://datafeed.api.productserve.com/datafeed/download/apikey/#{api_key}/mid/#{merchant_id_list}/columns/#{column_list}/format/#{format.downcase}/compression/zip/'
+
+      DEFAULT_COLUMNS = %w{ merchant_id merchant_name aw_product_id merchant_product_id product_name description 
+                            category_id category_name merchant_category aw_deep_link aw_image_url search_price 
+                            delivery_cost merchant_deep_link merchant_image_url mpn rrp_price stock_quantity 
+                            brand_id ean merchant_thumb_url brand_name in_stock model_number specifications upc }
+
+      def initialize(options = {})
+        parse_options(options)
+      end
+
+      def url
+        @url ||= eval(%Q|"#{URL_TEMPLATE}"|)
+      end
+
+      def columns
+        @columns || DEFAULT_COLUMNS
+      end
+
+      private
+
+        def column_list
+          columns.join(',')
+        end
+
+        def merchant_id_list
+          merchant_ids.join(',')
+        end
+
+    end
+  end
+end

data/lib/affiliate-window/helpers/account.rb

@@ -0,0 +1,25 @@
+module AffiliateWindow::Helpers
+
+  # Helper methods for account delegation and using a default account.
+  module Account
+
+    attr_accessor :account
+
+    # Some delegation methods (avoids having a delegation dependency).
+    def user; account.user; end
+    def datafeed_password; account.datafeed_password; end
+    def api_password; account.api_password; end
+    def api_key; account.api_key; end
+
+    def format; account.format; end
+    def compression_parameter; account.compression_parameter; end
+
+    # Sets @account to the passed account, or a defined default.
+    def set_account(account)
+      @account = account || AffiliateWindow.account
+      raise ArgumentError, "Pass the account parameter, or set AffiliateWindow.account." unless @account
+    end
+
+  end
+
+end

data/lib/affiliate-window/helpers/client.rb

@@ -0,0 +1,23 @@
+module AffiliateWindow::Helpers
+
+  # Helper methods for client classes.
+  module Client
+
+    def parse_options(options)
+      set_account(options.delete(:account))
+      options.each do |k, v|
+        if respond_to?(k)
+          instance_variable_set("@#{k}", v)
+        else
+          raise ArgumentError, "Unknown option #{k}."
+        end
+      end
+    end
+
+    def fetch(target = Tempfile.new('awin').path)
+      AffiliateWindow.fetch(url, target)
+    end
+
+  end
+
+end