espn 0.0.2 → 0.1.1

data/lib/espn/client/sports.rb

@@ -2,16 +2,24 @@ module ESPN
   class Client
     module Sports
 
-      # Get all sports supported by the ESPN Developer API
+      # Public: Get sports and leagues supported in the ESPN API.
       #
-      # @param [Hash] options
+      # 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).
       #
-      # @return [Hashie::Mash]
-      #
-      # @example
-      #   ESPN.sports()
-      def sports(options={})
-        get("/sports", options)
+      # Returns an Array of Hashie::Mash.
+      def sports(opts={})
+        url = 'sports'
+
+        unless opts[:sport].to_s.empty?
+          url += "/#{opts[:sport]}"
+          unless opts[:league].to_s.empty?
+            url += "/#{opts[:league]}"
+          end
+        end
+
+        get(url, opts)
       end
 
     end

data/lib/espn/client/standings.rb

@@ -0,0 +1,29 @@
+module ESPN
+  class Client
+    module Standings
+
+      # Public: Get the latest league and divisional standings from ESPN.
+      #
+      # 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).
+      #
+      # Returns an Array of Hashie::Mash.
+      def standings(opts={})
+        url = 'sports'
+
+        unless opts[:sport].to_s.empty?
+          url += "/#{opts[:sport]}"
+          unless opts[:league].to_s.empty?
+            url += "/#{opts[:league]}"
+          end
+        end
+
+        url += '/standings'
+
+        get(url, opts)
+      end
+
+    end
+  end
+end

data/lib/espn/client/teams.rb

@@ -2,16 +2,31 @@ module ESPN
   class Client
     module Teams
 
-      # Get all sports supported by the ESPN Developer API
+      # Public: Get sport team stats and information from the ESPN API.
       #
-      # @param [Hash] options
+      # 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).
+      #       - :team_id  - The id of the team (default: nil).
       #
-      # @return [Hashie::Mash]
-      #
-      # @example
-      #   ESPN.sports()
-      def teams(options={})
-        get("/sports/teams", options)
+      # Returns an Array of Hashie::Mash.
+      def teams(opts={})
+        url = 'sports'
+
+        unless opts[:sport].to_s.empty?
+          url += "/#{opts[:sport]}"
+          unless opts[:league].to_s.empty?
+            url += "/#{opts[:league]}"
+          end
+        end
+
+        url += '/teams'
+
+        unless opts[:team_id].to_s.empty?
+          url += "/#{opts[:team_id]}"
+        end
+
+        get(url, opts)
       end
 
     end

data/lib/espn/client/video.rb

@@ -0,0 +1,30 @@
+module ESPN
+  class Client
+    module Video
+
+      # Public: Get video clip and channel information from ESPN.
+      #
+      # opts  - Hash options used to refine the selection (default: {}).
+      #       - :category_id  - The id of the category (default: nil).
+      #       - :clip_id      - The id of the clip (default: nil).
+      #
+      # Returns an Array of Hashie::Mash.
+      def video(opts={})
+        url = 'video/channels'
+
+        unless opts[:category_id].to_s.empty?
+          url += "/#{opts[:category_id]}"
+        end
+
+        url += '/clips'
+
+        unless opts[:clip_id].to_s.empty?
+          url += "/#{opts[:clip_id]}"
+        end
+
+        get(url, opts)
+      end
+
+    end
+  end
+end

data/lib/espn/configuration.rb

@@ -2,35 +2,67 @@ require 'faraday'
 require 'espn/version'
 
 module ESPN
+
+  # Public: All methods useful for configuration. This module should be extended
+  # in the ESPN module, so ESPN can be configured.
+  #
+  # Examples
+  #
+  #   module ESPN
+  #     extend Configuration
+  #   end
   module Configuration
-    VALID_OPTIONS_KEYS = [
-      :adapter,
-      :api_version,
-      :proxy,
-      :api_key,
-      :timeout,
-      :open_timeout,
-      :user_agent].freeze
 
+    # Public: Array of all configuration options for an ESPN::Client.
+    VALID_OPTIONS_KEYS = [:adapter, :api_version, :proxy, :api_key, :timeout,
+                          :open_timeout, :user_agent].freeze
+
+    # Public: The default adapter used for requests.
     DEFAULT_ADAPTER         = Faraday.default_adapter
+
+    # Public: The default API Version.
     DEFAULT_API_VERSION     = 1
+
+    # Public: The default user agent.
     DEFAULT_USER_AGENT      = "ESPN Ruby Gem #{ESPN::VERSION}".freeze
+
+    # Public: The default timeout for HTTP Requests.
     DEFAULT_TIMEOUT         = 10
 
+    # Public: Create an attr_accessor for each VALID_OPTIONS_KEYS when this
+    # module is extended into another.
     attr_accessor(*VALID_OPTIONS_KEYS)
 
+    # Internal: Hook when this module is extended in another, we call #reset.
+    #
+    # Returns nothing.
     def self.extended(base)
       base.reset
     end
 
+    # Public: The ability to configure ESPN default options.
+    #
+    # Examples
+    #
+    #   ESPN.configure do |c|
+    #     c.api_key = 'abc123'
+    #   end
+    #
+    # Yields ESPN::Configuration.
     def configure
       yield self
     end
 
+    # Public: Get all valid options with their defaults.
+    #
+    # Returns a Hash.
     def options
       VALID_OPTIONS_KEYS.inject({}){|o,k| o.merge!(k => send(k)) }
     end
 
+    # Public: Reset all valid options to their defaults.
+    #
+    # Returns nothing.
     def reset
       self.adapter                = DEFAULT_ADAPTER
       self.api_version            = DEFAULT_API_VERSION

data/lib/espn/request.rb

@@ -9,6 +9,14 @@ module ESPN
     private
 
     def request(method, path, options)
+
+      # TODO: Decide if I want to delete these or not. There is probably
+      # a better way to do this, if so, by filtering them out.
+      %w( sport league method section team_id headline_id category_id clip_id
+          athlete_id event_id note_id podcast_id recording_id ).each do |k|
+        options.delete(k.to_sym)
+      end
+
       response = connection.send(method) do |request|
         request.url(path, options)
         request.options[:timeout] = timeout

data/lib/espn/version.rb

@@ -1,3 +1,6 @@
 module ESPN
-  VERSION = "0.0.2" unless defined?(ESPN::VERSION)
+
+  # Public: The version of the ESPN gem.
+  VERSION = '0.1.1'.freeze
+
 end

data/spec/espn/client/athletes_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe ESPN::Client::Athletes do
+  before do
+    @client = ESPN::Client.new
+  end
+
+  describe '#athletes' do
+
+    it 'gets all athletes' do
+      stub_get('sports/athletes')
+      @client.athletes
+      assert_requested :get, espn_url('sports/athletes')
+    end
+
+    context 'with a sport param' do
+      it 'should include the sport in the request' do
+        stub_get('sports/baseball/athletes')
+        @client.athletes(sport: 'baseball')
+        assert_requested :get, espn_url('sports/baseball/athletes')
+      end
+
+      context 'with a athlete_id param' do
+        it 'should include the sport and athlete_id params in the request' do
+          stub_get('sports/baseball/athletes/5')
+          @client.athletes(sport: 'baseball', athlete_id: 5)
+          assert_requested :get, espn_url('sports/baseball/athletes/5')
+        end
+      end
+    end
+
+    context 'with a sport and a league param' do
+      it 'should include the sport and league params in the request' do
+        stub_get('sports/baseball/mlb/athletes')
+        @client.athletes(sport: 'baseball', league: 'mlb')
+        assert_requested :get, espn_url('sports/baseball/mlb/athletes')
+      end
+
+      context 'with a athlete_id param' do
+        it 'should include the sport, league and athlete_id params' do
+          stub_get('sports/baseball/mlb/athletes/1')
+          @client.athletes(sport: 'baseball', league: 'mlb', athlete_id: 1)
+          assert_requested :get, espn_url('sports/baseball/mlb/athletes/1')
+        end
+      end
+    end
+
+    context 'with a athlete_id param' do
+      it 'should include the athlete_id in the request' do
+        stub_get('sports/athletes/5')
+        @client.athletes(athlete_id: 5)
+        assert_requested :get, espn_url('sports/athletes/5')
+      end
+    end
+
+    context 'with a league param and no sport param' do
+      it 'should not include either in the request' do
+        stub_get('sports/athletes')
+        @client.athletes(league: 'mlb')
+        assert_requested :get, espn_url('sports/athletes')
+      end
+
+      context 'with a athlete_id param' do
+        it 'should include the athlete_id in the request' do
+          stub_get('sports/athletes/2')
+          @client.athletes(league: 'mlb', athlete_id: 2)
+          assert_requested :get, espn_url('sports/athletes/2')
+        end
+      end
+    end
+
+  end
+end

data/spec/espn/client/audio_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe ESPN::Client::Audio do
+  before do
+    @client = ESPN::Client.new
+  end
+
+  it 'should get all podcasts' do
+    stub_get('audio/podcasts')
+    @client.audio
+    assert_requested :get, espn_url('audio/podcasts')
+  end
+
+  context 'with a method param' do
+    context 'if method is podcast_recordings' do
+      it 'should include podcasts/recordings in the request' do
+        stub_get('audio/podcasts/recordings')
+        @client.audio(method: 'podcast_recordings')
+        assert_requested :get, espn_url('audio/podcasts/recordings')
+      end
+    end
+
+    it 'should include the method in the request' do
+      stub_get('audio/recordings')
+      @client.audio(method: 'recordings')
+      assert_requested :get, espn_url('audio/recordings')
+    end
+  end
+
+  context 'with a podcast_id param' do
+    it 'should include the podcast_id in the param' do
+      stub_get('audio/podcasts/1')
+      @client.audio(podcast_id: 1)
+      assert_requested :get, espn_url('audio/podcasts/1')
+    end
+  end
+
+  context 'with a recording_id param' do
+    it 'should include the recording_id in the param' do
+      stub_get('audio/podcasts/2')
+      @client.audio(recording_id: 2)
+      assert_requested :get, espn_url('audio/podcasts/2')
+    end
+  end
+
+end

data/spec/espn/client/headlines_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe ESPN::Client::Headlines do
+  before do
+    @client = ESPN::Client.new
+  end
+
+  describe '#headlines' do
+    it 'should get headlines for sports by default' do
+      stub_get('sports/news')
+      @client.headlines
+      assert_requested :get, espn_url('sports/news')
+    end
+
+    context 'with a section param' do
+      it 'should get headlines for that section' do
+        stub_get('cities/news')
+        @client.headlines(section: 'cities')
+        assert_requested :get, espn_url('cities/news')
+      end
+    end
+
+    context 'with a sport param' do
+      it 'should include the sport in the request' do
+        stub_get('sports/baseball/news')
+        @client.headlines(sport: 'baseball')
+        assert_requested :get, espn_url('sports/baseball/news')
+      end
+    end
+
+    context 'with a sport and league param' do
+      it 'should include both params in the request' do
+        stub_get('sports/baseball/mlb/news')
+        @client.headlines(sport: 'baseball', league: 'mlb')
+        assert_requested :get, espn_url('sports/baseball/mlb/news')
+      end
+    end
+
+    context 'with a league param but no sport param' do
+      it 'should not include the league in the request' do
+        stub_get('sports/news')
+        @client.headlines(league: 'mlb')
+        assert_requested :get, espn_url('sports/news')
+      end
+    end
+
+    context 'with a method param' do
+      it 'should include the method in the request' do
+        stub_get('sports/news/headlines/top')
+        @client.headlines(method: 'top')
+        assert_requested :get, espn_url('sports/news/headlines/top')
+      end
+    end
+
+    context 'with a headline_id param' do
+      it 'should include the headline_id in the request' do
+        stub_get('sports/news/5')
+        @client.headlines(headline_id: 5)
+        assert_requested :get, espn_url('sports/news/5')
+      end
+    end
+  end
+
+end

data/spec/espn/client/medals_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe ESPN::Client::Medals do
+  before do
+    @client = ESPN::Client.new
+  end
+
+  it 'should get all medals' do
+    stub_get('sports/olympics/medals')
+    @client.medals
+    assert_requested :get, espn_url('sports/olympics/medals')
+  end
+
+end

data/spec/espn/client/notes_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe ESPN::Client::Notes do
+  before do
+    @client = ESPN::Client.new
+  end
+
+  describe '#notes' do
+
+    it 'gets all notes' do
+      stub_get('sports/news/notes')
+      @client.notes
+      assert_requested :get, espn_url('sports/news/notes')
+    end
+
+    context 'with a sport param' do
+      it 'should include the sport in the request' do
+        stub_get('sports/baseball/news/notes')
+        @client.notes(sport: 'baseball')
+        assert_requested :get, espn_url('sports/baseball/news/notes')
+      end
+
+      context 'with a note_id param' do
+        it 'should include the sport and note_id params in the request' do
+          stub_get('sports/baseball/news/notes/5')
+          @client.notes(sport: 'baseball', note_id: 5)
+          assert_requested :get, espn_url('sports/baseball/news/notes/5')
+        end
+      end
+    end
+
+    context 'with a sport and a league param' do
+      it 'should include the sport and league params in the request' do
+        stub_get('sports/baseball/mlb/news/notes')
+        @client.notes(sport: 'baseball', league: 'mlb')
+        assert_requested :get, espn_url('sports/baseball/mlb/news/notes')
+      end
+
+      context 'with a note_id param' do
+        it 'should include the sport, league and note_id params' do
+          stub_get('sports/baseball/mlb/news/notes/1')
+          @client.notes(sport: 'baseball', league: 'mlb', note_id: 1)
+          assert_requested :get, espn_url('sports/baseball/mlb/news/notes/1')
+        end
+      end
+    end
+
+    context 'with a note_id param' do
+      it 'should include the note_id in the request' do
+        stub_get('sports/news/notes/5')
+        @client.notes(note_id: 5)
+        assert_requested :get, espn_url('sports/news/notes/5')
+      end
+    end
+
+    context 'with a league param and no sport param' do
+      it 'should not include either in the request' do
+        stub_get('sports/news/notes')
+        @client.notes(league: 'mlb')
+        assert_requested :get, espn_url('sports/news/notes')
+      end
+
+      context 'with a note_id param' do
+        it 'should include the note_id in the request' do
+          stub_get('sports/news/notes/2')
+          @client.notes(league: 'mlb', note_id: 2)
+          assert_requested :get, espn_url('sports/news/notes/2')
+        end
+      end
+    end
+
+  end
+end