rodauth 2.15.0 → 2.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3abad4574361365b90229229928b653d049ad73e2e366195e10bb8ee565de323
-  data.tar.gz: 2fecb89ba5456f9aa8569eef019dbf7f9b7a3b7736b3da053ce15e5b4d67074c
+  metadata.gz: 03b165b6104e72c5c2ea6d76b3b0bf53380d4eacd90cbdab80b9fd655d80f1c4
+  data.tar.gz: af12c12c4bdf9aa47ffd0a34bd7df2858c006edcafa257e60ddd28c962d62630
 SHA512:
-  metadata.gz: 9086a3f18f04da0184af7fcaaa3c474ae3560e7b9c1b6b526cbbd8239ca4f2f47f2a44fe4e8681e349c5bb78a6e3f7529b5bd296d62ad92e1a1ac9188122a4ab
-  data.tar.gz: 2b67d509e6a0b0a61ca679f45238714b817d6eef1becb9e1ecfeab33d7e296d3f43ffa0a392d812981b8a3f096cbc868501c00f6661d1c72194cdfe0726ef842
+  metadata.gz: d11f3050e692d426c409a061c4f23489208618613868653a59fad982fd66b62ec4c9fe5b320b390f3789b5fc3d704d2d3ac99d9105bc54f9ee33dcfaa690dfd2
+  data.tar.gz: 811fb60b3f055d59866cf3b262ab197e8cf80a1ca7291724e756c58a99f1cdaddf994a73a500cdcff03f600fd1333e49cf3d1830cc9f10d01af641648c9fd930

data/CHANGELOG

@@ -1,3 +1,9 @@
+=== 2.16.0 (2021-08-23)
+
+* Add Rodauth.lib for using Rodauth as a library (jeremyevans)
+
+* Make internal_request feature work if the configuration uses only_json? true (janko) (#176)
+
 === 2.15.0 (2021-07-27)
 
 * Add path_class_methods feature, for getting paths/URLs using class methods (jeremyevans)

data/README.rdoc

@@ -1073,6 +1073,27 @@ methods on that class to perform actions on behalf of a user. See the
 {internal request feature documentation}[rdoc-ref:doc/internal_request.rdoc]
 for details.
 
+== Using Rodauth as a Library
+
+Rodauth was designed to serve as an authentication framework for Rack applications.
+However, Rodauth can be used purely as a library outside of a web application. You
+can do this by requiring +rodauth+, and using the +Rodauth.lib+ method to return
+a <tt>Rodauth::Auth</tt> subclass, which you can call methods on.  You pass the
++Rodauth.lib+ method an optional hash of Rodauth plugin options and a Rodauth
+configuration block:
+
+  require 'rodauth'
+  rodauth = Rodauth.lib do
+    enable :create_account, :change_password
+  end
+  rodauth.create_account(login: 'foo@example.com', password: '...')
+  rodauth.change_password(account_id: 24601, password: '...')
+
+This supports builds on top of the internal_request support (it implicitly loads
+the internal_request feature before processing the configuration block), and
+allows the use of Rodauth in non-web applications. Note that you still have to
+setup a Sequel::Database connection for Rodauth to use for data storage.
+
 === With Multiple Configurations
 
 Rodauth supports using multiple rodauth configurations in the same

data/doc/release_notes/2.16.0.txt

@@ -0,0 +1,20 @@
+= New Features
+
+* Rodauth.lib has been added for using Rodauth purely as a library,
+  useful in non-web applications:
+
+    require 'rodauth'
+    rodauth = Rodauth.lib do
+      enable :create_account, :change_password
+    end
+    rodauth.create_account(login: 'foo@example.com', password: '...')
+    rodauth.change_password(account_id: 24601, password: '...')
+
+  This is built on top of the internal_request feature, and works by
+  creating a Roda application with the rodauth plugin, and returning
+  the related Rodauth::Auth class.
+
+= Other Improvements
+
+* The internal_request feature now works correctly for configurations
+  where only_json? is set to true.

data/lib/rodauth/features/internal_request.rb

@@ -92,6 +92,10 @@ module Rodauth
       @internal_request_return_value
     end
 
+    def only_json?
+      false
+    end
+
     private
 
     def internal_request?

data/lib/rodauth/version.rb

@@ -6,7 +6,7 @@ module Rodauth
   MAJOR = 2
 
   # The minor version of Rodauth, updated for new feature releases of Rodauth.
-  MINOR = 15
+  MINOR = 16
 
   # The patch version of Rodauth, updated only for bug fixes from the last
   # feature release.

data/lib/rodauth.rb

@@ -3,6 +3,17 @@
 require 'securerandom'
 
 module Rodauth
+  def self.lib(opts={}, &block) 
+    require 'roda'
+    c = Class.new(Roda)
+    c.plugin(:rodauth, opts) do
+      enable :internal_request
+      instance_exec(&block)
+    end
+    c.freeze
+    c.rodauth
+  end
+
   def self.load_dependencies(app, opts={})
     json_opt = opts.fetch(:json, app.opts[:rodauth_json])
     if json_opt

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rodauth
 version: !ruby/object:Gem::Version
-  version: 2.15.0
+  version: 2.16.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-27 00:00:00.000000000 Z
+date: 2021-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -329,6 +329,7 @@ extra_rdoc_files:
 - doc/release_notes/2.13.0.txt
 - doc/release_notes/2.14.0.txt
 - doc/release_notes/2.15.0.txt
+- doc/release_notes/2.16.0.txt
 - doc/release_notes/2.2.0.txt
 - doc/release_notes/2.3.0.txt
 - doc/release_notes/2.4.0.txt
@@ -429,6 +430,7 @@ files:
 - doc/release_notes/2.13.0.txt
 - doc/release_notes/2.14.0.txt
 - doc/release_notes/2.15.0.txt
+- doc/release_notes/2.16.0.txt
 - doc/release_notes/2.2.0.txt
 - doc/release_notes/2.3.0.txt
 - doc/release_notes/2.4.0.txt