twitch-api 0.3.0 → 1.0.0

data/lib/twitch/response.rb

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 module Twitch
   # A compiled response from the API.
   class Response
+    extend Forwardable
+    def_delegators :@http_response, :body, :success?
+
     # The requested data.
     attr_reader :data
     # A total amount of entities.
@@ -10,10 +15,10 @@ module Twitch
     # Usually contains the keys start_date and end_date.
     # Applies to select endpoints.
     attr_reader :date_range
-    # A hash containing a pagination token. 
+    # A hash containing a pagination token.
     # Access it with
     #    pagination['cursor']
-    # Applies to select endpoints. 
+    # Applies to select endpoints.
     attr_reader :pagination
     # The total amount of calls that can be used in
     # the rate limit period (one minute by default).
@@ -25,34 +30,52 @@ module Twitch
     # The total amount of clips that can be created in
     # the clip rate limit period (currently unknown).
     attr_reader :clip_rate_limit
-    # The remaining amount of clips that can be created in 
-    # the clip rate limit period. 
+    # The remaining amount of clips that can be created in
+    # the clip rate limit period.
     attr_reader :clip_rate_limit_remaining
     # The HTTP raw response
     attr_reader :raw
 
-    def initialize(data_class, res)
-      http_res = res[:http_res]
-      @raw = http_res if res[:with_raw]
+    def initialize(data_class, http_response:)
+      @http_response = http_response
+      @raw = @http_response
+
+      @data = parse_data data_class
+
+      parse_rate_limits
+
+      @pagination = body['pagination']
+      @total = body['total']
+      @date_range = body['date_range']
+    end
+
+    private
 
-      @data = http_res.body['data'].map { |d| data_class.new(d) }
+    def parse_data(data_class)
+      raw_data = body['data']
+      return raw_data unless data_class
 
-      rate_limit_headers = Hash[http_res.headers.select do |k,v|
-        k.to_s.downcase.match(/^ratelimit/)
-      end.map { |k,v| [k.gsub('ratelimit-', '').to_sym, v] }]
+      if raw_data.is_a?(Array)
+        raw_data.map { |data_element| data_class.new(data_element) }
+      else
+        data_class.new(raw_data)
+      end
+    end
 
+    def parse_rate_limits
       @rate_limit = rate_limit_headers[:limit].to_i
       @rate_limit_remaining = rate_limit_headers[:remaining].to_i
       @rate_limit_resets_at = Time.at(rate_limit_headers[:reset].to_i)
 
-      if rate_limit_headers.keys.any? { |k| k.to_s.start_with?('helixclipscreation') }
-        @clip_rate_limit = rate_limit_headers[:'helixclipscreation-limit']
-        @clip_rate_limit_remaining = rate_limit_headers[:'helixclipscreation-remaining']
-      end
+      @clip_rate_limit = rate_limit_headers[:'helixclipscreation-limit']
+      @clip_rate_limit_remaining = rate_limit_headers[:'helixclipscreation-remaining']
+    end
 
-      @pagination = http_res.body['pagination']
-      @total = http_res.body['total']
-      @date_range = http_res.body['date_range']
+    def rate_limit_headers
+      @rate_limit_headers ||=
+        @http_response.headers
+          .select { |key, _value| key.to_s.downcase.match(/^ratelimit/) }
+          .transform_keys { |key| key.gsub('ratelimit-', '').to_sym }
     end
   end
-end
+end

data/lib/twitch/stream.rb

@@ -1,17 +1,20 @@
-require "time"
+# frozen_string_literal: true
+
+require 'time'
 
 module Twitch
   # A user's broadcasting session.
   class Stream
-    # Fields to be converted from ISO 8601 string to a typed date.
-    DATE_ATTRIBUTES = [:started_at]
-    
     # ID of the stream.
     attr_reader :id
     # ID of the user broadcasting.
     attr_reader :user_id
+    # Username of the user broadcasting.
+    attr_reader :user_name
     # ID of the game being broadcast.
     attr_reader :game_id
+    # Name of the game being broadcast.
+    attr_reader :game_name
     # Associated community IDs for the broadcaster.
     attr_reader :community_ids
     # The type of broadcast
@@ -27,16 +30,13 @@ module Twitch
     attr_reader :language
     # URL of the latest thumbnail image for the broadcast.
     attr_reader :thumbnail_url
-
+    # Ids of tags on the live stream
+    attr_reader :tag_ids
 
     def initialize(attributes = {})
-      attributes.each do |k, v|
-        if DATE_ATTRIBUTES.include?(k.to_sym)
-          instance_variable_set("@#{k}", Time.parse(v))
-        else
-          instance_variable_set("@#{k}", v)
-        end
+      attributes.each do |key, value|
+        instance_variable_set "@#{key}", value
       end
     end
   end
-end
+end

data/lib/twitch/stream_marker.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Twitch
+  # A point of time in a stream VOD that was marked while it is live.
+  class StreamMarker
+    # ID of the stream marker.
+    attr_reader :id
+    # Date at which the stream marker was created.
+    attr_reader :created_at
+    # Description of the stream marker.
+    attr_reader :description
+    # Elapsed time in the VOD in seconds at which the stream marker was created.
+    attr_reader :position_seconds
+    # URL pointing to the video and timestamp of the stream marker.
+    # Not returned upon creation.
+    attr_reader :url
+
+    def initialize(attributes = {})
+      @id = attributes['id']
+      @created_at = attributes['created_at']
+      @description = attributes['description']
+      @position_seconds = attributes['position_seconds']
+      @url = attributes['URL']
+    end
+  end
+
+  # The response envelope for the "Get Stream Markers" endpoint.
+  class StreamMarkerResponse
+    attr_reader :user_id, :user_name, :videos
+
+    def initialize(attributes = {})
+      @user_id = attributes['user_id']
+      @user_name = attributes['user_name']
+      @videos = attributes['videos'].map { |video| VideoStreamMarkers.new(video) }
+    end
+  end
+
+  # A video with a list of markers.
+  class VideoStreamMarkers
+    attr_reader :video_id, :markers
+
+    def initialize(attributes = {})
+      @video_id = attributes['video_id']
+      @markers = attributes['markers'].map { |marker| StreamMarker.new(marker) }
+    end
+  end
+end

data/lib/twitch/stream_metadata.rb

@@ -1,29 +1,43 @@
+# frozen_string_literal: true
+
 module Twitch
   # A set of metadata to provide additional information about a
-  # game being streamed.  
+  # game being streamed.
   # Additional getters are assigned at initialization time, e.g.
   #    self.hearthstone
-  # has data when Hearthstone is being streamed.  
+  # has data when Hearthstone is being streamed.
   # Other games may be included, but will be set to nil
   # if they aren't the game currently being streamed.
   class StreamMetadata
     # ID of the streaming user.
     attr_reader :user_id
-    # ID of the game being playead.
+    # Display name of the streaming user.
+    attr_reader :user_name
+    # ID of the game being played.
     attr_reader :game_id
 
     def initialize(attributes = {})
-      @user_id = attributes['user_id']
-      @game_id = attributes['game_id']
-
-      # Since more games can be supported in the future,
-      # this will ensure they will all be available.
-      attributes.each do |k, v|
-        unless instance_variables.include?("@#{k}".to_sym)
-          self.class.send(:attr_reader, k.to_sym)
-          instance_variable_set("@#{k}", v)
-        end
-      end
+      @attributes = attributes
+
+      @user_id = @attributes['user_id']
+      @user_name = @attributes['user_name']
+      @game_id = @attributes['game_id']
+    end
+
+    # Since more games can be supported in the future,
+    # this will ensure they will all be available.
+    def method_missing(name, *args)
+      name = name.to_s
+
+      return super unless @attributes.key?(name)
+
+      @attributes[name]
+    end
+
+    def respond_to_missing?(name)
+      name = name.to_s
+
+      @attributes.key?(name) ? true : super
     end
   end
-end
+end

data/lib/twitch/subscription.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Twitch
+  # A user's voluntary contribution to a streamer
+  class Subscription
+    # ID of the user being subscribed to.
+    attr_reader :broadcaster_id
+    # Username of the user being subscribed to.
+    attr_reader :broadcaster_name
+    # Whether the subscription was received as a gift.
+    attr_reader :is_gift
+    # Tier of the subscription.
+    # 1000 = Tier 1, 2000 = Tier 2, 3000 = Tier 3
+    attr_reader :tier
+    # Descriptive name of the subscription.
+    attr_reader :plan_name
+    # ID of the subscribing user.
+    attr_reader :user_id
+    # Username of the subscribing user.
+    attr_reader :user_name
+
+    def initialize(attributes = {})
+      attributes.each do |key, value|
+        instance_variable_set "@#{key}", value
+      end
+    end
+  end
+end

data/lib/twitch/user.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module Twitch
+  # Data object for Twitch users
   class User
     # ID of the user.
     attr_reader :id
@@ -10,7 +13,7 @@ module Twitch
     # (global mod, admin, staff)
     attr_reader :type
     # Represents a special broadcaster role of a user.
-    # (partner, affilaite)
+    # (partner, affiliate)
     attr_reader :broadcaster_type
     # Description/biographical info of a user.
     attr_reader :description
@@ -21,10 +24,12 @@ module Twitch
     attr_reader :offline_image_url
     # Total number of visits to the user's stream page.
     attr_reader :view_count
+    # The UTC date and time that the user’s account was created. The timestamp is in RFC3339 format.
+    attr_reader :created_at
 
     def initialize(attributes = {})
-      attributes.each do |k, v|
-        instance_variable_set("@#{k}", v)
+      attributes.each do |key, value|
+        instance_variable_set "@#{key}", value
       end
     end
   end

data/lib/twitch/user_ban.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Twitch
+  # Ban information for a user.
+  class UserBan
+    # Fields to be converted from ISO 8601 string to a typed date.
+    DATE_ATTRIBUTES = %i[expires_at].freeze
+
+    # ID of the banned/timed-out user.
+    attr_reader :user_id
+    # Username of the banned/timed-out user.
+    attr_reader :user_name
+    # Date of when the time-out will expire (nil for permanent bans)
+    attr_reader :expires_at
+
+    def initialize(attributes = {})
+      attributes.each do |key, value|
+        if DATE_ATTRIBUTES.include?(key.to_sym)
+          instance_variable_set "@#{key}", Time.parse(value)
+        else
+          instance_variable_set "@#{key}", value
+        end
+      end
+    end
+  end
+end

data/lib/twitch/user_follow.rb

@@ -1,17 +1,25 @@
+# frozen_string_literal: true
+
 module Twitch
   # Represents a relationship of one user following another.
   class UserFollow
     # User ID of the *following* user.
     attr_reader :from_id
+    # Display name of the *following* user.
+    attr_reader :from_name
     # User ID of the *followed* user.
     attr_reader :to_id
+    # User name of the *followed* user.
+    attr_reader :to_name
     # Date at which the follow action was performed.
     attr_reader :followed_at
 
     def initialize(attributes = {})
       @from_id = attributes['from_id']
+      @from_name = attributes['from_name']
       @to_id = attributes['to_id']
-      @followed_at = Time.iso8601(attributes['followed_at'])
+      @to_name = attributes['to_name']
+      @followed_at = attributes['followed_at']
     end
   end
-end
+end

data/lib/twitch/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module Twitch
   # Library version.
-  VERSION = "0.3.0"
+  VERSION = '1.0.0'
 end

data/lib/twitch/video.rb

@@ -1,10 +1,10 @@
-require "time"
+# frozen_string_literal: true
+
+require 'time'
 
 module Twitch
   # A captured broadcast or portion of a broadcast.
   class Video
-    DATE_ATTRIBUTES = [:created_at, :published_at]
-
     # ID of the video.
     attr_reader :id
     # Title of the video.
@@ -13,7 +13,7 @@ module Twitch
     attr_reader :description
     # Language of the video.
     attr_reader :language
-    # Number of views 
+    # Number of views
     attr_reader :view_count
     # Date the video was created.
     attr_reader :created_at
@@ -27,21 +27,17 @@ module Twitch
     attr_reader :url
     # ID of the user who uploaded/broadcasted the video.
     attr_reader :user_id
+    # Display name of the user who uploaded/broadcasted the video.
+    attr_reader :user_name
     # Viewability of the video (public or private)
     attr_reader :viewable
-    # Duration of the video, in the format
-    # 0h0m0s
+    # Duration of the video, in the format `0h0m0s`
     attr_reader :duration
 
     def initialize(attributes = {})
-      attributes.each do |k, v|
-        if DATE_ATTRIBUTES.include?(k.to_sym)
-          instance_variable_set("@#{k}", Time.parse(v))
-        else
-          instance_variable_set("@#{k}", v)
-        end
+      attributes.each do |key, value|
+        instance_variable_set("@#{key}", value)
       end
     end
-    
   end
 end

data/lib/twitch-api.rb

@@ -1,5 +1,4 @@
-require "twitch/version"
-require "twitch/client"
+# frozen_string_literal: true
 
-module Twitch
-end
+require_relative 'twitch/version'
+require_relative 'twitch/client'

metadata

@@ -1,150 +1,131 @@
 --- !ruby/object:Gem::Specification
 name: twitch-api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Maurice Wahba
-autorequire: 
-bindir: exe
+- Alexander Popov
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2018-06-17 00:00:00.000000000 Z
+date: 2023-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.12.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.12.2
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: faraday-parse_dates
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
+        version: 0.1.1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: faraday-retry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :development
+        version: '2.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: twitch_oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
+        version: 0.5.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-description: 
+        version: 0.5.0
+description:
 email:
 - maurice.wahba@gmail.com
+- alex.wayfer@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/twitch-api.rb
 - lib/twitch/api_error.rb
+- lib/twitch/automod_message_status.rb
 - lib/twitch/bits_leader.rb
+- lib/twitch/category.rb
+- lib/twitch/channel.rb
+- lib/twitch/cheermote.rb
+- lib/twitch/cheermote_tier.rb
+- lib/twitch/cheermote_tier_image.rb
+- lib/twitch/cheermote_tier_images.rb
 - lib/twitch/client.rb
+- lib/twitch/client/custom_rewards.rb
+- lib/twitch/client/extensions.rb
+- lib/twitch/client/games.rb
+- lib/twitch/client/moderation.rb
+- lib/twitch/client/streams.rb
+- lib/twitch/client/subscriptions.rb
+- lib/twitch/client/users.rb
 - lib/twitch/clip.rb
+- lib/twitch/custom_reward.rb
+- lib/twitch/editor.rb
 - lib/twitch/entitlement_grant_url.rb
+- lib/twitch/extension.rb
+- lib/twitch/extensions_by_types.rb
 - lib/twitch/game.rb
 - lib/twitch/game_analytic.rb
+- lib/twitch/moderation_event.rb
+- lib/twitch/moderator.rb
+- lib/twitch/redemption.rb
 - lib/twitch/response.rb
 - lib/twitch/stream.rb
+- lib/twitch/stream_marker.rb
 - lib/twitch/stream_metadata.rb
+- lib/twitch/subscription.rb
 - lib/twitch/user.rb
+- lib/twitch/user_ban.rb
 - lib/twitch/user_follow.rb
 - lib/twitch/version.rb
 - lib/twitch/video.rb
-- twitch-api.gemspec
 homepage: https://github.com/mauricew/ruby-twitch-api
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/mauricew/ruby-twitch-api/issues
+  documentation_uri: http://www.rubydoc.info/gems/twitch-api/1.0.0
+  homepage_uri: https://github.com/mauricew/ruby-twitch-api
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/mauricew/ruby-twitch-api
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -152,16 +133,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.7'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.1
-signing_key: 
+rubygems_version: 3.4.17
+signing_key:
 specification_version: 4
 summary: Ruby client for the Twitch Helix API.
 test_files: []

data/.gitignore

@@ -1,17 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-Gemfile.lock
-.ruby-version
-.ruby-gemset

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper