editmode 1.2.9 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3c6615ff35d91086eb0774d03d3d5e90070f1f52456563b883b947c42182bdf
-  data.tar.gz: 067ea9cb9d9227d12cda1aa825fbce9987731ee720e9882386a9a1d6cdbb4e4c
+  metadata.gz: 9b84d630e273ea3949b9ff1f5f0bd69f5dcf546ff33e15e92e766cd623b269ae
+  data.tar.gz: ce10b6c6fe4d46052f303ab4aeaddde7da8c230ae6c03a299e06e0c42f3d1d93
 SHA512:
-  metadata.gz: e3da11757cc4d252bd5222533c4e4fee807623a50c6913d968dec1ded22e3a653199b3b5b858f138440d62391e64048d22e1062837689c082b523c62beb82170
-  data.tar.gz: 367aace629ffe1363a1938a6bdec061976eeb2dda597916378f4c6385ee57e7dfa7a8e0efda7d873d8d1aafbb0cb5875a4328e478540b4abba775728e177c05f
+  metadata.gz: 24ffa6158c7b3c0d22fb4c546b521ec48a51fc2f579575608168cd7a321f103e439c6dc26bf33599483daf957215481b92b5a96bd1e9133e6342bcbba950ddad
+  data.tar.gz: f4d684b4d7713dee4853e304f9a61371eb982e9ce9841fbe283670c5c42176bfdd35847482dd698136e71c598a61e545be8c569f9f1177cb397984f197016e04

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 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. 
 

data/lib/editmode.rb

@@ -6,7 +6,8 @@ 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'
 module Editmode
   class << self
     include Editmode::ActionViewExtensions::EditmodeHelper
@@ -20,6 +21,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
@@ -43,11 +56,19 @@ module Editmode
 
   class Configuration
     attr_accessor :access_token, :variable
-    attr_reader :project_id
+    attr_reader :project_id, :log_level
+
+    def logger
+      @logger ||= Editmode::Logger.new
+    end
 
     def project_id=(id)
       @project_id = id
+    end
 
+    def log_level=(level)
+      @log_level = level
+      logger.log_level = level
     end
   end
 end

data/lib/editmode/action_view_extensions/editmode_helper.rb

@@ -16,6 +16,10 @@ module Editmode
         # Todo Add Header Version
       end
 
+      def allowed_tag_attributes
+        [:style, :href, :title, :src, :alt, :width, :height]
+      end
+
       def api_root_url
         ENV["EDITMODE_OVERRIDE_API_URL"] || "https://api.editmode.com"
       end
@@ -110,7 +114,7 @@ module Editmode
         end
       end
 
-      def render_chunk_content(chunk_identifier, chunk_content, chunk_type,options = {})
+      def render_chunk_content(chunk_identifier, chunk_content, chunk_type, options = {})
         begin 
           css_class = options[:class]
           cache_id = options[:cache_identifier]
@@ -132,17 +136,17 @@ module Editmode
           case display_type
           when "span"
             if chunk_type == "rich_text"
-              content = content_tag("em-span", :class => "editmode-richtext-editor #{css_class}", :data => chunk_data.merge!({:chunk_editable => true}) ) do
+              content = content_tag("em-span", :class => "editmode-richtext-editor #{css_class}", :data => chunk_data.merge!({:chunk_editable => true}), **options.slice(*allowed_tag_attributes) ) do
                 chunk_content.html_safe
               end
             else
-              content_tag("em-span", :class => css_class, :data => chunk_data.merge!({:chunk_editable => true}) ) do
+              content_tag("em-span", :class => css_class, :data => chunk_data.merge!({:chunk_editable => true}), **options.slice(*allowed_tag_attributes) ) do
                 chunk_content.html_safe
               end
             end
           when "image"
             chunk_content = chunk_content.blank? || chunk_content == "/images/original/missing.png" ? 'https://www.editmode.com/upload.png' : chunk_content
-            image_tag(chunk_content, :data => chunk_data, :class => css_class) 
+            image_tag(chunk_content, :data => chunk_data, :class => css_class, **options.slice(*allowed_tag_attributes)) 
           end
         rescue => errors
           puts errors
@@ -159,7 +163,7 @@ module Editmode
         # prevent the page from loading.
         begin
           field = options[:field].presence || ""          
-
+          options[:referrer] = request.url
           chunk_value = Editmode::ChunkValue.new(identifier, options)
           
           if field.present? && chunk_value.chunk_type == 'collection_item'

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
 
@@ -17,10 +17,12 @@ module Editmode
       @identifier = identifier
       @branch_id = options[:branch_id].presence
       @project_id = project_id
+      @referrer = options[:referrer].presence || ""
       @variable_values = options[:variables].presence || {}
       @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)
@@ -39,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)
@@ -72,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
@@ -107,21 +126,21 @@ 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
 
     def query_params
       the_params = { 'project_id' => project_id }
       the_params['branch_id'] = branch_id if branch_id.present?
+      the_params['transformation'] = @transformation if @transformation.present?
 
       the_params
     end
 
     def get_content
-
       if !cached?
-        http_response = HTTParty.get(url, query: query_params)
+        http_response = HTTParty.get(url, query: query_params, headers: {referrer: @referrer})
         response_received = true if http_response.code == 200
       end
 

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.2.9"
+  VERSION = "1.3.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: editmode
 version: !ruby/object:Gem::Version
-  version: 1.2.9
+  version: 1.3.4
 platform: ruby
 authors:
 - Tony Ennis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-14 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,6 +85,8 @@ files:
 - 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