locomotivecms 3.0.0.pre.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13af7d4674ae2e9a78c3f0c28ba9b0c6eab430b5
+  data.tar.gz: cbc17a9c176e8a2df21dc8f7c7545eb3ae3e4192
+SHA512:
+  metadata.gz: 9c5c7319dda26005c0b70f6179cbd1ddd2402083feea05428c498c8c0255e9da5bb51a0b124cc032ff647cad11f465260ae721269b0c50a95c0f4e5b7da90ae2
+  data.tar.gz: 371622004666f61268c538b2eef46b89355c5fc08d945adc21900784533442c21c2bbc89ed1c41096aa0da0085ffd9a44544cf0d7a1a0b3ec31dcc3fad4babfd

data/Gemfile

@@ -0,0 +1,63 @@
+#!/usr/bin/env bundle
+# encoding: utf-8
+
+source "https://rubygems.org"
+
+gemspec # Include gemspec dependencies
+
+gem 'sass-rails',   '~> 5.0.1'
+gem 'coffee-rails', '~> 4.1.0'
+gem 'uglifier',     '>= 2.5.3'
+
+gem 'coveralls',    '~> 0.7.2', require: false
+
+group :test, :development do
+  gem 'rspec-rails', '~> 3.2.1' #~> 2.14.2' # In order to have rspec tasks and generators
+  gem 'pry'
+end
+
+group :development do
+  # gem 'custom_fields', path: '../custom_fields'
+  # gem 'custom_fields', path: '../gems/custom_fields' # for Developers
+  # gem 'custom_fields', github: 'locomotivecms/custom_fields', ref: '15cceb66ed'
+
+  # gem 'locomotivecms_steam', path: '../in_progress/steam', require: false
+  # gem 'locomotivecms_steam', github: 'locomotivecms/steam', ref: '7e41d29d6a', require: false
+
+  # gem 'locomotive-aloha-rails', path: '../gems/aloha-rails' # for Developers
+  # gem 'locomotive-tinymce-rails', path: '../gems/tinymce-rails' # for Developers
+  # gem 'locomotive_liquid', path: '../gems/liquid' # for Developers
+  # gem 'locomotivecms_solid', path: '../gems/solid' # for Developers
+
+  # gem 'carrierwave-mongoid', git: 'git://github.com/locomotivecms/carrierwave-mongoid.git'
+
+  gem 'thor'
+  gem 'github_api'
+
+  gem 'quiet_assets'
+
+  gem 'ruby-prof'
+
+  gem 'better_errors'
+  gem 'binding_of_caller'
+
+  # gem 'unicorn-rails' # Using unicorn_rails instead of webrick (default server)
+  gem 'thin'
+end
+
+group :test do
+  # gem 'launchy'
+  # gem 'capybara',           '~> 2.0.2'
+  # gem 'cucumber-rails', require: false
+  # gem 'poltergeist'
+
+  gem 'shoulda-matchers',   '~> 2.7.0'
+  gem 'grape-entity-matchers'
+  gem 'factory_girl_rails'
+  gem 'pickle'
+  gem 'json_spec',          '~> 1.1.4'
+  gem 'database_cleaner'
+  gem 'timecop',            '~> 0.7.1'
+
+  # gem 'debugger', git: 'git://github.com/cldwalker/debugger.git'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+== MIT License
+
+Copyright (c) 2010-2015, Didier Lafforgue.
+
+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,76 @@
+# Locomotive
+
+[![Build Status](https://travis-ci.org/locomotivecms/engine.svg?branch=master)](https://travis-ci.org/locomotivecms/engine) [![Code Climate](https://codeclimate.com/github/locomotivecms/engine/badges/gpa.svg)](https://codeclimate.com/github/locomotivecms/engine) [![Dependency Status](https://gemnasium.com/locomotivecms/engine.svg)](https://gemnasium.com/locomotivecms/engine) [![Coverage Status](https://img.shields.io/coveralls/locomotivecms/engine.svg)](https://coveralls.io/r/locomotivecms/engine?branch=master) [![Join the chat at https://gitter.im/locomotivecms/engine](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/locomotivecms/engine?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+![Locomotive Screenshot](https://wagonapp.s3.amazonaws.com/doc/v3_backoffice.png)
+
+Locomotive is an open source platform to create, publish and edit sites. It is designed to save your time and help you focus on what matters: front-end technology, standard development process and no learning time for your client.
+
+Locomotive relies on a **very original workflow**.
+
+- Sites are coded locally using our open source tool: [Wagon](https://github.com/locomotivecms/wagon). A desktop version (not open source) is also available [here](http://www.wagonapp.com).
+- Sites are deployed to the platform (engine) thanks to our internal API.
+- A back-office for the end-users is automatically generated based on the custom models and editable regions described by the developers.
+
+Visit the Locomotive official website [here](http://www.locomotivecms.com) for more information.
+
+## Development Status ##
+
+As you can see from the commit logs, we are intensively working on the new V3 version. We kept all the features from our stable [v2 version](https://github.com/locomotivecms/engine/tree/v2.5.x), we just replace the UI, upgrade the gems and refactor our code.
+
+**[UPDATES]** Finally, we've been doing much more than we planed at first. We extracted the rendering functionality from the Engine and make it a gem named [Steam](https://github.com/locomotivecms/steam). This gem is also now used by [Wagon](https://github.com/locomotivecms/wagon) (version 2.0 in progress) which makes sure you get the same result between Wagon and Engine when you preview a page.
+And last but not least, we added a Ruby API client for Locomotive that we called [Coal](https://github.com/locomotivecms/coal). That client consumes the API from Engine which embeds now GrapeAPI. [Nic Boie](https://github.com/boie0025) is in charge of it. Kudos to him!
+
+**TRELLO** [here](https://trello.com/b/kRiy1dZu/locomotive-v3)
+
+## Getting Started ##
+
+If you can not wait for playing with our new version, you still can use the current one (v2.5.x). Check out our [installation guide](http://doc.locomotivecms.com/get-started).
+
+## Features ##
+
+- Multi-sites natively supported
+- Uses Liquid, a simple and clean templating language
+- Easy to add custom content types, no SQL needed
+- Beautiful and intuitive editing interface
+- Can fully localize all the content and pages
+- Embed a Restful API to manage every site
+- Develop and preview sites locally with your favorite tools **(Wagon)**
+- Support for SASS, LESS, HAML and Coffee Script **(Wagon)**
+
+## Technologies ##
+
+Here is a list of the main gems used to power the Locomotive backend:
+
+- Rails 4.2   - *web framework*
+- Bootstrap   - *UI framework*
+- Mongoid 4.0 - *Object-Document-Mapper for MongoDB*
+- Devise 3.4  - *Authentication*
+- Carrierwave - *Upload*
+- Pundit      - *Permissions*
+
+## Community ##
+
+- [Gitter](https://gitter.im/locomotivecms/engine?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) for technical discussions.
+- Get help or discuss Locomotive at the [Locomotive Google group](https://groups.google.com/forum/?fromgroups#!forum/locomotivecms)
+- [Follow us on twitter](http://twitter.com/locomotivecms)
+
+## Contributing to Locomotive ##
+
+Locomotive is an open source project, we encourage contributions. If you have found a bug and want to contribute a fix, or have a new feature you would like to add, follow the steps below to get your patch into the project:
+
+- Install ruby and mongoDB
+- Clone the project <code>git clone git@github.com:locomotivecms/engine.git</code>
+- Setup a virtual host entry for <code>test.example.com</code> to point to localhost
+- Run the tests <code>bundle exec rake</code>
+- Write your failing tests
+- Make the tests pass
+- [Create a GitHub pull request](http://help.github.com/send-pull-requests)
+
+For new features (especially large ones) it is best to create a topic on the [Google group](https://groups.google.com/forum/?fromgroups#!forum/locomotivecms) first to make sure it fits into the goals of the project.
+
+## Contact ##
+
+Feel free to contact me at did at locomotivecms dot com.
+
+Copyright (c) 2015 NoCoffee, released under the MIT license

data/app/api/locomotive/api.rb

@@ -0,0 +1,55 @@
+require 'active_support/all'
+require 'pundit'
+
+module Locomotive
+  module API
+
+    def self.to_app
+      Rack::Builder.new do
+        use Locomotive::API::Middlewares::LocaleMiddleware
+        use Locomotive::API::Middlewares::LoggerMiddleware
+        run Locomotive::API::Dispatch
+      end
+    end
+
+    class Dispatch < Grape::API
+
+      helpers Pundit
+      helpers API::Helpers::AuthenticationHelper
+      helpers API::Helpers::ParamsHelper
+      helpers API::Helpers::PersistenceHelper
+      helpers API::Helpers::PaginationHelper
+
+      include API::ExceptionRescuers
+
+      content_type :xml, 'application/xml'
+      content_type :json, 'application/json'
+
+      format :xml
+      format :json
+
+      prefix 'v3'
+
+      mount API::Resources::TokenResource
+      mount API::Resources::AccountResource
+      mount API::Resources::TranslationResource
+      mount API::Resources::VersionResource
+      mount API::Resources::ThemeAssetResource
+      mount API::Resources::SiteResource
+      mount API::Resources::SnippetResource
+      mount API::Resources::ContentTypeResource
+      mount API::Resources::ContentEntryResource
+      mount API::Resources::PageResource
+      mount API::Resources::MyAccountResource
+      mount API::Resources::MembershipResource
+      mount API::Resources::CurrentSiteResource
+      mount API::Resources::ContentAssetResource
+
+      route :any, '*path' do
+        error!({ error: "Unrecognized request path: #{params[:path]}" }, 404)
+      end
+
+    end
+
+  end
+end

data/app/api/locomotive/api/entities/account_entity.rb

@@ -0,0 +1,17 @@
+module Locomotive
+  module API
+    module Entities
+
+      class AccountEntity < BaseEntity
+
+        expose  :name, :email, :locale, :api_key, :super_admin
+
+        expose :local_admin do |account, _|
+          account.local_admin?
+        end
+
+      end
+
+    end
+  end
+end

data/app/api/locomotive/api/entities/base_entity.rb

@@ -0,0 +1,26 @@
+module Locomotive
+  module API
+    module Entities
+
+      class BaseEntity < ::Grape::Entity
+
+        include ActionView::Helpers::NumberHelper
+        include ActionView::Helpers::TextHelper
+
+        format_with(:human_size) { |number| number_to_human_size(number) }
+        format_with(:iso_timestamp) { |date_time| date_time.try(:iso8601) }
+        format_with(:labelize) { |label| label.gsub(/[\"\']/, '').gsub('-', ' ').humanize }
+        format_with(:truncate_to_3) { |target| truncate(target, length: 3) }
+
+        expose :_id do |entity, _|
+          entity._id.to_s
+        end
+
+        expose :created_at, format_with: :iso_timestamp
+        expose :updated_at, format_with: :iso_timestamp
+
+      end
+
+    end
+  end
+end

data/app/api/locomotive/api/entities/content_asset_entity.rb

@@ -0,0 +1,44 @@
+module Locomotive
+  module API
+    module Entities
+
+      class ContentAssetEntity < BaseEntity
+
+        expose :content_type, :width, :height, :vignette_url, :alternative_vignette_url, :checksum
+
+        expose :filename do |content_asset, _|
+          truncate(content_asset.source_filename, length: 28)
+        end
+
+        expose :short_name do |content_asset, _|
+          truncate(content_asset.name, length: 15)
+        end
+
+        expose :extname, format_with: :truncate_to_3
+
+        expose :full_filename do |content_asset, _|
+          content_asset.source_filename
+        end
+
+        expose :content_type_text do |content_asset, _|
+         value = content_asset.content_type.to_s == 'other' ? content_asset.extname : content_asset.content_type
+         value.blank? ? '?' : value
+        end
+
+        expose :with_thumbnail do |content_asset, _|
+         %w(image pdf).include?(content_asset.content_type)
+        end
+
+        expose :raw_size do |content_asset, _|
+         content_asset.size
+        end
+
+        expose :url do |content_asset, _|
+          content_asset.source.url
+        end
+
+      end
+
+    end
+  end
+end

data/app/api/locomotive/api/entities/content_entry_entity.rb

@@ -0,0 +1,85 @@
+module Locomotive
+  module API
+    module Entities
+
+      class ContentEntryEntity < BaseEntity
+
+        expose :_slug
+
+        expose :content_type_slug do |content_entry, _|
+          content_entry.content_type.slug
+        end
+
+        expose :_label, :_position, :_visible
+
+        expose :seo_title, :meta_keywords, :meta_description
+
+        expose :dynamic_fields
+
+        def serializable_hash(runtime_options = {})
+          (super || {}).dup.tap do |hash|
+            hash.merge!(hash.delete(:dynamic_fields) || hash.delete('dynamic_fields') || {})
+          end
+        end
+
+        def dynamic_fields
+          content_type.entries_custom_fields.inject({}) do |hash, field|
+            name        = field.name.to_sym
+            method_name = :"expose_#{field.type}_field"
+
+            hash[name] = send(method_name, name) if respond_to?(method_name)
+            hash
+          end
+        end
+
+        def expose_default_field(name)
+          dynamic_value_of(name)
+        end
+
+        alias :expose_string_field    :expose_default_field
+        alias :expose_text_field      :expose_default_field
+        alias :expose_boolean_field   :expose_default_field
+        alias :expose_email_field     :expose_default_field
+        alias :expose_integer_field   :expose_default_field
+        alias :expose_float_field     :expose_default_field
+        alias :expose_tags_field      :expose_default_field
+
+        def expose_money_field(name)
+          dynamic_value_of(:"formatted_#{name}")
+        end
+
+        def expose_date_time_field(name)
+          instance_exec(dynamic_value_of(name), &formatters[:iso_timestamp])
+        end
+
+        alias :expose_date_field :expose_date_time_field
+
+        def expose_file_field(name)
+          dynamic_value_of(:"#{name}_url")
+        end
+
+        def expose_select_field(name)
+          dynamic_value_of(name)
+        end
+
+        def expose_belongs_to_field(name)
+          dynamic_value_of(name).try(:_slug)
+        end
+
+        def expose_many_to_many_field(name)
+          dynamic_value_of(name).pluck_with_natural_order(:_slug)
+        end
+
+        def dynamic_value_of(name)
+          self.object.send(name)
+        end
+
+        def content_type
+          self.object.content_type
+        end
+
+      end
+
+    end
+  end
+end

data/app/api/locomotive/api/entities/content_type_entity.rb

@@ -0,0 +1,31 @@
+module Locomotive
+  module API
+    module Entities
+
+      class ContentTypeEntity < BaseEntity
+
+        expose :name, :slug, :description, :label_field_name, :order_direction, :public_submission_enabled, :raw_item_template
+
+        expose :fields, using: ContentTypeFieldEntity do |content_type, _|
+          content_type.ordered_entries_custom_fields || []
+        end
+
+        expose :order_by do |content_type, _|
+          content_type.order_by_attribute
+        end
+
+        expose :group_by do |content_type, _|
+          content_type.group_by_field.try(:name)
+        end
+
+        expose :public_submission_account_emails do |content_type, _|
+          ([*content_type.public_submission_accounts]).map do |_id|
+            Locomotive::Account.where(_id: _id).first.try(:email)
+          end.compact
+        end
+
+      end
+
+    end
+  end
+end

data/app/api/locomotive/api/entities/content_type_field_entity.rb

@@ -0,0 +1,34 @@
+module Locomotive
+  module API
+    module Entities
+
+      class ContentTypeFieldEntity < BaseEntity
+
+        expose :name, :type, :label, :hint, :required, :localized, :unique, :position
+
+        # text type field
+        expose :text_formatting, if: ->(field, _) { field.type.to_s == 'text' }
+
+        # select type field
+        expose :select_options, if: ->(field, _) { field.type.to_s == 'select' } do |field, _|
+          field.select_options.map do |option|
+            { id: option._id, name: option.name_translations, position: option.position }
+          end
+        end
+
+        # relationship type field
+        with_options if: ->(field, _) { field.is_relationship? } do
+
+          expose :target do |field, _|
+            field.class_name_to_content_type.try(:slug) rescue nil
+          end
+
+          expose :inverse_of, :order_by, :ui_enabled
+
+        end
+
+      end
+
+    end
+  end
+end