boxcab-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7bb546180b2ade0bdc43204aed2628ff2d32bb1a
+  data.tar.gz: c9fc6b6ea7546deb03e63201b30526caf2f51ac6
+SHA512:
+  metadata.gz: e8bc2d7d4e8fc9a618bf8137548c9e8971ef01ed6f6d6bfdf321b225148f7a1ae8e44078db2f91e0ed756e2035a4ef18501d93f3ac9f5f19d6d907564e47ab68
+  data.tar.gz: 2c2e90cf0747ea3a4764924b627715e29d7f650e011c61242c222fa2f4242f0c520d33822052360998219e904401afe4befbe860cc99c6823ea69e7f8c02ecf1

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/spec/sample/db/*.sqlite3
+/spec/sample/db/*.sqlite3-journal
+/spec/sample/db/log/*.log
+/spec/sample/log/
+/spec/sample/tmp/
+/spec/sample/.sass-cache

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.0.0.1'
+gem 'dotenv-rails'
+gem 'rspec-rails'
+gem 'webmock', '~> 2.1.0'
+gem 'vcr', '~> 3.0.3'
+
+# Specify your gem's dependencies in boxcab-rails.gemspec
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 did
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# Boxcab for Ruby on Rails applications
+
+Boxcab is an easy to use CMS for applications hosted on **Heroku**. It allows non-tech people to edit the content of static pages through a nice UI.
+See it as [PerchCMS](http://grabaperch.com) for Heroku applications.
+
+There is nothing to host, no migration to run. It works with Rails 3, Rails 4 and Rails 5.
+
+## What are static pages?
+
+Usually we're talking about the "about us", "our team", contact us", etc. pages in your Rails application. In some cases, we can extend this definition to the index page.
+
+There are many ways to handle them. You can either roll your own system like described in this article [http://blog.teamtreehouse.com/static-pages-ruby-rails](http://blog.teamtreehouse.com/static-pages-ruby-rails) or use a gem like [HighVoltage](https://github.com/thoughtbot/high_voltage).
+
+The awesome thing is that Boxcab is pretty agnostic about your system.
+
+## Requirements ##
+
+Your application has to run on Heroku. Besides, you have to add the **Boxcab** add-on.
+
+```
+heroku addons:create boxcab
+```
+
+## Installation
+
+Follow the [instructions here]([Heroku documentation](https://devcenter.heroku.com/articles/boxcab#ruby-on-rails-installation).
+
+## Usage
+
+Please visit our documentation site: [http://www.boxcab.io/pages/documentation/usage](http://www.boxcab.io/pages/documentation/usage).
+
+## FAQ
+
+[http://www.boxcab.io/pages/faq](http://www.boxcab.io/pages/faq).
+
+## Development
+
+After checking out the repo, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/locomotivecms-enterprise-public/boxcab-rails.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "boxcab/rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/boxcab-rails.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'boxcab/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "boxcab-rails"
+  spec.version       = Boxcab::VERSION
+  spec.authors       = ['did']
+  spec.email         = ['didier@nocoffee.fr']
+
+  spec.summary       = %q{Boxcab is an easy to use CMS for applications hosted on Heroku}
+  spec.description   = %q{Boxcab Rails is the Ruby on Rails version of PerchCMS}
+  spec.homepage      = "http://boxcab.io"
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'httparty', '~> 0.14.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'coffee-rails', '~> 4.2.1'
+end

data/lib/boxcab-rails.rb

@@ -0,0 +1 @@
+require_relative 'boxcab_rails'

data/lib/boxcab/action_controller/controller.rb

@@ -0,0 +1,62 @@
+module Boxcab
+  module ActionController
+    module Controller
+
+      extend ActiveSupport::Concern
+
+      ALLOW_FROM = %(nossl-editor.boxcab.io editor.boxcab.io editor.boxcab.dev:5000)
+
+      included do
+
+        before_action :allow_boxcab_iframe
+
+      end
+
+      private
+
+      def allow_boxcab_iframe
+        if request.env['HTTP_USER_AGENT'] =~ /MSIE/
+          response.headers['X-Frame-Options'] = "ALLOW-FROM #{ALLOW_FROM}"
+        else
+          response.headers.delete 'X-Frame-Options'
+          response.headers['Content-Security-Policy'] = "frame-ancestors #{ALLOW_FROM}"
+        end
+      end
+
+      module ClassMethods
+
+        def boxcab_pages_here(only: nil)
+          include Content
+          around_action :wrap_boxcab_page, only: only
+        end
+
+      end
+
+      module Content
+
+        extend ActiveSupport::Concern
+
+        private
+
+        def wrap_boxcab_page
+          @boxcab_page = boxcab_service.find_or_build(request.original_url, params[:boxcab_content])
+
+          yield.tap do
+            case boxcab_service.save(@boxcab_page)
+            when :success   then Rails.logger.info("[Boxcab] the page was saved")
+            when :fail      then Rails.logger.error("[Boxcab] the page was not saved. Please email us at support@boxcab.io")
+            when :unchanged then Rails.logger.info("[Boxcab] the page was not saved because of an unchanged schema")
+            else
+              Rails.logger.info "[Boxcab] the page was not saved because of the live preview mode or not in production"
+            end
+          end
+        end
+
+        def boxcab_service
+          @boxcab_service ||= Boxcab::PageService.new($boxcab_api, Rails.env.production? || ENV['BOXCAB_BASE_URI'].present?)
+        end
+
+      end
+    end
+  end
+end

data/lib/boxcab/action_view/helpers.rb

@@ -0,0 +1,120 @@
+module Boxcab
+  module ActionView
+    module Helpers
+
+      BOXCAB_CONTENT_TYPES = %(string text markdown image list)
+
+      def boxcab_page(attributes)
+        _boxcab_page.attributes = attributes.slice(:title, :position)
+        ''
+      end
+
+      def boxcab_content(name, options = {}, &block)
+        definition = { name: name.to_s, type: 'string' }.with_indifferent_access.merge(options)
+
+        # do not store symbols
+        definition[:type] = definition[:type].to_s
+
+        value = (@boxcab_nested_content || _boxcab_page.content)[name]
+
+        if BOXCAB_CONTENT_TYPES.include?(definition[:type])
+          send(:"_boxcab_#{definition[:type]}", value, definition, &block).tap do
+            _boxcab_append_definition(definition)
+          end
+        else
+          raise "[Boxcab helper] Unknown type: #{definition[:type]}"
+        end
+      end
+
+      def _boxcab_list(value, definition, &block)
+        raise 'Too many nested lists' if @boxcab_nested_schema.present?
+        raise 'You need to pass a template to your list type' unless block_given?
+
+        # look for nested schema
+        nested_schema = _boxcab_look_for_schema(&block)
+
+        definition[:fields] = nested_schema
+
+        # no need to look for definition for each item of the list
+        @boxcab_no_schema = true
+
+        # render list
+        if value
+          _boxcab_list_map(value.sort { |a, b| a['_position'] <=> b['_position'] }, &block)
+        elsif definition[:default].is_a?(Integer)
+          _boxcab_list_map(definition[:default].times, &block)
+        else
+          ''
+        end.tap do
+          @boxcab_no_schema = false
+        end
+      end
+
+      def _boxcab_list_map(collection, &block)
+        iterator = BoxcabViewListIterator.new(collection.size)
+
+        collection.each_with_index.map do |content, index|
+          @boxcab_nested_content = content.is_a?(Hash) ? content : {}
+          capture(iterator.change(index), &block)
+        end.tap do
+          @boxcab_nested_content = nil
+        end.join("\n").html_safe
+      end
+
+      def _boxcab_look_for_schema(&block)
+        @boxcab_nested_schema = []
+        capture(BoxcabViewListIterator.new, &block) # don't want to display it
+        @boxcab_nested_schema.tap { @boxcab_nested_schema = nil }
+      end
+
+      def _boxcab_string(value, definition, &block)
+        definition[:default] = capture(&block) if block_given?
+
+        (value || definition[:default] || '').html_safe
+      end
+
+      alias _boxcab_text      _boxcab_string
+      alias _boxcab_markdown  _boxcab_string
+      alias _boxcab_image     _boxcab_string
+
+      def _boxcab_page
+        @boxcab_page
+      end
+
+      def _boxcab_append_definition(definition)
+        return if @boxcab_no_schema
+
+        schema = @boxcab_nested_schema || _boxcab_page.schema
+        schema << definition
+      end
+
+      class BoxcabViewListIterator
+
+        attr_reader :index, :size
+
+        def initialize(size = 0, index = 0)
+          @size, @index = size, index
+        end
+
+        def first?
+          @index == 0
+        end
+
+        def last?
+          @index == @size - 1
+        end
+
+        def every?(n)
+          !first? && !last? && ((@index + 1) % n) == 0
+        end
+
+        def change(index)
+          @index = index
+          self
+        end
+
+      end
+
+    end
+  end
+end

data/lib/boxcab/api.rb

@@ -0,0 +1,57 @@
+require 'httparty'
+
+module Boxcab
+  class API
+
+    include HTTParty
+
+    def initialize(base_uri, site_handle, api_key)
+      @site_handle = site_handle
+      @options = {
+        base_uri: base_uri,
+        headers: {
+          'x-boxcab-site-handle'  => site_handle,
+          'x-boxcab-api-key'      => api_key
+        }
+      }
+    end
+
+    def find(id)
+      _options = @options.slice(:base_uri)
+
+      response = self.class.get("/api/v1/public/#{@site_handle}/pages/#{id}.json", _options)
+
+      response.success? ? response.parsed_response : nil
+    end
+
+    def update_site(attributes)
+      _attributes = attributes.slice(:name, :base_url)
+
+      response = self.class.put("/api/v1/site.json", @options.merge(body: {
+        site: _attributes
+      }))
+
+      response.success?
+    end
+
+    def create(attributes)
+      response = self.class.post('/api/v1/pages.json', @options.merge(body: {
+        page: attributes
+      }))
+
+      response.success? ? response.parsed_response : nil
+    end
+
+    def update(id, attributes)
+      _attributes = attributes.slice('title', 'url', 'schema', 'position')
+      _attributes['schema']   = _attributes['schema'].to_json
+
+      response = self.class.put("/api/v1/pages/#{id}.json", @options.merge(body: {
+        page: _attributes
+      }))
+
+      response.success?
+    end
+
+  end
+end

data/lib/boxcab/assets/javascripts/boxcab.coffee

@@ -0,0 +1,125 @@
+(->
+
+  modifiedContent = false
+
+  inIframe = ->
+    try window.self != window.top catch e then true
+
+  turbolinksEnabled = ->
+    typeof(Turbolinks) != 'undefined'
+
+  turbolinksEventNames = ->
+    if typeof(Turbolinks.controller) != 'undefined'
+      # Turbolinks 5
+      { load: 'turbolinks:load', 'before': 'turbolinks:before-visit' }
+    else
+      # Turbolinks classic
+      { load: 'page:load', 'before': 'page:before-change' }
+
+  pathname = (url) ->
+    parser = document.createElement('a')
+    parser.href = url
+    parser.pathname
+
+  cleanPath = (path) -> if path == '/index' then '/' else path
+
+  leaveMessage = -> "If you leave before saving, your changes will be lost"
+
+  previewContent = (content) ->
+    modifiedContent = true
+    _previewContent content, (html) ->
+      doc = document.documentElement.cloneNode()
+      doc.innerHTML = html
+      _html = doc.querySelector('body').innerHTML
+      document.body.innerHTML = _html;
+      document.dispatchEvent(new Event('boxcab:refresh'))
+
+  _previewContent = (content, callback) ->
+    path = '/_boxcab' + window.location.pathname
+
+    xhr = new XMLHttpRequest()
+    xhr.open 'PUT', path
+    xhr.setRequestHeader 'Content-Type', 'application/x-www-form-urlencoded'
+    xhr.setRequestHeader 'Accept', 'text/html'
+    xhr.onload = ->
+      if xhr.status == 200
+        callback xhr.responseText
+      else
+        alert 'Application error. Check your site logs please.'
+
+    xhr.send "#{encodeURIComponent('boxcab_content')}=#{encodeURIComponent(content)}"
+
+  #
+  # Common
+  #
+  setup = ->
+    window.addEventListener 'message', (event) ->
+      switch event.data.type
+        when 'clean'    then modifiedContent = false
+        when 'refresh'  then previewContent(event.data.content)
+        when 'visit'    then modifiedContent = false
+        else null
+
+  #
+  # Vanilla
+  #
+  setupVanilla = ->
+    unloadTimeout = null
+
+    document.addEventListener 'DOMContentLoaded', (event) ->
+      path = window.location.pathname;
+      if path == '/' then path = '/index'
+      window.parent.postMessage({ type: 'pageLoaded', path: path }, '*')
+
+    window.onbeforeunload = (event) ->
+      if modifiedContent
+        (event || window.event).returnValue = leaveMessage() # //Gecko + IE
+        leaveMessage() # Gecko + Webkit, Safari, Chrome etc.
+      else
+        window.parent.postMessage({ type: 'changePage' }, '*')
+
+    window.addEventListener 'message', (event) ->
+      switch event.data.type
+        when 'visit' then window.location.href = cleanPath(event.data.path)
+        else null
+    , false
+
+  #
+  # Turbolinks (Classic and 5)
+  #
+  setupForTurbolinks = ->
+    currentPath     = null
+    eventNames      = turbolinksEventNames()
+
+    document.addEventListener eventNames.load, (event) ->
+      if currentPath == null then currentPath = window.location.pathname
+      if currentPath == '/' then currentPath = '/index'
+      window.parent.postMessage({ type: 'pageLoaded', path: currentPath }, '*')
+
+    document.addEventListener eventNames.before, (event) ->
+      if modifiedContent && !confirm(leaveMessage())
+        event.preventDefault()
+        return
+
+      modifiedContent = false
+      currentPath = pathname(event.data.url)
+      if currentPath == '/' then currentPath = '/index'
+      window.parent.postMessage({ type: 'changePage' }, '*')
+
+    window.addEventListener 'message', (event) ->
+      switch event.data.type
+        when 'clean'    then Turbolinks.clearCache()
+        when 'visit'    then Turbolinks.visit(currentPath = cleanPath(event.data.path))
+        else null
+    , false
+
+  if inIframe()
+    setup()
+
+    if turbolinksEnabled()
+      console.log('[Boxcab][Front] Set up Turbolinks')
+      setupForTurbolinks()
+    else
+      console.log('[Boxcab][Front] Set up Simple');
+      setupVanilla()
+)()

data/lib/boxcab/configuration.rb

@@ -0,0 +1,24 @@
+# FIXME (Did) Not used for now
+module Boxcab
+  class Configuration
+
+    attr_accessor :site_name
+    attr_accessor :base_url
+
+    def base_url=(value)
+      @base_url = (if value =~ /^[a-zA-Z0-9-]+$/
+        "https://#{value}.herokuapp.com"
+      else
+        value
+      end)
+    end
+
+    def to_site_attributes
+      {
+        name:     self.site_name,
+        base_url: self.base_url
+      }.delete_if { |k, v| v.blank? }
+    end
+
+  end
+end

data/lib/boxcab/page.rb

@@ -0,0 +1,69 @@
+module Boxcab
+
+  class Page
+
+    ATTRIBUTE_NAMES = %w(id title url path position schema content)
+
+    def initialize(attributes = {})
+      @attributes = {}.with_indifferent_access
+      @read_only  = false
+
+      unless attributes.blank?
+        @previous_attributes = attributes.with_indifferent_access
+        @attributes = @previous_attributes.with_indifferent_access
+      end
+
+      @attributes['content'] ||= {}
+
+      # new schema in any case
+      @attributes['schema'] = []
+    end
+
+    ATTRIBUTE_NAMES.each do |name|
+      define_method(name) { @attributes[name] }
+      define_method(:"#{name}=") { |value| @attributes[name] = value }
+    end
+
+    def attributes=(new_attributes)
+      @attributes.merge!(new_attributes)
+    end
+
+    def self.build_default(url, path)
+      new.tap do |page|
+        page.title  = path.split('/').last.humanize
+        page.url    = url
+        page.path   = path
+      end
+    end
+
+    def content=(content)
+      @read_only = true
+      @attributes['content'] = content
+    end
+
+    # only called before an existing page is going to be updated
+    def changed?
+      return true if @attributes.slice(:title, :position) != @previous_attributes.slice(:title, :position)
+
+      @attributes[:schema] != @previous_attributes[:schema]
+    end
+
+    def read_only?
+      @read_only
+    end
+
+    def persisted?
+      !self.id.nil?
+    end
+
+    def to_api
+      if persisted?
+        @attributes.slice(:title, :position, :schema)
+      else
+        @attributes.slice(:title, :url, :path, :position, :schema)
+      end
+    end
+
+  end
+
+end

data/lib/boxcab/page_middleware.rb

@@ -0,0 +1,49 @@
+module Boxcab
+
+  class PageMiddleware
+
+    BOXCAB_PATH       = /^\/_boxcab\/(.*)/o
+    BOXCAB_PARAM_NAME = 'boxcab_content'
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      dup._call(env)
+    end
+
+    def _call(env)
+      if env['PATH_INFO'] =~ BOXCAB_PATH
+        change_request(env, $1)
+        decode_content(env)
+      end
+
+      @app.call(env)
+    end
+
+    def change_request(env, path)
+      path = "/#{path}"
+      path = '/' if path == '/index'
+
+      env['REQUEST_METHOD']     = 'GET'
+      env['REQUEST_URI']        = path
+      env['PATH_INFO']          = path
+      env['ORIGINAL_FULLPATH']  = path
+    end
+
+    def decode_content(env)
+      request = Rack::Request.new(env)
+      content = request.params[BOXCAB_PARAM_NAME]
+
+      return if content.blank?
+
+      decoded   = Base64.decode64(content)
+      _content  = ActiveSupport::JSON.decode(URI.unescape(decoded))
+
+      request.update_param(BOXCAB_PARAM_NAME, _content)
+    end
+
+  end
+
+end

data/lib/boxcab/page_service.rb

@@ -0,0 +1,47 @@
+module Boxcab
+  class PageService
+
+    def initialize(api, production = true)
+      @api, @production = api, production
+    end
+
+    def find_or_build(url, content = nil)
+      path = extract_path(url)
+      page_id = Digest::MD5.hexdigest(path)
+
+      page = (if content.blank? && attributes = @api.find(page_id)
+        Boxcab::Page.new(attributes)
+      else
+        Boxcab::Page.build_default(url, path)
+      end)
+
+      page.content = content unless content.blank?
+
+      page
+    end
+
+    def save(page)
+      if !production? || page.read_only?
+        :skip
+      elsif page.persisted?
+        return :unchanged unless page.changed?
+        @api.update(page.id, page.to_api) ? :success : :fail
+      else
+        @api.create(page.to_api) ? :success : :fail
+      end
+    end
+
+    def production?
+      !!@production
+    end
+
+    private
+
+    def extract_path(url)
+      path = URI.parse(url).path
+      path = '/index' if path.blank? || path == '/'
+      path
+    end
+
+  end
+end

data/lib/boxcab/railtie.rb

@@ -0,0 +1,50 @@
+require 'rails/railtie'
+
+module Boxcab
+  class Railtie < ::Rails::Railtie
+
+    initializer 'boxcab.action_view' do |app|
+      ActiveSupport.on_load :action_view do
+        require 'boxcab/action_view/helpers'
+        include Boxcab::ActionView::Helpers
+      end
+    end
+
+    initializer 'boxcab.action_contoller' do |app|
+      ActiveSupport.on_load(:action_controller) do
+        require 'boxcab/action_controller/controller'
+        include Boxcab::ActionController::Controller
+      end
+    end
+
+    initializer 'boxcab.middlewares' do |app|
+      require 'boxcab/page_middleware'
+      app.config.middleware.insert_after ActionDispatch::Static, Boxcab::PageMiddleware
+    end
+
+    initializer 'boxcab.assets' do |app|
+      app.config.assets.paths << File.expand_path('../assets/javascripts', __FILE__)
+      app.config.assets.precompile += %w(boxcab.js)
+    end
+
+    initializer 'boxcab.load_api' do |app|
+      require 'boxcab/api'
+
+      if (site_handle = ENV['BOXCAB_SITE_HANDLE']).blank? || (api_key = ENV['BOXCAB_API_KEY']).blank?
+        abort '[Boxcab API] missing BOXCAB_SITE_HANDLE or/and BOXCAB_API_KEY env variables'
+      end
+
+      base_uri = ENV['BOXCAB_BASE_URI'] || 'https://editor.boxcab.io'
+
+      $boxcab_api = Boxcab::API.new(base_uri, site_handle, api_key)
+    end
+
+    config.to_prepare do
+      %w(high_voltage).each do |vendor|
+        path = "boxcab/vendor/#{vendor}"
+        Rails.application.config.cache_classes ? require(path) : load("#{path}.rb")
+      end
+    end
+
+  end
+end

data/lib/boxcab/vendor/high_voltage.rb

@@ -0,0 +1,6 @@
+begin
+  HighVoltage::PagesController.send(:boxcab_pages_here)
+  Rails.logger.info "[Boxcab] HighVoltage has been found!"
+rescue
+  # HighVoltage is not installed
+end

data/lib/boxcab/version.rb

@@ -0,0 +1,3 @@
+module Boxcab
+  VERSION = '0.1.0'
+end

data/lib/boxcab_rails.rb

@@ -0,0 +1,26 @@
+require 'boxcab/version'
+require 'boxcab/configuration'
+require 'boxcab/api'
+require 'boxcab/page'
+require 'boxcab/page_service'
+require 'boxcab/railtie' if defined?(Rails)
+
+module Boxcab
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+end

data/lib/generators/boxcab/install/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Install the Boxcab initializer
+
+Example:
+    rails generate install boxcab::install
+
+    This will create:
+        config/initializers/boxcab.rb
+

data/lib/generators/boxcab/install/install_generator.rb

@@ -0,0 +1,85 @@
+class Boxcab::InstallGenerator < Rails::Generators::Base
+
+  # source_root File.expand_path('../templates', __FILE__)
+
+  # FIXME (Did): disabled for now
+  # def copy_templates
+  #   template 'initializer.rb', 'config/initializers/boxcab.rb'
+  # end
+
+  def ask_for_site_attributes
+    print_title "Boxcab site configuration"
+  end
+
+  def ask_for_name
+    say <<-EOF
+You can change the name of your site which is displayed in the Boxcab editor.
+Leave it blank if you don't want to change it.
+
+EOF
+    @site_name = ask("What's its name?")
+  end
+
+  def ask_for_base_url
+    say <<-EOF
+
+For a smoother experience, Boxcab requires the base url (http or https + ://<your domain>) of your site in production
+OR if you don't have one yet your Heroku app name.
+
+EOF
+    @site_base_url = ask("What's your base url OR your Heroku app name?")
+  end
+
+  def update_site
+    attributes = {}
+    attributes[:name]     = @site_name unless @site_name.strip.blank?
+    attributes[:base_url] = @site_base_url unless @site_base_url.strip.blank?
+
+    if !attributes.blank? && $boxcab_api.update_site(attributes)
+      say "\n"
+      say "Your Boxcab site has been updated!", [:green, :on_black, :bold]
+    end
+  end
+
+  def print_asset_instruction
+    say "\n\n"
+
+    print_title "Boxcab JS lib installation"
+
+    say <<-EOF
+In order to enable the live editing functionality, you have to add our javascript lib.
+Add the following statement in your layout or your pages you want to edit before the </head> tag.
+
+ERB:
+  <%= javascript_include_tag 'boxcab' %>
+
+HAML/SLIM
+  = javascript_include_tag 'boxcab'
+
+
+    EOF
+  end
+
+  def print_next_instructions
+    print_title "Boxcab make pages editable"
+
+    say <<-EOF
+
+Please visit the following links for the next instructions:
+
+  - http://www.boxcab.io/pages/documentation/installation#setup-it
+  - http://www.boxcab.io/pages/documentation/usage
+
+
+EOF
+  end
+
+  private
+
+  def print_title(title)
+    @step = @step ? @step + 1 : 1
+    say "#{@step}. #{title}", [:white, :on_blue, :bold]
+    say ''
+  end
+
+end

data/lib/generators/boxcab/install/templates/initializer.rb

@@ -0,0 +1,24 @@
+# Boxcab configuration
+#
+# Once you've made a modification to this file, run:
+# $ rails boxcab:apply_configuration
+#
+# This will set the settings in production
+#
+
+Boxcab.configure do |config|
+
+  # In the Boxcab editor, name displayed at the top in the left sidebar.
+  # By default, the Heroku app name will be chosen.
+  # config.site_name = 'demo'
+
+  # Base url of your site when running on Heroku. You can either pass
+  # your Heroku app name OR the url if you attached a domain to your Heroku app.
+  #
+  # config.base_url = "my-awesome-site"
+  # or
+  # config.base_url = "https://myawesomesite.org"
+  #
+
+end
+

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: boxcab-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- did
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+description: Boxcab Rails is the Ruby on Rails version of PerchCMS
+email:
+- didier@nocoffee.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- boxcab-rails.gemspec
+- lib/boxcab-rails.rb
+- lib/boxcab/action_controller/controller.rb
+- lib/boxcab/action_view/helpers.rb
+- lib/boxcab/api.rb
+- lib/boxcab/assets/javascripts/boxcab.coffee
+- lib/boxcab/configuration.rb
+- lib/boxcab/page.rb
+- lib/boxcab/page_middleware.rb
+- lib/boxcab/page_service.rb
+- lib/boxcab/railtie.rb
+- lib/boxcab/vendor/high_voltage.rb
+- lib/boxcab/version.rb
+- lib/boxcab_rails.rb
+- lib/generators/boxcab/install/USAGE
+- lib/generators/boxcab/install/install_generator.rb
+- lib/generators/boxcab/install/templates/initializer.rb
+homepage: http://boxcab.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Boxcab is an easy to use CMS for applications hosted on Heroku
+test_files: []