streamelements 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 31160ff2ea22fd4ede0596df856320841537e8641f1578b12648ee9c9b918799
+  data.tar.gz: d2a0068938a6f62b62e627165945324e4a41fddc8c58a805dbfe64bb474f16a7
+SHA512:
+  metadata.gz: f368ed8782747b19f755d31500b2b0c2c1d4e30d6a52fe6ac98fefc427be720ea87afa0fd3d8b02481f75b7093d7da7801ffb93539de61822960d4ff9fa19918
+  data.tar.gz: 895c89c0e5f073caa1979d509014ea96146d109c9e443d7307968fb7f4f9449586d03e111576c20dc2ef92e040906474c54895623b3240e0bae99824af672947

data/.env.example

@@ -0,0 +1,2 @@
+STREAMELEMENTS_JWT_ACCESS_TOKEN=
+STREAMELEMENTS_CHANNEL=

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Dean Perry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,93 @@
+# StreamElements
+
+This is a Ruby library for the StreamElements API. **Currently in development**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "streamelements"
+```
+
+## Usage
+
+### Authentication
+
+Firstly you'll need to set either a JWT Token or an OAuth Access Token.
+
+```ruby
+# Set a JWT Token
+@client = StreamElements::Client.new(jwt_access_token: "")
+
+# Or set an OAuth Access Token
+@client = StreamElements::Client.new(access_token: "")
+```
+
+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")
+
+# Retrieve the Top Activities
+# https://dev.streamelements.com/docs/api-docs/2ce44d058b16b-channel-top
+@client.actvitities.top(channel: "channel-id")
+```
+
+### Tips
+
+```ruby
+# Retrieve a list of Tips
+# https://dev.streamelements.com/docs/api-docs/704e5580be2d9-channel
+@client.tips.list(channel: "channel-id")
+
+# Retrieve a Tip
+@client.tips.retrieve(channel: "channel-id", id: "tip-id")
+
+# Retrieve the Tip Tips
+# https://dev.streamelements.com/docs/api-docs/b404f906817c4-channel-top
+@client.tips.top(channel: "channel-id")
+```
+
+### Song Requests
+
+```ruby
+# Retrieve the current playing song
+@client.song_requests.playing(channel: "channel-id")
+
+# 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")
+
+# Pause the player
+@client.song_requests.pause(channel: "channel-id")
+
+# Resume the player
+@client.song_requests.play(channel: "channel-id")
+
+# Set the volume of the player
+# volume is a number between 0 and 100
+@client.song_requests.volume(channel: "channel-id", volume: 50)
+
+# Skip the current song
+@client.song_requests.skip(channel: "channel-id")
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/streamelements.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/lib/stream_elements/client.rb

@@ -0,0 +1,48 @@
+module StreamElements
+  class Client
+    BASE_URL = "https://api.streamelements.com/kappa/v2"
+
+    attr_reader :jwt_access_token, :access_token, :adapter
+
+    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 activities
+      ActivitiesResource.new(self)
+    end
+
+    def tips
+      TipsResource.new(self)
+    end
+
+    def song_requests
+      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.headers = {
+          "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
+
+  end
+end

data/lib/stream_elements/collection.rb

@@ -0,0 +1,23 @@
+module StreamElements
+  class Collection
+    attr_reader :data, :total
+
+    def self.from_response(response, type:, name: nil)
+      if name.nil?
+        body = response.body
+      else
+        body = response.body[name]
+      end
+
+      new(
+        data: body.map { |attrs| type.new(attrs) },
+        total: body.count,
+      )
+    end
+
+    def initialize(data:, total:)
+      @data = data
+      @total = total
+    end
+  end
+end

data/lib/stream_elements/error.rb

@@ -0,0 +1,4 @@
+module StreamElements
+  class Error < StandardError
+  end
+end

data/lib/stream_elements/object.rb

@@ -0,0 +1,19 @@
+require "ostruct"
+
+module StreamElements
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h)
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else # Assumed to be a primitive value
+        obj
+      end
+    end
+  end
+end

data/lib/stream_elements/objects/activity.rb

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,10 @@
+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

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

data/lib/stream_elements/objects/top_tip.rb

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

data/lib/stream_elements/resource.rb

@@ -0,0 +1,58 @@
+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

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,43 @@
+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

@@ -0,0 +1,19 @@
+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

data/lib/stream_elements/version.rb

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

data/lib/stream_elements.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+require "stream_elements/version"
+
+module StreamElements
+
+  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"
+
+  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"
+
+end

data/lib/streamelements.rb

@@ -0,0 +1 @@
+require "stream_elements"

data/sig/streamelements.rbs

@@ -0,0 +1,4 @@
+module Streamelements
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: streamelements
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean Perry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: 
+email:
+- deanperry@fastmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stream_elements.rb
+- lib/stream_elements/client.rb
+- lib/stream_elements/collection.rb
+- lib/stream_elements/error.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
+homepage: https://github.com/deanpcmad/streamelements
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key: 
+specification_version: 4
+summary: Ruby library for the StreamElements API
+test_files: []