dyte 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 82cf74ac47f0763080ded04aa4b43a15ee84e589b5e2e7cbeb899e21dfce9460
+  data.tar.gz: 60c7a91ed450235a84d26e999a0b33bea4a0cb07b7c1f8cc4bf9bdb1cbcf6fd5
+SHA512:
+  metadata.gz: 9387401bb78c05abfa45af7b38b0445845421fe042bd4d463d6bd4ff5918fb87dc73ebfc46593c8ca8cfea1180f93a486a391fdcbcac2aee2077f40954ed3695
+  data.tar.gz: 5c839335e1f430dbf68d9e5bc5e4596a66c8e7e27c1814a315d8e23619030e0ddfbedc81443bb201b1898e47dcb18e14a0fe5d3f759d66e8c115bfbb3db53225

data/.pryrc

@@ -0,0 +1,6 @@
+if defined?(PryByebug)
+  Pry.commands.alias_command "c", "continue"
+  Pry.commands.alias_command "s", "step"
+  Pry.commands.alias_command "n", "next"
+  Pry.commands.alias_command "f", "finish"
+end

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-02-05
+
+- Initial release

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dyte.gemspec
+gemspec
+
+group :development do
+  gem "rake", "~> 13.0"
+  gem "standard", "~> 1.24"
+  gem "minitest", "~> 5.17"
+  gem "webmock", "~> 3.18"
+  gem "solargraph", "~> 0.48.0"
+  gem "debug"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Nick Warwick
+
+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,57 @@
+# Dyte
+
+A gem that wraps v2 of the [Dyte API](https://docs.dyte.io/api/#/) to make it easy to use in Ruby applications.
+Please note that some resources are not yet implemented. This is due to the fact that v2 of the Dyte API is incomplete. Once the Dyte team has finalized the response structure the remaining resources will be implemented.
+
+Bugs reports and pull requests are welcome! ❤️
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'dyte'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dyte
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Resources
+### Meetings
+```ruby
+client.meetings.list
+client.meetings.fetch(meeting_id: "id")
+client.meetings.create({})
+client.meetings.update(meeting_id: "id", {})
+```
+### Presets
+```ruby
+client.presets.list
+client.presets.fetch(preset_id: "id")
+client.presets.create({})
+client.presets.update(preset_id: "id", {})
+```
+### Sessions
+### Participants
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Contribution guidelines TBD. For now just open a PR and we'll figure it out.
+
+## 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,14 @@
+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
+
+task :console do
+  exec "irb -I lib -r dyte.rb"
+end

data/lib/dyte/client.rb

@@ -0,0 +1,60 @@
+require "minitest/autorun"
+module Dyte
+  class Client
+    BASE_URL_V1 = "https://api.cluster.dyte.in/v1/organizations"
+    BASE_URL = "https://api.cluster.dyte.in/v2"
+
+    attr_accessor :organization_id, :api_key, :adapter
+
+    def initialize(organization_id:, api_key:, adapter: Faraday.default_adapter)
+      @organization_id = organization_id
+      @api_key = api_key
+      @adapter = adapter
+    end
+
+    def meetings
+      MeetingsResource.new(self)
+    end
+
+    def presets
+      PresetsResource.new(self)
+    end
+
+    def participants
+      ParticipantsResource.new(self)
+    end
+
+    def sessions
+      SessionsResource.new(self)
+    end
+
+    def recordings
+      RecordingsResource.new(self)
+    end
+
+    def active_sessions
+      ActiveSessionsResource.new(self)
+    end
+
+    def connection_v1
+      @connection ||= Faraday.new("#{BASE_URL}/#{@organization_id}") do |conn|
+        conn.headers["Authorization"] = @api_key
+
+        conn.request :json
+
+        conn.response :json, content_type: "application/json"
+      end
+    end
+
+    def connection
+      auth_token = Base64.strict_encode64("#{@organization_id}:#{@api_key}")
+      @connection ||= Faraday.new(BASE_URL) do |conn|
+        conn.headers["Authorization"] = "Basic #{auth_token}"
+
+        conn.request :json
+
+        conn.response :json, content_type: "application/json"
+      end
+    end
+  end
+end

data/lib/dyte/collection.rb

@@ -0,0 +1,41 @@
+module Dyte
+  class Collection
+    attr_reader :data, :total_count, :start_offset, :end_offset
+
+    # from_response(response, type: Meeting)
+    def self.from_response(response, type:, key: nil)
+      body = response.body
+      new(
+        data: parse_body(body: body, type: type, key: key),
+        total_count: body.dig("paging", "total_count"),
+        start_offset: body.dig("paging", "start_offset"),
+        end_offset: body.dig("paging", "end_offset")
+      )
+    end
+
+    # As of now the session response differs from the other responses.
+    # It's missing pagination data and also the data is nested under 'sessions'.
+    def self.from_sessions_response(response, type:)
+      body = response.body
+      new(
+        data: body.dig("data", "sessions").map { |attrs| type.new(attrs) }
+      )
+    end
+
+    def initialize(data:, total_count: nil, start_offset: nil, end_offset: nil)
+      @data = data
+      @total_count = total_count
+      @start_offset = start_offset
+      @end_offset = end_offset
+    end
+
+    # The Dyte API does not have a consistent response structure. This method accounts for that.
+    def self.parse_body(body:, type:, key: nil)
+      if body["data"].is_a?(Array)
+        body["data"].map { |attrs| type.new(attrs) }
+      else
+        body.dig("data", key).map { |attrs| type.new(attrs) }
+      end
+    end
+  end
+end

data/lib/dyte/error.rb

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

data/lib/dyte/object.rb

@@ -0,0 +1,19 @@
+require "ostruct"
+
+module Dyte
+  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
+        obj
+      end
+    end
+  end
+end

data/lib/dyte/objects/active_session.rb

@@ -0,0 +1,4 @@
+module Dyte
+  class ActiveSession < Object
+  end
+end

data/lib/dyte/objects/meeting.rb

@@ -0,0 +1,4 @@
+module Dyte
+  class Meeting < Object
+  end
+end

data/lib/dyte/objects/participant.rb

@@ -0,0 +1,4 @@
+module Dyte
+  class Participant < Object
+  end
+end

data/lib/dyte/objects/preset.rb

@@ -0,0 +1,4 @@
+module Dyte
+  class Preset < Object
+  end
+end

data/lib/dyte/objects/recording.rb

@@ -0,0 +1,4 @@
+module Dyte
+  class Recording < Object
+  end
+end

data/lib/dyte/objects/session.rb

@@ -0,0 +1,4 @@
+module Dyte
+  class Session < Object
+  end
+end

data/lib/dyte/resource.rb

@@ -0,0 +1,53 @@
+module Dyte
+  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, "Your request was malformed. #{response.body["message"]}"
+      when 401
+        raise Error, "You did not supply valid authentication credentials. #{response.body["message"]}"
+      when 403
+        raise Error, "You are not allowed to perform that action. #{response.body["message"]}"
+      when 404
+        raise Error, "No results were found for your request. #{response.body["message"]}"
+      when 429
+        raise Error, "Your request exceeded the API rate limit. #{response.body["message"]}"
+      when 500
+        raise Error, "We were unable to perform the request due to server-side problems. #{response.body["message"]}"
+      when 503
+        raise Error,
+          "You have been rate limited for sending more than 20 requests per second. #{response.body["message"]}"
+      end
+
+      response
+    end
+  end
+end

data/lib/dyte/resources/active_sessions.rb

@@ -0,0 +1,7 @@
+module Dyte
+  class ActiveSessionsResource < Resource
+    def fetch(meeting_id:)
+      ActiveSession.new get_request("meetings/#{meeting_id}/active-session").body.dig("data")
+    end
+  end
+end

data/lib/dyte/resources/meetings.rb

@@ -0,0 +1,24 @@
+module Dyte
+  class MeetingsResource < Resource
+    def list(**params)
+      response = get_request("meetings", params: params)
+      Collection.from_response(response, type: Meeting)
+    end
+
+    def fetch(meeting_id:)
+      Meeting.new get_request("meetings/#{meeting_id}").body.dig("data")
+    end
+
+    def create(**attributes)
+      Meeting.new post_request("meetings", body: attributes).body.dig("data")
+    end
+
+    def update(meeting_id:, **attributes)
+      Meeting.new put_request("meetings/#{meeting_id}", body: attributes).body.dig("data", "meeting")
+    end
+
+    def update_old(meeting_id:, body: {})
+      Meeting.new put_request("meetings/#{meeting_id}", body: body).body.dig("data", "meeting")
+    end
+  end
+end

data/lib/dyte/resources/participants.rb

@@ -0,0 +1,12 @@
+module Dyte
+  class ParticipantsResource < Resource
+    def list(session_id:, **params)
+      response = get_request("sessions/#{session_id}/participants", params: params)
+      Collection.from_response(response, type: Participant, key: "participants")
+    end
+
+    def fetch(session_id:, participant_id:)
+      Participant.new get_request("sessions/#{session_id}/participants/#{participant_id}").body.dig("data", "participant")
+    end
+  end
+end

data/lib/dyte/resources/presets.rb

@@ -0,0 +1,24 @@
+module Dyte
+  class PresetsResource < Resource
+    def list(**params)
+      response = get_request("presets", params: params)
+      Collection.from_response(response, type: Preset)
+    end
+
+    def create(**attributes)
+      Preset.new post_request("presets", body: attributes).body.dig("data")
+    end
+
+    def fetch(preset_id:)
+      Preset.new get_request("presets/#{preset_id}").body.dig("data")
+    end
+
+    def delete(preset_id:)
+      Preset.new delete_request("presets/#{preset_id}").body.dig("data")
+    end
+
+    def update(preset_id:, **attributes)
+      Preset.new patch_request("presets/#{preset_id}", body: attributes).body.dig("data")
+    end
+  end
+end

data/lib/dyte/resources/recordings.rb

@@ -0,0 +1,14 @@
+module Dyte
+  class RecordingsResource < Resource
+    # Returns all recordings for an organization.
+    # If the meeting_id parameter is passed, returns all recordings for the given meeting ID.
+    def list(**params)
+      response = get_request("recordings", params: params)
+      Collection.from_response(response, type: Recording)
+    end
+
+    def fetch(recording_id:)
+      Recording.new get_request("recordings/#{recording_id}").body.dig("data")
+    end
+  end
+end

data/lib/dyte/resources/sessions.rb

@@ -0,0 +1,26 @@
+module Dyte
+  class SessionsResource < Resource
+    def list(**params)
+      response = get_request("sessions", params: params)
+      Collection.from_response(response, type: Session, key: "sessions")
+    end
+
+    def fetch(session_id:)
+      Session.new get_request("sessions/#{session_id}").body.dig("data", "session")
+    end
+
+    # Returns a list of participants for the given session ID.
+    # Kept it within the Sessions resource as that's how the Dyte API is structured.
+    def fetch_participants(session_id:)
+      Session.new get_request("sessions/#{session_id}/participants").body.dig("data")
+    end
+
+    def update(meeting_id:, **attributes)
+      Session.new put_request("sessions/#{meeting_id}", body: attributes).body.dig("data", "session")
+    end
+
+    def update_old(meeting_id:, body: {})
+      Session.new put_request("sessions/#{meeting_id}", body: body).body.dig("data", "session")
+    end
+  end
+end

data/lib/dyte/version.rb

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

data/lib/dyte.rb

@@ -0,0 +1,28 @@
+require "faraday"
+require "json"
+require "debug"
+require "dyte/version"
+require "dyte/client"
+require "dyte/collection"
+require "dyte/error"
+require "dyte/object"
+require "dyte/resource"
+
+# Objects
+require "dyte/objects/meeting"
+require "dyte/objects/preset"
+require "dyte/objects/participant"
+require "dyte/objects/session"
+require "dyte/objects/recording"
+require "dyte/objects/active_session"
+
+# Resources
+require "dyte/resources/meetings"
+require "dyte/resources/presets"
+require "dyte/resources/participants"
+require "dyte/resources/sessions"
+require "dyte/resources/recordings"
+require "dyte/resources/active_sessions"
+
+module Dyte
+end

data/sig/dyte.rbs

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

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: dyte
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Warwick
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+description: A simple wrapper for V2 of the Dyte API.
+email:
+- nicholaswarwick@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".pryrc"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/dyte.rb
+- lib/dyte/client.rb
+- lib/dyte/collection.rb
+- lib/dyte/error.rb
+- lib/dyte/object.rb
+- lib/dyte/objects/active_session.rb
+- lib/dyte/objects/meeting.rb
+- lib/dyte/objects/participant.rb
+- lib/dyte/objects/preset.rb
+- lib/dyte/objects/recording.rb
+- lib/dyte/objects/session.rb
+- lib/dyte/resource.rb
+- lib/dyte/resources/active_sessions.rb
+- lib/dyte/resources/meetings.rb
+- lib/dyte/resources/participants.rb
+- lib/dyte/resources/presets.rb
+- lib/dyte/resources/recordings.rb
+- lib/dyte/resources/sessions.rb
+- lib/dyte/version.rb
+- sig/dyte.rbs
+homepage: https://github.com/nwarwick
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nwarwick
+  source_code_uri: https://github.com/nwarwick
+  changelog_uri: https://github.com/nwarwick
+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.10
+signing_key:
+specification_version: 4
+summary: A simple wrapper for the Dyte API.
+test_files: []