argonuts-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab46eeb7dec91ab90a48e01bf6082116a8eb941b4777104d5b4d388952d1cbfb
+  data.tar.gz: 496bd20b0cb8c7f9a8556684840a1a3e91ae2eb9340f7da81b4bde6bbe21ad31
+SHA512:
+  metadata.gz: f55e87dda4006506fd344ef0706f46bc1d8bd269102d8e7afdc9a33ed2ab28b85e83ab02b18c1ba1a63a84db31ad2403eeae6c3c6a8748ccb53fbbeda1dd81a7
+  data.tar.gz: f28df646ced2df3ecea1c6ec7e6659f054a98a89c12fabcb53fdb7c30237a8baa42debebbd6be438b146037740e589d5bd381f6d78babd5cb7d87068dff25e18

data/README.md

@@ -0,0 +1,84 @@
+# Argonuts Ruby Library
+
+The Argonuts Ruby library provides access to the Argonuts API.
+
+## Documentation
+
+See the [full documentation](https://argonuts.co/docs).
+
+## Installation
+
+You can install it via rubygems:
+
+```console
+gem install argonuts-ruby
+```
+
+### Bundler
+
+In Gemfile:
+
+```ruby
+gem 'argonuts-ruby'
+```
+
+And then, type in your terminal:
+
+```console
+bundle install
+```
+
+## Usage
+
+The library needs you to set your API key which can be found in your [dashboard](https://argonuts.co/dashboard).
+
+
+```ruby
+Argonuts.api_key = 'api-key'
+
+Argonuts.notification = {
+  type: "http",
+  url: "https://yoursite.co/api/argonuts/webhook"
+}
+
+Argonuts.storage = {
+  url: "https://yoursite.co/api/argonuts/upload",
+}
+```
+
+## Creating a job
+
+```ruby
+Argonuts::Job.create(
+  input: { url: "https://yoursite.co/path/file.mp4" },
+  outputs: {
+    "jpg:300x": { path: "/image.jpg" },
+    "mp4:1080p": { path: "/1080p.mp4" },
+    "httpstream": {
+      hls: { path: "hls/" }
+    }
+  }
+)
+```
+
+## Getting information about a job
+
+```ruby
+Argonuts::Job.retrieve("OolQXaiU86NFki")
+```
+
+## Retrieving metadata
+
+```ruby
+Argonuts::Metadata.retrieve("OolQXaiU86NFki")
+
+```
+
+## Per-request configuration
+
+```ruby
+cli = Argonuts::Client.new(api_key: "api-key-prod")
+Argonuts::Job.create(job, client: cli)
+```
+
+*Released under the [MIT license](http://www.opensource.org/licenses/mit-license.php).*

data/argonuts-ruby.gemspec

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(::File.join(::File.dirname(__FILE__), "lib"))
+
+require "argonuts/version"
+
+Gem::Specification.new do |gem|
+  gem.name        = "argonuts-ruby"
+  gem.version     = Argonuts::VERSION
+  gem.summary     = "Client library provides access to the Argonuts API (argonuts.co)"
+  gem.description = "Official client library to the Argonuts API (argonuts.co)"
+  gem.author      = "Argonuts"
+  gem.email       = "admin@argonuts.co"
+  gem.homepage    = "https://argonuts.co"
+  gem.license     = "MIT"
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- test/*`.split("\n")
+  gem.require_paths = ["lib"]
+  gem.add_runtime_dependency "http"
+end

data/lib/argonuts/api.rb

@@ -0,0 +1,38 @@
+require "http"
+
+module Argonuts
+  # Argonuts::API is responsible for making API requests.
+  # It takes a Argonuts::Client to send api_key, endpoint and region.
+  class API
+    def self.headers(cli)
+      if cli.api_key.nil?
+        raise Argonuts::Error, "You must specify an API key with Argonuts.api_key="
+      end
+
+      HTTP.basic_auth(user: cli.api_key, pass: "").
+        headers(:user_agent => "Argonuts/v1 RubyBindings/#{Argonuts::VERSION}")
+    end
+
+    def self.request(verb, path, options={})
+      cli = options[:client] || Argonuts.default_client
+
+      case verb
+      when :get
+        resp = headers(cli).get("#{cli.endpoint}#{path}")
+      when :post
+        resp = headers(cli).post("#{cli.endpoint}#{path}", json: options[:json])
+      end
+
+      if resp.code > 399
+        # if response is 400 or 401, we return the error message and error code
+        if resp.code.between?(400, 401)
+          raise Argonuts::Error, "#{resp.parse["message"]} (code=#{resp.parse["error_code"]})"
+        else
+          raise Argonuts::Error, "Server returned HTTP status #{resp.code}."
+        end
+      end
+
+      return resp.parse
+    end
+  end
+end

data/lib/argonuts/client.rb

@@ -0,0 +1,31 @@
+module Argonuts
+  def self.default_client
+    Client.new({
+      api_key: Argonuts.api_key,
+      region: Argonuts.region,
+      endpoint: Argonuts.endpoint
+    })
+  end
+
+  class Client
+    attr_accessor :api_key, :endpoint, :region
+
+    def initialize(options={})
+      @api_key = options[:api_key]
+      @region = options[:region]
+      @endpoint = options[:endpoint]
+    end
+
+    def endpoint
+      if @endpoint
+        return @endpoint
+      end
+
+      # if @region
+      #   return "https://argonuts.co/api-#{@region}/v1"
+      # end
+
+      return Argonuts::ENDPOINT
+    end
+  end
+end

data/lib/argonuts/error.rb

@@ -0,0 +1,3 @@
+module Argonuts
+  class Error < RuntimeError; end
+end

data/lib/argonuts/job.rb

@@ -0,0 +1,42 @@
+module Argonuts
+  class Job < API
+    attr_reader :id, :created_at, :completed_at, :status, :progress, :errors, :output_urls
+
+    def initialize(attrs={})
+      @id = attrs["id"]
+      @created_at = attrs["created_at"]
+      @completed_at = attrs["completed_at"]
+      @status = attrs["status"]
+      @progress = attrs["progress"]
+      @errors = attrs["errors"]
+      @output_urls = attrs["output_urls"]
+    end
+
+    def self.retrieve(job_id, options={})
+      resp = API.request(:get, "/jobs/#{job_id}", options)
+      return Job.new(resp)
+    end
+
+    def self.create(job, options={})
+      resp = API.request(:post, "/jobs", options.merge({
+        json: apply_settings(job)
+      }))
+
+      return Job.new(resp)
+    end
+
+    def self.apply_settings(job)
+      if notification = Argonuts.notification
+        job[:notification] ||= {}
+        job[:notification].merge!(notification)
+      end
+
+      if storage = Argonuts.storage
+        job[:storage] ||= {}
+        job[:storage].merge!(storage)
+      end
+
+      return job
+    end
+  end
+end

data/lib/argonuts/metadata.rb

@@ -0,0 +1,7 @@
+module Argonuts
+  class Metadata
+    def self.retrieve(job_id, options={})
+      API.request(:get, "/metadata/jobs/#{job_id}/#{options.delete(:key)}", options)
+    end
+  end
+end

data/lib/argonuts/version.rb

@@ -0,0 +1,3 @@
+module Argonuts
+  VERSION = "0.1.0"
+end

data/lib/argonuts-ruby.rb

@@ -0,0 +1,50 @@
+require "argonuts/api"
+require "argonuts/error"
+require "argonuts/client"
+require "argonuts/job"
+require "argonuts/metadata"
+require "argonuts/version"
+
+module Argonuts
+  ENDPOINT = "https://argonuts.co/api/v1"
+
+  def self.api_key=(key)
+    @api_key = key
+  end
+
+  def self.api_key
+    @api_key
+  end
+
+  def self.region=(region)
+    @region = region
+  end
+
+  def self.region
+    @region
+  end
+
+  def self.endpoint=(endpoint)
+    @endpoint = endpoint
+  end
+
+  def self.endpoint
+    @endpoint
+  end
+
+  def self.notification=(notification)
+    @notification = notification
+  end
+
+  def self.notification
+    @notification
+  end
+
+  def self.storage=(storage)
+    @storage = storage
+  end
+
+  def self.storage
+    @storage
+  end
+end

data/test/argonuts_test.rb

@@ -0,0 +1,72 @@
+$LOAD_PATH.unshift(::File.join(::File.dirname(__FILE__), "..", "lib"))
+
+require "test/unit"
+require "argonuts-ruby"
+
+class ArgonutsTest < Test::Unit::TestCase
+  INPUT_URL = "https://argonuts.co/sample1080p.mp4"
+
+  def setup
+    Argonuts.api_key = ENV["ARGONUTS_API_KEY"]
+    Argonuts.endpoint = ENV["ARGONUTS_ENDPOINT"]
+
+    Argonuts.notification = {
+      type: "http",
+      url: ENV["ARGONUTS_WEBHOOK_URL"]
+    }
+  end
+
+  def create_job(j={}, options={})
+    Argonuts::Job.create({
+      input: { url: INPUT_URL },
+      outputs: {
+        mp4: { path: "/test_create_job.mp4", duration: 1 }
+      }
+    }.merge(j), options)
+  end
+
+  def test_argonuts_api_key
+    Argonuts.api_key = "apikey"
+    assert "apikey", Argonuts.api_key
+  end
+
+  def test_argonuts_default_endpoint
+    assert "https://argonuts.co/api/v1", Argonuts.endpoint
+  end
+
+  def test_overwrite_endpoint
+    myendpoint = "https://argonuts.local/api/v1"
+    Argonuts.endpoint = myendpoint
+
+    assert myendpoint, Argonuts.endpoint
+  end
+
+  def test_create_job
+    job = create_job
+    assert job.is_a?(Argonuts::Job)
+    assert_not_nil job.id
+    assert_equal "job.starting", job.status
+  end
+
+  def test_retrieve_job
+    job = Argonuts::Job.retrieve(create_job.id)
+    assert job.is_a?(Argonuts::Job)
+    assert_not_nil job.id
+    assert_equal "job.starting", job.status
+  end
+
+  def test_create_job_error
+    create_job(input: {url: "notvalidurl"})
+  rescue => e
+    assert_equal e.class, Argonuts::Error
+  end
+
+  def test_retrieve_metadata
+    job = create_job
+    sleep 10
+
+    md = Argonuts::Metadata.retrieve(job.id)
+    assert md.is_a?(Hash)
+    assert_not_nil md["metadata"]["input"]
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: argonuts-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Argonuts
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Official client library to the Argonuts API (argonuts.co)
+email: admin@argonuts.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- argonuts-ruby.gemspec
+- lib/argonuts-ruby.rb
+- lib/argonuts/api.rb
+- lib/argonuts/client.rb
+- lib/argonuts/error.rb
+- lib/argonuts/job.rb
+- lib/argonuts/metadata.rb
+- lib/argonuts/version.rb
+- test/argonuts_test.rb
+homepage: https://argonuts.co
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: Client library provides access to the Argonuts API (argonuts.co)
+test_files:
+- test/argonuts_test.rb