dato-rails 0.7.1 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7753883f681ceec3735a3ada67751e4ef59256775f99ddc4916c469e42119d83
-  data.tar.gz: 721f2b1c13b67796a74626bb9844b9d07aa6b0911f068e926fa1154cb4a76960
+  metadata.gz: cd0388aa8f2f5230feb9b58e501d0d2b32d9a276eccf4029864061ea4fb42745
+  data.tar.gz: c084383123cfa44fe5834c8eb61e247d8b5482f4ce983bd9f712044e36fe1f5e
 SHA512:
-  metadata.gz: 24b79eac4a15ca805d42151faa392f4174cdb53ccd5a9f253021d6f37c80736ace8a14ce04331e22acdaeb855abe39d99a7b3702fee140d49c6d586448d10791
-  data.tar.gz: fcf8912566cc3a242290a53b82e8337fe3306a7d6aea2073caba9ed8027923424ab173048974abdbd799f5843bb095711ada2ab415f6956e80a54ab479105e26
+  metadata.gz: 6cde762f15270f855bc106c523e6d428fca9763005b380177852fa990627ccd35445ba6abe8913d76f9899f6c7a30a132a829ef6ac00be2bda9d672faff99299
+  data.tar.gz: e54d6ac310cc81b0c62f65470e4a2c9ab0333e7ff71e9ca652a83f0ee1e3b9699c4889140cf3a6f8aaae421a3785433deb4eed48b01878ff9cfc5973afb7bbbd

data/README.md

@@ -168,6 +168,44 @@ Dato::Client.new.items.update(attributes: { title: 'Hello world' }, item_id: '12
 Dato::Client.new.items.destroy(item_id: '123')
 ```
 
+## File upload
+
+Dato Rails also supports file uploads. 
+These can be created either from a local file or from a url. 
+Basically all file types are supported, as long as they are valid in the CMS.
+
+> In addition to the binary file, also attributes and metadata can be uploaded. 
+Both metadata and attributes are optional.
+> Provide attributes according to the [docs](https://www.datocms.com/docs/content-management-api/resources/upload)
+
+### Upload from Url
+```ruby
+Dato::Client.new.uploads.create_from_url('https://picsum.photos/seed/picsum/200/300')
+Dato::Client.new.uploads.create_from_url('https://picsum.photos/seed/picsum/200/300', attributes:)
+```
+
+### Upload from Local File
+```ruby
+file = File.open('image.png')
+
+Dato::Client.new.uploads.create_from_file(file.path)
+Dato::Client.new.uploads.create_from_file(file.path, attributes:)
+```
+
+### Optional: Attributes and metadata
+
+```ruby
+meta = { en: { title: 'Static Random Image', alt: 'some caption text' } }
+attributes = { author: 'Dato Rails', default_field_metadata: meta }
+```
+
+### Optional: Filename
+```ruby
+Dato::Client.new.uploads.create_from_url('https://picsum.photos/seed/picsum/200/300', filename: 'test.png')
+Dato::Client.new.uploads.create_from_file(file.path, filename: 'test.png')
+
+```
+
 ## Configuration
 
 The following options are available:
@@ -232,7 +270,7 @@ You can take advantage of the publish mechanism of Dato CMS to expire the cache.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. 
+After checking out the repo, run `bundle install` to install dependencies. 
 
 You can now clone the dato-rails project
 
@@ -245,7 +283,7 @@ to consume data from your project.
 
 Then, run `bundle exec rspec` to run the tests. 
 
-You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+You can also run `rails console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. 
 To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, 

data/Rakefile

@@ -1,6 +1,6 @@
 require "bundler/setup"
 
-APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
 load "rails/tasks/engine.rake"
 
 load "rails/tasks/statistics.rake"

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

@@ -1,9 +1,11 @@
-<%= content_tag generated_tag, class: "dato-cms-#{@node.type}" do %>
-  <% @node.children&.each do |node| %>
-    <%= render_node(node) %>
+<figure class="dato-cms-figure">
+  <%= content_tag generated_tag, class: "dato-cms-#{@node.type}" do %>
+    <% @node.children&.each do |node| %>
+      <%= render_node(node) %>
+    <% end %>
   <% end %>
-<% end %>
 
-<p class="dato-cms-attribution">
-  <%= @node.attribution %>
-</p>
+  <figcaption class="dato-cms-attribution">
+    <%= @node.attribution %>
+  </figcaption>
+</figure>

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

@@ -1,6 +1,6 @@
-<%= content_tag generated_tag, class: "dato-cms-#{@node.type}" do %>
-  <%= @node.value %>
-  <% @node.children&.each do |node| %>
-    <%= render_node(node) %>
-  <% end %>
-<% end %>
+<%= content_tag generated_tag, class: "dato-cms-#{@node.type}" do -%>
+<%= @node.value -%>
+<% @node.children&.each do |node| -%>
+<%= render_node(node) -%>
+<% end -%>
+<% end -%>

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

@@ -1,5 +1,5 @@
-<a href="<%=@node.url %>" class="dato-cms-<%=@node.type %>">
-  <% @node.children&.each do |node| %>
-    <%= render_node(node) %>
-  <% end %>
-</a>
+<%= tag.a(**link_attributes) do -%>
+  <% @node.children&.each do |node| -%>
+<%= render_node(node) -%>
+  <% end -%>
+<% end -%>

data/app/components/dato/link.rb

@@ -8,4 +8,19 @@ class Dato::Link < Dato::DastNode
   def generated_tag
     "a"
   end
+
+  def link_attributes
+    attr = {
+      "href" => @node.url,
+      "class" => "dato-cms-#{@node.type}",
+    }
+    %w[rel target].each { |type| attr[type] = extract_meta(type) }
+    attr
+  end
+
+  private
+
+  def extract_meta(type)
+    @node.meta&.find { |m| m.id == type }&.value
+  end
 end

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

@@ -1,5 +1,5 @@
-<%= conditional_tag 'code', code_span?, class: "dato-cms-span-wrapper" do %>
-  <%= content_tag 'span', class: "dato-cms-span", style: styles do %>
-    <%= @node.value %>
-  <% end %>
-<% end %>
+<%= conditional_tag 'code', code_span?, class: "dato-cms-span-wrapper" do -%>
+<%= content_tag 'span', class: "dato-cms-span", style: styles do -%>
+<%= @node.value -%>
+<% end -%>
+<% end -%>

data/lib/dato/client.rb

@@ -1,12 +1,13 @@
 module Dato
   class Client
     delegate :live!, :execute!, :execute, to: :@gql
-    attr_reader :items, :gql
+    attr_reader :items, :uploads, :gql
 
     def initialize(api_token = Dato::Config.api_token, validate_query: false, preview: false, live: false)
       @api_token = api_token
       @gql = Dato::Gql.new(api_token, validate_query, preview, live)
       @items = Dato::Items.new(api_token)
+      @uploads = Dato::Uploads.new(api_token)
     end
   end
 end

data/lib/dato/uploads.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Dato
+  class Uploads
+    BASE_ITEM_URL = "https://site-api.datocms.com/upload-requests"
+
+    def initialize(api_token)
+      @auth_header = "Bearer #{api_token}"
+
+      headers = {
+        "Authorization" => @auth_header,
+        "Accept" => "application/json",
+        "X-Api-Version" => 3
+      }
+      @http_headers = HTTP.headers(headers)
+    end
+
+    def create_from_url(url, filename: nil, attributes: nil, meta: nil)
+      file = download_file_from_url(url)
+      result = create_from_file(file.path, filename:, attributes:, meta:)
+      file.delete
+
+      result
+    end
+
+    def create_from_file(path_to_file, filename: nil, attributes: nil, meta: nil)
+      request = request_file_upload_permission(filename || path_to_file)
+      upload_url = request[:url]
+      upload_id = request[:id]
+
+      upload_file_to_bucket(url: upload_url, path: path_to_file)
+
+      job_id = upload_file_to_dato(upload_id:, attributes:)
+      upload_id = retrieve_job_result(job_id).parse["data"]["attributes"]["payload"]["data"]["id"]
+
+      {upload_id:}
+    end
+
+    def retrieve_job_result(job_id)
+      headers = {
+        "X-Api-Version" => 3,
+        "Authorization" => @auth_header,
+        "Accept" => "application/json",
+        "Content-Type" => "application/vnd.api+json"
+      }
+
+      headers = HTTP.headers(headers)
+
+      headers.get("https://site-api.datocms.com/job-results/#{job_id}")
+    end
+
+    private
+
+    def download_file_from_url(url)
+      uri = URI.parse(url)
+      file_type = File.extname(uri.path)
+      file_contents = Net::HTTP.get(uri)
+      temp_file = Tempfile.new(["downloaded_file", file_type])
+      temp_file.binmode
+      temp_file.write(file_contents)
+      temp_file.rewind
+      temp_file.close
+
+      temp_file
+    end
+
+    def request_file_upload_permission(filename)
+      data = {
+        type: "upload_request",
+        attributes: {filename:}
+      }
+
+      response = @http_headers.post(BASE_ITEM_URL, json: {data:})
+      response = response.parse["data"]
+
+      {
+        url: response["attributes"]["url"],
+        id: response["id"]
+      }
+    end
+
+    def upload_file_to_bucket(url:, path:)
+      s3_headers = HTTP.headers({"Content-Type" => MimeMagic.by_magic(File.open(path))&.type || "application/octet-stream"})
+      s3_headers.put(url, body: File.read(path))
+    end
+
+    def upload_file_to_dato(upload_id:, attributes: nil)
+      attributes ||= {}
+
+      headers = {
+        "Content-Type" => "application/vnd.api+json",
+        "X-Api-Version" => 3,
+        "Authorization" => @auth_header,
+        "Accept" => "application/json"
+      }
+      headers = HTTP.headers(headers)
+
+      data = {
+        type: "upload",
+        attributes: {
+          path: upload_id,
+          **attributes
+        }
+      }
+
+      response = headers.post("https://site-api.datocms.com/uploads", json: {data:})
+
+      response.parse["data"]["id"]
+    end
+  end
+end

data/lib/dato/version.rb

@@ -1,3 +1,3 @@
 module Dato
-  VERSION = "0.7.1"
+  VERSION = "0.7.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dato-rails
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.4
 platform: ruby
 authors:
 - Alessandro Rodi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-02 00:00:00.000000000 Z
+date: 2023-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
@@ -216,6 +216,7 @@ files:
 - lib/dato/fragments/responsive_image.rb
 - lib/dato/gql.rb
 - lib/dato/items.rb
+- lib/dato/uploads.rb
 - lib/dato/version.rb
 - lib/tasks/dato/rails_tasks.rake
 homepage: https://github.com/renuo/dato-rails
@@ -239,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Use Dato CMS in your Rails application.