swiftner 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df81ce74f315ba2773be31747e089c77e955415362d0de93c6f0ac5e2d844086
-  data.tar.gz: 91ef8ff69dc8e7d8aa987d0296a45a04c02e3dc35c7466dbc2b872bf8345d43e
+  metadata.gz: 7fed0bd04566bcce81abf9cef775cd31ee2b4faf14709c190ea57a468804074e
+  data.tar.gz: 4d3c389378438555f00485e9f8cbee362a9d1757a8babbd5b545f5741f4f8b4c
 SHA512:
-  metadata.gz: a530d61cdf3023d1c9df3881ce151e346b15480f5b7ff067d69801cfc07597047d7b5985cc991e72b93a8ed7a6e33408687dbc324bc5ccc0ce4f316a1d915434
-  data.tar.gz: 244fd82157219579145a47d20f21734b77923b5ad88b0dd725f85ea37c371f588dd510b48cf8fc259c0d2ed0be89d9e8f1dd3d3a848bf746b6dff11669eb1f4a
+  metadata.gz: ec7c67f789d1f167cbde69b4a7a6df4d173a237500681bb2238525833312c86beed7198688d1a8dba9ed867155cbf468cdb32fb50d5d7b42c2d522ebe9ff818a
+  data.tar.gz: 0a3023b1c834c6791168659cb7a2bb0b0b6d4b7902070175c3e7423024a4010809fc74bb7aed2ae4c70e4cd782a28896131aa581bb3787ca780f655006aae8a7

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.0.6]
+- Added Meeting service with CRUD operations and `start`, `end`, `pause` and `resume`. [#10](https://github.com/Swiftner/swiftner_ruby/pull/10)
+- Added Channel service with CRUD operations and `live?`. [#9](https://github.com/Swiftner/swiftner_ruby/pull/9)
+- Added Chapter service with CRUD operations. [#8](https://github.com/Swiftner/swiftner_ruby/pull/8)
+- Added Organisation service with CRUD operations and `add_org_to_token`. [#7](https://github.com/Swiftner/swiftner_ruby/pull/7)
+
 ## [0.0.2] - 2024-02-13
 
 -  Adds the first services supported.

data/RELEASING.md

@@ -0,0 +1,14 @@
+# Releasing
+
+1. Update `lib/swiftner/version.rb` accordingly and run `bundle install` to update the Gemfile.lock.
+1. Update `CHANGELOG.md` to reflect the changes since last release. This means moving everyhing from the unrealesed section to an appropriate version section.
+1. Commit changes.
+1. Tag the release: `git tag -s vVERSION`
+1. Push changes: `git push && git push --tags`
+1. Build and publish:
+    ```bash
+    gem build swiftner.gemspe
+    gem push swiftner-VERSION.gem
+    ```
+1. Add a new GitHub release using the content from new version section of `CHANGELOG.md` as the content.
+1. Announce the new release, say "thank you" to the contributors.

data/lib/swiftner/API/channel.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Swiftner
+  module API
+    # Represents a Channel service responsible for finding, creating, updating and deleting channels.
+    # Inherits from the Service class.
+    # Provides methods for interacting with channel.
+    class Channel < Service
+      REQUIRED_ATTRIBUTES = %i[name type space_id].freeze
+
+      # Finds all channels
+      # @return [Array<Swiftner::API::Channel>]
+      def self.find_channels
+        response = client.get("/channel/get-channels")
+        map_collection(response)
+      end
+
+      # Finds channel by its id
+      # @param [Integer] channel_id
+      # @return [Swiftner::API::Channel]
+      def self.find(channel_id)
+        response = client.get("/channel/get/#{channel_id}")
+        build(response.parsed_response)
+      end
+
+      # @param [Hash] attributes
+      # @option attributes [String] :name (required)
+      # @option attributes [String] :type (required) - "audio", "video" or "dual"
+      # @option attributes [Integer] :space_id (required)
+      # @option attributes [String] :description (optional)
+      # @option attributes [Integer] :order (optional)
+      # @return [Swiftner::API::Channel]
+      def self.create(attributes)
+        validate_required(attributes, *REQUIRED_ATTRIBUTES)
+
+        response = client.post(
+          "/channel/create",
+          body: attributes.to_json,
+          headers: { "Content-Type" => "application/json" }
+        )
+
+        build(response.parsed_response)
+      end
+
+      # @return [Boolean]
+      def live?
+        client.get("/channel/is_channel_live?channel_id=#{id}")["status"] == "live"
+      rescue Swiftner::NotFound
+        # ?Why does api return 404 when channel is not live?
+        false
+      end
+
+      # @param [Hash] attributes
+      # @option attributes [String] :name (required)
+      # @option attributes [String] :type (required) - "audio", "video" or "dual"
+      # @option attributes [Integer] :space_id (required)
+      # @option attributes [String] :description (optional)
+      # @option attributes [Integer] :order (optional)
+      # @return [Swiftner::API::Channel]
+      def update(attributes)
+        attributes = attributes.transform_keys(&:to_s)
+        @details = @details.merge(attributes)
+
+        self.class.validate_required(@details, *REQUIRED_ATTRIBUTES)
+
+        client.put(
+          "/channel/update/#{id}",
+          body: @details.to_json,
+          headers: { "Content-Type" => "application/json" }
+        )
+        self
+      end
+
+      # Deletes channel by its id
+      # @return [Hash] response
+      def delete
+        client.delete("/channel/delete/#{id}")
+      end
+    end
+  end
+end

data/lib/swiftner/API/chapter.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Swiftner
+  module API
+    # Represents a chapter service responsible for finding, creating, and deleting chapters.
+    # Inherits from the Service class.
+    # Provides methods for interacting with chapters.
+    class Chapter < Service
+      REQUIRED_ATTRIBUTES = %i[title duration video_content_id start].freeze
+      # Finds all chapters for a video content.
+      # @param [Integer] video_content_id
+      # @return [Array<Swiftner::API::Chapter>]
+      def self.find_chapters(video_content_id)
+        response = client.get("/video-content/get/#{video_content_id}/chapters")
+        map_collection(response)
+      end
+
+      # Finds chapter by id.
+      # @param [Integer] chapter_id
+      # @return [Swiftner::API::Chapter]
+      def self.find(chapter_id)
+        response = client.get("/chapter/get/#{chapter_id}")
+        build(response.parsed_response)
+      end
+
+      # Creates a chapter.
+      # @param [Hash] attributes
+      # @option attributes [String] :title (required)
+      # @option attributes [String] :duration (required)
+      # @option attributes [Integer] :video_content_id (required)
+      # @option attributes [String] :start (required)
+      # @option attributes [String] :start_seconds (optional)
+      # @option attributes [String] :language (optional)
+      # @return [Swiftner::API::Chapter]
+      def self.create(attributes)
+        validate_required(attributes, *REQUIRED_ATTRIBUTES)
+
+        response = client.post(
+          "/chapter/create",
+          body: attributes.to_json,
+          headers: { "Content-Type" => "application/json" }
+        )
+
+        build(response.parsed_response)
+      end
+
+      # Creates a chapter.
+      # @param [Hash] attributes
+      # @option attributes [String] :title (optional)
+      # @option attributes [String] :duration (optional)
+      # @option attributes [Integer] :video_content_id (optional)
+      # @option attributes [String] :start (optional)
+      # @option attributes [String] :start_seconds (optional)
+      # @option attributes [String] :language (optional)
+      # @return [Swiftner::API::Chapter]
+      def update(attributes)
+        attributes = attributes.transform_keys(&:to_s)
+        @details = @details.merge(attributes)
+
+        self.class.validate_required(@details, *REQUIRED_ATTRIBUTES)
+
+        client.put(
+          "/chapter/update/#{id}",
+          body: @details.to_json,
+          headers: { "Content-Type" => "application/json" }
+        )
+        self
+      end
+
+      # @return [Hash]
+      def delete
+        client.delete("/chapter/delete/#{id}")
+      end
+    end
+  end
+end

data/lib/swiftner/API/meeting.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module Swiftner
+  module API
+    # Represents a Meeting service responsible for finding, creating, and deleting spaces.
+    # Inherits from the Service class.
+    # Provides methods for interacting with meetings.
+    class Meeting < Service
+      REQUIRED_ATTRIBUTES = %i[space_id language].freeze
+      # Finds all meetings
+      # @return [Array<Swiftner::API::Meeting>]
+      def self.find_meetings
+        response = client.get("/meeting/get-meetings")
+        map_collection(response)
+      end
+
+      # Finds meeting by id
+      # @param [Integer] meeting_id
+      # @return [Swiftner::API::Meeting]
+      def self.find(meeting_id)
+        response = client.get("/meeting/get/#{meeting_id}")
+        build(response.parsed_response)
+      end
+
+      # Creates a meeting.
+      # @param [Hash] attributes
+      # @option attributes [Integer] :space_id (required)
+      # @option attributes [String] :language (required)
+      # @option attributes [String] :title (optional)
+      # @option attributes [String] :description (optional)
+      # @option attributes [String] :start (optional) eg. "2024-09-06T08:37:45.162Z"
+      # @option attributes [Integer] :duration (optional)
+      # @option attributes [String] :thumbnail_url (optional)
+      # @option attributes [String] :state (optional) eg. "not_started", "ended"
+      # @option attributes [Integer] :prompt_id (optional)
+      # @return [Swiftner::API::Meeting]
+      def self.create(attributes)
+        validate_required(attributes, *REQUIRED_ATTRIBUTES)
+
+        response = client.post(
+          "/meeting/create",
+          body: attributes.to_json,
+          headers: { "Content-Type" => "application/json" }
+        )
+
+        build(response.parsed_response)
+      end
+
+      # Starts a meeting
+      # @return [Swiftner::API::Meeting]
+      def start
+        response = client.post(
+          "/meeting/#{id}/start",
+          headers: { "Content-Type" => "application/json" }
+        )
+
+        @details = response
+        self
+      end
+
+      # Ends a meeting
+      # @return [Swiftner::API::Meeting]
+      def end
+        response = client.post(
+          "/meeting/#{id}/end",
+          headers: { "Content-Type" => "application/json" }
+        )
+        @details = response.parsed_response
+        self
+      end
+
+      # Pauses a meeting
+      # @return [Swiftner::API::Meeting, nil]
+      def pause
+        response = client.post(
+          "/meeting/#{id}/pause",
+          headers: { "Content-Type" => "application/json" }
+        )
+        @details = response.parsed_response
+        self
+      end
+
+      # Resumes a meeting
+      # @return [Swiftner::API::Meeting]
+      def resume
+        response = client.post(
+          "/meeting/#{id}/resume",
+          headers: { "Content-Type" => "application/json" }
+        )
+        @details = response.parsed_response
+        self
+      end
+
+      # Updates a meeting.
+      # @param [Hash] attributes
+      # @option attributes [Integer] :space_id (optional)
+      # @option attributes [String] :language (optional) eg. "no", "en"
+      # @option attributes [String] :title (optional)
+      # @option attributes [String] :description (optional)
+      # @option attributes [String] :start (optional) eg. "2024-09-06T08:37:45.162Z"
+      # @option attributes [Integer] :duration (optional)
+      # @option attributes [String] :thumbnail_url (optional)
+      # @option attributes [String] :state (optional) eg. "not_started", "ended"
+      # @option attributes [Integer] :prompt_id (optional)
+      # @return [Swiftner::API::Meeting]
+      def update(attributes)
+        attributes = attributes.transform_keys(&:to_s)
+        @details = @details.merge(attributes)
+
+        self.class.validate_required(@details, :language, :space)
+
+        client.put(
+          "/meeting/update/#{id}",
+          body: @details.to_json,
+          headers: { "Content-Type" => "application/json" }
+        )
+        self
+      end
+
+      # Deletes a meeting.
+      # @return [Hash]
+      def delete
+        client.delete("/meeting/delete/#{id}")
+      end
+    end
+  end
+end

data/lib/swiftner/API/organisation.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Swiftner
+  module API
+    # Represents a Organisation service responsible for finding, creating, and deleting organisations.
+    # Inherits from the Service class.
+    # Provides methods for interacting with spaces.
+    class Organisation < Service
+      REQUIRED_ATTRIBUTES = %i[name].freeze
+
+      # Finds all organisations user is in
+      # @return [Array<Swiftner::API::Organisation>]
+      def self.find_organisations
+        response = client.get("/organisation/get-current-user-orgs")
+        map_collection(response)
+      end
+
+      # Finds organisation by id
+      # @param [Integer] organisation_id
+      # @return [Swiftner::API::Organisation]
+      def self.find(organisation_id)
+        response = client.get("/organisation/get/#{organisation_id}")
+        build(response.parsed_response)
+      end
+
+      # Add org to token
+      # @param [Integer] organisation_id
+      # @return [Hash] {access_hash: String, refresh_token: String}
+      def self.add_org_to_token(organisation_id)
+        client.put("/organisation/add-org-to-token?organisation_id=#{organisation_id}")
+      end
+
+      # Creates a new organisation
+      # @param [Hash] attributes
+      # @option attributes [String] :name (required)
+      # @option attributes [String] :description (optional)
+      # @option attributes [Integer] :default_prompt_id (optional)
+      # @option attributes [String] :language (optional)
+      # @return [Swiftner::API::Organisation]
+      def self.create(attributes)
+        validate_required(attributes, *REQUIRED_ATTRIBUTES)
+        response = client.post(
+          "/organisation/create",
+          body: attributes.to_json,
+          headers: { "Content-Type" => "application/json" }
+        )
+        build(response.parsed_response)
+      end
+
+      # Updates organisation
+      # @param [Hash] attributes
+      # @option attributes [String] :name (optional)
+      # @option attributes [String] :description (optional)
+      # @option attributes [Integer] :default_prompt_id (optional)
+      # @option attributes [String] :language (optional)
+      # @return [Swiftner::API::Organisation]
+      def update(attributes)
+        attributes = attributes.transform_keys(&:to_s)
+        @details = @details.merge(attributes)
+
+        self.class.validate_required(@details, *REQUIRED_ATTRIBUTES)
+
+        client.put(
+          "/organisation/update/#{id}",
+          body: @details.to_json,
+          headers: { "Content-Type" => "application/json" }
+        )
+        self
+      end
+
+      # Deletes organisation
+      def delete
+        client.delete("/organisation/delete/#{id}")
+      end
+    end
+  end
+end

data/lib/swiftner/client.rb

@@ -29,12 +29,12 @@ module Swiftner
 
     def handle_response(response)
       case response.code
-      when 200 then response
-      when 401 then raise Unauthorized
-      when 403 then raise Forbidden
-      when 404 then raise NotFound
-      when 500 then raise InternalError
-      else raise Error, "Unknown error occurred"
+      when 200, 201 then response
+      when 401 then raise Unauthorized.from_response(response)
+      when 403 then raise Forbidden.from_response(response)
+      when 404 then raise NotFound.from_response(response)
+      when 500 then raise InternalError.from_response(response)
+      else raise Error.new("Unknown error occurred", response: response)
       end
     end
   end

data/lib/swiftner/error.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Swiftner
+  # Encapsulates all errors that can be raised by the Swiftner API
+  class Error < StandardError
+    attr_reader :response
+
+    def self.from_response(response)
+      return new(response["detail"], response: response) if response.key?("detail")
+
+      new(response.to_s, response: response)
+    end
+
+    def initialize(message, response: nil)
+      @response = response
+      super(message)
+    end
+  end
+
+  class Forbidden < Error; end
+  class Unauthorized < Error; end
+  class NotFound < Error; end
+  class InternalError < Error; end
+end

data/lib/swiftner/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Swiftner
-  VERSION = "0.0.4"
+  VERSION = "0.0.6"
 end

data/lib/swiftner.rb

@@ -1,23 +1,22 @@
 # frozen_string_literal: true
 
+require_relative "swiftner/error"
 require_relative "swiftner/API/service"
 require_relative "swiftner/API/space"
 require_relative "swiftner/API/transcription"
 require_relative "swiftner/API/upload"
 require_relative "swiftner/API/video_content"
 require_relative "swiftner/API/linked_content"
+require_relative "swiftner/API/channel"
+require_relative "swiftner/API/chapter"
+require_relative "swiftner/API/organisation"
+require_relative "swiftner/API/meeting"
 require_relative "swiftner/configuration"
 require_relative "swiftner/client"
 require_relative "swiftner/version"
 
 ### Swiftner
 module Swiftner
-  class Error < StandardError; end
-  class Forbidden < Error; end
-  class Unauthorized < Error; end
-  class NotFound < Error; end
-  class InternalError < Error; end
-
   class << self
     attr_accessor :configuration
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swiftner
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Martin Ulleberg
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-04 00:00:00.000000000 Z
+date: 2024-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -36,9 +36,14 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - README.md
+- RELEASING.md
 - Rakefile
 - lib/swiftner.rb
+- lib/swiftner/API/channel.rb
+- lib/swiftner/API/chapter.rb
 - lib/swiftner/API/linked_content.rb
+- lib/swiftner/API/meeting.rb
+- lib/swiftner/API/organisation.rb
 - lib/swiftner/API/service.rb
 - lib/swiftner/API/space.rb
 - lib/swiftner/API/transcription.rb
@@ -46,6 +51,7 @@ files:
 - lib/swiftner/API/video_content.rb
 - lib/swiftner/client.rb
 - lib/swiftner/configuration.rb
+- lib/swiftner/error.rb
 - lib/swiftner/version.rb
 - swiftner.gemspec
 homepage: https://swiftner.com
@@ -55,7 +61,7 @@ metadata:
   source_code_uri: https://github.com/swiftner/swiftner_ruby
   changelog_uri: https://github.com/swiftner/swiftner_ruby/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -71,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: API wrapper for Swiftner's AI transcription service.
 test_files: []