swiftner 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2012383224b63c20920e314f1f475b3ceefc371b6ffb304b4bab51a8ae2cd8e5
+  data.tar.gz: 38a3b6e70c2387d6f71992e95c45e22d003f0c4a5772e5fa3cfa18076dd21e42
+SHA512:
+  metadata.gz: 3014179290cf659595aaa9d44be639e44c6be0a88ace20146dc8f0069200355aad675252604022f57e0fba793a927d1ae94e242eedc2ce099dd2a00532b56e2e
+  data.tar.gz: ad51894f768e7bdfccc9f1079e4337b67a17f56993bd20fd228623e1c149fbe104781c7e44055915ef5f9a583228cab3e4bd3262686a1ca2dcc9b6c139b919c1

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## [Unreleased]
+
+## [0.0.2] - 2024-02-13
+
+-  Adds the first services supported.
+
+## [0.0.1] - 2024-02-02
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at martin.ulleberg@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/README.md

@@ -0,0 +1,87 @@
+> [!WARNING]
+> Please note that this client is under active development and is not yet ready for production use.  We encourage you to try out its features and provide feedback, and if you're comfortable contributing to an in-progress project, we welcome your help in improving it. However, we recommend against deploying it to a production environment until its features have been more thoroughly tested and stabilized. We appreciate your understanding and patience!
+
+# Swiftner API Ruby Client
+
+This is a Ruby client for interacting with the Swiftner API. It allows you to work with videos, transcriptions, errors, and perform various actions such as uploading, deleting, updating, and fetching information. This client make it easier to deal with HTTP requests by providing a Ruby-oriented interface with built-in error handling.
+
+## Requirements
+
+- Ruby version: 3.0.0 or later
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add swiftner
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install swiftner
+
+## Usage
+
+This section includes syntax examples of some of the key features of the Swiftner API Ruby client.
+
+### Initializing the Client
+```ruby
+@api_key = "swiftner_api_key"
+@client = Swiftner::Client.new(@api_key)
+```
+
+### Working with Video Content
+```ruby
+@video_content_service = Swiftner::API::VideoContent
+
+# Find video contents
+video_contents = @video_content_service.find_video_contents
+
+# Find specific video content by ID
+video_content = @video_content_service.find(1)
+
+# Update the title of a video content
+video_content.update(title: "New title")
+```
+
+### Working with Uploads
+```ruby
+@upload_service = Swiftner::API::Upload
+
+# Find uploads
+uploads = @upload_service.find_uploads
+
+# Create an upload
+upload = @upload_service.create(sample_attributes)
+
+# Delete an upload
+upload.delete
+
+# Transcribe an upload
+upload.transcribe("no")
+```
+
+### 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
+begin
+  # some code that might raise an exception
+rescue Swiftner::Forbidden => e
+  puts "Handle forbidden error here"
+rescue Swiftner::Unauthorized => e
+  puts "Handle unauthorized error here"
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/swiftner/swiftner_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/swiftner/swiftner_ruby/blob/main/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the Swiftner project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/swiftner/swiftner_ruby/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/swiftner/API/service.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Swiftner
+  module API
+    # The `Service` class acts as a base class for API operations and data encapsulation.
+    class Service
+      attr_reader :id, :details, :client
+
+      def self.build(details)
+        new(details)
+      end
+
+      def initialize(attributes = {}, client = Base.client)
+        @id = attributes["id"]
+        @details = attributes
+        @client = client
+      end
+    end
+  end
+end

data/lib/swiftner/API/transcription.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Swiftner
+  module API
+    # Represents a Transcription service responsible for finding, creating, and deleting transcriptions.
+    # Inherits from the Service class.
+    # Provides methods for interacting with transcriptions.
+    class Transcription < Service
+      def self.find(transcription_id)
+        response = Base.client.get("/transcription/get/#{transcription_id}")
+        build(response.parsed_response)
+      end
+
+      def self.create(attributes)
+        response = Base.client.post(
+          "/transcription/create",
+          body: attributes.to_json,
+          headers: { "Content-Type" => "application/json" }
+        )
+
+        build(response.parsed_response)
+      end
+
+      def delete
+        client.delete("/transcription/delete/#{id}")
+      end
+    end
+  end
+end

data/lib/swiftner/API/upload.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Swiftner
+  module API
+    # The `Upload` class is responsible for managing uploads in the Swiftner API.
+    # It provides methods for finding uploads, creating uploads, deleting uploads, and retrieving transcriptions related
+    # to an upload.
+    class Upload < Service
+      def self.find_uploads
+        response = Base.client.get("/upload/get-uploads/")
+        response.map { |upload| build(upload) }
+      end
+
+      def self.find(upload_id)
+        response = Base.client.get("/upload/get/#{upload_id}")
+        build(response.parsed_response)
+      end
+
+      def self.create(attributes)
+        response = Base.client.post(
+          "/upload/create",
+          body: attributes.to_json,
+          headers: { "Content-Type" => "application/json" }
+        )
+        build(response.parsed_response) if response.success?
+      end
+
+      def delete
+        client.delete("/upload/delete/#{id}")
+      end
+
+      def transcriptions
+        response = client.get("/upload/get/#{id}/transcriptions")
+        response.map { |transcription| API::Transcription.build(transcription) }
+      end
+
+      def transcribe(language)
+        transcription = {
+          video_content_id: id,
+          language: language,
+          start: 0.0,
+          end: details["duration"],
+          duration: details["duration"]
+        }
+        API::Transcription.create(transcription)
+      end
+    end
+  end
+end

data/lib/swiftner/API/video_content.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Swiftner
+  module API
+    # VideoContent class represents video content in the Swiftner API.
+    # 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) }
+      end
+
+      def self.find(id)
+        response = Base.client.get("/video-content/get/#{id}")
+        build(response.parsed_response)
+      end
+
+      def update(attributes)
+        attributes = attributes.transform_keys(&:to_s)
+        @details = @details.merge(attributes)
+
+        client.put(
+          "/video-content/update/#{id}",
+          body: @details.to_json,
+          headers: { "Content-Type" => "application/json" }
+        )
+        self
+      end
+    end
+  end
+end

data/lib/swiftner/base.rb

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

data/lib/swiftner/client.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "httparty"
+
+module Swiftner
+  # Initializes a new instance of the Client class.
+  #
+  # @param api_key [String] The API key to be used for authentication.
+  class Client
+    include HTTParty
+    base_uri "https://api.swiftner.com"
+
+    def initialize(api_key)
+      self.class.headers "Api_Key_Header" => api_key
+    end
+
+    %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)
+        handle_response(response)
+      end
+    end
+
+    def check_health
+      get("/health")
+    end
+
+    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
+      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"
+      end
+    end
+  end
+end

data/lib/swiftner/version.rb

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

data/lib/swiftner.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+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/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
+
+  def self.create_client(api_key)
+    Base.client = Client.new(api_key)
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: swiftner
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Martin Ulleberg
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+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.
+email:
+- martin.ulleberg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- README.md
+- Rakefile
+- lib/swiftner.rb
+- lib/swiftner/API/service.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/version.rb
+homepage: https://swiftner.com
+licenses: []
+metadata:
+  homepage_uri: https://swiftner.com
+  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:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: API wrapper for Swiftner's AI transcription service.
+test_files: []