ebay_enterprise_affiliate_network 1.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,132 @@
+# eBay Enterprise Affiliate Network API
+
+Ruby wrapper for [eBay Enterprise Affiliate Network API](http://help.pepperjamnetwork.com/api/) (formerly PepperJam Exchange API). Only [Publisher API](http://help.pepperjamnetwork.com/api/publisher) is supported at this moment. If you need [Advertiser API](http://help.pepperjamnetwork.com/api/advertiser) or [Partner API](http://help.pepperjamnetwork.com/api/partner), 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 'ebay_enterprise_affiliate_network'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ebay_enterprise_affiliate_network
+
+## <a id="requirement"></a>Requirements
+
+[Ruby](http://www.ruby-lang.org/en/downloads/) 1.9 or above.
+
+## <a id="usage"></a>Usage
+
+The gem is designed to support all existing and future [Publisher API](http://help.pepperjamnetwork.com/api/publisher) resources.
+
+To start using the gem, you need to set up the api key first. If you use Ruby on Rails, the API key can be set in a configuration file (i.e. `app/config/initializers/ebay_enterprise_affiliate_network.rb`), otherwise just set it in your script. API Key can be found at http://www.pepperjamnetwork.com/affiliate/api/.
+
+```ruby
+require "ebay_enterprise_affiliate_network" # no need for RoR
+EBayEnterpriseAffiliateNetwork.api_key = ENV["EEAN_API_KEY"]
+```
+
+### Examples
+
+#### <a href="http://help.pepperjamnetwork.com/api/publisher#advertiser-category" target="_blank" title="Advertiser Categories">Advertiser Categories</a>
+
+```ruby
+publisher = EBayEnterpriseAffiliateNetwork::Publisher.new
+response = publisher.get("advertiser/category")
+response.data.each do |category|
+  puts "#{category.name} (ID #{category.id})"
+end
+
+# Retrieve the actual request URL sent to the API
+puts response.request.uri.to_s
+```
+
+#### <a href="http://help.pepperjamnetwork.com/api/publisher#advertiser" target="_blank" title="Advertisers">Advertiser Details</a>
+
+Get the list of [advertisers](http://help.pepperjamnetwork.com/api/publisher#advertiser) that you have a `joined` relationship with. The second argument of `get` method accepts a `Hash` of parameters. See the [API documentation](http://help.pepperjamnetwork.com/api/publisher) for a list of parameters for each API resource.
+Note that the API resource used must match the ones available in documentation, except the `publisher/` prefix that needs to be removed.
+
+```ruby
+publisher = EBayEnterpriseAffiliateNetwork::Publisher.new
+response = publisher.get("advertiser", status: :joined)
+# Return the number of total records
+response.meta.pagination.total_results
+# Return the number of pages
+response.meta.pagination.total_pages
+
+response.data.each do |advertiser|
+  # Do something
+end
+```
+If there are multiple pages (each page has a maximum of 500 records, value that cannot be changed), you can retrieve all pages by using the `all` method, as follows:
+
+```ruby
+response.all.each do |advertiser|
+  # Do something
+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.
+
+#### <a href="http://help.pepperjamnetwork.com/api/publisher#creative-product" target="_blank" title="Product Creatives">Product Creatives</a>
+
+Filter [Target](http://www.target.com) products by `canon camera` keywords.
+
+```ruby
+params = {
+  programIds: 6759, # Target ID
+  keywords: "canon camera"
+}
+publisher = EBayEnterpriseAffiliateNetwork::Publisher.new
+response = publisher.get("creative/product", params)
+response.data.each do |product|
+  puts "<a href=\"#{product.buy_url}\" title=\"#{product.name}\" target=\"_blank\">#{product.name}</a>"
+end
+```
+
+#### <a href="http://help.pepperjamnetwork.com/api/publisher#report-transaction-details" target="_blank" title="Transaction Details">Transaction Details</a>
+
+Retrieve all transactions in the last day
+
+```ruby
+require "date"
+# Note that the API uses ET as time zone, although is not specified anywhere
+yesterday = (Date.today - 1).to_s
+today = Date.today.to_s
+params = {
+  startDate: yesterday,
+  endDate: today,
+  website: 12345 # replace with your website id
+}
+publisher = EBayEnterpriseAffiliateNetwork::Publisher.new
+response = publisher.get("report/transaction-details", params)
+response.data.each do |transaction|
+  # Generate report
+end
+```
+
+Website ID can be retrieved from http://www.pepperjamnetwork.com/affiliate.
+
+### Extra Configuration
+
+* `EBayEnterpriseAffiliateNetwork.api_base_url` - default value is `http://api.pepperjamnetwork.com`
+* `EBayEnterpriseAffiliateNetwork.api_version` - default value is `20120402`
+* `EBayEnterpriseAffiliateNetwork.api_timeout` - the timeout set when initiating requests to eBay Enterprise Affiliate Network API (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.md)

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/VERSION

@@ -0,0 +1 @@
+1.0.1

data/ebay_enterprise_affiliate_network.gemspec

@@ -0,0 +1,33 @@
+ # -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ebay_enterprise_affiliate_network/version"
+
+Gem::Specification.new do |s|
+  s.name                  = "ebay_enterprise_affiliate_network"
+  s.version               = EBayEnterpriseAffiliateNetwork::VERSION
+  s.authors               = ["Razvan Marescu"]
+  s.email                 = ["razvan@marescu.net"]
+  s.description           = %q{Ruby wrapper for eBay Enterprise Affiliate Network API (formerly PepperJam Exchange API). See http://help.pepperjamnetwork.com/api for details.}
+  s.summary               = %q{eBay Enterprise Affiliate Network API}
+  s.homepage              = "https://github.com/rmarescu/ebay_enterprise_affiliate_network"
+  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 "addressable", "~> 2.3.5"
+  s.add_dependency "htmlentities", "~> 4.3.1"
+  s.add_dependency "httparty", "~> 0.11.0"
+  s.add_dependency "json", "~> 1.8.0"
+  s.add_dependency "recursive-open-struct", "~> 0.4.3"
+
+  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/lib/ebay_enterprise_affiliate_network.rb

@@ -0,0 +1,45 @@
+require "addressable/uri"
+require "cgi"
+require "htmlentities"
+require "httparty"
+require "json"
+require "net/http"
+require "recursive_open_struct"
+require "uri"
+
+# Version
+require "ebay_enterprise_affiliate_network/version"
+
+# Resources
+require "ebay_enterprise_affiliate_network/api_resource"
+require "ebay_enterprise_affiliate_network/publisher"
+require "ebay_enterprise_affiliate_network/api_response"
+
+# Errors
+require "ebay_enterprise_affiliate_network/errors/error"
+require "ebay_enterprise_affiliate_network/errors/authentication_error"
+require "ebay_enterprise_affiliate_network/errors/connection_error"
+require "ebay_enterprise_affiliate_network/errors/invalid_request_error"
+
+module EBayEnterpriseAffiliateNetwork
+  @api_base_url = "http://api.pepperjamnetwork.com"
+  @api_version  = 20120402
+  @api_timeout  = 30
+
+  class << self
+    attr_accessor :api_key, :api_base_url
+    attr_reader :api_version, :api_timeout
+  end
+
+  def self.api_version=(version)
+    raise ArgumentError, "Version must be a Fixnum (YYYYMMDD format); got #{version.class} instead." unless version.is_a? Fixnum
+    raise ArgumentError, "Please provide the version of the API Key." unless version > 0
+    @api_version = version
+  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/ebay_enterprise_affiliate_network/api_resource.rb

@@ -0,0 +1,66 @@
+module EBayEnterpriseAffiliateNetwork
+  class APIResource
+    include HTTParty
+
+    def class_name
+      self.class.name.split('::')[-1]
+    end
+
+    def base_path
+      if self == APIResource
+        raise NotImplementedError.new("APIResource is an abstract class. You should perform actions on its subclasses (i.e. Publisher)")
+      end
+      "/#{EBayEnterpriseAffiliateNetwork.api_version}/#{CGI.escape(class_name.downcase)}/"
+    end
+
+    def get(api_resource, params = {})
+      @resource ||= api_resource
+      unless api_key ||= EBayEnterpriseAffiliateNetwork.api_key
+        raise AuthenticationError.new(
+          "No API key provided. Set your API key using 'EBayEnterpriseAffiliateNetwork.api_key = <API-KEY>'. " +
+          "You can retrieve your API key from the eBay Enterprise web interface. " +
+          "See http://www.pepperjamnetwork.com/affiliate/api/ for details."
+        )
+      end
+      if api_key =~ /\s/
+        raise AuthenticationError.new(
+          "Your API key looks invalid. " +
+          "Double-check your API key at http://www.pepperjamnetwork.com/affiliate/api/"
+        )
+      end
+      raise ArgumentError, "Params must be a Hash; got #{params.class} instead" unless params.is_a? Hash
+
+      params.merge!({
+        apiKey: api_key,
+        format: :json
+      })
+      resource_url = EBayEnterpriseAffiliateNetwork.api_base_url + base_path + api_resource
+      request(resource_url, params)
+    end
+
+    def request(resource_url, params)
+      timeout = EBayEnterpriseAffiliateNetwork.api_timeout
+      begin
+        response = self.class.get(resource_url, query: params, timeout: timeout)
+      rescue Timeout::Error
+        raise ConnectionError.new("Timeout error (#{timeout}s)")
+      end
+      process(response)
+    end
+
+    private
+
+    def process(response)
+      case response.code
+      when 200, 201, 204
+        APIResponse.new(response)
+      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
+  end
+end

data/lib/ebay_enterprise_affiliate_network/api_response.rb

@@ -0,0 +1,31 @@
+module EBayEnterpriseAffiliateNetwork
+  class APIResponse
+    attr_reader :meta, :data, :request
+
+    def initialize(response)
+      @request = response.request
+      body = JSON.parse(response.body)
+      @meta = RecursiveOpenStruct.new(body["meta"])
+      @data = parse(body["data"])
+    end
+
+    def all
+      while meta.pagination.next
+        uri = Addressable::URI.parse(meta.pagination.next.href)
+        next_page_response = EBayEnterpriseAffiliateNetwork::Publisher.new.request(uri.origin + uri.path, uri.query_values)
+        @meta = next_page_response.meta
+        @data += next_page_response.data
+      end
+      @data
+    end
+
+    private
+
+    def parse(raw_data)
+      data = []
+      data = [raw_data] if raw_data.is_a?(Hash) # If we got exactly one result, put it in an array.
+      raw_data.each { |item| data << RecursiveOpenStruct.new(item) } if raw_data
+      data
+    end
+  end
+end

data/lib/ebay_enterprise_affiliate_network/errors/authentication_error.rb

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

data/lib/ebay_enterprise_affiliate_network/errors/connection_error.rb

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

data/lib/ebay_enterprise_affiliate_network/errors/error.rb

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

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

data/lib/ebay_enterprise_affiliate_network/publisher.rb

@@ -0,0 +1,4 @@
+module EBayEnterpriseAffiliateNetwork
+  class Publisher < APIResource
+  end
+end

data/lib/ebay_enterprise_affiliate_network/version.rb

@@ -0,0 +1,3 @@
+module EBayEnterpriseAffiliateNetwork
+  VERSION = "1.0.1"
+end

data/test/ebay_enterprise_affiliate_network_test.rb

@@ -0,0 +1,299 @@
+require "test_helper"
+
+class EBayEnterpriseAffiliateNetworkTest < Test::Unit::TestCase
+  def test_with_invalid_key
+    EBayEnterpriseAffiliateNetwork.api_key = nil
+    ebay = EBayEnterpriseAffiliateNetwork::Publisher.new
+    assert_raise EBayEnterpriseAffiliateNetwork::AuthenticationError do
+      ebay.get('advertiser')
+    end
+
+    EBayEnterpriseAffiliateNetwork.api_key = "key with spaces"
+    assert_raise EBayEnterpriseAffiliateNetwork::AuthenticationError do
+      ebay.get('advertiser')
+    end
+  end
+
+  def test_invalid_version
+    assert_raise ArgumentError do
+      EBayEnterpriseAffiliateNetwork.api_version = ""
+    end
+
+    assert_raise ArgumentError do
+      EBayEnterpriseAffiliateNetwork.api_version = 0
+    end
+  end
+
+  def test_invalid_timeout
+    assert_raise ArgumentError do
+      EBayEnterpriseAffiliateNetwork.api_timeout = ""
+    end
+
+    assert_raise ArgumentError do
+      EBayEnterpriseAffiliateNetwork.api_timeout = "20"
+    end
+
+    assert_raise ArgumentError do
+      EBayEnterpriseAffiliateNetwork.api_timeout = 0
+    end
+
+    assert_raise ArgumentError do
+      EBayEnterpriseAffiliateNetwork.api_timeout = -1
+    end
+  end
+
+  def test_new_publisher
+    EBayEnterpriseAffiliateNetwork.api_key = "key"
+    assert_nothing_raised do
+      EBayEnterpriseAffiliateNetwork::Publisher.new
+    end
+  end
+
+  def test_invalid_params_for_resource
+    EBayEnterpriseAffiliateNetwork.api_key = "key"
+    assert_raise ArgumentError do
+      EBayEnterpriseAffiliateNetwork::Publisher.new.get("advertiser", "foo")
+    end
+  end
+
+  def test_publisher_base_path
+    publisher = EBayEnterpriseAffiliateNetwork::Publisher.new
+    assert_equal "/#{EBayEnterpriseAffiliateNetwork.api_version}/publisher/", publisher.base_path
+  end
+
+  def test_raise_invalid_request_error_on_code_400
+    EBayEnterpriseAffiliateNetwork.api_key = "key"
+    publisher = EBayEnterpriseAffiliateNetwork::Publisher.new
+    json_response = <<-JSON
+    {
+      "meta": {
+        "status": { "code": 400, "message": "foo is not a valid program status option." },
+        "requests": { "current": 384, "maximum": 1500 }
+      },
+      "data": []
+    }
+    JSON
+    stub_request(
+      :get,
+      "http://api.pepperjamnetwork.com/20120402/publisher/advertiser?apiKey=#{EBayEnterpriseAffiliateNetwork.api_key}&format=json&status=foo").
+        with(headers: {}).
+        to_return(
+          status: [400, "foo is not a valid program status option."],
+          body: json_response,
+          headers: {}
+    )
+    e = assert_raise EBayEnterpriseAffiliateNetwork::InvalidRequestError do
+      publisher.get("advertiser", status: :foo)
+    end
+    assert_equal "foo is not a valid program status option. (Code 400)", e.to_s
+  end
+
+  def test_raise_error_on_code_500
+    EBayEnterpriseAffiliateNetwork.api_key = "key"
+    publisher = EBayEnterpriseAffiliateNetwork::Publisher.new
+    json_response = <<-JSON
+    {
+      "meta": {
+        "status": { "code": 500, "message": "Internal Server Error" },
+        "requests": { "current": 384, "maximum": 1500 }
+      },
+      "data": []
+    }
+    JSON
+    stub_request(
+      :get,
+      "http://api.pepperjamnetwork.com/20120402/publisher/advertiser/category?apiKey=#{EBayEnterpriseAffiliateNetwork.api_key}&format=json").
+        with(headers: {}).
+        to_return(
+          status: [500, "Internal Server Error"],
+          body: json_response,
+          headers: {}
+    )
+    e = assert_raise EBayEnterpriseAffiliateNetwork::Error do
+      publisher.get("advertiser/category")
+    end
+    assert_equal "Internal Server Error (Code 500)", e.to_s
+  end
+
+  def test_raise_error_on_code_401
+    EBayEnterpriseAffiliateNetwork.api_key = "wrong_key"
+    publisher = EBayEnterpriseAffiliateNetwork::Publisher.new
+    json_response = <<-JSON
+    {
+      meta: {
+        status: {
+        code: 401,
+        message: "Authentication error."
+        }
+      },
+      data: []
+    }
+    JSON
+    stub_request(
+      :get,
+      "http://api.pepperjamnetwork.com/20120402/publisher/advertiser/category?apiKey=#{EBayEnterpriseAffiliateNetwork.api_key}&format=json").
+        with(headers: {}).
+        to_return(
+          status: [401, "Authentication error."],
+          body: json_response,
+          headers: {}
+    )
+    e = assert_raise EBayEnterpriseAffiliateNetwork::AuthenticationError do
+      publisher.get("advertiser/category")
+    end
+    assert_equal "Authentication error. (Code 401)", e.to_s
+  end
+
+  def test_publisher_get_category_resource
+    EBayEnterpriseAffiliateNetwork.api_key = "key"
+    publisher = EBayEnterpriseAffiliateNetwork::Publisher.new
+    json_response = <<-JSON
+    {
+      "meta": {
+        "status": { "code": 200, "message": "OK" },
+        "pagination": { "total_results": 3, "total_pages": 1 },
+        "requests": { "current": 359, "maximum": 1500 }
+      },
+      "data": [
+        { "name": "Commerce", "id": "1" },
+        { "name": "Computer & Electronics", "id": "2" },
+        { "name": "Education", "id": "3" },
+        { "name": "Accessories", "id": "7" }
+      ]
+    }
+    JSON
+    stub_request(
+      :get,
+      "http://api.pepperjamnetwork.com/20120402/publisher/advertiser/category?apiKey=#{EBayEnterpriseAffiliateNetwork.api_key}&format=json").
+        with(headers: {}).
+        to_return(status: 200, body: json_response, headers: {})
+
+    response = publisher.get("advertiser/category")
+    check_results(response)
+
+    assert_equal 200, response.meta.status.code
+    assert_equal 3, response.meta.pagination.total_results
+    assert_equal 1, response.meta.pagination.total_pages
+    assert_equal 4, response.data.size
+    assert_equal "Commerce", response.data.first.name
+    assert_equal "1", response.data.first.id
+    assert_equal "Accessories", response.data.last.name
+    assert_equal "7", response.data.last.id
+  end
+
+  def test_publisher_get_all_results
+    EBayEnterpriseAffiliateNetwork.api_key = "key"
+    publisher = EBayEnterpriseAffiliateNetwork::Publisher.new
+    response_page_1 = <<-JSON
+    {
+      "meta": {
+        "status": { "code": 200, "message": "OK" },
+        "pagination": {
+          "total_results": 10,
+          "total_pages": 3,
+          "next": {
+            "rel": "next",
+            "href": "http://api.pepperjamnetwork.com/20120402/publisher/advertiser/category?apiKey=#{EBayEnterpriseAffiliateNetwork.api_key}&format=json&page=2",
+            "description": "Next Page"
+          }
+        },
+        "requests": { "current": 359, "maximum": 1500 }
+      },
+      "data": [
+        { "name": "Commerce", "id": "1" },
+        { "name": "Computer & Electronics", "id": "2" },
+        { "name": "Education", "id": "3" },
+        { "name": "Accessories", "id": "7" }
+      ]
+    }
+    JSON
+    response_page_2 = <<-JSON
+    {
+      "meta": {
+        "status": { "code": 200, "message": "OK" },
+        "pagination": {
+          "total_results": 10,
+          "total_pages": 3,
+          "next": {
+            "rel": "next",
+            "href": "http://api.pepperjamnetwork.com/20120402/publisher/advertiser/category?apiKey=#{EBayEnterpriseAffiliateNetwork.api_key}&format=json&page=3",
+            "description": "Next Page"
+          },
+          "prev": {
+            "rel": "prev",
+            "href": "http://api.pepperjamnetwork.com/20120402/publisher/advertiser/category?apiKey=#{EBayEnterpriseAffiliateNetwork.api_key}&format=json&page=1",
+            "description": "Previous Page"
+          }
+        },
+        "requests": { "current": 360, "maximum": 1500 }
+      },
+      "data": [
+        { "name": "Art/Photo/Music", "id": "9" },
+        { "name": "Automotive", "id": "11" },
+        { "name": "Books/Media", "id": "13" },
+        { "name": "Business", "id": "15" }
+      ]
+    }
+    JSON
+    response_page_3 = <<-JSON
+    {
+      "meta": {
+        "status": { "code": 200, "message": "OK" },
+        "pagination": {
+          "total_results": 10,
+          "total_pages": 3,
+          "prev": {
+            "rel": "prev",
+            "href": "http://api.pepperjamnetwork.com/20120402/publisher/advertiser/category?apiKey=#{EBayEnterpriseAffiliateNetwork.api_key}&format=json&page=2",
+            "description": "Previous Page"
+          }
+        },
+        "requests": { "current": 361, "maximum": 1500 }
+      },
+      "data": [
+        { "name": "Careers", "id": "17" },
+        { "name": "Clothing/Apparel", "id": "19" },
+        { "name": "Entertainment", "id": "23" }
+      ]
+    }
+    JSON
+    stub_request(
+      :get,
+      "http://api.pepperjamnetwork.com/20120402/publisher/advertiser/category?apiKey=#{EBayEnterpriseAffiliateNetwork.api_key}&format=json").
+        with(headers: {}).
+        to_return(status: 200, body: response_page_1, headers: {})
+
+    response = publisher.get("advertiser/category")
+    stub_request(
+      :get,
+      "http://api.pepperjamnetwork.com/20120402/publisher/advertiser/category?apiKey=#{EBayEnterpriseAffiliateNetwork.api_key}&format=json&page=2").
+        with(headers: {}).
+        to_return(status: 200, body: response_page_2, headers: {})
+    stub_request(
+      :get,
+      "http://api.pepperjamnetwork.com/20120402/publisher/advertiser/category?apiKey=#{EBayEnterpriseAffiliateNetwork.api_key}&format=json&page=3").
+        with(headers: {}).
+        to_return(status: 200, body: response_page_3, headers: {})
+    all_categories = response.all
+    check_results(response)
+
+    assert_equal 11, all_categories.count
+    assert_equal 23, all_categories.last.id.to_i
+  end
+
+  private
+
+  def check_results(response)
+    assert_instance_of(RecursiveOpenStruct, response.meta)
+    assert_instance_of(Fixnum, response.meta.status.code)
+    assert_instance_of(String, response.meta.status.message)
+    assert_instance_of(Fixnum, response.meta.pagination.total_results)
+    assert_instance_of(Fixnum, response.meta.pagination.total_pages)
+    assert_instance_of(Array, response.data)
+
+    response.data.each do |item|
+      assert_instance_of(RecursiveOpenStruct, item)
+      assert_respond_to(item, :name)
+    end
+  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 "ebay_enterprise_affiliate_network"

metadata

@@ -0,0 +1,228 @@
+--- !ruby/object:Gem::Specification
+name: ebay_enterprise_affiliate_network
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Razvan Marescu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+- !ruby/object:Gem::Dependency
+  name: htmlentities
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+- !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: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+- !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 eBay Enterprise Affiliate Network API (formerly PepperJam
+  Exchange API). See http://help.pepperjamnetwork.com/api for details.
+email:
+- razvan@marescu.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- ebay_enterprise_affiliate_network.gemspec
+- lib/ebay_enterprise_affiliate_network.rb
+- lib/ebay_enterprise_affiliate_network/api_resource.rb
+- lib/ebay_enterprise_affiliate_network/api_response.rb
+- lib/ebay_enterprise_affiliate_network/errors/authentication_error.rb
+- lib/ebay_enterprise_affiliate_network/errors/connection_error.rb
+- lib/ebay_enterprise_affiliate_network/errors/error.rb
+- lib/ebay_enterprise_affiliate_network/errors/invalid_request_error.rb
+- lib/ebay_enterprise_affiliate_network/publisher.rb
+- lib/ebay_enterprise_affiliate_network/version.rb
+- test/ebay_enterprise_affiliate_network_test.rb
+- test/test_helper.rb
+homepage: https://github.com/rmarescu/ebay_enterprise_affiliate_network
+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: eBay Enterprise Affiliate Network API
+test_files:
+- test/ebay_enterprise_affiliate_network_test.rb
+- test/test_helper.rb