swiftner 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2012383224b63c20920e314f1f475b3ceefc371b6ffb304b4bab51a8ae2cd8e5
-  data.tar.gz: 38a3b6e70c2387d6f71992e95c45e22d003f0c4a5772e5fa3cfa18076dd21e42
+  metadata.gz: df81ce74f315ba2773be31747e089c77e955415362d0de93c6f0ac5e2d844086
+  data.tar.gz: 91ef8ff69dc8e7d8aa987d0296a45a04c02e3dc35c7466dbc2b872bf8345d43e
 SHA512:
-  metadata.gz: 3014179290cf659595aaa9d44be639e44c6be0a88ace20146dc8f0069200355aad675252604022f57e0fba793a927d1ae94e242eedc2ce099dd2a00532b56e2e
-  data.tar.gz: ad51894f768e7bdfccc9f1079e4337b67a17f56993bd20fd228623e1c149fbe104781c7e44055915ef5f9a583228cab3e4bd3262686a1ca2dcc9b6c139b919c1
+  metadata.gz: a530d61cdf3023d1c9df3881ce151e346b15480f5b7ff067d69801cfc07597047d7b5985cc991e72b93a8ed7a6e33408687dbc324bc5ccc0ce4f316a1d915434
+  data.tar.gz: 244fd82157219579145a47d20f21734b77923b5ad88b0dd725f85ea37c371f588dd510b48cf8fc259c0d2ed0be89d9e8f1dd3d3a848bf746b6dff11669eb1f4a

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.0
   NewCops: enable
 
 Style/StringLiterals:

data/README.md

@@ -25,8 +25,11 @@ This section includes syntax examples of some of the key features of the Swiftne
 
 ### Initializing the Client
 ```ruby
-@api_key = "swiftner_api_key"
-@client = Swiftner::Client.new(@api_key)
+api_key = "swiftner_api_key"
+
+Swiftner.configure do |config|
+  config.client = Swiftner::Client.new(api_key)
+end
 ```
 
 ### Working with Video Content
@@ -60,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

@@ -10,7 +10,26 @@ module Swiftner
         new(details)
       end
 
-      def initialize(attributes = {}, client = Base.client)
+      def self.client
+        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?
+
         @id = attributes["id"]
         @details = attributes
         @client = client

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

@@ -7,12 +7,12 @@ module Swiftner
     # Provides methods for interacting with transcriptions.
     class Transcription < Service
       def self.find(transcription_id)
-        response = Base.client.get("/transcription/get/#{transcription_id}")
+        response = client.get("/transcription/get/#{transcription_id}")
         build(response.parsed_response)
       end
 
       def self.create(attributes)
-        response = Base.client.post(
+        response = client.post(
           "/transcription/create",
           body: attributes.to_json,
           headers: { "Content-Type" => "application/json" }

data/lib/swiftner/API/upload.rb

@@ -7,17 +7,17 @@ module Swiftner
     # to an upload.
     class Upload < Service
       def self.find_uploads
-        response = Base.client.get("/upload/get-uploads/")
-        response.map { |upload| build(upload) }
+        response = client.get("/upload/get-uploads/")
+        map_collection(response)
       end
 
       def self.find(upload_id)
-        response = Base.client.get("/upload/get/#{upload_id}")
+        response = client.get("/upload/get/#{upload_id}")
         build(response.parsed_response)
       end
 
       def self.create(attributes)
-        response = Base.client.post(
+        response = client.post(
           "/upload/create",
           body: attributes.to_json,
           headers: { "Content-Type" => "application/json" }

data/lib/swiftner/API/video_content.rb

@@ -6,12 +6,12 @@ module Swiftner
     # It allows you to find and update video content.
     class VideoContent < Service
       def self.find_video_contents
-        response = Base.client.get("/video-content/get-all/")
-        response.map { |upload| build(upload) }
+        response = client.get("/video-content/get-all/")
+        map_collection(response)
       end
 
       def self.find(id)
-        response = Base.client.get("/video-content/get/#{id}")
+        response = client.get("/video-content/get/#{id}")
         build(response.parsed_response)
       end
 

data/lib/swiftner/client.rb

@@ -16,7 +16,7 @@ module Swiftner
 
     %i[get post put delete].each do |http_method|
       define_method(http_method) do |path, options = {}|
-        response = self.class.public_send(http_method, build_path(path), options)
+        response = self.class.public_send(http_method, path, options)
         handle_response(response)
       end
     end
@@ -27,11 +27,6 @@ module Swiftner
 
     private
 
-    def build_path(path)
-      # This is temporary solution because server doesn't accept the API Key in headers for some reason.
-      "#{path}?api_key_query=#{ENV.fetch("SWIFTNER_API_KEY", "swiftner-api-key")}"
-    end
-
     def handle_response(response)
       case response.code
       when 200 then response

data/lib/swiftner/configuration.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Swiftner
+  ## `Swiftner::Configuration`
+  class Configuration
+    attr_accessor :client
+
+    def initialize
+      @client = nil
+    end
+  end
+end

data/lib/swiftner/version.rb

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

data/lib/swiftner.rb

@@ -1,10 +1,12 @@
 # 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/base"
+require_relative "swiftner/API/linked_content"
+require_relative "swiftner/configuration"
 require_relative "swiftner/client"
 require_relative "swiftner/version"
 
@@ -16,7 +18,12 @@ module Swiftner
   class NotFound < Error; end
   class InternalError < Error; end
 
-  def self.create_client(api_key)
-    Base.client = Client.new(api_key)
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
   end
 end

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.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Martin Ulleberg
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-13 00:00:00.000000000 Z
+date: 2024-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -38,13 +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/base.rb
 - lib/swiftner/client.rb
+- lib/swiftner/configuration.rb
 - lib/swiftner/version.rb
+- swiftner.gemspec
 homepage: https://swiftner.com
 licenses: []
 metadata:
@@ -52,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
@@ -60,15 +63,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !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: []

data/lib/swiftner/base.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Swiftner
-  ## `Swiftner::Base`
-  class Base
-    @client = nil
-
-    class << self
-      attr_accessor :client
-    end
-  end
-end