swiftner 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bccfb7a6a850c917d592bd4dbfaf84ed83f167443056642653e151e029c10e0
-  data.tar.gz: a8d9567709a73226085a560cb1ada880075067407276002eec0584e908520f47
+  metadata.gz: df81ce74f315ba2773be31747e089c77e955415362d0de93c6f0ac5e2d844086
+  data.tar.gz: 91ef8ff69dc8e7d8aa987d0296a45a04c02e3dc35c7466dbc2b872bf8345d43e
 SHA512:
-  metadata.gz: 42390d0d4f6bc5b6ee40a91deaeafc27c78c17fb2c4bd5663d91338dc376c5f22dfd818759cc9a627e8e3a1c7dded5a40b411baaae93faf124daa6c3a44f3620
-  data.tar.gz: 89f9c9ceab9e07ad7884fadb389830b5ff2f8cc36d9eda4898c17366fc8a1433179f956f79961c7b808bd644b8d688618e06b0147567ccafaa3d5e2bf37ec690
+  metadata.gz: a530d61cdf3023d1c9df3881ce151e346b15480f5b7ff067d69801cfc07597047d7b5985cc991e72b93a8ed7a6e33408687dbc324bc5ccc0ce4f316a1d915434
+  data.tar.gz: 244fd82157219579145a47d20f21734b77923b5ad88b0dd725f85ea37c371f588dd510b48cf8fc259c0d2ed0be89d9e8f1dd3d3a848bf746b6dff11669eb1f4a

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/version.rb

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

data/lib/swiftner.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swiftner
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Martin Ulleberg
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-23 00:00:00.000000000 Z
+date: 2024-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -38,7 +38,9 @@ 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
@@ -53,7 +55,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
@@ -68,8 +70,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
-signing_key:
+rubygems_version: 3.5.3
+signing_key: 
 specification_version: 4
 summary: API wrapper for Swiftner's AI transcription service.
 test_files: []