dato 0.7.8 → 0.7.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c290af75b0de6f8cd9b187448294b82d731b17d31d4443b1f40b5349fdb9c618
-  data.tar.gz: c127cf9869c434dce38bb77ba81895bf5ef351bee5a9b0edc9ef2d0fec510753
+  metadata.gz: 7779edc00921c84e0f98aee2008bb8fd3f89d893c02107d965db12d1f5bc7882
+  data.tar.gz: 25ba5f84f8a6236c40d2846ef976987501f4977d481c9c445e298b666bc6b1ec
 SHA512:
-  metadata.gz: d5552912880af2435a664eed763cb18e858b8653dae00f85f5915b0c7245225454538fe8da7e08e14d6e2fd7e460ed67e4770d1053df78c146060009aee0dfa5
-  data.tar.gz: 830e413829504a1ae8fc076fc3cb7a9a6b5e60dd9652df2121dca94eaa5a4e3cf68f498796411e09bda3be862ab0515a750c3a97c723a49a0a75422cce6c0c88
+  metadata.gz: 955b67a6fadad2fb96e1342ec2e8907f5084085e0f18737655ebac56a4a8661e5d670ff9e662b3afc21381636139480f86ae48d47f268b571a21fcfa470de8c2
+  data.tar.gz: 479fe2e231a44cdf9518961c98bfddbd67ac06d4cd511e37a7369d668e5f0fa4eeca195d8af09bd981277a5c195f01d5f368f6b134562ebdd8f43df0c47a8c91

data/CHANGELOG.md

@@ -1,3 +1,50 @@
+# 0.7.13
+
+Add option to pass a project's environment:
+
+```ruby
+require "dato"
+client = Dato::Site::Client.new("YOUR-API-KEY", environment: 'sandbox-foobar')
+```
+
+# 0.7.12
+
+Introduces `Dato::Utils::BuildModularBlock` class to help creating modular blocks.
+
+An example usage can be:
+
+```ruby
+description = [
+  Dato::Utils::BuildModularBlock.build(
+    item_type: "1235",
+    name: "Best dog in the world",
+    year: "2020",
+    picture: picture
+  )
+]
+
+record = client.items.create(
+  item_type: "1234", # model ID
+  name: "Gigio",
+  description: description
+)
+```
+
+Find more info [on the documentation](https://www.datocms.com/docs/content-management-api/resources/item/create).
+
+# 0.7.11 (not released)
+
+* Updated specs cassettes after `appeareance -> appearance` typo fix
+* Some style changes
+
+# 0.7.10
+
+* Fixed SEO title retrieval. Now it fallbacks to default SEO title is item title is blank
+
+# 0.7.9
+
+* Added new attributes to uploads
+
 # 0.7.0
 
 * Real-time events are now much more granular and the gem avoids downloading all the content every time a change occurs

data/Rakefile

@@ -3,5 +3,8 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "-b"
+end
+
 task default: :spec

data/dato.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'front_matter_parser'
 
   spec.add_runtime_dependency 'faraday', ['>= 0.9.0']
@@ -37,7 +38,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'activesupport', ['>= 4.2.7']
   spec.add_runtime_dependency 'addressable'
   spec.add_runtime_dependency 'thor'
-  spec.add_runtime_dependency 'imgix', ['>= 0.3.1']
+  spec.add_runtime_dependency 'imgix', ['~> 4']
   spec.add_runtime_dependency 'toml'
   spec.add_runtime_dependency 'cacert'
   spec.add_runtime_dependency 'dotenv'

data/lib/dato.rb

@@ -8,6 +8,7 @@ require 'dato/local/site'
 require 'dato/cli'
 require 'dato/utils/seo_tags_builder'
 require 'dato/utils/favicon_tags_builder'
+require 'dato/utils/build_modular_block'
 
 module Dato
 end

data/lib/dato/api_client.rb

@@ -20,7 +20,7 @@ module Dato
       base.extend ClassMethods
 
       base.class_eval do
-        attr_reader :token, :base_url, :schema, :extra_headers
+        attr_reader :token, :environment, :base_url, :schema, :extra_headers
       end
     end
 
@@ -29,27 +29,28 @@ module Dato
         define_method(:initialize) do |token, options = {}|
           @token = token
           @base_url = options[:base_url] || "https://#{subdomain}.datocms.com"
+          @environment = options[:environment]
           @extra_headers = options[:extra_headers] || {}
         end
 
+        # FOR DEV
+        # "http://#{subdomain}.lvh.me:3001/docs/#{subdomain}-hyperschema.json"
         response = Faraday.get(
-          # FOR DEV
-          # "http://#{subdomain}.lvh.me:3001/docs/#{subdomain}-hyperschema.json"
           "https://#{subdomain}.datocms.com/docs/#{subdomain}-hyperschema.json"
         )
 
         schema = JsonSchema.parse!(JSON.parse(response.body))
         schema.expand_references!
 
-        schema.definitions.each do |type, schema|
-          is_collection = schema.links.select { |x| x.rel === 'instances' }.any?
+        schema.definitions.each do |type, obj|
+          is_collection = obj.links.select { |x| x.rel == 'instances' }.any?
           namespace = is_collection ? type.pluralize : type
 
           define_method(namespace) do
             instance_variable_set(
               "@#{namespace}",
               instance_variable_get("@#{namespace}") ||
-              Dato::Repo.new(self, type, schema)
+              Dato::Repo.new(self, type, obj)
             )
           end
         end
@@ -76,16 +77,10 @@ module Dato
       method, absolute_path, body, params = args
 
       response = connection.send(method, absolute_path, body) do |c|
-        if params
-          c.params = params
-        end
+        c.params = params if params
       end
 
-      if response.body.is_a?(Hash)
-        response.body.with_indifferent_access
-      else
-        nil
-      end
+      response.body.with_indifferent_access if response.body.is_a?(Hash)
     rescue Faraday::SSLError => e
       raise e if ENV['SSL_CERT_FILE'] == Cacert.pem
 
@@ -101,14 +96,15 @@ module Dato
         sleep(to_wait + 1)
         request(*args)
       elsif e.response[:status] == 422 && batch_data_validation?(e.response)
-        puts "Validating items, waiting 1 second and retrying..."
+        puts 'Validating items, waiting 1 second and retrying...'
         sleep(1)
         request(*args)
       else
+        # puts body.inspect
+        # puts '===='
+        # puts error.message
+        # puts '===='
         error = ApiError.new(e.response)
-        puts "===="
-        puts error.message
-        puts "===="
         raise error
       end
     end
@@ -123,12 +119,12 @@ module Dato
              end
 
       return false unless body
-      return false unless body["data"]
+      return false unless body['data']
 
-      body["data"].any? do |e|
-        e["attributes"]["code"] == "BATCH_DATA_VALIDATION_IN_PROGRESS"
+      body['data'].any? do |e|
+        e['attributes']['code'] == 'BATCH_DATA_VALIDATION_IN_PROGRESS'
       end
-    rescue
+    rescue StandardError
       false
     end
 
@@ -141,9 +137,13 @@ module Dato
         'X-Api-Version' => '3'
       }
 
+      if environment
+        default_headers.merge!('X-Environment' => environment)
+      end
+
       options = {
         url: base_url,
-        headers: default_headers.merge(extra_headers),
+        headers: default_headers.merge(extra_headers)
       }
 
       @connection ||= Faraday.new(options) do |c|

data/lib/dato/cli.rb

@@ -11,8 +11,10 @@ module Dato
     desc 'dump', 'dumps DatoCMS content into local files'
     option :config, default: 'dato.config.rb'
     option :token, default: ENV['DATO_API_TOKEN'], required: true
+    option :environment, type: :string, required: false
     option :preview, default: false, type: :boolean
     option :watch, default: false, type: :boolean
+
     def dump
       config_file = File.expand_path(options[:config])
       watch_mode = options[:watch]
@@ -20,6 +22,7 @@ module Dato
 
       client = Dato::Site::Client.new(
         options[:token],
+        environment: options[:environment],
         extra_headers: {
           'X-Reason' => 'dump',
           'X-SSG' => Dump::SsgDetector.new(Dir.pwd).detect

data/lib/dato/json_api_serializer.rb

@@ -23,8 +23,10 @@ module Dato
       data[:type] = type
       data[:attributes] = serialized_attributes(resource)
 
-      if relationships.any?
-        data[:relationships] = serialized_relationships(resource)
+      serialized_relationships = serialized_relationships(resource)
+
+      if serialized_relationships
+        data[:relationships] = serialized_relationships
       end
 
       { data: data }
@@ -82,7 +84,7 @@ module Dato
         end
       end
 
-      result
+      result.empty? ? nil : result
     end
 
     def attributes(resource)
@@ -110,7 +112,11 @@ module Dato
     end
 
     def required_relationships
-      (link_relationships.required || []).map(&:to_sym)
+      if link.schema.properties['data'].required.include?("relationships")
+        (link_relationships.required || []).map(&:to_sym)
+      else
+        []
+      end
     end
 
     def link_attributes

data/lib/dato/local/field_type/file.rb

@@ -18,6 +18,7 @@ module Dato
                 v[:alt],
                 v[:title],
                 v[:custom_data],
+                v[:focal_point],
                 repo.site.entity.imgix_host
               )
             end
@@ -29,12 +30,14 @@ module Dato
           alt,
           title,
           custom_data,
+          focal_point,
           imgix_host
         )
           @upload = upload
           @alt = alt
           @title = title
           @custom_data = custom_data
+          @focal_point = focal_point
           @imgix_host = imgix_host
         end
 
@@ -74,31 +77,184 @@ module Dato
           @upload.copyright
         end
 
+        def filename
+          @upload.filename
+        end
+
+        def basename
+          @upload.basename
+        end
+
         def alt
-          default_metadata = @upload.default_field_metadata.deep_stringify_keys.fetch(I18n.locale.to_s, {})
-          @alt || default_metadata["alt"]
+          default_metadata = @upload.default_field_metadata.deep_stringify_keys
+                                    .fetch(I18n.locale.to_s, {})
+          @alt || default_metadata['alt']
         end
 
         def title
-          default_metadata = @upload.default_field_metadata.deep_stringify_keys.fetch(I18n.locale.to_s, {})
-          @title || default_metadata["title"]
+          default_metadata = @upload.default_field_metadata.deep_stringify_keys
+                                    .fetch(I18n.locale.to_s, {})
+          @title || default_metadata['title']
         end
 
         def custom_data
-          default_metadata = @upload.default_field_metadata.deep_stringify_keys.fetch(I18n.locale.to_s, {})
-          @custom_data.merge(default_metadata.fetch("custom_data", {}))
+          default_metadata = @upload.default_field_metadata.deep_stringify_keys
+                                    .fetch(I18n.locale.to_s, {})
+          @custom_data.merge(default_metadata.fetch('custom_data', {}))
+        end
+
+        def focal_point
+          default_metadata = @upload.default_field_metadata.deep_stringify_keys
+                                    .fetch(I18n.locale.to_s, {})
+          @focal_point || default_metadata['focal_point']
+        end
+
+        def tags
+          @upload.tags
+        end
+
+        def smart_tags
+          @upload.smart_tags
+        end
+
+        def is_image
+          @upload.is_image
+        end
+
+        def exif_info
+          @upload.exif_info
+        end
+
+        def mime_type
+          @upload.mime_type
+        end
+
+        def colors
+          @upload.colors.map { |color| Color.parse(color, nil) }
+        end
+
+        def blurhash
+          @upload.blurhash
+        end
+
+        class VideoAttributes
+          def initialize(upload)
+            @upload = upload
+          end
+
+          def mux_playback_id
+            @upload.mux_playback_id
+          end
+
+          def frame_rate
+            @upload.frame_rate
+          end
+
+          def duration
+            @upload.duration
+          end
+
+          def streaming_url
+            "https://stream.mux.com/#{@upload.mux_playback_id}.m3u8"
+          end
+
+          def thumbnail_url(format = :jpg)
+            if format == :gif
+              "https://image.mux.com/#{@upload.mux_playback_id}/animated.gif"
+            else
+              "https://image.mux.com/#{@upload.mux_playback_id}/thumbnail.#{format}"
+            end
+          end
+
+          def mp4_url(options = nil)
+            @upload.mux_mp4_highest_res or
+              return nil
+
+            if options && options[:exact_res]
+              if options[:exact_res] == :low
+                raw_mp4_url("low")
+              elsif options[:exact_res] == :medium
+                if %w[medium high].include?(@upload.mux_mp4_highest_res)
+                  raw_mp4_url("medium")
+                end
+              elsif @upload.mux_mp4_highest_res == :high
+                raw_mp4_url("high")
+              end
+            elsif options && options[:res] == :low
+              raw_mp4_url("low")
+            elsif options && options[:res] == :medium
+              if %w[low medium].include?(@upload.mux_mp4_highest_res)
+                raw_mp4_url(@upload.mux_mp4_highest_res)
+              else
+                raw_mp4_url("medium")
+              end
+            else
+              raw_mp4_url(@upload.mux_mp4_highest_res)
+            end
+          end
+
+          def to_hash
+            {
+              mux_playback_id: mux_playback_id,
+              frame_rate: frame_rate,
+              duration: duration,
+              streaming_url: streaming_url,
+              thumbnail_url: thumbnail_url,
+              mp4_url: mp4_url,
+            }
+          end
+
+          private
+
+          def raw_mp4_url(res)
+            "https://stream.mux.com/#{@upload.mux_playback_id}/#{res}.mp4"
+          end
+        end
+
+        def video
+          if @upload.mux_playback_id
+            VideoAttributes.new(@upload)
+          end
         end
 
         def file
           Imgix::Client.new(
-            host: @imgix_host,
+            domain: @imgix_host,
             secure: true,
             include_library_param: false
           ).path(path)
         end
 
-        def url(opts = {})
-          file.to_url(opts)
+        def url(query = {})
+          query.deep_stringify_keys!
+
+          if focal_point &&
+            query["fit"] == "crop" &&
+            (query["h"] || query["height"]) &&
+            (query["w"] || query["width"]) &&
+            [nil, "focalpoint"].include?(query["crop"]) &&
+            query["fp-x"].nil? &&
+            query["fp-y"].nil?
+
+            query.merge!(
+              "crop" => "focalpoint",
+              "fp-x" => focal_point[:x],
+              "fp-y" => focal_point[:y],
+            )
+          end
+
+          file.to_url(query)
+        end
+
+        def lqip_data_url(opts = {})
+          @imgix_host != "www.datocms-assets.com" and
+            raise "#lqip_data_url can only be used with www.datocms-assets.com domain"
+
+          response = Faraday.get(file.to_url(opts.merge(lqip: "blurhash")))
+
+          if response.status == 200
+            "data:image/jpeg;base64,#{Base64.strict_encode64(response.body)}"
+          end
         end
 
         def to_hash(*_args)
@@ -111,7 +267,19 @@ module Dato
             alt: alt,
             title: title,
             custom_data: custom_data,
-            url: url
+            focal_point: focal_point,
+            url: url,
+            copyright: copyright,
+            tags: tags,
+            smart_tags: smart_tags,
+            filename: filename,
+            basename: basename,
+            is_image: is_image,
+            exif_info: exif_info,
+            mime_type: mime_type,
+            colors: colors.map(&:to_hash),
+            blurhash: blurhash,
+            video: video && video.to_hash
           }
         end
       end

data/lib/dato/local/field_type/upload_id.rb

@@ -43,7 +43,7 @@ module Dato
 
         def file
           Imgix::Client.new(
-            host: @imgix_host,
+            domain: @imgix_host,
             secure: true,
             include_library_param: false
           ).path(path)

data/lib/dato/local/loader.rb

@@ -43,7 +43,13 @@ module Dato
 
         return if pusher && pusher.connected
 
-        pusher.subscribe("private-site-#{site_id}")
+        channel_name = if client.environment
+                         "private-site-#{site_id}-environment-#{environment}"
+                       else
+                         "private-site-#{site_id}"
+                       end
+
+        pusher.subscribe(channel_name)
 
         bind_on_site_upsert(&block)
         bind_on_item_destroy(&block)
@@ -66,7 +72,8 @@ module Dato
         bind_on("site:upsert", block) do |data|
           threads = [
             Thread.new { Thread.current[:output] = site },
-            Thread.new { Thread.current[:output] = all_items }
+            Thread.new { Thread.current[:output] = all_items },
+            Thread.new { Thread.current[:output] = all_uploads }
           ]
 
           results = threads.map do |t|

data/lib/dato/upload/create_upload_path.rb

@@ -72,7 +72,7 @@ module Dato
         end
         connection.get(url).body
       rescue Faraday::Error => e
-        puts "Error during uploading #{url}"
+        puts "Error during upload of #{url}: #{e.message}"
         raise e
       end
     end

data/lib/dato/utils/build_modular_block.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'dato/json_api_serializer'
+
+module Dato
+  module Utils
+    module BuildModularBlock
+      def self.build(unserialized_body)
+        json_api_serializer = JsonApiSerializer.new('item', nil)
+        attributes = json_api_serializer.serialized_attributes(unserialized_body)
+
+        payload = {
+          type: 'item',
+          attributes: attributes,
+          relationships: {
+            item_type: {
+              data: {
+                id: unserialized_body[:item_type],
+                type: 'item_type',
+              },
+            },
+          },
+        }
+
+        payload[:id] = unserialized_body[:id] if unserialized_body[:id]
+
+        payload
+      end
+    end
+  end
+end

data/lib/dato/utils/meta_tags/base.rb

@@ -28,7 +28,7 @@ module Dato
           fallback_seo_value = fallback_seo &&
                                fallback_seo.send(attribute)
 
-          item_seo_value || alternative || fallback_seo_value
+          item_seo_value.presence || alternative.presence || fallback_seo_value
         end
 
         def tag(tag_name, attributes)

data/lib/dato/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dato
-  VERSION = '0.7.8'
+  VERSION = '0.7.15'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dato
 version: !ruby/object:Gem::Version
-  version: 0.7.8
+  version: 0.7.15
 platform: ruby
 authors:
 - Stefano Verna
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-10-30 00:00:00.000000000 Z
+date: 2020-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: front_matter_parser
   requirement: !ruby/object:Gem::Requirement
@@ -238,16 +252,16 @@ dependencies:
   name: imgix
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: toml
   requirement: !ruby/object:Gem::Requirement
@@ -429,6 +443,7 @@ files:
 - lib/dato/upload/create_upload_path.rb
 - lib/dato/upload/file.rb
 - lib/dato/upload/image.rb
+- lib/dato/utils/build_modular_block.rb
 - lib/dato/utils/favicon_tags_builder.rb
 - lib/dato/utils/locale_value.rb
 - lib/dato/utils/meta_tags/article_modified_time.rb
@@ -449,7 +464,7 @@ homepage: https://github.com/datocms/ruby-datocms-client
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -464,9 +479,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 2.7.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Ruby client for DatoCMS API
 test_files: []