omniauth-passthrough 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: caa2d9412ba98d0dc313d1f92d54d5648d0168559d68bcc2ac9083f0e4b6af16
+  data.tar.gz: 20644c1b8d2c0ae6746fd5179a849078653a1b646ec561545677d7a5db30e6a5
+SHA512:
+  metadata.gz: 980b0aab5c58f01141a480763134182d9a1074a0fd061c0203dd291db6922a425641991fe5a9f6229619a3bee186f3e58abf020a7ce7623b79515fe2f5e52851
+  data.tar.gz: 807b979a3a45f05d4b5f226b5b7618c571867965bff84fa5bc249e5cfb86e275481e9c07db3bda70770e1505110646be36b6211a83ace7c3a8f7c7b033b84dbb

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# 1.0.0 (2025-02-05)
+
+
+### Features
+
+* action dispatch helper ([#7](https://github.com/benmelz/omniauth-passthrough/issues/7)) ([d0e6908](https://github.com/benmelz/omniauth-passthrough/commit/d0e69085944e8a7f996e14b3199630d059e9353b))
+* capybara helper ([#8](https://github.com/benmelz/omniauth-passthrough/issues/8)) ([1d49bc8](https://github.com/benmelz/omniauth-passthrough/commit/1d49bc85dd8a540a24383078a1c792c29035a148))
+* omniauth passthrough strategy ([#5](https://github.com/benmelz/omniauth-passthrough/issues/5)) ([f3ac6ee](https://github.com/benmelz/omniauth-passthrough/commit/f3ac6ee0fca4525e315f50ac5e96d138e1caba48))
+* rack test helper ([#6](https://github.com/benmelz/omniauth-passthrough/issues/6)) ([32fd106](https://github.com/benmelz/omniauth-passthrough/commit/32fd1061cedf0758e17e44d1bdbc94f0448717d4))

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Benjamin Melz
+
+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,70 @@
+# omniauth-passthrough
+
+An OmniAuth strategy that passes request params straight through the middleware.
+
+This strategy allows you to pass auth hash values directly to an auth endpoint and forwards them directly to your
+callback(s). The end goal of this is to provide more flexibility when writing login helpers in development/test
+environments while still utilizing your OmniAuth callback(s).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add omniauth-passthrough
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install omniauth-passthrough
+```
+
+## Usage
+
+Include the passthrough strategy in development/test environments as you would with any other OmniAuth
+strategy. *NEVER* use it in a production environment.
+
+Once included, any POST request to `/auth/passthrough` will pass through any `uid`, `info`, `credentials` and `extra`
+params to your omniauth callback.
+
+```ruby 
+# request
+post '/auth/passthrough', params: { uid: 'my-uid',
+                                    info: { email: 'my-email@example.com', first_name: 'My', last_name: 'Name' } }
+
+# callback
+request.env['omniauth.auth'].uid # => 'my-uid'
+request.env['omniauth.auth'].info.email # => 'my-email@example.com'
+request.env['omniauth.auth'].info.first_name # => 'My'
+request.env['omniauth.auth'].info.last_name # => 'Name'
+```
+
+### Test Environments
+
+A number of test helpers are provided to help with using the strategy for test login helpers.
+
+```ruby
+# including one of the following helpers in your test
+include Omniauth::Passthrough::RackHelper # if using Rack::Test
+include Omniauth::Passthrough::ActionDispatchHelper # if using ActionDispatch (Rails)
+include Omniauth::Passthrough::CapybaraHelper # if using Capybara
+
+# will make the following login helper available
+omniauth_passthrough(uid: 'my-uid', info: { email: 'my-email@example.com', first_name: 'My', last_name: 'Name' })
+```
+
+## Development
+
+* Run `bin/setup` to install dependencies.
+* Run `bin/rake appraisal spec` to run the tests.
+* Run `bin/rake rubocop` to run the linter.
+* Run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/omniauth-passthrough.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/omniauth/passthrough/action_dispatch_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module Passthrough
+    module ActionDispatchHelper
+      def omniauth_passthrough(params = {})
+        get("/auth/passthrough/callback", params:)
+      end
+    end
+  end
+end

data/lib/omniauth/passthrough/capybara_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module Passthrough
+    module CapybaraHelper
+      def omniauth_passthrough(params = {})
+        original_url = current_url
+        visit "/auth/passthrough/callback?#{Rack::Utils.build_nested_query(params)}"
+        visit original_url
+      end
+    end
+  end
+end

data/lib/omniauth/passthrough/rack_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module Passthrough
+    module RackHelper
+      def omniauth_passthrough(params = {})
+        get "/auth/passthrough/callback", params
+      end
+    end
+  end
+end

data/lib/omniauth/passthrough/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module Passthrough
+    VERSION = "1.0.0"
+  end
+end

data/lib/omniauth/passthrough.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "passthrough/action_dispatch_helper"
+require_relative "passthrough/capybara_helper"
+require_relative "passthrough/rack_helper"
+require_relative "passthrough/version"
+require_relative "strategies/passthrough"
+
+module OmniAuth
+  module Passthrough
+  end
+end

data/lib/omniauth/strategies/passthrough.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "omniauth"
+require "rack/utils"
+
+module OmniAuth
+  module Strategies
+    class Passthrough
+      include OmniAuth::Strategy
+
+      def request_phase
+        redirect(URI.parse(callback_url).tap { |uri| uri.query = Rack::Utils.build_nested_query(request.params) }.to_s)
+      end
+
+      uid { request.params["uid"] }
+      info { request.params["info"] || {} }
+      credentials { request.params["credentials"] || {} }
+      extra { request.params["extra"] || {} }
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-passthrough
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Benjamin Melz
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: 'This strategy allows you to pass auth hash values directly to an auth
+  endpoint and forwards them directly to your callback(s). The end goal of this is
+  to provide more flexibility when writing login helpers in development/test environments
+  while still utilizing your OmniAuth callback(s). '
+email: ben@melz.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/omniauth/passthrough.rb
+- lib/omniauth/passthrough/action_dispatch_helper.rb
+- lib/omniauth/passthrough/capybara_helper.rb
+- lib/omniauth/passthrough/rack_helper.rb
+- lib/omniauth/passthrough/version.rb
+- lib/omniauth/strategies/passthrough.rb
+homepage: https://github.com/benmelz/omniauth-passthrough
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/benmelz/omniauth-passthrough
+  source_code_uri: https://github.com/benmelz/omniauth-passthrough
+  changelog_uri: https://github.com/benmelz/omniauth-passthrough/blob/v1.0.0/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: An OmniAuth strategy that passes request params straight through the middleware.
+test_files: []