omniauth-confluence-oauth2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ac3d71dc95236d5efc111ad1e41c1e4aeaafbc6
+  data.tar.gz: c14471319332e0b6142da216b67ca7f210db480f
+SHA512:
+  metadata.gz: aedc5705cc763e273d652d33e18f6a0fe725ac9e7b7dbe9e42455ddf03102ba97b961defc1c1edad3dc9f109d79f750c4effa1edaef9b521e8ac6f668b46b460
+  data.tar.gz: eb431f34a69a887f883d66371c31b6b7c4345b0c947468671d8f34626309afd98cb04054da5c6b56e54cafde760f1afb3724c568c5f2f495762562fc68551424

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/.rubocop.yml

@@ -0,0 +1,22 @@
+ClassLength:
+  Enabled: false
+Layout/IndentHeredoc:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context']
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Naming:
+  Enabled: false
+Style/MutableConstant:
+  Enabled: false
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. Follows the
+religion set forth in https://keepachangelog.com/en/1.0.0/
+
+## 0.2.0 - 2018-03-02
+
+### Fixed
+- Fixed issue where callback phase was unnecessarily slow.
+
+## 0.1.0 - 2018-03-01
+
+### Added
+- First version released.
+- Docs in README.
+- Supports Jira API, refresh tokens, populating auth hash profile values, etc.

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    omniauth-atlassian-oauth2 (0.1.0)
+      omniauth (>= 1.1.1)
+      omniauth-oauth2 (>= 1.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    hashie (3.6.0)
+    jaro_winkler (1.5.2)
+    jwt (2.1.0)
+    multi_json (1.13.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    oauth2 (1.4.1)
+      faraday (>= 0.8, < 0.16.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    omniauth (1.9.0)
+      hashie (>= 3.4.6, < 3.7.0)
+      rack (>= 1.6.2, < 3)
+    omniauth-oauth2 (1.6.0)
+      oauth2 (~> 1.1)
+      omniauth (~> 1.9)
+    parallel (1.14.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    psych (3.1.0)
+    rack (2.0.6)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.65.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  omniauth-atlassian-oauth2!
+  rake (~> 12.0)
+  rspec (~> 3.6)
+  rubocop (~> 0.49)
+
+BUNDLED WITH
+   1.17.1

data/README.md

@@ -0,0 +1,96 @@
+# OmniAuth Confluence OAuth2 Strategy
+
+Strategy to authenticate with Confluence via OAuth2 in OmniAuth.
+
+Get your API key at: https://developer.atlassian.com/apps/ Note the Client ID
+and the Client Secret.
+
+For more details, read the Atlassian Confluence docs about OAuth 2.0 (3LO):
+https://developer.atlassian.com/cloud/confluence/oauth-2-authorization-code-grants-3lo-for-apps/
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-confluence-oauth2'
+```
+
+Then `bundle install`.
+
+## Confluence API Setup
+
+* Go to 'https://developer.atlassian.com/apps/'
+* Create a new app.
+* Note the Client ID and Secret values in the App Details section.
+* Under APIs and Features, add the "Authorization code grants" feature.
+  Configure the feature with your callback URL (something like
+  http://localhost:3000/auth/confluence_oauth2/callback).
+* Under APIs and Features, add the "Confluence platform REST API" API.
+
+## Usage
+
+Here's an example for adding the middleware to a Rails app in
+`config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :confluence_oauth2, ENV['CONFLUENCE_CLIENT_ID'], ENV['CONFLUENCE_CLIENT_SECRET'],
+    scope: "offline_access read:me read:confluence-space.summary read:confluence-props read:confluence-content.all read:confluence-content.summary search:confluence",
+    prompt: "consent"
+end
+```
+The `offline_access` scope must be included if you wish to attain a refresh token.
+You may wish to include additional scopes depending on how you've configured
+your app in the Atlassian UI.
+
+You can now access the OmniAuth Confluence OAuth2 URL: `/auth/confluence_oauth2`
+
+NOTE: While developing your application, if you change the scope in the
+initializer you will need to restart your app server.
+
+## Auth Hash
+
+Here's an example of an authentication hash available in the callback by
+accessing `request.env['omniauth.auth']`:
+
+After authing a user, when you make API calls over time, you should follow the
+[Confluence OAuth 2.0 docs](https://developer.atlassian.com/cloud/confluence/oauth-2-authorization-code-grants-3lo-for-apps/)
+and continue to check the `accessible-resources` endpoint to ensure your app
+continues to have access to the sites you expect.
+
+```ruby
+{
+  "provider" => "confluence_oauth2",
+  "uid" => "100000000000000000000",
+  "info" => {
+    "name" => "John Smith",
+    "email" => "john@example.com",
+    "nickname" => "john_smith", # username
+    "location" => "Australia/Sydney", # time zone
+    "image" => "https://whatever.atlassiancdn.com/photo.jpg",
+  },
+  "credentials" => {
+    "token" => "TOKEN",
+    "refresh_token" => "REFRESH_TOKEN",
+    "expires_at" => 1496120719,
+    "expires" => true
+  },
+  "extra" => {
+    "raw_info" => {
+      "sites" => {},
+      "myself" => {},
+    }
+  }
+}
+```
+
+## License
+
+Copyright (c) 2019 by Ben Standefer
+
+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/lib/omniauth-confluence-oauth2.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'omniauth/confluence_oauth2'

data/lib/omniauth/confluence_oauth2.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'omniauth/strategies/confluence_oauth2'

data/lib/omniauth/confluence_oauth2/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module ConfluenceOauth2
+    VERSION = '0.1.0'
+  end
+end

data/lib/omniauth/strategies/confluence_oauth2.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'omniauth/strategies/oauth2'
+require 'uri'
+
+# Potential scopes: https://developer.atlassian.com/cloud/jira/platform/scopes/
+# offline_access read:confluence-space.summary read:confluence-props read:confluence-content.all read:confluence-content.summary search:confluence
+#
+# Separate scopes with a space (%20)
+# https://developer.atlassian.com/cloud/confluence/oauth-2-authorization-code-grants-3lo-for-apps/
+
+module OmniAuth
+  module Strategies
+    # Omniauth strategy for Confluence
+    class ConfluenceOauth2 < OmniAuth::Strategies::OAuth2
+      option :name, 'confluence_oauth2'
+      option :client_options,
+             site: 'https://auth.atlassian.com',
+             authorize_url: 'https://auth.atlassian.com/authorize',
+             token_url: 'https://auth.atlassian.com/oauth/token',
+             audience: 'api.atlassian.com'
+      option :authorize_params,
+             prompt: 'consent',
+             audience: 'api.atlassian.com'
+
+      uid do
+        raw_info['myself']['account_id']
+      end
+
+      info do
+        {
+            name: raw_info['myself']['name'],
+            email: raw_info['myself']['email'],
+            nickname: raw_info['myself']['nickname'],
+            location: raw_info['myself']['zoneinfo'],
+            image: raw_info['myself']['picture']
+        }
+      end
+
+      extra do
+        {
+          'raw_info' => raw_info
+        }
+      end
+
+      def raw_info
+        return @raw_info if @raw_info
+
+        # NOTE: api.atlassian.com, not auth.atlassian.com!
+        accessible_resources_url = 'https://api.atlassian.com/oauth/token/accessible-resources'
+        sites = JSON.parse(access_token.get(accessible_resources_url).body)
+
+        myself_url = "https://api.atlassian.com/me"
+        myself = JSON.parse(access_token.get(myself_url).body)
+
+        @raw_info ||= {
+          'sites' => sites,
+          'myself' => myself
+        }
+      end
+    end
+  end
+end

data/omniauth-confluence-oauth2.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require File.expand_path(
+  File.join('..', 'lib', 'omniauth', 'confluence_oauth2', 'version'),
+  __FILE__
+)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'omniauth-confluence-oauth2'
+  gem.version       = OmniAuth::ConfluenceOauth2::VERSION
+  gem.license       = 'MIT'
+  gem.summary       = %(A Confluence OAuth2 strategy for OmniAuth 1.x)
+  gem.description   = %(A Confluence OAuth2 strategy for OmniAuth 1.x. This allows you to login to Confluence with your Ruby app.)
+  gem.authors       = ['Ben Standefer']
+  gem.email         = ['benstandefer@gmail.com']
+  gem.homepage      = 'https://github.com/aguynamedben/omniauth-atlassian-oauth2'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.require_paths = ['lib']
+
+  gem.required_ruby_version = '>= 2.1'
+
+  gem.add_runtime_dependency 'omniauth', '>= 1.1.1'
+  gem.add_runtime_dependency 'omniauth-oauth2', '>= 1.5'
+
+  gem.add_development_dependency 'rake', '~> 12.0'
+  gem.add_development_dependency 'rspec', '~> 3.6'
+  gem.add_development_dependency 'rubocop', '~> 0.49'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-confluence-oauth2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Standefer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+description: A Confluence OAuth2 strategy for OmniAuth 1.x. This allows you to login
+  to Confluence with your Ruby app.
+email:
+- benstandefer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/omniauth-confluence-oauth2.rb
+- lib/omniauth/confluence_oauth2.rb
+- lib/omniauth/confluence_oauth2/version.rb
+- lib/omniauth/strategies/confluence_oauth2.rb
+- omniauth-confluence-oauth2.gemspec
+homepage: https://github.com/aguynamedben/omniauth-atlassian-oauth2
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+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: A Confluence OAuth2 strategy for OmniAuth 1.x
+test_files: []