dato-rails 0.4.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48c76d182eea6b57c5a9fa7dc5731fd203ec11ab3fc6a263c6cd5cfbbed92520
-  data.tar.gz: c0109db369f7571f690448dbd4119104a887bfb3e28baa4c7f2481cac090baaf
+  metadata.gz: 749f20170663bb4bccf768abb34aa420530affa26573f9b5f86fe3b6aa69d169
+  data.tar.gz: d6125ac3828889b22f0c4434b765f5a2570c5200fa3e2aec8e44440bab2aa866
 SHA512:
-  metadata.gz: 90dee86a67536de6913bffe0d2ea41cc776b1b6ab5e884d392bfc2181fe0e73092cffc10398200e995d22dfe95b4c6eadff05618c2d696aa0ec960a4f7fe2d4e
-  data.tar.gz: d8a03730831b5a348e095b505bb10b170f36e0da4045417c508de4303579a741aa6bc6a419226aeafb49e18df0a1196d370eca63bd965f01550fffb2d554563c
+  metadata.gz: 15760b48a1ca878ac2ca1bedea696d2d55d6c144f1fa1ac614000806d4da9e5c45825252e6f8be074d9b4ae813ac67b3feb5a87c47ef9dfb91aba90ee38a5e4b
+  data.tar.gz: fcf53744435481c917eb80bdc8cddf5e6bc3fa507e1049b457dad62cda150405c8abbdc40d1e8656d89baeb2273b871f3442b1290809d7fbcf3994dc7d6e22c5

data/README.md

@@ -26,7 +26,7 @@ The gem is made of two parts:
 
 ## GraphQL client
 
-The GraphQL client based on [GQLi](https://github.com/contentful-labs/gqli.rb) allows to perform 
+The GraphQL client based on [GQLi](https://github.com/contentful-labs/gqli.rb) allows to perform
 queries to the GraphQL endpoint.
 Look at GQLi documentation for more information about the syntax of queries.
 You can also find some examples in specs of this library.
@@ -104,7 +104,7 @@ Dato::Config.overrides = {
 }.with_indifferent_access
 ```
 
-# Preview and live
+## Preview and live
 
 The `Dato::Client` supports both [preview](https://www.datocms.com/docs/pro-tips/how-to-manage-a-live-and-a-preview-site) and [live updates](https://www.datocms.com/docs/real-time-updates-api) features from Dato CMS.
 
@@ -134,6 +134,40 @@ render(Dato::Live.new(MyComponent, my_query, preview: true, live: true))
 
 and your component will come to life with live updates 🎉 (requires turbo).
 
+## CRUD Operations
+
+The library also provides a set of helpers to perform CRUD operations on Dato CMS.
+
+### All
+
+```ruby
+Dato::Client.new.items.all(item_type_id: '456')
+```
+
+### Find
+
+```ruby
+Dato::Client.new.items.find(item_id: '123')
+```
+
+### Create
+
+```ruby
+Dato::Client.new.items.create(attributes: { title: 'Hello world' }, item_type_id: '456')
+```
+
+### Update
+
+```ruby
+Dato::Client.new.items.update(attributes: { title: 'Hello world' }, item_id: '123')
+```
+
+### Destroy
+
+```ruby
+Dato::Client.new.items.destroy(item_id: '123')
+```
+
 ## Configuration
 
 The following options are available:
@@ -147,13 +181,13 @@ Dato::Config.configure do |config|
   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']
+  config.build_trigger_id = ENV['DATO_BUILD_TRIGGER_ID'] # default: ENV['DATO_BUILD_TRIGGER_ID']
 end
 ```
 
 ## Caching
 
-The library supports caching of the rendered components. 
+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.

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

@@ -16,11 +16,7 @@
 
   <%= turbo_frame_tag frame_id %>
 <% else %>
-  <% 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)) %>
+  <%= Dato::Cache.fetch(cache_key) do %>
+    <% render(component_klass.new(data)) %>
   <% end %>
 <% end %>

data/app/components/dato/live.rb

@@ -17,18 +17,10 @@ module Dato
       @live = live
     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

data/app/controllers/dato/publish_controller.rb

@@ -23,14 +23,16 @@ module Dato
     private
 
     def notify_success
-      if Dato::Config.build_triggger_id.present?
+      if Dato::Config.build_trigger_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")
+          uri = URI("https://webhooks.datocms.com/#{Dato::Config.build_trigger_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
+      else
+        Rails.logger.info "Dato::Config.build_trigger_id is not set, skipping notification."
       end
     end
   end

data/lib/dato/cache.rb

@@ -0,0 +1,25 @@
+module Dato
+  class Cache
+    def self.fetch(cache_key, &block)
+      if active?
+        Rails.cache.fetch(cache_key, expires_in: expires_in, namespace: namespace) do
+          block.call
+        end
+      else
+        block.call
+      end
+    end
+
+    def self.active?
+      Dato::Config.cache.present?
+    end
+
+    def self.expires_in
+      Dato::Config.cache.is_a?(Integer) ? Dato::Config.cache : 60.minutes
+    end
+
+    def self.namespace
+      Dato::Config.cache_namespace
+    end
+  end
+end

data/lib/dato/client.rb

@@ -1,33 +1,13 @@
 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
-        },
-        validate_query: validate_query && !live
-      )
-    end
-
-    def live!(query)
-      http_response = request.post(@url, params: @params, json: {query: query.to_gql})
-
-      fail "Error: #{http_response.reason}\nBody: #{http_response.body}" if http_response.status >= 300
+  class Client
+    delegate :live!, to: :@gql_client
+    delegate :execute!, to: :@gql_client
+    attr_reader :items
 
-      parsed_response = JSON.parse(http_response.to_s)
-      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)
+    def initialize(api_token = Dato::Config.api_token, validate_query: false, preview: false, live: false)
+      @api_token = api_token
+      @gql_client = Dato::Gql.new(api_token, validate_query, preview, live)
+      @items = Dato::Items.new(api_token)
     end
   end
 end

data/lib/dato/config.rb

@@ -6,7 +6,8 @@ module Dato
     config_accessor(:blocks) { {} }
     config_accessor(:cache) { false }
     config_accessor(:cache_namespace) { "dato-rails" }
+    config_accessor(:api_token) { ENV["DATO_API_TOKEN"] }
     config_accessor(:publish_key) { ENV["DATO_PUBLISH_KEY"] }
-    config_accessor(:build_triggger_id) { ENV["DATO_BUILD_TRIGGER_ID"] }
+    config_accessor(:build_trigger_id) { ENV["DATO_BUILD_TRIGGER_ID"] }
   end
 end

data/lib/dato/gql.rb

@@ -0,0 +1,24 @@
+module Dato
+  class Gql < GQLi::Client
+    def initialize(api_token, validate_query, preview, live)
+      @api_token = api_token
+      super(
+        "https://graphql#{"-listen" if live}.datocms.com/#{"preview" if preview}",
+        headers: {
+          "Authorization" => @api_token
+        },
+        validate_query: validate_query && !live
+      )
+    end
+
+    def live!(query)
+      http_response = request.post(@url, params: @params, json: {query: query.to_gql})
+
+      fail "Error: #{http_response.reason}\nBody: #{http_response.body}" if http_response.status >= 300
+
+      parsed_response = JSON.parse(http_response.to_s)
+      errors = parsed_response["errors"]
+      GQLi::Response.new(parsed_response, errors, query)
+    end
+  end
+end

data/lib/dato/items.rb

@@ -0,0 +1,46 @@
+module Dato
+  class Items
+    BASE_ITEM_URL = "https://site-api.datocms.com/items"
+
+    def initialize(api_token)
+      @http_headers = HTTP.headers({"Authorization" => "Bearer #{api_token}",
+                                     "Accept" => "application/json",
+                                     "X-Api-Version" => 3})
+    end
+
+    def find(item_id:)
+      @http_headers.get("#{BASE_ITEM_URL}/#{item_id}")
+    end
+
+    def all(item_type_id:)
+      @http_headers.get("#{BASE_ITEM_URL}?filter[type]=#{item_type_id}")
+    end
+
+    def create(item_type_id:, attributes:, meta: nil)
+      data = create_attributes(attributes, item_type_id)
+      data[:meta] = meta if meta
+      @http_headers.post(BASE_ITEM_URL, json: {data: data})
+    end
+
+    def update(attributes:, item_id:)
+      data = {type: "item", attributes: attributes, id: item_id}
+      @http_headers.put("#{BASE_ITEM_URL}/#{item_id}", json: {data: data})
+    end
+
+    def destroy(item_id:)
+      @http_headers.delete("#{BASE_ITEM_URL}/#{item_id}")
+    end
+
+    private
+
+    def create_attributes(attributes, item_type_id)
+      {
+        type: "item",
+        attributes: attributes,
+        relationships: {
+          item_type: {data: {type: "item_type", id: item_type_id}}
+        }
+      }
+    end
+  end
+end

data/lib/dato/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dato-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Alessandro Rodi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-14 00:00:00.000000000 Z
+date: 2023-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
@@ -209,10 +209,13 @@ files:
 - app/views/dato/live/show.html.erb
 - config/routes.rb
 - lib/dato.rb
+- lib/dato/cache.rb
 - lib/dato/client.rb
 - lib/dato/config.rb
 - lib/dato/engine.rb
 - lib/dato/fragments/responsive_image.rb
+- lib/dato/gql.rb
+- lib/dato/items.rb
 - lib/dato/version.rb
 - lib/tasks/dato/rails_tasks.rake
 homepage: https://github.com/renuo/dato-rails