auth1 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87e31158ba864d33d332a4c8d3f51fc22c6efc40f9b7b152c599853af6a3beed
-  data.tar.gz: c374e105ca45b58945e28b9609e2551227d23ba029dc4ff98314cf650c7169ce
+  metadata.gz: ab62e55c9216be06974fa4dd54b5d003c7821a45f3ffa89718e83199579c54f0
+  data.tar.gz: d59a75ac60f21c8771a4f2081aa69307b3b5c4158e6dd52cb42c0a260df141e3
 SHA512:
-  metadata.gz: 6fa02f1713470b70eda1f4cffc1482ae49a797f6520fe8e6786563fefe1a5725703b7dac125d65b951d7eb75805c8240d36cc18d68443b4281b3e2820b40dd3f
-  data.tar.gz: ff5ee901c1fbfba45d744d3f99b06a29349aa2a6bbda6bd737366795ae76b88c1fe7c09902858f144bbefed71203075b4b41b85f90fb1d3714d01e0c927f7a07
+  metadata.gz: 0bdf1f388ebe93068d18595a65d32d6bf73a9d0848b562a50f88983978985d2c345fd8145836fd66c6bda9bd104c3a80765acf075bc592c57542970ddf8586e1
+  data.tar.gz: 2e536940f599dc60555758accd786c561f5f3f8d023877e121b9147d220b9ca544d5273da7b497000a340475a31fd48fd67ac1579be0feefbcff58d00e8d190a

data/README.md

@@ -36,12 +36,14 @@ Add this line to your application's Gemfile:
 gem 'auth1'
 ```
 
-And then execute:
+Then run `bundle install`.
+
+Next, run the Auth1 install generator:
 ```bash
-$ bundle
+rails g auth1:install
 ```
 
-Set the following environment variables:
+This will add the following environment variables to `.env.local` if you are using [dotenv-rails](https://github.com/bkeepers/dotenv) gem:
 ```bash
 # Values from https://manage.auth0.com/#/applications
 AUTH0_CLIENT_ID
@@ -52,7 +54,17 @@ AUTH0_DOMAIN
 AUTH0_LOGOUT_URL
 ```
 
-Update **Allowed Callback URLs** field in [Auth0 Application Settings](https://manage.auth0.com/#/applications). For local development, you can set this value to `http://localhost:3000/auth/auth0/callback`git.
+If you're not using `dotenv-rails` gem, just set the above environment variables yourself.
+
+This will also mount Auth1 routes in your application by adding the following to `config/routes.rb`:
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  mount Auth1::Engine => '/'
+end
+```
+
+Update **Allowed Callback URLs** field in [Auth0 Application Settings](https://manage.auth0.com/#/applications). For local development, you can set this value to `http://localhost:3000/auth/auth0/callback`.
 
 Update **Allowed Logout URLs** field in [Auth0 Application Settings](https://manage.auth0.com/#/applications) with the same value in `AUTH0_LOGOUT_URL` environment variable.
 

data/lib/auth1/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Auth1
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/lib/generators/auth1/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Mount Auth1 routes and add environment variables.
+
+Example:
+    rails generate auth1:install
+
+    This will update:
+        .env.local
+        config/routes.rb

data/lib/generators/auth1/install_generator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Auth1
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Mount Auth1 routes and add environment variables.'
+
+      def update_routes
+        route "mount Auth1::Engine => '/'"
+      end
+
+      def add_auth0_env_vars
+        return unless defined?(Dotenv)
+
+        inject_into_file '.env.local' do
+          <<~HEREDOC
+            # Values from https://manage.auth0.com/#/applications
+            AUTH0_CLIENT_ID='AUTH0_CLIENT_ID'
+            AUTH0_CLIENT_SECRET='AUTH0_CLIENT_SECRET'
+            AUTH0_DOMAIN='AUTH0_DOMAIN'
+
+            # URL in your application to redirect to after logout from Auth0
+            AUTH0_LOGOUT_URL='http://localhost:3000/'
+          HEREDOC
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: auth1
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Joon Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-06 00:00:00.000000000 Z
+date: 2020-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-auth0
@@ -144,6 +144,8 @@ files:
 - lib/auth1.rb
 - lib/auth1/engine.rb
 - lib/auth1/version.rb
+- lib/generators/auth1/USAGE
+- lib/generators/auth1/install_generator.rb
 - lib/tasks/auth1_tasks.rake
 homepage: https://github.com/seouri/auth1
 licenses: