affiliate-window 0.2.0.pre1 → 0.2.1.pre1

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

@@ -0,0 +1,24 @@
+module AffiliateWindow::Helpers
+
+  # Helper methods for CSV handling.
+  module Csv
+
+    def csv
+      @csv ||= AffiliateWindow.fetch(url)
+    end
+
+    def all
+      items = [];
+      each { |r| items << r }
+      items
+    end
+
+    def each
+      CSV.foreach(csv, :headers => true, :header_converters => :symbol) do |row|
+        yield(row.to_hash)
+      end
+    end
+
+  end  
+
+end

data/lib/affiliate-window/models/transaction.rb

@@ -0,0 +1,92 @@
+# {:i_id=>"59330775", :s_status=>"confirmed", :s_type=>"normal", :s_ip=>"193.130.64.132", :b_paid=>false, :i_payment_id=>"0", :i_merchant_id=>"2698", :f_sale_amount=>"186.29", :f_commission_amount=>"7.45", :d_click_date=>"2011-10-31 17:36:03", :d_transaction_date=>"2011-11-01 12:37:41", :d_validation_date=>"2011-11-22 10:32:50", :s_clickref=>"1185896", :a_transaction_parts=>{:transaction_part=>{:s_commission_group_name=>"Default Commission", :f_sale_amount=>"186.29", :f_commission_amount=>"7.45", :i_commission=>"4", :s_commission_type=>"percentage"}}}
+require 'hashie'
+
+class Hash
+  def deep_find(key)
+    key?(key) ? self[key] : self.values.inject(nil) {|memo, v| memo ||= v.deep_find(key) if v.respond_to?(:deep_find) }
+  end
+end
+
+module AffiliateWindow
+	module Models
+    class Transaction < Hashie::Mash
+
+      include Savon::Model
+
+      CONVERSIONS = {
+        :i => :to_i,
+        :a => :to_a,
+        :f => :to_f,
+        :d => proc { |v| Time.parse(v) },
+        :s => :to_s
+      }
+
+      KEYS = %w{
+        i_id s_status s_type s_ip b_paid i_payment_id i_merchant_id f_sale_amount f_commission_amount d_click_date d_transaction_date 
+        d_validation_date s_clickref a_transaction_parts
+        =>{:transaction_part=>{:s_commission_group_name=>"Default Commission", :f_sale_amount=>"186.29", :f_commission_amount=>"7.45", :i_commission=>"4", :s_commission_type=>"percentage"}}}
+
+      actions :get_transaction, :get_transaction_list
+
+      class << self
+
+        def account=(account)
+          @account = account
+        end
+
+        def account
+          @account || ::AffiliateWindow.account
+        end
+
+        def client
+          @client ||= ::AffiliateWindow::Clients::AffiliateService.new(account)
+        end
+
+        def today
+          initialize_collection_from_hash(get_transaction_list(
+            :d_start_date => Time.now - 3600 * 250,
+            :d_end_date => Time.now,
+            :s_date_type => 'validation'
+          ))
+        end
+
+        def initialize_collection_from_xml(response)
+          puts response.to_xml
+          parse(response.to_xml)
+        end
+
+        def initialize_collection_from_hash(response)
+          response.to_hash.deep_find(:transaction).collect do |hash|
+            self.new(hash)
+          end
+        end
+
+      end
+
+      protected
+
+      def convert_key(key)
+        key.to_s.gsub(/^[#{CONVERSIONS.keys.map(&:to_s).join}]_/, '')
+      end
+
+      def xx_convert_value(val, duping=false) #:nodoc:
+        case val
+          when self.class
+            val.dup
+          when ::Hash
+            val = val.dup if duping
+            self.class.new(val)
+          when Array
+            val.collect{ |e| convert_value(e) }
+          else
+            val
+        end
+      end
+
+      def xx_id
+        attributes[:i_id].to_i
+      end
+
+    end
+  end
+end

data/lib/affiliate-window/version.rb

@@ -0,0 +1,10 @@
+module AffiliateWindow
+  module Version
+    MAJOR = 0
+    MINOR = 2
+    PATCH = 1
+    BUILD = 'pre1'
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end
+end

data/spec/affiliate_window/account_spec.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/../helper'
+
+module AffiliateWindow
+  class AccountSpec < MiniTest::Unit::TestCase
+
+    Klass = ::AffiliateWindow::Account
+
+    describe Klass do
+
+      describe '#compression_parameter' do
+        it 'should return an empty string if compression is :none' do
+          @account = account
+          @account.compression = :none
+          @account.compression_parameter.must_equal ''
+        end
+
+        it 'requires a datafeed password' do
+          proc { Klass.new(account.attributes.merge(:datafeed_password => nil)) }.must_raise ArgumentError
+        end
+
+        it 'requires an API password' do
+          proc { Klass.new(account.attributes.merge(:api_password => nil)) }.must_raise ArgumentError
+        end
+
+        it 'requires an API key' do
+          proc { Klass.new(account.attributes.merge(:api_key => nil)) }.must_raise ArgumentError
+        end
+
+      end
+    end
+
+  end
+end

data/spec/affiliate_window/clients/affiliate_service_spec.rb

@@ -0,0 +1,51 @@
+
+
+module AffiliateWindow
+  module Clients
+
+    Klass = ::AffiliateWindow::Clients::AffiliateService
+
+    describe Klass do
+      
+      it 'has a local cache of the WSDL document' do
+        File.exists?(Klass::CACHED_WSDL_PATH).must_equal true
+      end
+
+      describe '.new' do
+        it 'requires an account' do
+          proc { Klass.new }.must_raise ArgumentError
+        end
+      end
+
+      describe 'Instances' do
+        before do
+          FakeWeb.register_uri(:any, Klass::ENDPOINT_URL, :response => File.join(fixture_path, 'responses', 'get_transaction_list.xml'))
+          @client = Klass.new(account)
+        end
+
+        it 'has an array of actions' do
+          @client.wsdl.soap_actions.must_equal Klass::ACTIONS
+        end
+
+        it 'returns a transaction list' do
+          method = :get_transaction_list
+          response = @client.request(method) do
+            soap.body = {
+              :d_start_date => Time.now - 3600 * 250,
+              :d_end_date => Time.now,
+              :s_date_type => 'validation'
+            }
+          end
+          response.soap_fault?.must_equal false
+          response.http_error?.must_equal false
+          response.success?.must_equal true
+          response.to_hash[:"#{method}_response"].must_be_instance_of Hash
+          response.to_hash[:"#{method}_response"][:"#{method}_return"][:transaction].must_be_instance_of Array
+          transaction = response.to_hash[:"#{method}_response"][:"#{method}_return"][:transaction].first
+          transaction.must_be_instance_of Hash
+        end
+      end
+
+    end
+  end
+end

data/spec/affiliate_window/clients/category_spec.rb

@@ -0,0 +1,39 @@
+require_relative '../../helper'
+
+module AffiliateWindow
+  module Clients
+    class CategorySpec < MiniTest::Unit::TestCase
+
+      Klass = AffiliateWindow::Clients::Category
+
+      describe Klass do
+        
+        describe '.new' do
+          it 'requires an account' do
+            proc { Klass.new }.must_raise ArgumentError
+          end
+        end
+
+        describe 'Instances' do
+          before do
+            @client = Klass.new(account)
+          end
+
+          it 'handles CSV files' do
+            @client.must_respond_to :csv
+            @client.must_respond_to :each
+            @client.must_respond_to :all
+          end
+          
+          describe '#url' do
+            it 'returns a completed URL template' do
+              @client.url.must_match /#{account.user}/
+              @client.url.must_match /#{account.datafeed_password}/
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/spec/affiliate_window/clients/merchant_spec.rb

@@ -0,0 +1,48 @@
+require_relative '../../helper'
+
+module AffiliateWindow
+  module Clients
+    class MerchantSpec < MiniTest::Unit::TestCase
+
+      Klass = ::AffiliateWindow::Clients::Merchant
+
+      describe Klass do
+        
+        describe '.new' do
+          it 'requires an account' do
+            proc { Klass.new }.must_raise ArgumentError
+          end
+
+          it 'sets a default filter' do
+            client = Klass.new(nil, account)
+            client.filter.wont_be_empty
+          end
+
+          it 'raises an error if filter is invalid' do
+            proc { Klass.new('DUFF_FILTER', account) }.must_raise ArgumentError
+          end
+        end
+
+        describe 'Instances' do
+          before do
+            @client = Klass.new(nil, account)
+          end
+
+          it 'handles CSV files' do
+            @client.must_respond_to :csv
+            @client.must_respond_to :each
+            @client.must_respond_to :all
+          end
+          
+          describe '#url' do
+            it 'returns a completed URL template' do
+              @client.url.must_match /#{account.user}/
+              @client.url.must_match /#{account.datafeed_password}/
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/spec/affiliate_window/clients/shop_window_spec.rb

@@ -0,0 +1,41 @@
+require_relative '../../helper'
+
+module AffiliateWindow
+  module Clients
+    class ShopWindowSpec < MiniTest::Unit::TestCase
+
+      Klass = ::AffiliateWindow::Clients::ShopWindow
+
+      describe Klass do
+        
+        describe '.new' do
+          it 'requires an account' do
+            proc { Klass.new }.must_raise ArgumentError
+          end
+        end
+
+        describe 'Instances' do
+          before do
+            @merchant_ids = [1,2,3]
+            @client = Klass.new(:account => account, :merchant_ids => @merchant_ids)
+          end
+
+          it 'handles CSV files' do
+            @client.must_respond_to :csv
+            @client.must_respond_to :each
+            @client.must_respond_to :all
+          end
+          
+          describe '#url' do
+            it 'returns a completed URL template' do
+              @client.url.must_match /#{account.api_key}/
+              @client.url.must_match /#{@merchant_ids.join(',')}/
+              @client.url.must_match /#{Klass::DEFAULT_COLUMNS.join(',')}/
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/spec/affiliate_window/helpers/csv_spec.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/../../helper'
+
+module AffiliateWindow
+  module Helpers
+    class CsvSpec < MiniTest::Unit::TestCase
+
+      class ExtendedByCsvHelper
+        include AffiliateWindow::Helpers::Csv
+        def url; "http://example.com/"; end
+      end
+
+      describe ::AffiliateWindow::Helpers::Csv do
+        before do
+          @instance = ExtendedByCsvHelper.new
+        end
+
+        describe '#csv' do
+          it 'should return CSV path' do
+            AffiliateWindow.stubs(:fetch).returns('/path/to/file.csv')
+            @instance.csv
+          end
+        end
+
+        describe '#each' do
+          it 'should return each item in the CSV as a hash with symbolized keys' do
+            AffiliateWindow.stubs(:fetch).returns(File.join(fixture_path, 'csv', 'merchants.csv'))
+            @instance.each do |r|
+              r.must_be_kind_of Hash
+              r.keys.map(&:class).uniq.must_equal [Symbol]
+            end
+          end
+        end
+
+        describe '#all' do
+          it 'should return all items in the CSV' do
+            AffiliateWindow.stubs(:fetch).returns(File.join(fixture_path, 'csv', 'merchants.csv'))
+            @instance.all.size.must_equal 2
+          end
+        end
+      end
+    end
+  end
+end

data/spec/affiliate_window/models/transaction_spec.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/../../helper'
+
+module AffiliateWindow
+  module Models
+    class TransactionSpec < MiniTest::Unit::TestCase
+
+      Klass = ::AffiliateWindow::Models::Transaction
+
+      describe Klass do
+        
+        before do
+          FakeWeb.register_uri(:any, AffiliateWindow::Clients::AffiliateService::ENDPOINT_URL, :response => File.join(fixture_path, 'responses', 'get_transaction_list.xml'))
+          Klass.account = account
+        end
+
+        it 'stores an account' do
+          Klass.account.must_be_kind_of AffiliateWindow::Account
+        end
+
+        it 'returns a transaction list' do
+          method = :get_transaction_list
+          Klass.get_transaction_list(
+            :d_start_date => Time.now - 3600 * 250,
+            :d_end_date => Time.now,
+            :s_date_type => 'validation'
+          ).must_be_kind_of Savon::SOAP::Response
+        end
+
+        it 'returns transactions from today' do
+          collection = Klass.today
+          transaction = collection.first
+
+          collection.must_be_kind_of Array
+          transaction.must_be_kind_of Klass
+          transaction.id.must_equal '59330775'
+          
+          transaction.transaction_parts.must_be_kind_of Array
+          
+        end
+
+      end
+    end
+  end
+end

data/spec/affiliate_window_spec.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+class AffiliateWindowSpec < MiniTest::Unit::TestCase
+
+    describe ::AffiliateWindow do
+
+    it "should store an account" do
+      @account = account
+      AffiliateWindow.account = @account
+      AffiliateWindow.account.must_be_same_as @account
+      AffiliateWindow.account = nil # teardown
+    end
+
+    it "should have a default user agent string" do
+      AffiliateWindow.user_agent.must_match /AffiliateWindow/
+    end
+
+    it "should store a custom user agent string" do
+      AffiliateWindow.user_agent = 'AffiliateWindow test'
+      AffiliateWindow.user_agent.must_equal 'AffiliateWindow test'
+    end
+
+    it "should fetch files and return the local filename" do
+      FakeWeb.register_uri(:any, 'http://affiliatewindow.com/merchants.csv', :response => File.join(fixture_path, 'responses', 'merchants.csv'))
+      AffiliateWindow.fetch('http://affiliatewindow.com/merchants.csv', '/tmp/test').must_equal '/tmp/test'
+    end
+  end
+end