renuo-cms-rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1cf6e98e641d7bf6fcaa1909862c6c76bad61b10
-  data.tar.gz: 6b1e0eab22ea12f2cc570a7ee0a13bb6ad58e506
+  metadata.gz: 3fda16518538093c40b2c44a78900bff6163220d
+  data.tar.gz: b309d93121355109393d8864cebfc9090410eaf6
 SHA512:
-  metadata.gz: d687588afffbfa05caaff48b1ba41beb1da919ddd0a57bae7707600a9f0e42a1afd4ae8619a3dddc3de0f72ff1b876ddf7b308e2163137ccd1cba56e9dc35ead
-  data.tar.gz: 7731659391360e60806d0985a7489a71bc00a07609de7bd3b5e7547c72cb4027a40029829153b634793aef3286b4059ac28845c4427fb4ca3b9485f8c724ae38
+  metadata.gz: a5f49188f3f8718b14255b86a8d3d76c1984a21f2af014ec7e6d756604ac67399a1312660933005c38385943f1243220631262783084506b17f7e33d70698530
+  data.tar.gz: a0bc61c75aa044511b5d8eada8e1c6828a4002cdf5c31cfdbf180e2d0c5ffeede9d3aa076fc5a8271cb9fc5d4dcd7bca3a780f9c3f39e8b3543bff77de940836

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Version 0.2.0
+
+* implement server side caching of cms contents
+
 ## Version 0.1.0
 
 * add https:// by default to api_host if no protocol is given

data/README.md

@@ -30,6 +30,14 @@ And then execute:
 bundle
 ```
 
+To use the JS client you need to include the following JS file in your project (please use the latest version, which can be found here: https://www.jsdelivr.com/projects/renuo-cms-client):
+
+```html
+<script src="https://cdn.jsdelivr.net/renuo-cms-client/XXX/renuo-cms-client.min.js" integrity="sha256-XXX" crossorigin="anonymous"></script>
+```
+
+Use a fixed version of the library so you are not affected by changes without testing them, and to have a consistent behavior for all users.
+
 ## Usage
 
 ### CMS Helper

data/lib/railtie.rb

@@ -1,6 +1,18 @@
 module Railtie
   class Railtie < Rails::Railtie
-    # initializer 'setup renuo cms' do
-    # end
+    initializer 'renuo_cms_rails' do |app|
+      app.config.after_initialize do
+        require 'benchmark'
+        require 'digest/sha1'
+
+        time = Benchmark.measure do
+          Rails.logger.info 'Initializing Renuo CMS Rails Cache...'
+          cache = RenuoCmsRails::Cache.initialize_cache
+          cache_details = "found #{cache.size} contents, sha1: #{Digest::SHA1.hexdigest(cache.to_s)}"
+          Rails.logger.info "CMS cache details: #{cache_details}"
+        end
+        Rails.logger.info "Done initializing Renuo CMS Rails Cache (#{time.real.round(3)}s)"
+      end
+    end
   end
 end

data/lib/renuo-cms-rails.rb

@@ -1,6 +1,9 @@
 require 'renuo_cms_rails/version'
 require 'renuo_cms_rails/config'
 require 'renuo_cms_rails/cms_helper'
+require 'renuo_cms_rails/api'
+require 'renuo_cms_rails/cache'
+require_relative 'railtie' if defined?(Rails::Railtie)
 
 ActiveSupport.on_load(:action_view) do
   include RenuoCmsRails::CmsHelper

data/lib/renuo_cms_rails/api.rb

@@ -0,0 +1,14 @@
+require_relative 'api/contents'
+
+module RenuoCmsRails
+  module API
+    # Fetches the contents from the API. It returns a hash where the key is the content_path and the value is the
+    # content string.
+    # @return [Hash<String, String>] the contents from the API
+    def fetch_contents
+      Contents.new(RenuoCmsRails.config).fetch
+    end
+
+    module_function :fetch_contents
+  end
+end

data/lib/renuo_cms_rails/api/contents.rb

@@ -0,0 +1,49 @@
+module RenuoCmsRails
+  module API
+    class Contents
+      MAX_CACHE_TTL = 60 * 2 # 2 minutes
+
+      # @param [RenuoCmsRails::Config] config
+      def initialize(config)
+        @config = config
+      end
+
+      def url
+        "#{@config.api_host_with_protocol}/v1/#{@config.api_key}/content_blocks?_=#{cache_time}"
+      end
+
+      # :reek:UtilityFunction
+      def cache_time
+        # note: using integer division for rounding, so that we get a new key every 2 minutes, e.g.
+        # part 1: 249 / 120 = 2 (not 2.075)
+        # part 2: 2 * 120 = 240
+        # all: (249 / 120) * 120 = 240
+        (Time.now.to_i / MAX_CACHE_TTL) * MAX_CACHE_TTL
+      end
+
+      def fetch
+        uri = URI(url)
+        Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+          request = Net::HTTP::Get.new uri
+          handle_response(http.request(request))
+        end
+      end
+
+      private
+
+      def handle_response(response)
+        return {} unless response.is_a?(Net::HTTPOK)
+        convert_json(response)
+      end
+
+      # :reek:UtilityFunction
+      def convert_json(response)
+        content_blocks_json = JSON.parse(response.body)['content_blocks']
+        return {} unless content_blocks_json
+        content_blocks_json.map { |block_json| [block_json['content_path'], block_json['content']] }.to_h
+      rescue JSON::ParserError
+        {}
+      end
+    end
+  end
+end

data/lib/renuo_cms_rails/cache.rb

@@ -0,0 +1,20 @@
+require_relative 'cache/cacher'
+
+module RenuoCmsRails
+  module Cache
+    @cache = Cacher.new(RenuoCmsRails::API)
+
+    attr_reader :cache
+
+    # Initializes the cache. This will connect via HTTPS to the configured CMS host, so make sure that the host is
+    # configured prior to calling this method.
+    delegate :initialize_cache, to: :cache
+
+    # Gets the content if the content with the content_path is in the cache, nil otherwise.
+    # @param [String] content_path
+    # @return [String]
+    delegate :get, to: :cache
+
+    module_function :cache, :get, :initialize_cache
+  end
+end

data/lib/renuo_cms_rails/cache/cacher.rb

@@ -0,0 +1,18 @@
+module RenuoCmsRails
+  module Cache
+    class Cacher
+      def initialize(api)
+        @api = api
+      end
+
+      def initialize_cache
+        @contents = @api.fetch_contents
+      end
+
+      def get(content_path)
+        return unless @contents
+        @contents[content_path]
+      end
+    end
+  end
+end

data/lib/renuo_cms_rails/cms_helper.rb

@@ -2,9 +2,11 @@ require 'action_view/helpers'
 
 module RenuoCmsRails
   module CmsHelper
-    def cms(path, default_value = nil, &block)
+    def cms(i18n_path, default_value = nil, &block)
+      path = i18n_path.tr('.', '-')
       content_path = RenuoCmsRails.config.content_path_generator.call(path)
-      default_translation = capture_default_value(path, default_value, &block)
+      cache = RenuoCmsRails::Cache.cache.get(content_path)
+      default_translation = cache&.html_safe || capture_default_value(path, i18n_path, default_value, &block)
       content_tag(:div, default_translation, data: cms_attributes(content_path))
     end
 
@@ -19,11 +21,11 @@ module RenuoCmsRails
       cms_attributes
     end
 
-    def capture_default_value(path, default_value)
+    def capture_default_value(_path, i18n_path, default_value)
       return default_value if default_value
       return capture { yield } if block_given?
 
-      I18n.t(path)
+      I18n.t(i18n_path)
     end
   end
 end

data/lib/renuo_cms_rails/version.rb

@@ -1,3 +1,3 @@
 module RenuoCmsRails
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/renuo_cms_rails.gemspec

@@ -31,4 +31,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'climate_control',  '>= 0.0.3'
   spec.add_development_dependency 'rubocop',          '>= 0.39.0'
   spec.add_development_dependency 'reek',             '>= 4.0.1'
+  spec.add_development_dependency 'timecop',          '>= 0.8.0'
+  spec.add_development_dependency 'webmock',          '>= 2.0.3'
 end

data/spec/renuo_cms_rails/api/contents_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+require 'timecop'
+
+describe RenuoCmsRails::API::Contents do
+  before do
+    config = RenuoCmsRails::Config.new
+    config.api_host = 'example.com'
+    config.api_key = 'somekey'
+    config.private_api_key = 'pk'
+    @contents_api = RenuoCmsRails::API::Contents.new(config)
+  end
+
+  describe '#build_url' do
+    it 'calculates the correct cache time' do
+      Timecop.freeze(Time.at(10).utc) { expect(@contents_api.cache_time).to eq(0) }
+      Timecop.freeze(Time.at(60).utc) { expect(@contents_api.cache_time).to eq(0) }
+      Timecop.freeze(Time.at(90).utc) { expect(@contents_api.cache_time).to eq(0) }
+      Timecop.freeze(Time.at(119).utc) { expect(@contents_api.cache_time).to eq(0) }
+      Timecop.freeze(Time.at(120).utc) { expect(@contents_api.cache_time).to eq(120) }
+      Timecop.freeze(Time.at(121).utc) { expect(@contents_api.cache_time).to eq(120) }
+      Timecop.freeze(Time.at(239).utc) { expect(@contents_api.cache_time).to eq(120) }
+      Timecop.freeze(Time.at(240).utc) { expect(@contents_api.cache_time).to eq(240) }
+      Timecop.freeze(Time.at(240).utc) { expect(@contents_api.cache_time).to eq(240) }
+      Timecop.freeze(Time.at(959).utc) { expect(@contents_api.cache_time).to eq(840) }
+      Timecop.freeze(Time.at(960).utc) { expect(@contents_api.cache_time).to eq(960) }
+      Timecop.freeze(Time.at(961).utc) { expect(@contents_api.cache_time).to eq(960) }
+    end
+
+    describe '#url' do
+      it 'builds the correct url' do
+        Timecop.freeze(Time.at(123).utc) do
+          url = 'https://example.com/v1/somekey/content_blocks?_=120'
+          expect(@contents_api.url).to eq(url)
+        end
+      end
+    end
+
+    describe '#fetch' do
+      def valid_api_response
+        time_json = '"updated_at":"2016-04-11T12:30:38.029Z","created_at":"2016-01-11T12:30:38.029Z"'
+        cb1 = "{\"content\":\"content1\",\"content_path\":\"path1\",\"api_key\":\"somekey\",#{time_json}}"
+        cb2 = "{\"content\":\"content2\",\"content_path\":\"path2\",\"api_key\":\"somekey\",#{time_json}}"
+        "{\"content_blocks\":[#{cb1}, #{cb2}]}"
+      end
+
+      def test_request(contents_api, api_response)
+        Timecop.freeze(Time.at(123).utc) do
+          stub_request(:get, contents_api.url).with(headers: { 'Host' => 'example.com' }).to_return(body: api_response)
+          return contents_api.fetch
+        end
+      end
+
+      it 'fetches the contents via HTTPS' do
+        contents = test_request(@contents_api, valid_api_response)
+        expect(contents['path1']).to eq('content1')
+        expect(contents['path2']).to eq('content2')
+        expect(contents['path3']).to eq(nil)
+      end
+
+      it 'fetches the contents via HTTP' do
+        config = RenuoCmsRails::Config.new
+        config.api_host = 'http://example.com'
+        config.api_key = 'somekey'
+        config.private_api_key = 'pk'
+        contents_api = RenuoCmsRails::API::Contents.new(config)
+        contents = test_request(contents_api, valid_api_response)
+        expect(contents['path1']).to eq('content1')
+        expect(contents['path2']).to eq('content2')
+        expect(contents['path3']).to eq(nil)
+      end
+
+      it 'returns an empty hash if the JSON is invalid' do
+        config = RenuoCmsRails::Config.new
+        config.api_host = 'http://example.com'
+        config.api_key = 'somekey'
+        config.private_api_key = 'pk'
+        contents_api = RenuoCmsRails::API::Contents.new(config)
+        expect(test_request(contents_api, '{{invalid json')).to eq({})
+      end
+
+      it 'returns an empty hash if the JSON is not complete' do
+        config = RenuoCmsRails::Config.new
+        config.api_host = 'http://example.com'
+        config.api_key = 'somekey'
+        config.private_api_key = 'pk'
+        contents_api = RenuoCmsRails::API::Contents.new(config)
+        expect(test_request(contents_api, '{"missing":"stuff"}')).to eq({})
+      end
+
+      it 'returns an empty hash if the API request was not successful' do
+        config = RenuoCmsRails::Config.new
+        config.api_host = 'http://example.com'
+        config.api_key = 'somekey'
+        config.private_api_key = 'pk'
+        contents_api = RenuoCmsRails::API::Contents.new(config)
+
+        Timecop.freeze(Time.at(123).utc) do
+          stub_request(:get, contents_api.url).with(headers: { 'Host' => 'example.com' }).to_return(
+            status: [500, 'Internal Server Error']
+          )
+          expect(contents_api.fetch).to eq({})
+        end
+      end
+    end
+  end
+end

data/spec/renuo_cms_rails/api_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe RenuoCmsRails::API do
+  describe '#fetch_contents' do
+    it 'loads the contents' do
+      RenuoCmsRails.reset
+      RenuoCmsRails.config.api_host = 'example.com'
+      RenuoCmsRails.config.api_key = 'apikey'
+      RenuoCmsRails.config.private_api_key = 'pk'
+
+      Timecop.freeze(Time.at(123).utc) do
+        stub_request(:get, 'https://example.com/v1/apikey/content_blocks?_=120').with(
+          headers: { 'Host' => 'example.com' }
+        ).to_return(body: { content_blocks: [{ content: 'somecontent', content_path: 'somepath' }] }.to_json)
+        contents = RenuoCmsRails::API.fetch_contents
+        expect(contents['somepath']).to eq('somecontent')
+      end
+    end
+  end
+end

data/spec/renuo_cms_rails/cache_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe RenuoCmsRails::Cache do
+  describe '#cache' do
+    it 'returns a cache instance' do
+      expect(described_class.cache).to be_a(RenuoCmsRails::Cache::Cacher)
+    end
+
+    it 'returns the same instance two times' do
+      expect(described_class.cache).to be(described_class.cache)
+    end
+  end
+
+  describe '#initialize_cache' do
+    it 'delegates the method call initialize_cache to the cacher' do
+      expect(described_class.cache).to receive(:initialize_cache)
+      described_class.initialize_cache
+    end
+  end
+
+  describe '#get' do
+    it 'delegates the method call get(key) to the cacher' do
+      expect(described_class.cache).to receive(:get).with('content.path')
+      described_class.get('content.path')
+    end
+  end
+end

data/spec/renuo_cms_rails/cacher/cacher_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe RenuoCmsRails::Cache::Cacher do
+  describe '#initialize_cache' do
+    it 'calls the api to initialize the cache' do
+      api = double(fetch_contents: 'contents')
+      cacher = described_class.new(api)
+      expect(api).to receive(:fetch_contents)
+      cacher.initialize_cache
+      expect(cacher.instance_variable_get('@contents')).to eq('contents')
+    end
+  end
+
+  describe '#get' do
+    it 'gets the cached content' do
+      cacher = described_class.new(nil)
+      cacher.instance_variable_set('@contents', 'a' => 'aa', 'b' => 'bb')
+      expect(cacher.get('a')).to eq('aa')
+      expect(cacher.get('b')).to eq('bb')
+      expect(cacher.get('c')).to eq(nil)
+    end
+
+    it 'gets returns nil if the cache is not initialized' do
+      cacher = described_class.new(nil)
+      expect(cacher.get('a')).to eq(nil)
+    end
+  end
+end

data/spec/renuo_cms_rails/cms_helper_spec.rb

@@ -17,7 +17,7 @@ describe RenuoCmsRails::CmsHelper do
 
     node = Capybara.string cms('some.content', 'Some CMS content')
     expect(node).to have_css('div', text: 'Some CMS content')
-    expect(node).to have_css("div[data-content-path='some.content-en']")
+    expect(node).to have_css("div[data-content-path='some-content-en']")
     expect(node).to have_css("div[data-api-host='https://some.host']")
     expect(node).to have_css("div[data-api-key='apikey']")
     expect(node).not_to have_css('div[data-private-api-key]')
@@ -28,34 +28,57 @@ describe RenuoCmsRails::CmsHelper do
 
     node = Capybara.string cms('some.content', 'Some CMS content')
     expect(node).to have_css('div', text: 'Some CMS content')
-    expect(node).to have_css("div[data-content-path='some.content-en']")
+    expect(node).to have_css("div[data-content-path='some-content-en']")
     expect(node).to have_css("div[data-api-host='https://some.host']")
     expect(node).to have_css("div[data-api-key='apikey']")
     expect(node).to have_css("div[data-private-api-key='pk']")
   end
+  describe '#capture_default_value' do
+    it 'captures a block' do
+      allow(self).to receive(:cms_admin?).and_return(false)
 
-  it 'captures a block' do
-    allow(self).to receive(:cms_admin?).and_return(false)
+      node = Capybara.string cms('some.content') { content_tag('p', 'Block content!') }
+      expect(node).not_to have_css('div', text: 'Some CMS content')
+      expect(node).to have_css('div p', text: 'Block content!')
+      expect(node).to have_css("div[data-content-path='some-content-en']")
+      expect(node).to have_css("div[data-api-host='https://some.host']")
+      expect(node).to have_css("div[data-api-key='apikey']")
+      expect(node).not_to have_css('div[data-private-api-key]')
+    end
 
-    node = Capybara.string cms('some.content') { content_tag('p', 'Block content!') }
-    expect(node).not_to have_css('div', text: 'Some CMS content')
-    expect(node).to have_css('div p', text: 'Block content!')
-    expect(node).to have_css("div[data-content-path='some.content-en']")
-    expect(node).to have_css("div[data-api-host='https://some.host']")
-    expect(node).to have_css("div[data-api-key='apikey']")
-    expect(node).not_to have_css('div[data-private-api-key]')
-  end
+    it 'translates a key as content' do
+      allow(self).to receive(:cms_admin?).and_return(false)
 
-  it 'translates a key as content' do
-    allow(self).to receive(:cms_admin?).and_return(false)
+      I18n.backend.store_translations :en, some: { content: 'I18n.t content!' }
+      node = Capybara.string cms('some.content')
+      expect(node).to have_css('div', text: 'I18n.t content!')
+      expect(node).to have_css("div[data-content-path='some-content-en']")
+      expect(node).to have_css("div[data-api-host='https://some.host']")
+      expect(node).to have_css("div[data-api-key='apikey']")
+      expect(node).not_to have_css('div[data-private-api-key]')
+    end
 
-    I18n.backend.store_translations :en, some: { content: 'I18n.t content!' }
-    node = Capybara.string cms('some.content')
-    expect(node).to have_css('div', text: 'I18n.t content!')
-    expect(node).to have_css("div[data-content-path='some.content-en']")
-    expect(node).to have_css("div[data-api-host='https://some.host']")
-    expect(node).to have_css("div[data-api-key='apikey']")
-    expect(node).not_to have_css('div[data-private-api-key]')
+    it 'uses the cache as prio 1' do
+      allow(self).to receive(:cms_admin?).and_return(false)
+
+      original = RenuoCmsRails::Cache.instance_variable_get('@cache')
+      expect(original).to receive(:get).with('some-content-en').and_return('Cached content!')
+      node1 = Capybara.string cms('some.content')
+      expect(node1).to have_css('div', text: 'Cached content!')
+
+      expect(original).to receive(:get).with('some-content-en').and_return('Cached content!')
+      node2 = Capybara.string cms('some.content') { content_tag('p', 'Block content!') }
+      expect(node2).to have_css('div', text: 'Cached content!')
+
+      expect(original).to receive(:get).with('some-content-en').and_return('Cached content!')
+      I18n.backend.store_translations :en, some: { content: 'I18n.t content!' }
+      node3 = Capybara.string cms('some.content')
+      expect(node3).to have_css('div', text: 'Cached content!')
+
+      expect(original).to receive(:get).with('some-content-en').and_return('Cached content!')
+      node4 = Capybara.string cms('some.content', 'default content')
+      expect(node4).to have_css('div', text: 'Cached content!')
+    end
   end
 
   it 'uses the custom content_path_generator config' do
@@ -64,6 +87,6 @@ describe RenuoCmsRails::CmsHelper do
     RenuoCmsRails.config.content_path_generator = ->(path) { "#{I18n.locale}--#{path}" }
 
     node = Capybara.string cms('some.content', 'Some CMS content')
-    expect(node).to have_css("div[data-content-path='en--some.content']")
+    expect(node).to have_css("div[data-content-path='en--some-content']")
   end
 end

data/spec/spec_helper.rb

@@ -2,3 +2,4 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 require 'renuo-cms-rails'
 require 'capybara'
 require 'climate_control'
+require 'webmock/rspec'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: renuo-cms-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Lukas Elmer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-25 00:00:00.000000000 Z
+date: 2016-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -164,6 +164,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.1
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.3
 description: The Renuo CLI automates some commonly used workflows by providing a command
   line interface.
 email:
@@ -186,10 +214,18 @@ files:
 - Rakefile
 - lib/railtie.rb
 - lib/renuo-cms-rails.rb
+- lib/renuo_cms_rails/api.rb
+- lib/renuo_cms_rails/api/contents.rb
+- lib/renuo_cms_rails/cache.rb
+- lib/renuo_cms_rails/cache/cacher.rb
 - lib/renuo_cms_rails/cms_helper.rb
 - lib/renuo_cms_rails/config.rb
 - lib/renuo_cms_rails/version.rb
 - renuo_cms_rails.gemspec
+- spec/renuo_cms_rails/api/contents_spec.rb
+- spec/renuo_cms_rails/api_spec.rb
+- spec/renuo_cms_rails/cache_spec.rb
+- spec/renuo_cms_rails/cacher/cacher_spec.rb
 - spec/renuo_cms_rails/cms_helper_spec.rb
 - spec/renuo_cms_rails/config_spec.rb
 - spec/spec_helper.rb
@@ -219,6 +255,10 @@ signing_key:
 specification_version: 4
 summary: Rails helpers for the renuo-cms
 test_files:
+- spec/renuo_cms_rails/api/contents_spec.rb
+- spec/renuo_cms_rails/api_spec.rb
+- spec/renuo_cms_rails/cache_spec.rb
+- spec/renuo_cms_rails/cacher/cacher_spec.rb
 - spec/renuo_cms_rails/cms_helper_spec.rb
 - spec/renuo_cms_rails/config_spec.rb
 - spec/spec_helper.rb