hasoffers 0.1.0 → 0.1.1

data/CHANGELOG

@@ -1,5 +1,9 @@
 = HasOffers CHANGELOG
 
+== Version 0.1.1
+* Changed REMOTE_TEST environment variable to HAS_OFFERS_LIVE
+* Added AffiliateBilling.find_all_invoices_by_ids
+
 == Version 0.1.0
 
 Initial framework including support for the following API calls:

data/README.rdoc

@@ -2,9 +2,11 @@
 
 This gem hooks into the HasOffers API as documented here: http://www.hasoffers.com/wiki/Category:API
 
+
 == Install
 
-gem install ngin-hasoffers --source http://gems.github.com
+gem install hasoffers
+
 
 == Usage
 
@@ -20,12 +22,28 @@ Example usage: (more examples in tests)
                                     'status' => 'active',
                                     'expiration_date' => (Date.today + 30).to_s)
 
+When running in development mode, by default live api calls are not made. Dummy responses are returned from the DummyResponse class. Set the HAS_OFFERS_LIVE environment variable to "1" to make live api calls when in development mode like so:
+
+env HAS_OFFERS_LIVE=1 script/server
+
+If you always want live api calls in development mode then you can add this line to your development.rb file:
+
+HasOffers::Base.api_mode = :live
+
+
+== Tests
+
 The tests can be ran in two modes:
 
-1. Test mode:  rake test
- * Does not make real API calls. Dummy responses are returned by the DummyResponse class which is also useful in development mode to avoid real API calls
+=== Test mode
+* rake test
+Does not make live API calls. Dummy responses are returned by the DummyResponse class which is also used in development mode to avoid live API calls.
+
+=== Live mode
+* env REMOTE_TEST=1 rake test
+Makes live api calls. Uses the HasOffer credentials in config/has_offers.yml which by default is set to the demo account credentials. HasOffers does not supply a test gateway so be careful to not run these tests against your live HasOffers account.
+
 
-2. Live mode: env REMOTE_TEST=1 rake test
- * Makes real api calls. Uses the HasOffer credentials in config/has_offers.yml which by default is set to the demo account credentials. HasOffers does not supply a test gateway so be careful to not run these tests against your live HasOffers account.
+== Contributing
 
-The HasOffers API is huge and this gem implements only a portion of what is available with their API. With this framework in place it should be easy to extend the gem to support API calls that are not yet supported. Please send contributions as git patches.  
+The HasOffers API is huge and this gem implements only a portion of what is available with their API. With this framework in place it should be easy to extend the gem for API calls that are not yet supported. Please send contributions as git patches to luke.ludwig@tstmedia.com, or alternatively create a fork and send a git pull request via github.   

data/Rakefile

@@ -2,13 +2,13 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('hasoffers', '0.1.0') do |p|
+Echoe.new('hasoffers', '0.1.1') do |p|
   p.description = "Implementation of the HasOffers API for affiliate advertising."
   p.url = "http://github.com/ngin/hasoffers"
   p.author = "Luke Ludwig"
   p.email = "luke.ludwig@tstmedia.com"
   p.development_dependencies = []
-  p.runtime_dependencies = ["yajl-ruby >= 0.7.6", "crack >= 0.1.6"]
+  p.runtime_dependencies = ["yajl-ruby >=0.7.6", "crack >=0.1.6"]
 end
 
 Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/hasoffers.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hasoffers}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Luke Ludwig"]
-  s.date = %q{2010-07-13}
+  s.date = %q{2010-07-20}
   s.description = %q{Implementation of the HasOffers API for affiliate advertising.}
   s.email = %q{luke.ludwig@tstmedia.com}
   s.extra_rdoc_files = ["CHANGELOG", "README.rdoc", "lib/has_offers_model.rb", "lib/hasoffers.rb", "lib/hasoffers/advertiser.rb", "lib/hasoffers/affiliate.rb", "lib/hasoffers/affiliate_billing.rb", "lib/hasoffers/base.rb", "lib/hasoffers/conversion.rb", "lib/hasoffers/dummy_response.rb", "lib/hasoffers/offer.rb", "lib/hasoffers/report.rb", "lib/hasoffers/response.rb"]
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Hasoffers", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{hasoffers}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Implementation of the HasOffers API for affiliate advertising.}
   s.test_files = ["test/advertiser_test.rb", "test/affiliate_billing_test.rb", "test/affiliate_test.rb", "test/conversion_test.rb", "test/offer_test.rb", "test/report_test.rb", "test/test_helper.rb"]
 
@@ -23,15 +23,15 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<yajl-ruby>, [">= 0", "= 0.7.6"])
-      s.add_runtime_dependency(%q<crack>, [">= 0", "= 0.1.6"])
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<yajl-ruby>, [">= 0.7.6"])
+      s.add_runtime_dependency(%q<crack>, [">= 0.1.6"])
     else
-      s.add_dependency(%q<yajl-ruby>, [">= 0", "= 0.7.6"])
-      s.add_dependency(%q<crack>, [">= 0", "= 0.1.6"])
+      s.add_dependency(%q<yajl-ruby>, [">= 0.7.6"])
+      s.add_dependency(%q<crack>, [">= 0.1.6"])
     end
   else
-    s.add_dependency(%q<yajl-ruby>, [">= 0", "= 0.7.6"])
-    s.add_dependency(%q<crack>, [">= 0", "= 0.1.6"])
+    s.add_dependency(%q<yajl-ruby>, [">= 0.7.6"])
+    s.add_dependency(%q<crack>, [">= 0.1.6"])
   end
 end

data/lib/hasoffers/affiliate_billing.rb

@@ -23,6 +23,19 @@ module HasOffers
         response
       end
 
+      def find_all_invoices_by_ids(ids, params = {})
+        params['ids'] = ids
+        response = get_request(Target, 'findAllInvoicesByIds', params)
+        if response.success?
+          # strip out the clutter
+          data = response.data.map do |invoice|
+            invoice[1].values.first
+          end
+          response.set_data data
+        end
+        response
+      end
+
       def create_invoice(data, return_object = false)
         requires!(data, %w[affiliate_id start_date end_date status])
         params = build_data(data, return_object)

data/lib/hasoffers/base.rb

@@ -4,7 +4,7 @@ module HasOffers
   class Base
 
     BaseUri = 'https://api.hasoffers.com/Api'
-    @@api_mode = (ENV['RAILS_ENV'] == 'production' or ENV['REMOTE_TEST'] == '1') ? :live : :test
+    @@api_mode = (ENV['RAILS_ENV'] == 'production' or ENV['HAS_OFFERS_LIVE'] == '1') ? :live : :test
     @@default_params = nil
 
     class << self
@@ -31,7 +31,7 @@ module HasOffers
         @@api_mode == :live
       end
 
-      def set_api_mode(mode)
+      def api_mode=(mode)
         @@api_mode = mode
       end
 

data/lib/hasoffers/dummy_response.rb

@@ -62,6 +62,10 @@ module HasOffers
         {"response" => { "status" => 1, "data" => {"1" => {"AffiliateInvoice" => {"id" => "1", "affiliate_id" => "2", "datetime" => "2009-06-02 20:14:05", "start_date" => "2009-06-01", "end_date" => "2009-06-02", "is_paid" => "1", "memo" => "asdf", "status" => "active", "notes" => "", "receipt_id" => nil, "currency" => "USD", "amount" => "12.00", "conversions" => "12" }}}, "errors" => []}}
       end
 
+      def response_for_affiliatebilling_findallinvoicesbyids(params)
+        {"response" => { "status" => 1, "data" => {"1" => {"AffiliateInvoice" => {"id" => "1", "affiliate_id" => "2", "datetime" => "2009-06-02 20:14:05", "start_date" => "2009-06-01", "end_date" => "2009-06-02", "is_paid" => "1", "memo" => "asdf", "status" => "active", "notes" => "", "receipt_id" => nil, "currency" => "USD", "amount" => "12.00", "conversions" => "12" }}}, "errors" => []}}
+      end
+
       def response_for_report_getstats(params)
         {"response"=>{"data"=>{"pageCount"=>1, "data"=>[{"Stat"=>{"affiliate_id"=>"1", "clicks"=>"20645"}}], "current"=>50, "count"=>1, "page"=>1}, "errors"=>[], "status"=>1}}
       end

data/test/affiliate_billing_test.rb

@@ -22,6 +22,13 @@ class AffiliateBillingTest < Test::Unit::TestCase
     assert response.data.length > 0, "No invoices were returned."
   end
 
+  def test_find_all_invoices_by_ids
+    response = HasOffers::AffiliateBilling.find_all_invoices_by_ids([7,11]
+    )
+    assert_success response
+    assert response.data.length > 0, "No invoices were returned."
+  end
+
   def good_params
     {'affiliate_id' => '1',
      'start_date' => '2010-01-01',

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hasoffers
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Luke Ludwig
@@ -9,35 +15,41 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-13 00:00:00 -05:00
+date: 2010-07-20 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: yajl-ruby
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
-    - - "="
-      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 7
+        - 6
         version: 0.7.6
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: crack
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
-    - - "="
-      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 1
+        - 6
         version: 0.1.6
-    version: 
+  type: :runtime
+  version_requirements: *id002
 description: Implementation of the HasOffers API for affiliate advertising.
 email: luke.ludwig@tstmedia.com
 executables: []
@@ -98,21 +110,28 @@ 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"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
       version: "1.2"
-  version: 
 requirements: []
 
 rubyforge_project: hasoffers
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Implementation of the HasOffers API for affiliate advertising.