editmode 0.0.9.112 → 0.0.10.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c06ee068c329efaa3dba8ccf03bc2c83cf32d6ef753cacd87b2b0d8117ae7a9f
-  data.tar.gz: c9433d98aff266e7f16bfeacf7ece3fd03bd373159aac702868f2231d392696c
+  metadata.gz: feb3922328fd985e4aec3156ba98021dbd194c3fdf58a9b51b63de2b7f7dc535
+  data.tar.gz: f52847ef24647300e4bde80f71a90f557e67e7caa40b55ded07fe1276ca759e2
 SHA512:
-  metadata.gz: fcee3061b99a16e7d7a6c172899b15d271ccd27e97c0c09eec240d6922a67be01a2d8845940ca30d78b3538fc585178c6ea9b7b523cf4373e3f273cbb7e9cf6d
-  data.tar.gz: b91a78c606b9579fec2388fe9e5b21cbd6fa5fe01e8d509b7090700f88f31a615b57edf41061abe2bd56f739e6c959eace3872a712b20b4fe5f4f408d3ec440e
+  metadata.gz: 573b7952ccdb805057e3cdeffe11f9d19af12fc578d166916a95f14e0d3508b868b8c4f37348a2550bc1563abba2bd218b53d416f628c9422a19db6c08e656c2
+  data.tar.gz: 3a690c5d2a0427596f29fdf1154f1715da067611c27ad95dbe86a8ef4c5a296e5cbc6c96e170ce0442f9f32c9fea835233ab276a5cc28be98e7f7caa2e84c8ee

data/app/controllers/editmode_controller.rb

@@ -4,6 +4,10 @@ class EditmodeController < ApplicationController
     if params[:full]
       Rails.cache.clear
       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("chunk_#{params[:identifier]}")
       Rails.cache.delete("chunk_#{params[:identifier]}_type")

data/lib/editmode.rb

@@ -1,14 +1,16 @@
 require "active_support/dependencies"
-require "editmode-rails/version"
-require 'editmode-rails/script_tag'
-require 'editmode-rails/action_view_extensions/editmode_helper'
-require 'editmode-rails/auto_include_filter'
-require 'editmode-rails/railtie' if defined? Rails
-require 'editmode-rails/engine' if defined?(Rails)
-
-class Editmode
+require "editmode/version"
+require 'editmode/script_tag'
+require 'editmode/action_view_extensions/editmode_helper'
+require 'editmode/auto_include_filter'
+require 'editmode/chunk_value'
+require 'editmode/railtie' if defined? Rails
+require 'editmode/engine' if defined?(Rails)
+# Todo: Implement RSPEC
+module Editmode
   class << self
-    include ::EditModeRails::ActionViewExtensions::EditModeHelper
+    include Editmode::ActionViewExtensions::EditmodeHelper
+
     def project_id=(id)
       config.project_id = id
     end
@@ -22,8 +24,6 @@ class Editmode
     end
 
     def config
-      # Todo: Instantiate in editmode initializer or base controllers
-      # Todo: Add a generator to create initializer an file? 
       @config ||= Configuration.new
     end
 
@@ -32,36 +32,22 @@ class Editmode
     end
 
     def chunk_value(identifier, **options)
-      body = options[:values].presence || {}
-      field_id = options[:field_id].presence
-      branch_id = options[:branch_id].presence
-
-      branch_params = branch_id.present? ? "branch_id=#{branch_id}" : ""
-      cache_identifier = "chunk_#{identifier}#{branch_id}"
-      url = "#{api_root_url}/chunks/#{identifier}?#{branch_params}"
-
       begin
-        response = HTTParty.get(url, query: body)
-        response_received = true if response.code == 200
-
-        if !response_received
-          raise "No response received"
-        else
-          if field_id.present?
-            chunk = response["content"].detect {|f| f["custom_field_identifier"] == field_id }
-            chunk['content']
-          else
-            response['content']
-          end
-        end
-      rescue => error
-        # Todo: Send a log to editmode prob like sentry
-        return "No response received"
+        options.merge!(project_id: project_id)
+        Editmode::ChunkValue.new(identifier, **options )
+      rescue => er
+        raise er
       end
     end
   end
 
   class Configuration
-    attr_accessor :project_id, :access_token
+    attr_accessor :access_token, :variable
+    attr_reader :project_id
+
+    def project_id=(id)
+      @project_id = id
+
+    end
   end
 end

data/lib/{editmode-rails → editmode}/action_view_extensions/editmode_helper.rb

@@ -1,6 +1,6 @@
-module EditModeRails
+module Editmode
   module ActionViewExtensions
-    module EditModeHelper
+    module EditmodeHelper
 
       require 'httparty'
 
@@ -12,13 +12,29 @@ module EditModeRails
         ENV["EDITMODE_OVERRIDE_API_URL"] || "https://api.editmode.com"
       end
 
-      def chunk_collection(collection_identifier,has_tags=[])
+      def chunk_collection(collection_identifier, **options)
         branch_params = params[:em_branch_id].present? ? "branch_id=#{params[:em_branch_id]}" : ""
+        branch_id = params[:em_branch_id].presence
+        tags = options[:tags].presence || []
+        limit = options[:limit].presence
+
         begin 
-          url = "#{api_root_url}/chunks?collection_identifier=#{collection_identifier}&#{branch_params}"
+          url_params = { 
+            :collection_identifier => collection_identifier,
+            :branch_id => branch_id,
+            :limit => limit,
+            :tags => tags
+          }.to_query
+
+          url = URI(api_root_url)
+          url.path = '/chunks'
+          url.query = url_params
+
           response = HTTParty.get(url)
+
           raise "No response received" unless response.code == 200
           chunks = response["chunks"]
+
           return chunks
         rescue => error
           puts error 
@@ -53,7 +69,7 @@ module EditModeRails
           # Always sanitize the content!!
           chunk_content = ActionController::Base.helpers.sanitize(chunk_content)
           
-          css_class = options[:css_class]
+          css_class = options[:class]
 
           if chunk_type == "image"
             display_type = "image"
@@ -133,6 +149,28 @@ module EditModeRails
 
       alias_method :chunk, :chunk_display
 
+      def variable_parse!(content, variables, values)
+        tokens = content.scan(/\{{(.*?)\}}/)
+        if tokens.any?
+          tokens.flatten! 
+          tokens.each do |token|
+            token_value = values[token.to_sym] || variables[token] || ""
+            sanitized_value = ActionController::Base.helpers.sanitize(token_value)
+
+            content.gsub!("{{#{token}}}", sanitized_value)
+          end
+        end
+
+        content
+      end
+
+      def no_response_received(id = "")
+        "Sorry, we can't find a content using this identifier: \"#{id}\""
+      end
+      
+      def require_field_id
+        "Field ID or Field Name is required to retrieve a collection item"
+      end
     end
   end
 end

data/lib/{editmode-rails → editmode}/auto_include_filter.rb

@@ -1,10 +1,10 @@
-module EditModeRails
+module Editmode
 
   module AutoInclude
 
     module Method
       def editmode_auto_include
-        EditModeRails::AutoInclude::Filter.filter(self)
+        Editmode::AutoInclude::Filter.filter(self)
       end
     end
 
@@ -49,7 +49,7 @@ module EditModeRails
       end
 
       def editmode_script_tag
-        @script_tag ||= EditModeRails::ScriptTag.new()
+        @script_tag ||= Editmode::ScriptTag.new()
       end
 
       def enabled_for_environment?

data/lib/editmode/chunk_value.rb

@@ -0,0 +1,71 @@
+module Editmode
+  class ChunkValue
+    include Editmode::ActionViewExtensions::EditmodeHelper
+
+    attr_accessor :identifier, :variable_values, :branch_id, 
+                  :variable_fallbacks, :chunk_type, :project_id, 
+                  :content
+
+    def initialize(identifier, **options)
+      @identifier = identifier
+      @branch_id = options[:branch_id].presence
+      @project_id = options[:project_id].presence
+      @variable_values = options[:values].presence || {}
+      get_content
+    end
+
+    def field(field = nil)
+      # Field ID can be a slug or field_name
+      if chunk_type == 'collection_item'
+        if field.present?
+          field_content = content.detect {|f| f["custom_field_identifier"] == field || f["custom_field_name"] == field }
+          if field_content.present?
+            result = field_content['content']
+            result = variable_parse!(result, variable_fallbacks, variable_values)
+          else
+            raise no_response_received(field)
+          end
+        else
+          raise require_field_id
+        end
+      else
+        raise "undefined method field for chunk_type: #{chunk_type}"
+      end
+      result ||= content
+    end
+
+    private
+    def get_content
+      branch_params = branch_id.present? ? "branch_id=#{branch_id}" : ""
+      url = "#{api_root_url}/chunks/#{identifier}?#{branch_params}"
+
+      cache_identifier = "chunk_#{identifier}#{branch_id}"
+      cached_content_present = Rails.cache.exist?(cache_identifier)
+      cached_content_present = Rails.cache.exist?("chunk_#{project_id}_variables") if cached_content_present
+
+      if !cached_content_present
+        response = HTTParty.get(url)
+        response_received = true if response.code == 200
+      end
+
+      if !cached_content_present && !response_received
+        raise no_response_received(identifier)
+      else
+        @content = Rails.cache.fetch(cache_identifier) do
+          response['content']
+        end
+
+        @chunk_type = Rails.cache.fetch("#{cache_identifier}_type") do
+          response['chunk_type']
+        end
+
+        # Since variables are defined in the project level,
+        # We use project_id as cache identifier
+        @variable_fallbacks = Rails.cache.fetch("chunk_#{project_id}_variables") do
+          response['variable_fallbacks']
+        end
+      end      
+    end
+
+  end
+end

data/lib/{editmode-rails → editmode}/engine.rb

@@ -1,4 +1,4 @@
-module EditMode
+module Editmode
 
   class Engine < Rails::Engine
 

data/lib/{editmode-rails → editmode}/railtie.rb

@@ -1,9 +1,9 @@
-module EditModeRails
+module Editmode
   class Railtie < Rails::Railtie
-    initializer "editmode-rails" do |app|
+    initializer "editmode" do |app|
 
       ActiveSupport.on_load :action_view do
-        include EditModeRails::ActionViewExtensions::EditModeHelper
+        include Editmode::ActionViewExtensions::EditmodeHelper
       end
       ActiveSupport.on_load :action_controller do
         include AutoInclude::Method

data/lib/{editmode-rails → editmode}/script_tag.rb

@@ -1,4 +1,4 @@
-module EditModeRails
+module Editmode
 
   class ScriptTag
 

data/lib/editmode/version.rb

@@ -0,0 +1,3 @@
+module Editmode
+  VERSION = "0.0.10.15"
+end

data/lib/generators/editmode/config_generator.rb

@@ -0,0 +1,26 @@
+
+require 'rails/generators/base'
+
+module Editmode
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      argument :project_id, :desc => "Your Editmode project_id, which can be found here: https://www.editmode.com/projects"
+
+      def create_config_file
+        @project_id = project_id
+        
+        introduction = <<-intro
+Editmode will automatically insert its javascript before the closing '</body>'
+tag on every page.
+
+        intro
+
+        print "#{introduction} "
+
+        template "editmode.rb.erb", "config/initializers/editmode.rb"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+Editmode.setup do |config|
+  # Replace TodoProjectId with your Editmode Project ID, 
+  # visit https://editmode.com/projects
+  config.project_id = "<%= @project_id %>"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: editmode
 version: !ruby/object:Gem::Version
-  version: 0.0.9.112
+  version: 0.0.10.15
 platform: ruby
 authors:
 - Tony Ennis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-19 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,13 +79,16 @@ files:
 - Rakefile
 - app/controllers/editmode_controller.rb
 - config/routes.rb
-- lib/editmode-rails/action_view_extensions/editmode_helper.rb
-- lib/editmode-rails/auto_include_filter.rb
-- lib/editmode-rails/engine.rb
-- lib/editmode-rails/railtie.rb
-- lib/editmode-rails/script_tag.rb
-- lib/editmode-rails/version.rb
 - lib/editmode.rb
+- lib/editmode/action_view_extensions/editmode_helper.rb
+- lib/editmode/auto_include_filter.rb
+- lib/editmode/chunk_value.rb
+- lib/editmode/engine.rb
+- lib/editmode/railtie.rb
+- lib/editmode/script_tag.rb
+- lib/editmode/version.rb
+- lib/generators/editmode/config_generator.rb
+- lib/generators/editmode/templates/editmode.rb.erb
 homepage: https://github.com/tonyennis145/editmode-rails
 licenses:
 - MIT

data/lib/editmode-rails/version.rb

@@ -1,3 +0,0 @@
-module EditModeRails
-  VERSION = "0.0.9.112"
-end