cognito_idp_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f89e3021ee553c158133054d9b09a94fe02a0b0a490b462947a2b974df4cc0a9
+  data.tar.gz: 4984a4e7baffdce01541c67295575ba6dc518c53c94d66854dce6d51eabe494e
+SHA512:
+  metadata.gz: 5df85e9025803085b8aabb27a7b389219e87b6d817744ff7045f3075e1eef54b468288f387d559164d895faee2d34a9f17d78a43d8238f8b59e86d7dfe5ee40f
+  data.tar.gz: 85bc14d48e72a38fee9ffdc11e0fbcd3768a39aaebcb8c0fbd45076c26bb254ec01dc006d3556f9e652b7a401bd993e4823fe40771f75d826c87cf68bbf43222

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Appercept Limited
+
+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,43 @@
+# CognitoIdpRails
+
+Simple integration of Amazon Cognito IdP (User Pools) for Rails applications.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add cognito_idp_rails
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install cognito_idp_rails
+
+## Usage
+
+After adding the gem to your application, run the install generator:
+
+    $ rails generate cognito_idp:install
+
+This generator will add `cognito_idp` to your routes and install an initializer at `config/initializers/cognito_idp.rb`.
+
+Be sure to review and edit the initializer to configure options for your Amazon Cognito User Pool configuration. You
+must also provide an implementation for the `on_valid_login` function in the initializer appropriate for any actions you
+want to take when a user signed in.
+
+## 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/appercept/cognito_idp_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/appercept/cognito_idp_rails/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CognitoIdpRails project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/appercept/cognito_idp_rails/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/cognito_idp_rails_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/cognito_idp_rails .css

data/app/assets/stylesheets/cognito_idp_rails/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/cognito_idp_rails/application_controller.rb

@@ -0,0 +1,4 @@
+module CognitoIdpRails
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/cognito_idp_rails/sessions_controller.rb

@@ -0,0 +1,61 @@
+require "cognito_idp"
+
+module CognitoIdpRails
+  class SessionsController < ApplicationController
+    before_action :verify_state, only: [:login_callback]
+
+    def login
+      redirect_to authorization_url, allow_other_host: true
+    end
+
+    def login_callback
+      client.get_token(grant_type: :authorization_code, code: params[:code], redirect_uri: auth_login_callback_url) do |token|
+        client.get_user_info(token) do |user_info|
+          reset_session
+          configuration.on_valid_login.call(token, user_info, session)
+          redirect_to configuration.after_login_route, notice: "You have been successfully logged in."
+          return
+        end
+      end
+      redirect_to configuration.after_login_route, notice: "Login failed."
+    end
+
+    def logout
+      redirect_to client.logout_uri(logout_uri: auth_logout_callback_url), allow_other_host: true
+    end
+
+    def logout_callback
+      configuration.on_logout.call(session)
+      reset_session
+      redirect_to configuration.after_logout_route, notice: "You have been successfully logged out."
+    end
+
+    private
+
+    def authorization_url
+      client.authorization_uri(redirect_uri: auth_login_callback_url, scope: scope, state: login_state)
+    end
+
+    def client
+      CognitoIdpRails.client
+    end
+
+    def configuration
+      CognitoIdpRails.configuration
+    end
+
+    def scope
+      configuration.scope
+    end
+
+    def login_state
+      session[:login_state] ||= SecureRandom.urlsafe_base64
+    end
+
+    def verify_state
+      return if params[:state] == login_state
+
+      redirect_to configuration.after_login_route, notice: "Login failed."
+    end
+  end
+end

data/app/helpers/cognito_idp_rails/application_helper.rb

@@ -0,0 +1,4 @@
+module CognitoIdpRails
+  module ApplicationHelper
+  end
+end

data/app/jobs/cognito_idp_rails/application_job.rb

@@ -0,0 +1,4 @@
+module CognitoIdpRails
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/cognito_idp_rails/application_mailer.rb

@@ -0,0 +1,6 @@
+module CognitoIdpRails
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/cognito_idp_rails/application_record.rb

@@ -0,0 +1,5 @@
+module CognitoIdpRails
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/cognito_idp_rails/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Cognito idp rails</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "cognito_idp_rails/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+CognitoIdpRails::Engine.routes.draw do
+end

data/lib/cognito_idp_rails/configuration.rb

@@ -0,0 +1,13 @@
+module CognitoIdpRails
+  class Configuration
+    attr_accessor :after_login_route, :after_logout_route, :domain, :client_id,
+      :client_secret, :on_logout, :on_valid_login, :scope
+
+    def initialize
+      @after_login_route = "/"
+      @after_logout_route = "/"
+      @on_valid_login = lambda { |token, user_info, session| }
+      @on_logout = lambda { |session| }
+    end
+  end
+end

data/lib/cognito_idp_rails/engine.rb

@@ -0,0 +1,11 @@
+module CognitoIdpRails
+  class Engine < ::Rails::Engine
+    initializer "cognito_idp_rails.add_routing_paths" do |app|
+      ActionDispatch::Routing::Mapper.send(:include, CognitoIdpRails::Routing::MapperExtensions)
+    end
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/cognito_idp_rails/routing/mapper_extensions.rb

@@ -0,0 +1,12 @@
+module CognitoIdpRails
+  module Routing
+    module MapperExtensions
+      def cognito_idp
+        get("/login", to: "cognito_idp_rails/sessions#login")
+        get("/auth/login_callback", to: "cognito_idp_rails/sessions#login_callback")
+        get("/logout", to: "cognito_idp_rails/sessions#logout")
+        get("/auth/logout_callback", to: "cognito_idp_rails/sessions#logout_callback")
+      end
+    end
+  end
+end

data/lib/cognito_idp_rails/version.rb

@@ -0,0 +1,3 @@
+module CognitoIdpRails
+  VERSION = "0.1.0"
+end

data/lib/cognito_idp_rails.rb

@@ -0,0 +1,29 @@
+require "cognito_idp_rails/engine"
+require "cognito_idp_rails/version"
+require "cognito_idp"
+
+module CognitoIdpRails
+  autoload :Configuration, "cognito_idp_rails/configuration"
+
+  module Routing
+    autoload :MapperExtensions, "cognito_idp_rails/routing/mapper_extensions"
+  end
+
+  class << self
+    def client
+      @client ||= CognitoIdp::Client.new(
+        client_id: configuration.client_id,
+        client_secret: configuration.client_secret,
+        domain: configuration.domain
+      )
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/lib/generators/cognito_idp_rails/install_generator.rb

@@ -0,0 +1,18 @@
+require "rails/generators"
+
+module CognitoIdpRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Add an initializer and routes for Cognito IdP to your app"
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_initializer
+        template "cognito_idp_rails_initializer.rb.tt", "config/initializers/cognito_idp.rb"
+      end
+
+      def add_routes
+        route "cognito_idp"
+      end
+    end
+  end
+end

data/lib/generators/cognito_idp_rails/templates/cognito_idp_rails_initializer.rb.tt

@@ -0,0 +1,17 @@
+CognitoIdpRails.configure do |config|
+  config.client_id = ENV["COGNITO_CLIENT_ID"]
+  config.client_secret = ENV["COGNITO_CLIENT_SECRET"]
+  config.domain = ENV["COGNITO_DOMAIN"]
+  config.on_valid_login = lambda do |token, user_info, session|
+    # 1. Find or create a user.
+    # user = User.where(identifier: user_info.sub).find_or_create do |user|
+    #   user.email = user_info.email
+    # end
+
+    # 2. Set any session data for the user.
+    # session[:user_id] = user.id
+  end
+  config.on_logout = lambda do |session|
+    # Your last chance to do something before the session is reset.
+  end
+end

data/lib/tasks/cognito_idp_rails_tasks.rake

@@ -0,0 +1,2 @@
+default_install_migrations_task_name = "cognito_idp_rails:install:migrations"
+Rake::Task[default_install_migrations_task_name].clear if Rake::Task.task_defined?(default_install_migrations_task_name)

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: cognito_idp_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Richard Hatherall
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cognito_idp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+description: Simple Rails integration for authentication through Amazon Cognito IdP
+  (User Pools)
+email:
+- richard@appercept.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/config/cognito_idp_rails_manifest.js
+- app/assets/stylesheets/cognito_idp_rails/application.css
+- app/controllers/cognito_idp_rails/application_controller.rb
+- app/controllers/cognito_idp_rails/sessions_controller.rb
+- app/helpers/cognito_idp_rails/application_helper.rb
+- app/jobs/cognito_idp_rails/application_job.rb
+- app/mailers/cognito_idp_rails/application_mailer.rb
+- app/models/cognito_idp_rails/application_record.rb
+- app/views/layouts/cognito_idp_rails/application.html.erb
+- config/routes.rb
+- lib/cognito_idp_rails.rb
+- lib/cognito_idp_rails/configuration.rb
+- lib/cognito_idp_rails/engine.rb
+- lib/cognito_idp_rails/routing/mapper_extensions.rb
+- lib/cognito_idp_rails/version.rb
+- lib/generators/cognito_idp_rails/install_generator.rb
+- lib/generators/cognito_idp_rails/templates/cognito_idp_rails_initializer.rb.tt
+- lib/tasks/cognito_idp_rails_tasks.rake
+homepage: https://github.com/appercept/cognito_idp_rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/appercept/cognito_idp_rails
+  source_code_uri: https://github.com/appercept/cognito_idp_rails
+  changelog_uri: https://github.com/appercept/cognito_idp_rails/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Simple Rails integration for Amazon Cognito IdP (User Pools)
+test_files: []