farleyknight-commission_junction 1.0.4 → 1.1

data/History.txt

@@ -6,3 +6,7 @@
 == 1.0.2
 
 * Added RDocs and simple example
+
+== 1.1
+
+* Added storage capabilities

data/README.rdoc

@@ -2,7 +2,7 @@
 
 == What?
 
-A Soap API for CommissionJunction
+A Soap API for CommissionJunction, plus some local storage capabilities..
 
 == Where?
 
@@ -12,6 +12,8 @@ http://github.com/farleyknight/commission_junction/
 
 This API is mostly based on the Symfony plugin: http://trac.symfony-project.org/wiki/sfCommissionJunctionPlugin
 
+The storage functionality is still mostly a prototype for now.
+
 == Git it:
 
 $ gem sources -a http://gems.github.com 

data/Rakefile

@@ -1,4 +1,8 @@
 require 'config/requirements'
-require 'config/hoe' # setup Hoe + all gem configuration
 
-Dir['tasks/**/*.rake'].each { |rake| load rake }
+Dir['tasks/**/*.rake'].each { |rake| load rake }
+
+desc "Rebuilds the rdoc pages"
+task :rdoc do
+  `rdoc README.rdoc  lib/* lib/commission_junction/* -o doc`
+end

data/commission_junction.gemspec

@@ -1,16 +1,23 @@
 
 Gem::Specification.new do |s|
-  s.name = "commission_junction"
-  s.version = "1.0.4"
-  s.date = "2008-07-24"
-  s.summary = "Commission Junction SOAP API" 
-  s.email = "farleyknight@gmail.com"
-  s.homepage = "http://github.com/farleyknight/commission_junction/"
-  s.description = "Commission Junction SOAP API"
-  s.has_rdoc = true
-  s.authors = ["Farley Knight"]
-  s.files = ["History.txt", "Manifest.txt", "README.txt", "Rakefile", "commission_junction.gemspec", "lib/commission_junction.rb", "lib/commission_junction/ext.rb", "examples/based_on_website.rb"]
-  s.rdoc_options = ["--main", "README.rdoc"]
+  s.name             = "commission_junction"
+  s.version          = "1.1"
+  s.date             = "2008-09-23"
+  s.summary          = "Commission Junction SOAP API" 
+  s.email            = "farleyknight@gmail.com"
+  s.homepage         = "http://github.com/farleyknight/commission_junction/"
+  s.description      = "Commission Junction SOAP API"
+  s.has_rdoc         = true
+  s.authors          = ["Farley Knight"]
+  s.files            = [
+    "History.txt", "Manifest.txt", "README.txt", "Rakefile", 
+    "commission_junction.gemspec", 
+    "lib/commission_junction.rb", 
+    "lib/commission_junction/migrate.rb", 
+    "lib/commission_junction/search_link.rb", 
+    "lib/commission_junction/ext.rb", 
+    "examples/based_on_website.rb"]
+  s.rdoc_options     = ["--main", "README.rdoc"]
   s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.rdoc"]
 end
 

data/lib/commission_junction.rb

@@ -1,9 +1,12 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
+require 'yaml'
 require 'soap/wsdlDriver'
 require 'commission_junction/ext'
 
+#
+# = General Usage
 #
 # A fairly simple example of the library
 #   require 'commission_junction'
@@ -27,14 +30,14 @@ require 'commission_junction/ext'
 #   pp results
 #   
 #   Outputs:
-#   # {"totalResults"=>"1200",
-#   #  "count"=>"10",
-#   #  "links"=>
-#   #   {"LinkDetail"=>
-#   #     [{"threeMonthEPC"=>"-9999999.0",
-#   #       "sevenDayEPC"=>"-9999999.0",
-#   #       "promotionType"=>{},
-#   #       "linkDestination"=>
+#    {"totalResults"=>"1200",
+#     "count"=>"10",
+#     "links"=>
+#      {"LinkDetail"=>
+#        [{"threeMonthEPC"=>"-9999999.0",
+#          "sevenDayEPC"=>"-9999999.0",
+#          "promotionType"=>{},
+#          "linkDestination"=>
 #
 # Another example, using 'sortBy', shown in the web services documentation
 #   results = cj.searchLinks(:keywords => "kitchen sink", :sortBy => "linkId")
@@ -42,26 +45,96 @@ require 'commission_junction/ext'
 #   pp results
 #   
 #   Outputs:
-#   # {"totalResults"=>"1200",
-#   #  "count"=>"10",
-#   #  "links"=>
-#   #   {"LinkDetail"=>
-#   #     [{"threeMonthEPC"=>"-9999999.0",
-#   #       "sevenDayEPC"=>"-9999999.0",
-#   #       "promotionType"=>{},
-#   #       "linkDestination"=>
-#   #        "http://www.vintagetub.com/asp/sinks.asp?utm_id=ID2001",
-#   #       "relationshipStatus"=>"notjoined",
-#   #       "linkId"=>"10411673",
-#   #       "category"=>"bed & bath",
-#   #       "linkCodeJavascript"=>{},
+#    {"totalResults"=>"1200",
+#     "count"=>"10",
+#     "links"=>
+#      {"LinkDetail"=>
+#        [{"threeMonthEPC"=>"-9999999.0",
+#          "sevenDayEPC"=>"-9999999.0",
+#          "promotionType"=>{},
+#          "linkDestination"=>
+#           "http://www.vintagetub.com/asp/sinks.asp?utm_id=ID2001",
+#          "relationshipStatus"=>"notjoined",
+#          "linkId"=>"10411673",
+#          "category"=>"bed & bath",
+#          "linkCodeJavascript"=>{},
+#
+# = Configuration
+# 
+# If you don't want to pass your key and id on each instatiation of 
+# of CommissionJunction, create a yaml file:
+# 
+#   $HOME/.commission_junction.yaml
+# 
+# With $HOME being, of course, your home directory. Then include:
+# 
+#   developerKey: "1234567890abc...."
+#   websiteId: "1234567"
+# 
+#
+# = Storage
+# 
+# For convenience and more "on demand" usage of searchLinks
+# service, you can set up the ActiveRecord database table
+# and model, instead of fetching it on every request. 
+#
+# Here's an example, 
+#
+# 1) First add your database information to the commission 
+# junction config, mentioned above:
+#   
+#   developerKey: "1234567890abc...."
+#   websiteId: "1234567"
+#
+#   database:
+#     adapter: mysql
+#     database: commission_junction
+#     username: cj
+#     host: localhost
+#
+# 2) Create your database:
+# 
+#   >> mysql -ucj
+#
+#   mysql> create database commission_junction;
+# 
+# 3) Then open up irb and run the migration to set up the
+# table itself
+# 
+#   >> require 'rubygems'
+#   >> require 'commission_junction'
+#   >> 
+#   >> CommissionJunction.migrate!
+#
+#   ==  CreateSearchLinks: migrating ==============================================
+#   -- create_table(:search_links)
+#      -> 0.1812s
+#   ==  CreateSearchLinks: migrated (0.1817s) =====================================
+#
+#   => ["CreateSearchLinks"]
+#  
+# A more preferable method may be found so this step
+# may change in the future, but for now it's adequate.
+# 
+# 4) Next you'll want to start loading it with content. 
+# 
+#   require 'commission_junction/search_link'
+#   
+#   SearchLink.update!
+#   
+# This should start to load your table with all the categories 
+# available from Commission Junction. This may take awhile so
+# you may want to schedule this at regular intervals instead
+# of doing so by hand.
 #
+# Scheduling section coming soon..
+# 
 
 class CommissionJunction
   module VERSION 
     MAJOR = 1
-    MINOR = 0
-    TINY  = 2
+    MINOR = 1
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end
@@ -76,8 +149,18 @@ class CommissionJunction
     'FieldTypesSupport'   =>  'https://product.api.cj.com/wsdl/version2/supportServiceV2.wsdl'
   }
 
-  def initialize(developerKey, websiteId)
-    @developerKey, @websiteId = developerKey, websiteId
+  #
+  # If you've supplied the config file with the proper credentials
+  # then you don't need to pass a key or id.
+  #
+  # Also, any values passed will overwrite the config file's values
+  #
+  def initialize(developerKey = nil, websiteId =nil)
+    if File.exists?(Config.file)
+      parse_config_file!
+    end
+    @developerKey ||= developerKey
+    @websiteId    ||= websiteId
   end
 
   #
@@ -190,6 +273,10 @@ class CommissionJunction
   def getLanguages
     doOperation('FieldTypesSupport', 'getLanguages', self.instance_variables_hash)
   end
+  
+  def database_enabled?
+    not @database.nil?
+  end
 
   protected
   def doOperation(service, method, params)
@@ -197,4 +284,36 @@ class CommissionJunction
     driver = factory.create_rpc_driver
     driver.send(method, params).to_hash["out"]
   end
+
+  def parse_config_file!
+    config = Config.parse!
+    @developerKey = config["developerKey"]
+    @websiteId    = config["websiteId"]
+    @database     = config["database"]
+  end
+
+  def self.migrate!
+    db_connect!
+    require 'commission_junction/migrate'
+  end
+
+  def self.db_connect!
+    require 'active_record'
+    config = CommissionJunction::Config.parse!
+    ActiveRecord::Base.establish_connection(config["database"])
+  end
+
+  class Config
+    #
+    # The configuration file should be created at 
+    # $HOME/.commission_junction
+    #
+    def self.file
+      File.join(ENV['HOME'], ".commission_junction.yaml")    
+    end
+    
+    def self.parse!
+      YAML.load(File.read(file))      
+    end
+  end
 end

data/lib/commission_junction/ext.rb

@@ -8,6 +8,16 @@ Array.class_eval do
   end
 end
 
+Hash.class_eval do
+  def except!(keys)
+    keys.each { |key| delete(key) }    
+  end
+
+  def except(keys)
+    clone.except!(keys)
+  end
+end
+
 Object.class_eval do
   def instance_variables_hash
     instance_variables.inject({}) do |hash, name| 

data/lib/commission_junction/migrate.rb

@@ -0,0 +1,30 @@
+
+class CreateSearchLinks < ActiveRecord::Migration
+  def self.up
+    create_table :search_links do |t|
+      t.string  :promotionType
+      t.string  :linkDestination
+      t.string  :category
+      t.string  :language
+      t.string  :advertiserName
+      t.string  :linkDescription
+      t.string  :saleCommission
+      t.string  :linkType
+      t.string  :linkName
+      t.decimal :clickCommission
+      t.integer :advertiserId
+      t.integer :linkId
+    end
+  end
+end
+
+
+CreateSearchLinks.migrate(:up)
+
+# class CreateCategories < ActiveRecord::Migration
+#   def self.up
+#     create_table :categories do
+#       t.string :name
+#     end
+#   end
+# end

data/lib/commission_junction/search_link.rb

@@ -0,0 +1,32 @@
+
+require 'rubygems'
+require 'active_record'
+
+class SearchLink < ActiveRecord::Base
+  establish_connection(CommissionJunction::Config.parse!["database"])
+  
+  def self.update!
+    cj = CommissionJunction.new
+    categories = cj.getCategories["string"]
+    categories.each do |category|
+      puts "Querying #{category} for links"
+      results = cj.searchLinks(:category => category, :maxResults => 100)
+      links = results["links"]["LinkDetail"]
+
+      unless links.nil?
+        links.each do |result|
+          SearchLink.create_from_query!(result)
+        end
+      end
+    end
+  end
+
+  def self.create_from_query!(result)
+    link = new
+    result.each do |key, value|
+      link.send("#{key}=", value) if key.is_a? Symbol and link.respond_to? key
+    end
+    link.save!
+    link
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: farleyknight-commission_junction
 version: !ruby/object:Gem::Version 
-  version: 1.0.4
+  version: "1.1"
 platform: ruby
 authors: 
 - Farley Knight
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-24 00:00:00 -07:00
+date: 2008-09-23 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -30,6 +30,8 @@ files:
 - Rakefile
 - commission_junction.gemspec
 - lib/commission_junction.rb
+- lib/commission_junction/migrate.rb
+- lib/commission_junction/search_link.rb
 - lib/commission_junction/ext.rb
 - examples/based_on_website.rb
 - README.rdoc