cognitive_faculty 1.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2d252f53af2287701ad74a9c9037a337cd476a7c173c0512dbcf04308d92d34
-  data.tar.gz: ef1d662f15d69ed61a52fc960822b8c3c6482aadbee9ea67026203ef6dcf386e
+  metadata.gz: b9e38316fa235a461b08865f23d0bc70a397dc8a3eab31345a02f8bbfb851985
+  data.tar.gz: ea8fc496a435a2c3a64e31eb89c9678831328f0609f2b7858e8bde93dfd1d379
 SHA512:
-  metadata.gz: 72ad0ca29b84c36ff88c985681a4772608634885dd0bb70a0842236225ee39bfcb469cbdfe747dbc9b089dbcddb94c21f4660ee6c5111ffb3ae99fa7547fb396
-  data.tar.gz: 75f267074dabbf2f6613f15e887905a353c74d191d78947da90aa47df1618c75d3b169e0bafaaf15358d8964fb97bc87b138a8b9868eb9cc3a7c7d0c5d4213f4
+  metadata.gz: 7f6026419cfd1429bae4f66e267a6e253d4e6f17dcf56face2f0796e697a3552f3bf3fe695235d7a48c242a923526ca9dea52c74201a140989b993bddfb0593f
+  data.tar.gz: 4c1562cc84360b754b4053f25946080746b84c6c43263c2a6316d1298982901a37d5ae220a819122dfb4ffef304a67ad62f73bee2bcba6d89972ea41afc24e89

data/.travis.yml

@@ -1,5 +1,5 @@
 sudo: false
 language: ruby
 rvm:
-  - 1.17.3
-before_install: gem install bundler -v 1.17.3
+  - 2.4.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile.lock

@@ -1,23 +1,24 @@
 PATH
   remote: .
   specs:
-    cognitive_faculty (1.1.0)
-      activemodel (= 5.0.0)
-      activesupport (= 5.0.0)
+    cognitive_faculty (3.0.0)
+      activemodel (~> 6.0.2.1)
+      activesupport (~> 6.0.2.1)
       faraday_middleware (~> 0.12.2)
-      her (~> 0.8.0)
+      her (~> 1.1.0)
       oauth2 (~> 1.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.0.0)
-      activesupport (= 5.0.0)
-    activesupport (5.0.0)
+    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)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
     ast (2.4.0)
     concurrent-ruby (1.1.6)
     diff-lcs (1.3)
@@ -25,16 +26,15 @@ GEM
       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.4)
     jwt (2.2.1)
-    minitest (5.14.0)
+    minitest (5.14.1)
     multi_json (1.14.1)
     multi_xml (0.6.0)
     multipart-post (2.1.1)
@@ -45,10 +45,10 @@ GEM
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
     parallel (1.19.1)
-    parser (2.7.1.1)
+    parser (2.7.0.4)
       ast (~> 2.4.0)
-    psych (3.1.0)
-    rack (2.2.2)
+    powerpack (0.1.2)
+    rack (2.2.3)
     rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.9.0)
@@ -64,29 +64,30 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
-    rubocop (0.67.2)
+    rubocop (0.58.2)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.5, != 2.5.1.1)
-      psych (>= 3.1.0)
+      powerpack (~> 0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.6)
+      unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.10.1)
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    unicode-display_width (1.5.0)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17.3)
+  bundler (~> 2.1.4)
   cognitive_faculty!
   rake (~> 10.0)
   rspec (~> 3.0)
-  rubocop (~> 0.67.0)
+  rubocop (~> 0.58.2)
 
 BUNDLED WITH
-   1.17.3
+   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.17.3"
+  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.67.0"
+  spec.add_development_dependency "rubocop", "~> 0.58.2"
 
-  spec.add_dependency "activemodel", "= 5.0.0"
-  spec.add_dependency "activesupport", "= 5.0.0"
+  spec.add_dependency "activemodel", "~> 6.0.2.1"
+  spec.add_dependency "activesupport", "~> 6.0.2.1"
   spec.add_dependency "faraday_middleware", "~> 0.12.2"
-  spec.add_dependency "her", "~> 0.8.0"
+  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.0".freeze
+  VERSION = "3.0.0".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.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Luiz Aoqui
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-26 00:00:00.000000000 Z
+date: 2020-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.3
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.3
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,42 +58,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.67.0
+        version: 0.58.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.67.0
+        version: 0.58.2
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.0.2.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.0.2.1
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -181,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Cognitive Faculty Ruby SDK
 test_files: []