one40_proof 0.0.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 reddavis
+
+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,58 @@
+= 140Proof API Wrapper
+
+A Ruby wrapper around  the 140Proof API. Documentation can be found here - http://developers.140proof.com/docs
+
+It currently only supports JSON.
+
+== Install
+
+  gem sources -a http://gemcutter.org
+  sudo gem install one40_proof
+  
+== How To Use
+
+Testing ad placement while in development
+
+  require 'rubygems'
+  require 'one40_proof'
+  
+  ad = One40Proof::Test.new
+  
+  # The Ad
+  ad.image_url
+  ad.byline
+  ad.text
+  
+  # User
+  ad.user.screen_name
+  ad.user.user_id
+  ad.user.profile_image_url
+  ad.user.name
+  
+  # Action URLS
+  ad.action_urls.click_url
+  ad.action_urls.favorite_url   # Or ad.action_urls.favourite_url for the English
+  ad.action_urls.impression_url
+  ad.action_urls.friendship_url
+  ad.action_urls.reply_url
+  ad.action_urls.retweet_url
+  
+  
+To get an ad for a specific user
+
+  require 'rubygems'
+  require 'one40_proof'
+  
+  ad = One40Proof::UserAd.new(:user_id => 'reddavis', :publisher_id => 'your publisher id')
+  
+  
+To get an ad for a specific query
+
+  require 'rubygems'
+  require 'one40_proof'
+  
+  ad = One40Proof::Search.new(:user_id => 'reddavis', :publisher_id => 'your publisher id', :q => 'magic hats')
+  
+== Copyright
+
+Copyright (c) 2010 Red Davis. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "one40_proof"
+    gem.summary = %Q{A Ruby wrapper around  the 140Proof API}
+    gem.description = %Q{A Ruby wrapper around  the 140Proof API. Documentation can be found here - http://developers.140proof.com/docs/}
+    gem.email = "reddavis@gmail.com"
+    gem.homepage = "http://github.com/reddavis/One40Proof"
+    gem.authors = ["reddavis"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "json"
+    gem.add_dependency "httparty"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "One40Proof #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/one40_proof.rb

@@ -0,0 +1,5 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'one40_proof/test'
+require 'one40_proof/user_ad'
+require 'one40_proof/search'

data/lib/one40_proof/attributes/action_urls.rb

@@ -0,0 +1,34 @@
+module One40Proof
+  class ActionUrls
+    
+    def initialize(data)
+      @data = data['ads'][0]['action_urls']
+    end
+    
+    def click_url
+      @data['click_url']
+    end
+    
+    def favorite_url
+      @data['favorite_url']
+    end
+    alias_method :favourite_url, :favorite_url  # For the English ;)
+    
+    def impression_url
+      @data['impression_url']
+    end
+    
+    def friendship_url
+      @data['friendship_url']
+    end
+    
+    def reply_url
+      @data['reply_url']
+    end
+    
+    def retweet_url
+      @data['retweet_url']
+    end
+    
+  end
+end

data/lib/one40_proof/attributes/user.rb

@@ -0,0 +1,25 @@
+module One40Proof
+  class User
+    
+    def initialize(data)
+      @data = data['ads'][0]['user']
+    end
+    
+    def profile_image_url
+      @data['profile_image_url']
+    end
+    
+    def name
+      @data['name']
+    end
+    
+    def user_id
+      @data['id']
+    end
+    
+    def screen_name
+      @data['screen_name']
+    end
+    
+  end
+end

data/lib/one40_proof/base.rb

@@ -0,0 +1,53 @@
+require 'httparty'
+require 'json'
+require 'one40_proof/attributes/action_urls'
+require 'one40_proof/attributes/user'
+require 'one40_proof/exceptions'
+
+module One40Proof
+  class Base
+    include HTTParty
+    format :json
+    base_uri "http://api.140proof.com"
+    
+    def initialize(url, options={})
+      validate_response(Base.get(url, options))
+    end
+    
+    def action_urls
+      @action_urls ||= ActionUrls.new(json)
+    end
+        
+    def user
+      @user ||= User.new(json)
+    end
+    
+    def image_url
+      json['ads'][0]['image_url']
+    end
+    
+    # e.g "ads by Pizza Hut"
+    def byline
+      json['ads'][0]['byline']
+    end
+    
+    # Ad text
+    def text
+      json['ads'][0]['text']
+    end
+    
+    private
+            
+    def json
+      @json ||= JSON.parse(@response.body)
+    end
+    
+    def validate_response(response)
+      if response.code == 404
+        raise NotFound.new("Either user/publisher/targetted ad cannot be found")
+      else
+        @response = response
+      end
+    end
+  end
+end

data/lib/one40_proof/exceptions.rb

@@ -0,0 +1,8 @@
+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

data/lib/one40_proof/search.rb

@@ -0,0 +1,24 @@
+require 'one40_proof/base'
+
+# Returns an ad for a specified user. 
+# Returns an HTTP 404 error if the user does not exist, if the publisher does not exist, or if a targetted ad could not be found for the user.
+
+module One40Proof
+  class Search < Base    
+    
+    # Options:
+    # * user_id. Required. The Twitter ID or screen name of a user.
+    # * publisher_id. Required. Your 140 Proof app id.
+    # * q. Required. The query the user entered. Query strings should be URL encoded. Queries are limited 140 URL encoded characters.
+    # * lat. Optional. The user's current latitude. Note: The valid ranges for latitude is -90.0 to +90.0 (North is positive) inclusive. 
+    #   This parameter will be ignored if outside that range, if it is not a number, or if there not a corresponding long parameter with this request.
+    # * long. Optional. The user's current longitude. Note: 
+    #   The valid ranges for longitude is -180.0 to +180.0 (East is positive) inclusive. 
+    #   This parameter will be ignored if outside that range, if it is not a number, or if there not a corresponding lat parameter with this request.
+    # * lang. Optional. Restricts ads to the given language, specified by an ISO 639-1 code - http://en.wikipedia.org/wiki/ISO_639-1
+    def initialize(options={})
+      super('/ads/search.json', {:query => options})
+    end
+        
+  end
+end

data/lib/one40_proof/test.rb

@@ -0,0 +1,13 @@
+require 'one40_proof/base'
+
+# Returns an ad. Use for testing and verifying your ad-serving code while in development.
+
+module One40Proof
+  class Test < Base    
+    
+    def initialize
+      super('/test/ads.json')
+    end
+        
+  end
+end

data/lib/one40_proof/user_ad.rb

@@ -0,0 +1,24 @@
+require 'one40_proof/base'
+
+# Returns an ad for a specified user. 
+# Returns an HTTP 404 error if the user does not exist, if the publisher does not exist, or if a targetted ad could not be found for the user.
+
+module One40Proof
+  class UserAd < Base    
+    
+    # Options include
+    # * user_id. Required. The Twitter ID or screen name of a user.
+    # * publisher_id. Required. Your 140 Proof app id.
+    # * lat. Optional. The user's current latitude. Note: 
+    #   The valid ranges for latitude is -90.0 to +90.0 (North is positive) inclusive. 
+    #   This parameter will be ignored if outside that range, if it is not a number, or if there not a corresponding long parameter with this request.
+    # * long. Optional. The user's current longitude. Note: 
+    #   The valid ranges for longitude is -180.0 to +180.0 (East is positive) inclusive. 
+    #   This parameter will be ignored if outside that range, if it is not a number, or if there not a corresponding lat parameter with this request.
+    # * lang. Optional. Restricts ads to the given language, specified by an ISO 639-1 code - http://en.wikipedia.org/wiki/ISO_639-1
+    def initialize(options={})
+      super('/ads/user.json', {:query => options})
+    end
+        
+  end
+end

data/spec/one40_proof/attributes/action_urls_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "ActionUrls" do
+  before(:all) do
+    parsed_json = JSON.parse(test_ad_data)
+    @action_urls = One40Proof::ActionUrls.new(parsed_json)
+  end
+  
+  it "should return the click_url" do
+    @action_urls.click_url.should == "http://api.140proof.com/clicks/create.json?ad_id=1&impression_id=1&publisher_id=test&user_id=7"
+  end
+  
+  it "should return favorite_url" do
+    @action_urls.favorite_url.should == "http://api.140proof.com/favorites/create.json?ad_id=1&impression_id=1&publisher_id=test&user_id=7"
+  end
+  
+  it "should return impression_url" do
+    @action_urls.impression_url.should == "http://api.140proof.com/impressions/verify.json?ad_id=1&impression_id=1&publisher_id=test&user_id=7"
+  end
+  
+  it "should return friendship_url" do
+    @action_urls.friendship_url.should == "http://api.140proof.com/friendships/create.json?ad_id=1&impression_id=1&publisher_id=test&user_id=7"
+  end
+  
+  it "should return reply url" do
+    @action_urls.reply_url.should == "http://api.140proof.com/replies/create.json?ad_id=1&impression_id=1&publisher_id=test&user_id=7"
+  end
+  
+  it "should return retweet_url" do
+    @action_urls.retweet_url.should == "http://api.140proof.com/retweets/create.json?ad_id=1&impression_id=1&publisher_id=test&user_id=7"
+  end
+end

data/spec/one40_proof/attributes/user_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "User" do
+  before(:all) do
+    parsed_json = JSON.parse(test_ad_data)
+    @user = One40Proof::User.new(parsed_json)
+  end
+  
+  it "should return profile_image_url" do
+    @user.profile_image_url.should == "http://img.tweetimag.es/i/Mets_n"
+  end
+  
+  it "should return name" do
+    @user.name.should == "New York Mets"
+  end
+  
+  it "should return user_id" do
+    @user.user_id.should == 39367703
+  end
+  
+  it "should return screen_name" do
+    @user.screen_name.should == "Mets"
+  end
+end

data/spec/one40_proof/base_spec.rb

@@ -0,0 +1,42 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Base" do
+  
+  describe "200 OK" do
+    before(:all) do
+      stub_request(:get, base_url).to_return(:body => user_ad_data)
+      @base = One40Proof::Base.new(base_url)
+    end
+
+    it "should return an ActionUrls object" do
+      @base.action_urls.should be_a(One40Proof::ActionUrls)
+    end
+
+    it "should return a User object" do
+      @base.user.should be_a(One40Proof::User)
+    end
+
+    it "should return image_url" do
+      @base.image_url.should == "http://img.tweetimag.es/i/LittleSkillet_n"
+    end    
+    
+    it "should return byline" do
+      @base.byline.should == 'ads by 140 Proof'
+    end
+    
+    it "should return text" do
+      @base.text.should == "Serving up farm-fresh soul food and San Francisco's finest chicken and waffles. Follow @LittleSkillet for today's specials."
+    end
+  end
+  
+  describe "404" do
+    it "should raise a NotFound" do
+      stub_request(:get, base_url).to_return(:status => 404)
+      
+      lambda do  
+        @base = One40Proof::Base.new(base_url)
+      end.should raise_error(One40Proof::NotFound)
+    end
+  end
+
+end

data/spec/one40_proof/search_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Search" do
+  it "should request GET /ads/search.json..." do
+    url = base_url + '/ads/search.json?user_id=sferik&publisher_id=test&q=New%20York%20Mets'
+    stub_request(:get, url)
+    One40Proof::Search.new(:user_id => 'sferik', :publisher_id => 'test', :q => 'New York Mets')
+  
+    WebMock.should have_requested(:get, url)
+  end
+end

data/spec/one40_proof/test_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Test" do
+  describe "Connection to the service" do
+    it "should request GET /test/ads.json" do
+      url = base_url + '/test/ads.json'
+      stub_request(:get, url)
+      One40Proof::Test.new
+    
+      WebMock.should have_requested(:get, url)
+    end
+  end
+end

data/spec/one40_proof/user_ad_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "UserAd" do
+  it "should request GET /ads/user.json..." do
+    url = base_url + '/ads/user.json?user_id=sferik&publisher_id=test'
+    stub_request(:get, url)
+    One40Proof::UserAd.new(:user_id => 'sferik', :publisher_id => 'test')
+  
+    WebMock.should have_requested(:get, url)
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'one40_proof'
+require 'spec'
+require 'spec/autorun'
+require 'webmock/rspec'
+
+include WebMock
+
+def base_url
+  "http://api.140proof.com"
+end
+
+# From http://api.140proof.com/test/ads.json
+def test_ad_data
+  %{{"ads":[{"status":{"id":6017128450},"byline":"ads by 140 Proof","text":"NEW #Mets 2010 Alternate Jersey can be ordered here --> http://bit.ly/8P6xYm","action_urls":{"click_url":"http://api.140proof.com/clicks/create.json?ad_id=1&impression_id=1&publisher_id=test&user_id=7","favorite_url":"http://api.140proof.com/favorites/create.json?ad_id=1&impression_id=1&publisher_id=test&user_id=7","impression_url":"http://api.140proof.com/impressions/verify.json?ad_id=1&impression_id=1&publisher_id=test&user_id=7","friendship_url":"http://api.140proof.com/friendships/create.json?ad_id=1&impression_id=1&publisher_id=test&user_id=7","reply_url":"http://api.140proof.com/replies/create.json?ad_id=1&impression_id=1&publisher_id=test&user_id=7","retweet_url":"http://api.140proof.com/retweets/create.json?ad_id=1&impression_id=1&publisher_id=test&user_id=7"},"user":{"profile_image_url":"http://img.tweetimag.es/i/Mets_n","name":"New York Mets","id":39367703,"screen_name":"Mets"},"image_url":"http://img.tweetimag.es/i/mets_b"}]}}
+end
+
+# From http://api.140proof.com/ads/user.json?user_id=sferik&publisher_id=test
+def user_ad_data
+  %{{"ads":[{"status":{"id":null},"byline":"ads by 140 Proof","text":"Serving up farm-fresh soul food and San Francisco's finest chicken and waffles. Follow @LittleSkillet for today's specials.","action_urls":{"click_url":"http://api.140proof.com/clicks/create.json?ad_id=295&impression_id=7933117&publisher_id=test&user_id=7505382","favorite_url":null,"impression_url":"http://api.140proof.com/impressions/verify.json?ad_id=295&impression_id=7933117&publisher_id=test&user_id=7505382","friendship_url":"http://api.140proof.com/friendships/create.json?ad_id=295&impression_id=7933117&publisher_id=test&user_id=7505382","reply_url":"http://api.140proof.com/replies/create.json?ad_id=295&impression_id=7933117&publisher_id=test&user_id=7505382","retweet_url":null},"user":{"profile_image_url":"http://img.tweetimag.es/i/LittleSkillet_n","name":"Little Skillet","id":27710301,"screen_name":"LittleSkillet"},"image_url":"http://img.tweetimag.es/i/LittleSkillet_n"}]}}
+end
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: one40_proof
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- reddavis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-17 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A Ruby wrapper around  the 140Proof API. Documentation can be found here - http://developers.140proof.com/docs/
+email: reddavis@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/one40_proof.rb
+- lib/one40_proof/attributes/action_urls.rb
+- lib/one40_proof/attributes/user.rb
+- lib/one40_proof/base.rb
+- lib/one40_proof/exceptions.rb
+- lib/one40_proof/search.rb
+- lib/one40_proof/test.rb
+- lib/one40_proof/user_ad.rb
+- spec/one40_proof/attributes/action_urls_spec.rb
+- spec/one40_proof/attributes/user_spec.rb
+- spec/one40_proof/base_spec.rb
+- spec/one40_proof/search_spec.rb
+- spec/one40_proof/test_spec.rb
+- spec/one40_proof/user_ad_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/reddavis/One40Proof
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Ruby wrapper around  the 140Proof API
+test_files: 
+- spec/one40_proof/attributes/action_urls_spec.rb
+- spec/one40_proof/attributes/user_spec.rb
+- spec/one40_proof/base_spec.rb
+- spec/one40_proof/search_spec.rb
+- spec/one40_proof/test_spec.rb
+- spec/one40_proof/user_ad_spec.rb
+- spec/spec_helper.rb