kappa 1.0.1 → 1.0.2

data/lib/kappa/version.rb

@@ -1,3 +1,3 @@
-module Twitch
-  VERSION = '1.0.1'
-end
+module Twitch
+  VERSION = '1.0.2'
+end

data/lib/kappa/video.rb

@@ -1,229 +1,229 @@
-require 'cgi'
-require 'time'
-
-module Twitch::V2
-  # @private
-  class ChannelProxy
-    def initialize(name, display_name, query)
-      @name = name
-      @display_name = display_name
-      @query = query
-    end
-
-    attr_reader :name
-    attr_reader :display_name
-
-    include Proxy
-
-    proxy {
-      @query.channels.get(@name)
-    }
-  end
-
-  # Videos are broadcasts or highlights owned by a channel. Broadcasts are unedited
-  # videos that are saved after a streaming session. Highlights are videos edited from
-  # broadcasts by the channel's owner.
-  # @see Videos#get Videos#get
-  # @see Videos#top Videos#top
-  # @see Videos
-  # @see Channel
-  class Video
-    include Twitch::IdEquality
-
-    # @private
-    def initialize(hash, query)
-      @id = hash['_id']
-      @title = hash['title']
-      @recorded_at = Time.parse(hash['recorded_at']).utc
-      @url = hash['url']
-      @view_count = hash['views']
-      @description = hash['description']
-      @length = hash['length']
-      @game_name = hash['game']
-      @preview_url = hash['preview']
-      @embed_html = hash['embed']
-
-      @channel = ChannelProxy.new(
-        hash['channel']['name'],
-        hash['channel']['display_name'],
-        query
-      )
-    end
-
-    # @note This is a `String`, not a `Fixnum` like most other object IDs.
-    # @example
-    #   "a396294648"
-    # @return [String] Unique Twitch ID for this video.
-    attr_reader :id
-
-    # @example
-    #   "DreamHack Open Stockholm 26-27 April"
-    # @return [String] Title of this video. This is seen on the video's page.
-    attr_reader :title
-
-    # @example
-    #   2013-04-27 09:37:30 UTC
-    # @return [Time] When this video was recorded (UTC).
-    attr_reader :recorded_at
-
-    # @example
-    #   "http://www.twitch.tv/dreamhacktv/b/396294648"
-    # @return [String] URL of this video on Twitch.
-    attr_reader :url
-
-    # @example
-    #   81754
-    # @return [Fixnum] The number of views this video has received all-time.
-    attr_reader :view_count
-
-    # @return [String] Description of this video.
-    attr_reader :description
-
-    # @example
-    #   4205 # (1 hour, 10 minutes, 5 seconds)
-    # @return [Fixnum] The length of this video (seconds).
-    attr_reader :length
-
-    # @example
-    #   "StarCraft II: Heart of the Swarm"
-    # @return [String] The name of the game played in this video.
-    attr_reader :game_name
-
-    # @example
-    #   "http://static-cdn.jtvnw.net/jtv.thumbs/archive-396294648-320x240.jpg"
-    # @return [String] URL of a preview screenshot taken from the video stream.
-    attr_reader :preview_url
-
-    # @return [Channel] The channel on which this video was originally streamed.
-    attr_reader :channel
-
-    # @example
-    #   "<object data='http://www.twitch.tv/widgets/archive_embed_player.swf'>...</object>"
-    # @return [String] HTML code for embedding this video on a web page.
-    attr_reader :embed_html
-  end
-
-  # Query class for finding videos.
-  # @see Video
-  class Videos
-    # @private
-    def initialize(query)
-      @query = query
-    end
-
-    # Get a video by ID.
-    # @example
-    #   Twitch.videos.get('a396294648')
-    # @param id [String] The ID of the video to get.
-    # @raise [ArgumentError] If `id` is `nil` or empty.
-    # @return [Video] A valid `Video` object if the video exists, `nil` otherwise.
-    def get(id)
-      raise ArgumentError, 'id' if !id || id.strip.empty?
-
-      id = CGI.escape(id)
-      Twitch::Status.map(404 => nil) do
-        json = @query.connection.get("videos/#{id}")
-        Video.new(json, @query)
-      end
-    end
-
-    # Get the list of most popular videos based on view count.
-    # @note The number of videos returned is potentially very large, so it's recommended that you specify a `:limit`.
-    # @example
-    #   Twitch.videos.top
-    # @example
-    #   Twitch.videos.top(:period => :month, :game => 'Super Meat Boy')
-    # @example
-    #   Twitch.videos.top(:period => :all, :limit => 10)
-    # @example
-    #   Twitch.videos.top(:period => :all) do |video|
-    #     next if video.view_count < 10000
-    #     puts video.url
-    #   end
-    # @param options [Hash] Filter criteria.
-    # @option options [Symbol] :period (:week) Return videos only in this time period. Valid values are `:week`, `:month`, `:all`.
-    # @option options [String] :game (nil) Return videos only for this game.
-    # @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 top video is yielded.
-    # @yieldparam [Video] video Current video.
-    # @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/videos.md#get-videostop GET /videos/top
-    # @raise [ArgumentError] If `:period` is not one of `:week`, `:month`, or `:all`.
-    # @return [Array<Video>] Top videos, if no block is given.
-    # @return [nil] If a block is given.
-    def top(options = {}, &block)
-      params = {}
-
-      if options[:game]
-        params[:game] = options[:game]
-      end
-
-      period = options[:period] || :week
-      if ![:week, :month, :all].include?(period)
-        raise ArgumentError, 'period'
-      end
-
-      params[:period] = period.to_s
-
-      return @query.connection.accumulate(
-        :path => 'videos/top',
-        :params => params,
-        :json => 'videos',
-        :create => -> hash { Video.new(hash, @query) },
-        :limit => options[:limit],
-        :offset => options[:offset],
-        &block
-      )
-    end
-
-    # Get the videos for a channel, most recently created first.
-    # @example
-    #   v = Twitch.videos.for_channel('dreamhacktv')
-    # @example
-    #   v = Twitch.videos.for_channel('dreamhacktv', :type => :highlights, :limit => 10)
-    # @example
-    #   Twitch.videos.for_channel('dreamhacktv') do |video|
-    #     next if video.view_count < 10000
-    #     puts video.url
-    #   end
-    # @param options [Hash] Filter criteria.
-    # @option options [Symbol] :type (:highlights) The type of videos to return. Valid values are `:broadcasts`, `:highlights`.
-    # @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 video is yielded.
-    # @yieldparam [Video] video Current video.
-    # @see Channel#videos Channel#videos
-    # @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/videos.md#get-channelschannelvideos GET /channels/:channel/videos
-    # @raise [ArgumentError] If `:type` is not one of `:broadcasts` or `:highlights`.
-    # @return [Array<Video>] Videos for the channel, if no block is given.
-    # @return [nil] If a block is given.
-    def for_channel(channel, options = {})
-      if channel.respond_to?(:name)
-        channel_name = channel.name
-      else
-        channel_name = channel.to_s
-      end
-
-      params = {}
-
-      type = options[:type] || :highlights
-      if !type.nil?
-        if ![:broadcasts, :highlights].include?(type)
-          raise ArgumentError, 'type'
-        end
-
-        params[:broadcasts] = (type == :broadcasts)
-      end
-
-      name = CGI.escape(channel_name)
-      return @query.connection.accumulate(
-        :path => "channels/#{name}/videos",
-        :params => params,
-        :json => 'videos',
-        :create => -> hash { Video.new(hash, @query) },
-        :limit => options[:limit],
-        :offset => options[:offset]
-      )
-    end
-  end
-end
+require 'cgi'
+require 'time'
+
+module Twitch::V2
+  # @private
+  class ChannelProxy
+    def initialize(name, display_name, query)
+      @name = name
+      @display_name = display_name
+      @query = query
+    end
+
+    attr_reader :name
+    attr_reader :display_name
+
+    include Proxy
+
+    proxy {
+      @query.channels.get(@name)
+    }
+  end
+
+  # Videos are broadcasts or highlights owned by a channel. Broadcasts are unedited
+  # videos that are saved after a streaming session. Highlights are videos edited from
+  # broadcasts by the channel's owner.
+  # @see Videos#get Videos#get
+  # @see Videos#top Videos#top
+  # @see Videos
+  # @see Channel
+  class Video
+    include Twitch::IdEquality
+
+    # @private
+    def initialize(hash, query)
+      @id = hash['_id']
+      @title = hash['title']
+      @recorded_at = Time.parse(hash['recorded_at']).utc
+      @url = hash['url']
+      @view_count = hash['views']
+      @description = hash['description']
+      @length = hash['length']
+      @game_name = hash['game']
+      @preview_url = hash['preview']
+      @embed_html = hash['embed']
+
+      @channel = ChannelProxy.new(
+        hash['channel']['name'],
+        hash['channel']['display_name'],
+        query
+      )
+    end
+
+    # @note This is a `String`, not a `Fixnum` like most other object IDs.
+    # @example
+    #   "a396294648"
+    # @return [String] Unique Twitch ID for this video.
+    attr_reader :id
+
+    # @example
+    #   "DreamHack Open Stockholm 26-27 April"
+    # @return [String] Title of this video. This is seen on the video's page.
+    attr_reader :title
+
+    # @example
+    #   2013-04-27 09:37:30 UTC
+    # @return [Time] When this video was recorded (UTC).
+    attr_reader :recorded_at
+
+    # @example
+    #   "http://www.twitch.tv/dreamhacktv/b/396294648"
+    # @return [String] URL of this video on Twitch.
+    attr_reader :url
+
+    # @example
+    #   81754
+    # @return [Fixnum] The number of views this video has received all-time.
+    attr_reader :view_count
+
+    # @return [String] Description of this video.
+    attr_reader :description
+
+    # @example
+    #   4205 # (1 hour, 10 minutes, 5 seconds)
+    # @return [Fixnum] The length of this video (seconds).
+    attr_reader :length
+
+    # @example
+    #   "StarCraft II: Heart of the Swarm"
+    # @return [String] The name of the game played in this video.
+    attr_reader :game_name
+
+    # @example
+    #   "http://static-cdn.jtvnw.net/jtv.thumbs/archive-396294648-320x240.jpg"
+    # @return [String] URL of a preview screenshot taken from the video stream.
+    attr_reader :preview_url
+
+    # @return [Channel] The channel on which this video was originally streamed.
+    attr_reader :channel
+
+    # @example
+    #   "<object data='http://www.twitch.tv/widgets/archive_embed_player.swf'>...</object>"
+    # @return [String] HTML code for embedding this video on a web page.
+    attr_reader :embed_html
+  end
+
+  # Query class for finding videos.
+  # @see Video
+  class Videos
+    # @private
+    def initialize(query)
+      @query = query
+    end
+
+    # Get a video by ID.
+    # @example
+    #   Twitch.videos.get('a396294648')
+    # @param id [String] The ID of the video to get.
+    # @raise [ArgumentError] If `id` is `nil` or empty.
+    # @return [Video] A valid `Video` object if the video exists, `nil` otherwise.
+    def get(id)
+      raise ArgumentError, 'id' if !id || id.strip.empty?
+
+      id = CGI.escape(id)
+      Twitch::Status.map(404 => nil) do
+        json = @query.connection.get("videos/#{id}")
+        Video.new(json, @query)
+      end
+    end
+
+    # Get the list of most popular videos based on view count.
+    # @note The number of videos returned is potentially very large, so it's recommended that you specify a `:limit`.
+    # @example
+    #   Twitch.videos.top
+    # @example
+    #   Twitch.videos.top(:period => :month, :game => 'Super Meat Boy')
+    # @example
+    #   Twitch.videos.top(:period => :all, :limit => 10)
+    # @example
+    #   Twitch.videos.top(:period => :all) do |video|
+    #     next if video.view_count < 10000
+    #     puts video.url
+    #   end
+    # @param options [Hash] Filter criteria.
+    # @option options [Symbol] :period (:week) Return videos only in this time period. Valid values are `:week`, `:month`, `:all`.
+    # @option options [String] :game (nil) Return videos only for this game.
+    # @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 top video is yielded.
+    # @yieldparam [Video] video Current video.
+    # @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/videos.md#get-videostop GET /videos/top
+    # @raise [ArgumentError] If `:period` is not one of `:week`, `:month`, or `:all`.
+    # @return [Array<Video>] Top videos, if no block is given.
+    # @return [nil] If a block is given.
+    def top(options = {}, &block)
+      params = {}
+
+      if options[:game]
+        params[:game] = options[:game]
+      end
+
+      period = options[:period] || :week
+      if ![:week, :month, :all].include?(period)
+        raise ArgumentError, 'period'
+      end
+
+      params[:period] = period.to_s
+
+      return @query.connection.accumulate(
+        :path => 'videos/top',
+        :params => params,
+        :json => 'videos',
+        :create => -> hash { Video.new(hash, @query) },
+        :limit => options[:limit],
+        :offset => options[:offset],
+        &block
+      )
+    end
+
+    # Get the videos for a channel, most recently created first.
+    # @example
+    #   v = Twitch.videos.for_channel('dreamhacktv')
+    # @example
+    #   v = Twitch.videos.for_channel('dreamhacktv', :type => :highlights, :limit => 10)
+    # @example
+    #   Twitch.videos.for_channel('dreamhacktv') do |video|
+    #     next if video.view_count < 10000
+    #     puts video.url
+    #   end
+    # @param options [Hash] Filter criteria.
+    # @option options [Symbol] :type (:highlights) The type of videos to return. Valid values are `:broadcasts`, `:highlights`.
+    # @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 video is yielded.
+    # @yieldparam [Video] video Current video.
+    # @see Channel#videos Channel#videos
+    # @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/videos.md#get-channelschannelvideos GET /channels/:channel/videos
+    # @raise [ArgumentError] If `:type` is not one of `:broadcasts` or `:highlights`.
+    # @return [Array<Video>] Videos for the channel, if no block is given.
+    # @return [nil] If a block is given.
+    def for_channel(channel, options = {})
+      if channel.respond_to?(:name)
+        channel_name = channel.name
+      else
+        channel_name = channel.to_s
+      end
+
+      params = {}
+
+      type = options[:type] || :highlights
+      if !type.nil?
+        if ![:broadcasts, :highlights].include?(type)
+          raise ArgumentError, 'type'
+        end
+
+        params[:broadcasts] = (type == :broadcasts)
+      end
+
+      name = CGI.escape(channel_name)
+      return @query.connection.accumulate(
+        :path => "channels/#{name}/videos",
+        :params => params,
+        :json => 'videos',
+        :create => -> hash { Video.new(hash, @query) },
+        :limit => options[:limit],
+        :offset => options[:offset]
+      )
+    end
+  end
+end