commission_junction 1.4.1 → 1.5.0

data/README.md

@@ -33,25 +33,37 @@ cj = CommissionJunction.new(DEVELOPER_KEY, WEBSITE_ID)
 # See http://help.cj.com/en/web_services/product_catalog_search_service_rest.htm
 # for the list of request and response parameters.
 cj.product_search('keywords' => '+blue +jeans',
-		 'advertiser-ids' => 'joined',
-		 'serviceable-area' => 'us',
-		 'currency' => 'usd',
-		 'records-per-page' => '5').each do |product|
- puts product.name
- puts product.price
- puts product.image_url
- puts ''
+                  'advertiser-ids' => 'joined',
+                  'serviceable-area' => 'us',
+                  'currency' => 'usd',
+                  'records-per-page' => '5').each do |product|
+  puts product.name
+  puts product.price
+  puts product.image_url
+  puts ''
 end
 
 # See http://help.cj.com/en/web_services/advertiser_lookup_service_rest.htm
 # for the list of request and response parameters.
 cj.advertiser_lookup('keywords' => '+used +books',
-		    'advertiser-ids' => 'joined',
-		    'records-per-page' => '5').each do |advertiser|
- puts advertiser.advertiser_name
- puts advertiser.network_rank
- puts advertiser.program_url
- puts ''
+                     'advertiser-ids' => 'joined',
+                     'records-per-page' => '5').each do |advertiser|
+  puts advertiser.advertiser_name
+  puts advertiser.network_rank
+  puts advertiser.program_url
+  puts ''
+end
+
+# See http://help.cj.com/en/web_services/link_search_service_rest.htm
+# for the list of request and response parameters.
+cj.link_search('keywords' => '+used +books',
+               'advertiser-ids' => 'joined',
+               'records-per-page' => '5').each do |link|
+  puts link.link_id
+  puts link.link_name
+  puts link.link_code_html
+  puts link.sale_commission
+  puts ''
 end
 
 # See http://help.cj.com/en/web_services/support_services_rest.htm
@@ -61,14 +73,14 @@ puts cj.categories
 # See http://help.cj.com/en/web_services/Commission_Detail_Service.htm
 # for the list of request and response parameters.
 cj.commissions.each do |commission|
- puts commission.action_type
- puts commission.aid
- puts commission.commission_id
- puts commission.event_date
- puts commission.advertiser_name
- puts commission.commission_amount
- puts commission.sid
- puts ''
+  puts commission.action_type
+  puts commission.aid
+  puts commission.commission_id
+  puts commission.event_date
+  puts commission.advertiser_name
+  puts commission.commission_amount
+  puts commission.sid
+  puts ''
 end
 ```
 
@@ -88,6 +100,7 @@ end
 * [C.J. Sanders](https://github.com/cjsanders)
 * [Michael Nutt](https://github.com/mnutt)
 * [Jean-Sebastien Boulanger](https://github.com/jsboulanger)
+* [luckyjazzbo](https://github.com/luckyjazzbo)
 
 ## Copyright
 

data/lib/commission_junction.rb

@@ -27,6 +27,7 @@ class CommissionJunction
   WEB_SERVICE_URIS =
   {
     :product_search    => 'https://product-search.api.cj.com/v2/product-search',
+    :link_search       => 'https://link-search.api.cj.com/v2/link-search',
     :advertiser_lookup => 'https://advertiser-lookup.api.cj.com/v3/advertiser-lookup',
     :categories        => 'https://support-services.api.cj.com/v2/categories',
     :commissions       => 'https://commission-detail.api.cj.com/v3/commissions'
@@ -128,6 +129,41 @@ class CommissionJunction
     @cj_objects
   end
 
+  def link_search(params)
+    raise ArgumentError, "params must be a Hash; got #{params.class} instead" unless params.is_a?(Hash)
+
+    unless params.size > 0
+      raise ArgumentError, "You must provide at least one request parameter, for example, \"keywords\".\nSee http://help.cj.com/en/web_services/product_catalog_search_service_rest.htm"
+    end
+
+    params['website-id'] = @website_id
+
+    @cj_objects = []
+
+    begin
+      response = self.class.get(WEB_SERVICE_URIS[:link_search], :query => params, :timeout => @timeout)
+
+      cj_api = response['cj_api']
+      error_message = cj_api['error_message']
+
+      raise ArgumentError, error_message if error_message
+
+      links = cj_api['links']
+
+      @total_matched = links['total_matched'].to_i
+      @records_returned = links['records_returned'].to_i
+      @page_number = links['page_number'].to_i
+
+      link = links['link']
+      link = [link] if link.is_a?(Hash) # If we got exactly one result, put it in an array.
+      link.each { |item| @cj_objects << Link.new(item) } if link
+    rescue Timeout::Error
+      @total_matched = @records_returned = @page_number = 0
+    end
+
+    @cj_objects
+  end
+
   def commissions(params = {})
     raise ArgumentError, "params must be a Hash; got #{params.class} instead" unless params.is_a?(Hash)
 
@@ -179,6 +215,9 @@ class CommissionJunction
   class Advertiser < CjObject
   end
 
+  class Link < CjObject
+  end
+
   class Commission < CjObject
   end
 end

data/lib/commission_junction/version.rb

@@ -1,3 +1,3 @@
 class CommissionJunction
-  VERSION = '1.4.1'
+  VERSION = '1.5.0'
 end

data/test/commission_junction_test.rb

@@ -218,7 +218,7 @@ class CommissionJunctionTest < Test::Unit::TestCase
     key_file = File.join(ENV['HOME'], '.commission_junction.yaml')
 
     skip "#{key_file} does not exist. Put your CJ developer key and website ID in there to enable live testing." unless File.exist?(key_file)
-    
+
     credentials = YAML.load(File.read(key_file))
     cj = CommissionJunction.new(credentials['developer_key'], credentials['website_id'])
 
@@ -337,4 +337,51 @@ class CommissionJunctionTest < Test::Unit::TestCase
       assert_respond_to(commission, :sale_amount)
     end
   end
+
+  def test_link_search_live
+    key_file = File.join(ENV['HOME'], '.commission_junction.yaml')
+
+    skip "#{key_file} does not exist. Put your CJ developer key and website ID in there to enable live testing." unless File.exist?(key_file)
+
+    credentials = YAML.load(File.read(key_file))
+    cj = CommissionJunction.new(credentials['developer_key'], credentials['website_id'])
+
+    assert_nothing_raised do
+      cj.link_search('keywords' => '+blue +jeans', 'advertiser-ids' => 'joined')
+    end
+
+    check_link_search_results(cj)
+  end
+
+  def check_link_search_results(results)
+    assert_instance_of(Fixnum, results.total_matched)
+    assert_instance_of(Fixnum, results.records_returned)
+    assert_instance_of(Fixnum, results.page_number)
+    assert_instance_of(Array, results.cj_objects)
+
+    results.cj_objects.each do |link|
+      assert_instance_of(CommissionJunction::Link, link)
+      assert_respond_to(link, :advertiser_id)
+      assert_respond_to(link, :click_commission)
+      assert_respond_to(link, :creative_height)
+      assert_respond_to(link, :creative_width)
+      assert_respond_to(link, :lead_commission)
+      assert_respond_to(link, :link_code_html)
+      assert_respond_to(link, :link_code_javascript)
+      assert_respond_to(link, :destination)
+      assert_respond_to(link, :description)
+      assert_respond_to(link, :link_id)
+      assert_respond_to(link, :link_name)
+      assert_respond_to(link, :link_type)
+      assert_respond_to(link, :advertiser_name)
+      assert_respond_to(link, :performance_incentive)
+      assert_respond_to(link, :promotion_type)
+      assert_respond_to(link, :promotion_start_date)
+      assert_respond_to(link, :promotion_end_date)
+      assert_respond_to(link, :relationship_status)
+      assert_respond_to(link, :sale_commission)
+      assert_respond_to(link, :seven_day_epc)
+      assert_respond_to(link, :three_month_epc)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commission_junction
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-03 00:00:00.000000000 Z
+date: 2012-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -55,18 +55,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2510825910021186561
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2510825910021186561
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24