dato 0.6.18 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7011e6d97491b0d772ce29bf518411309948246a451495aad4889e09b57e379a
-  data.tar.gz: a90f2443479ff411ca350514bd17b4f0c78537de9d8c6acf51db0663d4d71529
+  metadata.gz: 5ae6a3e8219a9628772a2f4da2bdd5b8024042c765d6ea1582b94c2f86c59f81
+  data.tar.gz: 8d56caeecb617c3eda4072c9ff649e596fe4968c1b64b46c639804f23222fbd7
 SHA512:
-  metadata.gz: a6036fa4504f4ba21ef83186736d7788b8c6ecb1a3b2a2944f0a51635ef8d0aac4f6fe4ecbe9eb1f7dca9679dc4d7b4c2ded2cafa38cb4526deee60d7ca33d21
-  data.tar.gz: e605c4e7983a173a78a3432bfe4e3946cbb02666aea85759495ca5a65e40b3de1b85b2eccd556409f395d5a3adc030f16293f5545d7ad131dfe2ec096d808f3c
+  metadata.gz: 45fd8ebe07494123845f26eac19162a9c3a53f435607812ff0fa336567993171b73cd4f703d9f1b52f41c9c3758a366788bfde944a18f7aa92e762f8250426d4
+  data.tar.gz: 7078abd9cd150a79ca7d264094ef60321574fb4763020e5c473de9530c6e5c285d885ce792d6eea4f522b5a63f360c240c1dd0b3942f309df2912c74a8944ee0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.7.0
+
+* 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

data/lib/dato/cli.rb

@@ -3,7 +3,6 @@
 require 'thor'
 require 'dato/dump/runner'
 require 'dato/dump/ssg_detector'
-require 'dato/watch/site_change_watcher'
 require 'listen'
 module Dato
   class Cli < Thor
@@ -26,25 +25,26 @@ module Dato
           'X-SSG' => Dump::SsgDetector.new(Dir.pwd).detect
         }
       )
+      loader = Dato::Local::Loader.new(client, preview_mode)
+      print 'Fetching content from DatoCMS... '
+      loader.load
 
       if watch_mode
-        site_id = client.request(:get, '/site')['data']['id']
-
         semaphore = Mutex.new
 
-        thread_safe_dump(semaphore, config_file, client, preview_mode)
+        thread_safe_dump(semaphore, config_file, client, preview_mode, loader)
 
-        Dato::Watch::SiteChangeWatcher.new(site_id).connect do
-          thread_safe_dump(semaphore, config_file, client, preview_mode)
+        loader.watch do
+          thread_safe_dump(semaphore, config_file, client, preview_mode, loader)
         end
 
         watch_config_file(config_file) do
-          thread_safe_dump(semaphore, config_file, client, preview_mode)
+          thread_safe_dump(semaphore, config_file, client, preview_mode, loader)
         end
 
         sleep
       else
-        Dump::Runner.new(config_file, client, preview_mode).run
+        Dump::Runner.new(config_file, client, preview_mode, loader).run
       end
     end
 
@@ -78,9 +78,9 @@ module Dato
         ).start
       end
 
-      def thread_safe_dump(semaphore, config_file, client, preview_mode)
+      def thread_safe_dump(semaphore, config_file, client, preview_mode, loader)
         semaphore.synchronize do
-          Dump::Runner.new(config_file, client, preview_mode).run
+          Dump::Runner.new(config_file, client, preview_mode, loader).run
         end
       end
     end

data/lib/dato/dump/format.rb

@@ -2,6 +2,7 @@
 
 require 'dato/dump/format/toml'
 require 'dato/dump/format/yaml'
+require 'dato/dump/format/json'
 
 module Dato
   module Dump

data/lib/dato/dump/runner.rb

@@ -8,20 +8,17 @@ require 'dato/local/loader'
 module Dato
   module Dump
     class Runner
-      attr_reader :config_path, :client, :destination_path, :preview_mode
+      attr_reader :config_path, :client, :destination_path, :preview_mode, :loader
 
-      def initialize(config_path, client, preview_mode, destination_path = Dir.pwd)
+      def initialize(config_path, client, preview_mode, loader, destination_path = Dir.pwd)
         @config_path = config_path
         @preview_mode = preview_mode
         @client = client
         @destination_path = destination_path
+        @loader = loader
       end
 
       def run
-        print 'Fetching content from DatoCMS... '
-
-        loader.load
-
         I18n.available_locales = loader.items_repo.available_locales
         I18n.locale = I18n.available_locales.first
 
@@ -39,10 +36,6 @@ module Dato
       def operation
         @operation ||= Operation::Root.new(destination_path)
       end
-
-      def loader
-        @loader ||= Dato::Local::Loader.new(client, preview_mode)
-      end
     end
   end
 end

data/lib/dato/local/entities_repo.rb

@@ -9,14 +9,7 @@ module Dato
 
       def initialize(*payloads)
         @entities = {}
-
-        payloads.each do |payload|
-          EntitiesRepo.payload_entities(payload).each do |entity_payload|
-            object = JsonApiEntity.new(entity_payload, self)
-            @entities[object.type] ||= {}
-            @entities[object.type][object.id] = object
-          end
-        end
+        upsert_entities(*payloads)
       end
 
       def find_entities_of_type(type)
@@ -27,6 +20,27 @@ module Dato
         entities.fetch(type, {}).fetch(id, nil)
       end
 
+      def destroy_entities(type, ids)
+        ids.each do |id|
+          entities.fetch(type, {}).delete(id)
+        end
+      end
+
+      def destroy_item_type(id)
+        entities.fetch('item', {}).delete_if { |_item_id, item| item.item_type.id == id }
+        entities.fetch('item_type', {}).delete(id)
+      end
+
+      def upsert_entities(*payloads)
+        payloads.each do |payload|
+          EntitiesRepo.payload_entities(payload).each do |entity_payload|
+            object = JsonApiEntity.new(entity_payload, self)
+            @entities[object.type] ||= {}
+            @entities[object.type][object.id] = object
+          end
+        end
+      end
+
       def self.payload_entities(payload)
         acc = []
 

data/lib/dato/local/loader.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'pusher-client'
+
 require 'dato/local/entities_repo'
 require 'dato/local/items_repo'
 
@@ -11,6 +13,8 @@ module Dato
       attr_reader :items_repo
       attr_reader :preview_mode
 
+      PUSHER_API_KEY = '75e6ef0fe5d39f481626'
+
       def initialize(client, preview_mode = false)
         @client = client
         @preview_mode = preview_mode
@@ -34,8 +38,122 @@ module Dato
         @items_repo = ItemsRepo.new(@entities_repo)
       end
 
+      def watch(&block)
+        site_id = client.request(:get, '/site')['data']['id']
+
+        return if pusher && pusher.connected
+
+        pusher.subscribe("private-site-#{site_id}")
+
+        bind_on_item_destroy(&block)
+        bind_on_item_upsert(&block)
+        bind_on_item_type_upsert(&block)
+        bind_on_item_type_destroy(&block)
+        bind_on_upload_upsert(&block)
+        bind_on_upload_destroy(&block)
+
+        pusher.connect(true)
+      end
+
+      def stop_watch
+        pusher.disconnect if pusher && pusher.connected
+      end
+
       private
 
+      def bind_on_item_upsert(&block)
+        event_type = preview_mode ? 'preview_mode' : 'published_mode'
+
+        bind_on("item:#{event_type}:upsert", block) do |data|
+          payload = client.items.all(
+            {
+              'filter[ids]' => data[:ids].join(','),
+              version: item_version
+            },
+            deserialize_response: false,
+            all_pages: true
+          )
+
+          @entities_repo.upsert_entities(payload)
+        end
+      end
+
+      def bind_on_item_destroy(&block)
+        event_type = preview_mode ? 'preview_mode' : 'published_mode'
+
+        bind_on("item:#{event_type}:destroy", block) do |data|
+          @entities_repo.destroy_entities('item', data[:ids])
+        end
+      end
+
+      def bind_on_upload_upsert(&block)
+        bind_on("upload:upsert", block) do |data|
+          payload = client.uploads.all(
+            {
+              'filter[ids]' => data[:ids].join(',')
+            },
+            deserialize_response: false,
+            all_pages: true
+          )
+
+          @entities_repo.upsert_entities(payload)
+        end
+      end
+
+      def bind_on_upload_destroy(&block)
+        bind_on('upload:destroy', block) do |data|
+          @entities_repo.destroy_entities('upload', data[:ids])
+        end
+      end
+
+      def bind_on_item_type_upsert(&block)
+        bind_on('item_type:upsert', block) do |data|
+          data[:ids].each do |id|
+            payload = client.item_types.find(id, {}, deserialize_response: false)
+            @entities_repo.upsert_entities(payload)
+
+            payload = client.items.all(
+              { 'filter[type]' => id },
+              deserialize_response: false,
+              all_pages: true
+            )
+
+            @entities_repo.upsert_entities(payload)
+          end
+        end
+      end
+
+      def bind_on_item_type_destroy(&block)
+        bind_on('item_type:destroy', block) do |data|
+          data[:ids].each do |id|
+            @entities_repo.destroy_item_type(id)
+          end
+        end
+      end
+
+      def bind_on(event_name, user_block, &block)
+        pusher.bind(event_name) do |data|
+          parsed_data = JSON.parse(data)
+          block.call(parsed_data.deep_symbolize_keys)
+          update_items_repo!
+          user_block.call
+        end
+      end
+
+      def update_items_repo!
+        @items_repo = ItemsRepo.new(@entities_repo)
+      end
+
+      def pusher
+        PusherClient.logger.level = Logger::WARN
+
+        @pusher ||= PusherClient::Socket.new(
+          PUSHER_API_KEY,
+          secure: true,
+          auth_method: method(:pusher_auth_method)
+        )
+      end
+
       def site
         include = ['item_types', 'item_types.fields']
         client.request(:get, '/site', include: include)
@@ -43,18 +161,28 @@ module Dato
 
       def all_items
         client.items.all(
-          { version: preview_mode ? 'latest' : 'published' },
+          { version: item_version },
           deserialize_response: false,
           all_pages: true
         )
       end
 
       def all_uploads
-        client.uploads.all(
-          { 'filter[type]' => 'used' },
-          deserialize_response: false,
-          all_pages: true
-        )
+        client.uploads.all({},
+                           deserialize_response: false,
+                           all_pages: true)
+      end
+
+      def item_version
+        if preview_mode
+          'latest'
+        else
+          'published'
+        end
+      end
+
+      def pusher_auth_method(socket_id, channel)
+        client.pusher_token(socket_id, channel.name)["auth"]
       end
     end
   end

data/lib/dato/site/client.rb

@@ -20,6 +20,14 @@ module Dato
         file = Upload::Image.new(self, path_or_url)
         file.upload
       end
+
+      def pusher_token(socket_id, channel)
+        request(
+          :post,
+          "/pusher/authenticate",
+          { socket_id: socket_id, channel_name: channel}
+        )
+      end
     end
   end
 end

data/lib/dato/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dato
 version: !ruby/object:Gem::Version
-  version: 0.6.18
+  version: 0.7.0
 platform: ruby
 authors:
 - Stefano Verna
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-30 00:00:00.000000000 Z
+date: 2019-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -456,7 +456,6 @@ files:
 - 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

data/lib/dato/watch/site_change_watcher.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-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