rodauth-rails 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd5d6b153ae21b024570d612aff57a2c0d6f090f2215723b25bbc362ee743c9b
-  data.tar.gz: e6aac1fe20d00bd4c94559c74dbc56bd971da4404d086ec3193db8e06fe2a3bd
+  metadata.gz: c1e2e56e1f7312210e9f8fc587a783445f701a238aec21febf5f6ae0489e39c9
+  data.tar.gz: d192cdbbc8aeebbb0a8318430cc5771bf26abd6e392644393c1755af28aeb9dd
 SHA512:
-  metadata.gz: 83a5c386eaf39c7aa9b0536e9aed25e8a61bc069e2388bee556b28e9ee00941528fd5431199711d77a28212d281376258ecf0b914d6aa928954d8d99543b827b
-  data.tar.gz: 815d7fee34954d2f512e4532d02bb9d183ad9bde92fc622d522c517cd9db575c8fef98c857dce81c8329cd1798481b8e2f4609390b2472d83825d393886a3576
+  metadata.gz: 145b25b7e6bdb4a6ad395ec5e717112c93624005480bda4d617c036d45766224ea9ebe7f389b14f6d3fb6a9036c9a9a08c7595cfae710b58ff3458f698e9ce70
+  data.tar.gz: 51018b0878979bbc34c03f6dbd2a197c04854e3022561dd3db97ae2bb5d42f436d22c008d0ffd06ca8693435e5a69b5e938587f92baf5c39ad50bb247dfa2979

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.4.1 (2020-11-02)
+
+* Don't generate `RodauthController` in API-only mode (@janko)
+
+* Pass `test: false` to Sequel in the `sequel.rb` initializer (@janko)
+
 ## 0.4.0 (2020-11-02)
 
 * Support Rails API-only mode (@janko)

data/README.md

@@ -13,7 +13,7 @@ Provides Rails integration for the [Rodauth] authentication framework.
 Add the gem to your Gemfile:
 
 ```rb
-gem "rodauth-rails", "~> 0.3"
+gem "rodauth-rails", "~> 0.4"
 
 # gem "jwt",      require: false # for JWT feature
 # gem "rotp",     require: false # for OTP feature
@@ -88,7 +88,7 @@ ActiveRecord connection.
 require "sequel/core"
 
 # initialize Sequel and have it reuse Active Record's database connection
-DB = Sequel.postgres(extensions: :activerecord_connection)
+DB = Sequel.postgres(extensions: :activerecord_connection, test: false)
 ```
 
 ### Rodauth app
@@ -184,7 +184,7 @@ our app. We can do this in our Rodauth app's routing block, which helps keep
 the authentication logic encapsulated:
 
 ```rb
-# lib/rodauth_app.rb
+# app/lib/rodauth_app.rb
 class RodauthApp < Rodauth::Rails::App
   # ...
   route do |r|
@@ -304,7 +304,7 @@ Rodauth may send emails as part of the authentication flow. Most email settings
 can be customized:
 
 ```rb
-# lib/rodauth_app.rb
+# app/lib/rodauth_app.rb
 class RodauthApp < Rodauth::Rails::App
   # ...
   configure do
@@ -349,7 +349,7 @@ your mailer. If you've enabled additional authentication features, make sure to
 override their `send_*_email` methods as well.
 
 ```rb
-# lib/rodauth_app.rb
+# app/lib/rodauth_app.rb
 class RodauthApp < Rodauth::Rails::App
   # ...
   configure do
@@ -385,6 +385,37 @@ class RodauthApp < Rodauth::Rails::App
 end
 ```
 
+### JSON API
+
+JSON API support in Rodauth is provided by the [JWT feature]. First you'll need
+to add the [JWT gem] to your Gemfile:
+
+```rb
+gem "jwt"
+```
+
+The following configuration will enable the Rodauth endpoints to be accessed
+via JSON requests (in addition to HTML requests):
+
+```rb
+# app/lib/rodauth_app.rb
+class RodauthApp < Rodauth::Rails::App
+  configure(json: true) do
+    # ...
+    enable :jwt
+    jwt_secret "...your secret key..."
+    # ...
+  end
+end
+```
+
+If you want the endpoints to be only accessible via JSON requests, or if your
+Rails app is in API-only mode, instead of `json: true` pass `json: :only` to
+the configure method.
+
+Make sure to store the `jwt_secret` in a secure place, such as Rails
+credentials or environment variables.
+
 ## How it works
 
 ### Middleware
@@ -490,28 +521,6 @@ Rodauth::Rails.configure do |config|
 end
 ```
 
-## Working with JWT
-
-To use Rodauth's [JWT feature], you'll need to load Roda's JSON support in
-`configure`:
-
-```rb
-# lib/rodauth_app.rb
-class RodauthApp < Rodauth::Rails::App
-  configure(json: true) do
-    enable :jwt
-    jwt_secret "...your secret key..."
-    # your configuration
-  end
-end
-```
-
-Make sure to store the `jwt_secret` in a secure place, such as Rails
-credentials or environment variables.
-
-Rodauth's JWT feature depends on the [JWT gem], so make sure to add it to your
-Gemfile.
-
 ## Testing
 
 If you're writing system tests, it's generally better to go through the actual

data/lib/generators/rodauth/install_generator.rb

@@ -35,6 +35,8 @@ module Rodauth
         end
 
         def create_rodauth_controller
+          return if api_only?
+
           template "app/controllers/rodauth_controller.rb"
         end
 

data/lib/generators/rodauth/templates/app/lib/rodauth_app.rb

@@ -11,8 +11,10 @@ class RodauthApp < Rodauth::Rails::App
     # http://rodauth.jeremyevans.net/documentation.html
 
     # ==> General
+<% unless api_only? -%>
     # Specify the controller used for view rendering and CSRF verification.
     rails_controller { RodauthController }
+<% end -%>
 
     # Store account status in a text column.
     account_status_column :status

data/lib/generators/rodauth/templates/config/initializers/sequel.rb

@@ -2,7 +2,7 @@ require "sequel/core"
 
 # initialize Sequel and have it reuse Active Record's database connection
 <% if RUBY_ENGINE == "jruby" -%>
-DB = Sequel.connect("jdbc:<%= sequel_adapter %>://", extensions: :activerecord_connection)
+DB = Sequel.connect("jdbc:<%= sequel_adapter %>://", extensions: :activerecord_connection, test: false)
 <% else -%>
-DB = Sequel.<%= sequel_adapter %>(extensions: :activerecord_connection)
+DB = Sequel.<%= sequel_adapter %>(extensions: :activerecord_connection, test: false)
 <% end -%>

data/lib/rodauth/rails/feature.rb

@@ -62,9 +62,13 @@ module Rodauth
 
     # Calls the Rails renderer, returning nil if a template is missing.
     def rails_render(*args)
-      rails_controller_instance.render_to_string(*args)
-    rescue ActionView::MissingTemplate
-      nil
+      return if only_json?
+
+      begin
+        rails_controller_instance.render_to_string(*args)
+      rescue ActionView::MissingTemplate
+        nil
+      end
     end
 
     # Hidden tag with Rails CSRF token inserted into Rodauth templates.

data/lib/rodauth/rails/version.rb

@@ -1,5 +1,5 @@
 module Rodauth
   module Rails
-    VERSION = "0.4.0"
+    VERSION = "0.4.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rodauth-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Janko Marohnić