farleyknight-commission_junction 1.0.0 → 1.0.1

data/README.txt

@@ -1,25 +1,24 @@
 = commission_junction
 
-* http://github.com/farleyknight/commission_junction/
+== What?
 
-== DESCRIPTION:
+A Soap API for CommissionJunction
 
-A Soap API for Commission Junction
+== Where?
 
-== FEATURES/PROBLEMS:
+http://github.com/farleyknight/commission_junction/
 
-* http://webservices.cj.com/
+== How?
 
-== SYNOPSIS:
+This API is mostly based on the Symfony plugin: http://trac.symfony-project.org/wiki/sfCommissionJunctionPlugin
 
-* This API is mostly based on the Symfony plugin: http://trac.symfony-project.org/wiki/sfCommissionJunctionPlugin
+== Git it:
 
-== INSTALL:
+$ gem sources -a http://gems.github.com 
 
-* $ gem sources -a http://gems.github.com # add github to your sources
-* $ sudo gem install farleyknight-commission_junction 
+$ sudo gem install farleyknight-commission_junction 
 
-== LICENSE:
+== License:
 
 (The MIT License)
 
@@ -42,4 +41,4 @@ 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.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/commission_junction.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "commission_junction"
-  s.version = "1.0.0"
+  s.version = "1.0.1"
   s.date = "2008-07-24"
   s.summary = "Commission Junction SOAP API" 
   s.email = "farleyknight@gmail.com"
@@ -8,7 +8,9 @@ Gem::Specification.new do |s|
   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"]
+  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.txt"]
   s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
 end
+
+

data/examples/based_on_website.rb

@@ -0,0 +1,49 @@
+
+# A fairly simple example of the library
+
+require 'commission_junction'
+
+# Your developer key
+developerKey = "1234567890abc...."
+
+# Your Web site ID (PID)
+websiteId    = "1234567"
+
+# A new instance of the Commission Junction service API
+cj = CommissionJunction.new(developerKey, websiteId)
+
+# A minimal search, using the keywords parameter
+result = cj.searchLinks(:keywords => "kitchen sink")
+
+# All CJ results are hashes.. I found this to be easier to
+# use than objects because hashes are more transparent:
+
+pp results
+# =>
+# {"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")
+
+pp results
+# => 
+# {"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"=>{},

data/lib/commission_junction.rb

@@ -4,7 +4,67 @@ $:.unshift(File.dirname(__FILE__)) unless
 require 'soap/wsdlDriver'
 require 'commission_junction/ext'
 
+#
+# A fairly simple example of the library
+#   require 'commission_junction'
+#
+# Your developer key
+#   developerKey = "1234567890abc...."
+#
+# Your Web site ID (PID)
+#   websiteId    = "1234567"
+#
+# A new instance of the Commission Junction service API
+#   cj = CommissionJunction.new(developerKey, websiteId)
+#
+# A minimal search, using the keywords parameter
+#   result = cj.searchLinks(:keywords => "kitchen sink")
+#
+# All CJ results are hashes.. I found this to be easier to
+# use than objects because hashes are more transparent:
+#
+#   pp results
+#   
+#   Outputs:
+#   # {"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")
+#
+#   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"=>{},
+#
+
 class CommissionJunction
+  module VERSION 
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 2
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+
   @@wsdls = {
     'ProductSearch'       =>  'https://product.api.cj.com/wsdl/version2/productSearchServiceV2.wsdl',
     'LinkSearch'          =>  'https://product.api.cj.com/wsdl/version2/linkSearchServiceV2.wsdl',
@@ -20,6 +80,7 @@ class CommissionJunction
   end
 
   #
+  # For a list of possible params (where applicable) or more information, go to:
   # http://help.cj.com/en/web_services/Product_Catalog_Search_Service_v.2.htm
   #
   def productSearch(params = {})
@@ -27,34 +88,39 @@ class CommissionJunction
   end
 
   # 
+  # For a list of possible params (where applicable) or more information, go to:
   # http://help.cj.com/en/web_services/Link_Search_Service_v.2.htm
   #
   def searchLinks(params = {})
-    doOperation('LinkSearch', __method__, self.instance_variables_hash.merge(params))
+    doOperation('LinkSearch', 'searchLinks', self.instance_variables_hash.merge(params))
   end  
 
   #
+  # For a list of possible params (where applicable) or more information, go to:
   # http://help.cj.com/en/web_services/Publisher_Commission_Service.htm
   # 
   def findPublisherCommissions(params = {})
-    doOperation('PublisherCommission', __method__, self.instance_variables_hash.merge(params))
+    doOperation('PublisherCommission', 'findPublisherCommissions', self.instance_variables_hash.merge(params))
   end
   
   #
+  # For a list of possible params (where applicable) or more information, go to:
   # http://help.cj.com/en/web_services/Publisher_Commission_Service.htm
   # 
   def findPublisherCommissionDetails(params = {})
-    doOperation('PublisherCommission', __method__, self.instance_variables_hash.merge(params))
+    doOperation('PublisherCommission', 'findPublisherCommissionDetails', self.instance_variables_hash.merge(params))
   end
   
   #
+  # For a list of possible params (where applicable) or more information, go to:
   # http://help.cj.com/en/web_services/Real_Time_Commission_Service.htm
   # 
   def retrieveLatestTransactions(params = {})
-    doOperation('RealTimeCommission', __method__, self.instance_variables_hash.merge(params))
+    doOperation('RealTimeCommission', 'retrieveLatestTransactions', self.instance_variables_hash.merge(params))
   end
   
   #
+  # For a list of possible params (where applicable) or more information, go to:
   # http://help.cj.com/en/web_services/Advertiser_Search_Service_v.2.htm
   #
   def advertiserSearch(params = {})
@@ -64,47 +130,54 @@ class CommissionJunction
   end
 
   #
+  # For a list of possible params (where applicable) or more information, go to:
   # http://help.cj.com/en/web_services/Publisher_Lookup_Service.htm
   #
   def publisherLookup(token)
-    doOperation('PublisherLookup', __method__, self.instance_variables_hash.merge({:token => token}))
+    doOperation('PublisherLookup', 'publisherLookup', self.instance_variables_hash.merge({:token => token}))
   end
 
   #
+  # For a list of possible params (where applicable) or more information, go to:
   # http://help.cj.com/en/web_services/Support_Services.htm
   #
   def getCategories(locale = 'US')
-    doOperation('FieldTypesSupport', __method__, self.instance_variables_hash.merge({:locale => locale}))
+    doOperation('FieldTypesSupport', 'getCategories', self.instance_variables_hash.merge({:locale => locale}))
   end
 
   #
+  # For a list of possible params (where applicable) or more information, go to:
   # http://help.cj.com/en/web_services/Support_Services.htm
   #
   def getLinkTypes
-    doOperation('FieldTypesSupport', __method__, self.instance_variables_hash)
+    doOperation('FieldTypesSupport', 'getLinkTypes', self.instance_variables_hash)
   end
   
   #
+  # For a list of possible params (where applicable) or more information, go to:
   # http://help.cj.com/en/web_services/Support_Services.htm
   #
   def getLinkSizes
-    doOperation('FieldTypesSupport', __method__, self.instance_variables_hash)
+    doOperation('FieldTypesSupport', 'getLinkSizes', self.instance_variables_hash)
   end
 
   #
+  # For a list of possible params (where applicable) or more information, go to:
   # http://help.cj.com/en/web_services/Support_Services.htm
   #
   def getCountries(locale = 'US')
-    doOperation('FieldTypesSupport', __method__, self.instance_variables_hash.merge({:locale => locale}))
+    doOperation('FieldTypesSupport', 'getCountries', self.instance_variables_hash.merge({:locale => locale}))
   end
 
   #
+  # For a list of possible params (where applicable) or more information, go to:
   # http://help.cj.com/en/web_services/Support_Services.htm
   #
   def getLanguages
-    doOperation('FieldTypesSupport', __method__, self.instance_variables_hash)
+    doOperation('FieldTypesSupport', 'getLanguages', self.instance_variables_hash)
   end
 
+  protected
   def doOperation(service, method, params)
     factory = SOAP::WSDLDriverFactory.new(@@wsdls[service])
     driver = factory.create_rpc_driver

data/lib/commission_junction/ext.rb

@@ -8,14 +8,6 @@ Array.class_eval do
   end
 end
 
-# Hash.class_eval do
-#   def to_struct
-#     return {} if empty?
-#     keys = self.keys.map {|k| k.to_sym }
-#     Struct.new(*keys).new(*(self.values))
-#   end
-# end
-
 Object.class_eval do
   def instance_variables_hash
     instance_variables.inject({}) do |hash, name| 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: farleyknight-commission_junction
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Farley Knight
@@ -31,6 +31,7 @@ files:
 - commission_junction.gemspec
 - lib/commission_junction.rb
 - lib/commission_junction/ext.rb
+- examples/based_on_website.rb
 has_rdoc: true
 homepage: http://github.com/farleyknight/commission_junction/
 post_install_message: