streamelements 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31160ff2ea22fd4ede0596df856320841537e8641f1578b12648ee9c9b918799
-  data.tar.gz: d2a0068938a6f62b62e627165945324e4a41fddc8c58a805dbfe64bb474f16a7
+  metadata.gz: f59098ef3eac1b544e2ddb657c0c3c5abd92df95ca5a7b0c6b1a6263055b0688
+  data.tar.gz: 45073cf8652ed336f7c872dcbc80e153d6d3e64416b19307cb8643c328b961bb
 SHA512:
-  metadata.gz: f368ed8782747b19f755d31500b2b0c2c1d4e30d6a52fe6ac98fefc427be720ea87afa0fd3d8b02481f75b7093d7da7801ffb93539de61822960d4ff9fa19918
-  data.tar.gz: 895c89c0e5f073caa1979d509014ea96146d109c9e443d7307968fb7f4f9449586d03e111576c20dc2ef92e040906474c54895623b3240e0bae99824af672947
+  metadata.gz: 753fd8a5d596772a72b9e80283b1ff79088db9f6f08d84423e9e3ca524d0d2c8077a0d781e3744fe9d54f40ec35616a5314428c2cae685f66a37bdf71afbef2b
+  data.tar.gz: 8d3dc3c12760aed80003adcc619ff1a207ecfeab5e01529ca697cbcb2ca78782028f4d25341475515ce4d484cf07cb5cc5130f74e93904c13ef9af23ba4d2b8d

data/README.md

@@ -14,28 +14,25 @@ gem "streamelements"
 
 ### Authentication
 
-Firstly you'll need to set either a JWT Token or an OAuth Access Token.
+Firstly you'll need to set a JWT Token and Channel ID.
 
 ```ruby
-# Set a JWT Token
-@client = StreamElements::Client.new(jwt_access_token: "")
-
-# Or set an OAuth Access Token
-@client = StreamElements::Client.new(access_token: "")
+StreamElements.configure do |config|
+  config.token = ENV["STREAMELEMENTS_JWT_TOKEN"]
+  config.channel = ENV["STREAMELEMENTS_CHANNEL_ID"]
+end
 ```
 
-Most of the API requires the Channel ID to be passed as an argument.
-
 ### Activities
 
 ```ruby
 # Retrieve a list of Activities
 # https://dev.streamelements.com/docs/api-docs/861a5d5450bbb-channel
-@client.activities.list(channel: "channel-id")
+StreamElements::Activity.list
 
 # Retrieve the Top Activities
 # https://dev.streamelements.com/docs/api-docs/2ce44d058b16b-channel-top
-@client.actvitities.top(channel: "channel-id")
+StreamElements::Activity.top
 ```
 
 ### Tips
@@ -43,44 +40,61 @@ Most of the API requires the Channel ID to be passed as an argument.
 ```ruby
 # Retrieve a list of Tips
 # https://dev.streamelements.com/docs/api-docs/704e5580be2d9-channel
-@client.tips.list(channel: "channel-id")
+StreamElements::Tip.list
 
 # Retrieve a Tip
-@client.tips.retrieve(channel: "channel-id", id: "tip-id")
+StreamElements::Tip.retrieve(id: "tip-id")
 
 # Retrieve the Tip Tips
 # https://dev.streamelements.com/docs/api-docs/b404f906817c4-channel-top
-@client.tips.top(channel: "channel-id")
+StreamElements::Tip.top
 ```
 
 ### Song Requests
 
 ```ruby
 # Retrieve the current playing song
-@client.song_requests.playing(channel: "channel-id")
+StreamElements::SongRequest.playing
 
 # Retrieve a list of songs in the queue
-@client.song_requests.queue(channel: "channel-id")
+StreamElements::SongRequest.queue
 
 # Retrieve a list of previous songs
-@client.song_requests.queue(channel: "channel-id")
+StreamElements::SongRequest.queue
 
 # Add a song to the queue
 # video is the YouTube video ID or URL
-@client.song_requests.add(channel: "channel-id", video: "video-id")
+StreamElements::SongRequest.add(video: "video-id")
 
 # Pause the player
-@client.song_requests.pause(channel: "channel-id")
+StreamElements::SongRequest.pause
 
 # Resume the player
-@client.song_requests.play(channel: "channel-id")
+StreamElements::SongRequest.play
 
 # Set the volume of the player
 # volume is a number between 0 and 100
-@client.song_requests.volume(channel: "channel-id", volume: 50)
+StreamElements::SongRequest.volume(volume: 50)
 
 # Skip the current song
-@client.song_requests.skip(channel: "channel-id")
+StreamElements::SongRequest.skip
+
+# Get the current song request settings
+StreamElements::SongRequest.settings
+
+# Set the current song request settings
+# settings is a hash of settings
+StreamElements::SongRequest.update_settings(settings: { max_requests: 5 })
+```
+
+### Users
+
+```ruby
+# Get the current user
+StreamElements::User.current
+
+# Get the users Channels
+StreamElements::User.channels
 ```
 
 ## Contributing

data/lib/stream_elements/client.rb

@@ -1,47 +1,74 @@
 module StreamElements
   class Client
-    BASE_URL = "https://api.streamelements.com/kappa/v2"
 
-    attr_reader :jwt_access_token, :access_token, :adapter
+    class << self
 
-    def initialize(jwt_access_token: nil, access_token: nil, adapter: Faraday.default_adapter)
-      @jwt_access_token = jwt_access_token
-      @access_token = access_token
-      @adapter = adapter
-    end
+      def connection
+        @connection ||= Faraday.new("https://api.streamelements.com/kappa/v2") do |conn|
+          conn.request :authorization, :Bearer, StreamElements.config.token
 
-    def activities
-      ActivitiesResource.new(self)
-    end
+          conn.headers = {
+            "User-Agent" => "streamelements/v#{VERSION} (github.com/deanpcmad/streamelements)"
+          }
 
-    def tips
-      TipsResource.new(self)
-    end
-
-    def song_requests
-      SongRequestsResource.new(self)
-    end
+          conn.request :json
 
-    def connection
-      @connection ||= Faraday.new(BASE_URL) do |conn|
-        if jwt_access_token
-          conn.request :authorization, :Bearer, jwt_access_token
-        elsif access_token
-          conn.request :authorization, :Bearer, access_token
-        else
-          raise Error, "You must provide a jwt or access token."
+          conn.response :json, content_type: "application/json"
         end
+      end
 
-        conn.headers = {
-          "User-Agent" => "streamelements/v#{VERSION} (github.com/deanpcmad/streamelements)"
-        }
 
-        conn.request :json
+      def get_request(url, params: {}, headers: {})
+        handle_response connection.get(replace_channel(url), params, headers)
+      end
 
-        conn.response :json, content_type: "application/json"
+      def post_request(url, body: {}, headers: {})
+        handle_response connection.post(replace_channel(url), body, headers)
+      end
+
+      def put_request(url, body: {}, headers: {})
+        handle_response connection.put(replace_channel(url), body, headers)
+      end
 
-        conn.adapter adapter, @stubs
+      def patch_request(url, body:, headers: {})
+        handle_response connection.patch(replace_channel(url), body, headers)
       end
+
+      def delete_request(url, headers: {})
+        handle_response connection.delete(replace_channel(url), headers)
+      end
+
+      def replace_channel(url)
+        url.gsub(":channel", StreamElements.config.channel)
+      end
+
+      def handle_response(response)
+        case response.status
+        when 400
+          raise Error, "Error 400: Your request was malformed. '#{response.body["error"]}'"
+        when 401
+          raise Error, "Error 401: You did not supply valid authentication credentials. '#{response.body["error"]}'"
+        when 403
+          raise Error, "Error 403: You are not allowed to perform that action. '#{response.body["error"]}'"
+        when 404
+          raise Error, "Error 404: No results were found for your request. '#{response.body["error"]}'"
+        when 409
+          raise Error, "Error 409: Your request was a conflict. '#{response.body["error"]}'"
+        when 429
+          raise Error, "Error 429: Your request exceeded the API rate limit. '#{response.body["error"]}'"
+        when 500
+          raise Error, "Error 500: We were unable to perform the request due to server-side problems. '#{response.body["error"]}'"
+        when 503
+          raise Error, "Error 503: You have been rate limited for sending more than 20 requests per second. '#{response.body["error"]}'"
+        when 501
+          raise Error, "Error 501: This resource has not been implemented. '#{response.body["error"]}'"
+        when 204
+          return true
+        end
+
+        response
+      end
+
     end
 
   end

data/lib/stream_elements/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module StreamElements
+  class Configuration
+
+    attr_accessor :token
+    attr_accessor :channel
+
+    def initialize
+    end
+
+  end
+end

data/lib/stream_elements/models/activity.rb

@@ -0,0 +1,21 @@
+module StreamElements
+  class Activity < Object
+
+    class << self
+
+      def list(after:, before:, limit:, types:, **params)
+        attrs = { after: after, before: before, limit: limit, types: types }.merge(params)
+        response = Client.get_request("activities/:channel", params: attrs)
+        Collection.from_response(response, type: Activity)
+      end
+
+      def top(period:, offset:, limit:, type:)
+        attrs = { period: period, offset: offset, limit: limit, type: type }
+        response = Client.get_request("activities/:channel/top", params: attrs)
+        # Collection.from_response(response, type: TopActivity)
+      end
+
+    end
+
+  end
+end

data/lib/stream_elements/{objects/top_tip.rb → models/channel.rb}

@@ -1,4 +1,4 @@
 module StreamElements
-  class TopTip < Object
+  class Channel < Object
   end
 end

data/lib/stream_elements/models/song_request.rb

@@ -0,0 +1,56 @@
+module StreamElements
+  class SongRequest < Object
+
+    class << self
+
+      def playing
+        SongRequest.new Client.get_request("songrequest/:channel/playing").body
+      end
+
+      def queue
+        response = Client.get_request("songrequest/:channel/queue")
+        Collection.from_response(response, type: SongRequest)
+      end
+
+      def history(**params)
+        response = Client.get_request("songrequest/:channel/history", params: params)
+        Collection.from_response(response, type: SongRequest, name: "history")
+      end
+
+      def settings
+        Client.get_request("songrequest/:channel/settings").body
+      end
+
+      def update_settings(settings:)
+        response = Client.put_request("songrequest/:channel/settings", body: settings)
+        response.success?
+      end
+
+      def add(video:)
+        SongRequest.new Client.post_request("songrequest/:channel/queue", body: { video: video }).body
+      end
+
+      def pause
+        response = Client.post_request("songrequest/:channel/player/pause", body: {})
+        response.success?
+      end
+
+      def play
+        response = Client.post_request("songrequest/:channel/player/play", body: {})
+        response.success?
+      end
+
+      def volume(volume:)
+        response = Client.post_request("songrequest/:channel/player/volume", body: {volume: volume})
+        response.success?
+      end
+
+      def skip
+        response = Client.post_request("songrequest/:channel/skip", body: {})
+        response.success?
+      end
+
+    end
+
+  end
+end

data/lib/stream_elements/models/tip.rb

@@ -0,0 +1,23 @@
+module StreamElements
+  class Tip < Object
+
+    class << self
+
+      def list(**params)
+        response = Client.get_request("tips/:channel", params: params)
+        Collection.from_response(response, type: Tip, name: "docs")
+      end
+
+      def retrieve(id:)
+        Tip.new Client.get_request("tips/:channel/#{id}").body
+      end
+
+      def top
+        response = Client.get_request("tips/:channel/top")
+        # Collection.from_response(response, type: TopTip)
+      end
+
+    end
+
+  end
+end

data/lib/stream_elements/models/user.rb

@@ -0,0 +1,19 @@
+module StreamElements
+  class User < Object
+
+    class << self
+
+      def current
+        response = Client.get_request("users/current")
+        User.new response.body
+      end
+
+      def channels
+        response = Client.get_request("users/channels")
+        Collection.from_response(response, type: Channel)
+      end
+
+    end
+
+  end
+end

data/lib/stream_elements/object.rb

@@ -3,6 +3,7 @@ require "ostruct"
 module StreamElements
   class Object < OpenStruct
     def initialize(attributes)
+      attributes["id"] = attributes.delete("_id") if attributes["_id"]
       super to_ostruct(attributes)
     end
 

data/lib/stream_elements/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StreamElements
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/stream_elements.rb

@@ -6,20 +6,28 @@ require "stream_elements/version"
 
 module StreamElements
 
+  autoload :Configuration, "stream_elements/configuration"
   autoload :Client, "stream_elements/client"
   autoload :Collection, "stream_elements/collection"
   autoload :Error, "stream_elements/error"
-  autoload :Resource, "stream_elements/resource"
   autoload :Object, "stream_elements/object"
 
-  autoload :ActivitiesResource, "stream_elements/resources/activities"
-  autoload :TipsResource, "stream_elements/resources/tips"
-  autoload :SongRequestsResource, "stream_elements/resources/song_requests"
+  class << self
+    attr_writer :config
+  end
 
-  autoload :Activity, "stream_elements/objects/activity"
-  autoload :TopActivity, "stream_elements/objects/top_activity"
-  autoload :Tip, "stream_elements/objects/tip"
-  autoload :TopTip, "stream_elements/objects/top_tip"
-  autoload :SongRequest, "stream_elements/objects/song_request"
+  def self.configure
+    yield(config) if block_given?
+  end
+
+  def self.config
+    @config ||= StreamElements::Configuration.new
+  end
+
+  autoload :Activity, "stream_elements/models/activity"
+  autoload :Tip, "stream_elements/models/tip"
+  autoload :SongRequest, "stream_elements/models/song_request"
+  autoload :User, "stream_elements/models/user"
+  autoload :Channel, "stream_elements/models/channel"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: streamelements
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Dean Perry
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-09 00:00:00.000000000 Z
+date: 2023-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,17 +38,14 @@ files:
 - lib/stream_elements.rb
 - lib/stream_elements/client.rb
 - lib/stream_elements/collection.rb
+- lib/stream_elements/configuration.rb
 - lib/stream_elements/error.rb
+- lib/stream_elements/models/activity.rb
+- lib/stream_elements/models/channel.rb
+- lib/stream_elements/models/song_request.rb
+- lib/stream_elements/models/tip.rb
+- lib/stream_elements/models/user.rb
 - lib/stream_elements/object.rb
-- lib/stream_elements/objects/activity.rb
-- lib/stream_elements/objects/song_request.rb
-- lib/stream_elements/objects/tip.rb
-- lib/stream_elements/objects/top_activity.rb
-- lib/stream_elements/objects/top_tip.rb
-- lib/stream_elements/resource.rb
-- lib/stream_elements/resources/activities.rb
-- lib/stream_elements/resources/song_requests.rb
-- lib/stream_elements/resources/tips.rb
 - lib/stream_elements/version.rb
 - lib/streamelements.rb
 - sig/streamelements.rbs
@@ -71,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby library for the StreamElements API

data/lib/stream_elements/objects/activity.rb

@@ -1,10 +0,0 @@
-module StreamElements
-  class Activity < Object
-
-    def initialize(attributes = {})
-      attributes["id"] = attributes.delete("_id") if attributes["_id"]
-      super
-    end
-
-  end
-end

data/lib/stream_elements/objects/song_request.rb

@@ -1,10 +0,0 @@
-module StreamElements
-  class SongRequest < Object
-
-    def initialize(attributes = {})
-      attributes["id"] = attributes.delete("_id") if attributes["_id"]
-      super
-    end
-
-  end
-end

data/lib/stream_elements/objects/tip.rb

@@ -1,10 +0,0 @@
-module StreamElements
-  class Tip < Object
-
-    def initialize(attributes = {})
-      attributes["id"] = attributes.delete("_id") if attributes["_id"]
-      super
-    end
-
-  end
-end

data/lib/stream_elements/objects/top_activity.rb

@@ -1,4 +0,0 @@
-module StreamElements
-  class TopActivity < Object
-  end
-end

data/lib/stream_elements/resource.rb

@@ -1,58 +0,0 @@
-module StreamElements
-  class Resource
-    attr_reader :client
-
-    def initialize(client)
-      @client = client
-    end
-
-    private
-
-    def get_request(url, params: {}, headers: {})
-      handle_response client.connection.get(url, params, headers)
-    end
-
-    def post_request(url, body:, headers: {})
-      handle_response client.connection.post(url, body, headers)
-    end
-
-    def patch_request(url, body:, headers: {})
-      handle_response client.connection.patch(url, body, headers)
-    end
-
-    def put_request(url, body:, headers: {})
-      handle_response client.connection.put(url, body, headers)
-    end
-
-    def delete_request(url, params: {}, headers: {})
-      handle_response client.connection.delete(url, params, headers)
-    end
-
-    def handle_response(response)
-      case response.status
-      when 400
-        raise Error, "Error 400: Your request was malformed. '#{response.body["message"]}'"
-      when 401
-        raise Error, "Error 401: You did not supply valid authentication credentials. '#{response.body["error"]}'"
-      when 403
-        raise Error, "Error 403: You are not allowed to perform that action. '#{response.body["error"]}'"
-      when 404
-        raise Error, "Error 404: No results were found for your request. '#{response.body["error"]}'"
-      when 409
-        raise Error, "Error 409: Your request was a conflict. '#{response.body["message"]}'"
-      when 422
-        raise Error, "Error 422: Unprocessable Entity. '#{response.body["message"]}"
-      when 429
-        raise Error, "Error 429: Your request exceeded the API rate limit. '#{response.body["error"]}'"
-      when 500
-        raise Error, "Error 500: We were unable to perform the request due to server-side problems. '#{response.body["error"]}'"
-      when 503
-        raise Error, "Error 503: You have been rate limited for sending more than 20 requests per second. '#{response.body["error"]}'"
-      when 204
-        return true
-      end
-
-      response
-    end
-  end
-end

data/lib/stream_elements/resources/activities.rb

@@ -1,17 +0,0 @@
-module StreamElements
-  class ActivitiesResource < Resource
-
-    def list(channel:, after:, before:, limit:, types:, **params)
-      attrs = { after: after, before: before, limit: limit, types: types }.merge(params)
-      response = get_request("activities/#{channel}", params: attrs)
-      Collection.from_response(response, type: Activity)
-    end
-
-    def top(channel:, period:, offset:, limit:, type:)
-      attrs = { period: period, offset: offset, limit: limit, type: type }
-      response = get_request("activities/#{channel}/top", params: attrs)
-      Collection.from_response(response, type: TopActivity)
-    end
-
-  end
-end

data/lib/stream_elements/resources/song_requests.rb

@@ -1,43 +0,0 @@
-module StreamElements
-  class SongRequestsResource < Resource
-
-    def playing(channel:)
-      SongRequest.new get_request("songrequest/#{channel}/playing").body
-    end
-
-    def queue(channel:)
-      response = get_request("songrequest/#{channel}/queue")
-      Collection.from_response(response, type: SongRequest)
-    end
-
-    def history(channel:, **params)
-      response = get_request("songrequest/#{channel}/history", params: params)
-      Collection.from_response(response, type: SongRequest, name: "history")
-    end
-
-    def add(channel:, video:)
-      SongRequest.new post_request("songrequest/#{channel}/queue", body: { video: video }).body
-    end
-
-    def pause(channel:)
-      response = post_request("songrequest/#{channel}/player/pause", body: {})
-      response.success?
-    end
-
-    def play(channel:)
-      response = post_request("songrequest/#{channel}/player/play", body: {})
-      response.success?
-    end
-
-    def volume(channel:, volume:)
-      response = post_request("songrequest/#{channel}/player/volume", body: {volume: volume})
-      response.success?
-    end
-
-    def skip(channel:)
-      response = post_request("songrequest/#{channel}/skip", body: {})
-      response.success?
-    end
-
-  end
-end

data/lib/stream_elements/resources/tips.rb

@@ -1,19 +0,0 @@
-module StreamElements
-  class TipsResource < Resource
-
-    def list(channel:, **params)
-      response = get_request("tips/#{channel}", params: params)
-      Collection.from_response(response, type: Tip, name: "docs")
-    end
-
-    def retrieve(channel:, id:)
-      Tip.new get_request("tips/#{channel}/#{id}").body
-    end
-
-    def top(channel:)
-      response = get_request("tips/#{channel}/top")
-      Collection.from_response(response, type: TopTip)
-    end
-
-  end
-end