omniauth-mangoapps 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b9ce4ff51c32194eb653845bd3c9e45c3a5590ed113377b5636eb3f3fe7e509b
+  data.tar.gz: ff8874cc88db8cb6b784e8856fb822c9d1e28d934deb182a72547616647538e4
+SHA512:
+  metadata.gz: d554cfef85a9838591ded65b8e7cfcfb1cd1ac5f3c7ffd4bc7130fed4ff53977ad503941113b9f2686a46685a5b0784530c8b66248edafb6bc61d3af9394da55
+  data.tar.gz: c5480e4361a1ec1657ec9c93ecd9662c0ee0bb447a60feffa4fe70fe32f6bbb8e0fa3c4941b09b7defec382fcba1bced39caf168f7a30ec6894cf0e12628ed71

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Phillip Baker
+
+MIT License
+
+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/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run specs"
+RSpec::Core::RakeTask.new
+
+desc "Default: run specs."
+task :default => :spec
+task :test => :spec

data/lib/omniauth/strategies/mangoapps.rb

@@ -0,0 +1,87 @@
+require 'omniauth-oauth2'
+require 'multi_json'
+
+module OmniAuth
+  module Strategies
+    #
+    # Authenticate to DigitalOcean via OAuth and retrieve basic user information.
+    # Usage:
+    #    use OmniAuth::Strategies::Mangoapps, 'consumerkey', 'consumersecret', :scope => 'read write', :display => 'plain'
+    #
+    class Mangoapps < OmniAuth::Strategies::OAuth2
+      AUTHENTICATION_PARAMETERS = %w(display account state scope)
+      BASE_URL = "https://hub.mangoapps.com"
+      API_URL = "https://hub.mangoapps.com"
+
+      option :name, "mangoapps"
+
+      unless OmniAuth.config.test_mode
+        option :client_options, {
+          :authorize_url => "#{BASE_URL}/v1/oauth/authorize",
+          :token_url => "#{BASE_URL}/v1/oauth/token",
+          :site => BASE_URL
+        }
+      else
+        option :client_options, {
+          :authorize_url => "http://localhost:3000/v1/oauth/authorize",
+          :token_url => "http://localhost:3000/v1/oauth/token",
+          :site => "http://localhost:3000"
+        }
+      end
+
+      option :authorize_options, AUTHENTICATION_PARAMETERS
+
+      extra do
+        raw_info.parsed['account']
+      end
+
+      uid do
+        access_token.params['info']['uuid']
+      end
+
+      info do
+        access_token.params['info']
+      end
+
+      # Over-ride callback_url definition to maintain
+      # compatability with omniauth-oauth2 >= 1.4.0
+      #
+      # See: https://github.com/intridea/omniauth-oauth2/issues/81
+      def callback_url
+        full_host + script_name + callback_path
+      end
+
+      # Hook useful for appending parameters into the auth url before sending
+      # to provider.
+      def request_phase
+        super
+      end
+
+      # Hook used after response with code from provider. Used to prep token
+      # request from provider.
+      def callback_phase
+        super
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get("#{API_URL}/me.json")
+      end
+
+      ##
+      # You can pass +display+, +state+ or +scope+ params to the auth request, if
+      # you need to set them dynamically. You can also set these options
+      # in the OmniAuth config :authorize_params option.
+      #
+      # /v1/auth/digialocean?display=fancy&state=ABC
+      #
+      def authorize_params
+        super.tap do |params|
+          AUTHENTICATION_PARAMETERS.each do |v|
+            params[v.to_sym] = request.params[v] if request.params[v]
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/omniauth-mangoapps/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Mangoapps
+    VERSION = "0.3.1"
+  end
+end

data/lib/omniauth-mangoapps.rb

@@ -0,0 +1,2 @@
+require "omniauth-mangoapps/version"
+require "omniauth/strategies/mangoapps"

data/omniauth-mangoapps.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth-mangoapps/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-mangoapps"
+  spec.version       = Omniauth::Mangoapps::VERSION
+  spec.authors       = ["MangoApps API Engineering team"]
+  spec.email         = ["api-engineering@mangoapps.com"]
+  spec.summary       = %q{Official OmniAuth strategy for Mangoapps}
+  spec.description   = %q{Official OmniAuth strategy for Mangoapps}
+  spec.homepage      = "https://www.mangoapps.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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"]
+
+  spec.add_dependency "omniauth", "~> 2.0"
+  spec.add_dependency "omniauth-oauth2", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.7"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "webmock"
+end

data/spec/omniauth/strategies/mangoapps_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Mangoapps do
+  subject do
+    described_class.new({})
+  end
+
+  describe "production client options" do
+    it { expect(subject.options.name).to eq("mangoapps") }
+
+    it { expect(subject.options.client_options.site).to eq("https://hub.mangoapps.com") }
+    it { expect(subject.options.client_options.authorize_url).to eq("https://hub.mangoapps.com/v1/oauth/authorize") }
+    it { expect(subject.options.client_options.token_url).to eq("https://hub.mangoapps.com/v1/oauth/token") }
+  end
+
+  describe "callback phase instance methods" do
+    let(:uuid) { 123 }
+    let(:response_params) {
+      {
+        'info' => {
+          'uuid' => uuid
+        }
+      }
+    }
+    let(:account_response) {
+      { 'account' =>
+        {
+          'droplet_limit' => 25,
+          'email' => 'foo@example.com',
+          'uuid' => 'b6fc48dbf6d990634ce5f3c78dc9851e757381ef',
+          'email_verified' => true
+        }
+      }
+    }
+    let(:account_json) { double(:json, parsed: account_response) }
+    let(:access_token) { double('AccessToken', params: response_params, get: account_json) }
+
+    before do
+      allow(subject).to receive(:access_token).and_return(access_token)
+    end
+
+    describe "#uid" do
+      it "returns uuid from the info hash" do
+        expect(subject.uid).to eq(uuid)
+      end
+    end
+
+    describe '#extra' do
+      it 'includes the information returned from the account endpoint' do
+        expect(subject.extra['droplet_limit']).to eq(25)
+        expect(subject.extra['email']).to eq("foo@example.com")
+        expect(subject.extra['uuid']).to eq("b6fc48dbf6d990634ce5f3c78dc9851e757381ef")
+        expect(subject.extra['email_verified']).to eq(true)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth'
+require 'omniauth-digitalocean'
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-mangoapps
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- MangoApps API Engineering team
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Official OmniAuth strategy for Mangoapps
+email:
+- api-engineering@mangoapps.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- lib/omniauth-mangoapps.rb
+- lib/omniauth-mangoapps/version.rb
+- lib/omniauth/strategies/mangoapps.rb
+- omniauth-mangoapps.gemspec
+- spec/omniauth/strategies/mangoapps_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.mangoapps.com
+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: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Official OmniAuth strategy for Mangoapps
+test_files:
+- spec/omniauth/strategies/mangoapps_spec.rb
+- spec/spec_helper.rb