cognitive_faculty 1.1.1 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: db22ea0ff87524ade5a234577d2af3ec975d7288
-  data.tar.gz: 82927f74143fb5b9dd768058fd14af54f9976bcb
+SHA256:
+  metadata.gz: a1c78a5552d4d4af308e816866272d3f7be296b5a7bee2add05db61436a599e0
+  data.tar.gz: cb98e2311b120b2205b9360b39338bce0d581017aa79ff10ecc21cbc71a08d40
 SHA512:
-  metadata.gz: b620ce2f951c151898541edf0c21853e180e1a8228717308dc7a23a8a76a9cc708ea05b246774ee119b12b88962d027d2b79b1052f0f27a89ec6c71fc520e04a
-  data.tar.gz: 1ededc5585851c9a5be94d541c6d1ce9af9cf4feae2e08dfe7c5c60eb58f919806f3edd99ffa73e456cade9d1ea40c18cbfc36c29012daf7f600c63664044fdc
+  metadata.gz: 3c0ea41abb42a32e132e0eb36b66039af027962a52731ebc75f1cb8893fcb3c561a87cc3f8c32293ad1df04e2aae25d13432db3770ecd1f79a3615567a17a626
+  data.tar.gz: 9bb19d71734bffd5f564123025fcb9b5ad7e7e32db563cab1a8014a09def2eb794eb65abf0eac3b974d0fb585d1ba3c66f4c6a25ef6c11bb9ba2dbaf5d0f04cf

data/Gemfile.lock

@@ -1,71 +1,69 @@
 PATH
   remote: .
   specs:
-    cognitive_faculty (1.1.1)
-      activemodel (~> 4.2.10)
-      activesupport (~> 4.2.10)
+    cognitive_faculty (3.0.0)
+      activemodel (~> 6.0.2.1)
+      activesupport (~> 6.0.2.1)
       faraday_middleware (~> 0.12.2)
-      her (~> 0.8.1)
+      her (~> 1.1.0)
       oauth2 (~> 1.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (4.2.11.1)
-      activesupport (= 4.2.11.1)
-      builder (~> 3.1)
-    activesupport (4.2.11.1)
-      i18n (~> 0.7)
+    activemodel (6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activesupport (6.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
     ast (2.4.0)
-    builder (3.2.3)
-    concurrent-ruby (1.1.5)
+    concurrent-ruby (1.1.6)
     diff-lcs (1.3)
-    faraday (0.15.4)
+    faraday (0.17.3)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.12.2)
       faraday (>= 0.7.4, < 1.0)
-    her (0.8.6)
-      activemodel (>= 3.0.0, <= 6.0.0)
-      activesupport (>= 3.0.0, <= 6.0.0)
+    her (1.1.0)
+      activemodel (>= 4.2.1)
       faraday (>= 0.8, < 1.0)
       multi_json (~> 1.7)
-    i18n (0.9.5)
+    i18n (1.8.3)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.1)
-    jwt (2.1.0)
-    minitest (5.11.3)
-    multi_json (1.13.1)
+    jaro_winkler (1.5.4)
+    jwt (2.2.1)
+    minitest (5.14.1)
+    multi_json (1.14.1)
     multi_xml (0.6.0)
-    multipart-post (2.1.0)
-    oauth2 (1.4.1)
-      faraday (>= 0.8, < 0.16.0)
+    multipart-post (2.1.1)
+    oauth2 (1.4.4)
+      faraday (>= 0.8, < 2.0)
       jwt (>= 1.0, < 3.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
-    parallel (1.12.1)
-    parser (2.5.1.2)
+    parallel (1.19.1)
+    parser (2.7.0.4)
       ast (~> 2.4.0)
     powerpack (0.1.2)
-    rack (2.0.7)
+    rack (2.2.3)
     rainbow (3.0.0)
     rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
     rubocop (0.58.2)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -74,21 +72,22 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.10.0)
+    ruby-progressbar (1.10.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    unicode-display_width (1.4.0)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 2.1.4)
   cognitive_faculty!
   rake (~> 10.0)
   rspec (~> 3.0)
   rubocop (~> 0.58.2)
 
 BUNDLED WITH
-   1.16.4
+   2.1.4

data/README.md

@@ -20,16 +20,19 @@ Or install it yourself as:
 
 ## Usage
 
+Your application must be configured in AppID (NOTE: Single-Page App's do not work because they don't provide you a secret).
+
+To use this service, you will need to supply a client ID, secret, and oauth server URL. See below for implementation, or __[click here for more information on how to obtain AppID config info](https://cloud.ibm.com/docs/appid?topic=appid-obtain-tokens#credentials-gui)__.
+
 ```ruby
+# example implementation
 require 'cognitive_faculty'
 
 CognitiveFaculty.configure do |c|
-  c.url = "https://platform.cognitivefaculty.com/api"
-  c.auth.url = "https://accounts.cognitivefaculty.com"
-  c.auth.client_id = "client id"
-  c.auth.client_secret = "secret"
-  c.auth.username = "username"
-  c.auth.password = "password"
+  c.url = "https://platform.skills.network/api"
+  c.auth.client_id = "<AppID Client ID>"
+  c.auth.client_secret = "<AppID Secret>"
+  c.auth.oauth_server_url = "<AppID oauth Server URL>"
 end
 
 CognitiveFaculty::Offer.all.each do |o|
@@ -42,3 +45,7 @@ end
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Testing
+
+Fill out the values in `testy/main.rb` and then run `ruby testy/main.rb` for an easy way to test the Platform API.

data/cognitive_faculty.gemspec

@@ -19,14 +19,14 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler", "~> 2.1.4"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rubocop", "~> 0.58.2"
 
-  spec.add_dependency "activemodel", "~> 4.2.10"
-  spec.add_dependency "activesupport", "~> 4.2.10"
-  spec.add_dependency "faraday_middleware", "~> 0.12.2"
-  spec.add_dependency "her", "~> 0.8.1"
-  spec.add_dependency "oauth2", "~> 1.4.0"
+  spec.add_dependency "activemodel", ">= 6.0"
+  spec.add_dependency "activesupport", ">= 6.0.2.1"
+  spec.add_dependency "faraday_middleware", ">= 0.12.2"
+  spec.add_dependency "her", ">= 1.1.0"
+  spec.add_dependency "oauth2", ">= 1.4.0"
 end

data/lib/cognitive_faculty.rb

@@ -10,12 +10,10 @@ require "cognitive_faculty/configuration/configuration"
 #
 # Usage:
 #   CognitiveFaculty.configure do |c|
-#     c.url = "https://platform.cognitivefaculty.com/api"
-#     c.auth.url = "https://accounts.cognitivefaculty.com"
-#     c.auth.client_id = "client id"
-#     c.auth.client_secret = "secret"
-#     c.auth.username = "username"
-#     c.auth.password = "password"
+#     c.url = "https://platform.skills.network/api"
+#     c.auth.client_id = "<AppID Client ID>"
+#     c.auth.client_secret = "<AppID Secret>"
+#     c.auth.oauth_server_url = "<AppID oauth Server URL>"
 #   end
 #
 #   CognitiveFaculty::Offer.all.each do |o|

data/lib/cognitive_faculty/configuration/auth.rb

@@ -7,16 +7,13 @@ module CognitiveFaculty
     # Authorization configuration for Cognitive Faculty Platform API.
     #
     # Attributes:
-    #   +url+: URL for authorization server.
     #   +client_id+: Client ID used to request an acces token.
     #   +client_secret+: Client secret used to request an access token.
-    #   +username+: Username for requesting a token using the +password+ strategy.
-    #   +password+: Password for requesting a token using the +password+ strategy.
-    #   +realm+: Keycloak realm to use. Deafults to +master+.
+    #   +tenant_id+: AppID tenant id
+    #   +oauth_server_url+: AppID oauth server URL
     #   +token+: (read-only) OIDC access token.
     class Auth
-      attr_accessor :url, :client_id, :client_secret, :username, :password,
-                    :realm
+      attr_accessor :client_id, :client_secret, :tenant_id, :oauth_server_url
       attr_reader :token
 
       def initialize
@@ -29,12 +26,9 @@ module CognitiveFaculty
       end
 
       def update_token
-        opts = {
-          site: url,
-          token_url: "/auth/realms/#{realm}/protocol/openid-connect/token"
-        }
+        opts = { token_url: "#{oauth_server_url}/token" }
         oauth2 = OAuth2::Client.new(client_id, client_secret, opts)
-        @token = oauth2.password.get_token(username, password)
+        @token = oauth2.client_credentials.get_token(:username => client_id, :password => client_secret)
       end
     end
   end

data/lib/cognitive_faculty/version.rb

@@ -1,3 +1,3 @@
 module CognitiveFaculty
-  VERSION = "1.1.1".freeze
+  VERSION = "3.0.1".freeze
 end

data/testy/main.rb

@@ -0,0 +1,12 @@
+require 'cognitive_faculty'
+
+CognitiveFaculty.configure do |c|
+  c.url = "http://localhost:8080/api"
+  c.auth.client_id = "<client_id>"
+  c.auth.client_secret = "<client_secret>"
+  c.auth.oauth_server_url = "<oauth server url>"
+end
+
+CognitiveFaculty::Offer.all.each do |o|
+  puts o.name
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cognitive_faculty
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 3.0.1
 platform: ruby
 authors:
 - Luiz Aoqui
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-11 00:00:00.000000000 Z
+date: 2020-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -70,70 +70,70 @@ dependencies:
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.10
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.10
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.10
+        version: 6.0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.10
+        version: 6.0.2.1
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.2
 - !ruby/object:Gem::Dependency
   name: her
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.0
 description: Ruby gem for the Cognitive Faculty API.
@@ -162,10 +162,11 @@ files:
 - lib/cognitive_faculty/models/code.rb
 - lib/cognitive_faculty/models/offer.rb
 - lib/cognitive_faculty/version.rb
+- testy/main.rb
 homepage: https://cognitivefaculty.com
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -180,9 +181,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Cognitive Faculty Ruby SDK
 test_files: []