streamelements 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31160ff2ea22fd4ede0596df856320841537e8641f1578b12648ee9c9b918799
-  data.tar.gz: d2a0068938a6f62b62e627165945324e4a41fddc8c58a805dbfe64bb474f16a7
+  metadata.gz: 83d2ea9888a42229e5016f02f1dc44bc4bbb6dcd8e2518f18f205665af4085d5
+  data.tar.gz: 693b8d5938293d15a82eada641f6f1f4de021eaad7a68457d9bc2e179d7bd3db
 SHA512:
-  metadata.gz: f368ed8782747b19f755d31500b2b0c2c1d4e30d6a52fe6ac98fefc427be720ea87afa0fd3d8b02481f75b7093d7da7801ffb93539de61822960d4ff9fa19918
-  data.tar.gz: 895c89c0e5f073caa1979d509014ea96146d109c9e443d7307968fb7f4f9449586d03e111576c20dc2ef92e040906474c54895623b3240e0bae99824af672947
+  metadata.gz: f76b12a8c58996a31cfdc3849e237c6d4b1c4ded028cfe7bcba7a60379aa2e864d5dfd7191cb8677fbf06594c0a3284cfa0a5039a903579e717378d328ef04dc
+  data.tar.gz: b71d769c436f467bf3405df589f2ac8d8eb2fa44e06b1e3a040b69a2ab7e2582d3203e7f21730bae46b2deac81d43f863e05316851765a37339eb99d21f7ab83

data/README.md

@@ -12,30 +12,50 @@ gem "streamelements"
 
 ## Usage
 
-### Authentication
+### Set Client Details
 
-Firstly you'll need to set either a JWT Token or an OAuth Access Token.
+Firstly you'll need to the access token, which can be an oAuth Token or JWT.
 
 ```ruby
-# Set a JWT Token
-@client = StreamElements::Client.new(jwt_access_token: "")
+@client = StreamElements::Client.new(access_token: "abc123")
+```
+
+### Resources
+
+The gem maps as closely as we can to the StreamElements API so you can easily convert API examples to gem code.
+
+Responses are created as objects like `StreamElements::Channel`. Having types like `StreamElements::User` is handy for understanding what
+type of object you're working with. They're built using OpenStruct so you can easily access data in a Ruby-ish way.
+
+### Channels
+
+```ruby
+# Get the current channel
+@client.channels.me
+```
 
-# Or set an OAuth Access Token
-@client = StreamElements::Client.new(access_token: "")
+
+### Users
+
+```ruby
+# Get the current user
+@client.users.current
+
+# Get the users Channels
+@client.users.channels
 ```
 
-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")
+@client.activities.list(channel: "channel-id", after:, before:, limit:, types:)
 
 # Retrieve the Top Activities
 # https://dev.streamelements.com/docs/api-docs/2ce44d058b16b-channel-top
-@client.actvitities.top(channel: "channel-id")
+@client.activities.top(channel: "channel-id", period:, offset:, limit:, type:)
 ```
 
 ### Tips
@@ -43,7 +63,7 @@ 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")
+@client.tips.list(channel: "channel-id", after: "2024-01-01", sort: "createdAt", limit: 10)
 
 # Retrieve a Tip
 @client.tips.retrieve(channel: "channel-id", id: "tip-id")
@@ -62,9 +82,6 @@ Most of the API requires the Channel ID to be passed as an argument.
 # Retrieve a list of songs in the queue
 @client.song_requests.queue(channel: "channel-id")
 
-# Retrieve a list of previous songs
-@client.song_requests.queue(channel: "channel-id")
-
 # Add a song to the queue
 # video is the YouTube video ID or URL
 @client.song_requests.add(channel: "channel-id", video: "video-id")
@@ -81,6 +98,13 @@ Most of the API requires the Channel ID to be passed as an argument.
 
 # Skip the current song
 @client.song_requests.skip(channel: "channel-id")
+
+# Get the current song request settings
+@client.song_requests.settings(channel: "channel-id")
+
+# Set the current song request settings
+# settings is a hash of settings
+@client.song_requests.update_settings(channel: "channel-id", settings: { max_requests: 5 })
 ```
 
 ## Contributing

data/lib/stream_elements/client.rb

@@ -1,13 +1,20 @@
 module StreamElements
   class Client
+
     BASE_URL = "https://api.streamelements.com/kappa/v2"
 
-    attr_reader :jwt_access_token, :access_token, :adapter
+    attr_reader :access_token
 
-    def initialize(jwt_access_token: nil, access_token: nil, adapter: Faraday.default_adapter)
-      @jwt_access_token = jwt_access_token
+    def initialize(access_token:)
       @access_token = access_token
-      @adapter = adapter
+    end
+
+    def channels
+      ChannelsResource.new(self)
+    end
+
+    def users
+      UsersResource.new(self)
     end
 
     def activities
@@ -22,25 +29,18 @@ module StreamElements
       SongRequestsResource.new(self)
     end
 
+
     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."
-        end
+        conn.request :authorization, :Bearer, access_token
 
         conn.headers = {
-          "User-Agent" => "streamelements/v#{VERSION} (github.com/deanpcmad/streamelements)"
-        }
+            "User-Agent" => "streamelements/v#{VERSION} (github.com/deanpcmad/streamelements)"
+          }
 
         conn.request :json
 
         conn.response :json, content_type: "application/json"
-
-        conn.adapter adapter, @stubs
       end
     end
 

data/lib/stream_elements/collection.rb

@@ -19,5 +19,17 @@ module StreamElements
       @data = data
       @total = total
     end
+
+    def each(&block)
+      data.each(&block)
+    end
+
+    def first
+      data.first
+    end
+
+    def last
+      data.last
+    end
   end
 end

data/lib/stream_elements/error_generator.rb

@@ -0,0 +1,128 @@
+module StreamElements
+  class ErrorGenerator < StandardError
+    attr_reader :http_status_code
+    attr_reader :error_code
+    attr_reader :error_message
+
+    def initialize(response_body, http_status_code)
+      @response_body = response_body
+      @http_status_code = http_status_code
+      set_error_values
+      super(build_message)
+    end
+
+    private
+
+    def set_error_values
+      @error_code = @response_body.dig("error")
+      @error_message = @response_body.dig("message")
+    end
+
+    def error_message
+      @error_message || @response_body.dig("error")
+    rescue NoMethodError
+      "An unknown error occurred."
+    end
+
+    def build_message
+      if error_code.nil?
+        return "Error #{@http_status_code}: #{error_message}"
+      end
+      "Error #{@http_status_code}: #{error_message} '#{error_message}'"
+    end
+  end
+
+  module Errors
+    class BadRequestError < ErrorGenerator
+      private
+
+      def error_message
+        "Your request was malformed."
+      end
+    end
+
+    class AuthenticationMissingError < ErrorGenerator
+      private
+
+      def error_message
+        "You did not supply valid authentication credentials."
+      end
+    end
+
+    class ForbiddenError < ErrorGenerator
+      private
+
+      def error_message
+        "You are not allowed to perform that action."
+      end
+    end
+
+    class EntityNotFoundError < ErrorGenerator
+      private
+
+      def error_message
+        "No results were found for your request."
+      end
+    end
+
+    class ConflictError < ErrorGenerator
+      private
+
+      def error_message
+        "Your request was a conflict."
+      end
+    end
+
+    class TooManyRequestsError < ErrorGenerator
+      private
+
+      def error_message
+        "Your request exceeded the API rate limit."
+      end
+    end
+
+    class InternalError < ErrorGenerator
+      private
+
+      def error_message
+        "We were unable to perform the request due to server-side problems."
+      end
+    end
+
+    class ServiceUnavailableError < ErrorGenerator
+      private
+
+      def error_message
+        "You have been rate limited for sending more than 20 requests per second."
+      end
+    end
+
+    class NotImplementedError < ErrorGenerator
+      private
+
+      def error_message
+        "This resource has not been implemented."
+      end
+    end
+  end
+
+  class ErrorFactory
+    HTTP_ERROR_MAP = {
+      400 => Errors::BadRequestError,
+      401 => Errors::AuthenticationMissingError,
+      403 => Errors::ForbiddenError,
+      404 => Errors::EntityNotFoundError,
+      409 => Errors::ConflictError,
+      429 => Errors::TooManyRequestsError,
+      500 => Errors::InternalError,
+      503 => Errors::ServiceUnavailableError,
+      501 => Errors::NotImplementedError
+    }.freeze
+
+    def self.create(response_body, http_status_code)
+      status = http_status_code
+      error_class = HTTP_ERROR_MAP[status] || ErrorGenerator
+      error_class.new(response_body, http_status_code) if error_class
+    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/objects/activity.rb

@@ -1,10 +1,4 @@
 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/{top_activity.rb → channel.rb}

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

data/lib/stream_elements/objects/song_request.rb

@@ -1,10 +1,4 @@
 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 +1,4 @@
 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/user.rb

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

data/lib/stream_elements/resource.rb

@@ -12,47 +12,36 @@ module StreamElements
       handle_response client.connection.get(url, params, headers)
     end
 
-    def post_request(url, body:, headers: {})
+    def post_request(url, body: {}, headers: {})
       handle_response client.connection.post(url, body, headers)
     end
 
+    def put_request(url, body: {}, headers: {})
+      handle_response client.connection.put(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)
+    def delete_request(url, headers: {})
+      handle_response client.connection.delete(url, headers)
     end
 
-    def delete_request(url, params: {}, headers: {})
-      handle_response client.connection.delete(url, params, headers)
+    def handle_response(response)
+      return true if response.status == 204
+      return response unless error?(response)
+
+      raise_error(response)
     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
+    def error?(response)
+      [ 400, 401, 403, 404, 409, 429, 500, 501, 503 ].include?(response.status) #|| response.body&.key?("error")
+    end
+
+    def raise_error(response)
+      error = StreamElements::ErrorFactory.create(response.body, response.status)
+      raise error if error
     end
   end
 end

data/lib/stream_elements/resources/activities.rb

@@ -10,7 +10,7 @@ module StreamElements
     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)
+      # Collection.from_response(response, type: TopActivity)
     end
 
   end

data/lib/stream_elements/resources/channels.rb

@@ -0,0 +1,10 @@
+module StreamElements
+  class ChannelsResource < Resource
+
+    def me
+      response = get_request("channels/me")
+      Channel.new response.body
+    end
+
+  end
+end

data/lib/stream_elements/resources/song_requests.rb

@@ -15,6 +15,15 @@ module StreamElements
       Collection.from_response(response, type: SongRequest, name: "history")
     end
 
+    def settings(channel:)
+      get_request("songrequest/#{channel}/settings").body
+    end
+
+    def update_settings(channel:, settings:)
+      response = put_request("songrequest/#{channel}/settings", body: settings)
+      response.success?
+    end
+
     def add(channel:, video:)
       SongRequest.new post_request("songrequest/#{channel}/queue", body: { video: video }).body
     end

data/lib/stream_elements/resources/tips.rb

@@ -1,8 +1,9 @@
 module StreamElements
   class TipsResource < Resource
 
-    def list(channel:, **params)
-      response = get_request("tips/#{channel}", params: params)
+    def list(channel:, after:, sort:, limit:, **params)
+      attrs = { after: after, sort: sort, limit: limit }.merge(params)
+      response = get_request("tips/#{channel}", params: attrs)
       Collection.from_response(response, type: Tip, name: "docs")
     end
 

data/lib/stream_elements/resources/users.rb

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

data/lib/stream_elements/version.rb

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

data/lib/stream_elements.rb

@@ -6,20 +6,27 @@ require "stream_elements/version"
 
 module StreamElements
 
+  autoload :Error, "stream_elements/error"
+  autoload :Errors, "stream_elements/error_generator"
+  autoload :ErrorGenerator, "stream_elements/error_generator"
+  autoload :ErrorFactory, "stream_elements/error_generator"
+
   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 :ActivitiesResource, "stream_elements/resources/activitys"
   autoload :TipsResource, "stream_elements/resources/tips"
   autoload :SongRequestsResource, "stream_elements/resources/song_requests"
+  autoload :UsersResource, "stream_elements/resources/users"
+  autoload :ChannelsResource, "stream_elements/resources/channels"
 
   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"
+  autoload :User, "stream_elements/objects/user"
+  autoload :Channel, "stream_elements/objects/channel"
+  autoload :TopTip, "stream_elements/objects/top_tip"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: streamelements
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Dean Perry
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-09 00:00:00.000000000 Z
+date: 2024-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
-description: 
+description:
 email:
 - deanperry@fastmail.com
 executables: []
@@ -39,16 +39,20 @@ files:
 - lib/stream_elements/client.rb
 - lib/stream_elements/collection.rb
 - lib/stream_elements/error.rb
+- lib/stream_elements/error_generator.rb
 - lib/stream_elements/object.rb
 - lib/stream_elements/objects/activity.rb
+- lib/stream_elements/objects/channel.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/objects/user.rb
 - lib/stream_elements/resource.rb
 - lib/stream_elements/resources/activities.rb
+- lib/stream_elements/resources/channels.rb
 - lib/stream_elements/resources/song_requests.rb
 - lib/stream_elements/resources/tips.rb
+- lib/stream_elements/resources/users.rb
 - lib/stream_elements/version.rb
 - lib/streamelements.rb
 - sig/streamelements.rbs
@@ -56,7 +60,7 @@ homepage: https://github.com/deanpcmad/streamelements
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -71,8 +75,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
-signing_key: 
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: Ruby library for the StreamElements API
 test_files: []