lightcast-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e84099140e62596cbb9183473bfebee944442e8dbedc4fac70b8c5935c168c1
+  data.tar.gz: a00a7882cd0025d56927bf3b8b695904d168e7bfc347478f6d770ed8667c9b7b
+SHA512:
+  metadata.gz: '08905bbcf66ab46fbc0fd337c6ad54aa8bdc8416f1c915d400f871f91e61fa9a80ee2bcf8417bfb8e1df3356f2d862b829666a82846a8e8a3fada84a615ce3b4'
+  data.tar.gz: dfc54efac8196b4c12f3a439b62dc4ac8f24c607085ca83ada13c9f5a430e9793dbf32bfc490a0cc60ade9755e628f2c9550ad55d9ba9f187e3a8e1590b6c361

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,49 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.6
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - spec/**/*
+
+Naming/FileName:
+  Enabled: true
+  Exclude:
+    - lib/lightcast-ruby.rb
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/SubjectStub:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 150

data/CHANGELOG.md

@@ -0,0 +1 @@
+## [Unreleased]

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'faraday', '~> 1.0', '>= 1.0.0'
+
+group :development, :test do
+  gem 'rake', '~> 13.0.6'
+  gem 'rspec', '~> 3.12.0'
+  gem 'rspec_junit_formatter', '~> 0.6.0'
+  gem 'rubocop', '~> 1.52.1'
+  gem 'rubocop-rspec', '~> 2.22.0'
+  gem 'webmock', '~> 3.18.1'
+end

data/Gemfile.lock

@@ -0,0 +1,110 @@
+PATH
+  remote: .
+  specs:
+    lightcast-ruby (0.1.0)
+      faraday (~> 1.0, >= 1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    faraday (1.10.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    hashdiff (1.0.1)
+    json (2.6.3)
+    multipart-post (2.3.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    public_suffix (5.0.3)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rspec_junit_formatter (0.6.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (1.52.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-rspec (2.22.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.4.2)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  faraday (~> 1.0, >= 1.0.0)
+  lightcast-ruby!
+  rake (~> 13.0.6)
+  rspec (~> 3.12.0)
+  rspec_junit_formatter (~> 0.6.0)
+  rubocop (~> 1.52.1)
+  rubocop-rspec (~> 2.22.0)
+  webmock (~> 3.18.1)
+
+BUNDLED WITH
+   2.4.10

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Riipen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,111 @@
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/riipen/lightcast-ruby/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/riipen/lightcast-ruby/tree/main)
+
+# Lightcast Ruby
+
+An API client for the Lightcast REST APIs in ruby.
+
+Lightcast APIs documentation can be found here:
+
+https://docs.lightcast.dev/apis
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'lightcast-ruby'
+```
+
+Then `bundle install`.
+
+## Usage
+
+### Quick Start
+
+Create your client
+
+```ruby
+client = Lightcast::Client.new(
+  client_id: '123ABC'
+  client_secret: '456DEF'
+  scope: 'profiles:us',
+)
+```
+
+and then create an authentication token that lasts 1 hour
+
+```ruby
+client.authenticate
+```
+
+Now you can make use of any of your available APIs for your client.
+
+### Skills API
+
+You can access the skills API via
+
+```ruby
+client.skills(version: 'latest')
+```
+
+where the optional version is any valid version.
+
+#### Skills Extract
+
+Extract skills from plain text.
+
+```ruby
+client.skills.extract({ text: 'blah blah blah' }, { language: 'en', confidence_threshold: 0.5 })
+```
+
+[API docs](https://docs.lightcast.dev/apis/skills#versions-version-extract)
+
+#### Skills Get
+
+Get a single skill.
+
+```ruby
+client.skills.get(123)
+```
+
+[API docs](https://docs.lightcast.dev/apis/skills#versions-version-skills-skill_id)
+
+#### Skills Related
+
+Get related skills from provided skills.
+
+```ruby
+client.related.get(ids: ['12345', 'abcde'])
+```
+
+[API docs](https://docs.lightcast.dev/apis/skills#versions-version-related)
+
+#### Skills Status
+
+Get the status of the skills API.
+
+```ruby
+client.skills.status
+```
+
+[API docs](https://docs.lightcast.dev/apis/skills#status)
+
+### Errors
+
+Any error code returned by the Lightcast API will result in one of the following expections
+
+|Code|Exception|
+|----|---------|
+|400| Lightcast::BadRequest|
+|401| Lightcast::Unauthorized|
+|403| Lightcast::Forbidden|
+|404| Lightcast::NotFound|
+|410| Lightcast::Gone|
+|4xx| Lightcast::ClientError|
+|500| Lightcast::InternalServerError|
+|503| Lightcast::ServiceUnavailable|
+|5xx| Lightcast::ServerError|
+
+## License
+
+Copyright (C) 2023 Riipen. See [LICENSE](https://github.com/riipen/lightcast-ruby/blob/master/LICENSE.md) for details.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/lightcast-ruby/authentication.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Lightcast
+  module Authentication
+    def authenticate # rubocop:disable Metrics/MethodLength
+      response = connection_auth.post('/connect/token',
+                                      {
+                                        client_id: @client_id,
+                                        client_secret: @client_secret,
+                                        grant_type: 'client_credentials'
+                                      },
+                                      {
+                                        body: :form,
+                                        content_type: 'application/x-www-form-urlencoded'
+                                      })
+
+      # Set the client values inline
+      @access_token = response['access_token']
+
+      # Give a chance to the invoker of the client to do something with the response
+      response
+    end
+  end
+end

data/lib/lightcast-ruby/client.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'services/skills'
+
+module Lightcast
+  class Client
+    include Lightcast::Authentication
+
+    BASE_URL_AUTH     = 'https://auth.emsicloud.com'
+    BASE_URL_SERVICES = 'https://emsiservices.com'
+
+    def initialize(client_id:, client_secret:, scope:)
+      @client_id      = client_id
+      @client_secret  = client_secret
+      @scope          = scope
+
+      @skills = nil
+    end
+
+    def connection_auth
+      Connection.new(url: BASE_URL_AUTH)
+    end
+
+    def connection_services
+      Connection.new(access_token: @access_token, url: BASE_URL_SERVICES)
+    end
+
+    def skills(version: 'latest')
+      @skills ||= Lightcast::Services::Skills.new(client: self, version: version)
+    end
+  end
+end

data/lib/lightcast-ruby/connection.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module Lightcast
+  class Connection
+    attr_accessor :access_token, :url
+
+    def initialize(url:, access_token: nil)
+      @access_token = access_token
+      @url          = url
+    end
+
+    def delete(path, **params)
+      request(:delete, path, params)
+    end
+
+    def get(path, **params)
+      request(:get, path, params)
+    end
+
+    def head(path, **params)
+      request(:head, path, params)
+    end
+
+    def post(path, params = {}, options = {})
+      request(:post, path, params, options)
+    end
+
+    def put(path, **params)
+      request(:put, path, params)
+    end
+
+    def request(method, path, params, options = {}) # rubocop:disable Metrics/MethodLength
+      response = connection.public_send(method, path, params) do |request|
+        request.headers['accept'] = 'application/json'
+        request.headers['Authorization'] = "Bearer #{@access_token}" if @access_token
+
+        if options[:body] == :form
+          request.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+          request.body = URI.encode_www_form(params)
+        end
+      end
+
+      error = Error.from_response(response)
+
+      raise error if error
+
+      response.body
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new(url: @url) do |c|
+        c.request :json, content_type: /\bjson$/
+        c.response :json, content_type: /\bjson$/
+        c.request :url_encoded, content_type: /x-www-form-urlencoded/
+        c.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/lightcast-ruby/error.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Lightcast
+  class Error < StandardError
+    attr_reader :response
+
+    def self.from_response(response) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength:
+      klass =
+        case response.status
+        when 400 then BadRequest
+        when 401 then Unauthorized
+        when 403 then Forbidden
+        when 404 then NotFound
+        when 429 then TooManyRequests
+        when 400..499 then ClientError
+        when 500 then InternalServerError
+        when 503 then ServiceUnavailable
+        when 500..599 then ServerError
+        end
+
+      klass&.new(response)
+    end
+
+    def initialize(response = nil)
+      @response = response
+
+      super(build_error_message)
+    end
+
+    private
+
+    def build_error_message
+      return nil if @response.nil? || !@response.body['errors']
+
+      "#{@response.body.dig("errors", 0, "title")}: #{@response.body.dig("errors", 0, "detail")}"
+    end
+  end
+
+  class ClientError < Error; end
+  class BadRequest < Error; end
+  class Unauthorized < Error; end
+  class Forbidden < Error; end
+  class NotFound < Error; end
+  class TooManyRequests < Error; end
+  class ServerError < Error; end
+  class InternalServerError < Error; end
+  class BadGateway < Error; end
+  class ServiceUnavailable < Error; end
+end

data/lib/lightcast-ruby/services/skills.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Lightcast
+  module Services
+    class Skills
+      def initialize(client:, version:)
+        @client   = client
+        @version  = version
+      end
+
+      def extract(body = {}, query = { language: 'en', confidence_threshold: 0 })
+        @client.connection_services.post(
+          "/skills/versions/#{@version}/extract?language=#{query[:language]}&confidenceThreshold=#{query[:confidence_threshold]}", body
+        )
+      end
+
+      def get(id)
+        @client.connection_services.get("/skills/versions/#{@version}/skills/#{id}")
+      end
+
+      def related(**params)
+        @client.connection_services.post("/skills/versions/#{@version}/related", **params)
+      end
+
+      def status
+        @client.connection_services.get('/skills/status')
+      end
+    end
+  end
+end

data/lib/lightcast-ruby/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Lightcast
+  VERSION = '0.1.0'
+end

data/lib/lightcast-ruby.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'lightcast-ruby/services/skills'
+
+require 'lightcast-ruby/authentication'
+require 'lightcast-ruby/client'
+require 'lightcast-ruby/connection'
+require 'lightcast-ruby/error'
+require 'lightcast-ruby/version'

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: lightcast-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jordan Ell
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Access the Lightcast REST API.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/lightcast-ruby.rb
+- lib/lightcast-ruby/authentication.rb
+- lib/lightcast-ruby/client.rb
+- lib/lightcast-ruby/connection.rb
+- lib/lightcast-ruby/error.rb
+- lib/lightcast-ruby/services/skills.rb
+- lib/lightcast-ruby/version.rb
+homepage: https://github.com/riipen/lightcast-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/riipen/lightcast-ruby
+  source_code_uri: https://github.com/riipen/lightcast-ruby
+  changelog_uri: https://github.com/riipen/lightcast-ruby/blob/master/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.3.7
+signing_key:
+specification_version: 4
+summary: An API client for Lightcast in ruby.
+test_files: []