dato 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 186f63cfff368069213a4dd2e8b0659c03c940a1
-  data.tar.gz: c3ddd98a4638451b2f18b076c352b28cede76976
+  metadata.gz: e8bd9232f5d7494629388a5faf7e29af279a3892
+  data.tar.gz: 4a2a9ce729001fac5cbbaefe1066693e4bac0848
 SHA512:
-  metadata.gz: 3569cada67d3a8b46d6f1092d0184dc9be5a460ef87b8ddd5fb5ef3673e17363cda25b99adbea35f7d356a966a7780d79e74af045c621e30fa44c08226a7f96f
-  data.tar.gz: 9db4bd3512b4543ccfb607063ae381ab1c98c2d76596fa2eab5d9f15bee1a94a8cfda6dcf327d4eb0d1e448712f83149f6a801fc181453ffcb9ea58ff34abbf6
+  metadata.gz: 10bcef46db03d23cdf7ee723b01e19a50a878ac5d707890adbad735dff3c11f9b2105a6b9f8d850e6938bce665b403c69a073b1d6cf4df03922818f6dcb38c42
+  data.tar.gz: 6fafa7598ffab0f0939c08664fb9531c89ba1a31836a54f64102cc2b60841c94f802afcb6031068e600ea5a10b2910ef849b3188aa89931c1cb3f7b57aa10e36

data/.rspec

@@ -1,2 +1,2 @@
---format documentation
+--format progress
 --color

data/.rubocop.yml

@@ -21,7 +21,7 @@ Metrics/ModuleLength:
   Enabled: false
 
 Metrics/CyclomaticComplexity:
-  Max: 7
+  Max: 8
 
 Metrics/AbcSize:
   Max: 30

data/.ruby-version

@@ -1 +1 @@
-2.2.2
+2.3.1

data/dato.gemspec

@@ -43,4 +43,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'video_embed'
   spec.add_runtime_dependency 'toml'
   spec.add_runtime_dependency 'cacert'
+  spec.add_runtime_dependency 'dotenv'
 end

data/docs/site-api-client.md

@@ -117,4 +117,5 @@ client.upload_file(path_or_url)
 client.users.create(resource_attributes)
 client.users.all
 client.users.find(user_id)
+client.users.destroy(user_id)
 ```

data/exe/dato

@@ -4,4 +4,7 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
 require 'dato'
+require 'dotenv'
+
+Dotenv.load
 Dato::Cli.start(ARGV)

data/lib/dato.rb

@@ -5,6 +5,8 @@ require 'dato/site/client'
 require 'dato/account/client'
 require 'dato/local/site'
 require 'dato/cli'
+require 'dato/utils/seo_tags_builder'
+require 'dato/utils/favicon_tags_builder'
 
 module Dato
 end

data/lib/dato/dump/operation/add_to_data_file.rb

@@ -16,6 +16,8 @@ module Dato
 
         def perform
           complete_path = File.join(context.path, path)
+          FileUtils.mkdir_p(File.dirname(complete_path))
+
           content_to_add = Format.dump(format, value)
 
           old_content = if File.exist? complete_path

data/lib/dato/dump/operation/create_data_file.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'fileutils'
 require 'dato/dump/format'
 
 module Dato
@@ -15,6 +16,8 @@ module Dato
         end
 
         def perform
+          FileUtils.mkdir_p(File.dirname(path))
+
           File.open(File.join(context.path, path), 'w') do |file|
             file.write Format.dump(format, value)
           end

data/lib/dato/dump/operation/create_post.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'fileutils'
 require 'dato/dump/format'
 
 module Dato
@@ -16,6 +17,8 @@ module Dato
         end
 
         def perform
+          FileUtils.mkdir_p(File.dirname(path))
+
           File.open(File.join(context.path, path), 'w') do |file|
             file.write Format.frontmatter_dump(
               frontmatter_format,

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

@@ -24,7 +24,8 @@ module Dato
         def file(host = default_host)
           Imgix::Client.new(
             host: host,
-            secure: true
+            secure: true,
+            include_library_param: false
           ).path(path)
         end
 

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

@@ -23,8 +23,10 @@ module Dato
           @height = height
         end
 
+        alias raw_file file
+
         def file(host = default_host)
-          super.ch('DPR', 'Width').auto('compress', 'format')
+          super.ch('DPR', 'Width').auto('format')
         end
 
         def to_hash

data/lib/dato/local/item.rb

@@ -13,7 +13,7 @@ module Dato
       extend Forwardable
 
       attr_reader :entity
-      def_delegators :entity, :id, :type, :item_type
+      def_delegators :entity, :id
 
       def initialize(entity, items_repo)
         @entity = entity
@@ -52,6 +52,10 @@ module Dato
         end
       end
 
+      def seo_meta_tags
+        Utils::SeoTagsBuilder.new(self, @items_repo.site).meta_tags
+      end
+
       def singleton?
         item_type.singleton
       end

data/lib/dato/local/items_repo.rb

@@ -50,9 +50,9 @@ module Dato
       end
 
       def items_of_type(item_type)
-        method, singleton = item_type_methods[item_type]
+        method = item_type_methods[item_type]
 
-        if singleton
+        if item_type.singleton
           Array(@collections_by_type[method])
         else
           @collections_by_type[method]
@@ -64,6 +64,7 @@ module Dato
       def build_cache!
         build_item_type_methods!
         build_collections_by_type!
+        build_singletons_by_type!
       end
 
       def build_item_type_methods!
@@ -76,24 +77,27 @@ module Dato
         clashing_keys = singleton_keys & collection_keys
 
         item_types.each do |item_type|
-          singleton = item_type.singleton
           pluralized_api_key = item_type.api_key.pluralize
-          method = singleton ? item_type.api_key : pluralized_api_key
+
+          method = if item_type.singleton
+                     item_type.api_key
+                   else
+                     pluralized_api_key
+                   end
 
           if clashing_keys.include?(pluralized_api_key)
-            suffix = singleton ? 'instance' : 'collection'
+            suffix = item_type.singleton ? 'instance' : 'collection'
             method = "#{method}_#{suffix}"
           end
 
-          @item_type_methods[item_type] = [method.to_sym, singleton]
+          @item_type_methods[item_type] = method.to_sym
         end
       end
 
       def build_collections_by_type!
         item_types.each do |item_type|
-          method, singleton = item_type_methods[item_type]
-
-          @collections_by_type[method] = if singleton
+          method = item_type_methods[item_type]
+          @collections_by_type[method] = if item_type.singleton
                                            nil
                                          else
                                            ItemCollection.new
@@ -102,16 +106,30 @@ module Dato
 
         item_entities.each do |item_entity|
           item = Item.new(item_entity, self)
-          method, singleton = item_type_methods[item_entity.item_type]
+          method = item_type_methods[item_entity.item_type]
 
-          if singleton
-            @collections_by_type[method] = item
-          else
+          unless item_entity.item_type.singleton
             @collections_by_type[method].push item
           end
 
           @items_by_id[item.id] = item
         end
+
+        item_types.each do |item_type|
+          method = item_type_methods[item_type]
+          if !item_type.singleton && item_type.sortable
+            @collections_by_type[method].sort_by!(&:position)
+          end
+        end
+      end
+
+      def build_singletons_by_type!
+        item_types.each do |item_type|
+          method = item_type_methods[item_type]
+          if item_type.singleton
+            @collections_by_type[method] = @items_by_id[item_type.singleton_item.id]
+          end
+        end
       end
 
       def item_entities

data/lib/dato/local/site.rb

@@ -25,10 +25,14 @@ module Dato
       end
 
       def to_s
-        "#<Site id=#{id} site_name=#{site_name}>"
+        "#<Site id=#{id} site_name=#{name}>"
       end
       alias inspect to_s
 
+      def favicon_meta_tags(theme_color = nil)
+        Utils::FaviconTagsBuilder.new(self, theme_color).meta_tags
+      end
+
       def to_hash
         attributes = [
           :id, :name, :locales, :theme_hue, :domain, :internal_domain,

data/lib/dato/utils/favicon_tags_builder.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+module Dato
+  module Utils
+    class FaviconTagsBuilder
+      attr_reader :theme_color, :site
+
+      APPLE_TOUCH_ICON_SIZES = [57, 60, 72, 76, 114, 120, 144, 152, 180].freeze
+      ICON_SIZES = [16, 32, 96, 192].freeze
+      WINDOWS_SIZES = [[70, 70], [150, 150], [310, 310], [310, 150]].freeze
+
+      def initialize(site, theme_color)
+        @site = site
+        @theme_color = theme_color
+      end
+
+      def meta_tags
+        [
+          build_icon_tags,
+          build_apple_icon_tags,
+          build_windows_tags,
+          build_color_tags,
+          build_app_name_tag
+        ].flatten.compact
+      end
+
+      def build_apple_icon_tags
+        return unless site.favicon
+
+        APPLE_TOUCH_ICON_SIZES.map do |size|
+          link_tag(
+            'apple-touch-icon',
+            url(size),
+            sizes: "#{size}x#{size}"
+          )
+        end
+      end
+
+      def build_icon_tags
+        return unless site.favicon
+
+        ICON_SIZES.map do |size|
+          link_tag(
+            'icon',
+            url(size),
+            sizes: "#{size}x#{size}",
+            type: "image/#{site.favicon.format}"
+          )
+        end
+      end
+
+      def build_windows_tags
+        return unless site.favicon
+
+        WINDOWS_SIZES.map do |(w, h)|
+          meta_tag("msapplication-square#{w}x#{h}logo", url(w, h))
+        end
+      end
+
+      def build_app_name_tag
+        meta_tag('application-name', site.name)
+      end
+
+      def build_color_tags
+        return unless theme_color
+
+        [
+          meta_tag('theme-color', theme_color),
+          meta_tag('msapplication-TileColor', theme_color)
+        ]
+      end
+
+      def url(width, height = width)
+        site.favicon.url(w: width, h: height)
+      end
+
+      def meta_tag(name, value)
+        { tag_name: 'meta', attributes: { name: name, content: value } }
+      end
+
+      def link_tag(rel, href, attrs = {})
+        { tag_name: 'link', attributes: attrs.merge(rel: rel, href: href) }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+require 'dato/utils/meta_tags/base'
+require 'time'
+
+module Dato
+  module Utils
+    module MetaTags
+      class ArticleModifiedTime < Base
+        def build
+          og_tag('article:modified_time', item.updated_at.iso8601) if item
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'dato/utils/meta_tags/base'
+
+module Dato
+  module Utils
+    module MetaTags
+      class ArticlePublisher < Base
+        def build
+          og_tag('article:publisher', facebook_page_url) if facebook_page_url
+        end
+
+        def facebook_page_url
+          site.global_seo && site.global_seo.facebook_page_url
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+require 'forwardable'
+require 'dato/local/field_type/seo'
+require 'active_support/core_ext/object/blank'
+
+module Dato
+  module Utils
+    module MetaTags
+      class Base
+        attr_reader :site, :item
+
+        def initialize(item, site)
+          @item = item
+          @site = site
+        end
+
+        def seo_field_with_fallback(attribute, alternative)
+          fallback_seo = site.global_seo && site.global_seo.fallback_seo
+
+          seo_field = item &&
+                      item.fields.detect { |f| f.field_type == 'seo' }
+
+          item_seo_value = seo_field &&
+                           item.send(seo_field.api_key) &&
+                           item.send(seo_field.api_key).send(attribute)
+
+          fallback_seo_value = fallback_seo &&
+                               fallback_seo.send(attribute)
+
+          item_seo_value || alternative || fallback_seo_value
+        end
+
+        def tag(tag_name, attributes)
+          { tag_name: tag_name, attributes: attributes }
+        end
+
+        def meta_tag(name, content)
+          tag('meta', name: name, content: content)
+        end
+
+        def og_tag(property, content)
+          tag('meta', property: property, content: content)
+        end
+
+        def card_tag(name, content)
+          meta_tag(name, content)
+        end
+
+        def content_tag(tag_name, content)
+          { tag_name: tag_name, content: content }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require 'dato/utils/meta_tags/base'
+
+module Dato
+  module Utils
+    module MetaTags
+      class Description < Base
+        def build
+          return unless description.present?
+
+          [
+            meta_tag('description', description),
+            og_tag('og:description', description),
+            card_tag('twitter:description', description)
+          ]
+        end
+
+        def description
+          @description ||= seo_field_with_fallback(:description, nil)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+require 'dato/utils/meta_tags/base'
+
+module Dato
+  module Utils
+    module MetaTags
+      class Image < Base
+        def build
+          return unless image
+
+          [
+            og_tag('og:image', image.url),
+            card_tag('twitter:image', image.url)
+          ]
+        end
+
+        def image
+          @image ||= seo_field_with_fallback(:image, item_image)
+        end
+
+        def item_image
+          item && item.fields
+                      .select { |field| field.field_type == 'image' }
+                      .map { |field| item.send(field.api_key) }
+                      .compact
+                      .find do |image|
+                        image.width >= 200 && image.height >= 200
+                      end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+require 'dato/utils/meta_tags/base'
+
+module Dato
+  module Utils
+    module MetaTags
+      class OgLocale < Base
+        def build
+          locale = I18n.locale
+          og_tag('og:locale', "#{locale}_#{locale.upcase}")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'dato/utils/meta_tags/base'
+
+module Dato
+  module Utils
+    module MetaTags
+      class OgSiteName < Base
+        def build
+          card_tag('og:site_name', site_name) if site_name
+        end
+
+        def site_name
+          site.global_seo && site.global_seo.site_name
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'dato/utils/meta_tags/base'
+
+module Dato
+  module Utils
+    module MetaTags
+      class OgType < Base
+        def build
+          if !item || item.singleton?
+            og_tag('og:type', 'website')
+          else
+            og_tag('og:type', 'article')
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'dato/utils/meta_tags/base'
+
+module Dato
+  module Utils
+    module MetaTags
+      class Robots < Base
+        def build
+          meta_tag('robots', 'noindex') if site.no_index
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+require 'dato/utils/meta_tags/base'
+
+module Dato
+  module Utils
+    module MetaTags
+      class Title < Base
+        def build
+          return unless item_title
+
+          [
+            content_tag('title', item_title_with_suffix),
+            og_tag('og:title', item_title),
+            card_tag('twitter:title', item_title)
+          ]
+        end
+
+        def title_field
+          item && item.fields.find do |field|
+            field.field_type == 'string' &&
+              field.appeareance[:type] == 'title'
+          end
+        end
+
+        def item_title
+          @item_title ||= seo_field_with_fallback(
+            :title,
+            title_field && item.send(title_field.api_key)
+          )
+        end
+
+        def suffix
+          (site.global_seo && site.global_seo.title_suffix) || ''
+        end
+
+        def item_title_with_suffix
+          if (item_title + suffix).size <= 60
+            item_title + suffix
+          else
+            item_title
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'dato/utils/meta_tags/base'
+
+module Dato
+  module Utils
+    module MetaTags
+      class TwitterCard < Base
+        def build
+          card_tag('twitter:card', 'summary')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'dato/utils/meta_tags/base'
+
+module Dato
+  module Utils
+    module MetaTags
+      class TwitterSite < Base
+        def build
+          card_tag('twitter:site', twitter_account) if twitter_account
+        end
+
+        def twitter_account
+          site.global_seo && site.global_seo.twitter_account
+        end
+      end
+    end
+  end
+end

data/lib/dato/utils/seo_tags_builder.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+require 'dato/utils/meta_tags/title'
+require 'dato/utils/meta_tags/description'
+require 'dato/utils/meta_tags/image'
+require 'dato/utils/meta_tags/robots'
+require 'dato/utils/meta_tags/og_locale'
+require 'dato/utils/meta_tags/og_type'
+require 'dato/utils/meta_tags/og_site_name'
+require 'dato/utils/meta_tags/article_modified_time'
+require 'dato/utils/meta_tags/article_publisher'
+require 'dato/utils/meta_tags/twitter_card'
+require 'dato/utils/meta_tags/twitter_site'
+
+module Dato
+  module Utils
+    class SeoTagsBuilder
+      META_TAGS = [
+        MetaTags::Title,
+        MetaTags::Description,
+        MetaTags::Image,
+        MetaTags::Robots,
+        MetaTags::OgLocale,
+        MetaTags::OgType,
+        MetaTags::OgSiteName,
+        MetaTags::ArticleModifiedTime,
+        MetaTags::ArticlePublisher,
+        MetaTags::TwitterCard,
+        MetaTags::TwitterSite
+      ].freeze
+
+      attr_reader :site, :item
+
+      def initialize(item, site)
+        @item = item
+        @site = site
+      end
+
+      def meta_tags
+        META_TAGS.map do |klass|
+          klass.new(item, site).build
+        end.flatten.compact
+      end
+    end
+  end
+end

data/lib/dato/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Dato
-  VERSION = '0.2.7'
+  VERSION = '0.3.0'
 end

data/lib/dato/watch/site_change_watcher.rb

@@ -0,0 +1,36 @@
+require 'pusher-client'
+
+module Dato
+  module Watch
+    class SiteChangeWatcher
+      attr_reader :site_id
+
+      PUSHER_API_KEY = '75e6ef0fe5d39f481626'
+
+      def initialize(site_id)
+        PusherClient.logger.level = Logger::WARN
+        @site_id = site_id
+        @socket = nil
+      end
+
+      def connect(&block)
+        return if connected?
+
+        @socket = PusherClient::Socket.new(PUSHER_API_KEY, secure: true)
+        @socket.subscribe("site-#{site_id}")
+        @socket.bind('site:change', &block)
+        @socket.connect(true)
+
+        self
+      end
+
+      def connected?
+        @socket && @socket.connected
+      end
+
+      def disconnect!
+        connected? && @socket.disconnect
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dato
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
 platform: ruby
 authors:
 - Stefano Verna
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-22 00:00:00.000000000 Z
+date: 2016-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -318,6 +318,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby client for DatoCMS API
 email:
 - s.verna@cantierecreativo.net
@@ -403,7 +417,22 @@ files:
 - lib/dato/site/repo/user.rb
 - lib/dato/upload/file.rb
 - lib/dato/upload/image.rb
+- lib/dato/utils/favicon_tags_builder.rb
+- lib/dato/utils/meta_tags/article_modified_time.rb
+- lib/dato/utils/meta_tags/article_publisher.rb
+- lib/dato/utils/meta_tags/base.rb
+- lib/dato/utils/meta_tags/description.rb
+- lib/dato/utils/meta_tags/image.rb
+- lib/dato/utils/meta_tags/og_locale.rb
+- lib/dato/utils/meta_tags/og_site_name.rb
+- lib/dato/utils/meta_tags/og_type.rb
+- lib/dato/utils/meta_tags/robots.rb
+- lib/dato/utils/meta_tags/title.rb
+- lib/dato/utils/meta_tags/twitter_card.rb
+- lib/dato/utils/meta_tags/twitter_site.rb
+- lib/dato/utils/seo_tags_builder.rb
 - lib/dato/version.rb
+- lib/dato/watch/site_change_watcher.rb
 homepage: https://github.com/datocms/ruby-datocms-client
 licenses:
 - MIT
@@ -424,7 +453,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby client for DatoCMS API