espn 0.0.2 → 0.1.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmNiOWEzYWM3YTI5MzBkYTZkMTI3ZWYzNjU5ODJlNzEyYzg5OWI4Mg==
+  data.tar.gz: !binary |-
+    YTY0NGE5MzY5YzVlNGEyNDAyM2ZlYzRjOTE2MjY5YmQzZjM3OGMwYw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    N2FlMmU2MjA0YmMwNTk4OWIzYmYxMjRmZWQ4NmVjMWUzZTU2OGYxMjUzYzEy
+    ZTZhMTk1Y2ZkOTdjOTljODIxZWVhN2E2MTFkMDE0YWRjOWQ0NDRhZWM0ZTE2
+    ZDg0MjAzZGU1Njg5NDgwMjg4NTAyZDJjZTgzN2M5ZTM4NjNhM2U=
+  data.tar.gz: !binary |-
+    Zjk1Njc1OGNjZDBhNzFmYjdkMjAyYzA2ZDg3MWYzMGNiNTc4ODNkNjUyY2Vm
+    ZDBjNjgwNzM2Y2IxNWJiMGNiYTY0MWYzOThmOTBhMGZjMjU1NTk0ZWM1M2Mw
+    MmE0ODc1MWFmMDdhZDRiMDM5N2MwYTc2ZDU5ZWUwMTRiNGQ4NWU=

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Andrew Thorp
+
+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.md

@@ -1,5 +1,40 @@
-# Ruby Wrapper for the ESPN API
+# ESPN
 
-## Why?
+Simply Ruby Wrapper for the ESPN Developer API.
 
-I have seen this halfway implemented a few times. My goal is to take over the `espn` gem name.
+## Installation
+
+    gem install espn
+
+## Examples
+
+First, setup your client:
+
+    client = ESPN::Client.new(api_key: 'your_api_key_here')
+
+Next, make calls against the ESPN API.
+
+### Sports
+
+    sport = client.sports(sport: 'baseball', league: 'mlb').sports.first
+    puts sport.leagues.first.groups.first.name
+    # => American League
+
+### Headlines
+
+    headline = client.headlines(sport: 'baseball', league: 'mlb').headlines.first
+    puts headline.title
+    # => Atlanta Braves outfielder Jason Heyward hit in jaw with pitch
+
+## Inspiration
+
+A ton of inspiration was taken from [Octokit][octokit]. Thanks to those guys for
+showing the world how API Wrappers should work.
+
+[octokit]: http://github.com/octokit/octokit.rb
+
+## Copyright
+
+Copyright (c) 2013 Andrew Thorp. See [LICENSE][] for details.
+
+[license]: LICENSE.md

data/espn.gemspec

@@ -3,7 +3,7 @@ require File.expand_path('../lib/espn/version', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = 'espn'
-  s.version     = ESPN::VERSION
+  s.version     = ESPN::VERSION.dup
   s.platform    = Gem::Platform::RUBY
 
   s.authors     = ['Andrew Thorp']
@@ -24,10 +24,14 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'webmock'
+  s.add_development_dependency 'vcr'
   s.add_development_dependency 'yard'
   s.add_development_dependency 'markdown'
 
-  s.files         = `git ls-files -cd`.split("\n")
+  s.files = %w(LICENSE.md README.md espn.gemspec)
+  s.files += Dir.glob("lib/**/*.rb")
+  s.files += Dir.glob("spec/**/*")
+
   s.test_files    = Dir.glob("spec/**/*")
   s.require_paths = ["lib"]
 end

data/lib/espn.rb

@@ -4,22 +4,32 @@ require 'espn/error'
 
 module ESPN
   extend Configuration
+
   class << self
-    # Alias for ESPN::Client.new
+
+    # Public: An alias for ESPN::Client.new.
     #
-    # @return [ESPN::Client]
+    # Returns an ESPN::Client.
     def new(options={})
       ESPN::Client.new(options)
     end
 
-    # Delegate to ESPN::Client.new
+    # Public: Delegate methods to ESPN::Client.new. If a ESPN::Client does not
+    # respond_to? the :method, pass it up the chain.
+    #
+    # Returns nothing.
     def method_missing(method, *args, &block)
       return super unless new.respond_to?(method)
       new.send(method, *args, &block)
     end
 
+    # Public: Delegate to ESPN::Client.new respond_to?
+    #
+    # Returns nothing.
     def respond_to?(method, include_private=false)
       new.respond_to?(method, include_private) || super(method, include_private)
     end
+
   end
+
 end

data/lib/espn/client.rb

@@ -1,38 +1,65 @@
 require 'espn/connection'
 require 'espn/request'
+
+require 'espn/client/athletes'
+require 'espn/client/audio'
+require 'espn/client/headlines'
+require 'espn/client/medals'
+require 'espn/client/notes'
+require 'espn/client/now'
+require 'espn/client/scores'
 require 'espn/client/sports'
+require 'espn/client/standings'
 require 'espn/client/teams'
+require 'espn/client/video'
 
 module ESPN
 
   class Client
+
+    # Public: An attr_accessor for each configuration option.
     attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
 
-    def initialize(options={})
-      options = ESPN.options.merge(options)
+    # Public: Initialize a new Client. To see all options that can be
+    # configured, look at the Configuration module, specifically
+    # VALID_OPTIONS_KEYS.
+    #
+    # opts  - A Hash of configuration options.
+    def initialize(opts={})
+      options = ESPN.options.merge(opts)
       Configuration::VALID_OPTIONS_KEYS.each do |key|
         send("#{key}=", options[key])
       end
     end
 
-    # Provides the URL for accessing the API
+    # Public: Get the base URL for accessing the ESPN API.
     #
-    # @return [String]
+    # Returns a String.
     def api_url
-      "http://api.espn.com/v1"
+      "http://api.espn.com/v1/"
     end
 
-    # Determine if an api_key has been set
+    # Public: Determine if the ESPN::Client has been authenticated. At this
+    # point, we are just checking to see if an :api_key has been set.
     #
-    # @return [Boolean]
+    # Returns a Boolean.
     def authed?
       !api_key.nil?
     end
 
     include ESPN::Connection
     include ESPN::Request
+    include ESPN::Client::Athletes
+    include ESPN::Client::Audio
+    include ESPN::Client::Headlines
+    include ESPN::Client::Medals
+    include ESPN::Client::Notes
+    include ESPN::Client::Now
+    include ESPN::Client::Scores
     include ESPN::Client::Sports
+    include ESPN::Client::Standings
     include ESPN::Client::Teams
+    include ESPN::Client::Video
 
   end
 

data/lib/espn/client/athletes.rb

@@ -0,0 +1,34 @@
+module ESPN
+  class Client
+    module Athletes
+
+      # Public: Get athlete stats and information from the ESPN API.
+      #
+      # opts  - Hash options used to refine the selection (default: {}).
+      #       - :sport        - The name of the sport (default: nil).
+      #       - :league       - The name of the league (default: nil).
+      #       - :athlete_id   - The id of the athlete (default: nil).
+      #
+      # Returns an Array of Hashie::Mash.
+      def athletes(opts={})
+        url = "sports"
+
+        unless opts[:sport].to_s.empty?
+          url += "/#{opts[:sport]}"
+          unless opts[:league].to_s.empty?
+            url += "/#{opts[:league]}"
+          end
+        end
+
+        url += "/athletes"
+
+        unless opts[:athlete_id].to_s.empty?
+          url += "/#{opts[:athlete_id]}"
+        end
+
+        get(url, opts)
+      end
+
+    end
+  end
+end

data/lib/espn/client/audio.rb

@@ -0,0 +1,37 @@
+module ESPN
+  class Client
+    module Audio
+
+      # Public: Get audio podcasts and clips from ESPN.
+      #
+      # opts  - Hash options used to refine the selection (default: {}).
+      #       - :method         - The name of the sport (default: 'podcasts').
+      #       - :podast_id      - The id of the podcast (default: nil).
+      #       - :recording_id   - The id of the recording (default: nil).
+      #
+      # Returns an Array of Hashie::Mash.
+      def audio(opts={})
+        opts [:method] ||= 'podcasts'
+
+        url = 'audio'
+
+        if opts[:method] == 'podcast_recordings'
+          url += '/podcasts/recordings'
+        else
+          url += "/#{opts[:method]}"
+        end
+
+        unless opts[:podcast_id].to_s.empty?
+          url += "/#{opts[:podcast_id]}"
+        end
+
+        unless opts[:recording_id].to_s.empty?
+          url += "/#{opts[:recording_id]}"
+        end
+
+        get(url, opts)
+      end
+
+    end
+  end
+end

data/lib/espn/client/headlines.rb

@@ -0,0 +1,42 @@
+module ESPN
+  class Client
+    module Headlines
+
+      # Public: Get latest sports news and analysis from the ESPN API.
+      #
+      # opts  - Hash options used to refine the selection (default: {}).
+      #       - :section      - The news section (default: 'sports').
+      #       - :sport        - The name of the sport (default: nil).
+      #       - :league       - The name of the league (default: nil).
+      #       - :method       - The method of headlines (default: nil).
+      #       - :headline_id  - The id of a specific headline (default: nil).
+      #
+      # Returns an Array of Hashie::Mash.
+      def headlines(opts={})
+        url = opts[:section] || 'sports'
+
+        unless opts[:sport].to_s.empty?
+          url += "/#{opts[:sport]}"
+          unless opts[:league].to_s.empty?
+            url += "/#{opts[:league]}"
+          end
+        end
+
+        url += '/news'
+
+        unless opts[:method].to_s.empty?
+          url += "/headlines/#{opts[:method]}"
+        end
+
+        unless opts[:headline_id].to_s.empty?
+          url += "/#{opts[:headline_id]}"
+        end
+
+        puts url
+
+        get(url, opts)
+      end
+
+    end
+  end
+end

data/lib/espn/client/medals.rb

@@ -0,0 +1,16 @@
+module ESPN
+  class Client
+    module Medals
+
+      # Public: Get medal counts and competition from the olympic games.
+      #
+      # opts  - Hash options used to refine the selection (default: {}).
+      #
+      # Returns an Array of Hashie::Mash.
+      def medals(opts={})
+        get('sports/olympics/medals', opts)
+      end
+
+    end
+  end
+end

data/lib/espn/client/notes.rb

@@ -0,0 +1,35 @@
+module ESPN
+  class Client
+    module Notes
+
+      # Public: Get Exclusive factoids produced by ESPN's Stats and Information
+      # Group from the ESPN API.
+      #
+      # opts  - Hash options used to refine the selection (default: {}).
+      #       - :sport    - The name of the sport (default: nil).
+      #       - :league   - The name of the league (default: nil).
+      #       - :note_id  - The id of the note (default: nil).
+      #
+      # Returns an Array of Hashie::Mash.
+      def notes(opts={})
+        url = 'sports'
+
+        unless opts[:sport].to_s.empty?
+          url += "/#{opts[:sport]}"
+          unless opts[:league].to_s.empty?
+            url += "/#{opts[:league]}"
+          end
+        end
+
+        url += '/news/notes'
+
+        unless opts[:note_id].to_s.empty?
+          url += "/#{opts[:note_id]}"
+        end
+
+        get(url, opts)
+      end
+
+    end
+  end
+end

data/lib/espn/client/now.rb

@@ -0,0 +1,23 @@
+module ESPN
+  class Client
+    module Now
+
+      # Public: Get stream of the latest content published on ESPN.com.
+      #
+      # opts  - Hash options used to refine the selection (default: {}).
+      #       - :method   - The type of content to retrieve (default: nil).
+      #
+      # Returns an Array of Hashie::Mash
+      def now(opts={})
+        url = 'now'
+
+        unless opts[:method].to_s.empty?
+          url += "/#{opts[:method]}"
+        end
+
+        get(url, opts)
+      end
+
+    end
+  end
+end

data/lib/espn/client/scores.rb

@@ -0,0 +1,34 @@
+module ESPN
+  class Client
+    module Scores
+
+      # Public: Get schedule and scores information from the ESPN API.
+      #
+      # opts  - Hash options used to refine the selection (default: {}).
+      #       - :sport    - The name of the sport (default: nil).
+      #       - :league   - The name of the league (default: nil).
+      #       - :event_id - The event to get information about (default: nil).
+      #
+      # Returns an Array of Hashie::Mash.
+      def scores(opts={})
+        url = 'sports'
+
+        unless opts[:sport].to_s.empty?
+          url += "/#{opts[:sport]}"
+          unless opts[:league].to_s.empty?
+            url += "/#{opts[:league]}"
+          end
+        end
+
+        url += '/events'
+
+        unless opts[:event_id].to_s.empty?
+          url += "/#{opts[:event_id]}"
+        end
+
+        get(url, opts)
+      end
+
+    end
+  end
+end