linkshare_api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b32e4d516fc03567a0d237cf9668ff023e873ed7
-  data.tar.gz: 729a0129c9b661d5d3f211c5c7919bfe67e732ec
+  metadata.gz: ff42adfc68ce3f7ab0b44825493ac5d4a1962afa
+  data.tar.gz: bcbc838cd106dd6e6f0968b8645c4aa472f08e01
 SHA512:
-  metadata.gz: 6f4053896f431cd45d1500a053ebf5fefef4c26783719f983b434bc36656ef712b297a50f5777ed9fae9569e25afabbfdf8b4df06a4118b44020a34b590e456f
-  data.tar.gz: 47dfebd2653f171431b0c5bbebe03020e79ec2a9612fe6822950fee56f8d342bb43fc3d41e78ad783fced9ccb54a0e39b7fe212a83a2f561d3981a858943d22b
+  metadata.gz: 6d9731f6389f7b36201c1c1c01cd0488d1b738981d84bf29b6f8331b7a246ec06919d1a7c6be3be4ccae2b20439c75a6020662e1d26d358e78e14d716e885e79
+  data.tar.gz: f8c4a1dbebd67445fed46fe63c9c6b8386a248cb7b576b61bf3e12743522de2a867dd9ad52811a183f4556a0181b9a3080f18c93a3c17654aa311289d13c78dc

data/.ruby-version

@@ -1 +1 @@
-2.1.1
+2.1.3

data/README.md

@@ -3,14 +3,19 @@
 [![Gem Version](https://badge.fury.io/rb/linkshare_api.png)](http://badge.fury.io/rb/linkshare_api)
 [![Build Status](https://travis-ci.org/rmarescu/linkshare_api.png)](https://travis-ci.org/rmarescu/linkshare_api)
 
-Ruby wrapper for [LinkShare Publisher Web Services](http://helpcenter.linkshare.com/publisher/categories.php?categoryid=71).
+Ruby wrapper for [LinkShare Publisher Web Services](https://rakutenlinkshare.zendesk.com).
 Supported web services:
-* [Automated LinkGenerator](#automated-link-generator)
+* [Deep Linking](#deep-linking) (previously [Automated LinkGenerator](#automated-link-generator))
 * [Merchandiser Query Tool](#merchandiser-query-tool)
+* [Coupon Web Service](#coupon-web-service)
 
 If you need services that are not yet supported, feel free to [contribute](#contributing).
 For questions or bugs please [create an issue](../../issues/new).
 
+## <a id="requirement"></a>Requirements
+
+[Ruby](http://www.ruby-lang.org/en/downloads/) 1.9 or above.
+
 ## <a id="installation"></a>Installation
 
 Add this line to your application's Gemfile:
@@ -25,32 +30,68 @@ Or install it yourself as:
 
     $ gem install linkshare_api
 
-## <a id="requirement"></a>Requirements
+## <a id="configuration"></a>Configuration
 
-[Ruby](http://www.ruby-lang.org/en/downloads/) 1.9 or above.
+Before using **LinkShare API** you need to set up your publisher token first. If you use Ruby on Rails, the token can be set in a configuration file (i.e. `app/config/initializers/linkshare_api.rb`), otherwise just set it in your script. The token can be found on LinkShare's Web Services page under the Links tab.
 
-## <a id="usage"></a>Usage
+```ruby
+LinkshareAPI.token = ENV["LINKSHARE_TOKEN"]
+```
 
-Before using **LinkShare API** you need to set up your publisher token first. If you use Ruby on Rails, the token can be set in a configuration file (i.e. `app/config/initializers/linkshare_api.rb`), otherwise just set it in your script. The token can be found on LinkShare's Web Services page under the Links tab.
+Affiliate ID is required for using Deep Linking.
+
+```ruby
+LinkshareAPI.affiliate_id = ENV["LINKSHARE_AFFILIATE_ID"]
+```
+
+By default linkshare_api logs to STDOUT. To use your own logger implementation you have to specify it using `LinkshareAPI.logger`
+
+### Configuration example
+
+Would apply for Ruby on Rails. Create `app/config/initializers/linkshare_api.rb` and add the following content:
 
 ```ruby
-require "linkshare_api" # no need for RoR
 LinkshareAPI.token = ENV["LINKSHARE_TOKEN"]
+LinkshareAPI.affiliate_id = ENV["LINKSHARE_AFFILIATE_ID"]
+LinkshareAPI.logger = Rails.logger
+```
+
+## <a id="usage"></a>Usage
+
+### Deep Linking
+
+Generate affiliate URLs using [Deep Linking](https://rakutenlinkshare.zendesk.com/hc/en-us/articles/201295755-Guide-to-Deep-Linking) service.
+Below is an example of generating an affiliate URL for [Walmart](http://www.walmart.com). Walmart merchant code is `2149`.
+
+```ruby
+require "linkshare_api" # No need for RoR
+
+LinkshareAPI.affiliate_id = ENV["LINKSHARE_AFFILIATE_ID"] # must be set in order to use Deep Linking, otherwise will fall back to Automated Link Generator
+url = "http://www.walmart.com/cp/Electronics/3944?povid=P1171-C1093.2766-L33"
+affiliate_url = LinkshareAPI.link_generator(2149, url)
+# http://click.linksynergy.com/deeplink?id=your_affiliate_id&mid=2149&murl=http%3A%2F%2Fwww.walmart.com%2Fcp%2FElectronics%2F3944%3Fpovid%3DP1171-C1093.2766-L33
 ```
 
+**Note:** The link is generated manually, therefore you must ensure that the Affiliate ID provided is valid.
+
 ### Automated Link Generator
 
-Generate affiliate URLs using [Automated LinkGenerator](http://helpcenter.linkshare.com/publisher/categories.php?categoryid=72) service.
+**Deprecation Notice**
+
+**As of October 2014, Automated LinkGenerator is discontinued in favor of Deep Linking.** To use [Deep Linking](#deep-linking) instead, you only have to set `LinkshareAPI.affiliate_id`. Everything else remains the same.
+
+Generate affiliate URLs using [Automated LinkGenerator](https://rakutenlinkshare.zendesk.com/hc/en-us/articles/201343135-Automated-LinkGenerator-Guidelines) service.
 Below is an example of generating an affiliate URL for [Walmart](http://www.walmart.com). Walmart merchant code is `2149`.
 
 ```ruby
 url = "http://www.walmart.com/cp/Electronics/3944?povid=P1171-C1093.2766-L33"
 affiliate_url = LinkshareAPI.link_generator(2149, url)
+# http://linksynergy.walmart.com/fs-bin/click?id=your_affiliate_id&subid=0&offerid=223073.1&type=10&tmpid=273&RD_PARM1=http%3A%2F%2Fwww.walmart.com%2Fcp%2FElectronics%2F3944%3F&RD_PARM2=povid%3DP1171-C1093.2766-L33
 ```
 
 ### Merchandiser Query Tool
 
-Search for products using [Merchandiser Query Tool](http://helpcenter.linkshare.com/publisher/categories.php?categoryid=74) service.
+Search for products using [Merchandiser Query Tool](https://rakutenlinkshare.zendesk.com/hc/en-us/articles/201483905-Merchandiser-Query-Tool-API-Guidelines) service.
 
 ```ruby
 response = LinkshareAPI.product_search(keyword: "laptop")
@@ -70,7 +111,7 @@ response.data.each do |item|
 end
 ```
 
-`product_search` accepts a hash as argument, and can include all available options. For a complete list of options please visit  http://helpcenter.linkshare.com/publisher/questions.php?questionid=652.
+`product_search` accepts a hash as argument, and can include all available options. For a complete list of options please visit https://rakutenlinkshare.zendesk.com/hc/en-us/articles/201483905-Merchandiser-Query-Tool-API-Guidelines.
 
 ```ruby
 # Search "laptop" only for Wal-Mart, within Electronics category,
@@ -99,9 +140,9 @@ end
 
 When using the `all` method, `response` object is updated with the data returned by the last API request (last page). `response.all` returns the `data` array.
 
-### Coupon Web Services
+### Coupon Web Service
 
-Easy access to coupons and promotional link data for your advertisers using [Coupon Web Service](http://helpcenter.linkshare.com/publisher/questions.php?questionid=865)
+Easy access to coupons and promotional link data for your advertisers using [Coupon Web Service](https://rakutenlinkshare.zendesk.com/hc/en-us/articles/200919909-Using-the-Coupon-Web-Service)
 
 ```ruby
 # Search for promotion types "Clearance" (id 3) and "Dollar Amount Off" (id 5)

data/lib/linkshare_api/coupon_web_service.rb

@@ -1,9 +1,8 @@
-require "addressable/uri"
 require "httparty"
 
 module LinkshareAPI
   # For implementation details please visit
-  # http://helpcenter.linkshare.com/publisher/questions.php?questionid=865
+  # https://rakutenlinkshare.zendesk.com/hc/en-us/articles/200919909-Using-the-Coupon-Web-Service
   class CouponWebService
     include HTTParty
 
@@ -18,7 +17,7 @@ module LinkshareAPI
         raise AuthenticationError.new(
           "No token. Set your token by using 'LinkshareAPI.token = <TOKEN>'. " +
           "You can retrieve your token from LinkhShare's Web Services page under the Links tab. " +
-          "See http://helpcenter.linkshare.com/publisher/questions.php?questionid=648 for details."
+          "See https://rakutenlinkshare.zendesk.com/hc/en-us/articles/200992487-What-is-a-Web-Services-Token-Feed-Token- for details."
         )
       end
     end

data/lib/linkshare_api/deep_linking.rb

@@ -0,0 +1,33 @@
+require "addressable/uri"
+
+module LinkshareAPI
+  # For implementation details please visit
+  # https://rakutenlinkshare.zendesk.com/hc/en-us/articles/201295755-Guide-to-Deep-Linking
+  class DeepLinking
+    attr_reader :base_url, :affiliate_id
+
+    def initialize
+      @affiliate_id = LinkshareAPI.affiliate_id
+      @base_url = LinkshareAPI::WEB_SERVICE_URIS[:deep_linking]
+
+      if @affiliate_id.nil?
+        raise AuthenticationError.new(
+          "No Affilite ID. Set your Affiliate ID by using 'LinkshareAPI.affiliate_id = <AFFILIATE_ID>'. " +
+          "See https://github.com/rmarescu/linkshare_api#deep-linking for details."
+        )
+      end
+    end
+
+    def build(mid, murl)
+      raise ArgumentError, "mid must be a Fixnum, got #{mid.class} instead" unless mid.is_a?(Fixnum)
+
+      uri = Addressable::URI.parse(base_url)
+      uri.query_values = {
+        id: affiliate_id,
+        mid: mid,
+        murl: murl
+      }
+      uri.to_s
+    end
+  end
+end

data/lib/linkshare_api/link_generator.rb

@@ -1,10 +1,9 @@
-require "addressable/uri"
 require "cgi"
 require "httparty"
 
 module LinkshareAPI
   # For implementation details please visit
-  # http://helpcenter.linkshare.com/publisher/questions.php?questionid=648
+  # https://rakutenlinkshare.zendesk.com/hc/en-us/articles/201343135-Automated-LinkGenerator-Guidelines
   class LinkGenerator
     include HTTParty
 
@@ -19,7 +18,7 @@ module LinkshareAPI
         raise AuthenticationError.new(
           "No token. Set your token by using 'LinkshareAPI.token = <TOKEN>'. " +
           "You can retrieve your token from LinkhShare's Web Services page under the Links tab. " +
-          "See http://helpcenter.linkshare.com/publisher/questions.php?questionid=648 for details."
+          "See https://rakutenlinkshare.zendesk.com/hc/en-us/articles/200992487-What-is-a-Web-Services-Token-Feed-Token- for details."
         )
       end
     end

data/lib/linkshare_api/logger.rb

@@ -0,0 +1,16 @@
+require "logger"
+
+module LinkshareAPI
+  class Logger
+    attr_reader :logger
+
+    def self.log(level, message)
+
+      new.logger.send(level, "[linkshare_api] #{message}")
+    end
+
+    def initialize
+      @logger = LinkshareAPI.logger || ::Logger.new(STDOUT)
+    end
+  end
+end

data/lib/linkshare_api/product_search.rb

@@ -1,9 +1,8 @@
-require "addressable/uri"
 require "httparty"
 
 module LinkshareAPI
   # For implementation details please visit
-  # http://helpcenter.linkshare.com/publisher/questions.php?questionid=652
+  # https://rakutenlinkshare.zendesk.com/hc/en-us/articles/201483905-Merchandiser-Query-Tool-API-Guidelines
   class ProductSearch
     include HTTParty
 
@@ -18,7 +17,7 @@ module LinkshareAPI
         raise AuthenticationError.new(
           "No token. Set your token by using 'LinkshareAPI.token = <TOKEN>'. " +
           "You can retrieve your token from LinkhShare's Web Services page under the Links tab. " +
-          "See http://helpcenter.linkshare.com/publisher/questions.php?questionid=648 for details."
+          "See https://rakutenlinkshare.zendesk.com/hc/en-us/articles/200992487-What-is-a-Web-Services-Token-Feed-Token- for details."
         )
       end
     end

data/lib/linkshare_api/version.rb

@@ -1,3 +1,3 @@
 module LinkshareAPI
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/linkshare_api.rb

@@ -3,6 +3,7 @@ require "linkshare_api/version"
 
 # Resources
 require File.expand_path("../linkshare_api/link_generator", __FILE__)
+require File.expand_path("../linkshare_api/deep_linking", __FILE__)
 require File.expand_path("../linkshare_api/product_search", __FILE__)
 require File.expand_path("../linkshare_api/coupon_web_service", __FILE__)
 require File.expand_path("../linkshare_api/response", __FILE__)
@@ -13,9 +14,13 @@ require File.expand_path("../linkshare_api/errors/authentication_error", __FILE_
 require File.expand_path("../linkshare_api/errors/connection_error", __FILE__)
 require File.expand_path("../linkshare_api/errors/invalid_request_error", __FILE__)
 
+# Misc
+require File.expand_path("../linkshare_api/logger", __FILE__)
+
 module LinkshareAPI
   WEB_SERVICE_URIS = {
     link_generator: "http://getdeeplink.linksynergy.com/createcustomlink.shtml",
+    deep_linking: "http://click.linksynergy.com/deeplink",
     product_search: "http://productsearch.linksynergy.com/productsearch",
     coupon_web_service: "http://couponfeed.linksynergy.com/coupon"
   }
@@ -39,7 +44,7 @@ module LinkshareAPI
   @api_timeout  = 30
 
   class << self
-    attr_accessor :token
+    attr_accessor :token, :affiliate_id, :logger
     attr_reader   :api_timeout
   end
 
@@ -50,7 +55,18 @@ module LinkshareAPI
   end
 
   def self.link_generator(mid, murl)
-    link_generator = LinkshareAPI::LinkGenerator.new
+    if affiliate_id.nil?
+      LinkshareAPI::Logger.log(
+        :warn,
+        "`Automated Link Generator` has been discontinued in favor of `Deep Linking`. " +
+        "To use `Deep Linking` you only have to set your Affiliate ID by executing " +
+        "'LinkshareAPI.affiliate_id = <AFFILIATE_ID>'. Everything else remains the same. " +
+        "See https://github.com/rmarescu/linkshare_api#deep-linking for details."
+      )
+      link_generator = LinkshareAPI::LinkGenerator.new
+    else
+      link_generator = LinkshareAPI::DeepLinking.new
+    end
     link_generator.build(mid, murl)
   end
 

data/linkshare_api.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.version               = LinkshareAPI::VERSION
   s.authors               = ["Razvan Marescu"]
   s.email                 = ["razvan@marescu.net"]
-  s.description           = %q{Ruby wrapper for LinkShare Publisher Web Services. See http://helpcenter.linkshare.com/publisher/categories.php?categoryid=71.}
+  s.description           = %q{Ruby wrapper for LinkShare Publisher Web Services. See https://rakutenlinkshare.zendesk.com.}
   s.summary               = %q{Linkshare API}
   s.homepage              = "https://github.com/rmarescu/linkshare_api"
   s.license               = "MIT"
@@ -20,8 +20,9 @@ Gem::Specification.new do |s|
   s.require_paths         = ["lib"]
 
   s.add_dependency "addressable", "~> 2.3"
+  s.add_dependency "formatador", "~>0.2"
   s.add_dependency "httparty", "~> 0.13"
-  s.add_dependency "recursive-open-struct", "~> 0.4"
+  s.add_dependency "recursive-open-struct", "~> 0.5"
 
   s.add_development_dependency "bundler", "~> 1.6"
   s.add_development_dependency "rake"

data/test/linkshare_api_test.rb

@@ -3,6 +3,7 @@ require "test_helper"
 class LinkshareAPITest < Test::Unit::TestCase
   def test_link_generator_invalid_token
     LinkshareAPI.token = nil
+    LinkshareAPI.affiliate_id = nil
     assert_raise LinkshareAPI::AuthenticationError do
       LinkshareAPI.link_generator(123, "http://www.example.com")
     end
@@ -24,6 +25,7 @@ class LinkshareAPITest < Test::Unit::TestCase
 
   def test_link_generator_invalid_mid
     LinkshareAPI.token = token
+    LinkshareAPI.affiliate_id = nil
     assert_raise ArgumentError do
       LinkshareAPI.link_generator(nil, nil)
     end
@@ -31,6 +33,7 @@ class LinkshareAPITest < Test::Unit::TestCase
 
   def test_link_generator_missing_url
     LinkshareAPI.token = token
+    LinkshareAPI.affiliate_id = nil
     stub_request(
       :get,
       "http://getdeeplink.linksynergy.com/createcustomlink.shtml?token=#{token}&mid=123&murl="
@@ -48,6 +51,7 @@ class LinkshareAPITest < Test::Unit::TestCase
 
   def test_link_generator_valid_request
     LinkshareAPI.token = token
+    LinkshareAPI.affiliate_id = nil
     mid = 2149
     murl = "http://www.walmart.com/cp/blu-ray/616859?povid=P1171-C1110.2784+1455.2776+1115.2956-L44"
     stub_request(
@@ -63,6 +67,28 @@ class LinkshareAPITest < Test::Unit::TestCase
     assert_equal "http://linksynergy.walmart.com/fs-bin/click?id=yourid&subid=0&offerid=223073.1&type=10&tmpid=273&RD_PARM0=http%3A%2F%2Fwww.walmart.com%2Fcp%2Fblu-ray%2F616859%3Fpovid%3DP1171-C1110.2784%2B1455.2776%2B1115.2956-L44&RD_PARM1=http%3A%2F%2Fwww.walmart.com%2Fcp%2Fblu-ray%2F616859%3F&RD_PARM2=povid%3DP1171-C1110.2784%2B1455.2776%2B1115.2956-L44", url
   end
 
+  def test_deep_linking_invalid_token
+    LinkshareAPI.affiliate_id = nil
+    assert_raise LinkshareAPI::AuthenticationError do
+      LinkshareAPI.link_generator(123, "http://www.example.com")
+    end
+  end
+
+  def test_deep_linking_invalid_mid
+    LinkshareAPI.affiliate_id = affiliate_id
+    assert_raise ArgumentError do
+      LinkshareAPI.link_generator(nil, nil)
+    end
+  end
+
+  def test_deep_linking_valid_request
+    LinkshareAPI.affiliate_id = affiliate_id
+    mid = 2149
+    murl = "http://www.walmart.com/cp/blu-ray/616859?povid=P1171-C1110.2784+1455.2776+1115.2956-L44"
+    url = LinkshareAPI.link_generator(mid, murl)
+    assert_equal "http://click.linksynergy.com/deeplink?id=secret_affiliate_id&mid=2149&murl=http%3A%2F%2Fwww.walmart.com%2Fcp%2Fblu-ray%2F616859%3Fpovid%3DP1171-C1110.2784%2B1455.2776%2B1115.2956-L44", url
+  end
+
   def test_product_search_invalid_token
     LinkshareAPI.token = nil
     assert_raise LinkshareAPI::AuthenticationError do
@@ -221,6 +247,10 @@ class LinkshareAPITest < Test::Unit::TestCase
   private
 
   def token
-    "abcdef"
+    "secret_token"
+  end
+
+  def affiliate_id
+    "secret_affiliate_id"
   end
 end

data/test/test_helper.rb

@@ -5,3 +5,5 @@ require "webmock/test_unit"
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 require "linkshare_api"
+
+LinkshareAPI.logger = Logger.new("/dev/null")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linkshare_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Razvan Marescu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-07 00:00:00.000000000 Z
+date: 2014-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: formatador
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Ruby wrapper for LinkShare Publisher Web Services. See http://helpcenter.linkshare.com/publisher/categories.php?categoryid=71.
+description: Ruby wrapper for LinkShare Publisher Web Services. See https://rakutenlinkshare.zendesk.com.
 email:
 - razvan@marescu.net
 executables: []
@@ -153,11 +167,13 @@ files:
 - Rakefile
 - lib/linkshare_api.rb
 - lib/linkshare_api/coupon_web_service.rb
+- lib/linkshare_api/deep_linking.rb
 - lib/linkshare_api/errors/authentication_error.rb
 - lib/linkshare_api/errors/connection_error.rb
 - lib/linkshare_api/errors/error.rb
 - lib/linkshare_api/errors/invalid_request_error.rb
 - lib/linkshare_api/link_generator.rb
+- lib/linkshare_api/logger.rb
 - lib/linkshare_api/product_search.rb
 - lib/linkshare_api/response.rb
 - lib/linkshare_api/version.rb