linkshare_api 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,10 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :test do
+  watch(%r{^test/.+_test\.rb$})
+  watch("test/test_helper.rb") { "test" }
+
+  watch(%r{^app/models/(.+)\.rb$})     { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^app/validators/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2013- Venture Media Labs, Inc.
+
+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,63 @@
+# LinkShare API
+
+[![Gem Version](https://badge.fury.io/rb/linkshare_api.png)](http://badge.fury.io/rb/linkshare_api)
+
+Ruby wrapper for [LinkShare Publisher Web Services](http://helpcenter.linkshare.com/publisher/categories.php?categoryid=71).
+Supported web services:
+* [Automated LinkGenerator](#automated_link_generator)
+
+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="installation"></a>Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'linkshare_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install linkshare_api
+
+## <a id="requirement"></a>Requirements
+
+[Ruby](http://www.ruby-lang.org/en/downloads/) 1.9 or above.
+
+## <a id="usage"></a>Usage
+
+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.
+
+```ruby
+require "linkshare_api" # no need for RoR
+LinkshareAPI.token = ENV["LINKSHARE_TOKEN"]
+```
+
+### Automated Link Generator
+
+Generate affiliate URLs using [Automated LinkGenerator](http://helpcenter.linkshare.com/publisher/categories.php?categoryid=72) 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)
+```
+
+### Extra Configuration
+
+* `LinkshareAPI.api_timeout` - the timeout set when initiating requests to LinkShare Web Services (default value is 30 seconds)
+
+## <a id="contributing"></a>Contributing
+
+1. Fork it
+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 new Pull Request
+
+## <a id="license"></a>License
+
+[MIT](LICENSE.txt)

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/*_test.rb"
+  test.verbose = true
+end
+
+task default: :test

data/lib/linkshare_api.rb

@@ -0,0 +1,35 @@
+# Version
+require "linkshare_api/version"
+
+# Resources
+require "linkshare_api/link_generator"
+
+# Errors
+require "linkshare_api/errors/error"
+require "linkshare_api/errors/authentication_error"
+require "linkshare_api/errors/connection_error"
+require "linkshare_api/errors/invalid_request_error"
+
+module LinkshareAPI
+  WEB_SERVICE_URIS = {
+    link_generator: "http://getdeeplink.linksynergy.com/createcustomlink.shtml"
+  }
+
+  @api_timeout  = 30
+
+  class << self
+    attr_accessor :token
+    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
+
+  def self.link_generator(mid, murl)
+    link_generator = LinkshareAPI::LinkGenerator.new
+    link_generator.build(mid, murl)
+  end
+end

data/lib/linkshare_api/errors/authentication_error.rb

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

data/lib/linkshare_api/errors/connection_error.rb

@@ -0,0 +1,4 @@
+module LinkshareAPI
+  class ConnectionError < Error
+  end
+end

data/lib/linkshare_api/errors/error.rb

@@ -0,0 +1,15 @@
+module LinkshareAPI
+  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/linkshare_api/errors/invalid_request_error.rb

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

data/lib/linkshare_api/link_generator.rb

@@ -0,0 +1,52 @@
+require "addressable/uri"
+require "cgi"
+require "httparty"
+
+module LinkshareAPI
+  # For implementation details please visit
+  # http://helpcenter.linkshare.com/publisher/questions.php?questionid=648
+  class LinkGenerator
+    include HTTParty
+
+    attr_reader :api_base_url, :token, :api_timeout
+
+    def initialize
+      @token        = LinkshareAPI.token
+      @api_base_url = LinkshareAPI::WEB_SERVICE_URIS[:link_generator]
+      @api_timeout  = LinkshareAPI.api_timeout
+      if @token.nil?
+        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."
+        )
+      end
+    end
+
+    def build(mid, murl)
+      raise ArgumentError, "mid must be a Fixnum, got #{mid.class} instead" unless mid.is_a?(Fixnum)
+
+      query_string = "token=#{CGI.escape(token)}"
+      query_string << "&mid=#{mid}"
+      # murl must not be encoded (RFC ftw)
+      query_string << "&murl=#{murl}"
+      api_request_url = "#{api_base_url}?#{query_string}"
+      begin
+        response = self.class.get(api_request_url, timeout: api_timeout)
+      rescue Timeout::Error
+        raise ConnectionError.new("Timeout error (#{timeout}s)")
+      end
+
+      if response.code != 200
+        raise Error.new("Unexpected response: #{response.message}", response.code)
+      end
+
+      # If the body content looks like an URL, then would be
+      # safe to assume that the request was processed correctly
+      unless response.body.start_with? "http://", "https://"
+        raise InvalidRequestError.new(response.body)
+      end
+      response.body
+    end
+  end
+end

data/lib/linkshare_api/version.rb

@@ -0,0 +1,3 @@
+module LinkshareAPI
+  VERSION = "0.0.1"
+end

data/linkshare_api.gemspec

@@ -0,0 +1,29 @@
+ # -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "linkshare_api/version"
+
+Gem::Specification.new do |s|
+  s.name                  = "linkshare_api"
+  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.summary               = %q{Linkshare API}
+  s.homepage              = "https://github.com/rmarescu/linkshare_api"
+  s.license               = "MIT"
+  s.required_ruby_version = ">= 1.9"
+
+  s.files                 = `git ls-files`.split($/)
+  s.test_files            = s.files.grep(%r{^(test|s|features)/})
+  s.executables           = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.require_paths         = ["lib"]
+
+  s.add_dependency "httparty", "~> 0.11.0"
+
+  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "webmock"
+  s.add_development_dependency "test-unit"
+  s.add_development_dependency "guard-test"
+end

data/test/linkshare_api_test.rb

@@ -0,0 +1,65 @@
+require "test_helper"
+
+class LinkshareAPITest < Test::Unit::TestCase
+  def test_link_generator_invalid_token
+    LinkshareAPI.token = nil
+    assert_raise LinkshareAPI::AuthenticationError do
+      LinkshareAPI.link_generator(123, "http://www.example.com")
+    end
+  end
+
+  def test_link_generator_invalid_timeout
+    assert_raise ArgumentError do
+      LinkshareAPI.api_timeout = ""
+    end
+
+    assert_raise ArgumentError do
+      LinkshareAPI.api_timeout = "20"
+    end
+
+    assert_raise ArgumentError do
+      LinkshareAPI.api_timeout = 0
+    end
+  end
+
+  def test_link_generator_invalid_mid
+    LinkshareAPI.token = "token"
+    assert_raise ArgumentError do
+      LinkshareAPI.link_generator(nil, nil)
+    end
+  end
+
+  def test_link_generator_missing_url
+    LinkshareAPI.token = "your_token"
+    stub_request(
+      :get,
+      "http://getdeeplink.linksynergy.com/createcustomlink.shtml?token=your_token&mid=123&murl="
+      ).
+      to_return(
+        status: 200,
+        body: "No Advertiser URL provided for deep linking. This could be because murl was not found or was empty.",
+        headers: {}
+    )
+    e = assert_raise LinkshareAPI::InvalidRequestError do
+      LinkshareAPI.link_generator(123, nil)
+    end
+    assert_equal "No Advertiser URL provided for deep linking. This could be because murl was not found or was empty.", e.to_s
+  end
+
+  def test_link_generator_valid_request
+    LinkshareAPI.token = "your_token"
+    mid = 2149
+    murl = "http://www.walmart.com/cp/blu-ray/616859?povid=P1171-C1110.2784+1455.2776+1115.2956-L44"
+    stub_request(
+      :get,
+      "http://getdeeplink.linksynergy.com/createcustomlink.shtml?token=your_token&mid=#{mid}&murl=#{murl}"
+      ).
+      to_return(
+        status: 200,
+        body: "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",
+        headers: {}
+    )
+    url = LinkshareAPI.link_generator(mid, murl)
+    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
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require "rubygems"
+require "test/unit"
+require "webmock/test_unit"
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+require "linkshare_api"

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: linkshare_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Razvan Marescu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for LinkShare Publisher Web Services. See http://helpcenter.linkshare.com/publisher/categories.php?categoryid=71.
+email:
+- razvan@marescu.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/linkshare_api.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/version.rb
+- linkshare_api.gemspec
+- test/linkshare_api_test.rb
+- test/test_helper.rb
+homepage: https://github.com/rmarescu/linkshare_api
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Linkshare API
+test_files:
+- test/linkshare_api_test.rb
+- test/test_helper.rb