editmode 1.2.8 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68357d9af1673886733d966a8c6bad378f2f0a9242b810b9e61560ab8b793b75
-  data.tar.gz: d7f45153fe466bb03b68a7b1428cc245883fbd033a4a0e9e449133a14c4480d5
+  metadata.gz: 3c2cf39ab030f4bc6d04678170c164d950a4bf947659906c6da343537f447bd4
+  data.tar.gz: 89a6a0f4a16d51541404f1f1c0fd8ab90e0ad799b6bc176c28c48e8f653c0064
 SHA512:
-  metadata.gz: cf0d706724b4d3fd92b7e3926af60e491adc248b3ac1b36b1913f3bf22eac78e82e8967182b29c8ba86984a0c5ce8b3124fecce2b8695e79fca0b098c72d9d77
-  data.tar.gz: a2af19294f5625257a5d94239a16bbb68035863404c951f9aa1d2728d0e16e57071f00ac1cecc1c560950505e2b8c9552d802fd16dbaaf6312403cc8db8302aa
+  metadata.gz: d3815cd743139b4fd6a354c072d9bd2c8d010c8fa4aa2a6a6e04165f363430a5689d91a1228e5e3789b8d53a9f0434c4175a525bb3d7f85c4105bcecf81d1e96
+  data.tar.gz: fcb8a9260a0cd706ad049c2f2dfd9406c3c3bc2ac8addcb6fa74f662709d483a00e338613136959762c5f317798cde9ad9f8d48ce0077fe63cdac323ccd063d4

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in chunks.gemspec
+  gem 'pry-rails'
+  gem 'rails', '~> 5.2.0'
 gemspec

data/Rakefile

@@ -1,2 +1,10 @@
-require "bundler/gem_tasks"
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
+task :test do
+  Dir['test/*_test.rb'].each do |testfile|
+    load testfile
+  end
+end
+
+task :default => :test

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

@@ -1,15 +1,25 @@
 require 'editmode/helper'
+require 'action_view'
+require 'httparty'
 
 module Editmode
   module ActionViewExtensions
     module EditmodeHelper
-      require 'httparty'
+      include ::ActionView::Helpers::TagHelper
+      include ::ActionView::Helpers::TextHelper
+      include ::ActionView::Helpers::AssetTagHelper
+      include ::ActionView::Context
       include Editmode::Helper
 
+
       def api_version
         # 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
@@ -104,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]
@@ -126,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
@@ -153,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

@@ -1,3 +1,6 @@
+require 'action_view'
+require 'active_support'
+
 module Editmode
   class ChunkValue
     include ActionView::Helpers::TagHelper
@@ -14,6 +17,7 @@ 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]
@@ -63,7 +67,15 @@ module Editmode
       result.try(:html_safe)
     end
 
+    def cached?
+      return false if @skip_cache
+      Rails.cache.exist?(cache_identifier)
+    end
+
     private
+    def allowed_tag_attributes
+      %w(style href title src alt width height class target)
+    end
 
     # Todo: Transfer to helper utils
     def api_root_url
@@ -99,15 +111,10 @@ 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 cached?
-      return false if @skip_cache
-      Rails.cache.exist?(cache_identifier)
-    end
-
     def query_params
       the_params = { 'project_id' => project_id }
       the_params['branch_id'] = branch_id if branch_id.present?
@@ -116,14 +123,15 @@ module Editmode
     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
 
       if !cached? && !response_received
-        raise no_response_received(identifier)
+        message = http_response.try(:[], 'message') || no_response_received(identifier)
+
+        raise message
       else
         Rails.cache.write(cache_identifier, http_response.to_json) if http_response.present?
         cached_response = Rails.cache.fetch(cache_identifier)
@@ -141,5 +149,8 @@ module Editmode
       @branch_id = response['branch_id']
     end
 
+    def no_response_received(id = "")
+      "Sorry, we can't find a chunk using this identifier: \"#{id}\". This can happen if you've deleted a chunk on editmode.com or if your local cache is out of date. If it persists, try running Rails.cache clear."
+    end
   end
 end

data/lib/editmode/engine.rb

@@ -1,4 +1,5 @@
-require 'editmode/chunk_value'
+require 'rails/engine'
+require 'action_controller'
 require 'editmode/helper'
 
 module Editmode

data/lib/editmode/helper.rb

@@ -12,7 +12,7 @@ module Editmode
           chunk.content
         end 
       rescue => er
-        puts er
+        Rails.logger.info "#{er}: We can't render content for #{identifier}"
       end
     end
 

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/railtie.rb

@@ -1,3 +1,4 @@
+require 'rails/railtie'
 module Editmode
   class Railtie < Rails::Railtie
     initializer "editmode" do |app|

data/lib/editmode/version.rb

@@ -1,3 +1,3 @@
 module Editmode
-  VERSION = "1.2.8"
+  VERSION = "1.3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: editmode
 version: !ruby/object:Gem::Version
-  version: 1.2.8
+  version: 1.3.3
 platform: ruby
 authors:
 - Tony Ennis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-29 00:00:00.000000000 Z
+date: 2021-02-05 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
@@ -109,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.2.4
 signing_key:
 specification_version: 4
 summary: Editmode allows you to turn plain text in your rails app into easily inline-editable