dato-rails 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02c359d5fbd1d6c3ec6aeb523e4e6cd363d76eeeec4045a195af8d89f62f59f8
-  data.tar.gz: 3a81c86545557254a92fe7b323bc241cac6b33051d619847d5e911f286cbb0ab
+  metadata.gz: 48c76d182eea6b57c5a9fa7dc5731fd203ec11ab3fc6a263c6cd5cfbbed92520
+  data.tar.gz: c0109db369f7571f690448dbd4119104a887bfb3e28baa4c7f2481cac090baaf
 SHA512:
-  metadata.gz: 49b7857ed9358db19ea94a5c984250ec50b389bc806af3c6df8a7919504c8dbd6aa837c167bffed60f69c8cbd599ed86e03bbedbe721e39adf1b80a758a42adc
-  data.tar.gz: bcc954ba7e8606a5c807d0d3f1be11b1a82d0a3b065cfef77e051b7b481e3fe8b0f4f424738216ab0602a009446709c14b5d4133eef576e4960fa194fd1f4b4e
+  metadata.gz: 90dee86a67536de6913bffe0d2ea41cc776b1b6ab5e884d392bfc2181fe0e73092cffc10398200e995d22dfe95b4c6eadff05618c2d696aa0ec960a4f7fe2d4e
+  data.tar.gz: d8a03730831b5a348e095b505bb10b170f36e0da4045417c508de4303579a741aa6bc6a419226aeafb49e18df0a1196d370eca63bd965f01550fffb2d554563c

data/README.md

@@ -4,6 +4,8 @@ Use [DatoCMS](https://www.datocms.com/) in your Rails application.
 
 This gem allows you to fetch data using Dato GraphQL APIs and render the content in your Rails app.
 
+👉 See [this simple tutorial to get started on dev.to](https://dev.to/coorasse/datocms-with-ruby-on-rails-3ae5). 👈
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -116,7 +118,7 @@ client.live!(your_query)
 
 A `ViewComponent` is provided to use both these features very easily!
 
-Given that you have a `ViewComponent` that takes in input only the result of a dato query,
+Given that you have a `MyComponent` that takes in input only the result of a dato query,
 you probably have the following:
 
 ```ruby
@@ -132,6 +134,68 @@ render(Dato::Live.new(MyComponent, my_query, preview: true, live: true))
 
 and your component will come to life with live updates 🎉 (requires turbo).
 
+## Configuration
+
+The following options are available:
+
+```ruby
+# config/initializers/dato.rb
+
+Dato::Config.configure do |config|
+  config.overrides = {} # default: {}
+  config.blocks = {} # default: {}
+  config.cache = false # default: false
+  config.cache_namespace = 'dato-rails' # default: 'dato-rails'
+  config.publish_key = ENV['DATO_PUBLISH_KEY'] # default: ENV['DATO_PUBLISH_KEY']
+  config.build_triggger_id = ENV['DATO_BUILD_TRIGGER_ID'] # default: ENV['DATO_BUILD_TRIGGER_ID']
+end
+```
+
+## Caching
+
+The library supports caching of the rendered components. 
+If you enable caching, the components rendered using `Dato::Live`, will be cached.
+
+To enable caching, you need to set the `cache` option in the configuration.
+
+```ruby
+# config/initializers/dato.rb
+
+Dato::Config.configure do |config|
+  config.cache = 1.day # if you set it to `true`, it will default to 60 minutes
+end
+```
+
+Now a call to
+
+```ruby
+render(Dato::Live.new(MyComponent, my_query))
+```
+
+will be cached for 1 day. 
+
+This means that for the next 24 hours, the graphQL endpoint will not be invoked and the whole component rendering will also be skipped.
+
+**We will cache the entire HTML result of the component, not only the graphQL response.**
+
+If you want to expire the cache you have two options:
+
+### manually
+
+executing `Rails.cache.clear(namespace: Dato::Config.cache_namespace)`
+
+### publish endpoint
+
+You can take advantage of the publish mechanism of Dato CMS to expire the cache.
+* Mount the `dato-rails` engine in your Rails routes file.
+* Set the `DATO_PUBLISH_KEY` environment variable
+* Create a build trigger with a custom webhook on your Dato CMS project setting.
+* Define the Trigger URL as `https://yourapp.com/dato/publish`
+* Set the `DATO_PUBLISH_KEY` as the Authorization header
+* Copy the build trigger id and set it as `DATO_BUILD_TRIGGER_ID` environment variable.
+
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. 

data/app/components/dato/list.rb

@@ -6,6 +6,6 @@ class Dato::List < Dato::DastNode
   end
 
   def generated_tag
-    @node.style == "bulleted" ? "ul" : "ol"
+    (@node.style == "bulleted") ? "ul" : "ol"
   end
 end

data/app/components/dato/live.html.erb

@@ -1,8 +1,8 @@
-<% if @live %>
+<% if live %>
   <script type="text/javascript">
-    const eventSourceUrl = '<%=@data.url %>';
-    const componentKlass = '<%=@component_klass%>';
-    const frameId = '<%=@frame_id%>';
+    const eventSourceUrl = '<%=data.url %>';
+    const componentKlass = '<%=component_klass%>';
+    const frameId = '<%=frame_id%>';
     const eventSource = new EventSource(eventSourceUrl);
     eventSource.addEventListener("update", (event) => {
       const params = new URLSearchParams({
@@ -14,7 +14,13 @@
     });
   </script>
 
-  <%= turbo_frame_tag @frame_id %>
+  <%= turbo_frame_tag frame_id %>
 <% else %>
-  <%= render(@component_klass.new(@data)) %>
+  <% if cache? %>
+    <%= Rails.cache.fetch(cache_key, expires_in: cache_time, namespace: Dato::Config.cache_namespace) do %>
+      <% render(component_klass.new(data)) %>
+    <% end %>
+  <% else %>
+    <%= render(component_klass.new(data)) %>
+  <% end %>
 <% end %>

data/app/components/dato/live.rb

@@ -7,11 +7,34 @@ module Dato
   class Live < ViewComponent::Base
     delegate :turbo_frame_tag, to: :helpers
 
+    attr_reader :component_klass, :query, :preview, :live
+
     def initialize(component_klass, query, preview: false, live: false)
-      @data = dato_fetch(query, preview: preview, live: live)
+      super()
       @component_klass = component_klass
+      @query = query
+      @preview = preview
       @live = live
-      @frame_id = SecureRandom.hex(10)
+    end
+
+    def cache?
+      Dato::Config.cache.present?
+    end
+
+    def cache_key
+      @cache_key ||= Digest::MD5.hexdigest(query.to_gql)
+    end
+
+    def cache_time
+      @cache_time ||= Dato::Config.cache.is_a?(Integer) ? Dato::Config.cache : 60.minutes
+    end
+
+    def data
+      @data ||= dato_fetch(query, preview: preview, live: live)
+    end
+
+    def frame_id
+      @frame_id ||= SecureRandom.hex(10)
     end
 
     private

data/app/components/dato/unknown_block.rb

@@ -2,8 +2,5 @@
 
 module Dato
   class UnknownBlock < Node
-    def initialize(block, root)
-      super(block, root)
-    end
   end
 end

data/app/controllers/dato/publish_controller.rb

@@ -0,0 +1,37 @@
+require "net/http"
+require "uri"
+
+module Dato
+  class PublishController < ActionController::Base
+    skip_before_action :verify_authenticity_token
+    before_action :check, only: :create
+
+    def create
+      Rails.cache.clear(namespace: Dato::Config.cache_namespace)
+
+      notify_success
+
+      render json: {message: "ok"}, status: :ok
+    end
+
+    def check
+      if request.headers["Authorization"] != Dato::Config.publish_key
+        render json: {message: "unauthorized"}, status: :unauthorized
+      end
+    end
+
+    private
+
+    def notify_success
+      if Dato::Config.build_triggger_id.present?
+        Thread.new do
+          sleep 5 # wait for the build to finish
+          uri = URI("https://webhooks.datocms.com/#{Dato::Config.build_triggger_id}/deploy-results")
+          req = Net::HTTP::Post.new(uri, "Content-Type" => "application/json")
+          req.body = {status: "success"}.to_json
+          Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
+        end
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -1,3 +1,4 @@
 Dato::Engine.routes.draw do
   get "live", to: "live#show"
+  post "publish", to: "publish#create"
 end

data/lib/dato/client.rb

@@ -1,10 +1,11 @@
 module Dato
   class Client < GQLi::Client
     def initialize(api_token = ENV["DATO_API_TOKEN"], validate_query: false, preview: false, live: false)
+      @api_token = api_token
       super(
         "https://graphql#{"-listen" if live}.datocms.com/#{"preview" if preview}",
         headers: {
-          "Authorization" => api_token
+          "Authorization" => @api_token
         },
         validate_query: validate_query && !live
       )
@@ -19,5 +20,14 @@ module Dato
       errors = parsed_response["errors"]
       GQLi::Response.new(parsed_response, errors, query)
     end
+
+    def search(query)
+      url = "https://site-api.datocms.com/search-results?query=#{query}&filter[build_trigger_id]=''"
+      response = HTTP.headers({
+        "Authorization" => "Bearer #{@api_token}",
+        "Accept" => "application/json",
+        "X-Api-Version" => 3
+      }).timeout(timeout_options).get(url)
+    end
   end
 end

data/lib/dato/config.rb

@@ -4,5 +4,9 @@ module Dato
 
     config_accessor(:overrides) { {} }
     config_accessor(:blocks) { {} }
+    config_accessor(:cache) { false }
+    config_accessor(:cache_namespace) { "dato-rails" }
+    config_accessor(:publish_key) { ENV["DATO_PUBLISH_KEY"] }
+    config_accessor(:build_triggger_id) { ENV["DATO_BUILD_TRIGGER_ID"] }
   end
 end

data/lib/dato/version.rb

@@ -1,3 +1,3 @@
 module Dato
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dato-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Alessandro Rodi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-04 00:00:00.000000000 Z
+date: 2023-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: view_component
   requirement: !ruby/object:Gem::Requirement
@@ -177,6 +205,7 @@ files:
 - app/components/dato/unknown_node.html.erb
 - app/components/dato/unknown_node.rb
 - app/controllers/dato/live_controller.rb
+- app/controllers/dato/publish_controller.rb
 - app/views/dato/live/show.html.erb
 - config/routes.rb
 - lib/dato.rb
@@ -191,7 +220,7 @@ licenses: []
 metadata:
   homepage_uri: https://github.com/renuo/dato-rails
   source_code_uri: https://github.com/renuo/dato-rails
-  changelog_uri: https://github.com/renuo/dato-rails/CHANGELOG.md
+  changelog_uri: https://github.com/renuo/dato-rails/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -207,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.10
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Use Dato CMS in your Rails application.