lightcast-ruby 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e84099140e62596cbb9183473bfebee944442e8dbedc4fac70b8c5935c168c1
-  data.tar.gz: a00a7882cd0025d56927bf3b8b695904d168e7bfc347478f6d770ed8667c9b7b
+  metadata.gz: 5cd267666687cc842b14716d54d109c96180cbbb6c4ddd980324beb15f59de38
+  data.tar.gz: 5057ff614595e005a8460972a23fa934d98fe3ea5950d1c212ec118ac3e76fa5
 SHA512:
-  metadata.gz: '08905bbcf66ab46fbc0fd337c6ad54aa8bdc8416f1c915d400f871f91e61fa9a80ee2bcf8417bfb8e1df3356f2d862b829666a82846a8e8a3fada84a615ce3b4'
-  data.tar.gz: dfc54efac8196b4c12f3a439b62dc4ac8f24c607085ca83ada13c9f5a430e9793dbf32bfc490a0cc60ade9755e628f2c9550ad55d9ba9f187e3a8e1590b6c361
+  metadata.gz: de74703364201614aa14d343ddbe1c96841987ac26a2e235f5aab5624830282063c107aa559dc2c5737bb8c4e80c4f7b5c077e59349e2c32d4533a80fe47a515
+  data.tar.gz: 7410aaa39b0dec37ac8116c9a410be16358b5e0927b90febc4674f87665b87c674fae5fb536930831a7a2b26ff71f7bb136511884a84243551f7b380ebdc47a7

data/CHANGELOG.md

@@ -1 +1,15 @@
+## v0.2.1
+
+Upgrade faraday dependency to >=2.0.1
+
+## v0.2.0
+
+Switched from using of Skills API to Classification API
+
+## v0.1.0
+
+Initial release of the gem. 
+
+- Added basic skills API endpoints
+
 ## [Unreleased]

data/Gemfile

@@ -4,7 +4,7 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'faraday', '~> 1.0', '>= 1.0.0'
+gem 'faraday', '>= 2.0.1'
 
 group :development, :test do
   gem 'rake', '~> 13.0.6'

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    lightcast-ruby (0.1.0)
-      faraday (~> 1.0, >= 1.0.0)
+    lightcast-ruby (0.2.1)
+      faraday (>= 2.0.1)
 
 GEM
   remote: https://rubygems.org/
@@ -13,32 +13,14 @@ GEM
     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)
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
+    faraday-net_http (3.1.0)
+      net-http
     hashdiff (1.0.1)
     json (2.6.3)
-    multipart-post (2.3.0)
+    net-http (0.4.1)
+      uri
     parallel (1.23.0)
     parser (3.2.2.3)
       ast (~> 2.4.1)
@@ -85,19 +67,20 @@ GEM
       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)
+    uri (0.13.0)
     webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  x86_64-darwin-20
   x86_64-darwin-22
   x86_64-linux
 
 DEPENDENCIES
-  faraday (~> 1.0, >= 1.0.0)
+  faraday (>= 2.0.1)
   lightcast-ruby!
   rake (~> 13.0.6)
   rspec (~> 3.12.0)

data/README.md

@@ -1,12 +1,13 @@
+[![Gem Version](https://badge.fury.io/rb/lightcast-ruby.svg)](https://badge.fury.io/rb/lightcast-ruby)
 [![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:
+Lightcast Classification APIs documentation can be found here:
 
-https://docs.lightcast.dev/apis
+https://docs.lightcast.dev/apis/classification
 
 ## Installation
 
@@ -28,7 +29,7 @@ Create your client
 client = Lightcast::Client.new(
   client_id: '123ABC'
   client_secret: '456DEF'
-  scope: 'profiles:us',
+  scope: 'classifications_api',
 )
 ```
 
@@ -45,7 +46,7 @@ Now you can make use of any of your available APIs for your client.
 You can access the skills API via
 
 ```ruby
-client.skills(version: 'latest')
+client.skills(version: '9.0.0', release: '2024.7')
 ```
 
 where the optional version is any valid version.
@@ -55,10 +56,10 @@ where the optional version is any valid version.
 Extract skills from plain text.
 
 ```ruby
-client.skills.extract({ text: 'blah blah blah' }, { language: 'en', confidence_threshold: 0.5 })
+skills.extract(text:'computer science is a cool thing to study')
 ```
 
-[API docs](https://docs.lightcast.dev/apis/skills#versions-version-extract)
+[API docs](https://docs.lightcast.dev/apis/classification#post-extract-skills)
 
 #### Skills Get
 
@@ -68,27 +69,46 @@ Get a single skill.
 client.skills.get(123)
 ```
 
-[API docs](https://docs.lightcast.dev/apis/skills#versions-version-skills-skill_id)
+[API docs](https://docs.lightcast.dev/apis/classification#get-get-a-concept-by-id)
+
+#### Skills List
+
+List skills.
+
+```ruby
+client.skills.post(
+   fields: ['name'],
+   filter: {
+     level: ['2'],
+     id: [
+      "someId",
+      "anotherId"
+     ]
+   },
+   limit: 5)
+```
+
+[API docs](https://docs.lightcast.dev/apis/classification#post-list-requested-taxonomy-concepts)
 
 #### Skills Related
 
 Get related skills from provided skills.
 
 ```ruby
-client.related.get(ids: ['12345', 'abcde'])
+client.related.get(ids: ['12345', 'abcde'], relationType: 'sibling')
 ```
 
-[API docs](https://docs.lightcast.dev/apis/skills#versions-version-related)
+[API docs](https://docs.lightcast.dev/apis/classification#post-list-requested-taxonomy-concepts)
 
 #### Skills Status
 
-Get the status of the skills API.
+Get the status of the classifications API.
 
 ```ruby
 client.skills.status
 ```
 
-[API docs](https://docs.lightcast.dev/apis/skills#status)
+[API docs](https://docs.lightcast.dev/apis/classification#get-get-service-status)
 
 ### Errors
 
@@ -108,4 +128,4 @@ Any error code returned by the Lightcast API will result in one of the following
 
 ## License
 
-Copyright (C) 2023 Riipen. See [LICENSE](https://github.com/riipen/lightcast-ruby/blob/master/LICENSE.md) for details.
+Copyright (C) 2023 Riipen. See [LICENSE](https://github.com/riipen/lightcast-ruby/blob/master/LICENSE.md) for details.

data/lib/lightcast-ruby/authentication.rb

@@ -7,7 +7,8 @@ module Lightcast
                                       {
                                         client_id: @client_id,
                                         client_secret: @client_secret,
-                                        grant_type: 'client_credentials'
+                                        grant_type: 'client_credentials',
+                                        scope: @scope
                                       },
                                       {
                                         body: :form,

data/lib/lightcast-ruby/client.rb

@@ -7,7 +7,7 @@ module Lightcast
     include Lightcast::Authentication
 
     BASE_URL_AUTH     = 'https://auth.emsicloud.com'
-    BASE_URL_SERVICES = 'https://emsiservices.com'
+    BASE_URL_SERVICES = 'https://classification.emsicloud.com'
 
     def initialize(client_id:, client_secret:, scope:)
       @client_id      = client_id
@@ -18,15 +18,15 @@ module Lightcast
     end
 
     def connection_auth
-      Connection.new(url: BASE_URL_AUTH)
+      Connection.new(url: BASE_URL_AUTH, scope: @scope)
     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)
+    def skills(version: '9.0.0', release: '2024.7')
+      @skills ||= Lightcast::Services::Skills.new(client: self, version: version, release: release)
     end
   end
 end

data/lib/lightcast-ruby/connection.rb

@@ -6,9 +6,10 @@ module Lightcast
   class Connection
     attr_accessor :access_token, :url
 
-    def initialize(url:, access_token: nil)
+    def initialize(url:, access_token: nil, scope: 'classification_api')
       @access_token = access_token
       @url          = url
+      @scope = scope
     end
 
     def delete(path, **params)

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

@@ -3,27 +3,32 @@
 module Lightcast
   module Services
     class Skills
-      def initialize(client:, version:)
+      def initialize(client:, version:, release:)
         @client   = client
         @version  = version
+        @release = release
       end
 
-      def extract(body = {}, query = { language: 'en', confidence_threshold: 0 })
+      def extract(**params)
         @client.connection_services.post(
-          "/skills/versions/#{@version}/extract?language=#{query[:language]}&confidenceThreshold=#{query[:confidence_threshold]}", body
+          "/classifications/#{@release}/skills/extract", **params
         )
       end
 
       def get(id)
-        @client.connection_services.get("/skills/versions/#{@version}/skills/#{id}")
+        @client.connection_services.get("/taxonomies/skills/versions/#{@version}/concepts/#{id}")
+      end
+
+      def list(**params)
+        @client.connection_services.post("/taxonomies/skills/versions/#{@version}/concepts", **params)
       end
 
       def related(**params)
-        @client.connection_services.post("/skills/versions/#{@version}/related", **params)
+        @client.connection_services.post("/taxonomies/skills/versions/#{@version}/relations", **params)
       end
 
       def status
-        @client.connection_services.get('/skills/status')
+        @client.connection_services.get('/status')
       end
     end
   end

data/lib/lightcast-ruby/version.rb

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

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: lightcast-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jordan Ell
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-16 00:00:00.000000000 Z
+date: 2024-04-12 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
+        version: 2.0.1
   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
+        version: 2.0.1
 description: Access the Lightcast REST API.
 email:
 executables: []