omniauth_cobot 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd04fd27faf858cb8ee7d25e9d1c93402b28f87b34550dc542203fc873495b4f
-  data.tar.gz: e3ea2d9f917c5d67f743a449394ee29b9f517cd7ce297e8d3ae78652324e3038
+  metadata.gz: 5695363dcc7584d437846dd02f9a110f125071d47b1ad63d8443d1c321b81e74
+  data.tar.gz: d4f5b08566889f9492f4b19f7445560d373723d4b9d893e21e04ee1277b35c6d
 SHA512:
-  metadata.gz: 86c1325dae2bddd3aed060f980c6e353e71d51604cef3216c33b7e9808d22692daac63a55ef99f36806936595b71eb57ac93cfebe16032dca2ed67a4d0973704
-  data.tar.gz: d34796ce330e318b1872e74e3e17cd5044fd2ec5abcbda71d089821da685c0142f4d33cdd34eba6296cbefe2f4218d4b1cb70db92f8e02a5761d08d4f21cd300
+  metadata.gz: 41f36efe8d264df83f3e4ef41c3d9fe7d84de120448afffa2fd72124a03bf51db9260a8c83af6ef73d52c300ad29c0fa4a507db70c00b757918d9da33490be87
+  data.tar.gz: c0f8189ba29bfa270a5a1088a28fdb6532044620d88cd9cfe7ccd89d8188662eed3207360ac3a3ba0907b74ef1a9ba71fffefdef354deb5f8607c7b06b33c2e9

data/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/workflows/ruby.yml

@@ -0,0 +1,23 @@
+name: Push gem
+
+on:
+  push:
+    tags:
+      - "v*"
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          persist-credentials: false
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+      - name: Release gem
+        uses: rubygems/release-gem@v1

data/.github/workflows/test.yml

@@ -0,0 +1,25 @@
+name: Ruby CI
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["4.0", "3.4", "3.3"]
+    steps:
+      - uses: actions/checkout@v5
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake
+  

data/.gitignore

@@ -1 +1,3 @@
 pkg/*
+*.gem
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,13 @@
+plugins:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.2
+
+RSpec/ExampleLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/CHANGES.md

@@ -0,0 +1,8 @@
+# 1.0.0
+
+- Add support for Ruby v4
+- Drop support for EOL Rubies (< 3.3)
+
+# 0.2.0
+
+- add using space subdomain in authorize url

data/Gemfile

@@ -1,4 +1,12 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
 
 # Specify your gem's dependencies in omniauth_cobot.gemspec
 gemspec
+
+gem 'rake'
+gem 'rspec', '~>3.12'
+gem 'rubocop'
+gem 'rubocop-rake'
+gem 'rubocop-rspec'

data/README.md

@@ -4,15 +4,30 @@ This gem provides an [OmniAuth](https://github.com/intridea/omniauth) strategy f
 
 ### Rails
 
+Add the following to your Gemfile:
+
+````ruby
+gem 'omniauth_cobot'
+gem 'omniauth-rails_csrf_protection', '~>1.0.0'
+``
+
 Add the following as an initializer:
 
-    Rails.application.config.middleware.use OmniAuth::Builder do
-      provider :cobot, '<client_id>', '<client_secret>', scope: 'read write'
-    end
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :cobot, '<client_id>', '<client_secret>', scope: 'read write'
+end
+````
+
+To authenticate a user against Cobot, send them to `/auth/cobot`.
+
+If authenticating in the context of a Cobot space, e.g. if your app is inside an ifram on Cobot, pass the space's subdomain by sending the user to `/auth/cobot/cobot_space_subdomain=<space-sudbomain>`. This ensures users don't have to log in again for their space on Cobot when that space has a custom domain.
+
+After the user completed the OAuth flow, they are redirected back to `/auth/cobot/callback`, which should be routed to a controller action.
 
-This gives you access to a variable `request.env['omniauth.auth']` in your authentication callback that looks like this:
+In the controller action you have access to a variable `request.env['omniauth.auth']` that looks like this:
 
-* `uid` - the id of the user
-* `credentials` - `{'token' => '<access token>'}`
-* `info` - `{'email' => '<user email>', 'picture' => '<url>'}`
-* `extra` - `{:raw_info => { "id": "<user id>", "email": "<email>", "picture": "<picture url>", "mac_addresses": ["<mac address>"...], "memberships": [{ "space_link": "<https://www.cobot.me/api/spaces/some-space>", "link": "<https://some-space.cobot.me/api/memberships/some-membership>" } ], "admin_of": [ { "space_link": "<https://www.cobot.me/api/spaces/some-space>", "name": "<admin name>" } ] }`
+- `uid` - the id of the user
+- `credentials` - `{'token' => '<access token>'}`
+- `info` - `{'email' => '<user email>', 'picture' => '<url>'}`
+- `extra` - `{:raw_info => { "id": "<user id>", "email": "<email>", "picture": "<picture url>", "mac_addresses": ["<mac address>"...], "memberships": [{ "space_link": "<https://www.cobot.me/api/spaces/some-space>", "link": "<https://some-space.cobot.me/api/memberships/some-membership>" } ], "admin_of": [ { "space_link": "<https://www.cobot.me/api/spaces/some-space>", "name": "<admin name>" } ] }`

data/Rakefile

@@ -1,2 +1,16 @@
+# frozen_string_literal: true
+
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+task default: %i[spec rubocop]
+
+desc 'Run the specs.'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+RuboCop::RakeTask.new(:rubocop)

data/lib/omniauth/cobot/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module OmniAuth
   module Cobot
-    VERSION = '0.1.0'
+    VERSION = '1.0.0'
   end
 end

data/lib/omniauth/strategies/cobot.rb

@@ -1,14 +1,37 @@
+# frozen_string_literal: true
+
 require 'omniauth/strategies/oauth2'
 
 module OmniAuth
   module Strategies
     class Cobot < OmniAuth::Strategies::OAuth2
       option :client_options, {
-        :site => 'https://www.cobot.me',
-        :authorize_url => 'https://www.cobot.me/oauth/authorize',
-        :token_url => 'https://www.cobot.me/oauth/access_token'
+        site: 'https://www.cobot.me',
+        authorize_url: 'https://www.cobot.me/oauth/authorize',
+        token_url: 'https://www.cobot.me/oauth/access_token'
       }
 
+      def client
+        ::OAuth2::Client.new(
+          options.client_id,
+          options.client_secret,
+          deep_symbolize(
+            options.client_options.merge(
+              authorize_url: space_subdomain_authorize_url
+            )
+          )
+        )
+      end
+
+      def space_subdomain_authorize_url
+        params = Rack::Utils.parse_nested_query(env['QUERY_STRING'])
+        if (subdomain = params['cobot_space_subdomain'])
+          options.client_options[:authorize_url].sub('www.', "#{subdomain}.")
+        else
+          options.client_options[:authorize_url]
+        end
+      end
+
       uid { raw_info['id'] }
 
       info do
@@ -19,7 +42,7 @@ module OmniAuth
       end
 
       extra do
-        {:raw_info => raw_info}
+        { raw_info: raw_info }
       end
 
       def raw_info

data/lib/omniauth_cobot.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'omniauth'
 require 'omniauth/strategies/cobot'

data/omniauth_cobot.gemspec

@@ -1,23 +1,24 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "omniauth/cobot/version"
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'omniauth/cobot/version'
 
 Gem::Specification.new do |s|
-  s.name = "omniauth_cobot"
-  s.summary = "OmniAuth strategy for Cobot"
-  s.email = "alex@cobot.me"
-  s.homepage = "http://github.com/cobot/omniauth_cobot"
-  s.description = "OmniAuth strategy for Cobot"
-  s.authors = ["Alexander Lang"]
+  s.name = 'omniauth_cobot'
+  s.summary = 'OmniAuth strategy for Cobot'
+  s.email = 'alex@cobot.me'
+  s.homepage = 'http://github.com/cobot/omniauth_cobot'
+  s.description = 'OmniAuth strategy for Cobot'
+  s.authors = ['Alexander Lang']
   s.version     = OmniAuth::Cobot::VERSION
   s.platform    = Gem::Platform::RUBY
 
-  s.add_dependency 'omniauth-oauth2', '~>1.8.0'
+  s.required_ruby_version = ['>=3.2', '<5']
 
-  s.add_development_dependency 'rake'
+  s.add_dependency 'omniauth-oauth2', '~>1.8'
 
   s.files         = `git ls-files`.split("\n")
-  # s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   # s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
+  s.metadata['rubygems_mfa_required'] = 'true'
 end

data/spec/omni_auth/strategies/cobot_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe OmniAuth::Strategies::Cobot do
+  let(:app) do
+    lambda do |_env|
+      [200, {}, ['Hello.']]
+    end
+  end
+  let(:strategy) { Class.new(described_class) }
+
+  before do
+    OmniAuth.config.test_mode = true
+  end
+
+  after do
+    OmniAuth.config.test_mode = false
+  end
+
+  it 'takes the cobot_space_sudomain query param and changes the subdomain of the authorize_url' do
+    subject = strategy
+              .new(app, client_options: { authorize_url: 'https://www.cobot.me' })
+
+    subject.call!(
+      {
+        'rack.session' => {},
+        'QUERY_STRING' => 'cobot_space_subdomain=my-space'
+      }
+    )
+
+    expect(subject.client.authorize_url)
+      .to eq('https://my-space.cobot.me')
+  end
+
+  it 'does not change the subdomain of the authorize_url when no cobot_space_subdomain passed' do
+    subject = strategy
+              .new(app, client_options: { authorize_url: 'https://www.cobot.me' })
+
+    subject.call!(
+      {
+        'rack.session' => {}
+      }
+    )
+
+    expect(subject.client.authorize_url)
+      .to eq('https://www.cobot.me')
+  end
+
+  it 'does nothing if no authorize_url configured' do
+    subject = strategy
+              .new(app, {})
+
+    subject.call!(
+      {
+        'rack.session' => {}
+      }
+    )
+
+    expect(subject.client.authorize_url)
+      .to eq('https://www.cobot.me/oauth/authorize')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'omniauth_cobot'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: omniauth_cobot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Alexander Lang
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-15 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
@@ -16,37 +15,27 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.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'
+        version: '1.8'
 description: OmniAuth strategy for Cobot
 email: alex@cobot.me
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ruby.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
+- ".rubocop.yml"
+- CHANGES.md
 - Gemfile
-- Gemfile.lock
 - MIT_LICENSE.txt
 - README.md
 - Rakefile
@@ -54,10 +43,12 @@ files:
 - lib/omniauth/strategies/cobot.rb
 - lib/omniauth_cobot.rb
 - omniauth_cobot.gemspec
+- spec/omni_auth/strategies/cobot_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/cobot/omniauth_cobot
 licenses: []
-metadata: {}
-post_install_message:
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -65,15 +56,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 4.0.10
 specification_version: 4
 summary: OmniAuth strategy for Cobot
 test_files: []

data/Gemfile.lock

@@ -1,40 +0,0 @@
-PATH
-  remote: .
-  specs:
-    omniauth_cobot (0.0.3)
-      omniauth-oauth2 (~> 1.6.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    faraday (0.15.4)
-      multipart-post (>= 1.2, < 3)
-    hashie (3.6.0)
-    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)
-    rack (2.2.3.1)
-    rake (13.0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  omniauth_cobot!
-  rake
-
-BUNDLED WITH
-   1.16.1