ls_linkdirect_api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5321f05c60a0c21073823cbb981ed34ce7492439
+  data.tar.gz: b118e82ea754f7e80d43dca2beca6757fcaec427
+SHA512:
+  metadata.gz: ff02cf9f6d5833634f9f2fcce3a4f831703cb017922a8101e37757349bafd0fad1f696e0e747c839fb093357003028879db73b98bb0183b0b204d58a7a0a3958
+  data.tar.gz: a5839df1bdebcb6b2100281d4e7e6affd660458b92452778eda35882c142258337c26a645e5e871c306eba8afe4da8283727d9a19f3231123c91f1d05fa441f8

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ls_linkdirect_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kirk Jarvis
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.md

@@ -0,0 +1,89 @@
+# LsLinkdirectAPI
+
+Ruby wrapper for [LinkShare LinkLocator Direct](http://helpcenter.linkshare.com/publisher/questions.php?questionid=50).
+Supported web services:
+  * [TextLinks]
+  * [BannerLinks]
+  * [DRMLinks]
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ls_linkdirect_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ls_linkdirect_api
+
+## Usage
+
+Before using **LsLinkdirectAPI** 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.
+
+Currently there are three services that can be used with this gem.  To use those services, you name the service as the class when you declare a new instance of the class (i.e. `LsLinkdirectAPI::TextLinks.new`) see examples below.
+
+```ruby
+require "ls_linkdirect_api" # no need for RoR
+LsLinkdirectAPI.token = ENV["LINKSHARE_TOKEN"]
+```
+### Text Link Request
+
+This request gives you the available text links. To specify the links your request returns, you can filter it using these parameters: MID, Category, Start Date, and End Date.
+
+```ruby
+textlinks = LsLinkdirectAPI::TextLinks.new
+params = { mid: -1, cat: -1, startDate: 01012014, endDate: 05012014 }
+# all params are optional gem will add defaults where required
+response = textlinks.get(params)
+response.data.each do |item|
+  puts "Name: #{item.linkName}"
+  puts "Click URL: #{item.clickURL}"
+  puts "Tracking Pixil : #{item.showURL}"
+  puts "Text Display: #{item.textDisplay}"
+end
+```
+### Banner Link Request
+
+This feed gives you the available banner links. To obtain specific banner links, you can filter this request using these parameters: MID, Category, Size, Start Date, and End Date.
+
+[LinkLocator Direct: Banner Size Codes](http://helpcenter.linkshare.com/publisher/questions.php?questionid=907)
+
+```ruby
+bannerlinks = LsLinkdirectAPI:: BannerLinks.new
+params = { mid: -1, cat: -1, startDate: 01012014, endDate: 05012014, size: 1  }
+# all params are optional gem will add defaults where required
+response = bannerlinks.get(params)
+response.data.each do |item|
+  puts "Name: #{item.linkName}"
+  puts "Click URL: #{item.clickURL}"
+  puts "Tracking Pixil : #{item.showURL}"
+  puts "Text Display: #{item.textDisplay}"
+  puts "Image URL: #{item.imgURL}"
+end
+```
+
+### DRM Link Request
+This feed gives you the available DRM links. To obtain specific DRM links, you can filter it using these parameters: MID, Category, Start Date, and End Date.
+
+```ruby
+drmlinks = LsLinkdirectAPI:: DRMLinks.new
+params = { mid: -1, cat: -1, startDate: 01012014, endDate: 05012014 }
+# all params are optional gem will add defaults where required
+response = drmlinks.get(params)
+response.data.each do |item|
+  puts "Name: #{item.linkName}"
+  puts "Code: #{item.code}"
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/ls_linkdirect_api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/ls_linkdirect_api.rb

@@ -0,0 +1,38 @@
+require "addressable/uri"
+require "cgi"
+require "htmlentities"
+require "httparty"
+#require "net/http"
+require "recursive_open_struct"
+require "uri"
+
+require "ls_linkdirect_api/api_resource"
+require "ls_linkdirect_api/api_response"
+require "ls_linkdirect_api/version"
+require "ls_linkdirect_api/text_links"
+require "ls_linkdirect_api/banner_links"
+require "ls_linkdirect_api/drm_links"
+
+require "ls_linkdirect_api/errors/error"
+require "ls_linkdirect_api/errors/authentication_error"
+require "ls_linkdirect_api/errors/argument_error"
+require "ls_linkdirect_api/errors/not_implemented_error"
+require "ls_linkdirect_api/errors/invalid_request_error"
+
+
+
+module LsLinkdirectAPI
+  @api_base_url = "http://lld2.linksynergy.com/services/restLinks"
+  @api_timeout = 30
+
+  class << self
+    attr_accessor :token, :api_base_url
+    attr_reader :api_timeout
+  end
+
+  def self.api_timeout=(timeout)
+    raise ArgumentError, "Timeout must be a Fixnum; got #{timeout.class} instead" unless timeout.is_a? Fixnum
+    raise ArgumentError, "Timeout must be > 0; got #{timeout} instead" unless timeout > 0
+    @api_timeout = timeout
+  end
+end

data/lib/ls_linkdirect_api/api_resource.rb

@@ -0,0 +1,104 @@
+module LsLinkdirectAPI
+  class APIResource
+    include HTTParty
+
+    def class_name
+      self.class.name.split('::')[-1]
+    end
+
+    def base_path
+      if self.class == LsLinkdirectAPI::APIResource
+        raise NotImplementedError.new(
+          "APIResource is an abstract class. You should perform actions on its subclasses (i.e. TextLinks)"
+        )
+      end
+      "/get#{CGI.escape(class_name)}/"
+    end
+
+    def get(params = {})
+      
+      unless token ||= LsLinkdirectAPI.token
+        raise AuthenticationError.new(
+          "No token provided. Set your token key using: LsLinkdirectAPI.token = 'TOKEN' " +
+          "You can retrieve your Your Web Services Token from the Linkshare web interface. " +
+          "http://helpcenter.linkshare.com/publisher/questions.php?questionid=58 for details."
+        )
+      end
+
+      if token =~ /\s/
+        raise AuthenticationError.new(
+          "Your token looks invalid. " +
+          "Double-check your token at http://linkshare.com"
+        )
+      end
+      
+      raise ArgumentError, "Params must be a Hash; got #{params.class} instead" unless params.is_a? Hash
+
+      params.merge!({
+        token: token,
+      })
+      make_params_valid(params)
+      resource_url = LsLinkdirectAPI.api_base_url + base_path + self.params_path(params)
+      request(resource_url, params)
+    end
+
+    def request(resource_url, params)
+      timeout = LsLinkdirectAPI.api_timeout
+      begin
+        response = self.class.get(resource_url, query: nil, timeout: timeout)
+      rescue Timeout::Error
+        raise ConnectionError.new("Timeout error (#{timeout}s)")
+      end
+      process(response, "#{class_name}", params)
+    end
+
+    private
+
+    def process(response, response_name, params)
+      case response.code
+      when 200, 201, 204
+        APIResponse.new(response, response_name, params)
+      when 400, 404
+        raise InvalidRequestError.new(response.message, response.code)
+      when 401
+        raise AuthenticationError.new(response.message, response.code)
+      else
+        raise Error.new(response.message, response.code)
+      end
+    end
+
+    def check_date_format(date)
+      if date
+        if date =~ /(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])(19|20)\d\d/
+          date
+        else
+          raise ArgumentError, "Data format needs to be MMDDYYYY."
+        end
+      else
+        ''
+      end
+    end
+
+    def make_params_valid(params)
+      unless params[:mid]
+        params[:mid] = -1
+      end
+
+      unless params[:cat]
+        params[:cat] = -1
+      end
+
+      unless params[:page]
+        params[:page] = 1
+      end
+
+      unless params[:campaignID]
+        params[:campaignID] = -1
+      end
+
+      unless params[:size]
+        params[:size] = -1
+      end
+    end
+  end
+end

data/lib/ls_linkdirect_api/api_response.rb

@@ -0,0 +1,36 @@
+require "recursive_open_struct"
+
+module LsLinkdirectAPI
+  class APIResponse
+    attr_reader :data, :request
+
+    def initialize(response, response_name, params)
+      @request = response.request
+      @response_name = response_name
+      @params = params
+      result = response[ "get#{response_name}Response" ]
+      @data = parse(result["return"])
+    end
+
+    def all
+      get_next_page = true
+      while get_next_page
+        cls = Object.const_get('LsLinkdirectAPI').const_get(@response_name)
+        @params[:page] += 1
+        next_page_response = cls.new.get(@params)
+        @data += next_page_response.data
+        get_next_page = false if next_page_response.data == []
+      end
+      @data
+    end
+
+    private
+
+    def parse(raw_data)
+      data = []
+      data = [RecursiveOpenStruct.new(raw_data)] if raw_data.is_a?(Hash) # If we got exactly one result, put it in an array.
+      raw_data.each { |i| data << RecursiveOpenStruct.new(i) } if raw_data.is_a?(Array)
+      data
+    end
+  end
+end

data/lib/ls_linkdirect_api/banner_links.rb

@@ -0,0 +1,7 @@
+module LsLinkdirectAPI
+  class BannerLinks < APIResource
+    def params_path(params)
+      "#{params[:token]}/#{params[:mid]}/#{params[:cat]}/#{check_date_format(params[:startDate])}/#{check_date_format(params[:endDate])}/#{params[:size]}/#{params[:campaignID]}/#{params[:page]}"
+    end
+  end
+end

data/lib/ls_linkdirect_api/drm_links.rb

@@ -0,0 +1,7 @@
+module LsLinkdirectAPI
+  class DRMLinks < APIResource
+    def params_path(params)
+      "#{params[:token]}/#{params[:mid]}/#{params[:cat]}/#{check_date_format(params[:startDate])}/#{check_date_format(params[:endDate])}/#{params[:campaignID]}/#{params[:page]}"
+    end
+  end
+end

data/lib/ls_linkdirect_api/errors/argument_error.rb

@@ -0,0 +1,4 @@
+module LsLinkdirectAPI
+  class ArgumentError < Error
+  end
+end

data/lib/ls_linkdirect_api/errors/authentication_error.rb

@@ -0,0 +1,4 @@
+module LsLinkdirectAPI
+  class AuthenticationError < Error
+  end
+end

data/lib/ls_linkdirect_api/errors/error.rb

@@ -0,0 +1,15 @@
+module LsLinkdirectAPI
+  class Error < StandardError
+    attr_reader :message, :code
+
+    def initialize(message = nil, code = nil)
+      @message = message
+      @code    = code
+    end
+
+    def to_s
+      code_string = code.nil? ? "" : " (Code #{code})"
+      "#{message}#{code_string}"
+    end
+  end
+end

data/lib/ls_linkdirect_api/errors/invalid_request_error.rb

@@ -0,0 +1,4 @@
+module LsLinkdirectAPI
+  class InvalidRequestError < Error
+  end
+end

data/lib/ls_linkdirect_api/errors/not_implemented_error.rb

@@ -0,0 +1,4 @@
+module LsLinkdirectAPI
+  class NotImplementedError < Error
+  end
+end

data/lib/ls_linkdirect_api/text_links.rb

@@ -0,0 +1,7 @@
+module LsLinkdirectAPI
+  class TextLinks < APIResource
+    def params_path(params)
+      "#{params[:token]}/#{params[:mid]}/#{params[:cat]}/#{check_date_format(params[:startDate])}/#{check_date_format(params[:endDate])}/#{params[:campaignID]}/#{params[:page]}"
+    end
+  end
+end

data/lib/ls_linkdirect_api/version.rb

@@ -0,0 +1,3 @@
+module LsLinkdirectAPI
+  VERSION = "0.0.2"
+end

data/ls_linkdirect_api.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ls_linkdirect_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ls_linkdirect_api"
+  spec.version       = LsLinkdirectAPI::VERSION
+  spec.authors       = ["Kirk Jarvis"]
+  spec.email         = ["zuuzlo@yahoo.com"]
+  spec.summary       = %q{Ruby wrapper for accessing Linkshare LinkLocator Direct API using REST. }
+  spec.description   = %q{This wrapper will access the Linkshare LinkLocator Direct Web Service, which is available to all publishers. The authentication of a publisher is done using the publisher’s Web services token. Publishers that do not have a Web services token, can go to Web Services under the Links tab on the Publisher Dashboard and click the button to generate a token. Since the token is used for authentication, it is a required parameter for all requests.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "addressable", "~> 2.3.5"
+  spec.add_dependency "htmlentities", "~> 4.3.1"
+  spec.add_dependency "httparty", "~> 0.11.0"
+  spec.add_dependency "recursive-open-struct", "~> 0.4.3"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
+end

data/spec/ls_linkdirect_api_spec.rb

@@ -0,0 +1,239 @@
+require 'spec_helper'
+
+describe LsLinkdirectAPI do
+  context "errors" do
+
+    it "raise connection error if times out" do
+      expect{ LsLinkdirectAPI.api_timeout = "" }.to raise_error(LsLinkdirectAPI::ArgumentError,"Timeout must be a Fixnum; got String instead")
+    end
+
+    it "raise connection error if times out" do
+      expect{ LsLinkdirectAPI.api_timeout = 0 }.to raise_error(LsLinkdirectAPI::ArgumentError,"Timeout must be > 0; got 0 instead")
+    end
+
+    
+    it "raises authenication if token not present" do
+      textlinks = LsLinkdirectAPI::TextLinks.new
+      expect{ textlinks.get({})}.to raise_error(LsLinkdirectAPI::AuthenticationError)
+    end
+
+    it "raises authenication if token has spaces" do
+      LsLinkdirectAPI.token = 'afajfdafd dfjaskdfk'
+      textlinks = LsLinkdirectAPI::TextLinks.new
+      expect{ textlinks.get({})}.to raise_error(LsLinkdirectAPI::AuthenticationError)
+    end
+
+    it "raises ArgumentError if params is not a hash" do
+      LsLinkdirectAPI.token = 'afajfdafddfjaskdfk'
+      textlinks = LsLinkdirectAPI::TextLinks.new
+      expect{ textlinks.get('text')}.to raise_error(LsLinkdirectAPI::ArgumentError)
+    end
+
+    it "base_path for TextLinks is getTextLinks" do
+      textlinks = LsLinkdirectAPI::TextLinks.new
+      expect(textlinks.base_path).to eq("/getTextLinks/")
+    end
+
+    it "raises Not Implemented Error if APIResource is accessed" do
+      textlinks = LsLinkdirectAPI::APIResource.new
+      expect{ textlinks.base_path }.to raise_error(LsLinkdirectAPI::NotImplementedError)
+    end
+
+    it "raises ArgumentError on wrong date format" do
+      LsLinkdirectAPI.token = 'afajfdafddfjaskdfk'
+      textlinks = LsLinkdirectAPI::TextLinks.new
+      params = { endDate: 'dec 10'}
+      expect{ textlinks.get(params)}.to raise_error(LsLinkdirectAPI::ArgumentError)
+    end
+  end
+
+  context "response code is not 200, 201, 204" do
+    it "raise Invalid Request Error if response is 400" do
+      LsLinkdirectAPI.token = '400'
+      xml_response = <<-XML
+      <?xml version="1.0" encoding="UTF-8"?>
+        <ns1:XMLFault xmlns:ns1="http://cxf.apache.org/bindings/xformat"><ns1:faultstring xmlns:ns1="http://cxf.apache.org/bindings/xformat">Invalid URL/Verb combination. Verb: GET Path: /etTextLinks/06a400a42d5ee2822cc4342b7cedf714bffa542768b1c06d571c0ebe8aa85203/38605/-1//05162014/-1/1</ns1:faultstring></ns1:XMLFault>
+      XML
+      stub_request(
+        :get,
+        "http://lld2.linksynergy.com/services/restLinks/getTextLinks/400/-1/-1//05162014/-1/1"
+        ).
+        to_return(
+          status: 400,
+          body: xml_response,
+          headers: { "Content-type" => "text/xml; charset=UTF-8" }
+        )
+      textlinks = LsLinkdirectAPI::TextLinks.new
+      params = { endDate: '05162014'}
+      expect { textlinks.get(params) }.to raise_error(LsLinkdirectAPI::InvalidRequestError)
+    end
+  end
+  context "response code is 200 TextLinks" do
+    before do
+      LsLinkdirectAPI.token = '200'
+      xml_response = <<-XML
+      <?xml version="1.0" encoding="UTF-8"?>
+      <ns1:getTextLinksResponse xmlns:ns1="http://endpoint.linkservice.linkshare.com/"><ns1:return><ns1:campaignID>0</ns1:campaignID><ns1:categoryID>200321300</ns1:categoryID><ns1:categoryName>Toys</ns1:categoryName><ns1:linkID>3997</ns1:linkID><ns1:linkName>5/15-5/18 10% off Outdoor Toys. Promo Code OUTDOOR10</ns1:linkName><ns1:mid>38605</ns1:mid><ns1:nid>1</ns1:nid><ns1:clickURL>http://click.linksynergy.com/fs-bin/click?id=V8uMkWlCTes&amp;offerid=328293.3997&amp;type=3</ns1:clickURL><ns1:endDate>May 19, 2014</ns1:endDate><ns1:landURL>www.kohls.com/catalog.jsp?N=3000060558</ns1:landURL><ns1:showURL>http://ad.linksynergy.com/fs-bin/show?id=V8uMkWlCTes&amp;bids=328293.3997&amp;type=3</ns1:showURL><ns1:startDate>May 15, 2014</ns1:startDate><ns1:textDisplay>Extra 10% off Outdoor Toys. Promo Code OUTDOOR10</ns1:textDisplay></ns1:return><ns1:return><ns1:campaignID>0</ns1:campaignID><ns1:categoryID>0</ns1:categoryID><ns1:categoryName>Default</ns1:categoryName><ns1:linkID>3986</ns1:linkID><ns1:linkName>Free Shipping $50+ with Code FREE50MAY</ns1:linkName><ns1:mid>38605</ns1:mid><ns1:nid>1</ns1:nid><ns1:clickURL>http://click.linksynergy.com/fs-bin/click?id=V8uMkWlCTes&amp;offerid=328293.3986&amp;type=3</ns1:clickURL><ns1:endDate>May 19, 2014</ns1:endDate><ns1:landURL>http://www.kohls.com</ns1:landURL><ns1:showURL>http://ad.linksynergy.com/fs-bin/show?id=V8uMkWlCTes&amp;bids=328293.3986&amp;type=3</ns1:showURL><ns1:startDate>May 16, 2014</ns1:startDate><ns1:textDisplay>Free Shipping $50+ with Code FREE50MAY. Valid 5/16-5/18.</ns1:textDisplay></ns1:return></ns1:getTextLinksResponse>
+      XML
+      stub_request(
+        :get,
+        "http://lld2.linksynergy.com/services/restLinks/getTextLinks/200/-1/-1//05162014/-1/1"
+      ).
+        to_return(
+          status: 200,
+          body: xml_response,
+          headers: { "Content-type" => "text/xml; charset=UTF-8" }
+        )
+    end
+
+    let(:textlinks) { LsLinkdirectAPI::TextLinks.new }
+    let(:params) { { endDate: '05162014'} }
+    let(:response) { textlinks.get(params) }
+
+    it "first record linkid is 3997" do
+      expect(response.data.first.linkID).to eq("3997")
+    end
+
+    it "last record linkid is 3986" do
+      expect(response.data.last.linkID).to eq("3986")
+    end
+  end
+
+  context "response code is 200 BannerLinks" do
+    before do
+      LsLinkdirectAPI.token = '200'
+      xml_response = <<-XML
+      <?xml version="1.0" encoding="UTF-8"?>
+        <ns1:getBannerLinksResponse xmlns:ns1="http://endpoint.linkservice.linkshare.com/"><ns1:return><ns1:campaignID>0</ns1:campaignID><ns1:categoryID>0</ns1:categoryID><ns1:categoryName>Default</ns1:categoryName><ns1:linkID>3</ns1:linkID><ns1:linkName>Candie's</ns1:linkName><ns1:mid>38605</ns1:mid><ns1:nid>1</ns1:nid><ns1:clickURL>http://click.linksynergy.com/fs-bin/click?id=V8uMkWlCTes&amp;offerid=328293.3&amp;type=4</ns1:clickURL><ns1:endDate>Dec 31, 2019</ns1:endDate><ns1:height>31</ns1:height><ns1:iconURL>http://merchant.linksynergy.com/fs/banners/38605/38605_3.jpg</ns1:iconURL><ns1:imgURL>http://ad.linksynergy.com/fs-bin/show?id=V8uMkWlCTes&amp;bids=328293.3&amp;type=4</ns1:imgURL><ns1:landURL>http://www.kohls.com/catalog/juniors-candie-s-clothing.jsp?CN=4294719935+4294875004+4294719810</ns1:landURL><ns1:serverType>4</ns1:serverType><ns1:size>7</ns1:size><ns1:startDate>Jul 18, 2013</ns1:startDate><ns1:width>88</ns1:width></ns1:return><ns1:return><ns1:campaignID>0</ns1:campaignID><ns1:categoryID>0</ns1:categoryID><ns1:categoryName>Default</ns1:categoryName><ns1:linkID>4</ns1:linkID><ns1:linkName>Candie's</ns1:linkName><ns1:mid>38605</ns1:mid><ns1:nid>1</ns1:nid><ns1:clickURL>http://click.linksynergy.com/fs-bin/click?id=V8uMkWlCTes&amp;offerid=328293.4&amp;type=4</ns1:clickURL><ns1:endDate>Dec 31, 2019</ns1:endDate><ns1:height>90</ns1:height><ns1:iconURL>http://merchant.linksynergy.com/fs/banners/38605/38605_4.jpg</ns1:iconURL><ns1:imgURL>http://ad.linksynergy.com/fs-bin/show?id=V8uMkWlCTes&amp;bids=328293.4&amp;type=4</ns1:imgURL><ns1:landURL>http://www.kohls.com/catalog/juniors-candie-s-clothing.jsp?CN=4294719935+4294875004+4294719810</ns1:landURL><ns1:serverType>4</ns1:serverType><ns1:size>5</ns1:size><ns1:startDate>Jul 18, 2013</ns1:startDate><ns1:width>120</ns1:width></ns1:return></ns1:getBannerLinksResponse>
+      XML
+      stub_request(
+        :get,
+        "http://lld2.linksynergy.com/services/restLinks/getBannerLinks/200/-1/-1//05162014/-1/-1/1"
+      ).
+        to_return(
+          status: 200,
+          body: xml_response,
+          headers: { "Content-type" => "text/xml; charset=UTF-8" }
+        )
+    end
+
+    let(:bannerlinks) { LsLinkdirectAPI::BannerLinks.new }
+    let(:params) { { endDate: '05162014'} }
+    let(:response) { bannerlinks.get(params) }
+
+    it "first record linkid is 3" do
+      expect(response.data.first.linkID).to eq("3")
+    end
+
+    it "last record linkid is 4" do
+      expect(response.data.last.linkID).to eq("4")
+    end
+  end
+
+  context "response code is 200 DRMLinks" do
+    before do
+      LsLinkdirectAPI.token = '200'
+      xml_response = <<-XML
+      <?xml version="1.0" encoding="UTF-8"?>
+        <ns1:getDRMLinksResponse xmlns:ns1="http://endpoint.linkservice.linkshare.com/"><ns1:return><ns1:campaignID>0</ns1:campaignID><ns1:categoryID>78</ns1:categoryID><ns1:categoryName>Dynamic Media - Banners</ns1:categoryName><ns1:linkID>6885</ns1:linkID><ns1:linkName>Banner 300x250</ns1:linkName><ns1:mid>14028</ns1:mid><ns1:nid>1</ns1:nid><ns1:code>&lt;script src='http://ad.linksynergy.com/fs-bin/show?id=V8uMkWlCTes&amp;bids=299527.6885&amp;catid=78&amp;gridnum=13&amp;type=14'>&lt;/script>&lt;noscript>&lt;a href='http://click.linksynergy.com/fs-bin/click?id=V8uMkWlCTes&amp;offerid=299527&amp;type=4&amp;subid='>&lt;img src='http://ad.linksynergy.com/fs-bin/show?id=V8uMkWlCTes&amp;bids=299527&amp;subid=&amp;type=4&amp;gridnum=13'>&lt;/a>&lt;/noscript></ns1:code><ns1:endDate>Oct 13, 2017</ns1:endDate><ns1:height>250</ns1:height><ns1:serverType>4</ns1:serverType><ns1:showURL>http://ad.linksynergy.com/fs-bin/show?id=V8uMkWlCTes&amp;bids=299527.6885&amp;catid=78&amp;gridnum=13&amp;type=14</ns1:showURL><ns1:size>13</ns1:size><ns1:startDate>Oct 13, 2011</ns1:startDate><ns1:width>300</ns1:width></ns1:return><ns1:return><ns1:campaignID>0</ns1:campaignID><ns1:categoryID>78</ns1:categoryID><ns1:categoryName>Dynamic Media - Banners</ns1:categoryName><ns1:linkID>4027</ns1:linkID><ns1:linkName>Banner 120x240</ns1:linkName><ns1:mid>14028</ns1:mid><ns1:nid>1</ns1:nid><ns1:code>&lt;script src='http://ad.linksynergy.com/fs-bin/show?id=V8uMkWlCTes&amp;bids=299527.4027&amp;catid=78&amp;gridnum=8&amp;type=14'>&lt;/script>&lt;noscript>&lt;a href='http://click.linksynergy.com/fs-bin/click?id=V8uMkWlCTes&amp;offerid=299527&amp;type=4&amp;subid='>&lt;img src='http://ad.linksynergy.com/fs-bin/show?id=V8uMkWlCTes&amp;bids=299527&amp;subid=&amp;type=4&amp;gridnum=8'>&lt;/a>&lt;/noscript></ns1:code><ns1:endDate>Feb 28, 2017</ns1:endDate><ns1:height>240</ns1:height><ns1:serverType>4</ns1:serverType><ns1:showURL>http://ad.linksynergy.com/fs-bin/show?id=V8uMkWlCTes&amp;bids=299527.4027&amp;catid=78&amp;gridnum=8&amp;type=14</ns1:showURL><ns1:size>8</ns1:size><ns1:startDate>Feb 27, 2007</ns1:startDate><ns1:width>120</ns1:width></ns1:return></ns1:getDRMLinksResponse>
+      XML
+      stub_request(
+        :get,
+        "http://lld2.linksynergy.com/services/restLinks/getDRMLinks/200/-1/-1//05162014/-1/1"
+      ).
+        to_return(
+          status: 200,
+          body: xml_response,
+          headers: { "Content-type" => "text/xml; charset=UTF-8" }
+        )
+    end
+
+    let(:drmlinks) { LsLinkdirectAPI::DRMLinks.new }
+    let(:params) { { endDate: '05162014'} }
+    let(:response) { drmlinks.get(params) }
+
+    it "first record linkid is 6885" do
+      expect(response.data.first.linkID).to eq("6885")
+    end
+
+    it "last record linkid is 4027" do
+      expect(response.data.last.linkID).to eq("4027")
+    end
+  end
+  context "multi page using all" do
+    before do
+      LsLinkdirectAPI.token = '200'
+      xml_response0 = <<-XML
+      <?xml version="1.0" encoding="UTF-8"?>
+        <ns1:getTextLinksResponse xmlns:ns1="http://endpoint.linkservice.linkshare.com/"><ns1:return><ns1:campaignID>0</ns1:campaignID><ns1:categoryID>200321300</ns1:categoryID><ns1:categoryName>Toys</ns1:categoryName><ns1:linkID>3997</ns1:linkID><ns1:linkName>5/15-5/18 10% off Outdoor Toys. Promo Code OUTDOOR10</ns1:linkName><ns1:mid>38605</ns1:mid><ns1:nid>1</ns1:nid><ns1:clickURL>http://click.linksynergy.com/fs-bin/click?id=V8uMkWlCTes&amp;offerid=328293.3997&amp;type=3</ns1:clickURL><ns1:endDate>May 19, 2014</ns1:endDate><ns1:landURL>www.kohls.com/catalog.jsp?N=3000060558</ns1:landURL><ns1:showURL>http://ad.linksynergy.com/fs-bin/show?id=V8uMkWlCTes&amp;bids=328293.3997&amp;type=3</ns1:showURL><ns1:startDate>May 15, 2014</ns1:startDate><ns1:textDisplay>Extra 10% off Outdoor Toys. Promo Code OUTDOOR10</ns1:textDisplay></ns1:return></ns1:getTextLinksResponse>
+      XML
+      stub_request(
+        :get,
+        "http://lld2.linksynergy.com/services/restLinks/getTextLinks/200/-1/-1//05162014/-1/1"
+      ).
+        to_return(
+          status: 200,
+          body: xml_response0,
+          headers: { "Content-type" => "text/xml; charset=UTF-8" }
+        )
+
+        xml_response1 = <<-XML
+      <?xml version="1.0" encoding="UTF-8"?>
+        <ns1:getTextLinksResponse xmlns:ns1="http://endpoint.linkservice.linkshare.com/"><ns1:return><ns1:campaignID>0</ns1:campaignID><ns1:categoryID>0</ns1:categoryID><ns1:categoryName>Default</ns1:categoryName><ns1:linkID>3986</ns1:linkID><ns1:linkName>Free Shipping $50+ with Code FREE50MAY</ns1:linkName><ns1:mid>38605</ns1:mid><ns1:nid>1</ns1:nid><ns1:clickURL>http://click.linksynergy.com/fs-bin/click?id=V8uMkWlCTes&amp;offerid=328293.3986&amp;type=3</ns1:clickURL><ns1:endDate>May 19, 2014</ns1:endDate><ns1:landURL>http://www.kohls.com</ns1:landURL><ns1:showURL>http://ad.linksynergy.com/fs-bin/show?id=V8uMkWlCTes&amp;bids=328293.3986&amp;type=3</ns1:showURL><ns1:startDate>May 16, 2014</ns1:startDate><ns1:textDisplay>Free Shipping $50+ with Code FREE50MAY. Valid 5/16-5/18.</ns1:textDisplay></ns1:return></ns1:getTextLinksResponse>
+      XML
+      stub_request(
+        :get,
+        "http://lld2.linksynergy.com/services/restLinks/getTextLinks/200/-1/-1//05162014/-1/2"
+      ).
+        to_return(
+          status: 200,
+          body: xml_response1,
+          headers: { "Content-type" => "text/xml; charset=UTF-8" }
+        )
+
+        xml_response2 = <<-XML
+      <?xml version="1.0" encoding="UTF-8"?>
+      <ns1:getTextLinksResponse xmlns:ns1="http://endpoint.linkservice.linkshare.com/"><ns1:return><ns1:campaignID>0</ns1:campaignID><ns1:categoryID>200334761</ns1:categoryID><ns1:categoryName>Jewelry</ns1:categoryName><ns1:linkID>3961</ns1:linkID><ns1:linkName>Get Set for Summer Sale</ns1:linkName><ns1:mid>38605</ns1:mid><ns1:nid>1</ns1:nid><ns1:clickURL>http://click.linksynergy.com/fs-bin/click?id=V8uMkWlCTes&amp;offerid=328293.3961&amp;type=3</ns1:clickURL><ns1:endDate>May 21, 2014</ns1:endDate><ns1:landURL>http://www.kohls.com/catalog/jewelry.jsp?CN=4294719765&amp;N=4294719765+3000060490</ns1:landURL><ns1:showURL>http://ad.linksynergy.com/fs-bin/show?id=V8uMkWlCTes&amp;bids=328293.3961&amp;type=3</ns1:showURL><ns1:startDate>May 14, 2014</ns1:startDate><ns1:textDisplay>$1599.99 14k gold certified 1-ct. T.W. diamond solitaire rings. Select styles. reg. $4250. Valid 5/14-5/20.</ns1:textDisplay></ns1:return></ns1:getTextLinksResponse>
+      XML
+      stub_request(
+        :get,
+        "http://lld2.linksynergy.com/services/restLinks/getTextLinks/200/-1/-1//05162014/-1/3"
+      ).
+        to_return(
+          status: 200,
+          body: xml_response2,
+          headers: { "Content-type" => "text/xml; charset=UTF-8" }
+        )
+
+         xml_response3 = <<-XML
+      <?xml version="1.0" encoding="UTF-8"?>
+      <ns1:getTextLinksResponse xmlns:ns1="http://endpoint.linkservice.linkshare.com/"></ns1:getTextLinksResponse>
+      XML
+      stub_request(
+        :get,
+        "http://lld2.linksynergy.com/services/restLinks/getTextLinks/200/-1/-1//05162014/-1/4"
+      ).
+        to_return(
+          status: 200,
+          body: xml_response3,
+          headers: { "Content-type" => "text/xml; charset=UTF-8" }
+        )
+    end
+
+    let(:textlinks) { LsLinkdirectAPI::TextLinks.new }
+    let(:params) { { endDate: '05162014'} }
+    let(:response) { textlinks.get(params) }
+
+    it "first record linkid is 3997" do
+      expect(response.all.first.linkID).to eq("3997")
+    end
+
+    it "last record linkid is 3961" do
+      expect(response.all.last.linkID).to eq("3961")
+    end
+
+    it "has 3 text links" do
+      expect(response.all.size).to eq(3)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'webmock/rspec'
+require 'ls_linkdirect_api'
+#require_relative './support/fake_pepperjam_api'
+
+RSpec.configure do |config|
+=begin
+  config.before(:each) do
+    stub_request(:any, /api.pepperjamnetwork.com/ ).to_rack( FakePepperjamApi )
+  end
+=end
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification
+name: ls_linkdirect_api
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Kirk Jarvis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+- !ruby/object:Gem::Dependency
+  name: htmlentities
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This wrapper will access the Linkshare LinkLocator Direct Web Service,
+  which is available to all publishers. The authentication of a publisher is done
+  using the publisher’s Web services token. Publishers that do not have a Web services
+  token, can go to Web Services under the Links tab on the Publisher Dashboard and
+  click the button to generate a token. Since the token is used for authentication,
+  it is a required parameter for all requests.
+email:
+- zuuzlo@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ls_linkdirect_api.rb
+- lib/ls_linkdirect_api/api_resource.rb
+- lib/ls_linkdirect_api/api_response.rb
+- lib/ls_linkdirect_api/banner_links.rb
+- lib/ls_linkdirect_api/drm_links.rb
+- lib/ls_linkdirect_api/errors/argument_error.rb
+- lib/ls_linkdirect_api/errors/authentication_error.rb
+- lib/ls_linkdirect_api/errors/error.rb
+- lib/ls_linkdirect_api/errors/invalid_request_error.rb
+- lib/ls_linkdirect_api/errors/not_implemented_error.rb
+- lib/ls_linkdirect_api/text_links.rb
+- lib/ls_linkdirect_api/version.rb
+- ls_linkdirect_api.gemspec
+- spec/ls_linkdirect_api_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for accessing Linkshare LinkLocator Direct API using REST.
+test_files:
+- spec/ls_linkdirect_api_spec.rb
+- spec/spec_helper.rb