alchemy-json_api 2.4.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7812a7201b85a39537d23fddd317eda7154aae57d939e3eaa7b687edadf6cc06
-  data.tar.gz: 3202a669eb9298590b8cb434589dfda055e099002893e3c8034a07dddb996554
+  metadata.gz: 40926540b22b0e31f3761a394cd421fa64932b2d3a4067b519a8afe89266abb3
+  data.tar.gz: 7a7c5b56562dadc57cb0e4f0ce19ab16554631a44173700740ad4b67904cb6ac
 SHA512:
-  metadata.gz: e4c02e1f70dff8d703e65a8800f0568da0afca50ba8b9f6fe6f0da95d864378d7559204b401a89607076f5f7e5f073a12301bd0ea759da8609af0b3cef97f9a3
-  data.tar.gz: c7043b57ae494aad2e4d4073c4a94063b673f39358e07cc209d5dc5f884b6ff5fffc857b73f13d99f8fbc4b2c92597422af0a0de3d0b9b385cf46416b9b2be5a
+  metadata.gz: 20b7dce5cfb2dce79e2eba41bfceb34f7cc8cbf474759dd329e413f5e57f0289492901bb75096ca3d6109bd49c735ebf8a88aadcfba25c4925692b8eea35b7cd
+  data.tar.gz: a303f1895af78789b65e3b7d526a0ad8f9074e286f3db795cec2dfbadbbba98849d162ec62ce248ac56eebd9c3bb76cac532c413e62d200dd3a75bce2ccd0d93

data/README.md

@@ -13,11 +13,13 @@ gem 'alchemy-json_api'
 ```
 
 And then execute:
+
 ```bash
 $ bundle
 ```
 
 Or install it yourself as:
+
 ```bash
 $ gem install alchemy-json_api
 ```
@@ -27,9 +29,11 @@ $ gem install alchemy-json_api
 Run this in your application:
 
 ```
-yarn add "@alchemy_cms/json_api"
+npm install @alchemy_cms/json_api --save
 ```
 
+or with the package manager of your choice
+
 ## Usage
 
 ### In your Rails app
@@ -57,18 +61,46 @@ const pages = deserializePages(data)
 console.log(pages[0].name) // => Homepage
 ```
 
+## HTTP Caching
+
+Alchemy::JsonApi allows for caching API responses. It respects the caching configuration of your Rails app and of your Alchemy configuration and settings in the pages page layout configuration. Restricted pages are never cached.
+
+By default it sets the `max-age` `Cache-Control` header to 10 minutes (`600` seconds). You can change this by configuring the `Alchemy::JsonApi.page_cache_max_age` setting. It is recommended to set this via an environment variable like this:
+
+```rb
+# config/initializers/alchemy_json_api.rb
+Alchemy::JsonApi.page_cache_max_age = ENV.fetch("ALCHEMY_JSON_API_CACHE_DURATION", 600).to_i
+```
+
+### Edge Caching
+
+Alchemy sets the `must-revalidate` directive if caching is enabled. If your CDN supports it, you can change that to use the much more efficient `stale-while-revalidate` directive by changing the `Alchemy::JsonApi.page_caching_options` setting to any integer value.
+
+```rb
+# config/initializers/alchemy_json_api.rb
+Alchemy::JsonApi.page_caching_options = {
+  stale_while_revalidate: ENV.fetch("ALCHEMY_JSON_API_CACHE_STALE_WHILE_REVALIDATE", 60).to_i
+}
+```
+
+> [!TIP]
+> You can set any caching option that [`ActionController::ConditionalGet#expires_in` supports](https://api.rubyonrails.org/classes/ActionController/ConditionalGet.html#method-i-expires_in), like `stale_if_error`, `public` or `immutable`.
+
 ## Key transforms
 
 If you ever want to change how Alchemy serializes attributes you can set
 
 ```rb
+# config/initializers/alchemy_json_api.rb
 Alchemy::JsonApi.key_transform = :camel_lower
 ```
 
 It defaults to `:underscore`.
 
 ## Contributing
+
 Contribution directions go here.
 
 ## License
+
 The gem is available as open source under the terms of the [BSD-3-Clause license](https://opensource.org/licenses/BSD-3-Clause).

data/app/controllers/alchemy/json_api/admin/pages_controller.rb

@@ -18,11 +18,7 @@ module Alchemy
         end
 
         def set_current_preview
-          if Alchemy.const_defined?(:Current)
-            Alchemy::Current.preview_page = @page
-          else
-            Alchemy::Page.current_preview = @page
-          end
+          Alchemy::Current.preview_page = @page
         end
 
         def page_cache_key(page)

data/app/controllers/alchemy/json_api/pages_controller.rb

@@ -3,7 +3,7 @@
 module Alchemy
   module JsonApi
     class PagesController < JsonApi::BaseController
-      THREE_HOURS = 10800
+      CACHE_DURATION = 600
       JSONAPI_STALEMAKERS = %i[include fields sort filter page]
 
       before_action :load_page_for_cache_key, only: :show
@@ -51,11 +51,11 @@ module Alchemy
       end
 
       def cache_duration
-        ENV.fetch("ALCHEMY_JSON_API_CACHE_DURATION", THREE_HOURS).to_i
+        Alchemy::JsonApi.page_cache_max_age
       end
 
       def caching_options
-        {must_revalidate: true}
+        Alchemy::JsonApi.page_caching_options
       end
 
       # Get page w/o includes to get cache key
@@ -138,11 +138,7 @@ module Alchemy
       end
 
       def current_language
-        if Alchemy.const_defined?(:Current)
-          Alchemy::Current.language
-        else
-          Alchemy::Language.current
-        end
+        Alchemy::Current.language
       end
 
       def jsonapi_serializer_class(_resource, _is_collection)

data/app/serializers/alchemy/json_api/ingredient_page_serializer.rb

@@ -20,7 +20,7 @@ module Alchemy
       end
 
       has_one :page, record_type: :page, serializer: PageSerializer do |ingredient|
-        ingredient.page&.tap { Page.new(_1) }
+        Alchemy::JsonApi::Page.new(ingredient.page) if ingredient.page
       end
     end
   end

data/lib/alchemy/json_api/version.rb

@@ -2,6 +2,6 @@
 
 module Alchemy
   module JsonApi
-    VERSION = "2.4.2"
+    VERSION = "3.0.0"
   end
 end

data/lib/alchemy/json_api.rb

@@ -6,6 +6,8 @@ require "alchemy/json_api/engine"
 
 module Alchemy
   module JsonApi
+    extend self
+
     # Set FastJsonapi key_transform
     #
     # Supported transformations:
@@ -14,15 +16,45 @@ module Alchemy
     # :camel_lower # "some_key" => "someKey"
     # :dash # "some_key" => "some-key"
     # :underscore # "some_key" => "some_key"
-    def self.key_transform=(value)
+    def key_transform=(value)
       @_key_transform = value
     end
 
     # FastJsonapi key_transform
     #
     # Default :underscore # "some_key" => "some_key"
-    def self.key_transform
+    def key_transform
       @_key_transform || :underscore
     end
+
+    # HTTP Cache-Control max-age
+    #
+    # Can be set as `ALCHEMY_JSON_API_CACHE_DURATION` env var
+    #
+    # Default 600 (seconds)
+    def page_cache_max_age
+      @_page_cache_max_age ||= ENV.fetch("ALCHEMY_JSON_API_CACHE_DURATION", 600).to_i
+    end
+
+    def page_cache_max_age=(max_age)
+      @_page_cache_max_age = max_age
+    end
+
+    # HTTP Cache-Control options
+    #
+    # Set any of the ActionController::ConditionalGet#expires_in options
+    #
+    # See https://api.rubyonrails.org/classes/ActionController/ConditionalGet.html#method-i-expires_in
+    #
+    # Default `{must_revalidate: true}`
+    def page_caching_options
+      @_page_caching_options ||= {
+        must_revalidate: true
+      }
+    end
+
+    def page_caching_options=(options)
+      @_page_caching_options = options
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alchemy-json_api
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Martin Meyerhoff
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0.a
+        version: 7.2.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0.a
+        version: 7.2.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'