kappa 1.0.1 → 1.0.2

data/lib/kappa/team.rb

@@ -1,132 +1,132 @@
-require 'cgi'
-require 'time'
-
-module Twitch::V2
-  # Teams are an organization of channels.
-  # @see Teams#get Teams#get
-  # @see Teams#all Teams#all
-  # @see Teams
-  # @see Channel
-  class Team
-    include Twitch::IdEquality
-    
-    # @private
-    def initialize(hash)
-      @id = hash['_id']
-      @info = hash['info']
-      @background_url = hash['background']
-      @banner_url = hash['banner']
-      @logo_url = hash['logo']
-      @name = hash['name']
-      @display_name = hash['display_name']
-      @updated_at = Time.parse(hash['updated_at']).utc
-      @created_at = Time.parse(hash['created_at']).utc
-
-      name = CGI.escape(@name)
-      @url = "http://www.twitch.tv/team/#{name}"
-    end
-
-    # @example
-    #   12
-    # @return [Fixnum] Unique Twitch ID.
-    attr_reader :id
-
-    # @example
-    #   "TeamLiquid is awesome. and esports. video games. \n\n"
-    # @return [String] Info about the team. This is displayed on the team's page and can contain HTML.
-    attr_reader :info
-
-    # @example
-    #   "http://static-cdn.jtvnw.net/jtv_user_pictures/team-eg-background_image-da36973b6d829ac6.png"
-    # @return [String] URL for background image.
-    attr_reader :background_url
-
-    # @example
-    #   "http://static-cdn.jtvnw.net/jtv_user_pictures/team-eg-banner_image-1ad9c4738f4698b1-640x125.png"
-    # @return [String] URL for banner image.
-    attr_reader :banner_url
-
-    # @example
-    #   "http://static-cdn.jtvnw.net/jtv_user_pictures/team-eg-team_logo_image-9107b874d4c3fc3b-300x300.jpeg"
-    # @return [String] URL for the logo image.
-    attr_reader :logo_url
-
-    # @example
-    #   "teamliquid"
-    # @see #display_name
-    # @return [String] Unique Twitch name.
-    attr_reader :name
-
-    # @example
-    #   "TeamLiquid"
-    # @see #name
-    # @return [String] User-friendly display name. This name is used for the team's page title.
-    attr_reader :display_name
-
-    # @example
-    #   2013-05-24 00:17:10 UTC
-    # @return [Time] When the team was last updated (UTC).
-    attr_reader :updated_at
-
-    # @example
-    #   2011-10-27 01:00:44 UTC
-    # @return [Time] When the team was created (UTC).
-    attr_reader :created_at
-
-    # @example
-    #   "http://www.twitch.tv/team/teamliquid"
-    # @return [String] URL for the team's Twitch landing page.
-    attr_reader :url
-  end
-
-  # Query class for finding all active teams.
-  # @see Team
-  class Teams
-    # @private
-    def initialize(query)
-      @query = query
-    end
-
-    # Get a team by name.
-    # @example
-    #   Twitch.teams.get('teamliquid')
-    # @param team_name [String] The name of the team to get.
-    # @return [Team] A valid `Team` object if the team exists, `nil` otherwise.
-    # @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/teams.md#get-teamsteam GET /teams/:team
-    def get(team_name)
-      name = CGI.escape(team_name)
-      Twitch::Status.map(404 => nil) do
-        json = @query.connection.get("teams/#{name}")
-        Team.new(json)
-      end
-    end
-
-    # Get the list of all active teams.
-    # @example
-    #   Twitch.teams.all
-    # @example
-    #   Twitch.teams.all(:limit => 10)
-    # @example
-    #   Twitch.teams do |team|
-    #     next if (Time.now - team.updated_at) > (60 * 60 * 24)
-    #     puts team.url
-    #   end
-    # @param options [Hash] Filter criteria.
-    # @option options [Fixnum] :limit (nil) Limit on the number of results returned.
-    # @yield Optional. If a block is given, each team is yielded.
-    # @yieldparam [Team] team Current team.
-    # @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/teams.md#get-teams GET /teams
-    # @return [Array<Team>] All active teams, if no block is given.
-    # @return [nil] If a block is given.
-    def all(options = {}, &block)
-      return @query.connection.accumulate(
-        :path => 'teams',
-        :json => 'teams',
-        :create => Team,
-        :limit => options[:limit],
-        :offset => options[:offset],
-        &block
-      )
-    end
-  end
-end
+require 'cgi'
+require 'time'
+
+module Twitch::V2
+  # Teams are an organization of channels.
+  # @see Teams#get Teams#get
+  # @see Teams#all Teams#all
+  # @see Teams
+  # @see Channel
+  class Team
+    include Twitch::IdEquality
+    
+    # @private
+    def initialize(hash)
+      @id = hash['_id']
+      @info = hash['info']
+      @background_url = hash['background']
+      @banner_url = hash['banner']
+      @logo_url = hash['logo']
+      @name = hash['name']
+      @display_name = hash['display_name']
+      @updated_at = Time.parse(hash['updated_at']).utc
+      @created_at = Time.parse(hash['created_at']).utc
+
+      name = CGI.escape(@name)
+      @url = "http://www.twitch.tv/team/#{name}"
+    end
+
+    # @example
+    #   12
+    # @return [Fixnum] Unique Twitch ID.
+    attr_reader :id
+
+    # @example
+    #   "TeamLiquid is awesome. and esports. video games. \n\n"
+    # @return [String] Info about the team. This is displayed on the team's page and can contain HTML.
+    attr_reader :info
+
+    # @example
+    #   "http://static-cdn.jtvnw.net/jtv_user_pictures/team-eg-background_image-da36973b6d829ac6.png"
+    # @return [String] URL for background image.
+    attr_reader :background_url
+
+    # @example
+    #   "http://static-cdn.jtvnw.net/jtv_user_pictures/team-eg-banner_image-1ad9c4738f4698b1-640x125.png"
+    # @return [String] URL for banner image.
+    attr_reader :banner_url
+
+    # @example
+    #   "http://static-cdn.jtvnw.net/jtv_user_pictures/team-eg-team_logo_image-9107b874d4c3fc3b-300x300.jpeg"
+    # @return [String] URL for the logo image.
+    attr_reader :logo_url
+
+    # @example
+    #   "teamliquid"
+    # @see #display_name
+    # @return [String] Unique Twitch name.
+    attr_reader :name
+
+    # @example
+    #   "TeamLiquid"
+    # @see #name
+    # @return [String] User-friendly display name. This name is used for the team's page title.
+    attr_reader :display_name
+
+    # @example
+    #   2013-05-24 00:17:10 UTC
+    # @return [Time] When the team was last updated (UTC).
+    attr_reader :updated_at
+
+    # @example
+    #   2011-10-27 01:00:44 UTC
+    # @return [Time] When the team was created (UTC).
+    attr_reader :created_at
+
+    # @example
+    #   "http://www.twitch.tv/team/teamliquid"
+    # @return [String] URL for the team's Twitch landing page.
+    attr_reader :url
+  end
+
+  # Query class for finding all active teams.
+  # @see Team
+  class Teams
+    # @private
+    def initialize(query)
+      @query = query
+    end
+
+    # Get a team by name.
+    # @example
+    #   Twitch.teams.get('teamliquid')
+    # @param team_name [String] The name of the team to get.
+    # @return [Team] A valid `Team` object if the team exists, `nil` otherwise.
+    # @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/teams.md#get-teamsteam GET /teams/:team
+    def get(team_name)
+      name = CGI.escape(team_name)
+      Twitch::Status.map(404 => nil) do
+        json = @query.connection.get("teams/#{name}")
+        Team.new(json)
+      end
+    end
+
+    # Get the list of all active teams.
+    # @example
+    #   Twitch.teams.all
+    # @example
+    #   Twitch.teams.all(:limit => 10)
+    # @example
+    #   Twitch.teams do |team|
+    #     next if (Time.now - team.updated_at) > (60 * 60 * 24)
+    #     puts team.url
+    #   end
+    # @param options [Hash] Filter criteria.
+    # @option options [Fixnum] :limit (nil) Limit on the number of results returned.
+    # @yield Optional. If a block is given, each team is yielded.
+    # @yieldparam [Team] team Current team.
+    # @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/teams.md#get-teams GET /teams
+    # @return [Array<Team>] All active teams, if no block is given.
+    # @return [nil] If a block is given.
+    def all(options = {}, &block)
+      return @query.connection.accumulate(
+        :path => 'teams',
+        :json => 'teams',
+        :create => Team,
+        :limit => options[:limit],
+        :offset => options[:offset],
+        &block
+      )
+    end
+  end
+end

data/lib/kappa/user.rb

@@ -1,159 +1,159 @@
-require 'cgi'
-require 'time'
-
-module Twitch::V2
-  # These are members of the Twitch community who have a Twitch account. If broadcasting,
-  # they can own a stream that they can broadcast on their channel. If mainly viewing,
-  # they might follow or subscribe to channels.
-  # @see Users#get Users#get
-  # @see Users
-  # @see Channel
-  # @see Stream
-  class User
-    include Twitch::IdEquality
-
-    # @private
-    def initialize(hash, query)
-      @query = query
-      @id = hash['_id']
-      @created_at = Time.parse(hash['created_at']).utc
-      @display_name = hash['display_name']
-      @logo_url = hash['logo']
-      @name = hash['name']
-      @staff = hash['staff'] || false
-      @updated_at = Time.parse(hash['updated_at']).utc
-    end
-
-    # Get the `Channel` associated with this user.
-    # @note This incurs an additional web request.
-    # @return [Channel] The `Channel` associated with this user, or `nil` if this is a Justin.tv account.
-    # @see Channel#get Channel#get
-    def channel
-      @query.channels.get(@name)
-    end
-
-    # Get the live stream associated with this user.
-    # @note This incurs an additional web request.
-    # @return [Stream] Live stream object for this user, or `nil` if the user is not currently streaming.
-    # @see #streaming?
-    def stream
-      @query.streams.get(@name)
-    end
-
-    # Is this user currently streaming?
-    # @note This makes a separate request to get the user's stream. If you want to actually use the stream object, you should call `#stream` instead.
-    # @return [Boolean] `true` if the user currently has a live stream, `false` otherwise.
-    # @see #stream
-    def streaming?
-      !stream.nil?
-    end
-
-    # @return [Boolean] `true` if the user is a member of the Twitch.tv staff, `false` otherwise.
-    def staff?
-      @staff
-    end
-
-    # Get the channels the user is currently following.
-    # @example
-    #   user.following(:limit => 10)
-    # @example
-    #   user.following do |channel|
-    #     next if channel.game_name !~ /starcraft/i
-    #     puts channel.display_name
-    #   end
-    # @param options [Hash] Filter criteria.
-    # @option options [Fixnum] :limit (nil) Limit on the number of results returned.
-    # @option options [Fixnum] :offset (0) Offset into the result set to begin enumeration.
-    # @yield Optional. If a block is given, each followed channel is yielded.
-    # @yieldparam [Channel] channel Current channel.
-    # @see #following?
-    # @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/follows.md#get-usersuserfollowschannels GET /users/:user/follows/channels
-    # @return [Array<Channel>] Channels the user is currently following, if no block is given.
-    # @return [nil] If a block is given.
-    def following(options = {}, &block)
-      name = CGI.escape(@name)
-      return @query.connection.accumulate(
-        :path => "users/#{name}/follows/channels",
-        :json => 'follows',
-        :sub_json => 'channel',
-        :create => -> hash { Channel.new(hash, @query) },
-        :limit => options[:limit],
-        :offset => options[:offset],
-        &block
-      )
-    end
-
-    # @param target [String, Channel, User, Stream, #name] The name of the channel to check.
-    # @return [Boolean] `true` if the user is following the channel, `false` otherwise.
-    # @see #following
-    # @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/follows.md#get-usersuserfollowschannelstarget GET /users/:user/follows/channels/:target
-    def following?(target)
-      name = if target.respond_to?(:name)
-        target.name
-      else
-        target.to_s
-      end
-
-      user_name = CGI.escape(@name)
-      channel_name = CGI.escape(name)
-
-      Twitch::Status.map(404 => false) do
-        @query.connection.get("users/#{user_name}/follows/channels/#{channel_name}")
-        true
-      end
-    end
-
-    # @example
-    #   23945610 
-    # @return [Fixnum] Unique Twitch ID.
-    attr_reader :id
-
-    # @example
-    #   2011-08-08 21:03:44 UTC
-    # @return [Time] When the user account was created (UTC).
-    attr_reader :created_at
-
-    # @example
-    #   2013-07-19 23:51:43 UTC
-    # @return [Time] When the user account was last updated (UTC).
-    attr_reader :updated_at
-
-    # @example
-    #   "LAGTVMaximusBlack"
-    # @return [String] User-friendly display name.
-    attr_reader :display_name
-
-    # @example
-    #   "http://static-cdn.jtvnw.net/jtv_user_pictures/lagtvmaximusblack-profile_image-4b77a2305f5d85c8-300x300.png"
-    # @return [String] URL for the logo image.
-    attr_reader :logo_url
-
-    # @example
-    #   "lagtvmaximusblack"
-    # @return [String] Unique Twitch name.
-    attr_reader :name
-  end
-
-  # Query class for finding users.
-  # @see User
-  class Users
-    # @private
-    def initialize(query)
-      @query = query
-    end
-
-    # Get a user by name.
-    # @example
-    #   Twitch.users.get('totalbiscuit')
-    # @param user_name [String] The name of the user to get. This is the same as the channel or stream name.
-    # @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/users.md#get-usersuser GET /users/:user
-    # @return [User] A valid `User` object if the user exists, `nil` otherwise.
-    def get(user_name)
-      name = CGI.escape(user_name)
-      Twitch::Status.map(404 => nil) do
-        json = @query.connection.get("users/#{name}")
-        User.new(json, @query)
-      end
-    end
-  end
-end
+require 'cgi'
+require 'time'
+
+module Twitch::V2
+  # These are members of the Twitch community who have a Twitch account. If broadcasting,
+  # they can own a stream that they can broadcast on their channel. If mainly viewing,
+  # they might follow or subscribe to channels.
+  # @see Users#get Users#get
+  # @see Users
+  # @see Channel
+  # @see Stream
+  class User
+    include Twitch::IdEquality
+
+    # @private
+    def initialize(hash, query)
+      @query = query
+      @id = hash['_id']
+      @created_at = Time.parse(hash['created_at']).utc
+      @display_name = hash['display_name']
+      @logo_url = hash['logo']
+      @name = hash['name']
+      @staff = hash['staff'] || false
+      @updated_at = Time.parse(hash['updated_at']).utc
+    end
+
+    # Get the `Channel` associated with this user.
+    # @note This incurs an additional web request.
+    # @return [Channel] The `Channel` associated with this user, or `nil` if this is a Justin.tv account.
+    # @see Channel#get Channel#get
+    def channel
+      @query.channels.get(@name)
+    end
+
+    # Get the live stream associated with this user.
+    # @note This incurs an additional web request.
+    # @return [Stream] Live stream object for this user, or `nil` if the user is not currently streaming.
+    # @see #streaming?
+    def stream
+      @query.streams.get(@name)
+    end
+
+    # Is this user currently streaming?
+    # @note This makes a separate request to get the user's stream. If you want to actually use the stream object, you should call `#stream` instead.
+    # @return [Boolean] `true` if the user currently has a live stream, `false` otherwise.
+    # @see #stream
+    def streaming?
+      !stream.nil?
+    end
+
+    # @return [Boolean] `true` if the user is a member of the Twitch.tv staff, `false` otherwise.
+    def staff?
+      @staff
+    end
+
+    # Get the channels the user is currently following.
+    # @example
+    #   user.following(:limit => 10)
+    # @example
+    #   user.following do |channel|
+    #     next if channel.game_name !~ /starcraft/i
+    #     puts channel.display_name
+    #   end
+    # @param options [Hash] Filter criteria.
+    # @option options [Fixnum] :limit (nil) Limit on the number of results returned.
+    # @option options [Fixnum] :offset (0) Offset into the result set to begin enumeration.
+    # @yield Optional. If a block is given, each followed channel is yielded.
+    # @yieldparam [Channel] channel Current channel.
+    # @see #following?
+    # @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/follows.md#get-usersuserfollowschannels GET /users/:user/follows/channels
+    # @return [Array<Channel>] Channels the user is currently following, if no block is given.
+    # @return [nil] If a block is given.
+    def following(options = {}, &block)
+      name = CGI.escape(@name)
+      return @query.connection.accumulate(
+        :path => "users/#{name}/follows/channels",
+        :json => 'follows',
+        :sub_json => 'channel',
+        :create => -> hash { Channel.new(hash, @query) },
+        :limit => options[:limit],
+        :offset => options[:offset],
+        &block
+      )
+    end
+
+    # @param target [String, Channel, User, Stream, #name] The name of the channel to check.
+    # @return [Boolean] `true` if the user is following the channel, `false` otherwise.
+    # @see #following
+    # @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/follows.md#get-usersuserfollowschannelstarget GET /users/:user/follows/channels/:target
+    def following?(target)
+      name = if target.respond_to?(:name)
+        target.name
+      else
+        target.to_s
+      end
+
+      user_name = CGI.escape(@name)
+      channel_name = CGI.escape(name)
+
+      Twitch::Status.map(404 => false) do
+        @query.connection.get("users/#{user_name}/follows/channels/#{channel_name}")
+        true
+      end
+    end
+
+    # @example
+    #   23945610 
+    # @return [Fixnum] Unique Twitch ID.
+    attr_reader :id
+
+    # @example
+    #   2011-08-08 21:03:44 UTC
+    # @return [Time] When the user account was created (UTC).
+    attr_reader :created_at
+
+    # @example
+    #   2013-07-19 23:51:43 UTC
+    # @return [Time] When the user account was last updated (UTC).
+    attr_reader :updated_at
+
+    # @example
+    #   "LAGTVMaximusBlack"
+    # @return [String] User-friendly display name.
+    attr_reader :display_name
+
+    # @example
+    #   "http://static-cdn.jtvnw.net/jtv_user_pictures/lagtvmaximusblack-profile_image-4b77a2305f5d85c8-300x300.png"
+    # @return [String] URL for the logo image.
+    attr_reader :logo_url
+
+    # @example
+    #   "lagtvmaximusblack"
+    # @return [String] Unique Twitch name.
+    attr_reader :name
+  end
+
+  # Query class for finding users.
+  # @see User
+  class Users
+    # @private
+    def initialize(query)
+      @query = query
+    end
+
+    # Get a user by name.
+    # @example
+    #   Twitch.users.get('totalbiscuit')
+    # @param user_name [String] The name of the user to get. This is the same as the channel or stream name.
+    # @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/users.md#get-usersuser GET /users/:user
+    # @return [User] A valid `User` object if the user exists, `nil` otherwise.
+    def get(user_name)
+      name = CGI.escape(user_name)
+      Twitch::Status.map(404 => nil) do
+        json = @query.connection.get("users/#{name}")
+        User.new(json, @query)
+      end
+    end
+  end
+end