twitch-api 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13fa554e6376acacd400d0aad2e651d295c613297df4476ba7c1736b6e7640aa
-  data.tar.gz: 6e180eab8e7061535821922cbc6ad4c4b35e867096314a7ddf564704ea32882c
+  metadata.gz: a0d26f1ad1f75eb33986d6ffeee5df987d9d1f9a5a6806bdca9a8b1adfd0e127
+  data.tar.gz: 453ec71c27d902598bdb86e4365b18eede4e4b817d51fd9ab9a1f6229eda0513
 SHA512:
-  metadata.gz: 7b45c4f07f653c77e3058579dac055efbcb2b1664fe1c68f63caf3715bfd8471a318bacc2d6ec49f072d0fee7686b7d72313c939e26c0e8a8bbd888137611e1a
-  data.tar.gz: c29bf47c2020a2b2617d1f6a54b7fda59b0544c165c5787fcbba92963dc11eeaeee2149640e8bbcaa86a4b1eca7551050d82d40ca1d6657543c8647f511f4a40
+  metadata.gz: 8f9077115a63b251d9d8762bcf1f036697417c93b0ecf2d2002aea9f41b6bb92daa6f1a692a14e938549b70c669cd84da2b2a39dcaa50002e812d6547bde4c4c
+  data.tar.gz: 814370a51c612759743b24b12e51de46a26e3b080bafb5ff00e2a50293e69e6a4a941d9e61ad648f8143cf0e7577fa8c3c1626ea56bedc66e6b21568caa177d8

data/.travis.yml

@@ -1,9 +1,9 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.7
-  - 2.4.4
-  - 2.5.1
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
 env:
   - TWITCH_CLIENT_ID=test
 before_install: gem install bundler -v 1.16.0

data/lib/twitch/bits_leader.rb

@@ -3,6 +3,8 @@ module Twitch
   class BitsLeader
     # ID of the user giving bits.
     attr_reader :user_id
+    # Display name of the user giving bits.
+    attr_reader :user_name
     # Ranking of the user giving bits.
     # Reflects the parent object's date range.
     attr_reader :rank
@@ -11,6 +13,7 @@ module Twitch
 
     def initialize(attributes = {})
       @user_id = attributes['user_id']
+      @user_name = attributes['user_name']
       @rank = attributes['rank']
       @score = attributes['score']
     end

data/lib/twitch/client.rb

@@ -9,6 +9,7 @@ require "twitch/entitlement_grant_url"
 require "twitch/game"
 require "twitch/game_analytic"
 require "twitch/stream"
+require "twitch/stream_marker"
 require "twitch/stream_metadata"
 require "twitch/user"
 require "twitch/user_follow"
@@ -65,6 +66,10 @@ Unpredictable behavior may follow.})
       Response.new(EntitlementGrantUrl, post('entitlements/upload', options))
     end
 
+    def create_stream_marker(options = {})
+      Response.new(StreamMarker, post('streams/markers', options))
+    end
+
     def get_clips(options = {})
       Response.new(Clip, get('clips', options))
     end
@@ -85,6 +90,10 @@ Unpredictable behavior may follow.})
       Response.new(GameAnalytic, get('analytics/games', options))
     end
 
+    def get_stream_markers(options = {})
+      Response.new(StreamMarkerResponse, get('streams/markers', options))
+    end
+
     def get_streams(options = {})
       Response.new(Stream, get('streams', options))
     end

data/lib/twitch/clip.rb

@@ -20,10 +20,14 @@ module Twitch
     attr_reader :view_count
     # Language of the originating broadcast.
     attr_reader :language
-    # (User) ID of the clip's source broadcast.
+    # (User) ID of the clip's source broadcaster.
     attr_reader :broadcaster_id
+    # (User) name of the clip's source broadcaster
+    attr_reader :broadcaster_name
     # (User) ID of the clip's creator.
     attr_reader :creator_id
+    # (User) name of the clip's creator.
+    attr_reader :creator_name
     # ID of the game being played.
     attr_reader :game_id
     # ID of the archived broadcast (may not be available).

data/lib/twitch/stream.rb

@@ -5,11 +5,13 @@ module Twitch
   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
     # Associated community IDs for the broadcaster.
@@ -39,4 +41,4 @@ module Twitch
       end
     end
   end
-end
+end

data/lib/twitch/stream_marker.rb

@@ -0,0 +1,48 @@
+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 = Time.parse(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
+    attr_reader :user_name
+    attr_reader :videos
+
+    def initialize(attributes = {})
+      @user_id = attributes['user_id']
+      @user_name = attributes['user_name']
+      @videos = attributes['videos'].map { |v| VideoStreamMarkers.new(v) }
+    end
+  end
+
+  # A video with a list of markers.
+  class VideoStreamMarkers
+    attr_reader :video_id
+    attr_reader :markers
+
+    def initialize(attributes = {})
+      @video_id = attributes['video_id']
+      @markers = attributes['markers'].map{ |m| StreamMarker.new(m) }
+    end
+  end
+end

data/lib/twitch/stream_metadata.rb

@@ -9,11 +9,14 @@ module Twitch
   class StreamMetadata
     # ID of the streaming user.
     attr_reader :user_id
+    # Display name of the streaming user.
+    attr_reader :user_name
     # ID of the game being playead.
     attr_reader :game_id
 
     def initialize(attributes = {})
       @user_id = attributes['user_id']
+      @user_name = attributes['user_name']
       @game_id = attributes['game_id']
 
       # Since more games can be supported in the future,

data/lib/twitch/user_follow.rb

@@ -3,14 +3,20 @@ module Twitch
   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']
+      @to_name = attributes['to_name']
       @followed_at = Time.iso8601(attributes['followed_at'])
     end
   end

data/lib/twitch/version.rb

@@ -1,4 +1,4 @@
 module Twitch
   # Library version.
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/twitch/video.rb

@@ -27,6 +27,8 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitch-api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Maurice Wahba
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-17 00:00:00.000000000 Z
+date: 2019-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -134,6 +134,7 @@ files:
 - lib/twitch/game_analytic.rb
 - lib/twitch/response.rb
 - lib/twitch/stream.rb
+- lib/twitch/stream_marker.rb
 - lib/twitch/stream_metadata.rb
 - lib/twitch/user.rb
 - lib/twitch/user_follow.rb
@@ -160,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.1
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Ruby client for the Twitch Helix API.