affiliate-window 0.1.0.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 475bdebb4c9395e8b8482318264dc7345d774de4
+  data.tar.gz: 796a08e3040ac2c071a8c6b0bf654023b0bf0da2
+SHA512:
+  metadata.gz: 815cd27fddd94692a4cf8efc6ff6f81998301ee542b8b5a2bd2579437a24cb0d24cca5abb9d272b100822064ff61b7f7115d2237ed94c6aca5780ebebb8fdd0a
+  data.tar.gz: 135346c074f730e95076ab92ea47a6dc384736172307dab0ff2458225493178129dfedf2966a9804c44cb736743b2c890b8bd9a3a537efd51bcaad766deeac89

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,17 @@
+source 'http://rubygems.org'
+
+gem 'savon', '>= 0.9.7'
+gem 'savon_model', '>= 0.0.0'
+gem 'hashie', '>= 0.0.0'
+
+group :development do
+  gem 'minitest', '>= 0'
+  gem 'minitest-reporters', '>= 0'
+  gem 'simplecov', '>= 0'
+  gem 'fakeweb', '>= 0'
+  gem 'mocha', '>= 0'
+  gem 'bundler', '~> 1.0.0'
+  gem 'jeweler', '~> 1.6.4'
+  gem 'rcov', '>= 0'
+  gem 'rdoc', '>= 0'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 andy.triggs@gmail.com
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,97 @@
+= affiliate-window
+
+This Ruby gem contains clients for the AffiliateWindow (http://www.affiliatewindow.com/) suite of APIs and webservices. It currently supports:
+
+* AffiliateService (SOAP)
+* Merchant and category meta-data
+* ShopWindow data feeds.
+
+
+== Getting started
+
+Configure an account for the gem to use with all clients. If you're working with Rails, you could do this in an initializer:
+
+    AffiliateWindow.account = AffiliateWindow::Account.new(
+      :user => '12345', 
+      :datafeed_password => 'e9db...', 
+      :api_key => 'fc70...',
+      :api_password => 'dc3024ea...'
+    )
+
+
+== Examples
+
+
+=== AffiliateService
+
+To get all today's transactions with the AffiliateService SOAP client:
+
+    client = AffiliateWindow::Clients::AffiliateService.new
+    response = client.request(:get_transaction_list) do
+      soap.body = { 
+        :d_start_date => Time.now.beginning_of_day, 
+        :d_end_date => Time.now.end_of_day, 
+        :s_date_type => 'transaction'
+      }
+    end
+
+    puts r.to_hash
+
+This outputs something like:
+
+    {:get_transaction_list_response=>{:get_transaction_list_return=>{:transaction=>{:i_id=>"72417910", :s_status=>"pending", :s_type=>"normal", :s_ip=>"0.0.0.0", :b_paid=>false, :i_payment_id=>"0", :i_merchant_id=>"9999", :f_sale_amount=>"318.74", :f_commission_amount=>"9.56", :d_click_date=>"2012-05-26 19:48:30", :d_transaction_date=>"2012-05-26 20:41:03", :s_clickref=>"4fc125b25ef7f37589000ac7", :a_transaction_parts=>{:transaction_part=>{:s_commission_group_name=>"Default Commission", :f_sale_amount=>"318.74", :f_commission_amount=>"9.56", :i_commission=>"3", :s_commission_type=>"percentage"}}}}, :get_transaction_list_count_return=>{:i_rows_returned=>"1", :i_rows_available=>"1"}}}
+
+
+=== ShopWindow
+
+To download a product feed CSV for a set of merchants:
+
+    store_to = "tmp/data.csv.zip"
+    client = AffiliateWindow::Clients::ShopWindow.new(:merchant_ids => [1,2,3,4])
+    client.fetch(store_to)
+
+
+=== Merchants and categories
+
+Merchants:
+
+    AffiliateWindow::Clients::Merchant.new.each { |merchant| puts merchant.inspect }
+
+Categories:
+
+    AffiliateWindow::Clients::Category.new.each { |category| puts merchant.inspect }
+
+
+== Models
+
+There's currently only a Transaction model, and this is a work in progress.
+
+
+== ToDo
+
+* Use VCR for test coverage
+* Extend test coverage to actually connect to API with real URLs and test responses, to protect against API changes.
+* Handle 'merchant' user type for AffiliateService authentications.
+
+
+== In production
+
+This is in production use on http://www.bikepimp.co.uk. If you're using this, let me know.
+
+
+== Contributing to affiliate-window
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+
+== Copyright
+
+Copyright (c) 2011 andy.triggs@gmail.com. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+require './lib/affiliate-window/version'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "affiliate-window"
+  gem.homepage = "http://github.com/andyt/affiliate-window"
+  gem.license = "MIT"
+  gem.summary = %Q{Clients and other publisher tools for using Affiliate Window APIs}
+  gem.description = %Q{Affiliate Window provide APIs for interacting with their merchant, product and transaction data via your publisher account. This gem provides clients for those APIs.}
+  gem.email = "andy.triggs@gmail.com"
+  gem.authors = ["andy.triggs@gmail.com"]
+  gem.version = AffiliateWindow::Version::STRING
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'spec'
+  test.pattern = 'spec/**/*_spec.rb'
+  test.verbose = false
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "affiliate-window #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/affiliate-window.rb

@@ -0,0 +1,53 @@
+module AffiliateWindow
+
+  require 'csv'
+  require 'net/http'
+  require 'savon'
+  require 'savon_model'
+  require 'affiliate-window/version'
+  require 'affiliate-window/helpers/account'
+  require 'affiliate-window/helpers/client'
+  require 'affiliate-window/helpers/csv'
+  require 'affiliate-window/account'
+  require 'affiliate-window/clients/category'
+  require 'affiliate-window/clients/merchant'
+  require 'affiliate-window/clients/affiliate_service'
+  require 'affiliate-window/clients/shop_window'
+  require 'affiliate-window/models/transaction'
+  
+  DEFAULT_USER_AGENT = "AffiliateWindow rubygem v#{Version::STRING} (http://github.com/andyt/affiliate-window)"
+
+  def self.account
+    @account
+  end
+
+  def self.account=(account)
+    @account = account
+  end
+
+  def self.user_agent
+    @user_agent || DEFAULT_USER_AGENT
+  end
+
+  def self.user_agent=(string)
+    @user_agent = string
+  end
+
+  def self.fetch(uri, target = Tempfile.new('awin').path)
+    uri = URI(uri)
+
+    Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+      request = Net::HTTP::Get.new uri.request_uri, {'User-Agent' => self.user_agent}
+
+      http.request request do |response|
+        open target, 'wb' do |io|
+          response.read_body do |chunk|
+            io.write chunk
+          end
+        end
+      end
+    end
+    target
+  end
+
+end

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: affiliate-window
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre1
+platform: ruby
+authors:
+- andy.triggs@gmail.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.7
+- !ruby/object:Gem::Dependency
+  name: savon_model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+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.
+email: andy.triggs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- ".document"
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/affiliate-window.rb
+homepage: http://github.com/andyt/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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.0
+signing_key: 
+specification_version: 3
+summary: Clients and other publisher tools for using Affiliate Window APIs
+test_files: []