omniauth-cognitiveclass 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f25927e30eed937ef8d492234120de5e59be1a88
+  data.tar.gz: 4fccf0f731e16146217165ab2ffdd74376c4c76d
+SHA512:
+  metadata.gz: 433bd16ace6add06618d5691d5483f4fc990b99b3b3552c63a473774571ca7a60543f4f768c54eebe49462fb05bd562b92e1df17c635baf7aa648857f553c08e
+  data.tar.gz: a7857c2a55acbd0b7692a44a068758f28372f09385db8016963060b92523095fbd0aa62bad06c731217e4e0f584a8ff2e791d66e6eb14c424d3a6d61978f42b7

data/.editorconfig

@@ -0,0 +1,23 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+charset      = utf-8
+indent_size  = 2
+indent_style = space
+tab_width    = 2
+
+end_of_line              = lf   # Not supported in RubyMine
+insert_final_newline     = true # Not supported in RubyMine
+trim_trailing_whitespace = true # Not supported in RubyMine
+
+[Makefile]
+indent_style = tab
+indent_size  = 8
+
+[*.{py,js,css}]
+indent_size = 4
+tab_width = 4

data/.env.example

@@ -0,0 +1,5 @@
+unset RUBYGEMS_HOST
+
+export COGNITIVE_SITE="https://courses.cognitiveclass.ai/"
+export COGNITIVE_AUTHORIZE_URL="https://courses.cognitiveclass.ai/oauth2/authorize"
+export COGNITIVE_TOKEN_URL="https://courses.cognitiveclass.ai/oauth2/access_token"

data/.gitignore

@@ -0,0 +1,111 @@
+.env
+.idea
+
+# Created by https://www.gitignore.io/api/rubymine,ruby
+
+### RubyMine ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff:
+.idea/workspace.xml
+.idea/tasks.xml
+
+# Sensitive or high-churn files:
+.idea/dataSources/
+.idea/dataSources.ids
+.idea/dataSources.xml
+.idea/dataSources.local.xml
+.idea/sqlDataSources.xml
+.idea/dynamic.xml
+.idea/uiDesigner.xml
+
+# Gradle:
+.idea/gradle.xml
+.idea/libraries
+
+# Mongo Explorer plugin:
+.idea/mongoSettings.xml
+
+## File-based project format:
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+### RubyMine Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# End of https://www.gitignore.io/api/rubymine,ruby

data/.rubocop.yml

@@ -0,0 +1,89 @@
+# inherit_from: ../.rubocop.yml
+
+# Common configuration.
+AllCops:
+  # Include gemspec and Rakefile
+  Include:
+    - '**/Rakefile'
+    - '**/*.jbuilder'
+  Exclude:
+    - 'bin/rails'
+    - 'bin/rake'
+    - 'bin/spring'
+    - 'config/initializers/*'
+    # - 'config/routes.rb'
+    - 'db/migrate/**/*'
+    - 'db/schema.rb'
+    - 'secure_rails'
+    - 'test/**/*'
+    - 'tmp/**/*'
+    
+Rails:
+  Enabled: true
+
+# # Not compatible with Rails < 4
+# ActionFilter:
+#   Enabled: false
+
+AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+ClassLength:
+  Max: 300
+
+# Crashes in Rubocop 0.21.0
+Delegate:
+  Enabled: true
+
+Encoding:
+  Enabled: false
+
+# Not compatible with Rails < 4
+# FindBy:
+#   Enabled: false
+
+IndentHash:
+  EnforcedStyle: consistent
+
+HasAndBelongsToMany:
+  Enabled: false
+
+LineLength:
+  Max: 120
+
+# Default 10
+MethodLength:
+  Max: 30
+
+# Default 15
+Metrics/AbcSize:
+  Max: 30
+
+StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/AlignHash:
+  # Alignment of entries using colon as separator. Valid values are:
+  #
+  # key - left alignment of keys
+  # a: 0
+  # bb: 1
+  # separator - alignment of colons, keys are right aligned
+  # a: 0
+  # bb: 1
+  # table - left alignment of keys and values
+  # a: 0
+  # bb: 1
+  EnforcedColonStyle: table
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/SpaceBeforeFirstArg:
+  Enabled: false
+
+Style/CommandLiteral:
+  EnforcedStyle: percent_x

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [0.4.0] - 2017-05-16
+### Changed
+-   Gem renamed to `omniauth-cognitiveclass` and open sourced

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dswb.gemspec
+group :test do
+  gem "rspec", "~> 3.4"
+
+  gem "simplecov"
+end
+gemspec

data/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: .
+  specs:
+    omniauth-cognitiveclass (0.4.1)
+      omniauth-oauth2 (~> 1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    bundler-audit (0.5.0)
+      bundler (~> 1.2)
+      thor (~> 0.18)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.11.0)
+      multipart-post (>= 1.2, < 3)
+    hashie (3.5.5)
+    json (2.0.2)
+    jwt (1.5.6)
+    multi_json (1.12.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    oauth2 (1.3.1)
+      faraday (>= 0.8, < 0.12)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    omniauth (1.3.2)
+      hashie (>= 1.2, < 4)
+      rack (>= 1.0, < 3)
+    omniauth-oauth2 (1.4.0)
+      oauth2 (~> 1.0)
+      omniauth (~> 1.2)
+    parser (2.3.3.1)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rack (2.0.1)
+    rainbow (2.2.1)
+    rake (12.0.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.46.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thor (0.19.4)
+    unicode-display_width (1.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler-audit (~> 0.5)
+  omniauth-cognitiveclass!
+  rake (~> 12.0)
+  rspec (~> 3.4)
+  rubocop (~> 0.46)
+  simplecov
+
+BUNDLED WITH
+   1.13.6

data/LICENSE.md

@@ -0,0 +1,19 @@
+(c) Copyright IBM Corporation 2017
+
+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/Makefile

@@ -0,0 +1,20 @@
+.PHONY: build clean precommit push
+
+VERSION:=$(shell cat VERSION)
+
+build: precommit tag
+	gem build *.gemspec
+
+clean:
+	rm *.gem
+
+push: build
+	gem push *-$(VERSION).gem
+	make clean
+
+precommit:
+	-rubocop -Da
+	bundle-audit check --update
+
+tag:
+	git tag -f v$(VERSION)

data/README.md

@@ -0,0 +1,52 @@
+# omniauth-cognitiveclass
+
+`omniauth-cognitiveclass` is a strategy (plugin or extension) for OmniAuth, 
+which is a Ruby authentication library. OmniAuth integrates transparently 
+with Devise, a popular Rails authentication solution.
+
+[Cognitive Class](https://courses.cognitiveclass.ai/) is also known as Big
+Data University. It's based on the OpenEdx platform
+
+## Usage with Devise
+
+Add this to your Gemfile:
+
+```ruby
+gem "omniauth-cognitiveclass", "~> 0.4.0"
+```
+
+Install the gem:
+
+```bash 
+bundle install
+```
+
+Define these environment variables for your Ruby application:
+
+```bash
+export COGNITIVE_SITE="https://courses.cognitiveclass.ai/"
+export COGNITIVE_AUTHORIZE_URL="https://courses.cognitiveclass.ai/oauth2/authorize"
+export COGNITIVE_TOKEN_URL="https://courses.cognitiveclass.ai/oauth2/access_token"
+
+export COGNITIVE_ID="..."
+export COGNITIVE_SECRET="..."
+
+export MY_ORIGIN="http://example.com:3000"
+```
+
+Add this to your `config/initializers/devise.rb`:
+
+```ruby
+callback_url = "#{ENV.fetch('MY_ORIGIN')}}/users/auth/bdu/callback"
+
+config.omniauth :cognitive_class, ENV.fetch("COGNITIVE_ID"), ENV.fetch("COGNITIVE_SECRET"),
+  callback_url:           callback_url,
+  provider_ignores_state: true
+```
+
+Follow the other steps from the [Devise OmniAuth Guide](https://github.com/plataformatec/devise/wiki/OmniAuth:-Overview).
+
+## See Also
+
+*   <https://github.com/omniauth/omniauth/wiki>
+*   <https://github.com/intridea/omniauth-oauth2>

data/VERSION

@@ -0,0 +1 @@
+0.4.1

data/lib/omniauth/strategies/cognitive_class.rb

@@ -0,0 +1,60 @@
+require "omniauth-oauth2"
+
+module OmniAuth
+  module Strategies
+    class CognitiveClass < OmniAuth::Strategies::OAuth2
+      # Give your strategy a name.
+      option :name, "cognitive_class"
+
+      # This is where you pass the options you would pass when
+      # initializing your consumer from the OAuth gem.
+      option :client_options,
+        site:          "https://courses.bigdatauniversity.com/",
+        authorize_url: "https://courses.bigdatauniversity.com/oauth2/authorize",
+        token_url:     "https://courses.bigdatauniversity.com/oauth2/access_token"
+
+      option :authorize_params, scope: "openid profile email"
+
+      # https://github.com/intridea/omniauth-oauth2/issues/32
+      option :provider_ignores_state, true
+
+      # These are called after authentication has succeeded. If
+      # possible, you should try to set the UID without making
+      # additional calls (if the user id is returned with the token
+      # or as a URI parameter). This may not be possible with all
+      # providers.
+
+      # Raw info: { "family_name"=>"...",
+      # "sub"=>"1ea...c61",
+      # "locale"=>"en",
+      # "preferred_username"=>"...",
+      # "given_name"=>"...", "email"=>"...",
+      # "name"=>"..."}
+
+      uid { raw_info["sub"] }
+
+      info do
+        {
+          email:              raw_info["email"],
+          family_name:        raw_info["family_name"],
+          given_name:         raw_info["given_name"],
+          locale:             raw_info["locale"],
+          name:               raw_info["name"],
+          preferred_username: raw_info["preferred_username"]
+        }
+      end
+
+      extra do
+        {
+          "raw_info" => raw_info
+        }
+      end
+
+      def raw_info
+        access_token.options[:mode] = :query
+        user_headers = { headers: { "Authorization" => "Bearer #{access_token.token}" } }
+        @raw_info ||= access_token.get("/oauth2/user_info", user_headers).parsed
+      end
+    end
+  end
+end

data/lib/omniauth_cognitive_class.rb

@@ -0,0 +1 @@
+require "omniauth/strategies/cognitive_class"

data/omniauth-cognitiveclass.gemspec

@@ -0,0 +1,44 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-cognitiveclass"
+  spec.version       = File.open("VERSION", "r").read.strip
+  spec.authors       = ["Leons Petrazickis"]
+  spec.email         = ["support@cognitiveclass.ai"]
+  spec.summary       = "CognitiveClass strategy for the Omniauth Oauth2 Ruby library "
+  spec.description   = "`omniauth-cognitiveclass` is a strategy (plugin or extension) for OmniAuth,
+                        which is a Ruby authentication library. OmniAuth integrates transparently
+                        with Devise, a popular Rails authentication solution.
+
+                        [Cognitive Class](https://courses.cognitiveclass.ai/) is also known as Big
+                        Data University. It's based on the OpenEdx platform"
+  spec.homepage      = "https://github.com/cognitiveclass/omniauth-cognitiveclass"
+  spec.license       = "MIT"
+
+  # TODO: Remove dependency on git
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  # To install the gem locally:
+  # bundle exec rake install
+  spec.add_development_dependency "bundler-audit", "~> 0.5"
+
+  spec.add_development_dependency "rake", "~> 12.0"
+
+  # Unit tests
+  spec.add_development_dependency "rspec", "~> 3.4"
+
+  # Test coverage report
+  spec.add_development_dependency "simplecov", "~> 0.12"
+
+  # Automatic Ruby code style checking tool. Aims to enforce the community-driven
+  # Ruby Style Guide.
+  # https://github.com/bbatsov/rubocop
+  spec.add_development_dependency "rubocop", "~> 0.46"
+
+  spec.add_runtime_dependency "omniauth-oauth2", "~> 1.4"
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-cognitiveclass
+version: !ruby/object:Gem::Version
+  version: 0.4.1
+platform: ruby
+authors:
+- Leons Petrazickis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.46'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.46'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: |-
+  `omniauth-cognitiveclass` is a strategy (plugin or extension) for OmniAuth,
+                          which is a Ruby authentication library. OmniAuth integrates transparently
+                          with Devise, a popular Rails authentication solution.
+
+                          [Cognitive Class](https://courses.cognitiveclass.ai/) is also known as Big
+                          Data University. It's based on the OpenEdx platform
+email:
+- support@cognitiveclass.ai
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".env.example"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- Makefile
+- README.md
+- VERSION
+- lib/omniauth/strategies/cognitive_class.rb
+- lib/omniauth_cognitive_class.rb
+- omniauth-cognitiveclass.gemspec
+homepage: https://github.com/cognitiveclass/omniauth-cognitiveclass
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: CognitiveClass strategy for the Omniauth Oauth2 Ruby library
+test_files: []