locomotive_cms 2.0.0.rc12 → 2.0.0

data/app/controllers/locomotive/api/snippets_controller.rb

@@ -2,35 +2,82 @@ module Locomotive
   module Api
     class SnippetsController < BaseController
 
-      load_and_authorize_resource :class => Locomotive::Snippet
+      load_and_authorize_resource class: Locomotive::Snippet, through: :current_site
 
       def index
-        @snippets = current_site.snippets.order_by([[:name, :asc]])
+        @snippets = @snippets.order_by([[:name, :asc]])
         respond_with(@snippets)
       end
 
       def show
-        @snippet = current_site.snippets.find(params[:id])
         respond_with @snippet
       end
 
       def create
-        @snippet = current_site.snippets.create(params[:snippet])
-        respond_with @snippet, :location => main_app.locomotive_api_snippets_url
+        @snippet.from_presenter(params[:snippet])
+        @snippet.save
+        respond_with @snippet, location: main_app.locomotive_api_snippets_url
       end
 
       def update
-        @snippet = current_site.snippets.find(params[:id])
-        @snippet.update_attributes(params[:snippet])
-        respond_with @snippet, :location => main_app.locomotive_api_snippets_url
+        @snippet.from_presenter(params[:snippet])
+        @snippet.save
+        respond_with @snippet, location: main_app.locomotive_api_snippets_url
       end
 
       def destroy
-        @snippet = current_site.snippets.find(params[:id])
         @snippet.destroy
         respond_with @snippet
       end
 
+      protected
+
+      def self.description
+        {
+          overall: %{Manage the snippets},
+          actions: {
+            index: {
+              description: %{Return all the snippets ordered by the depth and position},
+              example: {
+                command: %{curl 'http://mysite.com/locomotive/api/snippets.json?auth_token=dtsjkqs1TJrWiSiJt2gg'},
+                response: %(TODO)
+              }
+            },
+            show: {
+              description: %{Return the attributes of a snippet},
+              response: Locomotive::SnippetPresenter.getters_to_hash,
+              example: {
+                command: %{curl 'http://mysite.com/locomotive/api/snippets/4244af4ef0000002.json?auth_token=dtsjkqs1TJrWiSiJt2gg'},
+                response: %(TODO)
+              }
+            },
+            create: {
+              description: %{Create a snippet},
+              params: Locomotive::SnippetPresenter.setters_to_hash,
+              example: {
+                command: %{curl -d '...' 'http://mysite.com/locomotive/api/snippets.json?auth_token=dtsjkqs1TJrWiSiJt2gg'},
+                response: %(TODO)
+              }
+            },
+            update: {
+              description: %{Update a snippet},
+              params: Locomotive::SnippetPresenter.setters_to_hash,
+              example: {
+                command: %{curl -d '...' -X UPDATE 'http://mysite.com/locomotive/api/snippets/4244af4ef0000002.json?auth_token=dtsjkqs1TJrWiSiJt2gg'},
+                response: %(TODO)
+              }
+            },
+            destroy: {
+              description: %{Delete a snippet},
+              example: {
+                command: %{curl -X DELETE 'http://mysite.com/locomotive/api/snippets/4244af4ef0000002.json?auth_token=dtsjkqs1TJrWiSiJt2gg'},
+                response: %(TODO)
+              }
+            }
+          }
+        }
+      end
+
     end
   end
 end

data/app/controllers/locomotive/api/theme_assets_controller.rb

@@ -2,31 +2,29 @@ module Locomotive
   module Api
     class ThemeAssetsController < BaseController
 
-      load_and_authorize_resource :class => Locomotive::ThemeAsset
+      load_and_authorize_resource class: Locomotive::Translation, through: :current_site
 
       def index
-        @theme_assets = current_site.theme_assets.all
         respond_with(@theme_assets)
       end
 
       def show
-        @theme_asset = current_site.theme_assets.find(params[:id])
         respond_with @theme_asset
       end
 
       def create
-        @theme_asset = current_site.theme_assets.create(params[:theme_asset])
-        respond_with @theme_asset, :location => main_app.locomotive_api_theme_assets_url
+        @theme_asset.from_presenter(params[:theme_asset])
+        @theme_asset.save
+        respond_with @theme_asset, location: main_app.locomotive_api_theme_assets_url
       end
 
       def update
-        @theme_asset = current_site.theme_assets.find(params[:id])
-        @theme_asset.update_attributes(params[:theme_asset])
-        respond_with @theme_asset, :location => main_app.locomotive_api_theme_assets_url
+        @theme_asset.from_presenter(params[:theme_asset])
+        @theme_asset.save
+        respond_with @theme_asset, location: main_app.locomotive_api_theme_assets_url
       end
 
       def destroy
-        @theme_asset = current_site.theme_assets.find(params[:id])
         @theme_asset.destroy
         respond_with @theme_asset
       end

data/app/controllers/locomotive/api/tokens_controller.rb

@@ -2,26 +2,53 @@ module Locomotive
   module Api
     class TokensController < Locomotive::Api::BaseController
 
-      skip_before_filter :require_account
+      skip_before_filter :require_account, :require_site, :set_locale, :set_current_thread_variables
 
       def create
         begin
           token = Account.create_api_token(current_site, params[:email], params[:password])
-          respond_with({ :token => token }, :location => root_url)
+          respond_with({ token: token }, location: root_url)
         rescue Exception => e
-          respond_with({ :message => e.message }, :status => 401, :location => root_url)
+          respond_with({ message: e.message }, status: 401, location: root_url)
         end
       end
 
       def destroy
         begin
           token = Account.invalidate_api_token(params[:id])
-          respond_with({ :token => token }, :location => root_url)
+          respond_with({ token: token }, location: root_url)
         rescue Exception => e
-          respond_with({ :message => e.message }, :status => 404, :location => root_url)
+          respond_with({ message: e.message }, status: 404, location: root_url)
         end
       end
 
+      protected
+
+      def self.description
+        {
+          overall: %{Manage a session token which will be passed to all the other REST calls},
+          actions: {
+            create: {
+              description: %{Generate a session token from an email and a password},
+              params: { email: 'String', password: 'String' },
+              response: { token: 'String' },
+              example: {
+                command: %{curl -d 'email=john.doe@acme.org&password=secret' 'http://mysite.com/locomotive/api/tokens.json'},
+                response: %({ "token": "dtsjkqs1TJrWiSiJt2gg" })
+              }
+            },
+            destroy: {
+              description: %{Make a session token invalid},
+              response: { token: 'String' },
+              example: {
+                command: %{curl -X DELETE 'http://mysite.com/locomotive/api/tokens/dtsjkqs1TJrWiSiJt2gg.json'},
+                response: %({ "token": "dtsjkqs1TJrWiSiJt2gg" })
+              }
+            }
+          }
+        }
+      end
+
     end
   end
 end

data/app/controllers/locomotive/api/translations_controller.rb

@@ -0,0 +1,33 @@
+module Locomotive
+  module Api
+    class TranslationsController < BaseController
+
+      load_and_authorize_resource class: Locomotive::Translation, through: :current_site
+
+      def index
+        respond_with(@translations)
+      end
+
+      def show
+        respond_with @translation
+      end
+
+      def create
+        @translation.from_presenter(params[:translation])
+        @translation.save
+        respond_with @translation, location: main_app.locomotive_api_translation_path(@translation)
+      end
+
+      def update
+        @translation.update_attributes(params[:translation])
+        respond_with @translation, location: main_app.locomotive_api_translation_path(@translation)
+      end
+
+      def destroy
+        @translation.destroy
+        respond_with @translation
+      end
+
+    end
+  end
+end

data/app/controllers/locomotive/public/base_controller.rb

@@ -14,7 +14,7 @@ module Locomotive
       protected
 
       def set_locale
-        logger.info "[public/set_locale] TODO"
+        logger.info "[public/set_locale] TO BE OVERRIDEN"
       end
 
     end

data/app/controllers/locomotive/public/content_entries_controller.rb

@@ -1,33 +1,34 @@
 module Locomotive
   module Public
-    class ContentEntriesController < BaseController
+    class ContentEntriesController < Public::BaseController
 
-      before_filter :set_content_type
-
-      before_filter :sanitize_entry_params, :only => :create
+      include Locomotive::Render
 
-      skip_load_and_authorize_resource
+      before_filter :set_content_type
 
-      self.responder = Locomotive::ActionController::PublicResponder # custom responder
+      before_filter :sanitize_entry_params, only: :create
 
       respond_to :html, :json
 
       def create
         @entry = @content_type.entries.create(params[:entry] || params[:content])
-        flash[@content_type.slug.singularize] = @entry.to_presenter(:include_errors => true).as_json
-        respond_with @entry, :location => self.callback_url
+
+        respond_with @entry, {
+          location:   self.callback_url,
+          responder:  Locomotive::ActionController::PublicResponder
+        }
       end
 
       protected
 
       def set_content_type
-        @content_type = current_site.content_types.where(:slug => params[:slug]).first
+        @content_type = current_site.content_types.where(slug: params[:slug]).first
 
         # check if ability to receive public submissions
         unless @content_type.public_submission_enabled?
           respond_to do |format|
-            format.json { render :json => { :error => 'Public submissions not accepted' }, :status => :forbidden }
-            format.html { render :text => 'Public submissions not accepted', :status => :forbidden }
+            format.json { render json: { error: 'Public submissions not accepted' }, status: :forbidden }
+            format.html { render text: 'Public submissions not accepted', status: :forbidden }
           end
           return false
         end
@@ -48,7 +49,7 @@ module Locomotive
       def handle_unverified_request
         if Locomotive.config.csrf_protection
           reset_session
-          redirect_to '/', :status => 302
+          redirect_to '/', status: 302
         end
       end
 

data/app/controllers/locomotive/public/pages_controller.rb

@@ -16,6 +16,8 @@ module Locomotive
 
       before_filter :set_locale, :only => [:show, :edit]
 
+      helper Locomotive::BaseHelper
+
       def show_toolbar
         render :layout => false
       end
@@ -33,7 +35,7 @@ module Locomotive
 
       def set_toolbar_locale
         ::I18n.locale = current_locomotive_account.locale rescue Locomotive.config.default_locale
-        ::Mongoid::Fields::I18n.locale = session[:content_locale] || current_site.default_locale
+        ::Mongoid::Fields::I18n.locale = params[:locale] || current_site.default_locale
       end
 
       def set_locale

data/app/controllers/locomotive/public/robots_controller.rb

@@ -1,6 +1,6 @@
 module Locomotive
   module Public
-    class RobotsController < BaseController
+    class RobotsController < Public::BaseController
 
       include Locomotive::Render
 
@@ -8,7 +8,7 @@ module Locomotive
 
       def show
         template = ::Liquid::Template.parse(current_site.robots_txt)
-        render :text => template.render('request_host' => self.request.host.downcase)
+        render :text => template.render(locomotive_context.merge('request_host' => self.request.host.downcase))
       end
 
     end

data/app/controllers/locomotive/public/sitemaps_controller.rb

@@ -1,11 +1,11 @@
 module Locomotive
   module Public
-    class SitemapsController < BaseController
+    class SitemapsController < Public::BaseController
 
       respond_to :xml
 
       def show
-        @pages = current_site.pages.published
+        @pages = current_site.pages.published.order_by([:depth.asc, :position.asc])
         respond_with @pages
       end
 

data/app/controllers/locomotive/sites_controller.rb

@@ -12,13 +12,13 @@ module Locomotive
 
     def create
       @site = Site.new(params[:site])
-      @site.memberships.build :account => @current_locomotive_account, :role => 'admin'
+      @site.memberships.build :account => self.current_locomotive_account, :role => 'admin'
       @site.save
       respond_with @site, :location => edit_my_account_url
     end
 
     def destroy
-      @site = current_locomotive_account.sites.find(params[:id])
+      @site = self.current_locomotive_account.sites.find(params[:id])
 
       if @site != current_site
         @site.destroy

data/app/controllers/locomotive/snippets_controller.rb

@@ -7,13 +7,18 @@ module Locomotive
 
     before_filter :back_to_default_site_locale, :only => %w(new create)
 
-    respond_to :json, :only => [:create, :update, :destroy]
+    respond_to    :json, :only => [:show, :create, :update, :destroy]
 
     def new
       @snippet = current_site.snippets.new
       respond_with @snippet
     end
 
+    def show
+      @snippet = current_site.snippets.find(params[:id])
+      respond_with @snippet
+    end
+
     def create
       @snippet = current_site.snippets.create(params[:snippet])
       respond_with @snippet, :location => edit_snippet_url(@snippet._id)

data/app/controllers/locomotive/translations_controller.rb

@@ -0,0 +1,39 @@
+module Locomotive
+  class TranslationsController < BaseController
+
+    sections :settings, :translations
+
+    respond_to :json, only: [:create, :update]
+
+    def index
+      @translations = current_site.translations.ordered
+      respond_with @translations
+    end
+
+    def new
+      @translation = current_site.translations.build
+      respond_with @translation
+    end
+
+    def create
+      @translation = current_site.translations.create(params[:translation])
+      respond_with @translation, location: translations_path
+    end
+
+    def edit
+      respond_with @translation
+    end
+
+    def update
+      @translation = current_site.translations.find(params[:id])
+      @translation.update_attributes(params[:translation])
+      respond_with @translation, location: translations_path
+    end
+
+    def destroy
+      @translation = current_site.translations.find(params[:id])
+      @translation.destroy
+      respond_with @translation, location: translations_path
+    end
+  end
+end

data/app/helpers/locomotive/accounts_helper.rb

@@ -6,7 +6,7 @@ module Locomotive
     end
 
     def options_for_account
-      current_site.accounts.collect { |a| ["#{a.name} <#{a.email}>", a.id] }
+      current_site.accounts.collect { |a| ["#{a.name} <#{a.email}>", a.id.to_s] }
     end
 
   end

data/app/helpers/locomotive/base_helper.rb

@@ -14,6 +14,22 @@ module Locomotive
       resource.persisted? && resource.errors.empty?
     end
 
+    # Like link_to but instead of passing a label, we
+    # pass the name of an Font Awesome icon.
+    # If the name is a Symbol, we append "icon-" to the
+    # dasherized version of the name.
+    #
+    # @param [ String / Symbol ] name The class name or a symbol
+    # @param [ Array ] *args
+    #
+    # @return [ String ] The HTML <a> tag
+    #
+    def link_to_icon(name, *args, &block)
+      name = name.is_a?(Symbol) ? "icon-#{name.to_s.dasherize}" : name
+      icon = content_tag(:i, '', :class => name)
+      link_to(icon, *args, &block).html_safe
+    end
+
     # Execute the code only once during the request time. It avoids duplicated
     # dom elements in the rendered rails page.
     #
@@ -37,7 +53,8 @@ module Locomotive
       label_link = default_options[:i18n] ? t("locomotive.shared.menu.#{name}") : name
       if block_given?
         popup = content_tag(:div, capture(&block), :class => 'popup', :style => 'display: none')
-        link = link_to(content_tag(:span, preserve(label_link) + content_tag(:em)) + content_tag(:em), url, :class => css)
+        text  = content_tag(:span, preserve(label_link) + content_tag(:i, '', :class => 'icon-caret-down'))
+        link  = link_to(text + content_tag(:em), url, :class => css)
         content_tag(:li, link + popup, :class => 'hoverable')
       else
         content_tag(:li, link_to(content_tag(:span, label_link), url, :class => css))
@@ -46,8 +63,12 @@ module Locomotive
 
     def local_action_button(text, url, options = {})
       text = text.is_a?(Symbol) ? t(".#{text}") : text
+
+      icon = options.delete(:icon) || :exclamation_sign
+      icon = icon.is_a?(Symbol) ? "icon-#{icon.to_s.dasherize}" : icon
+
       link_to(url, options) do
-        content_tag(:em, escape_once('&nbsp;')) + text
+        content_tag(:i, '', :class => icon) + text
       end
     end
 
@@ -85,6 +106,39 @@ module Locomotive
       content_for?(:backbone_view_data) ? content_for(:backbone_view_data) : ''
     end
 
+    # Build the json version of a object. If the object owns a presenter
+    # then that presenter is used instead of the default object to_json method.
+    # Furthermore, if the presenter owns a as_json_for_html_view method,
+    # then it is called instead of the default as_json method.
+    # A html_safe is processed at the end.
+    #
+    # @return [ String ] The json representation of the object
+    #
+    def to_json(object)
+      if object.respond_to?(:to_presenter)
+        presenter = object.to_presenter
+
+        if presenter.respond_to?(:as_json_for_html_view)
+          presenter.as_json_for_html_view
+        else
+          presenter.as_json
+        end.to_json
+      else
+        object.to_json
+      end.html_safe
+    end
+
+    # Display the image of the flag representing the locale.
+    #
+    # @param [ String / Symbol ] locale The locale (fr, en, ...etc)
+    # @param [ String ] size The width x height (by default, 24x24)
+    #
+    # @return [ String ] The HTML image tag with the path to the matching flag.
+    #
+    def flag_tag(locale, size = '24x24')
+      image_tag("locomotive/icons/flags/#{locale}.png", :class => 'flag', :size => size)
+    end
+
     def nocoffee_tag
       link_to 'noCoffee', 'http://www.nocoffee.fr', :id => 'nocoffee'
     end
@@ -133,6 +187,18 @@ module Locomotive
       options_for_select(list)
     end
 
+    # locales
+
+    # For a localized site, tell if the current content locale does not match
+    # the default locale of the site. It is used by the page / snippet forms
+    # to determine if we have to display the warning message letting the
+    # designer know that the template is only editable in the default locale.
+    #
+    # @return [ Boolean ] True if it matches the condition above.
+    #
+    def not_the_default_current_locale?
+      current_site.localized? && current_content_locale.to_s != current_site.default_locale.to_s
+    end
 
   end
 end