rack-change-password-url 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1fbeb94677e12c8cc859d9befd8481634ca0286dccb4f19d6135cf76ddbc7d47
+  data.tar.gz: '04839d68e11629e7901fdb1165d18010d5dd7650962197d88ca9b7346614a2a7'
+SHA512:
+  metadata.gz: 52609e3749794ce3791b062ff2ce02058bbf3f039b4a7baf21498db130f9d3f30d7c055b8ab97bdb907b0cb3bb4428b6178b09f32a59b109697fc6c953b96fa4
+  data.tar.gz: 1e3e045fb59334ba75ef3daf66beb3da54ebb1ed60c9075135f19aba261347430fd5bd575ab4f78cfef55b02ffbb9f6d58680dbe1d4075b71db75219b8b690cd

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Taketo Takashima
+
+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,51 @@
+# Rack::ChangePasswordUrl
+
+Provides endpoint of a Well-Known URL for Changing Passwords for Rails and Rack apps.
+
+References:
+* [A Well-Known URL for Changing Passwords | W3C](https://www.w3.org/TR/change-password-url/)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add rack-change-password-url
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install rack-change-password-url
+
+## Usage
+### For Rack App
+
+```ruby
+require "rack/change-password-url"
+
+use Rack::ChangePasswordUrl::Middleware, redirect_path: 'your-redirect-path'
+```
+
+### For Rails App
+
+```ruby
+# config/application.rb
+module MyApp
+  class Application < Rails::Application
+    ...
+    config.rack_change_password_url.redirect_path = 'your-redirect-path'
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/taketo1113/rack-change-password-url.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/rack/change-password-url/middleware.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Rack
+  module ChangePasswordUrl
+    class Middleware
+      def initialize(app, options={})
+        @app = app
+
+        @redirect_path = options[:redirect_path]
+      end
+
+      def call(env)
+        req = Rack::Request.new(env)
+
+        if req.path == '/.well-known/change-password'
+          unless @redirect_path.nil?
+            return [ 302, { 'Location' => @redirect_path }, [] ]
+          else
+            raise Error.new('Failed to redirect change password url: not set redirect_path')
+          end
+        end
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/rack/change-password-url/rails_options.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rack
+  module ChangePasswordUrl
+    class RailsOptions
+      attr_accessor :redirect_path
+    end
+  end
+end

data/lib/rack/change-password-url/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'rails_options'
+
+module Rack
+  module ChangePasswordUrl
+    class Railtie < ::Rails::Railtie
+      config.rack_change_password_url = RailsOptions.new
+
+      initializer "rack-change-password-url.middleware" do |app|
+        app.middleware.use Rack::ChangePasswordUrl::Middleware, { redirect_path: app.config.rack_change_password_url.redirect_path }
+      end
+    end
+  end
+end

data/lib/rack/change-password-url/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rack
+  module ChangePasswordUrl
+    VERSION = "0.1.0"
+  end
+end

data/lib/rack/change-password-url.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "change-password-url/middleware"
+require_relative "change-password-url/version"
+
+require_relative 'change-password-url/railtie' if defined?(::Rails)
+
+module Rack
+  module ChangePasswordUrl
+    class Error < StandardError; end
+  end
+end

data/lib/rack-change-password-url.rb

@@ -0,0 +1 @@
+require "rack/change-password-url"

data/rack-change-password-url.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/rack/change-password-url/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rack-change-password-url"
+  spec.version = Rack::ChangePasswordUrl::VERSION
+  spec.authors = ["Taketo Takashima"]
+  spec.email = ["t.taketo1113@gmail.com"]
+
+  spec.summary = "Provides endpoint of a Well-Known URL for Changing Passwords"
+  spec.description = "Provides endpoint of a Well-Known URL for Changing Passwords"
+  spec.homepage = "https://github.com/taketo1113/rack-change-password-url"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/taketo1113/rack-change-password-url"
+  spec.metadata["changelog_uri"] = "https://github.com/taketo1113/rack-change-password-url/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack", ">= 2.2.3.1"
+
+  spec.add_development_dependency "rake", ">= 13.0"
+  spec.add_development_dependency "rspec", ">= 3.0"
+  spec.add_development_dependency "rack-test"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: rack-change-password-url
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Taketo Takashima
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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'
+description: Provides endpoint of a Well-Known URL for Changing Passwords
+email:
+- t.taketo1113@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack-change-password-url.rb
+- lib/rack/change-password-url.rb
+- lib/rack/change-password-url/middleware.rb
+- lib/rack/change-password-url/rails_options.rb
+- lib/rack/change-password-url/railtie.rb
+- lib/rack/change-password-url/version.rb
+- rack-change-password-url.gemspec
+homepage: https://github.com/taketo1113/rack-change-password-url
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/taketo1113/rack-change-password-url
+  source_code_uri: https://github.com/taketo1113/rack-change-password-url
+  changelog_uri: https://github.com/taketo1113/rack-change-password-url/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Provides endpoint of a Well-Known URL for Changing Passwords
+test_files: []