swiftner 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bccfb7a6a850c917d592bd4dbfaf84ed83f167443056642653e151e029c10e0
-  data.tar.gz: a8d9567709a73226085a560cb1ada880075067407276002eec0584e908520f47
+  metadata.gz: fcaad19a345368e1cd1c8660d53bcab7a8f5152c59221e335bf9c8057f17fbd1
+  data.tar.gz: d1b40c55191e99e2326aac0850bc342f0eadde486f69c772a0fc828d9ad2c3e0
 SHA512:
-  metadata.gz: 42390d0d4f6bc5b6ee40a91deaeafc27c78c17fb2c4bd5663d91338dc376c5f22dfd818759cc9a627e8e3a1c7dded5a40b411baaae93faf124daa6c3a44f3620
-  data.tar.gz: 89f9c9ceab9e07ad7884fadb389830b5ff2f8cc36d9eda4898c17366fc8a1433179f956f79961c7b808bd644b8d688618e06b0147567ccafaa3d5e2bf37ec690
+  metadata.gz: e847384adbdb29330517d383c310085b8fc34b3e47f9b4fddcba6d12c08dca276128eaa65e1fabc9d7149adeeeee5ac4ddf80ff9f5770a86862a190b3d37b2a3
+  data.tar.gz: b74036ad768d3faa6c90d5564ef246153a01736785174cc2393410cb65559de4dbe41b35718313b85b27e50bcc81a3713c1f0f436cdf7f9730a9b3e8f1ac8726

data/README.md

@@ -63,6 +63,32 @@ upload.delete
 upload.transcribe("no")
 ```
 
+### Working with Linked Content
+```ruby
+@linked_content_service = Swiftner::API::LinkedContent
+
+# Find linked contents
+linked_contents = @linked_content_service.find_linked_contents
+
+# Find linked content
+linked_content = @linked_content_service.find(1)
+
+# Create an upload
+linked_content = @linked_content_service.create(sample_attributes)
+
+# Find linked content transcriptions
+transcriptions = linked_content.transcriptions
+
+# Batch create linked content
+linked_contents = @linked_content_service.batch_create([sample_attributes, sample_attributes])
+
+# Restart transcription process
+linked_content.transcribe
+
+# Delete linked content
+linked_content.delete
+```
+
 ### Handling Exceptions
 The Swiftner API Ruby Client includes custom exceptions for handling API errors. These inherit from either the base Swiftner::Error class or the standard Ruby StandardError class.
 ```ruby

data/lib/swiftner/API/linked_content.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Swiftner
+  module API
+    # Represents a LinkedContent service responsible for finding, creating, and updating linked content.
+    # Inherits from the Service class.
+    # Provides methods for interacting with linked content.
+    class LinkedContent < Service
+      def self.find_linked_contents
+        response = client.get("/linked-content/get-all/")
+        map_collection(response)
+      end
+
+      def self.find(linked_content_id)
+        response = client.get("/linked-content/get/#{linked_content_id}")
+        build(response.parsed_response)
+      end
+
+      def self.create(attributes)
+        validate_required(attributes, :url)
+
+        response = client.post(
+          "/linked-content/create",
+          body: attributes.to_json,
+          headers: { "Content-Type" => "application/json" }
+        )
+
+        build(response.parsed_response)
+      end
+
+      def self.batch_create(array_of_attributes)
+        array_of_attributes.each { |attributes| validate_required(attributes, :url) }
+
+        response = client.post(
+          "/linked-content/batch-create",
+          body: array_of_attributes.to_json,
+          headers: { "Content-Type" => "application/json" }
+        )
+
+        map_collection(response)
+      end
+
+      def update(attributes)
+        attributes = attributes.transform_keys(&:to_s)
+        @details = @details.merge(attributes)
+
+        client.put(
+          "/linked-content/update/#{id}",
+          body: @details.to_json,
+          headers: { "Content-Type" => "application/json" }
+        )
+        self
+      end
+
+      def transcriptions
+        response = client.get("/linked-content/get/#{id}/transcriptions")
+        response.map { |transcription| API::Transcription.build(transcription) }
+      end
+
+      def delete
+        client.delete("/linked-content/delete/#{id}")
+      end
+
+      def transcribe
+        response = client.post(
+          "/linked-content/transcribe/#{id}",
+          body: @details.to_json,
+          headers: { "Content-Type" => "application/json" }
+        )
+        @details = @details.merge(response.parsed_response)
+
+        self
+      end
+    end
+  end
+end

data/lib/swiftner/API/service.rb

@@ -14,6 +14,19 @@ module Swiftner
         Swiftner.configuration.client
       end
 
+      def self.validate_required(attributes, *keys)
+        attr_str_keys = attributes.transform_keys(&:to_s)
+        missing_keys = keys.map(&:to_s).reject { |key| attr_str_keys.key?(key) }
+
+        return unless missing_keys.any?
+
+        raise ArgumentError, "Key(s) '#{missing_keys.join(", ")}' are missing in attributes. #{attributes.inspect}"
+      end
+
+      def self.map_collection(response)
+        response.map { |item| build(item) }
+      end
+
       def initialize(attributes = {}, client = self.class.client)
         raise Swiftner::Error, "Client must be set" if client.nil?
 

data/lib/swiftner/API/space.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Swiftner
+  module API
+    # Represents a Space service responsible for finding, creating, and deleting spaces.
+    # Inherits from the Service class.
+    # Provides methods for interacting with spaces.
+    class Space < Service
+      def self.find_spaces
+        response = client.get("/space/get-spaces")
+        map_collection(response)
+      end
+
+      def self.find(space_id)
+        response = client.get("/space/get/#{space_id}")
+        build(response.parsed_response)
+      end
+
+      def self.create(attributes)
+        validate_required(attributes, :name, :description)
+
+        response = client.post(
+          "/space/create",
+          body: attributes.to_json,
+          headers: { "Content-Type" => "application/json" }
+        )
+
+        build(response.parsed_response)
+      end
+
+      def update(attributes)
+        attributes = attributes.transform_keys(&:to_s)
+        @details = @details.merge(attributes)
+
+        self.class.validate_required(@details, :name, :description)
+
+        client.put(
+          "/space/update/#{id}",
+          body: @details.to_json,
+          headers: { "Content-Type" => "application/json" }
+        )
+        self
+      end
+
+      def delete
+        client.delete("/space/delete/#{id}")
+      end
+    end
+  end
+end

data/lib/swiftner/API/upload.rb

@@ -8,7 +8,7 @@ module Swiftner
     class Upload < Service
       def self.find_uploads
         response = client.get("/upload/get-uploads/")
-        response.map { |upload| build(upload) }
+        map_collection(response)
       end
 
       def self.find(upload_id)

data/lib/swiftner/API/video_content.rb

@@ -7,7 +7,7 @@ module Swiftner
     class VideoContent < Service
       def self.find_video_contents
         response = client.get("/video-content/get-all/")
-        response.map { |upload| build(upload) }
+        map_collection(response)
       end
 
       def self.find(id)

data/lib/swiftner/client.rb

@@ -30,11 +30,11 @@ 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 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.3"
+  VERSION = "0.0.5"
 end

data/lib/swiftner.rb

@@ -1,21 +1,18 @@
 # 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/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.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Martin Ulleberg
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-23 00:00:00.000000000 Z
+date: 2024-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -38,14 +38,16 @@ files:
 - README.md
 - Rakefile
 - lib/swiftner.rb
+- lib/swiftner/API/linked_content.rb
 - lib/swiftner/API/service.rb
+- lib/swiftner/API/space.rb
 - lib/swiftner/API/transcription.rb
 - lib/swiftner/API/upload.rb
 - 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
 licenses: []
 metadata:
@@ -68,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.5
 signing_key:
 specification_version: 4
 summary: API wrapper for Swiftner's AI transcription service.

data/swiftner.gemspec

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