espn 0.1.3 → 0.2.0

data/lib/espn/client/medals.rb

@@ -1,5 +1,13 @@
 module ESPN
   class Client
+
+    # Public: The mapping to the MEDALS API of the ESPN developer API.
+    #
+    # Examples
+    #
+    #   class Client
+    #     include ESPN::Client::Medals
+    #   end
     module Medals
 
       # Public: Get medal counts and competition from the olympic games.

data/lib/espn/client/notes.rb

@@ -1,33 +1,43 @@
 module ESPN
   class Client
+
+    # Public: The mapping to the RESEARCH NOTES API of the ESPN developer API.
+    #
+    # Examples
+    #
+    #   class Client
+    #     include ESPN::Client::Notes
+    #   end
     module Notes
 
+      # Public: Get a specific note from the ESPN developer API.
+      #
+      # id    - The id of a specific note.
+      # opts  - Hash options used to refine the selection. You can find a full
+      #         list of options on the ESPN developer API website (default: {}).
+      #
+      # Returns a Hashie::Mash.
+      def note(id, opts={})
+        get("sports/news/notes/#{id}", opts).notes.first
+      end
+
       # 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).
+      # sport   - A Symbol or String of the sport (optional).
+      # league  - A Symbol or String of the league. If a league is passed, but
+      #           not a sport, an attempt will be made to map the league to a
+      #           sport (required).
+      # opts    - Hash options used to refine the selection. If sport and/or
+      #           league are passed in, they will override the mapped values
+      #           You can find a full list of options on the ESPN developer API
+      #           website (default: {}).
       #
       # 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)
+      def notes(*args)
+        arguments = ESPN::Arguments.new(args)
+        pattern = "sports/:sport/:league/news/notes"
+        get(pattern, arguments.options).notes
       end
 
     end

data/lib/espn/client/now.rb

@@ -1,21 +1,24 @@
 module ESPN
   class Client
+
+    # Public: The mapping to the ESPN NOW API of the ESPN developer API.
+    #
+    # Examples
+    #
+    #   class Client
+    #     include ESPN::Client::Now
+    #   end
     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).
+      #         :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)
+        pattern = 'now/:method'
+        get(pattern, opts).feed
       end
 
     end

data/lib/espn/client/scores.rb

@@ -1,32 +1,44 @@
 module ESPN
   class Client
+
+    # Public: The mapping to the SCORES & SCHEDULES API of the ESPN developer
+    # API.
+    #
+    # Examples
+    #
+    #   class Client
+    #     include ESPN::Client::Scores
+    #   end
     module Scores
 
+      # Public: Get the score for a specific event from the ESPN API.
+      #
+      # id    - The id of an event to get the scores for.
+      # opts  - Hash options used to refine the selection. You can find a full
+      #         list of options on the ESPN developer API website (default: {}).
+      #
+      # Returns a Hashie::Mash.
+      def score(id, opts={})
+        get("sports/events/#{id}", opts).sports.first.leagues.first.events.first
+      end
+
       # 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).
+      # sport   - A Symbol or String of the sport (optional).
+      # league  - A Symbol or String of the league. If a league is passed, but
+      #           not a sport, an attempt will be made to map the league to a
+      #           sport (required).
+      # opts    - Hash options used to refine the selection. If sport and/or
+      #           league are passed in, they will override the mapped values
+      #           You can find a full list of options on the ESPN developer API
+      #           website (default: {}).
+      #           :id - The id of a specific event (default: nil, optional).
       #
       # 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)
+      def scores(*args)
+        arguments = ESPN::Arguments.new(args)
+        pattern = 'sports/:sport/:league/events/:id'
+        get(pattern, arguments.options).sports.first.leagues.first.events
       end
 
     end

data/lib/espn/client/sports.rb

@@ -1,25 +1,31 @@
 module ESPN
   class Client
+
+    # Public: The mapping to the SPORTS API of the ESPN developer API.
+    #
+    # Examples
+    #
+    #   class Client
+    #     include ESPN::Client::Sports
+    #   end
     module Sports
 
       # Public: Get sports and leagues supported in 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).
+      # sport   - A Symbol or String of the sport (optional).
+      # league  - A Symbol or String of the league. If a league is passed, but
+      #           not a sport, an attempt will be made to map the league to a
+      #           sport (required).
+      # opts    - Hash options used to refine the selection. If sport and/or
+      #           league are passed in, they will override the mapped values
+      #           You can find a full list of options on the ESPN developer API
+      #           website (default: {}).
       #
       # 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)
+      def sports(*args)
+        arguments = ESPN::Arguments.new(args)
+        pattern = 'sports/:sport/:league'
+        get(pattern, arguments.options).sports
       end
 
     end

data/lib/espn/client/standings.rb

@@ -1,27 +1,31 @@
 module ESPN
   class Client
+
+    # Public: The mapping to the STANDINGS API of the ESPN developer API.
+    #
+    # Examples
+    #
+    #   class Client
+    #     include ESPN::Client::Standings
+    #   end
     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).
+      # sport   - A Symbol or String of the sport (optional).
+      # league  - A Symbol or String of the league. If a league is passed, but
+      #           not a sport, an attempt will be made to map the league to a
+      #           sport (required).
+      # opts    - Hash options used to refine the selection. If sport and/or
+      #           league are passed in, they will override the mapped values
+      #           You can find a full list of options on the ESPN developer API
+      #           website (default: {}).
       #
       # 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)
+      def standings(*args)
+        arguments = ESPN::Arguments.new(args, {}, [:league])
+        pattern = 'sports/:sport/:league/standings'
+        get(pattern, arguments.options).sports.first.leagues.first.groups
       end
 
     end

data/lib/espn/client/teams.rb

@@ -1,32 +1,50 @@
 module ESPN
   class Client
+
+    # Public: The mapping to the TEAMS API of the ESPN developer API.
+    #
+    # Examples
+    #
+    #   class Client
+    #     include ESPN::Client::Teams
+    #   end
     module Teams
 
+      # Public: Get a specific team from the ESPN API.
+      #
+      # id      - An id of a team.
+      # sport   - A Symbol or String of the sport (optional).
+      # league  - A Symbol or String of the league. If a league is passed, but
+      #           not a sport, an attempt will be made to map the league to a
+      #           sport (required).
+      # opts    - Hash options used to refine the selection. If sport and/or
+      #           league are passed in, they will override the mapped values
+      #           You can find a full list of options on the ESPN developer API
+      #           website (default: {}).
+      #
+      # Returns a Hashie::Mash.
+      def team(id, *args)
+        arguments = ESPN::Arguments.new(args, {}, [:league])
+        pattern = "sports/:sport/:league/teams/#{id}"
+        get(pattern, arguments.options).sports.first.leagues.first.teams.first
+      end
+
       # Public: Get sport team 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).
-      #       - :team_id  - The id of the team (default: nil).
+      # sport   - A Symbol or String of the sport (optional).
+      # league  - A Symbol or String of the league. If a league is passed, but
+      #           not a sport, an attempt will be made to map the league to a
+      #           sport (required).
+      # opts    - Hash options used to refine the selection. If sport and/or
+      #           league are passed in, they will override the mapped values
+      #           You can find a full list of options on the ESPN developer API
+      #           website (default: {}).
       #
       # 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)
+      def teams(*args)
+        arguments = ESPN::Arguments.new(args, {}, [:league])
+        pattern = 'sports/:sport/:league/teams'
+        get(pattern, arguments.options).sports.first.leagues.first.teams
       end
 
     end

data/lib/espn/client/video.rb

@@ -1,28 +1,25 @@
 module ESPN
   class Client
+
+    # Public: The mapping to the VIDEO API of the ESPN developer API.
+    #
+    # Examples
+    #
+    #   class Client
+    #     include ESPN::Client::Video
+    #   end
     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).
+      # channel_id  - The id of a video channel.
+      # opts        - Hash options used to refine the selection (default: {}).
+      #               :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)
+      def videos(channel_id, opts={})
+        pattern = "video/channels/#{channel_id}/clips/:clip_id"
+        get(pattern, opts).channels
       end
 
     end

data/lib/espn/configuration.rb

@@ -14,9 +14,30 @@ module ESPN
   module Configuration
 
     # Public: Array of all configuration options for an ESPN::Client.
-    VALID_OPTIONS_KEYS = [:adapter, :api_version, :proxy, :api_key, :timeout,
+    VALID_OPTIONS_KEYS = [:adapter, :api_version, :api_key, :proxy, :timeout,
                           :open_timeout, :user_agent].freeze
 
+    # Public: Gets/Sets the Symbol adapter.
+    attr_accessor :adapter
+
+    # Public: Gets/Sets the Fixnum api version.
+    attr_accessor :api_version
+
+    # Public: Gets/Sets the String api key.
+    attr_accessor :api_key
+
+    # Public: Gets/Sets the Fixnum open timeout.
+    attr_accessor :open_timeout
+
+    # Public: Gets/Sets the String proxy.
+    attr_accessor :proxy
+
+    # Public: Gets/Sets the Fixnum timeout.
+    attr_accessor :timeout
+
+    # Public: Gets/Sets the String user agent.
+    attr_accessor :user_agent
+
     # Public: The default adapter used for requests.
     DEFAULT_ADAPTER         = Faraday.default_adapter
 
@@ -29,10 +50,6 @@ module ESPN
     # 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.
@@ -64,13 +81,13 @@ module ESPN
     #
     # Returns nothing.
     def reset
-      self.adapter                = DEFAULT_ADAPTER
-      self.api_version            = DEFAULT_API_VERSION
-      self.user_agent             = DEFAULT_USER_AGENT
-      self.timeout                = DEFAULT_TIMEOUT
-      self.open_timeout           = DEFAULT_TIMEOUT
-      self.api_key                = nil
-      self.proxy                  = nil
+      self.adapter        = DEFAULT_ADAPTER
+      self.api_version    = DEFAULT_API_VERSION
+      self.user_agent     = DEFAULT_USER_AGENT
+      self.timeout        = DEFAULT_TIMEOUT
+      self.open_timeout   = DEFAULT_TIMEOUT
+      self.api_key        = nil
+      self.proxy          = nil
     end
   end
 end