omniauth_cobot 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd04fd27faf858cb8ee7d25e9d1c93402b28f87b34550dc542203fc873495b4f
-  data.tar.gz: e3ea2d9f917c5d67f743a449394ee29b9f517cd7ce297e8d3ae78652324e3038
+  metadata.gz: 3c91b6d6f983000b2c8f392cb0532aeb6c5dedf0afbfee30cd3b6adf2b4fb15d
+  data.tar.gz: 6280f53cfe29d745051263c61f0f670ddd124ecfe8ef6b57955182f78fa3cd37
 SHA512:
-  metadata.gz: 86c1325dae2bddd3aed060f980c6e353e71d51604cef3216c33b7e9808d22692daac63a55ef99f36806936595b71eb57ac93cfebe16032dca2ed67a4d0973704
-  data.tar.gz: d34796ce330e318b1872e74e3e17cd5044fd2ec5abcbda71d089821da685c0142f4d33cdd34eba6296cbefe2f4218d4b1cb70db92f8e02a5761d08d4f21cd300
+  metadata.gz: 0f549df07238edc70eaa9912b633be07d1d5bc63ed0a9b7e28f5000e2703d5f7546b47cd7b654d380bbdb8925f74c14bd3db1c518362fdc1f196c172f43279e9
+  data.tar.gz: 3cbf4da8ef6ebc0dd95c01757bc0ae16fb0f3363a516c02d9c441dbb6b216c8aee82e41d98bf988b61ea05a1c90c2e90eff2ccb51eadd323d405ae5edab89480

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,24 @@
+name: Ruby CI
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.7", "3.0", "3.1"]
+    steps:
+      - uses: actions/checkout@v3
+      - 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/Gemfile.lock

@@ -1,40 +1,65 @@
 PATH
   remote: .
   specs:
-    omniauth_cobot (0.0.3)
-      omniauth-oauth2 (~> 1.6.0)
+    omniauth_cobot (0.2.0)
+      omniauth-oauth2 (~> 1.8.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)
+    diff-lcs (1.5.0)
+    faraday (2.6.0)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.1)
+    hashie (5.0.0)
+    jwt (2.5.0)
     multi_xml (0.6.0)
-    multipart-post (2.0.0)
-    oauth2 (1.4.1)
-      faraday (>= 0.8, < 0.16.0)
+    oauth2 (2.0.9)
+      faraday (>= 0.17.3, < 3.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)
+      rack (>= 1.2, < 4)
+      snaky_hash (~> 2.0)
+      version_gem (~> 1.1)
+    omniauth (2.1.0)
+      hashie (>= 3.4.6)
+      rack (>= 2.2.3)
+      rack-protection
+    omniauth-oauth2 (1.8.0)
+      oauth2 (>= 1.4, < 3)
+      omniauth (~> 2.0)
+    rack (3.0.0)
+    rack-protection (3.0.2)
+      rack
     rake (13.0.1)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    ruby2_keywords (0.0.5)
+    snaky_hash (2.0.1)
+      hashie
+      version_gem (~> 1.1, >= 1.1.1)
+    version_gem (1.1.1)
 
 PLATFORMS
-  ruby
+  arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   omniauth_cobot!
   rake
+  rspec (~> 3.12)
 
 BUNDLED WITH
-   1.16.1
+   2.3.20

data/README.md

@@ -6,13 +6,21 @@ This gem provides an [OmniAuth](https://github.com/intridea/omniauth) strategy f
 
 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
+```
 
-This gives you access to a variable `request.env['omniauth.auth']` in your authentication callback that looks like this:
+To authenticate a user against Cobot, send them to `/auth/cobot`.
 
-* `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>" } ] }`
+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.
+
+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>" } ] }`

data/Rakefile

@@ -1,2 +1,11 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+task default: [:spec]
+
+desc "Run the specs."
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end

data/lib/omniauth/cobot/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Cobot
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/omniauth/strategies/cobot.rb

@@ -9,6 +9,27 @@ module OmniAuth
         :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

data/omniauth_cobot.gemspec

@@ -15,9 +15,10 @@ Gem::Specification.new do |s|
   s.add_dependency 'omniauth-oauth2', '~>1.8.0'
 
   s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '~>3.12'
 
   s.files         = `git ls-files`.split("\n")
-  # s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
   # s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'omniauth_cobot'

data/spec/strategy_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+RSpec.describe OmniAuth::Strategies::Cobot do
+  let(:app) do
+    lambda do |_env|
+      [200, {}, ["Hello."]]
+    end
+  end
+  let(:strategy) { Class.new(OmniAuth::Strategies::Cobot) }
+
+  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth_cobot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexander Lang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-15 00:00:00.000000000 Z
+date: 2022-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
@@ -38,12 +38,28 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
 description: OmniAuth strategy for Cobot
 email: alex@cobot.me
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
@@ -54,6 +70,8 @@ files:
 - lib/omniauth/strategies/cobot.rb
 - lib/omniauth_cobot.rb
 - omniauth_cobot.gemspec
+- spec/spec_helper.rb
+- spec/strategy_spec.rb
 homepage: http://github.com/cobot/omniauth_cobot
 licenses: []
 metadata: {}
@@ -76,4 +94,6 @@ rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: OmniAuth strategy for Cobot
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/strategy_spec.rb