dato 0.7.6 → 0.7.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 118ea91dc3caa834412e342a2350b594c94880bbbafba6f37d2b6041b5570acc
-  data.tar.gz: 64e1a53c6292a41ad4e361e4b01bdff416d09e3acebbd133afc123c2f80fe74b
+  metadata.gz: 8911d925c9122207b1b12804415839e1a60c6f42212523f8a9d8590a0ac3b609
+  data.tar.gz: fcb4dfbed9102fd7c037c635bb0a436ea8c5671964e51e7dcf1c9b7345f25471
 SHA512:
-  metadata.gz: a93f7dccda38b47237a585a7274754b2a3c370918c476e5556bc42ec13a2326a53e594f25b48fdc240a456f707d71dedfe9d9587a978ff38a177c398d5627ffa
-  data.tar.gz: b74c22160ba51d703705213b12c60d795eb499855fc6179a8b2c576ff8e32d1cd7bb94747a7e3a6a5bd957ff527e34964ca01eb47dbfdc078f16519272dfb6a4
+  metadata.gz: 127d2b647b57bbf530f3def61fefd302f763ec0ead035dc0f7a3d53cb6d6646948a994a75c5b6f22533e815e35a1a27a1d1f6cb0b85f2eedb86e8985971bbc87
+  data.tar.gz: 9709363be3b119354890d3d1de8a16bd8a020faf3e58692022e50de1ba25dcd4af6c49f1962e03cd8e8b82f35334140efa61cd7ff9f3f9835b39c5901b3e904b

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/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Cantiere Creativo SRL
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

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

@@ -38,6 +38,10 @@ module Dato
           @imgix_host = imgix_host
         end
 
+        def id
+          @upload.id
+        end
+
         def path
           @upload.path
         end
@@ -70,19 +74,138 @@ 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 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
@@ -99,6 +222,7 @@ module Dato
 
         def to_hash(*_args)
           {
+            id: id,
             format: format,
             size: size,
             width: width,
@@ -106,7 +230,18 @@ module Dato
             alt: alt,
             title: title,
             custom_data: custom_data,
-            url: url
+            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/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/site/client.rb

@@ -2,7 +2,7 @@
 
 require 'dato/api_client'
 require 'dato/upload/file'
-require 'dato/upload/image'
+require 'dato/upload/create_upload_path'
 
 module Dato
   module Site
@@ -11,13 +11,18 @@ module Dato
 
       json_schema 'site-api'
 
-      def upload_file(path_or_url)
-        file = Upload::File.new(self, path_or_url)
+      def create_upload_path(path_or_url)
+        file = Upload::CreateUploadPath.new(self, path_or_url)
+        file.upload_path
+      end
+
+      def upload_file(path_or_url, upload_attributes = {}, field_attributes = {})
+        file = Upload::File.new(self, path_or_url, upload_attributes, field_attributes)
         file.upload
       end
 
-      def upload_image(path_or_url)
-        file = Upload::Image.new(self, path_or_url)
+      def upload_image(path_or_url, upload_attributes = {}, field_attributes = {})
+        file = Upload::File.new(self, path_or_url, upload_attributes, field_attributes)
         file.upload
       end
 

data/lib/dato/upload/create_upload_path.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'mime/types'
+require 'tempfile'
+require 'addressable'
+require 'net/http'
+
+module Dato
+  module Upload
+    class CreateUploadPath
+      attr_reader :client, :source
+
+      def initialize(client, source)
+        @client = client
+        @source = source
+      end
+
+      def file
+        @file ||= if http_source?
+                    uri = Addressable::URI.parse(source)
+                    ext = ::File.extname(uri.path).downcase
+                    tempfile = Tempfile.new(['file', ext])
+                    tempfile.binmode
+                    tempfile.write(download_file(source))
+                    tempfile.rewind
+                    tempfile
+                  else
+                    ::File.new(::File.expand_path(source))
+                  end
+      end
+
+      def http_source?
+        uri = Addressable::URI.parse(source)
+        uri.scheme == 'http' || uri.scheme == 'https'
+      rescue Addressable::URI::InvalidURIError
+        false
+      end
+
+      def filename
+        if http_source?
+          ::File.basename(source)
+        else
+          ::File.basename(file.path)
+        end
+      end
+
+      def upload_path
+        upload_request = client.upload_request.create(filename: filename)
+        uri = URI.parse(upload_request[:url])
+
+        mime_type = MIME::Types.of(filename).first
+
+        request = Net::HTTP::Put.new(uri)
+        if mime_type
+          request.add_field("Content-Type", mime_type.to_s)
+        end
+        request.body = file.read
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+
+        http.request(request)
+
+        upload_request[:id]
+      end
+
+      def download_file(url)
+        connection = Faraday.new do |c|
+          c.response :raise_error
+          c.use FaradayMiddleware::FollowRedirects
+          c.adapter :net_http
+        end
+        connection.get(url).body
+      rescue Faraday::Error => e
+        puts "Error during uploading #{url}"
+        raise e
+      end
+    end
+  end
+end
+

data/lib/dato/upload/file.rb

@@ -1,88 +1,31 @@
 # frozen_string_literal: true
 
-require 'mime/types'
-require 'tempfile'
-require 'addressable'
-require 'net/http'
+require 'dato/upload/create_upload_path'
 
 module Dato
   module Upload
     class File
-      IMAGE_FORMATS = %w[png jpg jpeg gif].freeze
+      attr_reader :client, :source, :upload_attributes, :field_attributes
 
-      attr_reader :client, :source
-
-      def initialize(client, source)
+      def initialize(client, source, upload_attributes = {}, field_attributes = {})
         @client = client
         @source = source
-      end
-
-      def file
-        @file ||= if http_source?
-                    uri = Addressable::URI.parse(source)
-                    ext = ::File.extname(uri.path).downcase
-                    tempfile = Tempfile.new(['file', ext])
-                    tempfile.binmode
-                    tempfile.write(download_file(source))
-                    tempfile.rewind
-                    tempfile
-                  else
-                    ::File.new(::File.expand_path(source))
-                  end
-      end
-
-      def http_source?
-        uri = Addressable::URI.parse(source)
-        uri.scheme == 'http' || uri.scheme == 'https'
-      rescue Addressable::URI::InvalidURIError
-        false
-      end
-
-      def filename
-        if http_source?
-          ::File.basename(source)
-        else
-          ::File.basename(file.path)
-        end
+        @upload_attributes = upload_attributes
+        @field_attributes = field_attributes
       end
 
       def upload
-        upload_request = client.upload_request.create(filename: filename)
-        uri = URI.parse(upload_request[:url])
+        upload_path = CreateUploadPath.new(client, source).upload_path
 
-        mime_type = MIME::Types.of(filename).first
-
-        request = Net::HTTP::Put.new(uri)
-        if mime_type
-          request.add_field("Content-Type", mime_type.to_s)
-        end
-        request.body = file.read
-
-        http = Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = true
-
-        http.request(request)
-
-        upload = client.uploads.create(path: upload_request[:id])
+        upload = client.uploads.create(
+          upload_attributes.merge(path: upload_path)
+        )
 
         {
-          upload_id: upload['id'],
           alt: nil,
           title: nil,
           custom_data: {},
-        }
-      end
-
-      def download_file(url)
-        connection = Faraday.new do |c|
-          c.response :raise_error
-          c.use FaradayMiddleware::FollowRedirects
-          c.adapter :net_http
-        end
-        connection.get(url).body
-      rescue Faraday::Error => e
-        puts "Error during uploading #{url}"
-        raise e
+        }.merge(field_attributes).merge(upload_id: upload['id'])
       end
     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.6'
+  VERSION = '0.7.13'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dato
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.7.13
 platform: ruby
 authors:
 - Stefano Verna
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-09 00:00:00.000000000 Z
+date: 2020-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -362,6 +362,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -425,8 +426,10 @@ files:
 - lib/dato/paginator.rb
 - lib/dato/repo.rb
 - lib/dato/site/client.rb
+- 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