one40_proof 0.0.2 → 0.0.3

data/README.rdoc

@@ -89,7 +89,22 @@ Queries are created using a hash and then placed in an array
     ad.action_urls.friendship_url
     ad.action_urls.reply_url
     ad.action_urls.retweet_url
+    
+    # Status
+    ad.status.id
   end
+  
+  # You can also specify what happens if a request fails
+  a = One40Proof::Multi::Base.new(queries, :on_fail => "Fail!")
+  
+  # It can also take anything that responds to #call
+  # e.g. One40Proof::Multi::Base.new(queries, :on_fail => Proc.new {raise "fail"})
+  
+  # If all our requests fail then:
+  a.ads
+    #=> ["Fail!", "Fail!", "Fail!"]
+    
+  # If nothing is specified on_fail then a nil object is just placed inside the array
 
 
 <b>Making Single Requests</b>
@@ -120,11 +135,13 @@ Testing ad placement while in development
   ad.action_urls.reply_url
   ad.action_urls.retweet_url
   
+  # Status
+  ad.status.id
   
 To get an ad for a specific user
 
   require 'rubygems'
-  require 'one40_proof'
+  require 'one40_proof/simple'
   
   ad = One40Proof::UserAd.new(:user_id => 'reddavis', :app_id => 'your app_id')
   
@@ -132,10 +149,14 @@ To get an ad for a specific user
 To get an ad for a specific query
 
   require 'rubygems'
-  require 'one40_proof'
+  require 'one40_proof/simple'
   
   ad = One40Proof::Search.new(:user_id => 'reddavis', :app_id => 'your app_id', :q => 'magic hats')
-  
+
+== Issues
+
+Please report any problems or feature requests here[http://github.com/reddavis/One40Proof/issues].
+
 == Copyright
 
 Copyright (c) 2010 Red Davis. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/one40_proof/exceptions.rb

@@ -0,0 +1,17 @@
+module One40Proof
+  
+  # Raised:
+  # * When a user does not exists
+  # * When a publisher does not exist
+  # * If a targetted ad cannot be found
+  class NotFound < Exception; end
+  
+  # Raised
+  # * When a user passes an API method that doesnt exist
+  class InvalidAPICall < Exception 
+    def initialize
+      super("Check your query hash. Only :search, :test and :user methods allows")
+    end
+  end
+  
+end

data/lib/one40_proof/multi/base.rb

@@ -1,11 +1,15 @@
 require 'typhoeus'
 require 'attributes/ad'
+require 'exceptions'
 
 module One40Proof
   module Multi
     class Base
-    
-      def initialize(ad_requests)
+      
+      # Takes an array of hashs that build the requests.
+      # User can also specify an :on_fail option.
+      def initialize(ad_requests, options={})
+        on_fail = options[:on_fail]
         hydra = Typhoeus::Hydra.new
             
         ad_requests.each do |ad_request|
@@ -15,7 +19,7 @@ module One40Proof
           request = Typhoeus::Request.new(url, params)
         
           request.on_complete do |response|
-            ads << Ad.new(response.body)
+            handle_response(response, on_fail)
           end
         
           hydra.queue(request)
@@ -29,6 +33,15 @@ module One40Proof
       end
         
       private
+      
+      # The Thyphoeus response class gets sent here
+      def handle_response(response, on_fail)
+        if response.code == 200
+          ads << Ad.new(response.body)
+        else
+          ads << (on_fail.respond_to?(:call) ? on_fail.call : on_fail)
+        end
+      end
     
       # I get undefined method `<=>' for :user_id:Symbol in Ruby 1.8.6
       def turn_keys_to_strings(hash)
@@ -45,6 +58,8 @@ module One40Proof
           path = '/ads/user.json'
         when :search
           path = '/ads/search.json'
+        else
+          raise InvalidAPICall.new
         end
       
         base_uri + path

data/lib/one40_proof/simple/base.rb

@@ -1,6 +1,6 @@
 require 'httparty'
 require 'attributes/ad'
-require 'simple/exceptions'
+require 'exceptions'
 
 module One40Proof
   class Base

data/one40_proof.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{one40_proof}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["reddavis"]
-  s.date = %q{2010-03-07}
+  s.date = %q{2010-03-14}
   s.description = %q{A Ruby wrapper around  the 140Proof API. Documentation can be found here - http://developers.140proof.com/docs/}
   s.email = %q{reddavis@gmail.com}
   s.extra_rdoc_files = [
@@ -28,11 +28,11 @@ Gem::Specification.new do |s|
      "lib/one40_proof/attributes/ad.rb",
      "lib/one40_proof/attributes/status.rb",
      "lib/one40_proof/attributes/user.rb",
+     "lib/one40_proof/exceptions.rb",
      "lib/one40_proof/multi.rb",
      "lib/one40_proof/multi/base.rb",
      "lib/one40_proof/simple.rb",
      "lib/one40_proof/simple/base.rb",
-     "lib/one40_proof/simple/exceptions.rb",
      "lib/one40_proof/simple/search.rb",
      "lib/one40_proof/simple/test.rb",
      "lib/one40_proof/simple/user_ad.rb",

data/spec/one40_proof/multi/base_spec.rb

@@ -1,32 +1,49 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 require 'one40_proof/multi'
+require 'one40_proof/simple/exceptions'
 
 describe "MultiBase" do
-  before(:all) do
-    hydra = Typhoeus::Hydra.new
-    test_response = Response.new(:code => 200, :body => test_ad_data)
-    user_response = Response.new(:code => 200, :body => user_ad_data)
+  describe "Requests" do
     
-    # I receive undefined method `request=' for #<WebMock::Response:0x7fc658> without these:
-    test_response.stub!(:request=)
-    user_response.stub!(:request=)
+    describe "Good Response" do
+      before do
+        http_stubbing(200)
+        @response = One40Proof::Multi::Base.new(queries)
+      end
     
-    hydra.stub(:get, "http://api.140proof.com/test/ads.json").and_return(test_response)
-    hydra.stub(:get, "http://api.140proof.com/ads/user.json?app_id=test&user_id=sferik").and_return(user_response)
-    hydra.stub(:get, "http://api.140proof.com/ads/search.json?app_id=test&q=New+York+Mets&user_id=sferik").and_return(user_response)
+      it "should return an Array of Ads" do
+        @response.ads.should be_an(Array)
+      end
+  
+      it "should create 3 ads" do
+        @response.ads.size.should == 3
+      end
+    end
+  
+    describe "Bad Response" do
+      before do
+        http_stubbing(404)
+      end
     
-    Typhoeus::Hydra.stub!(:new).and_return(hydra)
+      it "should raise an error" do
+        lambda do  
+          One40Proof::Multi::Base.new(queries, :on_fail => Proc.new {raise One40Proof::NotFound.new})
+        end.should raise_error(One40Proof::NotFound)
+      end
     
-    @a = One40Proof::Multi::Base.new(queries)
-    @a.ads.should be_an(Array)
-  end
+      it "should include 'hello' in ads array" do
+        One40Proof::Multi::Base.new(queries, :on_fail => "Hello").ads.should include('Hello')
+      end
+    end
     
-  it "should return an Array of Ads" do
-    @a.ads.should be_an(Array)
   end
   
-  it "should create 3 ads" do
-    @a.ads.size.should == 3
+  describe "Querying an invalid 140Proof method" do
+    it "should raise One40Proof::InvalidAPICall" do
+      lambda do
+        One40Proof::Multi::Base.new({:method => :error})
+      end.should raise_error(One40Proof::InvalidAPICall)
+    end
   end
   
   def queries
@@ -36,4 +53,16 @@ describe "MultiBase" do
       {:method => :search, :user_id => 'sferik', :app_id => 'test', :q => 'New York Mets'}
     ]
   end
+  
+  def http_stubbing(code, data=test_ad_data)
+    hydra = Typhoeus::Hydra.new
+    response = Response.new(:code => code, :body => data)
+    # I receive undefined method 'request=' for WebMock (0.9.1)
+    response.stub!(:request=)
+    # I receive undefined method 'code' for WebMock (0.9.1)
+    response.stub!(:code).and_return(404)
+    
+    hydra.stub(:get, /http:\/\/api.140proof.com/).and_return(response)
+    Typhoeus::Hydra.stub!(:new).and_return(hydra)
+  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - reddavis
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-07 00:00:00 +00:00
+date: 2010-03-14 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -76,11 +76,11 @@ files:
 - lib/one40_proof/attributes/ad.rb
 - lib/one40_proof/attributes/status.rb
 - lib/one40_proof/attributes/user.rb
+- lib/one40_proof/exceptions.rb
 - lib/one40_proof/multi.rb
 - lib/one40_proof/multi/base.rb
 - lib/one40_proof/simple.rb
 - lib/one40_proof/simple/base.rb
-- lib/one40_proof/simple/exceptions.rb
 - lib/one40_proof/simple/search.rb
 - lib/one40_proof/simple/test.rb
 - lib/one40_proof/simple/user_ad.rb

data/lib/one40_proof/simple/exceptions.rb

@@ -1,8 +0,0 @@
-module One40Proof
-  
-  # Raised:
-  # * When a user does not exists
-  # * When a publisher does not exist
-  # * If a targetted ad cannot be found
-  class NotFound < Exception; end
-end