swiftner 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2012383224b63c20920e314f1f475b3ceefc371b6ffb304b4bab51a8ae2cd8e5
-  data.tar.gz: 38a3b6e70c2387d6f71992e95c45e22d003f0c4a5772e5fa3cfa18076dd21e42
+  metadata.gz: 0bccfb7a6a850c917d592bd4dbfaf84ed83f167443056642653e151e029c10e0
+  data.tar.gz: a8d9567709a73226085a560cb1ada880075067407276002eec0584e908520f47
 SHA512:
-  metadata.gz: 3014179290cf659595aaa9d44be639e44c6be0a88ace20146dc8f0069200355aad675252604022f57e0fba793a927d1ae94e242eedc2ce099dd2a00532b56e2e
-  data.tar.gz: ad51894f768e7bdfccc9f1079e4337b67a17f56993bd20fd228623e1c149fbe104781c7e44055915ef5f9a583228cab3e4bd3262686a1ca2dcc9b6c139b919c1
+  metadata.gz: 42390d0d4f6bc5b6ee40a91deaeafc27c78c17fb2c4bd5663d91338dc376c5f22dfd818759cc9a627e8e3a1c7dded5a40b411baaae93faf124daa6c3a44f3620
+  data.tar.gz: 89f9c9ceab9e07ad7884fadb389830b5ff2f8cc36d9eda4898c17366fc8a1433179f956f79961c7b808bd644b8d688618e06b0147567ccafaa3d5e2bf37ec690

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

data/lib/swiftner/API/service.rb

@@ -10,7 +10,13 @@ module Swiftner
         new(details)
       end
 
-      def initialize(attributes = {}, client = Base.client)
+      def self.client
+        Swiftner.configuration.client
+      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/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 = client.get("/upload/get-uploads/")
         response.map { |upload| build(upload) }
       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 = client.get("/video-content/get-all/")
         response.map { |upload| build(upload) }
       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.3"
 end

data/lib/swiftner.rb

@@ -4,7 +4,7 @@ require_relative "swiftner/API/service"
 require_relative "swiftner/API/transcription"
 require_relative "swiftner/API/upload"
 require_relative "swiftner/API/video_content"
-require_relative "swiftner/base"
+require_relative "swiftner/configuration"
 require_relative "swiftner/client"
 require_relative "swiftner/version"
 
@@ -16,7 +16,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.3
 platform: ruby
 authors:
 - Martin Ulleberg
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-13 00:00:00.000000000 Z
+date: 2024-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -42,9 +42,10 @@ files:
 - 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:
@@ -60,7 +61,7 @@ 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:
   - - ">="

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