editmode 1.3.1 → 1.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 392f282609e410c8656791b6120245b8b4c790ed8ba102d6dfe1c5d2062acd6f
-  data.tar.gz: 94246ddabf9aadcdf65ceab231e83a6704a7d89f39ce5039685b7f44ea4e18c9
+  metadata.gz: 32d49f4215168d36260f8b3f363c12d7ba6948fd7e9f97e8dae1e1b58ddb7ef8
+  data.tar.gz: ed1cf4a9c60ae63973ed9e3f98b5c2a7e66eb4b273e1a392509574aa7ae3f86a
 SHA512:
-  metadata.gz: 7a1f7f6442b1109fedbd94be59a08c0658d3aa6d9570a5e21f36a32da45c6befacdab23da75670618034c95ceace95262e440807ccafc0c847544b96600497be
-  data.tar.gz: b89dc6f25b53ef930ed66c752947a539157cd4cda959a8288366431cb2ea0987ac7d5af6e3b5ab0a5ee49e341046fc47877133ade9c1fa05a8ba0a833add5368
+  metadata.gz: b2036241a90a7d9eff95d2da0553918d278f37c5336b181bcf62d076bb7a4184f87b8dac5a286026dc88f5beaf46e54db5020f6228877d88b0a72592bd85ee2c
+  data.tar.gz: 6f0354be4a33de404b01f0b1611a87e95c4916b59f0034356cc647192b99f77b113424c5b463d1542c6e405306c959a4477c93949d92392e382c9f7fa98000f1

data/README.md

@@ -107,6 +107,20 @@ e("cnk_16e04a02d577afb610ce", "Email Content", variables: variable_values)
 | item_class | string | `optional` Class name(s) that will be added along with "chunks-collection-item--wrapper" to all collection items |
 
 
+### Working with Image Transformation
+Use `transformation` attribute to perform real-time image transformations to deliver perfect images to the end-users.
+
+```ruby
+# This chunk should render an image with 200 x 200 dimension
+= E('id-of-some-image', transformation: "w-200 h-200")
+
+# For image inside a collection
+= c('some-collection-id') do
+  = F('Avatar', transformation: "w-200 h-200")
+```
+
+Please see the complete list of [transformation parameters](https://editmode.com/docs#/imagekit_properties).
+
 ## Caching
 In order to keep your application speedy, Editmode minimizes the amount of network calls it makes by caching content where it can. 
 
@@ -125,6 +139,8 @@ The editmode gem exposes a cache expiration endpoint in your application at `/ed
 
 The cache expiration endpoint is currently **not** authenticated.
 
+?> We are using a method called `delete_matched` to purge your caches when a content gets updated, and this method isn't supported in `memcached`. We highly recommend using `redis_store` or `file_store`.
+
 ## Disabling editmode.js auto-include
 
 To disable automatic insertion for a particular controller or action you can:

data/app/controllers/editmode_controller.rb

@@ -6,14 +6,14 @@ class EditmodeController < ApplicationController
       render status: 200, json: {:response => "success"}
     elsif params[:collection]
       cache_id = "collection_#{params[:identifier]}"
-      Rails.cache.delete_matched("#{cache_id}*")
+      Rails.cache.delete_matched("*#{cache_id}*")
       render status: 200, json: {:response => "success"}
     elsif params[:variable_cache_project_id]
       project_id = params[:variable_cache_project_id]
       Rails.cache.delete("chunk_#{project_id}_variables")
       render status: 200, json: {:response => "success"}
     elsif params[:identifier]
-      Rails.cache.delete_matched("#{params[:identifier]}")
+      Rails.cache.delete_matched("*#{params[:identifier]}*")
       render status: 200, json: {:response => "success"}
     else
       render status: 404, json: {:response => "no identifier specified"}

data/lib/editmode.rb

@@ -6,12 +6,19 @@ require 'editmode/auto_include_filter'
 require 'editmode/chunk_value'
 require 'editmode/railtie' if defined? Rails
 require 'editmode/engine' if defined?(Rails)
-# Todo: Implement RSPEC
+require 'editmode/monkey_patches'
+require 'editmode/logger'
+require 'editmode/chunk'
+
 module Editmode
   class << self
     include Editmode::ActionViewExtensions::EditmodeHelper
     include Editmode::Helper
 
+    def api_root_url
+      ENV["EDITMODE_OVERRIDE_API_URL"] || "https://api.editmode.com"
+    end
+
     def project_id=(id)
       config.project_id = id
     end
@@ -20,6 +27,18 @@ module Editmode
       config.project_id
     end
 
+    def logger
+      config.logger
+    end
+
+    def log_level
+      config.log_level
+    end
+
+    def log_level=(level)
+      config.log_level = level
+    end
+
     def access_token
       config.access_token
     end
@@ -39,15 +58,46 @@ module Editmode
         puts er
       end
     end
+
+    def cache_all!(chunks)
+      chunks.each do |chunk|
+        project_id = chunk["project_id"]
+        identifier = chunk["identifier"]
+        content_key = chunk["content_key"]
+        json_data = chunk.to_json
+        Rails.cache.write("chunk_#{project_id}#{identifier}", json_data)
+        Rails.cache.write("chunk_#{project_id}#{content_key}", json_data) if content_key.present?
+      end
+    end
   end
 
   class Configuration
     attr_accessor :access_token, :variable
-    attr_reader :project_id
+    attr_reader :project_id, :log_level, :preload
+
+    def preload=(bool)
+      @preload = bool
+      if bool
+        chunks = Editmode::Chunk.retrieve
+        Editmode.cache_all!(chunks)
+      end
+    end
+
+    def logger
+      @logger ||= Editmode::Logger.new
+    end
 
     def project_id=(id)
       @project_id = id
+      if preload
+        chunks = Editmode::Chunk.retrieve(id)
+        Editmode.cache_all!(chunks)
+      end
+    end
 
+    def log_level=(level)
+      @log_level = level
+      logger.log_level = level
     end
   end
 end

data/lib/editmode/chunk.rb

@@ -0,0 +1,26 @@
+class Editmode::Chunk
+  def initialize
+  end
+
+  class << self
+    def retrieve(project_id = Editmode.project_id, options = {})
+      begin
+        root_url = Editmode.api_root_url
+        chunk_id = options[:identifier] || options[:content_key]
+
+        url = "#{root_url}/chunks/#{chunk_id}?project_id=#{project_id}"
+        response = HTTParty.get(url)
+
+        if chunk_id.present?
+          return response
+        else
+          chunks = response.try(:[], "chunks")
+          chunks ||= []
+        end
+      rescue => er
+        Rails.logger.info er
+        []
+      end
+    end
+  end
+end

data/lib/editmode/chunk_value.rb

@@ -9,7 +9,7 @@ module Editmode
     attr_accessor :identifier, :variable_values, :branch_id,
       :variable_fallbacks, :chunk_type, :project_id,
       :url, :collection_id, :cache_identifier,
-      :response
+      :response, :transformation
 
     attr_writer :content
 
@@ -22,6 +22,7 @@ module Editmode
       @raw = options[:raw].present?
       @skip_sanitize = options[:dangerously_skip_sanitization]
       @skip_cache = options[:skip_cache]
+      @transformation = options[:transformation]
 
       @url = "#{api_root_url}/chunks/#{identifier}"
       @cache_identifier = set_cache_identifier(identifier)
@@ -40,7 +41,7 @@ module Editmode
         if field.present?
           field_chunk = field_chunk(field)
           if field_chunk.present?
-            result = field_chunk['content']
+            result = field_chunk['chunk_type'] == 'image' ? set_transformation_properties!(field_chunk['content']) : field_chunk['content']
             result = variable_parse!(result, variable_fallbacks, variable_values, @raw, @skip_sanitize)
           else
             raise no_response_received(field)
@@ -73,6 +74,23 @@ module Editmode
     end
 
     private
+    def set_transformation_properties!(url)
+      if transformation.present? && url.present?
+        transformation.gsub!(" ", ",")
+        transformation.gsub!(/\s/, '')
+  
+        uri = URI(url)
+        uri.query = [uri.query, "tr=#{transformation}"].compact.join("&")
+        
+        url = uri.to_s
+      end
+
+      url
+    end
+
+    def allowed_tag_attributes
+      %w(style href title src alt width height class target)
+    end
 
     # Todo: Transfer to helper utils
     def api_root_url
@@ -108,7 +126,7 @@ module Editmode
         end
       end
 
-      content = ActionController::Base.helpers.sanitize(content) unless skip_sanitize
+      content = ActionController::Base.helpers.sanitize(content, attributes: allowed_tag_attributes) unless skip_sanitize
       return content
     end
 
@@ -139,8 +157,9 @@ module Editmode
     end
 
     def set_response_attributes!
-      @content = response['content']
       @chunk_type = response['chunk_type']
+      
+      @content = @chunk_type == 'image' ? set_transformation_properties!(response['content']) : response['content'] 
       @variable_fallbacks = response['variable_fallbacks'].presence || {}
       @collection_id = response["collection"]["identifier"] if chunk_type == 'collection_item'
       @branch_id = response['branch_id']

data/lib/editmode/helper.rb

@@ -17,7 +17,7 @@ module Editmode
     end
 
     def render_custom_field_raw(label, options={})
-      e(@custom_field_chunk["identifier"], label, options.merge({response: @custom_field_chunk}))
+      e(@custom_field_chunk["identifier"], label, options.merge({response: @custom_field_chunk}))      
     end
     alias_method :f, :render_custom_field_raw
 

data/lib/editmode/logger.rb

@@ -0,0 +1,28 @@
+require 'active_support'
+
+module Editmode
+  class Logger
+    attr_accessor :httparty_subscription
+
+    def log_level=(level)
+      if level == :normal
+        # Add more subscription here
+        enable_httparty!
+      end
+    end
+
+    def enable_httparty!
+      @httparty_subscription = ActiveSupport::Notifications.subscribe('request.httparty') do |name, start, ending, transaction_id, payload|
+        event = ActiveSupport::Notifications::Event.new(name, start, ending, transaction_id, payload)
+        Rails.logger.info "  HTTParty -- " + "#{event.payload[:method]} #{event.payload[:url]} (Duration: #{event.duration}ms)"
+        Thread.current[:http_runtime] ||= 0
+        Thread.current[:http_runtime] += event.duration
+        payload[:http_runtime] = event.duration
+      end
+    end
+
+    def unsubscribe(subscriber)
+      ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber.present?
+    end
+  end
+end

data/lib/editmode/monkey_patches.rb

@@ -0,0 +1,17 @@
+require 'httparty'
+
+# Support logging on httparty requests
+module HTTParty
+  class Request
+    alias_method :_original_perform, :perform
+    def perform(&block)
+      payload = {
+        method: http_method.const_get(:METHOD),
+        url: uri
+      }
+      ActiveSupport::Notifications.instrument 'request.httparty', payload do
+        _original_perform(&block)
+      end
+    end
+  end
+end

data/lib/editmode/version.rb

@@ -1,3 +1,3 @@
 module Editmode
-  VERSION = "1.3.1"
+  VERSION = "1.3.6"
 end

data/lib/generators/editmode/templates/editmode.rb.erb

@@ -1,5 +1,11 @@
 Editmode.setup do |config|
-  # Replace TodoProjectId with your Editmode Project ID, 
-  # visit https://editmode.com/projects
   config.project_id = "<%= @project_id %>"
+
+  # Enables logging on every API request
+  # config.log_level = :silence
+
+  # Preload contents - this will take all the contents
+  # from the project specified in config.project_id
+  # and store it to your Application cache.
+  # config.preload = true
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: editmode
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.6
 platform: ruby
 authors:
 - Tony Ennis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-26 00:00:00.000000000 Z
+date: 2021-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,9 +82,12 @@ files:
 - lib/editmode.rb
 - lib/editmode/action_view_extensions/editmode_helper.rb
 - lib/editmode/auto_include_filter.rb
+- lib/editmode/chunk.rb
 - lib/editmode/chunk_value.rb
 - lib/editmode/engine.rb
 - lib/editmode/helper.rb
+- lib/editmode/logger.rb
+- lib/editmode/monkey_patches.rb
 - lib/editmode/railtie.rb
 - lib/editmode/script_tag.rb
 - lib/editmode/version.rb