dato 0.7.9 → 0.7.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2faaeda3b7c9f1317aeaa5291274cd1e66f7ec352f45f4513ca3e44747d6d816
-  data.tar.gz: 4a8afc49f92605e0c1bcbdd5473d07bbc83f34d7f71e20cf44414489eaa48504
+  metadata.gz: 5497d73f33b5f38e2f931d32bba7fa6362d5069d0b8fa5cf3b85326f339ab0ba
+  data.tar.gz: b085c940d24c1f3a2bea211ad0fef22cf0455bbb958c85c0932fa4659c9a362c
 SHA512:
-  metadata.gz: e64850f3e6bb5d754e1d365d03538d42e37b6798ac177bd6e6eb1297e5431a43f4261c1ad29c05f9d0ecb29d8e7c5200c1d9f4fecb1b4440e3fa37f9b7c7bfc7
-  data.tar.gz: cd164fe876d2bd58d23c742ae8b96bffa66e58f896d43f641ac0fe5c2ba736b4d5476aac7b17091c78154ec96a617d210d841039fcd92a34c562a356c4dda053
+  metadata.gz: ce46783a3fe8719de2400ea08b94bde2b7c64856c889129cd22580c97e727931c8025f97740dd8c5124997d973178aff3b284f103967bee91ff4a857151afc6f
+  data.tar.gz: dce4329c9bf0a556a0044b7e17c21e4e091a51da35466734fd03987dd59206a5f00d57b7496f0c46451cba4ebaf446628664bac89d0454f824488108825d23e4

data/CHANGELOG.md

@@ -1,30 +1,77 @@
+# 0.7.16
+
+Fixes bug when launching `dato dump --watch` together with the `environment` option.
+
+# 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
+- 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
+- Real-time events are now much more granular and the gem avoids downloading all the content every time a change occurs
 
 # 0.6.18
 
-* Fixed regression where you could no longer access items' item type
+- Fixed regression where you could no longer access items' item type
 
 # 0.6.15
 
-* Handle `429 Too Many Requests` responses from API
+- Handle `429 Too Many Requests` responses from API
 
 # 0.6.12
 
-* Allow empty responses from server
+- Allow empty responses from server
 
 # 0.6.10
 
-* Introduced `.meta` on `Dato::Local::Item` to fetch all meta information about the records
+- Introduced `.meta` on `Dato::Local::Item` to fetch all meta information about the records
 
 # 0.6.5
 
-* The `.seo_meta_tags` method now generates fallback titles based on the model field title
+- The `.seo_meta_tags` method now generates fallback titles based on the model field title
 
 # v0.6.2
 
@@ -32,7 +79,7 @@ Moved `json_schema` as runtime dependency
 
 # v0.6.1
 
-The big change is that the methods the client makes available are  generated at runtime based on the [JSON Schema of our CMA](https://www.datocms.com/content-management-api/). This means any new API endpoint — or changes to existing ones — will instantly be reflected to the client, without the need to upgrade to the latest client version.
+The big change is that the methods the client makes available are generated at runtime based on the [JSON Schema of our CMA](https://www.datocms.com/content-management-api/). This means any new API endpoint — or changes to existing ones — will instantly be reflected to the client, without the need to upgrade to the latest client version.
 
 We also added a new `deserialize_response` option to every call, that you can use if you want to retrieve the exact payload the DatoCMS returns:
 

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,14 @@ 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
         error = ApiError.new(e.response)
-        puts "===="
+        puts '===='
         puts error.message
-        puts "===="
+        puts '===='
         raise error
       end
     end
@@ -123,12 +118,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 +136,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/local/field_type/file.rb

@@ -210,7 +210,7 @@ module Dato
 
         def file
           Imgix::Client.new(
-            host: @imgix_host,
+            domain: @imgix_host,
             secure: true,
             include_library_param: false
           ).path(path)
@@ -220,6 +220,17 @@ module Dato
           file.to_url(opts)
         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)
           {
             id: id,

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-#{client.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/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.9'
+  VERSION = '0.7.16'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dato
 version: !ruby/object:Gem::Version
-  version: 0.7.9
+  version: 0.7.16
 platform: ruby
 authors:
 - Stefano Verna
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-03 00:00:00.000000000 Z
+date: 2020-09-30 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
@@ -464,8 +479,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby client for DatoCMS API