authrocket 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 496c2639a6c1ce3fbee2aa2630cad8fda1d9e2d4b6dc599b1e67cbaa3aa9e73b
-  data.tar.gz: 4b60926eeb42fe5c1a7676a40b144f097fd117dc6db5083e5c0990347d9e09cd
+  metadata.gz: 1081c944badcc582e41e1b6a2c490b7b36797072ce37c4c0d4ff95cff70c9a37
+  data.tar.gz: c3fb78aa005891773187d5dd3494b51746566b180c99358d41ec48fa9e46a6ee
 SHA512:
-  metadata.gz: '08b37f9964636332dd7154a03a5d37074cf7e766dfc48f9add8e96e114ec8a518b9a1324e74a1063931d2e40b4fd07e146675e0f03f28ac5914bf48372b5efd5'
-  data.tar.gz: 4269068e638a0451ca3af856101adf6d90660c0a68a8772e5b5625f3ebf1ec50b56fa8c2e2d69917086cc85f115bfc0f7afce708f580f547aaf837009862f348
+  metadata.gz: 71ae02ef915333191bc493a141c6ef9fa452184028cfb528ade5b264aa7323adb1a3d13d457566766b628246b892e19a2fa7587edefe57938f884f0da972ed15
+  data.tar.gz: 86634dae4a53d8dca492b409782c45a096db901adeee0ef5012ea7405782cf0ab6d9258a99c4ec6ba0514c405a8500b31991a9666e9e3a7aef55959982cfd4d3

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+#### 3.4.0
+
+- Document how to change locales
+- Self-configure rescue_responses when using Rails
+- Add request caching
+
 #### 3.3.0
 
 - Update Invitation, Hook, Realm, User

data/README.md

@@ -159,7 +159,7 @@ This default path may be changed using an initializer. Create/edit `config/initi
 
 ##### /logout route
 
-The default route for logout is `/logout`. To overrideis, add an initializer for AuthRocket (eg: `config/initializers/authrocket.rb`) and add:
+The default route for logout is `/logout`. To override it, add an initializer for AuthRocket (eg: `config/initializers/authrocket.rb`) and add:
 
     AuthRocket::Api.use_default_routes = false
 
@@ -206,11 +206,13 @@ AuthRocket's login tokens use the JWT standard and are cryptographically signed.
 AuthRocket also supports Managed Sessions, which enables you to enforce logouts, even across apps (single sign-out!). In this instance, the session is regularly verified using the AuthRocket API.
 
     def current_user
-      @_current_user ||= AuthRocket::Session.retrieve(session[:ar_token])&.user
+      @_current_user ||= AuthRocket::Session.retrieve(session[:ar_token], cache: {expires_in: 15.minutes})&.user
     end
 
 For better performance (and to avoid API rate limits), you will want to cache the results of the API call for 3-15 minutes.
 
+If not using Rails/ActiveSupport, use seconds: `cache: {expires_in: 15*60}` and also configure the cache store, as explained in Caching below. If using Rails, make sure Rails.cache is configured.
+
 
 #### Initial login
 
@@ -229,6 +231,66 @@ Each of the above are designed for ongoing use. The initial login isn't going to
 
 
 
+## Changing locales
+
+The AuthRocket Core API supports multi-locale access. See the AuthRocket docs for the currently supported locales.
+
+If you are using the streamlined Rails integration alongside LoginRocket, it may not be necessary to set the locale for API access. The locale is primarily used for generating localized error messages. This is only useful for API operations that might generate errors. When handling logins and signups via LoginRocket, LoginRocket will handle all of this for you.
+
+When the Accept-Language header is not sent, the AuthRocket Core API uses English.
+
+
+#### Global locale
+
+To set a global locale for your app, add this to your AuthRocket initializer:
+
+    AuthRocket::Api.default_headers.merge!(
+      accept_language: 'en'
+    )
+
+
+#### Per-request locale
+
+If your app supports multiple locales, then you'll likely want to set the locale on a per-request basis. Add a `headers: {accept_language: 'en'}` param to relevant API calls:
+
+    AuthRocket::User.create(
+      email: 'jdoe@example.com',
+      password: 'secret!',
+      headers: {accept_language: 'en'}
+    )
+
+
+
+## Caching
+
+The AuthRocket gem is capable of caching the results of GET requests. Since authentication and user data generally needs to be timely, this is opt-in on a per-request basis. The most common use is when validating sessions via the API.
+
+To enable caching, a cache store must be configured. On Rails, `authrocket` automatically uses Rails.cache, so simply ensure that's setup appropriately.
+
+If not using Rails (or if you with to use a different cache store even when using Rails), add this to your AuthRocket initializer:
+
+    cache_options = {} # app specific
+    AuthRocket::Api.cache_store = RedisCacheStore.new(cache_options)
+
+Any Rails-compatible cache store should work.
+
+Next, enable the cache for specific API calls:
+
+    # To avoid caching for too long, it's recommended to set a specific expiration time.
+    AuthRocket::Session.retrieve(token, cache: {expires_in: 5.minutes})
+
+    # However, it's possible to leave out :expires_in and use the cache store's default.
+    # Warning: Ensure the cache store has a default expiration, otherwise cache entries
+    # will last forever!
+    AuthRocket::Session.retrieve(token, cache: {})   # These are identical
+    AuthRocket::Session.retrieve(token, cache: true)
+
+    # All options in cache: {...} are passed directly to the cache store, so anything
+    # supported by your cache store is valid.
+    AuthRocket::Session.retrieve(token, cache: {expires_in: 15.minutes, force: true})
+
+
+
 ## Reference
 
 For full details on the AuthRocket API, including examples for Ruby, see our [documentation](https://authrocket.com/docs).

data/authrocket.gemspec

@@ -24,6 +24,6 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'ncore', '~> 3.0'
   gem.add_dependency 'jwt', '~> 2.1'
 
-  gem.add_development_dependency "bundler", "~> 1.3"
+  gem.add_development_dependency "bundler"
   gem.add_development_dependency "rake"
 end

data/lib/authrocket/api/railtie.rb

@@ -1,6 +1,15 @@
 module AuthRocket
   class Railtie < Rails::Railtie
 
+    config.action_dispatch.rescue_responses.merge!(
+      'AuthRocket::RecordInvalid'  => :unprocessable_entity, # 422
+      'AuthRocket::RecordNotFound' => :not_found, # 404
+    )
+
+    initializer "authrocket.cache_store" do |app|
+      AuthRocket::Api.cache_store = Rails.cache
+    end
+
     initializer "authrocket.log_runtime" do |app|
       require 'authrocket/api/log_subscriber'
       ActiveSupport.on_load(:action_controller) do

data/lib/authrocket/api/version.rb

@@ -1,3 +1,3 @@
 module AuthRocket
-  VERSION = '3.3.0'
+  VERSION = '3.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: authrocket
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - AuthRocket Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-15 00:00:00.000000000 Z
+date: 2021-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -56,16 +56,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -145,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: AuthRocket client for Ruby