editmode 1.3.3 → 1.4.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c2cf39ab030f4bc6d04678170c164d950a4bf947659906c6da343537f447bd4
-  data.tar.gz: 89a6a0f4a16d51541404f1f1c0fd8ab90e0ad799b6bc176c28c48e8f653c0064
+  metadata.gz: 4acdedb3a0c0a95880700ee29583205d5e811546af1b641aa7eb741772dee274
+  data.tar.gz: b23c3944bdab82badcd992503f32da48165dca684af7a6965e58fb4445d5302f
 SHA512:
-  metadata.gz: d3815cd743139b4fd6a354c072d9bd2c8d010c8fa4aa2a6a6e04165f363430a5689d91a1228e5e3789b8d53a9f0434c4175a525bb3d7f85c4105bcecf81d1e96
-  data.tar.gz: fcb8a9260a0cd706ad049c2f2dfd9406c3c3bc2ac8addcb6fa74f662709d483a00e338613136959762c5f317798cde9ad9f8d48ce0077fe63cdac323ccd063d4
+  metadata.gz: 648e976a0deda3b7f0496bcb3dba5d56879d2a37486bea27353595c1a8ba7b471be6254af806cf6a024b5ac6d45c1d54f491179b7ed7b22cba1b7683c8f7b325
+  data.tar.gz: 8b59da953856ee72876f2eef4fb3760924f9076a4802de71ab2b10a141939feea95d083c44dc6737be7b3ee00e1c6148ecf459aa0bf20398e74f81c8f9736a87

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

@@ -8,11 +8,17 @@ require 'editmode/railtie' if defined? Rails
 require 'editmode/engine' if defined?(Rails)
 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
@@ -52,11 +58,30 @@ 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, :log_level
+    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
@@ -64,6 +89,10 @@ module Editmode
 
     def project_id=(id)
       @project_id = id
+      if preload
+        chunks = Editmode::Chunk.retrieve(id)
+        Editmode.cache_all!(chunks)
+      end
     end
 
     def log_level=(level)

data/lib/editmode/action_view_extensions/editmode_helper.rb

@@ -163,7 +163,7 @@ module Editmode
         # prevent the page from loading.
         begin
           field = options[:field].presence || ""          
-          options[:referrer] = request.url
+          options[:referrer] = request.present? && request.url || ""
           chunk_value = Editmode::ChunkValue.new(identifier, options)
           
           if field.present? && chunk_value.chunk_type == 'collection_item'
@@ -182,11 +182,12 @@ module Editmode
           render_chunk_content(identifier, chunk_content, chunk_type, options)
 
         rescue => error
+          puts error
           # Show fallback content by default
           return content_tag("em-span", &block) if block_given?
           # Otherwise show a span with no content to 
           # maintain layout
-          content_tag("em-span", "&nbsp".html_safe) 
+          content_tag("em-span", "&nbsp".html_safe)
         end
       end
       alias_method :chunk, :chunk_display

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,20 @@ 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
@@ -124,26 +139,30 @@ module Editmode
 
     def get_content
       if !cached?
-        http_response = HTTParty.get(url, query: query_params, headers: {referrer: @referrer})
-        response_received = true if http_response.code == 200
+        @response = HTTParty.get(url, query: query_params, headers: {referrer: @referrer})
+        response_received = true if @response.code == 200
       end
 
       if !cached? && !response_received
-        message = http_response.try(:[], 'message') || no_response_received(identifier)
+        message = @response.try(:[], 'message') || no_response_received(identifier)
 
         raise message
       else
-        Rails.cache.write(cache_identifier, http_response.to_json) if http_response.present?
+        Rails.cache.write(cache_identifier, @response.to_json) if @response.present?
         cached_response = Rails.cache.fetch(cache_identifier)
 
-        @response = json?(cached_response) ? JSON.parse(cached_response) : cached_response
+        if cached_response.present?
+          @response = json?(cached_response) ? JSON.parse(cached_response) : cached_response
+        end
+
         set_response_attributes!
       end
     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

@@ -5,7 +5,7 @@ module Editmode
       field, options = parse_arguments(args)
       begin
         chunk = Editmode::ChunkValue.new(identifier, options.merge({raw: true}))
-
+        
         if chunk.chunk_type == 'collection_item'
           chunk.field(field)
         else
@@ -13,11 +13,12 @@ module Editmode
         end 
       rescue => er
         Rails.logger.info "#{er}: We can't render content for #{identifier}"
+        return ""
       end
     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/version.rb

@@ -1,3 +1,3 @@
 module Editmode
-  VERSION = "1.3.3"
+  VERSION = "1.4.0.pre.1"
 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.3
+  version: 1.4.0.pre.1
 platform: ruby
 authors:
 - Tony Ennis
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2021-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,6 +82,7 @@ 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
@@ -96,7 +97,7 @@ homepage: https://github.com/tonyennis145/editmode-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -107,12 +108,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.2.4
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: Editmode allows you to turn plain text in your rails app into easily inline-editable
   bits of content that can be managed by anyone with no technical knowledge