cognitive_faculty 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2d252f53af2287701ad74a9c9037a337cd476a7c173c0512dbcf04308d92d34
+  data.tar.gz: ef1d662f15d69ed61a52fc960822b8c3c6482aadbee9ea67026203ef6dcf386e
+SHA512:
+  metadata.gz: 72ad0ca29b84c36ff88c985681a4772608634885dd0bb70a0842236225ee39bfcb469cbdfe747dbc9b089dbcddb94c21f4660ee6c5111ffb3ae99fa7547fb396
+  data.tar.gz: 75f267074dabbf2f6613f15e887905a353c74d191d78947da90aa47df1618c75d3b169e0bafaaf15358d8964fb97bc87b138a8b9868eb9cc3a7c7d0c5d4213f4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,9 @@
+# Common configuration.
+Layout/SpaceBeforeFirstArg:
+  Enabled: false
+
+LineLength:
+  Max: 120
+
+StringLiterals:
+  EnforcedStyle: double_quotes

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cognitive_faculty.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    cognitive_faculty (1.1.0)
+      activemodel (= 5.0.0)
+      activesupport (= 5.0.0)
+      faraday_middleware (~> 0.12.2)
+      her (~> 0.8.0)
+      oauth2 (~> 1.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.0.0)
+      activesupport (= 5.0.0)
+    activesupport (5.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    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)
+      faraday (>= 0.8, < 1.0)
+      multi_json (~> 1.7)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    jwt (2.2.1)
+    minitest (5.14.0)
+    multi_json (1.14.1)
+    multi_xml (0.6.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.19.1)
+    parser (2.7.1.1)
+      ast (~> 2.4.0)
+    psych (3.1.0)
+    rack (2.2.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    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.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.67.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.10.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17.3)
+  cognitive_faculty!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.67.0)
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,44 @@
+# CognitiveFaculty
+
+A Ruby gem for accessing the Cognitive Faculty API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cognitive_faculty'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cognitive_faculty
+
+## Usage
+
+```ruby
+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"
+end
+
+CognitiveFaculty::Offer.all.each do |o|
+  puts o.name
+end
+```
+
+## Development
+
+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).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cognitive_faculty"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cognitive_faculty.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cognitive_faculty/version"
+
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
+  spec.name          = "cognitive_faculty"
+  spec.version       = CognitiveFaculty::VERSION
+  spec.authors       = ["Luiz Aoqui"]
+  spec.email         = ["laoqui@ca.ibm.com"]
+
+  spec.summary       = "Cognitive Faculty Ruby SDK"
+  spec.description   = "Ruby gem for the Cognitive Faculty API."
+  spec.homepage      = "https://cognitivefaculty.com"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = "exe"
+  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 "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.67.0"
+
+  spec.add_dependency "activemodel", "= 5.0.0"
+  spec.add_dependency "activesupport", "= 5.0.0"
+  spec.add_dependency "faraday_middleware", "~> 0.12.2"
+  spec.add_dependency "her", "~> 0.8.0"
+  spec.add_dependency "oauth2", "~> 1.4.0"
+end

data/lib/cognitive_faculty.rb

@@ -0,0 +1,64 @@
+require "her"
+require "faraday"
+require "faraday_middleware"
+
+require "cognitive_faculty/version"
+require "cognitive_faculty/configuration/configuration"
+
+##
+# Cognitive Faculty API client for Ruby.
+#
+# 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"
+#   end
+#
+#   CognitiveFaculty::Offer.all.each do |o|
+#     puts o.name
+#   end
+#
+module CognitiveFaculty
+  class << self
+    attr_accessor :configuration
+
+    private
+
+    def setup_her
+      api = Her::API.setup url: configuration.url do |c|
+        # Request
+        c.use AccessTokenMiddleware
+        c.use Faraday::Request::UrlEncoded
+
+        # Response
+        c.use Her::Middleware::DefaultParseJSON
+        c.use Faraday::Response::Logger, nil, body: true
+
+        # Adapter
+        c.use Faraday::Adapter::NetHttp
+      end
+      require "cognitive_faculty/models"
+      api
+    end
+
+    # Faraday middleware for adding the OIDC access token at each request.
+    # If the access token is expired, a new token will be requested.
+    class AccessTokenMiddleware < Faraday::Middleware
+      def call(env)
+        token = CognitiveFaculty.configuration.auth.access_token
+        env[:request_headers]["Authorization"] = "Bearer #{token}"
+        @app.call(env)
+      end
+    end
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+    setup_her
+  end
+end

data/lib/cognitive_faculty/configuration/auth.rb

@@ -0,0 +1,41 @@
+require "uri"
+require "oauth2"
+
+module CognitiveFaculty
+  class Configuration
+    ##
+    # 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+.
+    #   +token+: (read-only) OIDC access token.
+    class Auth
+      attr_accessor :url, :client_id, :client_secret, :username, :password,
+                    :realm
+      attr_reader :token
+
+      def initialize
+        @realm = "master"
+      end
+
+      def access_token
+        update_token if token.nil? || token.expired?
+        token.token
+      end
+
+      def update_token
+        opts = {
+          site: url,
+          token_url: "/auth/realms/#{realm}/protocol/openid-connect/token"
+        }
+        oauth2 = OAuth2::Client.new(client_id, client_secret, opts)
+        @token = oauth2.password.get_token(username, password)
+      end
+    end
+  end
+end

data/lib/cognitive_faculty/configuration/configuration.rb

@@ -0,0 +1,17 @@
+require "cognitive_faculty/configuration/auth"
+
+module CognitiveFaculty
+  ##
+  # Configuration object for `CognitiveFaculty` API client.
+  #
+  # Attributes
+  #   +auth+: CognitiveFaculty::Configuration::Auth object
+  #   +url+: URL for the Cognitive Faculty Platform API
+  class Configuration
+    attr_accessor :auth, :url
+
+    def initialize
+      @auth = Auth.new
+    end
+  end
+end

data/lib/cognitive_faculty/models.rb

@@ -0,0 +1,3 @@
+require "cognitive_faculty/models/code"
+require "cognitive_faculty/models/offer"
+require "cognitive_faculty/models/badge"

data/lib/cognitive_faculty/models/badge.rb

@@ -0,0 +1,38 @@
+module CognitiveFaculty
+  ##
+  # Model for a Badge
+  class Badge
+    include Her::Model
+
+    primary_key :id
+
+    def issue(lp_certs_url, learning_path, opts = {})
+      opts["badge_template_id"] = id
+      opts["email"] = opts[:to][:email]
+      opts["first_name"] = opts[:to][:name].split(" ", 2).first
+      opts["last_name"] = opts[:to][:name].split(" ", 2).last
+      return false unless eligible?(lp_certs_url, learning_path, opts[:to])
+      self.class.post_raw("/api/badges", opts) do |parsed_data|
+        parsed_data[:data][:success]
+      end
+    end
+
+    def issued_badge(email)
+      self.class.get_raw("/api/badges/#{id}/issued?email=#{email}") do |data|
+        if data[:data][:issued]
+          data[:data][:badge]
+        else
+          false
+        end
+      end
+    end
+
+    private
+
+    def eligible?(lp_certs_url, learning_path, user)
+      self.class.get_raw("#{lp_certs_url}/certificates/#{user[:username]}/#{learning_path[:slug]}/status") do |status|
+        status[:data][:eligible]
+      end
+    end
+  end
+end

data/lib/cognitive_faculty/models/code.rb

@@ -0,0 +1,10 @@
+module CognitiveFaculty
+  ##
+  # Model for an Offer Code
+  class Code
+    include Her::Model
+
+    parse_root_in_json true, format: :active_model_serializers
+    primary_key :code
+  end
+end

data/lib/cognitive_faculty/models/offer.rb

@@ -0,0 +1,31 @@
+module CognitiveFaculty
+  ##
+  # Model for an Offer
+  class Offer
+    include Her::Model
+
+    attr_accessor :description, :content
+
+    scope :active, (lambda do
+      has_batch_enabled = lambda do |offer|
+        offer.batches.select { |batch| batch["active"] }.size.positive?
+      end
+      all.select(&has_batch_enabled)
+    end)
+
+    # her < 1.0 can't parse codes properly because they under a root element
+    # has_many :codes
+
+    def claim(opts = {})
+      self.class.put_raw("/api/offers/#{id}/codes/claim", opts) do |parsed_data|
+        parsed_data[:data][:code]
+      end
+    end
+
+    def codes(opts = {})
+      self.class.get_raw("/api/offers/#{id}/codes", opts) do |parsed_data|
+        parsed_data[:data][:codes].map { |c| Code.new(c) }
+      end
+    end
+  end
+end

data/lib/cognitive_faculty/version.rb

@@ -0,0 +1,3 @@
+module CognitiveFaculty
+  VERSION = "1.1.0".freeze
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: cognitive_faculty
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Luiz Aoqui
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.67.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.67.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.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.
+email:
+- laoqui@ca.ibm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cognitive_faculty.gemspec
+- lib/cognitive_faculty.rb
+- lib/cognitive_faculty/configuration/auth.rb
+- lib/cognitive_faculty/configuration/configuration.rb
+- lib/cognitive_faculty/models.rb
+- lib/cognitive_faculty/models/badge.rb
+- lib/cognitive_faculty/models/code.rb
+- lib/cognitive_faculty/models/offer.rb
+- lib/cognitive_faculty/version.rb
+homepage: https://cognitivefaculty.com
+licenses: []
+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.1.2
+signing_key: 
+specification_version: 4
+summary: Cognitive Faculty Ruby SDK
+test_files: []