fanfeedr 0.1.0 → 0.2.0

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in fanfeedr_new.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    fanfeedr (0.2.0)
+      hashie
+      httparty
+      json
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.6)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    hashie (1.2.0)
+    httparty (0.8.1)
+      multi_json
+      multi_xml
+    json (1.6.5)
+    multi_json (1.0.4)
+    multi_xml (0.4.1)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    vcr (1.11.3)
+    webmock (1.7.10)
+      addressable (~> 2.2, > 2.2.5)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fanfeedr!
+  rspec
+  vcr
+  webmock

data/README.md

@@ -4,38 +4,38 @@ This is a Ruby wrapper for the [Fanfeedr API](http://developer.fanfeedr.com/).
 
 ## Installation
 
-In your Rails directory:
+As a gem:
 
-    script/plugin install git://github.com/phuphighter/fanfeedr.git
+    sudo gem install fanfeedr
+
+In a gemfile:
+
+    gem 'fanfeedr'
     
 ## Get a Fanfeedr API key
 
-Sign up for a Fanfeedr API key: [http://developer.fanfeedr.com/member/register](http://developer.fanfeedr.com/member/register)
+Sign up for a Fanfeedr API key: [http://developer.fanfeedr.com/page/API_Plans_and_Pricing](http://developer.fanfeedr.com/page/API_Plans_and_Pricing)
     
 ## Usage
 
 ### Instantiate a client
 
-    >> fanfeedr = Fanfeedr::Client.new(:api_key => 'your_api_key', :api_type => 'your_api_type')
-    
-### or configure once
-
-    >> Fanfeedr.configure do |config|
-    >>   config.api_key = 'your_api_key'
-    >>   config.api_type = 'your_api_type'
-    >> end
-    >> fanfeedr = Fanfeedr::Client.new
+    >> @client = Fanfeedr::Client.new(:api_key => 'your_api_key', :tier => 'your_tier')
     
 #### Examples
-
-    >> fanfeedr.scores(:resource => "team://mlb/texas_rangers", :rows => '2')
-    => [{"defaultdict(<type 'str'>, {'eventlink': u'event://mlb/2010/05/15/games/texas_rangers_toronto_blue_jays', 'winteamlocationshort': u'Toronto', 'loseteamlogo': u'/img/teams/small/texas_rangers_25.png', 'is_college': u'False', 'loseteamlocation': u'Texas', 'winteamname': u'Blue Jays', 'loseteamfullname': u'Rangers', 'sport': u'Baseball', 'winscore': u'6', 'league': u'league://mlb', 'losescore': u'0', 'loseteamlink': u'team://mlb/texas_rangers', 'loseteamlocationshort': u'Texas', 'season_type': u'None', 'winteamfullname': u'Blue Jays', 'winteamlink': u'team://mlb/toronto_blue_jays', 'season_year': u'None', 'winteamlogo': u'/img/teams/small/toronto_blue_jays_25.png', 'winteamhomeaway': u'A', 'winteamlocation': u'Toronto', 'loseteamname': u'Rangers'})"=>[nil]}]
     
-    >> fanfeedr.schedule(:resource => "team://nba/boston_celtics")
-    => [{"name"=>"Boston Celtics @ Orlando Magic", "time"=>"20:30:00", "date"=>Sun, 30 May 2010, "away"=>{"winlose"=>nil, "team"=>"team://nba/boston_celtics", "score"=>nil}, "status"=>nil, "home"=>{"winlose"=>nil, "team"=>"team://nba/orlando_magic", "score"=>nil}, "resource_text"=>"event://nba/2010/05/30/games/boston_celtics_orlando_magic"}]
+    >> @leagues = @client.leagues(:id => "20f0857f-3c43-5f50-acfc-879f838ee853")
+    >> @leagues.size
+    => 45
+
+    >> @client.leagues(:id => "20f0857f-3c43-5f50-acfc-879f838ee853")
+    => {"sport"=>"Baseball", "name"=>"MLB", "gender"=>"M", "id"=>"20f0857f-3c43-5f50-acfc-879f838ee853", "levels"=>["professional"]}
 
+    >> @client.conferences(:id => "384fbe7c-7694-51e8-bf0a-7d0d63ba9211", :parent_resource => "leagues", :resource_id => "20f0857f-3c43-5f50-acfc-879f838ee853")
+    => {"id"=>"384fbe7c-7694-51e8-bf0a-7d0d63ba9211", "level"=>"professional", "name"=>"National League"}
+    
 ## Copyright
 
 Contact me if you have any suggestions and feel free to fork it!
 
-Copyright (c) 2009 Johnny Khai Nguyen, released under the MIT license
+Copyright (c) 2012 Johnny Khai Nguyen, released under the MIT license

data/Rakefile

@@ -1,41 +1,6 @@
-require 'rubygems'
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "fanfeedr"
-    gem.summary = %Q{Ruby wrapper for the Fanfeedr API}
-    gem.description = %Q{Ruby wrapper for the Fanfeedr API}
-    gem.email = "johnnyn@gmail.com"
-    gem.homepage = "http://github.com/phuphighter/fanfeedr"
-    gem.authors = ["Johnny Khai Nguyen"]
-    
-    gem.add_dependency('httparty', '>= 0.5.0')
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
+RSpec::Core::RakeTask.new('spec')
 
-desc 'Default: run unit tests.'
-task :default => :test
-
-desc 'Test the fanfeedr plugin.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-end
-
-desc 'Generate documentation for the fanfeedr plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Fanfeedr'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+task :default => :spec

data/fanfeedr.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "fanfeedr/version"
+
+Gem::Specification.new do |s|
+  s.name        = "fanfeedr"
+  s.version     = Fanfeedr::VERSION
+  s.authors     = ["Johnny Khai Nguyen"]
+  s.email       = ["johnnyn@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Ruby wrapper for the Fanfeedr API}
+  s.description = %q{Use this to access the Fanfeedr API in your Ruby application}
+
+  s.rubyforge_project = "fanfeedr_new"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'httparty'
+  s.add_dependency 'hashie'  
+  s.add_dependency 'json'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'vcr'
+end

data/lib/fanfeedr.rb

@@ -31,7 +31,7 @@ module Fanfeedr
 
   class << self
     attr_accessor :api_key
-    attr_accessor :api_type
+    attr_accessor :tier
   end
   
 end

data/lib/fanfeedr/client.rb

@@ -2,80 +2,149 @@ module Fanfeedr
   
   class Client
     include HTTParty
-    base_uri "http://api.fanfeedr.com"
+    base_uri "http://ffapi.fanfeedr.com"
     
     attr_reader :api_key
-    attr_reader :api_type
+    attr_reader :tier
                 
     def initialize(options={})
       @api_key = options[:api_key] || Fanfeedr.api_key
-      @api_type = options[:api_type] || Fanfeedr.api_type
+      @tier = options[:tier] || Fanfeedr.tier
     end
 
-    def geo_feed(options={})
-      response = self.class.get("/#{@api_type}/geo_feed", :query => options.merge(self.default_xml_options), :format => :xml)["response"]["result"]["doc"]
+    def leagues(options={})  
+      id = options.delete(:id)
+          
+      if id
+        response = self.class.get("/#{@tier}/api/leagues/#{id}", :query => options.merge(self.default_options), :format => :json)
+      else
+        response = self.class.get("/#{@tier}/api/leagues", :query => options.merge(self.default_options), :format => :json)
+      end
     end
-
-    def schedule(options={})
-      response = self.class.get("/#{@api_type}/schedule", :query => options.merge(self.default_json_options), :format => :json)
+    
+    def conferences(options={})
+      id = options.delete(:id)
+      parent_resource = options.delete(:parent_resource)
+      resource_id = options.delete(:resource_id)
+      
+      if id
+        response = self.class.get("/#{@tier}/api/#{parent_resource}/#{resource_id}/conferences/#{id}", :query => options.merge(self.default_options), :format => :json)
+      else
+        response = self.class.get("/#{@tier}/api/#{parent_resource}/#{resource_id}/conferences", :query => options.merge(self.default_options), :format => :json)
+      end
     end
     
-    def suggest(options={})
-      response = self.class.get("/#{@api_type}/suggest", :query => options.merge(self.default_json_options), :format => :json)
+    def divisions(options={})
+      id = options.delete(:id)      
+      parent_resource = options.delete(:parent_resource)
+      resource_id = options.delete(:resource_id)
+      
+      if id
+        response = self.class.get("/#{@tier}/api/#{parent_resource}/#{resource_id}/divisions/#{id}", :query => options.merge(self.default_options), :format => :json)
+      else
+        response = self.class.get("/#{@tier}/api/#{parent_resource}/#{resource_id}/divisions", :query => options.merge(self.default_options), :format => :json)
+      end
     end
     
-    def search(options={})
-      response = self.class.get("/#{@api_type}/search", :query => options.merge(self.default_json_options), :format => :json)
+    def teams(options={}, secondary=nil)
+      id = options.delete(:id)
+      parent_resource = options.delete(:parent_resource)
+      resource_id = options.delete(:resource_id)
+      
+      if id && secondary.nil?
+        response = self.class.get("/#{@tier}/api/#{parent_resource}/#{resource_id}/teams/#{id}", :query => options.merge(self.default_options), :format => :json)
+      elsif id && !secondary.nil?
+        response = self.class.get("/#{@tier}/api/#{parent_resource}/#{resource_id}/teams/#{id}/#{secondary}", :query => options.merge(self.default_options), :format => :json)  
+      else
+        response = self.class.get("/#{@tier}/api/#{parent_resource}/#{resource_id}/teams", :query => options.merge(self.default_options), :format => :json)
+      end
     end
     
-    def all_scores(options={})
-      response = []
-      results = self.class.get("/#{@api_type}/all_scores", :query => options.merge(self.default_xml_options), :format => :xml)["response"]["result"]["doc"]
+    def persons(options={})
+      id = options.delete(:id)
+      parent_resource = options.delete(:parent_resource)
+      resource_id = options.delete(:resource_id)
       
-      results.each do |r|
-        score_details = CGI::parse(r['str'][0])
-        response << score_details
+      if id
+        response = self.class.get("/#{@tier}/api/#{parent_resource}/#{resource_id}/persons/#{id}", :query => options.merge(self.default_options), :format => :json)
+      else
+        response = self.class.get("/#{@tier}/api/#{parent_resource}/#{resource_id}/persons", :query => options.merge(self.default_options), :format => :json)
       end
-
-      response
     end
-
-    def scores(options={})
-      response = []
-      results = self.class.get("/#{@api_type}/scores", :query => options.merge(self.default_xml_options), :format => :xml)["response"]["result"]["doc"]
+    
+    def geo(options={}, secondary=nil)
+      id = options.delete(:id)
       
-      results.each do |r|
-        score_details = CGI::parse(r['str'][0])
-        response << score_details
+      if id && secondary.nil?
+        response = self.class.get("/#{@tier}/api/geo/#{id}", :query => options.merge(self.default_options), :format => :json)
+      elsif id && !secondary.nil?
+        response = self.class.get("/#{@tier}/api/geo/#{id}/#{secondary}", :query => options.merge(self.default_options), :format => :json)  
+      else
+        response = self.class.get("/#{@tier}/api/geo", :query => options.merge(self.default_options), :format => :json)
       end
-
-      response
     end
-
-    def resource_feed(options={})
-      response = self.class.get("/#{@api_type}/resource_feed", :query => options.merge(self.default_json_options), :format => :json)["docs"]
+    
+    def events(options={}, secondary=nil)
+      id = options.delete(:id)
+      parent_resource = options.delete(:parent_resource)
+      resource_id = options.delete(:resource_id)
+      season_type = options.delete(:season_type) || nil      
+      
+      if id && secondary.nil?
+        response = self.class.get("/#{@tier}/api/#{parent_resource}/#{resource_id}/events/#{id}", :query => options.merge(self.default_options), :format => :json)
+      elsif id && !secondary.nil?
+        response = self.class.get("/#{@tier}/api/#{parent_resource}/#{resource_id}/events/#{id}/#{secondary}", :query => options.merge(self.default_options), :format => :json)  
+      elsif id.nil? && !secondary.nil?
+        response = self.class.get("/#{@tier}/api/#{parent_resource}/#{resource_id}/events/#{secondary}", :query => options.merge(self.default_options), :format => :json)        
+      elsif id.nil? && secondary.nil? && options[:season_type]
+        response = self.class.get("/#{@tier}/api/#{parent_resource}/#{resource_id}/events/#{season_type}", :query => options.merge(self.default_options), :format => :json)        
+      else
+        response = self.class.get("/#{@tier}/api/#{parent_resource}/#{resource_id}/events", :query => options.merge(self.default_options), :format => :json)
+      end
     end
-
-    def get_article(options={})
-      response = self.class.get("/#{@api_type}/get_article", :query => options.merge(self.default_xml_options))      
+    
+    def content(options={}, secondary=nil)
+      id = options.delete(:id)
+      parent_resource = options.delete(:parent_resource)
+      resource_id = options.delete(:resource_id)
+      content_filter = options.delete(:filter) || nil
+      
+      if id && secondary.nil?
+        response = self.class.get("/#{@tier}/api/#{parent_resource}/#{resource_id}/content/#{id}", :query => options.merge(self.default_options), :format => :json)
+      elsif id && !secondary.nil?
+        response = self.class.get("/#{@tier}/api/#{parent_resource}/#{resource_id}}/content/#{id}/#{secondary}", :query => options.merge(self.default_options), :format => :json)  
+      elsif id.nil? && secondary.nil? && !content_filter.nil?
+        response = self.class.get("/#{@tier}/api/#{parent_resource}/#{resource_id}/content/#{filter}", :query => options.merge(self.default_options), :format => :json)        
+      else
+        response = self.class.get("/#{@tier}/api/#{parent_resource}/#{resource_id}/content", :query => options.merge(self.default_options), :format => :json)
+      end
     end
-
-    def recap(options={})
-      response = self.class.get("/#{@api_type}/recap", :query => options.merge(self.default_xml_options))      
+    
+    def sources(options={})
+      id = options.delete(:id)
+      parent_resource = options.delete(:parent_resource)
+      resource_id = options.delete(:resource_id)
+      
+      if id
+        response = self.class.get("/#{@tier}/api/#{parent_resource}/#{resource_id}/sources/#{id}", :query => options.merge(self.default_options), :format => :json)
+      else
+        response = self.class.get("/#{@tier}/api/#{parent_resource}/#{resource_id}/sources", :query => options.merge(self.default_options), :format => :json)
+      end
     end
-
-    def boxscore(options={})
-      response = self.class.get("/#{@api_type}/boxscore", :query => options.merge(self.default_json_options), :format => :json)      
+    
+    def trending(options={}, secondary=nil)
+      parent_resource = options.delete(:parent_resource)
+      resource_id = options.delete(:resource_id)
+      
+      if !secondary.nil?
+        response = self.class.get("/#{@tier}/api/#{parent_resource}/#{resource_id}/#{secondary}", :query => options.merge(self.default_options), :format => :json)
+      end
     end
     
     protected
     
-    def default_json_options
-      {:appid => @api_key, :format => :json}
-    end
-    
-    def default_xml_options
-      {:appid => @api_key}
+    def default_options
+      {:api_key => @api_key}
     end
     
   end

data/lib/fanfeedr/version.rb

@@ -0,0 +1,3 @@
+module Fanfeedr
+  VERSION = "0.2.0"
+end

data/spec/fanfeedr/client_spec.rb

@@ -0,0 +1,172 @@
+require 'spec_helper'
+
+describe Fanfeedr::Client do
+  
+  context 'requesting leagues' do
+    use_vcr_cassette 'leagues'
+
+    it 'should initialize with an api_key' do
+      @client = Fanfeedr::Client.new(:api_key => "foobar", :tier => "basic")
+      @client.api_key.should == "foobar"
+    end
+
+    it 'should return all leagues' do    
+      @client = Fanfeedr::Client.new(:api_key => "foobar", :tier => "basic")
+      @leagues = @client.leagues
+      @leagues.size.should == 45
+    end
+    
+    it 'should return one league' do    
+      @client = Fanfeedr::Client.new(:api_key => "foobar", :tier => "basic")
+      @league = @client.leagues(:id => "20f0857f-3c43-5f50-acfc-879f838ee853")
+      @league.should == {"sport"=>"Baseball", "name"=>"MLB", "gender"=>"M", "id"=>"20f0857f-3c43-5f50-acfc-879f838ee853", "levels"=>["professional"]}
+    end
+  end
+  
+  context "requesting conferences" do
+    use_vcr_cassette 'conferences'
+    
+    before do
+      @client = Fanfeedr::Client.new(:api_key => "foobar", :tier => "basic")
+    end
+    
+    it 'should return all conferences' do    
+      @conferences = @client.conferences(:parent_resource => "leagues", :resource_id => "20f0857f-3c43-5f50-acfc-879f838ee853")
+      @conferences.size.should == 2
+    end
+    
+    it 'should return one conference' do    
+      @conference = @client.conferences(:id => "384fbe7c-7694-51e8-bf0a-7d0d63ba9211", :parent_resource => "leagues", :resource_id => "20f0857f-3c43-5f50-acfc-879f838ee853")
+      @conference.should == {"id"=>"384fbe7c-7694-51e8-bf0a-7d0d63ba9211", "level"=>"professional", "name"=>"National League"}
+    end
+  end
+  
+  context "requesting divisions" do
+    use_vcr_cassette 'divisions'
+    
+    before do
+      @client = Fanfeedr::Client.new(:api_key => "foobar", :tier => "basic")
+    end
+    
+    it 'should return all divisions' do    
+      @divisions = @client.divisions(:parent_resource => "leagues", :resource_id => "20f0857f-3c43-5f50-acfc-879f838ee853")
+      @divisions.size.should == 6
+    end
+  end
+  
+  context "requesting teams" do
+    use_vcr_cassette 'teams'
+    
+    before do
+      @client = Fanfeedr::Client.new(:api_key => "foobar", :tier => "basic")
+    end
+    
+    it 'should return all teams' do    
+      @teams = @client.teams(:parent_resource => "leagues", :resource_id => "20f0857f-3c43-5f50-acfc-879f838ee853")
+      @teams.size.should == 30
+    end
+  end
+  
+  context "requesting persons" do
+    use_vcr_cassette 'persons'
+    
+    before do
+      @client = Fanfeedr::Client.new(:api_key => "foobar", :tier => "basic")
+    end
+    
+    it 'should return all persons' do    
+      @persons = @client.persons(:parent_resource => "leagues", :resource_id => "20f0857f-3c43-5f50-acfc-879f838ee853")
+      @persons.should_not be_nil
+    end
+  end
+  
+  context 'geo' do
+    use_vcr_cassette 'geo'
+    
+    before do
+      @client = Fanfeedr::Client.new(:api_key => "foobar", :tier => "basic")
+    end
+
+    it 'should return all geo with query' do    
+      @geo = @client.geo(:q => "dallas")
+      @geo.should_not be_nil
+    end
+  end
+  
+  context "requesting events" do
+    use_vcr_cassette 'events'
+    
+    before do
+      @client = Fanfeedr::Client.new(:api_key => "foobar", :tier => "basic")
+    end
+    
+    it 'should return all events' do    
+      @events = @client.events(:parent_resource => "leagues", :resource_id => "20f0857f-3c43-5f50-acfc-879f838ee853")
+      @events.size.should == 2
+    end
+      
+    it 'should return all events for today' do    
+      @events = @client.events({:parent_resource => "leagues", :resource_id => "20f0857f-3c43-5f50-acfc-879f838ee853"}, "today")
+      @events.should_not be_nil
+    end
+    
+    it 'should return all events for next two weeks' do    
+      @events = @client.events({:parent_resource => "leagues", :resource_id => "20f0857f-3c43-5f50-acfc-879f838ee853"}, "next")
+      @events.should_not be_nil
+    end
+    
+    it 'should return all events for last two weeks' do    
+      @events = @client.events({:parent_resource => "leagues", :resource_id => "20f0857f-3c43-5f50-acfc-879f838ee853"}, "last")
+      @events.should_not be_nil
+    end
+    
+    it 'should return all events for season_type' do    
+      @events = @client.events(:parent_resource => "leagues", :resource_id => "20f0857f-3c43-5f50-acfc-879f838ee853", :season_type => "postseason")
+      @events.should_not be_nil
+    end
+  end
+  
+  context "requesting content" do
+    use_vcr_cassette 'content'
+    
+    before do
+      @client = Fanfeedr::Client.new(:api_key => "foobar", :tier => "basic")
+    end
+    
+    it 'should return all content' do    
+      @content = @client.content(:parent_resource => "leagues", :resource_id => "20f0857f-3c43-5f50-acfc-879f838ee853")
+      @content.should_not be_nil
+    end
+  end
+  
+  context "requesting sources" do
+    use_vcr_cassette 'sources'
+    
+    before do
+      @client = Fanfeedr::Client.new(:api_key => "foobar", :tier => "basic")
+    end
+    
+    it 'should return all sources' do    
+      @sources = @client.sources(:parent_resource => "leagues", :resource_id => "20f0857f-3c43-5f50-acfc-879f838ee853")
+      @sources.should_not be_nil
+    end
+  end
+  
+  context "requesting trending" do
+    use_vcr_cassette 'trending'
+    
+    before do
+      @client = Fanfeedr::Client.new(:api_key => "foobar", :tier => "basic")
+    end
+    
+    it 'should return all trending for team' do    
+      @trending = @client.trending({:parent_resource => "leagues", :resource_id => "20f0857f-3c43-5f50-acfc-879f838ee853"}, "teams")
+      @trending.should_not be_nil
+    end
+    
+    it 'should return all trending for persons' do    
+      @trending = @client.trending({:parent_resource => "leagues", :resource_id => "20f0857f-3c43-5f50-acfc-879f838ee853"}, "persons")
+      @trending.should_not be_nil
+    end
+  end
+end