zferral 0.2.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

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

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+
+gem "httparty"
+gem "json"
+gem "hashie"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+  gem "vcr"
+  gem "webmock"
+end

data/Gemfile.lock

@@ -0,0 +1,45 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.3)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    hashie (0.4.0)
+    httparty (0.7.3)
+      crack (= 0.1.8)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.5.1)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    vcr (1.5.1)
+    webmock (1.6.2)
+      addressable (>= 2.2.2)
+      crack (>= 0.1.7)
+    yard (0.6.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  hashie
+  httparty
+  jeweler (~> 1.5.2)
+  json
+  rcov
+  rspec (~> 2.3.0)
+  vcr
+  webmock
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Michael Klett
+
+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.rdoc

@@ -0,0 +1,29 @@
+= zferral API Ruby Wrapper
+
+Set your API credentials and obtain a Zferral instance
+
+    zferral = Zferral.new(:subdomain => "foo", :token => "bar")
+
+Then work with your resources through the instance:
+
+    zferral.campaign.all
+    # => [<#Zferral::Campaign campaign_status_id=1, commission_approved_callback_url=nil, ...>, ...]
+    
+    zferral.event.call(:campaign_id => 1, :revenue => 20.00, :affiliate_id => 300, :customer_id => "john@example.com")
+    # => <#Zferral::Event commission_sum=2>
+
+== Contributing to zferral
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Michael Klett. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "zferral"
+  gem.homepage = "http://github.com/grasshopperlabs/zferral"
+  gem.license = "MIT"
+  gem.summary = %Q{A Ruby wrapper for the Zferral API}
+  gem.description = %Q{A Ruby wrapper for the Zferral API, based on HTTParty.}
+  gem.email = "michael@webadvocate.com"
+  gem.authors = ["Michael Klett"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/zferral.rb

@@ -0,0 +1,22 @@
+require "rubygems"
+require 'httparty'
+require 'json'
+require 'hashie'
+
+Dir[File.join(File.dirname(__FILE__), 'zferral', '**', '*.rb')].each {|f| require f}
+
+module Zferral #:nodoc:
+  # Creates a new API {Zferral::Client} with the passed arguments.
+  #
+  # This is the preferred entry point for the library.  In other words, create a client using
+  # this method and access all of the API resources from here.
+  #
+  #   zferral = Zferral.new(:subdomain => 'sandbox', :api_token => 'c143c5450fb633c70c53b1bcc6348077')
+  #   zferral.campaign.list
+  #
+  # @param (see Zferral::Client#initialize)
+  # @return (see Zferral::Client#initialize)
+  def self.new(*args)
+    Zferral::Client.new(*args)
+  end
+end

data/lib/zferral/client.rb

@@ -0,0 +1,34 @@
+module Zferral
+  # The Client holds the API credentials and orchestrates access to the Resources.
+  class Client
+    attr_accessor :subdomain
+    attr_accessor :api_token
+
+    # @param [Hash] options API credentials, passed as a hash with 'subdomain' and 'api_token' keys
+    def initialize(options = {})
+      self.subdomain = options[:subdomain] || options['subdomain']
+      self.api_token = options[:api_token] || options['api_token']
+    end
+    
+    # A {Zferral::Campaign} class connected to this Client
+    #
+    # @return [Zferral::Campaign]
+    def campaign
+      Zferral::Campaign.connect(self)
+    end
+    
+    # A {Zferral::Campaign} resource for this Client
+    #
+    # @return [Zferral::Campaign] {Zferral::Campaign} class
+    def campaign
+      Zferral::Campaign.connect(self)
+    end
+    
+    # A {Zferral::Event} resource for this Client
+    #
+    # @return [Zferral::Event] {Zferral::Event} class
+    def event
+      Zferral::Event.connect(self)
+    end
+  end
+end

data/lib/zferral/errors.rb

@@ -0,0 +1,13 @@
+module Zferral
+  # Raised when general resource errors are encountered.
+  class ResourceError < StandardError
+  end
+  
+  # Raised when a fetch request for a particular ID results in no resource being found.
+  class ResourceNotFound < StandardError
+  end
+  
+  # Raised when a particular Resource does not support the requested method
+  class MethodNotSupported < StandardError
+  end
+end

data/lib/zferral/resource.rb

@@ -0,0 +1,136 @@
+module Zferral
+  # The "base" resource from which all of the Zferral API resources subclass.  This class typically
+  # isn't used directly; instead, you'll use the subclasses like {Zferral::Campaign}.
+  class Resource < Hashie::Mash
+    include HTTParty
+    format :json
+    headers 'Content-Type' => 'application/json', 'Accept' => 'application/json'
+    debug_output $stdout
+    
+    # Used to "connect" the resource to a Client already configured with credentials.
+    #
+    # Upon connection, the passed in Client is stored (see .client), the base_uri
+    # for HTTParty interaction is calculated, and the class is returned.
+    #
+    # @param [Client] client instance with credentials (subdomain and api_token attached)
+    #
+    # @return [Class]
+    def self.connect(client)
+      @@client = client
+      self.base_uri("https://#{subdomain}.zferral.com/api/#{api_token}")
+      self
+    end
+    
+    # @return [String] The subdomain of the currently connected Client, or nil of no Client is connected.
+    def self.subdomain
+      @@client.subdomain if @@client
+    end
+
+    # @return [String] The API token of the currently connected Client, or nil of no Client is connected.
+    def self.api_token
+      @@client.api_token if @@client
+    end
+
+    # @return [String] The singular resource name (computed from the class name) to be used in resource URLs
+    def self.resource_name
+      name.split("::").last.downcase
+    end
+    
+    # @return [String] The plural resource name (computed from the class name) to be used in resource URLs
+    def self.resource_names
+      name.split("::").last.downcase + "s"
+    end
+    
+    # Get an array of all members of the resource list
+    #
+    # @return [Array] An array of the expected resource
+    def self.list
+      handle_list get("/#{resource_names}.json")["#{resource_names}"]
+    end
+    
+    # Alias .all to .list
+    class << self
+      alias_method :all, :list
+    end
+
+    # Fetches a single resource by ID
+    #
+    # @return [Resource] A single Resource object, or one of its subclasses
+    #
+    # @raise [ResourceError, ResourceNotFound]
+    def self.fetch(id)
+      fetch_id(id)
+      handle_fetch get("/#{resource_name}/#{id}.json").parsed_response
+    end
+    
+    # {Resource.find} can be used with syntax like ActiveRecord to fetch lists or single resources.
+    #
+    # To fetch a list, use the +:all+ parameter:
+    # 
+    #   Resource.find(:all)
+    #
+    # To fetch a single Resource, pass an Integer ID
+    #
+    # @param [Symbol, Integer] +:all+ to fetch a list, an Integer to fetch a single Resource
+    #
+    # @return [Array, Resource] An Array of Resources or a single Resource
+    #
+    # @raise (see .fetch)
+    def self.find(scope_or_id)
+      case scope_or_id
+      when Symbol
+        if scope_or_id == :all
+          list
+        end
+      when Integer, String
+        fetch(scope_or_id.to_i)
+      end
+    end
+    
+    private
+    
+    def self.client
+      @@client
+    end
+    
+    def self.handle_list(list)
+      if list.is_a?(Array)
+        list.collect { |c| self.new(c) }
+      else
+        raise Zferral::ResourceError, "unexpected response while listing #{resource_names}: #{list.inspect[0..20]}"
+      end
+    end
+    
+    def self.fetch_id(id=nil)
+      @fetch_id = id unless id.nil?
+      @fetch_id
+    end
+    
+    def self.handle_fetch(response)
+      case response
+      when Hash
+        case response.keys.first
+        when resource_name
+          resource = self.new(response[resource_name])
+          if resource.respond_to?(:error)
+            raise Zferral::ResourceError, resource.error
+          end
+          resource
+        when 'error'
+          code = response['error']['code']
+          case code
+          when '404'
+            raise Zferral::ResourceNotFound, "#{resource_name} with id=#{fetch_id} was not found"
+          else
+            raise Zferral::ResourceError, "#{resource_name} caused a #{code} error"
+          end
+        else
+          raise Zferral::ResourceError, "unexpected response: #{resource.inspect}" 
+        end
+      else
+        raise Zferral::ResourceError, "unexpected response: #{resource.inspect}"
+      end
+    end
+      
+  end
+end

data/lib/zferral/resources/campaign.rb

@@ -0,0 +1,7 @@
+module Zferral
+  # A Zferral Campaign resource, that behaves like a RESTful Resource
+  #
+  # http://zferral.com/api-docs/campaign
+  class Campaign < Resource
+  end
+end

data/lib/zferral/resources/event.rb

@@ -0,0 +1,33 @@
+module Zferral
+  # A Zferral Event Resource
+  #
+  # http://zferral.com/api-docs/event
+  class Event < Resource
+    # The event/call API method, used to register an event (i.e. sale)
+    def self.call(params = {})
+      response = post("/event/call.json", :body => {:event => params}.to_json).parsed_response
+      handle_fetch response
+    end
+    
+    # A special invocation of the event/call API method, used to register recurring revenue events.
+    #
+    # These calls add the +ignore_cookie+ flag, so that an affiliate ID or cookie is not needed.
+    # Instead, the affiliate to credit is identified by the +customer_id+ attribute, assuming that
+    # the +customer_id+ has been associated with the Affiliate already via a normal .call method
+    # or via the Zferral tracking code (img tag or javascript).
+    def self.call_recurring(params = {})
+      params.merge!(:ignore_cookie => '1')
+      call(params)
+    end
+    
+    # Not supported by Event
+    def self.list
+      raise MethodNotSupported, "Event does not support the .list method"
+    end
+
+    # Not supported by Event
+    def self.fetch(id)
+      raise MethodNotSupported, "Event does not support the .fetch method"
+    end
+  end
+end

data/spec/campaign_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Zferral::Campaign do
+  use_vcr_cassette "campaigns"
+
+  let(:campaign) { Zferral.new(:subdomain => subdomain, :api_token => api_token).campaign }
+
+  describe "#list" do
+    it "returns an array of your campaigns" do
+      campaign.list.should be_an_array_of_campaigns
+    end
+    
+    it "is aliased by #all" do
+      campaign.all.should == campaign.list
+    end
+    
+    it "is aliased by #find(:all)" do
+      campaign.find(:all).should == campaign.list
+    end
+  end
+  
+  describe "#fetch" do
+    context "given a valid ID" do
+      it "fetches and returns the campaign" do
+        campaign.fetch(1).should be_a_campaign
+      end
+    end
+    context "given an invalid ID" do
+      it "raises a ResourceNotFound exception" do
+        lambda { campaign.fetch(9999999) }.should raise_error(Zferral::ResourceNotFound, "campaign with id=9999999 was not found")
+      end
+    end
+    
+    it "is aliased by #find(id)" do
+      campaign.find(1).should == campaign.fetch(1)
+    end
+  end
+end

data/spec/event_spec.rb

@@ -0,0 +1,52 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Zferral::Event do
+  use_vcr_cassette "events", :match_requests_on => [:uri, :method, :body]
+
+  let(:event) { Zferral.new(:subdomain => subdomain, :api_token => api_token).event }
+  
+  describe "#call" do
+    context "passing all required params, with debug" do
+      it "returns an event containing the commission_sum" do
+        resource = event.call(:debug => '1', :campaign_id => 1, :revenue => 20.00, :customer_id => "1", :affiliate_id => 538)
+        resource.should respond_to(:commission_sum)
+      end
+    end
+    
+    context "with a missing campaign_id" do
+      it "raises a ResourceError with the error displayed" do
+        lambda {
+          event.call(:debug => '1', :revenue => 20.00, :customer_id => "1", :affiliate_id => 538)
+        }.should raise_error(Zferral::ResourceError, "Campaign ID is not set.")
+      end
+    end
+
+    context "with none of the required parameters" do
+      it "raises a ResourceError with the first encountered error displayed" do
+        lambda {
+          event.call(:debug => '1')
+        }.should raise_error(Zferral::ResourceError, "Campaign ID is not set.")
+      end
+    end
+  end
+  
+  describe "#call_recurring" do
+    it "invokes call after merging the option to ignore the cookie" do
+      hash = {:debug => '1', :campaign_id => 1, :revenue => 20.00, :customer_id => "1", :affiliate_id => 538}
+      event.should_receive(:call).with(hash.merge(:ignore_cookie => '1'))
+      event.call_recurring(hash)
+    end
+    
+    it "posts the event successfully without passing an affiliate id if the customer_id is previously 'registered'" do
+      resource = event.call_recurring(:debug => '1', :campaign_id => 1, :revenue => 20.00, :customer_id => "1")
+      resource.should respond_to(:commission_sum)
+    end
+
+    it "posts the event unsuccessfully without passing an affiliate id if the customer_id is not previously 'registered'" do
+      lambda {
+        event.call_recurring(:debug => '1', :campaign_id => 1, :revenue => 20.00, :customer_id => "foobarjones")
+      }.should raise_error(Zferral::ResourceError, "Neither cookie found nor referer set.")
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'vcr'
+require 'webmock/rspec'
+require 'zferral'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.extend VCR::RSpec::Macros
+end
+
+VCR.config do |c|
+  c.cassette_library_dir     = 'spec/vcr_cassettes'
+  c.stub_with                :webmock
+  c.default_cassette_options = { :record => :new_episodes }
+end
+
+def test_credentials
+  @test_credentials ||= {'subdomain' => subdomain, 'api_token' => api_token}
+end
+
+def subdomain
+  'sandbox'
+end
+
+def api_token
+  'c143c5450fb633c70c53b1bcc6348077'
+end
+  

data/spec/support/matchers/be.rb

@@ -0,0 +1,29 @@
+RSpec::Matchers.define :be_an_array_of_campaigns do
+  match do |actual|
+    actual.is_a?(Array) && actual.first.is_a?(Hashie::Mash) && actual.first.respond_to?(:campaign_status_id)
+  end
+  
+  failure_message_for_should do |actual|
+    "expected an array of Campaigns, got #{actual.inspect}"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected to not receive an array of Campaigns, got #{actual.inspect}"
+  end
+end
+
+RSpec::Matchers.define :be_a_campaign do
+  match do |actual|
+    actual.is_a?(Hashie::Mash) && actual.respond_to?(:campaign_status_id)
+  end
+  
+  failure_message_for_should do |actual|
+    "expected a Campaign, got #{actual.inspect}"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected not a Campaign, got #{actual.inspect}"
+  end
+end
+
+

data/spec/vcr_cassettes/campaigns.yml

@@ -0,0 +1,119 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://sandbox.zferral.com:443/api/c143c5450fb633c70c53b1bcc6348077/campaigns.json
+    body: 
+    headers: 
+      accept: 
+      - application/json
+      content-type: 
+      - application/json
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      x-powered-by: 
+      - PHP/5.2.17-0.dotdeb.0
+      content-type: 
+      - application/json; charset=utf-8
+      server: 
+      - Apache/2.2.9 (Debian) PHP/5.2.17-0.dotdeb.0 with Suhosin-Patch mod_ssl/2.2.9 OpenSSL/0.9.8g
+      date: 
+      - Thu, 27 Jan 2011 19:11:17 GMT
+      content-length: 
+      - "847"
+      set-cookie: 
+      - zferral=34cb69dbc3ea8dcee785cda0cc18e31e; path=/
+    body: "{\"campaigns\":[{\"id\":1,\"commission_type_id\":2,\"campaign_status_id\":1,\"event_id\":2,\"reward_points_type_id\":null,\"is_monetary\":true,\"is_private\":false,\"name\":\"Sample Revenue Share\",\"date_start\":\"2010-08-25\",\"date_end\":\"9999-12-01\",\"has_tiered_commission\":false,\"has_stepped_commission\":false,\"initial_commission\":\"10.00\",\"recurring_commission\":null,\"has_recurring_limited_by_renewals\":false,\"renewals_number\":null,\"has_recurring_limited_by_period\":false,\"recurring_end_date\":null,\"recurring_period_in_days\":null,\"has_simple_recurring_commissions\":false,\"has_auto_approval_commission\":true,\"commission_approved_callback_url\":null,\"description\":\"Refer a new customer, receive 10% of the revenue generated, for life.\",\"cookie_expire\":\"2010-11-25 00:00:00\",\"created_at\":\"2010-08-25 12:49:06\",\"landing_page_url\":\"http:\\/\\/zferral.com\",\"deleted_at\":null}]}"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://sandbox.zferral.com:443/api/c143c5450fb633c70c53b1bcc6348077/campaign/1.json
+    body: 
+    headers: 
+      accept: 
+      - application/json
+      content-type: 
+      - application/json
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      x-powered-by: 
+      - PHP/5.2.17-0.dotdeb.0
+      content-type: 
+      - application/json; charset=utf-8
+      date: 
+      - Thu, 27 Jan 2011 19:11:18 GMT
+      server: 
+      - Apache/2.2.9 (Debian) PHP/5.2.17-0.dotdeb.0 with Suhosin-Patch mod_ssl/2.2.9 OpenSSL/0.9.8g
+      content-length: 
+      - "844"
+      set-cookie: 
+      - zferral=58c023f43ec7907beca9357e31b7ea5f; path=/
+    body: "{\"campaign\":{\"id\":1,\"commission_type_id\":2,\"campaign_status_id\":1,\"event_id\":2,\"reward_points_type_id\":null,\"is_monetary\":true,\"is_private\":false,\"name\":\"Sample Revenue Share\",\"date_start\":\"2010-08-25\",\"date_end\":\"9999-12-01\",\"has_tiered_commission\":false,\"has_stepped_commission\":false,\"initial_commission\":\"10.00\",\"recurring_commission\":null,\"has_recurring_limited_by_renewals\":false,\"renewals_number\":null,\"has_recurring_limited_by_period\":false,\"recurring_end_date\":null,\"recurring_period_in_days\":null,\"has_simple_recurring_commissions\":false,\"has_auto_approval_commission\":true,\"commission_approved_callback_url\":null,\"description\":\"Refer a new customer, receive 10% of the revenue generated, for life.\",\"cookie_expire\":\"2010-11-25 00:00:00\",\"created_at\":\"2010-08-25 12:49:06\",\"landing_page_url\":\"http:\\/\\/zferral.com\",\"deleted_at\":null}}"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://sandbox.zferral.com:443/api/c143c5450fb633c70c53b1bcc6348077/campaign/1.json
+    body: 
+    headers: 
+      accept: 
+      - application/json
+      content-type: 
+      - application/json
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      x-powered-by: 
+      - PHP/5.2.17-0.dotdeb.0
+      content-type: 
+      - application/json; charset=utf-8
+      date: 
+      - Thu, 27 Jan 2011 19:11:18 GMT
+      server: 
+      - Apache/2.2.9 (Debian) PHP/5.2.17-0.dotdeb.0 with Suhosin-Patch mod_ssl/2.2.9 OpenSSL/0.9.8g
+      content-length: 
+      - "844"
+      set-cookie: 
+      - zferral=eca13fe9ab58c58ac2298a5bfbe56ce4; path=/
+    body: "{\"campaign\":{\"id\":1,\"commission_type_id\":2,\"campaign_status_id\":1,\"event_id\":2,\"reward_points_type_id\":null,\"is_monetary\":true,\"is_private\":false,\"name\":\"Sample Revenue Share\",\"date_start\":\"2010-08-25\",\"date_end\":\"9999-12-01\",\"has_tiered_commission\":false,\"has_stepped_commission\":false,\"initial_commission\":\"10.00\",\"recurring_commission\":null,\"has_recurring_limited_by_renewals\":false,\"renewals_number\":null,\"has_recurring_limited_by_period\":false,\"recurring_end_date\":null,\"recurring_period_in_days\":null,\"has_simple_recurring_commissions\":false,\"has_auto_approval_commission\":true,\"commission_approved_callback_url\":null,\"description\":\"Refer a new customer, receive 10% of the revenue generated, for life.\",\"cookie_expire\":\"2010-11-25 00:00:00\",\"created_at\":\"2010-08-25 12:49:06\",\"landing_page_url\":\"http:\\/\\/zferral.com\",\"deleted_at\":null}}"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://sandbox.zferral.com:443/api/c143c5450fb633c70c53b1bcc6348077/campaign/9999999.json
+    body: 
+    headers: 
+      accept: 
+      - application/json
+      content-type: 
+      - application/json
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 404
+      message: Not Found
+    headers: 
+      x-powered-by: 
+      - PHP/5.2.17-0.dotdeb.0
+      content-type: 
+      - application/json; charset=utf-8
+      server: 
+      - Apache/2.2.9 (Debian) PHP/5.2.17-0.dotdeb.0 with Suhosin-Patch mod_ssl/2.2.9 OpenSSL/0.9.8g
+      date: 
+      - Thu, 27 Jan 2011 19:11:19 GMT
+      content-length: 
+      - "46"
+      set-cookie: 
+      - zferral=3c862251ddc530dd6eada7f3e1d493a4; path=/
+      status: 
+      - 404 Not Found
+    body: "{\"error\":{\"code\":\"404\",\"message\":\"Not Found\"}}"
+    http_version: "1.1"

data/spec/vcr_cassettes/events.yml

@@ -0,0 +1,207 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :post
+    uri: https://sandbox.zferral.com:443/api/c143c5450fb633c70c53b1bcc6348077/event/call.json
+    body: "{\"event\":{\"debug\":\"1\",\"campaign_id\":1,\"revenue\":20.0,\"customer_id\":\"1\",\"affiliate_id\":538}}"
+    headers: 
+      accept: 
+      - application/json
+      content-type: 
+      - application/json
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      x-powered-by: 
+      - PHP/5.2.17-0.dotdeb.0
+      content-type: 
+      - application/json; charset=utf-8
+      server: 
+      - Apache/2.2.9 (Debian) PHP/5.2.17-0.dotdeb.0 with Suhosin-Patch mod_ssl/2.2.9 OpenSSL/0.9.8g
+      date: 
+      - Thu, 27 Jan 2011 19:11:21 GMT
+      content-length: 
+      - "30"
+      set-cookie: 
+      - cuid=8295b918f98f70f8d09511d9044ea543; expires=Wed, 01-Jan-2020 05:00:00 GMT; path=/; domain=sandbox.zferral.com
+      - zferral=8a0518ef003e7f83628a6c8d61b193c6; path=/
+    body: "{\"event\":{\"commission_sum\":2}}"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :post
+    uri: https://sandbox.zferral.com:443/api/c143c5450fb633c70c53b1bcc6348077/event/call.json
+    body: "{\"event\":{\"debug\":\"1\",\"revenue\":20.0,\"customer_id\":\"1\",\"affiliate_id\":538}}"
+    headers: 
+      accept: 
+      - application/json
+      content-type: 
+      - application/json
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      x-powered-by: 
+      - PHP/5.2.17-0.dotdeb.0
+      content-type: 
+      - application/json; charset=utf-8
+      date: 
+      - Thu, 27 Jan 2011 19:11:22 GMT
+      server: 
+      - Apache/2.2.9 (Debian) PHP/5.2.17-0.dotdeb.0 with Suhosin-Patch mod_ssl/2.2.9 OpenSSL/0.9.8g
+      content-length: 
+      - "45"
+      set-cookie: 
+      - zferral=ff098b069200835b71e4c38c5d203ef6; path=/
+    body: "{\"event\":{\"error\":\"Campaign ID is not set.\"}}"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :post
+    uri: https://sandbox.zferral.com:443/api/c143c5450fb633c70c53b1bcc6348077/event/call.json
+    body: "{\"event\":{\"debug\":\"1\"}}"
+    headers: 
+      accept: 
+      - application/json
+      content-type: 
+      - application/json
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      x-powered-by: 
+      - PHP/5.2.17-0.dotdeb.0
+      content-type: 
+      - application/json; charset=utf-8
+      server: 
+      - Apache/2.2.9 (Debian) PHP/5.2.17-0.dotdeb.0 with Suhosin-Patch mod_ssl/2.2.9 OpenSSL/0.9.8g
+      date: 
+      - Thu, 27 Jan 2011 19:11:23 GMT
+      content-length: 
+      - "45"
+      set-cookie: 
+      - zferral=e1f89862984eebf98420674e6c5dab82; path=/
+    body: "{\"event\":{\"error\":\"Campaign ID is not set.\"}}"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :post
+    uri: https://sandbox.zferral.com:443/api/c143c5450fb633c70c53b1bcc6348077/event/call.json
+    body: "{\"event\":{\"debug\":\"1\",\"campaign_id\":1,\"ignore_cookie\":\"1\",\"revenue\":20.0,\"customer_id\":\"1\"}}"
+    headers: 
+      accept: 
+      - application/json
+      content-type: 
+      - application/json
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      x-powered-by: 
+      - PHP/5.2.17-0.dotdeb.0
+      content-type: 
+      - application/json; charset=utf-8
+      date: 
+      - Thu, 27 Jan 2011 19:11:24 GMT
+      server: 
+      - Apache/2.2.9 (Debian) PHP/5.2.17-0.dotdeb.0 with Suhosin-Patch mod_ssl/2.2.9 OpenSSL/0.9.8g
+      content-length: 
+      - "30"
+      set-cookie: 
+      - cuid=8295b918f98f70f8d09511d9044ea543; expires=Wed, 01-Jan-2020 05:00:00 GMT; path=/; domain=sandbox.zferral.com
+      - zferral=239337692a5ea21deb195c8be0a6c1cf; path=/
+    body: "{\"event\":{\"commission_sum\":2}}"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :post
+    uri: https://sandbox.zferral.com:443/api/c143c5450fb633c70c53b1bcc6348077/event/call.json
+    body: "{\"event\":{\"debug\":\"1\",\"campaign_id\":1,\"ignore_cookie\":\"1\",\"revenue\":20.0,\"customer_id\":\"foobarjones\"}}"
+    headers: 
+      accept: 
+      - application/json
+      content-type: 
+      - application/json
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      x-powered-by: 
+      - PHP/5.2.17-0.dotdeb.0
+      content-type: 
+      - application/json; charset=utf-8
+      server: 
+      - Apache/2.2.9 (Debian) PHP/5.2.17-0.dotdeb.0 with Suhosin-Patch mod_ssl/2.2.9 OpenSSL/0.9.8g
+      date: 
+      - Thu, 27 Jan 2011 19:11:25 GMT
+      content-length: 
+      - "59"
+      set-cookie: 
+      - zferral=aea87a857d0d423d913c442d74935ede; path=/
+    body: "{\"event\":{\"error\":\"Neither cookie found nor referer set.\"}}"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :post
+    uri: https://sandbox.zferral.com:443/api/c143c5450fb633c70c53b1bcc6348077/event/call.json
+    body: "{\"event\":{\"affiliate_id\":538,\"debug\":\"1\",\"campaign_id\":1,\"revenue\":20.0,\"customer_id\":\"1\"}}"
+    headers: 
+      accept: 
+      - application/json
+      content-type: 
+      - application/json
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      x-powered-by: 
+      - PHP/5.2.17-0.dotdeb.0
+      content-type: 
+      - application/json; charset=utf-8
+      date: 
+      - Thu, 27 Jan 2011 19:47:20 GMT
+      server: 
+      - Apache/2.2.9 (Debian) PHP/5.2.17-0.dotdeb.0 with Suhosin-Patch mod_ssl/2.2.9 OpenSSL/0.9.8g
+      content-length: 
+      - "30"
+      set-cookie: 
+      - cuid=8295b918f98f70f8d09511d9044ea543; expires=Wed, 01-Jan-2020 05:00:00 GMT; path=/; domain=sandbox.zferral.com
+      - zferral=5567f5f61c1d97bae1435e22f80e8d3a; path=/
+    body: "{\"event\":{\"commission_sum\":2}}"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :post
+    uri: https://sandbox.zferral.com:443/api/c143c5450fb633c70c53b1bcc6348077/event/call.json
+    body: "{\"event\":{\"affiliate_id\":538,\"debug\":\"1\",\"revenue\":20.0,\"customer_id\":\"1\"}}"
+    headers: 
+      accept: 
+      - application/json
+      content-type: 
+      - application/json
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      x-powered-by: 
+      - PHP/5.2.17-0.dotdeb.0
+      content-type: 
+      - application/json; charset=utf-8
+      server: 
+      - Apache/2.2.9 (Debian) PHP/5.2.17-0.dotdeb.0 with Suhosin-Patch mod_ssl/2.2.9 OpenSSL/0.9.8g
+      date: 
+      - Thu, 27 Jan 2011 19:47:21 GMT
+      content-length: 
+      - "45"
+      set-cookie: 
+      - zferral=9a1d9025277bff7468e148f7b8d673e6; path=/
+    body: "{\"event\":{\"error\":\"Campaign ID is not set.\"}}"
+    http_version: "1.1"

data/spec/zferral_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Zferral" do
+  describe ".new" do
+    it "creates a new instance of Zferral::Client" do
+      Zferral.new.should be_a(Zferral::Client)
+    end
+  end
+  
+  describe "#campaign" do
+    it "provides access to the Campaign class with a linkage to the client" do
+      zferral = Zferral.new(:subdomain => subdomain, :api_token => api_token)
+      zferral.campaign.should == Zferral::Campaign
+      zferral.campaign.client.should == zferral
+    end
+  end
+
+  describe "#event" do
+    it "provides access to the Event class with a linkage to the client" do
+      zferral = Zferral.new(:subdomain => subdomain, :api_token => api_token)
+      zferral.event.should == Zferral::Event
+      zferral.event.client.should == zferral
+    end
+  end
+end
+

data/zferral.gemspec

@@ -0,0 +1,96 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{zferral}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Klett"]
+  s.date = %q{2011-01-27}
+  s.description = %q{A Ruby wrapper for the Zferral API, based on HTTParty.}
+  s.email = %q{michael@webadvocate.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/zferral.rb",
+    "lib/zferral/client.rb",
+    "lib/zferral/errors.rb",
+    "lib/zferral/resource.rb",
+    "lib/zferral/resources/campaign.rb",
+    "lib/zferral/resources/event.rb",
+    "spec/campaign_spec.rb",
+    "spec/event_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/matchers/be.rb",
+    "spec/vcr_cassettes/campaigns.yml",
+    "spec/vcr_cassettes/events.yml",
+    "spec/zferral_spec.rb",
+    "zferral.gemspec"
+  ]
+  s.homepage = %q{http://github.com/grasshopperlabs/zferral}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A Ruby wrapper for the Zferral API}
+  s.test_files = [
+    "spec/campaign_spec.rb",
+    "spec/event_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/matchers/be.rb",
+    "spec/zferral_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<hashie>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<vcr>, [">= 0"])
+      s.add_development_dependency(%q<webmock>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<hashie>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<vcr>, [">= 0"])
+      s.add_dependency(%q<webmock>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<hashie>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<vcr>, [">= 0"])
+    s.add_dependency(%q<webmock>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,240 @@
+--- !ruby/object:Gem::Specification 
+name: zferral
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Michael Klett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-27 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: httparty
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: json
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: hashie
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rspec
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: yard
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: bundler
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: jeweler
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rcov
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id008
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: vcr
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id009
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: webmock
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id010
+description: A Ruby wrapper for the Zferral API, based on HTTParty.
+email: michael@webadvocate.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/zferral.rb
+- lib/zferral/client.rb
+- lib/zferral/errors.rb
+- lib/zferral/resource.rb
+- lib/zferral/resources/campaign.rb
+- lib/zferral/resources/event.rb
+- spec/campaign_spec.rb
+- spec/event_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers/be.rb
+- spec/vcr_cassettes/campaigns.yml
+- spec/vcr_cassettes/events.yml
+- spec/zferral_spec.rb
+- zferral.gemspec
+has_rdoc: true
+homepage: http://github.com/grasshopperlabs/zferral
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Ruby wrapper for the Zferral API
+test_files: 
+- spec/campaign_spec.rb
+- spec/event_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers/be.rb
+- spec/zferral_spec.rb