kappa 0.2.0 → 0.3.0

data/lib/kappa/id_equality.rb

@@ -1,17 +1,17 @@
-module Kappa
-  # @private
-  module IdEquality
-    def hash
-      @id.hash
-    end
-
-    def eql?(other)
-      other && (self.class == other.class) && (self.id == other.id)
-    end
-
-    def ==(other)
-      eql?(other)
-    end
-  end
-end
-
+module Kappa
+  # @private
+  module IdEquality
+    def hash
+      @id.hash
+    end
+
+    def eql?(other)
+      other && (self.class == other.class) && (self.id == other.id)
+    end
+
+    def ==(other)
+      eql?(other)
+    end
+  end
+end
+

data/lib/kappa/images.rb

@@ -1,36 +1,34 @@
-module Kappa::V2
-  # A group of URLs pointing to variously-sized versions of the same image.
-  class Images
-    # @private
-    def initialize(hash)
-      @large_url = hash['large']
-      @medium_url = hash['medium']
-      @small_url = hash['small']
-      @template_url = hash['template']
-    end
-
-    # Get a URL pointing to an image with a specific size.
-    # @param width [Fixnum] Desired width of the image.
-    # @param height [Fixnum] Desired height of the image.
-    # @return [String] URL pointing to the image with the specified size.
-    def url(width, height)
-      @template_url.gsub('{width}', width.to_s).gsub('{height}', height.to_s)
-    end
-
-    # TODO: Add documentation notes about rough sizes for small, medium, large images.
-
-    # @return [String] URL for the large-sized version of this image.
-    attr_reader :large_url
-
-    # @return [String] URL for the medium-sized version of this image.
-    attr_reader :medium_url
-
-    # @return [String] URL for the small-sized version of this image.
-    attr_reader :small_url
-
-    # @note You shouldn't need to use this property directly. See #url for getting a formatted URL instead.
-    # @return [String] Template image URL with placeholders for width and height.
-    # @see #url
-    attr_reader :template_url
-  end
-end
+module Kappa::V2
+  # A group of URLs pointing to variously-sized versions of the same image.
+  class Images
+    # @private
+    def initialize(hash)
+      @large_url = hash['large']
+      @medium_url = hash['medium']
+      @small_url = hash['small']
+      @template_url = hash['template']
+    end
+
+    # Get a URL pointing to an image with a specific size.
+    # @param width [Fixnum] Desired width of the image.
+    # @param height [Fixnum] Desired height of the image.
+    # @return [String] URL pointing to the image with the specified size.
+    def url(width, height)
+      @template_url.gsub('{width}', width.to_s).gsub('{height}', height.to_s)
+    end
+
+    # @return [String] URL for the large-sized version of this image.
+    attr_reader :large_url
+
+    # @return [String] URL for the medium-sized version of this image.
+    attr_reader :medium_url
+
+    # @return [String] URL for the small-sized version of this image.
+    attr_reader :small_url
+
+    # @note You shouldn't need to use this property directly. See #url for getting a formatted URL instead.
+    # @return [String] Template image URL with placeholders for width and height.
+    # @see #url
+    attr_reader :template_url
+  end
+end

data/lib/kappa/proxy.rb

@@ -0,0 +1,32 @@
+# @private
+module Proxy
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def proxy(&create_block)
+      self.class_variable_set(:@@creator, create_block)
+    end
+  end
+
+  def method_missing(*args)
+    real.send(*args)
+  end
+
+  def respond_to?(sym, include_private = false)
+    real.respond_to?(sym, include_private) || super
+  end
+
+  def respond_to_missing?(method_name, include_private = false)
+    real.respond_to?(method_name, include_private) || super
+  end
+
+private
+  def real
+    @real ||= begin
+      creator = self.class.class_variable_get(:@@creator)
+      self.instance_eval(&creator)
+    end
+  end
+end

data/lib/kappa/stream.rb

@@ -1,175 +1,185 @@
-require 'cgi'
-
-module Kappa::V2
-  # Streams are video broadcasts that are currently live. They belong to a user and are part of a channel.
-  # @see .get Stream.get
-  # @see Streams
-  # @see Channel
-  class Stream
-    include Connection
-    include Kappa::IdEquality
-
-    # @private
-    def initialize(hash)
-      @id = hash['_id']
-      @broadcaster = hash['broadcaster']
-      @game_name = hash['game']
-      @name = hash['name']
-      @viewer_count = hash['viewers']
-      @preview_url = hash['preview']
-      @channel = Channel.new(hash['channel'])
-    end
-
-    # Get a live stream by name.
-    # @example
-    #   s = Stream.get('lagtvmaximusblack')
-    #   s.nil?          # => false (stream is live)
-    #   s.game_name     # => "StarCraft II: Heart of the Swarm"
-    #   s.viewer_count  # => 2403
-    # @example
-    #   s = Strearm.get('destiny')
-    #   s.nil?          # => true (stream is offline)
-    # @param stream_name [String] The name of the stream to get. This is the same as the channel or user name.
-    # @see Streams.find
-    # @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/streams.md#get-streamschannel GET /streams/:channel
-    # @return [Stream] A valid `Stream` object if the stream exists and is currently live, `nil` otherwise.
-    def self.get(stream_name)
-      encoded_name = CGI.escape(stream_name)
-      json = connection.get("streams/#{encoded_name}")
-      stream = json['stream']
-      if json['status'] == 404 || !stream
-        nil
-      else
-        new(stream)
-      end
-    end
-
-    # @return [Fixnum] Unique Twitch ID.
-    attr_reader :id
-
-    # @example
-    #   "fme", "xsplit", "obs"
-    # @return [String] The broadcasting software used for this stream.
-    attr_reader :broadcaster
-    
-    # @return [String] The name of the game currently being streamed.
-    attr_reader :game_name
-
-    # @return [String] The unique Twitch name for this stream.
-    attr_reader :name
-
-    # @return [Fixnum] The number of viewers currently watching the stream.
-    attr_reader :viewer_count
-
-    # @return [String] URL of a preview screenshot taken from the video stream.
-    attr_reader :preview_url
-
-    # @note This does not incur any web requests.
-    # @return [Channel] The `Channel` associated with this stream.
-    attr_reader :channel
-  end
-
-  # Query class used for finding featured streams or streams meeting certain criteria.
-  # @see Stream
-  class Streams
-    include Connection
-
-    # @private
-    # Private until implemented
-    def self.all
-      # TODO
-    end
-
-    # Get a list of streams for a specific game, for a set of channels, or by other criteria.
-    # @example
-    #   Streams.find(:game => 'League of Legends', :limit => 50)
-    # @example
-    #   Streams.find(:channel => ['fgtvlive', 'incontroltv', 'destiny'])
-    # @example
-    #   Streams.find(:game => 'Diablo III', :channel => ['nl_kripp', 'protech'])
-    # @param options [Hash] Search criteria.
-    # @option options [String/Game] :game Only return streams currently streaming the specified game.
-    # @option options [Array<String/Channel>] :channel Only return streams for these channels.
-    #   If a channel is not currently streaming, it is omitted. You must specify an array of channels
-    #   or channel names. If you want to find the stream for a single channel, see {Stream.get}.
-    # @option options [Boolean] :embeddable TODO
-    # @option options [Boolean] :hls TODO
-    # @option options [Fixnum] :limit (none) Limit on the number of results returned.
-    # @option options [Fixnum] :offset (0) Offset into the result set to begin enumeration.
-    # @see Stream.get
-    # @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/streams.md#get-streams GET /streams
-    # @raise [ArgumentError] If `options` does not specify a search criteria (`:game`, `:channel`, `:embeddable`, or `:hls`).
-    # @return [Array<Stream>] List of streams matching the specified criteria.
-    def self.find(options)
-      check = options.dup
-      check.delete(:limit)
-      check.delete(:offset)
-      raise ArgumentError if check.empty?
-
-      # TODO: Support Kappa::Vx::Game object for the :game param.
-      # TODO: Support Kappa::Vx::Channel object for the :channel param.
-
-      params = {}
-
-      if options[:channel]
-        params[:channel] = options[:channel].join(',')
-      end
-
-      if options[:game]
-        params[:game] = options[:game]
-      end
-
-      limit = options[:limit]
-      if limit && (limit < 100)
-        params[:limit] = limit
-      else
-        params[:limit] = 100
-        limit = 0
-      end
-
-      return connection.accumulate(
-        :path => 'streams',
-        :params => params,
-        :json => 'streams',
-        :class => Stream,
-        :limit => limit
-      )
-    end
-
-    # Get the list of currently featured (promoted) streams. This includes the list of streams shown on the Twitch homepage.
-    # @note There is no guarantee of how many streams are featured at any given time.
-    # @example
-    #   Streams.featured
-    # @example
-    #   Streams.featured(:limit => 5)
-    # @param options [Hash] Filter criteria.
-    # @option options [Boolean] :hls (false) TODO
-    # @option options [Fixnum] :limit (none) Limit on the number of results returned.
-    # @option options [Fixnum] :offset (0) Offset into the result set to begin enumeration.
-    # @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/streams.md#get-streamsfeatured GET /streams/featured
-    # @return [Array<Stream>] List of currently featured streams.
-    def self.featured(options = {})
-      params = {}
-
-      # TODO: Support :offset param
-      # TODO: Support :hls param
-
-      limit = options[:limit]
-      if limit && (limit < 100)
-        params[:limit] = limit
-      else
-        params[:limit] = 100
-        limit = 0
-      end
-
-      return connection.accumulate(
-        :path => 'streams/featured',
-        :params => params,
-        :json => 'featured',
-        :sub_json => 'stream',
-        :class => Stream,
-        :limit => limit
-      )
-    end
-  end
-end
+require 'cgi'
+
+module Kappa::V2
+  # Streams are video broadcasts that are currently live. They belong to a user and are part of a channel.
+  # @see .get Stream.get
+  # @see Streams
+  # @see Channel
+  class Stream
+    include Connection
+    include Kappa::IdEquality
+
+    # @private
+    def initialize(hash)
+      @id = hash['_id']
+      @broadcaster = hash['broadcaster']
+      @game_name = hash['game']
+      @name = hash['name']
+      @viewer_count = hash['viewers']
+      @preview_url = hash['preview']
+      @channel = Channel.new(hash['channel'])
+      @url = @channel.url
+    end
+
+    # Get a live stream by name.
+    # @example
+    #   s = Stream.get('lagtvmaximusblack')
+    #   s.nil?          # => false (stream is live)
+    #   s.game_name     # => "StarCraft II: Heart of the Swarm"
+    #   s.viewer_count  # => 2403
+    # @example
+    #   s = Strearm.get('destiny')
+    #   s.nil?          # => true (stream is offline)
+    # @param stream_name [String] The name of the stream to get. This is the same as the channel or user name.
+    # @see Streams.find
+    # @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/streams.md#get-streamschannel GET /streams/:channel
+    # @return [Stream] A valid `Stream` object if the stream exists and is currently live, `nil` otherwise.
+    def self.get(stream_name)
+      encoded_name = CGI.escape(stream_name)
+      json = connection.get("streams/#{encoded_name}")
+      stream = json['stream']
+      if json['status'] == 404 || !stream
+        nil
+      else
+        new(stream)
+      end
+    end
+
+    # Get the owner of this stream.
+    # @note This incurs an additional web request.
+    # @return [User] The user that owns this stream.
+    def user
+      User.get(@channel.name)
+    end
+
+    # @return [Fixnum] Unique Twitch ID.
+    attr_reader :id
+
+    # @example
+    #   "fme", "xsplit", "obs", "rebroadcast", "delay", "unknown rtmp"
+    # @deprecated This attribute will not be present in the V3 API.
+    # @return [String] The broadcasting software used for this stream.
+    attr_reader :broadcaster
+    
+    # @return [String] The name of the game currently being streamed.
+    attr_reader :game_name
+
+    # @return [String] The unique Twitch name for this stream.
+    attr_reader :name
+
+    # @return [Fixnum] The number of viewers currently watching the stream.
+    attr_reader :viewer_count
+
+    # @return [String] URL of a preview screenshot taken from the video stream.
+    attr_reader :preview_url
+
+    # @note This does not incur any web requests.
+    # @return [Channel] The `Channel` associated with this stream.
+    attr_reader :channel
+
+    # @return [String] The URL for this stream.
+    attr_reader :url
+  end
+
+  # Query class used for finding featured streams or streams meeting certain criteria.
+  # @see Stream
+  class Streams
+    include Connection
+
+    # Get a list of streams for a specific game, for a set of channels, or by other criteria.
+    # @example
+    #   Streams.find(:game => 'League of Legends', :limit => 50)
+    # @example
+    #   Streams.find(:channel => ['fgtvlive', 'incontroltv', 'destiny'])
+    # @example
+    #   Streams.find(:game => 'Diablo III', :channel => ['nl_kripp', 'protech'])
+    # @param options [Hash] Search criteria.
+    # @option options [String/Game/#name] :game Only return streams currently streaming the specified game.
+    # @option options [Array<String/Channel/#name>] :channel Only return streams for these channels.
+    #   If a channel is not currently streaming, it is omitted. You must specify an array of channels
+    #   or channel names. If you want to find the stream for a single channel, see {Stream.get}.
+    # @option options [Boolean] :embeddable (nil) If `true`, limit the streams to those that can be embedded. If `false` or `nil`, do not limit.
+    # @option options [Boolean] :hls (nil) If `true`, limit the streams to those using HLS (HTTP Live Streaming). If `false` or `nil`, do not limit.
+    # @option options [Fixnum] :limit (none) Limit on the number of results returned.
+    # @option options [Fixnum] :offset (0) Offset into the result set to begin enumeration.
+    # @see Stream.get
+    # @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/streams.md#get-streams GET /streams
+    # @raise [ArgumentError] If `options` does not specify a search criteria (`:game`, `:channel`, `:embeddable`, or `:hls`).
+    # @return [Array<Stream>] List of streams matching the specified criteria.
+    def self.find(options)
+      check = options.dup
+      check.delete(:limit)
+      check.delete(:offset)
+      raise ArgumentError, 'options' if check.empty?
+
+      params = {}
+
+      channels = options[:channel]
+      if channels
+        params[:channel] = channels.map { |channel|
+          if channel.respond_to?(:name)
+            channel.name
+          else
+            channel.to_s
+          end
+        }.join(',')
+      end
+
+      game = options[:game]
+      if game
+        if game.respond_to?(:name)
+          params[:game] = game.name
+        else
+          params[:game] = game.to_s
+        end
+      end
+
+      if options[:hls]
+        params[:hls] = true
+      end
+
+      if options[:embeddable]
+        params[:embeddable] = true
+      end
+
+      return connection.accumulate(
+        :path => 'streams',
+        :params => params,
+        :json => 'streams',
+        :class => Stream,
+        :limit => options[:limit],
+        :offset => options[:offset]
+      )
+    end
+
+    # Get the list of currently featured (promoted) streams. This includes the list of streams shown on the Twitch homepage.
+    # @note There is no guarantee of how many streams are featured at any given time.
+    # @example
+    #   Streams.featured
+    # @example
+    #   Streams.featured(:limit => 5)
+    # @param options [Hash] Filter criteria.
+    # @option options [Boolean] :hls (nil) If `true`, limit the streams to those using HLS (HTTP Live Streaming). If `false` or `nil`, do not limit.
+    # @option options [Fixnum] :limit (none) Limit on the number of results returned.
+    # @option options [Fixnum] :offset (0) Offset into the result set to begin enumeration.
+    # @see https://github.com/justintv/Twitch-API/blob/master/v2_resources/streams.md#get-streamsfeatured GET /streams/featured
+    # @return [Array<Stream>] List of currently featured streams.
+    def self.featured(options = {})
+      params = {}
+
+      if options[:hls]
+        params[:hls] = true
+      end
+
+      return connection.accumulate(
+        :path => 'streams/featured',
+        :params => params,
+        :json => 'featured',
+        :sub_json => 'stream',
+        :class => Stream,
+        :limit => options[:limit],
+        :offset => options[:offset]
+      )
+    end
+  end
+end