dato-rails 0.7.3 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e08eaabd558518c83178db908c5d4c0e7829f5d28241b05a9eb3c9ea3449d84d
-  data.tar.gz: 22173dc5421c8c1fbd2fc3b844eebdfcc1876dbfd04f9c04c573878ca1694efe
+  metadata.gz: 7d61ca3870d999b82aed6ff238182a3a6fd4b294f87c608b1b9c4ee9425d97ad
+  data.tar.gz: 3032c72e0226946239830f8c5aaeb1a5f0640328aa349a269c1f156d9b40f6b8
 SHA512:
-  metadata.gz: e0109bd3b767231c28917403f0ca96e9a207dbc9fb593cb6a41c83dc853c33ef58018a5a8cd643382c38ed7f85c8c5a817d3f4cb6d73570f1434fd5ec49fdcaa
-  data.tar.gz: 5c6b4b06e93b9a79379c7e70fecb578518090047aeb8afa869e08c39275842f158503ff4ed4906d06cccdf144947168d0310d28247b4f626bc4bcadc019ad315
+  metadata.gz: 7733a018553585d7f51a8d85920932dabe04944581772d84c6e9bea5d9c8ec6107e0269c6b0832da4028533128d95c0fa91e409b17a4a1d4acf429ae9c5e1591
+  data.tar.gz: c705f72bf8f0ed731ff656459b0ef0e5adc4c0a351a79b250f4db55eb0835f6e17df8adb5e9e9a01f6420704c78c92972f894fc06935169795462b142b3a2a70

data/README.md

@@ -168,6 +168,55 @@ 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.
+Be aware that dato jobs are not synchronous, so you may need to 
+implement some kind of polling to check if the upload is finished.
+The create method returns a job id, which can be used to retrieve the upload result.
+
+> 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')
+```
+
+
+### Getting the upload id
+As the file upload is asynchronous, you may need to implement some kind of polling to check if the upload is finished. 
+With the retrieve_job_result method you can retrieve the upload id from the job result.
+```ruby
+job_id = client.uploads.create_from_file(file.path) # get back a job id
+response = client.uploads.retrieve_job_result(job_id).parse # check the status
+upload_id = response.dig('data', 'attributes', 'payload', 'data', 'id') # if nil, it's not done yet
+```
 ## Configuration
 
 The following options are available:
@@ -241,7 +290,8 @@ You can now clone the dato-rails project
 
 
 You then need to set a `DATO_API_TOKEN=abcd123x` in the `.env` file on the root of your project
-to consume data from your project.
+to consume data from your project. For testing purposes, set `TEST_MODEL_TYPE_ID=1234` in the `.env` file
+with the id of the author model type in your project.
 
 Then, run `bundle exec rspec` to run the tests. 
 

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,108 @@
+# 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)
+
+      upload_file_to_dato(upload_id:, attributes:)
+    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.3"
+  VERSION = "0.7.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dato-rails
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.5
 platform: ruby
 authors:
 - Alessandro Rodi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-14 00:00:00.000000000 Z
+date: 2023-08-23 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.10
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Use Dato CMS in your Rails application.