mlb 0.2.6 → 0.3.0

data/.gitignore

@@ -1,14 +1,8 @@
 *.gem
-*~
-.#*
 .DS_Store
-.hg/*
-.hgignore
-.svn/*
-TAGS
-TODO
+.bundle
+.yardoc
 coverage/*
 doc/*
+log/*
 pkg/*
-src/*
-tmp/*

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/.yardopts

@@ -0,0 +1,3 @@
+--markup markdown
+-
+LICENSE.mkd

data/Gemfile

@@ -1,5 +1,3 @@
 source 'http://rubygems.org'
 
-gem "httparty", "~> 0.6"
-gem "json", "~> 1.4"
-gem "sqlite3-ruby", "~> 1.3", :require => 'sqlite3'
+gemspec

data/Gemfile.lock

@@ -1,16 +1,55 @@
+PATH
+  remote: .
+  specs:
+    mlb (0.3.0)
+      faraday (~> 0.5.2)
+      sqlite3-ruby (~> 1.3.2)
+      yajl-ruby (~> 0.7.8)
+
 GEM
   remote: http://rubygems.org/
   specs:
+    ZenTest (4.4.0)
+    addressable (2.2.2)
     crack (0.1.8)
-    httparty (0.6.1)
-      crack (= 0.1.8)
-    json (1.4.6)
-    sqlite3-ruby (1.3.1)
+    diff-lcs (1.1.2)
+    faraday (0.5.2)
+      addressable (~> 2.2.2)
+      multipart-post (~> 1.0.1)
+      rack (>= 1.1.0, < 2)
+    multipart-post (1.0.1)
+    rack (1.2.1)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    sqlite3-ruby (1.3.2)
+    webmock (1.5.0)
+      addressable (>= 2.2.2)
+      crack (>= 0.1.7)
+    yajl-ruby (0.7.8)
+    yard (0.6.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  httparty (~> 0.6)
-  json (~> 1.4)
-  sqlite3-ruby (~> 1.3)
+  ZenTest (~> 4.4)
+  bundler (~> 1.0)
+  faraday (~> 0.5.2)
+  mlb!
+  rake (~> 0.8)
+  rcov (~> 0.9)
+  rspec (~> 2.0)
+  sqlite3-ruby (~> 1.3.2)
+  webmock (~> 1.5)
+  yajl-ruby (~> 0.7.8)
+  yard (~> 0.6)

data/{LICENSE → LICENSE.mkd}

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Erik Michaels-Ober
+Copyright (c) 2010 Erik Michaels-Ober
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.mkd

@@ -0,0 +1,84 @@
+MLB.rb
+======
+MLB.rb is a Ruby library for retrieving current Major League Baseball players, managers, teams, divisions, and leagues.
+
+Installation
+------------
+    $ [sudo] gem install mlb
+
+Documentation
+-------------
+<http://rdoc.info/gems/mlb>
+
+Usage Examples
+-----
+    $ irb
+    >> require 'mlb'
+    >> MLB::Team.all.first.name                   # => "Arizona Diamondbacks"
+    >> MLB::Team.all.first.league                 # => "National League"
+    >> MLB::Team.all.first.division               # => "National League West"
+    >> MLB::Team.all.first.manager                # => "Bob Melvin"
+    >> MLB::Team.all.first.wins                   # => 82
+    >> MLB::Team.all.first.losses                 # => 80
+    >> MLB::Team.all.first.founded                # => 1998
+    >> MLB::Team.all.first.mascot                 # => nil
+    >> MLB::Team.all.first.ballpark               # => "Chase Field"
+    >> MLB::Team.all.first.logo_url               # => "http://img.freebase.com/api/trans/image_thumb/wikipedia/images/en_id/13104064"
+    >> MLB::Team.all.first.players.first.name     # => "Alex Romero"
+    >> MLB::Team.all.first.players.first.number   # => 28
+    >> MLB::Team.all.first.players.first.position # => "Right fielder"
+
+Contributing
+------------
+In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small**: fix typos, add comments, cleanup inconsistent whitespace)
+* by refactoring code
+* by closing [issues](http://github.com/sferik/mlb/issues)
+* by reviewing patches
+* financially
+
+All contributors will be added to the credits and will receive the respect and gratitude of the community.
+
+Submitting an Issue
+-------------------
+We use the [GitHub issue tracker](http://github.com/sferik/mlb/issues) to track bugs and
+features. Before submitting a bug report or feature request, check to make sure it hasn't already
+been submitted. You can indicate support for an existing issuse by voting it up. When submitting a
+bug report, please include a [Gist](http://gist.github.com/) that includes a stack trace and any
+details that may be necessary to reproduce the bug, including your gem version, Ruby version, and
+operating system. Ideally, a bug report should include a pull request with failing specs.
+
+Submitting a Pull Request
+-------------------------
+1. Fork the project.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Add documentation for your feature or bug fix.
+5. Run <tt>bundle exec rake doc:yard</tt>. If your changes are not 100% documented, go back to step 4.
+6. Add specs for your feature or bug fix.
+7. Run <tt>bundle exec rake spec:rcov</tt>. If your changes are not 100% covered, go back to step 6.
+8. Commit and push your changes.
+9. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
+
+Credits
+-------
+Many thanks to:
+
+* [Bundler](http://gembundler.com/)
+* [Freebase](http://www.freebase.com/)
+* [faraday](https://github.com/technoweenie/faraday/)
+* [Markdown](http://daringfireball.net/projects/markdown/)
+* [MultiJSON](https://github.com/intridea/multi_json/)
+* [rcov](https://github.com/relevance/rcov/)
+* [RSpec](http://relishapp.com/rspec/)
+* [SQLite](http://www.sqlite.org/)
+* [WebMock](https://github.com/bblimke/webmock/)
+* [YARD](http://yardoc.org/)

data/Rakefile

@@ -1,15 +1,30 @@
-require 'rubygems'
-require 'rake'
-require 'rake/rdoctask'
 require 'bundler'
-
 Bundler::GemHelper.install_tasks
 
-Rake::RDocTask.new do |rd|
-  rd.main = 'README.rdoc'
-  rd.rdoc_dir = 'doc'
-  rd.rdoc_files.include('README.rdoc', 'LICENSE', 'lib/**/*.rb')
-  rd.title = 'MLB.rb'
-  rd.options << '--inline-source'
-  rd.options << '--all'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+namespace :spec do
+  desc "Run all examples using rcov"
+  RSpec::Core::RakeTask.new(:rcov => :cleanup_rcov_files) do |task|
+    task.rcov = true
+    task.rcov_opts = %[-Ilib -Ispec --exclude "gems/*,features,specs" --text-report --sort coverage]
+  end
+end
+
+task :cleanup_rcov_files do
+  rm_rf 'coverage'
+end
+
+task :default => ["spec:rcov"]
+
+namespace :doc do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['LICENSE.mkd', 'lib/**/*.rb']
+    task.options = [
+      '--output-dir', 'doc/yard',
+      '--markup', 'markdown',
+    ]
+  end
 end

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/lib/mlb.rb

@@ -1,4 +1,6 @@
 module MLB
-  autoload :Team, 'mlb/team'
-  autoload :Player, 'mlb/player'
+  autoload :Connection, 'mlb/connection'
+  autoload :Request,    'mlb/request'
+  autoload :Team,       'mlb/team'
+  autoload :Player,     'mlb/player'
 end

data/lib/mlb/request.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+
+module MLB
+  # @private
+  class Request
+    # Perform an HTTP GET request
+    def self.get(path, options={})
+      response = connection.get do |request|
+        request.url(path, options)
+      end
+      response.body
+    end
+
+    private
+
+    def self.connection
+      Faraday::Connection.new(:url => 'http://api.freebase.com') do |connection|
+        connection.use Faraday::Response::Yajl
+        connection.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/mlb/team.rb

@@ -1,15 +1,10 @@
-require 'httparty'
-require 'json'
-
 module MLB
   class Team
-    include HTTParty
-    format :json
-    base_uri 'http://www.freebase.com/api'
     attr_accessor :name, :league, :division, :manager, :wins, :losses, :founded, :mascot, :ballpark, :logo_url, :players
 
     # Returns an array of Team objects
     #
+    # @example
     #   MLB::Team.all.first.name                    # => "Arizona Diamondbacks"
     #   MLB::Team.all.first.league                  # => "National League"
     #   MLB::Team.all.first.division                # => "National League West"
@@ -35,9 +30,7 @@ module MLB
 
     private
 
-    # Attempt to fetch the result from the Freebase API
-    # unless there is a connection error, in which case
-    # query a static SQLite3 database.
+    # Attempt to fetch the result from the Freebase API unless there is a connection error, in which case query a static SQLite3 database
     def self.run
       begin
         run_team_mql
@@ -47,9 +40,7 @@ module MLB
     end
 
     def self.run_team_mql
-      query = team_mql_query
-      results = get('/service/mqlread?', :query => {:query => query.to_json})
-      raise(Exception, "#{results['status']} (Transaction: #{results['transaction_id']})") unless results['code'] == '/api/status/ok'
+      results = Request.get('/api/service/mqlread', :query => team_mql_query)
 
       teams = []
       results['result'].each do |result|
@@ -128,51 +119,49 @@ module MLB
 
     # Returns the MQL query for teams, as a Ruby hash
     def self.team_mql_query
-      {
-        :query => [
-          {
-            'name' => nil,
-            'league' => {
-              'name' => nil,
-            },
-            'division' => {
-              'name' => nil,
-            },
-            'current_manager' => {
-              'name' => nil,
-            },
-            'team_stats' => [{
-              'wins' => nil,
-              'losses' => nil,
-              'season' => nil,
-              'limit' => 1,
-              'sort' => '-season',
-            }],
-            'current_roster' => [{
-              'player' => nil,
-              'position' => nil,
-              'number' => nil,
-              'sort' => 'player',
-            }],
-            '/sports/sports_team/founded' => [{
-              'value' => nil,
-            }],
-            '/sports/sports_team/team_mascot' => [{
-            }],
-            '/sports/sports_team/arena_stadium' => [{
-              'name' => nil,
-            }],
-            '/common/topic/image' => [{
-              'id' => nil,
-              'timestamp' => nil,
-              'sort' => '-timestamp',
-              'limit' => 1,
-            }],
-            'sort' => 'name',
-            'type' => '/baseball/baseball_team',
-          }
-        ]
-      }
+      query = <<-eos
+        [{
+          "name":          null,
+          "league": {
+            "name": null
+          },
+          "division": {
+            "name": null
+          },
+          "current_manager": {
+            "name": null
+          },
+          "team_stats": [{
+            "wins":   null,
+            "losses": null,
+            "season": null,
+            "limit":  1,
+            "sort":   "-season"
+          }],
+          "current_roster": [{
+            "player":   null,
+            "position": null,
+            "number":   null,
+            "sort":     "player"
+          }],
+          "/sports/sports_team/founded": [{
+            "value": null
+          }],
+          "/sports/sports_team/team_mascot": [{}],
+          "/sports/sports_team/arena_stadium": [{
+            "name": null
+          }],
+          "/common/topic/image": [{
+            "id":        null,
+            "timestamp": null,
+            "sort":      "-timestamp",
+            "limit":     1
+          }],
+          "sort":          "name",
+          "type":          "/baseball/baseball_team"
+        }]
+        eos
+      '{"query":' + query.gsub!("\n", '').gsub!(' ', '') + '}'
     end
 
     def self.team_sql_query

data/lib/mlb/version.rb

@@ -1,3 +1,3 @@
 module MLB
-  VERSION = "0.2.6"
+  VERSION = "0.3.0"
 end

data/mlb.gemspec

@@ -2,19 +2,25 @@
 require File.expand_path("../lib/mlb/version", __FILE__)
 
 Gem::Specification.new do |s|
-  s.add_runtime_dependency(%q<httparty>, ["~> 0.6"])
-  s.add_runtime_dependency(%q<json>, ["~> 1.4"])
-  s.add_runtime_dependency(%q<sqlite3-ruby>, ["~> 1.3"])
+  s.add_development_dependency("bundler", "~> 1.0")
+  s.add_development_dependency("rake", "~> 0.8")
+  s.add_development_dependency("rcov", "~> 0.9")
+  s.add_development_dependency("rspec", "~> 2.0")
+  s.add_development_dependency("webmock", "~> 1.5")
+  s.add_development_dependency("yard", "~> 0.6")
+  s.add_development_dependency("ZenTest", "~> 4.4")
+  s.add_runtime_dependency("faraday", "~> 0.5.2")
+  s.add_runtime_dependency("yajl-ruby", "~> 0.7.8")
+  s.add_runtime_dependency("sqlite3-ruby", "~> 1.3.2")
   s.authors = ["Erik Michaels-Ober"]
   s.description = %q{MLB.rb is a Ruby library for retrieving current Major League Baseball players, managers, teams, divisions, and leagues.}
   s.email = ["sferik@gmail.com"]
-  s.extra_rdoc_files = ["LICENSE", "README.rdoc"]
   s.files = `git ls-files`.split("\n")
   s.homepage = "http://rubygems.org/gems/mlb"
   s.name = "mlb"
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.required_rubygems_version = ">= 1.3.6"
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.3.6") if s.respond_to? :required_rubygems_version=
   s.summary = %q{MLB.rb is a Ruby library for retrieving current Major League Baseball players, managers, teams, divisions, and leagues.}
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.version = MLB::VERSION