omniauth-mattermost 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e11c815a9d2a317e8845bf52c5706c37a84ee45c9ad869e7715e44be6324a23b
+  data.tar.gz: 9fcafdca2e202e9a727b439edd013e31be815762db9abc595189f19c507291ed
+SHA512:
+  metadata.gz: e09a429fbfc62cabc1f595ea6a9a71a812769c0a43c35d31a44ee86224d632fbb6871a63c55ead56744034537e7b124191673430f90684a9334750f30b9cc473
+  data.tar.gz: ba2e251ae3501e9d0813e9306bbc812080cc767f4782a0509c15c26eb3ae117abe9e14cd2f5f7851be90ad8d33c5a955c8c5016613e6aae48b9f045f7b6f2c68

data/.github/workflows/ruby.yml

@@ -0,0 +1,22 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["3.0", "3.1", "3.2", "3.3"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Build and test with Rake
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rake

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-mattermost.gemspec
+gemspec
+
+group :development, :test do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+  gem 'rb-fsevent'
+  gem 'growl'
+  gem 'rake'
+  gem 'graphlient'
+end

data/Guardfile

@@ -0,0 +1,10 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch('omniauth-mattermost.gemspec')
+end

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2021 Quentin Rousseau.
+
+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/README.md

@@ -0,0 +1,64 @@
+![Ruby](https://github.com/kwent/omniauth-mattermost/workflows/Ruby/badge.svg?branch=master)
+
+# OmniAuth Mattermost
+
+This is the official OmniAuth strategy for authenticating to Mattermost. To
+use it, you'll need to sign up for an OAuth2 Client ID and Secret
+on the [Mattermost Developer Page](https://community.servicenow.com/community?id=community_blog&sys_id=56086e4fdb9014146064eeb5ca961957).
+
+## Installation
+
+```ruby
+gem 'omniauth-mattermost'
+```
+
+## Basic Usage
+
+```ruby
+use OmniAuth::Builder do
+  provider :mattermost, ENV['MATTERMOST_CLIENT_ID'], ENV['MATTERMOST_CLIENT_SECRET'], { client_options: { site: 'https://<instance-id>.mattermost.com' } }
+end
+```
+
+## Basic Usage Rails
+
+In `config/initializers/mattermost.rb`
+
+```ruby
+  Rails.application.config.middleware.use OmniAuth::Builder do
+    provider :mattermost, ENV['MATTERMOST_CLIENT_ID'], ENV['MATTERMOST_CLIENT_SECRET'], { client_options: { site: 'https://<instance-id>.mattermost.com' } }
+  end
+```
+
+## Dynamic client_id and client_secret
+
+In `config/initializers/mattermost.rb`
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  setup_proc = lambda do |env|
+    req = Rack::Request.new(env)
+    env['omniauth.strategy'].options[:client_options][:site] = req.params['site']
+    env['omniauth.strategy'].options[:client_id] = req.params['client_id']
+    env['omniauth.strategy'].options[:client_secret] = req.params['client_secret']
+  end
+  provider :mattermost, nil, nil, { setup: setup_proc }
+end
+```
+
+More info: https://github.com/omniauth/omniauth/wiki/Setup-Phase
+
+## Semver
+
+This project adheres to Semantic Versioning 2.0.0. Any violations of this scheme are considered to be bugs.
+All changes will be tracked [here](https://github.com/kwent/omniauth-mattermost/releases).
+
+## License
+
+Copyright (c) 2021 Quentin Rousseau.
+
+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,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+desc 'Run specs'
+task :default => :spec

data/lib/omniauth/strategies/mattermost.rb

@@ -0,0 +1,99 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Mattermost < OmniAuth::Strategies::OAuth2
+
+      args %i[client_id client_secret]
+
+      option :name, 'mattermost'
+
+      option :client_options, {
+        site: "https://<instance-id>.mattermost.com",
+        authorize_url: "/oauth/authorize",
+        token_url: "/oauth/access_token",
+        response_type: 'code',
+      }
+
+      option :auth_token_params, {
+        grant_type: 'authorization_code',
+      }
+
+      # When `true`, client_id and client_secret are returned in extra['raw_info'].
+      option :extra_client_id_and_client_secret, false
+
+      def authorize_params
+        super.tap do |params|
+          %w[client_options].each do |v|
+            if request.params[v]
+              params[v.to_sym] = request.params[v]
+            end
+          end
+        end
+      end
+
+      def build_access_token
+        verifier = request.params["code"]
+        # Override regular client when using setup: proc
+        if env['omniauth.params']['client_id'] && env['omniauth.params']['client_secret'] && env['omniauth.params']['site']
+          client = ::OAuth2::Client.new(
+            env['omniauth.params']['client_id'],
+            env['omniauth.params']['client_secret'],
+            site: env['omniauth.params']['site'],
+            authorize_url: options.client_options.authorize_url,
+            token_url: options.client_options.token_url
+          )
+          client.auth_code.get_token(verifier, {:redirect_uri => callback_url}.merge(token_params.to_hash(:symbolize_keys => true)), deep_symbolize(options.auth_token_params))
+        else
+          super
+        end
+      end
+
+      uid { user['id'] }
+
+      info do
+        {
+          id: user['id'],
+          username: user['username'],
+          email: user['email'],
+          email_verified: user['email_verified']
+        }
+      end
+
+      extra do
+        { raw_info: raw_info, site: smart_site, instance_url: instance_url, user: user }
+      end
+
+      def raw_info
+        @raw_info ||= options[:extra_client_id_and_client_secret] ? { client_id: smart_client_id, client_secret: smart_client_secret } : {}
+      end
+
+      def smart_client_id
+        @smart_client_id ||= env['omniauth.params']['client_id'] || env['omniauth.strategy'].options.client_id
+      end
+
+      def smart_client_secret
+        @smart_client_secret ||= env['omniauth.params']['client_secret'] || env['omniauth.strategy'].options.client_secret
+      end
+
+      def smart_site
+        @site ||= env['omniauth.params']['site'] || env['omniauth.strategy'].options.site || options.client_options.site
+      end
+
+      def instance_url
+        @instance_url ||= smart_site if smart_site
+      end
+
+      def user
+        access_token.options[:mode] = :header
+        @user ||= access_token.get('api/v4/users/me', :headers => { 'Content-Type' => 'application/json' }).parsed
+      end
+
+      def callback_url
+        options.redirect_url || (full_host + callback_path)
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'mattermost', 'Mattermost'

data/lib/omniauth-mattermost/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Mattermost
+    VERSION = "2.0.0"
+  end
+end

data/lib/omniauth-mattermost.rb

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

data/omniauth-mattermost.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/omniauth-mattermost/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Quentin Rousseau"]
+  gem.email         = ["contact@quent.in"]
+  gem.description   = %q{Official OmniAuth strategy for Mattermost.}
+  gem.summary       = %q{Official OmniAuth strategy for Mattermost.}
+  gem.homepage      = "https://github.com/kwent/omniauth-mattermost"
+  gem.license       = "MIT"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "omniauth-mattermost"
+  gem.require_paths = ["lib"]
+  gem.version       = OmniAuth::Mattermost::VERSION
+
+  gem.required_ruby_version = ">= 3"
+
+  gem.add_dependency 'omniauth', '~> 2.0.0'
+  gem.add_dependency 'omniauth-oauth2', '>= 1.4.0', '< 2.0'
+  gem.add_development_dependency 'rspec', '~> 3.5'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'webmock'
+end

data/spec/omniauth/strategies/mattermost_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Mattermost do
+  let(:access_token) { instance_double('AccessToken', :options => {}, :[] => 'user') }
+  let(:parsed_response) { instance_double('ParsedResponse') }
+  let(:response) { instance_double('Response', :parsed => parsed_response) }
+
+  let(:enterprise_site)          { 'https://some.other.site.com' }
+  let(:enterprise_authorize_url) { 'https://some.other.site.com/login/oauth/authorize' }
+  let(:enterprise_token_url)     { 'https://some.other.site.com/login/oauth/token' }
+  let(:enterprise) do
+    OmniAuth::Strategies::Mattermost.new('MATTERMOST_CLIENT_ID', 'MATTERMOST_CLIENT_SECRET',
+        {
+            :client_options => {
+                :site => enterprise_site,
+                :authorize_url => enterprise_authorize_url,
+                :token_url => enterprise_token_url
+            }
+        }
+    )
+  end
+
+  subject do
+    OmniAuth::Strategies::Mattermost.new({})
+  end
+
+  before(:each) do
+    allow(subject).to receive(:access_token).and_return(access_token)
+  end
+
+  context 'client options' do
+    it 'should have correct site' do
+      expect(subject.options.client_options.site).to eq('https://<instance-id>.mattermost.com')
+    end
+
+    it 'should have correct authorize url' do
+      expect(subject.options.client_options.authorize_url).to eq('/oauth/authorize')
+    end
+
+    it 'should have correct token url' do
+      expect(subject.options.client_options.token_url).to eq('/oauth/access_token')
+    end
+
+    describe 'should be overrideable' do
+      it 'for site' do
+        expect(enterprise.options.client_options.site).to eq(enterprise_site)
+      end
+
+      it 'for authorize url' do
+        expect(enterprise.options.client_options.authorize_url).to eq(enterprise_authorize_url)
+      end
+
+      it 'for token url' do
+        expect(enterprise.options.client_options.token_url).to eq(enterprise_token_url)
+      end
+    end
+  end
+
+  describe '#callback_url' do
+    let(:base_url) { 'https://example.com' }
+
+    context 'no script name present' do
+      it 'has the correct default callback path' do
+        allow(subject).to receive(:full_host) { base_url }
+        allow(subject).to receive(:script_name) { '' }
+        allow(subject).to receive(:query_string) { '' }
+        expect(subject.callback_url).to eq(base_url + '/auth/mattermost/callback')
+      end
+    end
+
+    context 'script name' do
+      it 'should set the callback path with script_name' do
+        allow(subject).to receive(:full_host) { base_url }
+        allow(subject).to receive(:script_name) { '/v1' }
+        allow(subject).to receive(:query_string) { '' }
+        expect(subject.callback_url).to eq(base_url + '/v1/auth/mattermost/callback')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+SimpleCov.start
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth'
+require 'omniauth-mattermost'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+end
+

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-mattermost
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Quentin Rousseau
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-04 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !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 Mattermost.
+email:
+- contact@quent.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth-mattermost.rb
+- lib/omniauth-mattermost/version.rb
+- lib/omniauth/strategies/mattermost.rb
+- omniauth-mattermost.gemspec
+- spec/omniauth/strategies/mattermost_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kwent/omniauth-mattermost
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Official OmniAuth strategy for Mattermost.
+test_files:
+- spec/omniauth/strategies/mattermost_spec.rb
+- spec/spec_helper.rb