chore: init commit

michaellzc · michaellzc · commit 06c3f5090330 · 2021-04-18T12:17:28.000-06:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status
diff --git a/.prettierrc.yml b/.prettierrc.yml
@@ -0,0 +1 @@
+rubySingleQuote: false
diff --git a/.rspec b/.rspec
@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -0,0 +1,5 @@
+inherit_gem:
+  prettier: rubocop.yml
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
diff --git a/Gemfile b/Gemfile
@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in omniauth-open-edx.gemspec
+gemspec
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) International Business Machines Corporation
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,41 @@
+# OmniAuth::OpenEdx
+
+This is the OmniAuth stragegy for authenticaing to Open edX.
+
+Note, this strategy only works with Open edX `juniper` release or above.
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem "omniauth-open-edx"
+```
+
+## Open edX OAuth2 Toolkit Setup
+
+- Go to `${LMS_URL}/admin/oauth2_provider/application`
+- Add a new application
+- Enter redirect url, this depends on your setup, learn more from [examples](./examples)
+- Select `Confidential` client type, `Authorization code` authorization grant type
+- Get the `Client id` and `Client secret` and configure them in your ruby application
+
+## Usage
+
+```ruby
+use OmniAuth::Builder do
+  provider :open_edx,
+           ENV["OPEN_EDX_OAUTH_CLIENT_ID"],
+           ENV["OPEN_EDX_OAUTH_CLIENT_SECRET"],
+           {
+             scope: "profile email",
+             client_options: {
+               site: "https://courses.edx.org",
+             },
+           }
+end
+```
+
+## License
+
+[MIT License](./LICENSE).
diff --git a/Rakefile b/Rakefile
@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
diff --git a/bin/console b/bin/console
@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "omniauth-open-edx"
+
+# 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__)
diff --git a/bin/setup b/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
diff --git a/examples/sinatra/Gemfile b/examples/sinatra/Gemfile
@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gem "omniauth-open-edx", path: "../../"
diff --git a/examples/sinatra/app.rb b/examples/sinatra/app.rb
@@ -0,0 +1,38 @@
+begin
+  require "sinatra"
+  require "omniauth"
+  require "omniauth-open-edx"
+rescue LoadError
+  require "rubygems"
+  require "sinatra"
+  require "omniauth"
+  require "omniauth-open-edx"
+end
+
+use Rack::Session::Cookie
+use OmniAuth::Builder do
+  provider :open_edx,
+           ENV["OPEN_EDX_OAUTH_CLIENT_ID"],
+           ENV["OPEN_EDX_OAUTH_CLIENT_SECRET"],
+           {
+             scope: "profile email",
+             client_options: {
+               site: "https://courses.edx.org"
+             }
+           }
+end
+
+get "/" do
+  <<-HTML
+  <a href='/auth/open_edx'>Sign in with Open edX</a>
+  HTML
+end
+
+get "/auth/:name/callback" do
+  auth = request.env["omniauth.auth"]
+  <<-HTML
+  <h1>You are logged in as #{auth["info"]["email"]}</h1>
+  <div>OmniAuth::AuthHash::InfoHash</div>
+  <span>#{auth["info"].to_json}</span>
+  HTML
+end
diff --git a/lib/omniauth-open-edx.rb b/lib/omniauth-open-edx.rb
@@ -0,0 +1,2 @@
+require "omniauth-open-edx/version"
+require "omniauth/strategies/open_edx"
diff --git a/lib/omniauth-open-edx/version.rb b/lib/omniauth-open-edx/version.rb
@@ -0,0 +1,5 @@
+module OmniAuth
+  module OpenEdx
+    VERSION = "1.0.0"
+  end
+end
diff --git a/lib/omniauth/strategies/open_edx.rb b/lib/omniauth/strategies/open_edx.rb
@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+# Learn more about the Open edX JWT Oauth2 flow
+# https://github.com/edx/edx-platform/blob/master/openedx/core/djangoapps/oauth_dispatch/docs/decisions/0003-use-jwt-as-oauth-tokens-remove-openid-connect.rst
+
+require "omniauth-oauth2"
+require "jwt"
+
+module OmniAuth
+  module Strategies
+    class OpenEdx < OmniAuth::Strategies::OAuth2
+      DEFAULT_SCOPE = "profile email"
+
+      option :name, "open_edx"
+      option :client_options,
+             site: "https://courses.edx.org",
+             authorize_url: "/oauth2/authorize",
+             token_url: "/oauth2/access_token"
+      option :scope, DEFAULT_SCOPE
+      option :authorize_options, [:scope]
+
+      option :token_options, [:token_type]
+      option :token_params, token_type: "jwt"
+
+      uid { raw_info["sub"] }
+
+      info do
+        {
+          name: raw_info["name"],
+          email: raw_info["email"],
+          username: raw_info["preferred_username"],
+          first_name: raw_info["given_name"],
+          last_name: raw_info["family_name"]
+        }
+      end
+
+      extra { { raw_info: raw_info } }
+
+      def raw_info
+        @raw_info ||= jwt_payload
+      end
+
+      def callback_url
+        # overwrite this function from omniauth
+        # https://github.com/omniauth/omniauth/blob/c2380ae848ce4e0e39b4bb94c5b8e3fd0a544825/lib/omniauth/strategy.rb#L444
+        # edx greatly dislikes when query_string is part of the callback_url
+        full_host + callback_path
+      end
+
+      def authorize_params
+        super.tap do |params|
+          %w[scope].each do |v|
+            params[v.to_sym] = request.params[v] if request.params[v]
+          end
+
+          params[:scope] ||= DEFAULT_SCOPE
+        end
+      end
+
+      private
+
+      def jwt_payload
+        JWT.decode(access_token.token, nil, false)[0]
+      end
+    end
+  end
+end
diff --git a/omniauth-open-edx.gemspec b/omniauth-open-edx.gemspec
@@ -0,0 +1,44 @@
+require_relative "lib/omniauth-open-edx/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "omniauth-open-edx"
+  spec.version = OmniAuth::OpenEdx::VERSION
+  spec.authors = ["Michael Lin"]
+  spec.email = ["mlzc@hey.com"]
+
+  spec.summary = "Open edX strategy for OmniAuth"
+  spec.description = "Open edX strategy for OmniAuth"
+  spec.homepage = "https://github.com/ibm-skills-network/omniauth-open-edx"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] =
+    "https://github.com/ibm-skills-network/omniauth-open-edx"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files =
+    Dir.chdir(File.expand_path(__dir__)) do
+      `git ls-files -z`.split("\x0").reject do |f|
+        f.match(%r{^(test|spec|features)/})
+      end
+    end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jwt", ">= 2.0"
+  spec.add_dependency "omniauth", [">= 1.9", "< 2"]
+  spec.add_dependency "omniauth-oauth2", ">= 1.4"
+
+  spec.add_development_dependency "bundler", ">= 2.0"
+  spec.add_development_dependency "prettier"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 3.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "webmock"
+end
diff --git a/spec/omniauth/strategies/open_edx_spec.rb b/spec/omniauth/strategies/open_edx_spec.rb
@@ -0,0 +1,55 @@
+require "spec_helper"
+
+RSpec.describe OmniAuth::Strategies::OpenEdx do
+  let(:jwt_token) do
+    "eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJTRVQtTUUtUExFQVNFIiwiZXhwIjoxNjE4ODA0NDkyLCJpYXQiOjE2MTg3Njg0OTIsImlzcyI6Imh0dHA6Ly9jb3Vyc2VzLmV4YW1wbGUuY29tL29hdXRoMiIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwic2NvcGVzIjpbInByb2ZpbGUiLCJlbWFpbCJdLCJ2ZXJzaW9uIjoiMS4yLjAiLCJzdWIiOiIxMmI3Mzk1MGUwZTRhMzluZmQwOTY0NzFhMmVjYSIsImZpbHRlcnMiOlsidXNlcjptZSJdLCJpc19yZXN0cmljdGVkIjpmYWxzZSwiZW1haWxfdmVyaWZpZWQiOnRydWUsIm5hbWUiOiJBZG1pbiIsImZhbWlseV9uYW1lIjoiIiwiZ2l2ZW5fbmFtZSI6IiIsImFkbWluaXN0cmF0b3IiOnRydWUsInN1cGVydXNlciI6dHJ1ZSwiZW1haWwiOiJhZG1pbkBleGFtcGxlLmNvbSJ9.bsCLLaIWhO0YFW-ODA9nN9nycltoPHUKLa4UPjZV2js"
+  end
+  let(:access_token) { double("AccessToken", token: jwt_token) }
+
+  let(:self_host_site) { "https://courses.example.com" }
+  let(:self_host) do
+    OmniAuth::Strategies::OpenEdx.new(
+      "CLIENT_ID",
+      "CLIENT_SECRET",
+      { client_options: { site: self_host_site } }
+    )
+  end
+
+  subject { OmniAuth::Strategies::OpenEdx.new({}) }
+
+  before { allow(subject).to receive(:access_token).and_return(access_token) }
+
+  context "client options" do
+    it "should have correct site" do
+      expect(subject.options.client_options.site).to eq(
+        "https://courses.edx.org"
+      )
+    end
+
+    it "should have correct authorization url path" do
+      expect(subject.options.client_options.authorize_url).to eq(
+        "/oauth2/authorize"
+      )
+    end
+
+    it "should have correct token url path" do
+      expect(subject.options.client_options.token_url).to eq(
+        "/oauth2/access_token"
+      )
+    end
+
+    describe "should be overridable" do
+      it "for site" do
+        expect(self_host.options.client_options.site).to eq(self_host_site)
+      end
+    end
+  end
+
+  context "info" do
+    it "should have correct user info" do
+      expect(subject.info[:name]).to eq("Admin")
+      expect(subject.info[:username]).to eq("admin")
+      expect(subject.info[:email]).to eq("admin@example.com")
+    end
+  end
+end
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rspec"
+require "rack/test"
+require "webmock/rspec"
+require "omniauth"
+require "omniauth-open-edx"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend OmniAuth::Test::StrategyMacros, type: :strategy
+end

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+--format documentation`
	`2`	`+--color`
	`3`	`+--require spec_helper`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +source "https://rubygems.org"
++
 +# Specify your gem's dependencies in omniauth-open-edx.gemspec
 +gemspec