omniauth-quip 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 43b2870f0ff1ee58b78fe417c08b4faff910589f2e4ed39f71f4b73a5dfb2f3c
+  data.tar.gz: 84c9fc3b73095c43c31d681cfacd0e251fafb14816f604dcd5ca475118bb992b
+SHA512:
+  metadata.gz: a6a8cf73e32d058a63e1f4c4a0585264ced2251ed5991a47268ee562b0a4d4e16729d90a1ec0c8ffe82237206d8371c413709619ed43c4e35f3c6a3608914ca2
+  data.tar.gz: 2deafc9bf33ec5fde93a5738ea8d0845210eb14a40ca67f90becd9f9f3adbf9614436fefcc9294f681878f61de5fbb72d06a51e44c56526ec0e2a5f8bf4557c3

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+.ruby-version

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,7 @@
+# Changelog
+
+## 0.1.0 - 2022-11-02
+
+### Added
+- First version released.
+- Docs in README.

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,101 @@
+PATH
+  remote: .
+  specs:
+    omniauth-quip (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 (1.9.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
+      multipart-post (>= 1.2, < 3)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    hashie (5.0.0)
+    jaro_winkler (1.5.2)
+    jwt (2.3.0)
+    multi_json (1.15.0)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    oauth2 (1.4.7)
+      faraday (>= 0.8, < 2.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    omniauth (2.0.4)
+      hashie (>= 3.4.6)
+      rack (>= 1.6.2, < 3)
+      rack-protection
+    omniauth-oauth2 (1.7.2)
+      oauth2 (~> 1.4)
+      omniauth (>= 1.9, < 3)
+    parallel (1.14.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    psych (3.1.0)
+    rack (2.2.3)
+    rack-protection (2.1.0)
+      rack
+    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)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  omniauth-quip!
+  rake (~> 12.0)
+  rspec (~> 3.6)
+  rubocop (~> 0.49)
+
+BUNDLED WITH
+   1.17.1

data/README.md

@@ -0,0 +1,98 @@
+# OmniAuth Quip OAuth2 Strategy
+
+Strategy to authenticate with Quip via OAuth2 in OmniAuth.
+
+Get your API key at: https://help.salesforce.com/s/articleView?id=sf.anywhere_new_api_key.htm&type=5
+
+Note the Client ID and the Client Secret.
+
+For more details, read the Atlassian Quip docs about OAuth 2.0 (3LO): https://quip.com/dev/automation/documentation/current#tag/Authentication
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-quip'
+```
+
+Then `bundle install`.
+
+## Quip API Setup
+
+* Go to 'https://help.salesforce.com/s/articleView?id=sf.anywhere_new_api_key.htm&type=5'
+* 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/quip/callback).
+* Under APIs and Features, add the "Quip 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 :quip, ENV['QUIP_CLIENT_ID'], ENV['QUIP_CLIENT_SECRET'],
+    scope: "USER_READ USER_WRITE USER_MANAGE"
+end
+```
+
+You can now access the OmniAuth Quip OAuth2 URL: `/auth/quip`
+
+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
+[Quip 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"=>"quip",
+ "uid"=>"1db0a817f4ad35e04d96efe06991a234238e8fa19417d39de073b6a0aa7fab677",
+ "info"=>{},
+ "credentials"=>
+  {"token"=>"REDACTED",
+   "refresh_token"=>"REDACTED",
+   "expires_at"=>1670017351,
+   "expires"=>true},
+ "extra"=>
+  {"raw_info"=>{},
+   "me"=>
+    {"name"=>"John Doe",
+     "emails"=>["john@acme.com"],
+     "id"=>"JJCAEArdcbn",
+     "created_usec"=>1665786610244999,
+     "is_robot"=>false,
+     "affinity"=>0.0,
+     "desktop_folder_id"=>"AUMAOAfZCvN",
+     "archive_folder_id"=>"AUMAOAOFsOu",
+     "starred_folder_id"=>"AUMAOAd8R4l",
+     "private_folder_id"=>"AUMAOA2dCE2",
+     "shared_folder_ids"=>[],
+     "group_folder_ids"=>["bNNAOAEh3Ui"],
+     "disabled"=>false,
+     "profile_picture_url"=>"https://quip-cdn.com/4OOk3BA2e412gU9Q6v3RDgDxA",
+     "subdomain"=>"acme",
+     "url"=>"https://acme.quip.com"}}
+}
+```
+
+## License
+
+Copyright (c) 2022 by 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/lib/omniauth/quip/version.rb

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

data/lib/omniauth/quip.rb

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

data/lib/omniauth/strategies/quip.rb

@@ -0,0 +1,84 @@
+# 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 Quip
+    class Quip < OmniAuth::Strategies::OAuth2
+
+      args %i[client_id client_secret]
+
+      option :name, 'quip'
+
+      option :client_options,
+             site: 'https://platform.quip.com/1',
+             authorize_url: 'https://platform.quip.com/1/oauth/login',
+             token_url: 'https://platform.quip.com/1/oauth/access_token'
+
+      # 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']
+          client = ::OAuth2::Client.new(
+            env['omniauth.params']['client_id'],
+            env['omniauth.params']['client_secret'],
+            site: options.client_options.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 { Digest::SHA2.hexdigest("#{me['id']}-#{me['company_id']}-#{access_token.client.id}") }
+
+      extra do
+        { raw_info: raw_info, me: me }
+      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 me
+        access_token.options[:mode] = :header
+        @me ||= access_token.get('users/current', :headers => { 'Content-Type' => 'application/json' }).parsed
+      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 callback_url
+        full_host + script_name + callback_path
+      end
+    end
+  end
+end

data/lib/quip.rb

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

data/omniauth-quip.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require File.expand_path(
+  File.join('..', 'lib', 'omniauth', 'quip', 'version'),
+  __FILE__
+)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'omniauth-quip'
+  gem.version       = OmniAuth::Quip::VERSION
+  gem.license       = 'MIT'
+  gem.summary       = %(A Quip OAuth2 strategy for OmniAuth 1.x)
+  gem.description   = %(A Quip OAuth2 strategy for OmniAuth 1.x. This allows you to login to Quip with your Ruby app.)
+  gem.authors       = ['Quentin Rousseau']
+  gem.email         = ['contact@quent.in']
+  gem.homepage      = 'https://github.com/kwent/omniauth-quip'
+
+  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,125 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-quip
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Quentin Rousseau
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-11-02 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 Quip OAuth2 strategy for OmniAuth 1.x. This allows you to login to
+  Quip with your Ruby app.
+email:
+- contact@quent.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/omniauth/quip.rb
+- lib/omniauth/quip/version.rb
+- lib/omniauth/strategies/quip.rb
+- lib/quip.rb
+- omniauth-quip.gemspec
+homepage: https://github.com/kwent/omniauth-quip
+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: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: A Quip OAuth2 strategy for OmniAuth 1.x
+test_files: []