swiftner 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcaad19a345368e1cd1c8660d53bcab7a8f5152c59221e335bf9c8057f17fbd1
-  data.tar.gz: d1b40c55191e99e2326aac0850bc342f0eadde486f69c772a0fc828d9ad2c3e0
+  metadata.gz: 7fed0bd04566bcce81abf9cef775cd31ee2b4faf14709c190ea57a468804074e
+  data.tar.gz: 4d3c389378438555f00485e9f8cbee362a9d1757a8babbd5b545f5741f4f8b4c
 SHA512:
-  metadata.gz: e847384adbdb29330517d383c310085b8fc34b3e47f9b4fddcba6d12c08dca276128eaa65e1fabc9d7149adeeeee5ac4ddf80ff9f5770a86862a190b3d37b2a3
-  data.tar.gz: b74036ad768d3faa6c90d5564ef246153a01736785174cc2393410cb65559de4dbe41b35718313b85b27e50bcc81a3713c1f0f436cdf7f9730a9b3e8f1ac8726
+  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,7 +29,7 @@ module Swiftner
 
     def handle_response(response)
       case response.code
-      when 200 then response
+      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)

data/lib/swiftner/version.rb

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

data/lib/swiftner.rb

@@ -7,6 +7,10 @@ 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"

data/swiftner.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/swiftner/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "swiftner"
+  spec.version = Swiftner::VERSION
+  spec.authors = ["Martin Ulleberg"]
+  spec.email = ["martin.ulleberg@gmail.com"]
+
+  spec.summary = "API wrapper for Swiftner's AI transcription service."
+  spec.description = "This gem provides an easy-to-use interface for Swiftner's API, allowing seamless integration of\
+    AI-driven transcription services into your Ruby applications."
+  spec.homepage = "https://swiftner.com"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/swiftner/swiftner_ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/swiftner/swiftner_ruby/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0.21"
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swiftner
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Martin Ulleberg
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-07 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
@@ -48,6 +53,7 @@ files:
 - lib/swiftner/configuration.rb
 - lib/swiftner/error.rb
 - lib/swiftner/version.rb
+- swiftner.gemspec
 homepage: https://swiftner.com
 licenses: []
 metadata:
@@ -70,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.5
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: API wrapper for Swiftner's AI transcription service.