mlb 0.0.3 → 0.0.4

data/lib/mlb.rb

@@ -6,9 +6,71 @@ class MLB
   include HTTParty
   base_uri 'http://www.freebase.com/api'
 
+  # Returns an array of objects, one for each Major League Baseball team
+  #
+  #   MLB.teams.first.name                    # => "Arizona Diamondbacks"
+  #   MLB.teams.first.league                  # => "National League"
+  #   MLB.teams.first.division                # => "National League West"
+  #   MLB.teams.first.manager                 # => "Bob Melvin"
+  #   MLB.teams.first.wins                    # => 82
+  #   MLB.teams.first.losses                  # => 80
+  #   MLB.teams.first.founded                 # => 1998
+  #   MLB.teams.first.mascot                  # => nil
+  #   MLB.teams.first.ballpark                # => "Chase Field"
+  #   MLB.teams.first.logo_url                # => "http://img.freebase.com/api/trans/image_thumb/wikipedia/images/en_id/13104064"
+  #   MLB.teams.first.players.first.name      # => "Alex Romero"
+  #   MLB.teams.first.players.first.number    # => 28
+  #   MLB.teams.first.players.first.position  # => "Right fielder"
   def self.teams
     format :json
-    @query ||= {
+    @query ||= team_query
+    @response ||= exec_mql(@query)
+    @results ||= []
+    if @results.empty?
+      @response['result'].each do |result|
+        @results << OpenStruct.new({
+          :name     => result['name'],
+          :league   => result['league']['name'],
+          :division => result['division']['name'],
+          :manager  => result['current_manager']['name'],
+          :wins     => result['team_stats'].first['wins'].to_i,
+          :losses   => result['team_stats'].first['losses'].to_i,
+          :founded  => result['/sports/sports_team/founded'].first['value'].to_i,
+          :mascot   => (result['/sports/sports_team/team_mascot'].first ? result['/sports/sports_team/team_mascot'].first['name'] : nil),
+          :ballpark => result['/sports/sports_team/arena_stadium'].first['name'],
+          :logo_url => 'http://img.freebase.com/api/trans/image_thumb' + result['/common/topic/image'].first['id'],
+          :players  => result['current_roster'].map {|player|
+            OpenStruct.new({
+              :name => player['player'],
+              :number => player['number'],
+              :position => player['position'],
+            })
+          },
+        })
+      end
+    end
+    @results
+  end
+
+  private
+
+  # Converts MQL query to JSON and sends to Freebase API
+  def self.exec_mql(query)
+    begin
+      response ||= get('/service/mqlread?', :query => {:query => query.to_json})
+      unless response['code'] == '/api/status/ok'
+        errors = Array(response['messages']).map{|m| m.inspect}.join(', ')
+        raise "#{response['status']}: #{errors} (#{response['transaction_id']})"
+      end
+    rescue SocketError, Errno::ECONNREFUSED => e
+      raise Exception.new("Could not connect. Unclog tubes and try again.")
+    end
+    response
+  end
+
+  # Returns the MQL query for teams, as a Ruby hash
+  def self.team_query
+    {
       :query => [
         {
           'name' => nil,
@@ -53,31 +115,6 @@ class MLB
         }
       ]
     }
-
-    @response ||= get('/service/mqlread?', :query => {:query => @query.to_json})
-    unless @response['code'] == '/api/status/ok'
-      errors = Array(@response['messages']).map{|m| m.inspect}.join(', ')
-      raise "#{@response['status']}: #{errors} (#{@response['transaction_id']})"
-    end
-    @results ||= []
-    if @results.empty?
-      @response['result'].each do |result|
-        @results << OpenStruct.new({
-          :name     => result['name'],
-          :league   => result['league']['name'],
-          :division => result['division']['name'],
-          :manager  => result['current_manager']['name'],
-          :players  => result['current_roster'].map{|player| OpenStruct.new({:name => player['player'], :number => player['number'], :position => player['position'],})},
-          :wins     => result['team_stats'].first['wins'].to_i,
-          :losses   => result['team_stats'].first['losses'].to_i,
-          :founded  => result['/sports/sports_team/founded'].first['value'].to_i,
-          :mascot   => (result['/sports/sports_team/team_mascot'].first ? result['/sports/sports_team/team_mascot'].first['name'] : nil),
-          :ballpark => result['/sports/sports_team/arena_stadium'].first['name'],
-          :logo_url => 'http://img.freebase.com/api/trans/image_thumb' + result['/common/topic/image'].first['id'],
-        })
-      end
-    end
-    @results
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mlb
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Erik Michaels-Ober
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-07 00:00:00 -07:00
+date: 2009-10-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -39,11 +39,22 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.markdown
+- README.rdoc
 - LICENSE
 files: 
 - LICENSE
-- README.markdown
+- README.rdoc
+- Rakefile
+- doc/classes/MLB.html
+- doc/created.rid
+- doc/files/lib/mlb_rb.html
+- doc/files/LICENSE.html
+- doc/files/README_rdoc.html
+- doc/fr_class_index.html
+- doc/fr_file_index.html
+- doc/fr_method_index.html
+- doc/index.html
+- doc/rdoc-style.css
 - lib/mlb.rb
 has_rdoc: true
 homepage: http://github.com/sferik/mlb

data/README.markdown

@@ -1,52 +0,0 @@
-# MLB.rb
-
-**MLB.rb is a Ruby library for retrieving current Major League Baseball players, managers, teams, divisions, and leagues.**
-
-## Get it
-
-At the command prompt, type:
-
-    sudo gem install mlb -s http://gemcutter.org
-
-## Use it
-
-    $ irb
-    >> require 'mlb'
-    => true
-    >> team = MLB.teams[17]; nil
-    => nil
-    >> team.name
-    => "New York Mets"
-    >> team.league
-    => "National League"
-    >> team.division
-    => "National League East"
-    >> team.manager
-    => "Jerry Manuel"
-    >> team.wins
-    => 89
-    >> team.losses
-    => 73
-    >> team.founded
-    => 1962
-    >> team.mascot
-    => "Mr. Met"
-    >> team.ballpark
-    => "Shea Stadium"
-    >> team.logo_url
-    => "http://img.freebase.com/api/trans/image_thumb/wikipedia/images/commons_id/3269938"
-    >> player = team.players[14]; nil
-    => nil
-    >> player.name
-    => "David Wright"
-    >> player.number
-    => 5
-    >> player.position
-    => "Third baseman"
-
-Many thanks to:
-
-* [Freebase](http://www.freebase.com)
-* [httparty](http://github.com/jnunemaker/httparty)
-
-Also, thanks to [beer](http://www.21st-amendment.com).