locomotivecms_wagon 2.0.0.pre.beta.2 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec11f1311f000e44d0d199967eaf73c25048c83d
-  data.tar.gz: 701ba6761d428edf3d03a76254bc7558b331054f
+  metadata.gz: d6e7813188667f8439421a837787f0ca5e85b1bf
+  data.tar.gz: d7846774d2eb77655e96b1e7b57e98393b6147c1
 SHA512:
-  metadata.gz: bf8014572c5c1d78c63e93a0a2b5fe09c3d035b8f44d49e9a5ff4b123c2e21f83905949166f0712c84a4d7475fa509aec825cbaaf6645f12d4befd4ab138af1f
-  data.tar.gz: 382c96d36f76196e2ffd0bb8c0fecdfdbe9261cb28c0114e6b81a9c5b81e1fa530814edccdfe010f898713e51f69663ea201cf1ffb3e7e63be9469254fc90507
+  metadata.gz: d7e950c87f45d9a67d6512183940e5a06af167fcc4e8fe87b195f672cbceb6de795e93099c5865868b9191a6eec6f2f867531e8fef2c1fb2d39343c64f2a5f88
+  data.tar.gz: 7daa31a931589f899b29dbdd480d4324fb4e5e34e475a841b7267540a0eee64457c2907f925faba9e601fe5dcc7e86938629acc17918ddef65da127b5ffe2626

data/.gitignore

@@ -12,6 +12,7 @@ Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
+bin/wagon_dev.rb
 doc/
 lib/bundler/man
 pkg

data/Gemfile

@@ -8,7 +8,7 @@ gem 'rb-fsevent', '~> 0.9.1'
 gem 'therubyracer'
 
 # Development
-# gem 'locomotivecms_steam', github: 'locomotivecms/steam', ref: '2650a1c', require: false
+# gem 'locomotivecms_steam', github: 'locomotivecms/steam', ref: 'c487443', require: false
 # gem 'locomotivecms_coal', github: 'locomotivecms/coal', ref: '32b2844', require: false
 # gem 'locomotivecms_common', github: 'locomotivecms/common', ref: '3046b79893', require: false
 

data/generators/content_type/app/content_types/%slug%.yml.tt

@@ -43,7 +43,7 @@ fields: <% config[:fields].each_with_index do |field, index| %>
     required: <%= index == 0 ? true : field.required %>
     hint: Explanatory text displayed in the back office
     localized: <%= field.localized %><% if field.type == 'text' %>
-    # text_formatting: html # html (uses rich text editor) or text (uses plain text editor)<% end -%><% if field.type == 'select' -%>
+    # text_formatting: html # html (uses rich text editor), markdown or text (uses plain text editor)<% end -%><% if field.type == 'select' -%>
     # if localized, use
     #   en: ['option1_en', 'option2_en']
     #   fr: ['option1_fr', 'option2_fr']

data/lib/locomotive/wagon.rb

@@ -3,7 +3,7 @@ require_relative 'wagon/exceptions'
 module Locomotive
   module Wagon
 
-    DEFAULT_PLATFORM_URL = 'http://www.lvh.me:3000'.freeze
+    DEFAULT_PLATFORM_URL = 'http://locomotive.works'.freeze
 
     # Authenticate an user to the Hosting platform.
     # If the user does not exist, then create an account for her/him.

data/lib/locomotive/wagon/commands/concerns/api_concern.rb

@@ -19,6 +19,8 @@ module Locomotive::Wagon
       @api_site_client = Locomotive::Coal::Client.new(_host, _credentials, _options)
     end
 
+    alias :build_api_site_client :api_site_client
+
     # Host (+ port) extracted from the platform_url instance variable.
     # If port equals 80, do not add it to the host.
     #

data/lib/locomotive/wagon/commands/loggers/push_logger.rb

@@ -18,6 +18,10 @@ module Locomotive::Wagon
         log "persisting #{event.payload[:label]}", :white, 2, true
       end
 
+      subscribe :warning do |event|
+        log "Warning: #{event.payload[:message]}", :yellow
+      end
+
       subscribe :skip_persisting do |event|
         log ' [' + 'skip'.colorize(:yellow) + ']'
       end
@@ -34,32 +38,10 @@ module Locomotive::Wagon
 
     private
 
-    # def log(message, color = nil, ident = nil, print = false)
-    #   ident = ' ' * (ident || 0)
-
-    #   message = "#{ident}#{message.gsub("\n", "\n" + ident)}"
-    #   message = message.colorize(color) if color
-
-    #   if print
-    #     print message
-    #   else
-    #     puts message
-    #   end
-    # end
-
     def subscribe(action = nil, &block)
       _subscribe('push', action, &block)
     end
 
-    # def subscribe(action = nil, &block)
-    #   name = ['wagon', 'push', [*action]].flatten.compact.join('.')
-
-    #   ActiveSupport::Notifications.subscribe(name) do |*args|
-    #     event = ActiveSupport::Notifications::Event.new *args
-    #     yield(event)
-    #   end
-    # end
-
   end
 
 end

data/lib/locomotive/wagon/commands/pull_sub_commands/concerns/assets_concern.rb

@@ -4,6 +4,8 @@ module Locomotive::Wagon
 
   module AssetsConcern
 
+    REGEX = /(https?:\/\/\S+)?\/sites\/[0-9a-f]{24}\/(assets|pages|theme|content_entry[0-9a-f]{24})\/(([^;.]+)\/)*([a-zA-Z_\-0-9.]+)\.([A-Za-z]{2,})/
+
     # The content assets on the remote engine follows the format: /sites/<id>/assets/<type>/<file>
     # This method replaces these urls by their local representation. <type>/<file>
     #
@@ -12,16 +14,16 @@ module Locomotive::Wagon
     def replace_asset_urls(content)
       return '' if content.blank?
 
-      content.force_encoding('utf-8').gsub(/\/sites\/[0-9a-f]{24}\/(assets|pages|theme|content_entry[0-9a-f]{24})\/(([^;.]+)\/)*([a-zA-Z_\-0-9]+)\.([a-z]{2,3})/) do |url|
-        filename = "#{$4}.#{$5}"
-        folder = case $1
-        when 'assets', 'pages'  then File.join('samples', $1)
-        when 'theme'            then $3
+      content.force_encoding('utf-8').gsub(REGEX) do |url|
+        filename = "#{$5}.#{$6}"
+        folder = case $2
+        when 'assets', 'pages'  then File.join('samples', $2)
+        when 'theme'            then $4
         when /\Acontent_entry/  then File.join('samples', 'content_entries')
         end
 
         if filepath = write_asset(url, File.join(path, 'public', folder, filename))
-          File.join('', folder, File.basename(filepath))
+          File.join('', folder, File.basename(filepath)).to_s
         else
           ''
         end

data/lib/locomotive/wagon/commands/pull_sub_commands/pull_content_entries_command.rb

@@ -47,7 +47,7 @@ module Locomotive::Wagon
     def fetch_content_types(&block)
       api_client.content_types.all.each do |content_type|
         content_type.attributes['localized_names'] = content_type.fields.map { |f| f['localized'] ? f['name'] : nil }.compact
-        content_type.attributes['urls_names'] = content_type.fields.map { |f| %w(file text).include?(f['type']) ? f['name'] : nil }.compact
+        content_type.attributes['urls_names'] = content_type.fields.map { |f| %w(file string text).include?(f['type']) ? f['name'] : nil }.compact
         yield(content_type)
       end
     end

data/lib/locomotive/wagon/commands/pull_sub_commands/pull_content_types_command.rb

@@ -26,7 +26,7 @@ module Locomotive::Wagon
     end
 
     def field_yaml_attributes(field)
-      attributes = field.slice('label', 'type', 'required', 'hint', 'localized', 'select_options', 'class_name', 'inverse_of', 'ui_enabled')
+      attributes = field.slice('label', 'type', 'required', 'hint', 'localized', 'select_options', 'target', 'inverse_of', 'ui_enabled')
 
       clean_attributes(attributes)
 

data/lib/locomotive/wagon/commands/pull_sub_commands/pull_theme_assets_command.rb

@@ -21,7 +21,7 @@ module Locomotive::Wagon
     private
 
     def theme_asset_filepath(asset)
-      File.join('public', asset.folder, asset.local_path)
+      File.join('public', asset.local_path)
     end
 
   end

data/lib/locomotive/wagon/commands/push_command.rb

@@ -32,17 +32,31 @@ module Locomotive::Wagon
     def push
       PushLogger.new if options[:verbose]
 
-      api_client = api_site_client(connection_information)
+      api_client = build_api_site_client(connection_information)
+
+      validate!
 
       content_assets_pusher = Locomotive::Wagon::PushContentAssetsCommand.new(api_client, steam_services)
 
       each_resource do |klass|
-        klass.push(api_client, steam_services, content_assets_pusher)
+        klass.push(api_client, steam_services, content_assets_pusher, remote_site)
       end
     end
 
     private
 
+    # To push all the other resources, the big requirement is to
+    # have the same locales between the local site and the remote one.
+    def validate!
+      if local_site.default_locale != remote_site.default_locale && remote_site.edited?
+        raise "Your Wagon site locale (#{local_site.default_locale}) is not the same as the one in the back-office (#{remote_site.default_locale})."
+      end
+
+      if local_site.locales != remote_site.locales
+        instrument :warning, message: "Your Wagon site locales (#{local_site.locales.join(', ')}) are not the same as the ones in the back-office (#{remote_site.locales.join(', ')})."
+      end
+    end
+
     def each_resource
       RESOURCES.each do |name|
         next if !options[:resources].blank? && !options[:resources].include?(name)
@@ -109,6 +123,26 @@ module Locomotive::Wagon
       self.platform_url = url.blank? ? default : url
     end
 
+    def local_site
+      return @local_site if @local_site
+      @local_site = SiteDecorator.new(steam_services.repositories.site.first)
+    end
+
+    def remote_site
+      return @remote_site if @remote_site
+
+      attribute = nil
+
+      begin
+        attributes = @api_site_client.current_site.get.attributes
+      rescue Locomotive::Coal::UnknownResourceError
+        raise 'Sorry, we were unable to find your site on the remote platform. Check the information in your config/deploy.yml file.'
+      end
+
+      _site         = Locomotive::Steam::Site.new(attributes)
+      @remote_site  = SiteDecorator.new(_site)
+    end
+
   end
 
 end

data/lib/locomotive/wagon/commands/push_sub_commands/push_base_command.rb

@@ -1,13 +1,13 @@
 module Locomotive::Wagon
 
-  class PushBaseCommand < Struct.new(:api_client, :steam_services, :content_assets_pusher)
+  class PushBaseCommand < Struct.new(:api_client, :steam_services, :content_assets_pusher, :remote_site)
 
     extend Forwardable
 
     def_delegators :steam_services, :current_site, :locale, :repositories
 
-    def self.push(api_client, steam_services, content_assets_pusher)
-      new(api_client, steam_services, content_assets_pusher).push
+    def self.push(api_client, steam_services, content_assets_pusher, remote_site)
+      new(api_client, steam_services, content_assets_pusher, remote_site).push
     end
 
     def push
@@ -33,8 +33,9 @@ module Locomotive::Wagon
           instrument :persist_with_success
         rescue SkipPersistingException => e
           instrument :skip_persisting
-        # rescue Exception => e
-        #   instrument :persist_with_error, message: e.message
+        rescue Exception => e
+          instrument :persist_with_error, message: e.message
+          raise e
         end
       end
     end

data/lib/locomotive/wagon/commands/push_sub_commands/push_pages_command.rb

@@ -39,7 +39,7 @@ module Locomotive::Wagon
     private
 
     def _decorate(entity)
-      PageDecorator.new(entity, default_locale, content_assets_pusher)
+      PageDecorator.new(entity, default_locale, content_assets_pusher, remote_site.edited?)
     end
 
     def remote_entity_id(fullpath)

data/lib/locomotive/wagon/commands/push_sub_commands/push_site_command.rb

@@ -7,12 +7,19 @@ module Locomotive::Wagon
     end
 
     def decorate(entity)
-      IconSiteDecorator.new(entity)
+      UpdateSiteDecorator.new(entity)
     end
 
     def persist(decorated_entity)
       _attributes = decorated_entity.to_hash
-      if !_attributes.empty? && api_client.current_site.get.attributes[:picture_url].nil?
+
+      # push the picture only if there is no existing remote picture
+      _attributes.delete(:picture) if remote_site['picture_url'].present?
+
+      # push the locales as long as there is no content on the remote site yet
+      _attributes.delete(:locales) if remote_site.edited?
+
+      if _attributes.present?
         api_client.current_site.update(_attributes)
       else
         raise SkipPersistingException.new

data/lib/locomotive/wagon/decorators/content_type_field_decorator.rb

@@ -29,8 +29,6 @@ module Locomotive
       end
 
       def text_formatting
-        return nil unless type == :text
-
         self[:text_formatting]
       end
 

data/lib/locomotive/wagon/decorators/page_decorator.rb

@@ -6,10 +6,11 @@ module Locomotive
       include ToHashConcern
       include PersistAssetsConcern
 
-      attr_accessor :__content_assets_pusher__
+      attr_accessor :__content_assets_pusher__, :__site_edited__
 
-      def initialize(object, locale = nil, content_assets_pusher)
+      def initialize(object, locale = nil, content_assets_pusher, site_edited)
         self.__content_assets_pusher__ = content_assets_pusher
+        self.__site_edited__ = site_edited
         super(object, locale, nil)
       end
 
@@ -24,7 +25,10 @@ module Locomotive
           content_type
           template)
 
-        _attributes -= %i(editable_elements) if persisted?
+        # remove the attributes that end-users might have modified in the back-office
+        if persisted? && __site_edited__
+          _attributes -= %i(title published listed position seo_title meta_keywords meta_description editable_elements)
+        end
 
         _attributes
       end

data/lib/locomotive/wagon/decorators/site_decorator.rb

@@ -13,10 +13,12 @@ module Locomotive
         picture_path = __getobj__.picture
         if picture_path && File.exists?(picture_path)
           Locomotive::Coal::UploadIO.new(picture_path, nil, 'icon.png')
+        else
+          nil
         end
       end
 
-      %i(robots_txt locales timezone seo_title meta_keywords meta_description).each do |name|
+      %i(robots_txt timezone seo_title meta_keywords meta_description).each do |name|
         define_method(name) do
           self[name]
         end
@@ -26,12 +28,16 @@ module Locomotive
         %i(name handle robots_txt locales timezone seo_title meta_keywords meta_description picture)
       end
 
+      def edited?
+        (self[:content_version].try(:to_i) || 0) > 0
+      end
+
     end
 
-    class IconSiteDecorator < SiteDecorator
+    class UpdateSiteDecorator < SiteDecorator
 
       def __attributes__
-        %i(picture)
+        %i(picture locales)
       end
 
     end

data/lib/locomotive/wagon/middlewares/error_page.rb

@@ -1,5 +1,5 @@
 require 'erb'
-require 'locomotive/steam/middlewares/threadsafe'
+require 'locomotive/steam/middlewares/thread_safe'
 require 'locomotive/steam/middlewares/helpers'
 
 module Locomotive::Wagon

data/lib/locomotive/wagon/version.rb

@@ -1,5 +1,5 @@
 module Locomotive
   module Wagon
-    VERSION = '2.0.0-beta.2'
+    VERSION = '2.0.0.rc1'
   end
 end

data/locomotivecms_wagon.gemspec

@@ -25,8 +25,8 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'rubyzip',               '~> 1.1.7'
   gem.add_dependency 'netrc',                 '~> 0.10.3'
 
-  gem.add_dependency 'locomotivecms_coal',    '~> 1.0.0-beta.2'
-  gem.add_dependency 'locomotivecms_steam',   '~> 1.0.0-beta.3'
+  gem.add_dependency 'locomotivecms_coal',    '~> 1.0.0.rc1'
+  gem.add_dependency 'locomotivecms_steam',   '~> 1.0.0.rc1'
 
   gem.add_dependency 'listen',                '~> 2.10.0'
   gem.add_dependency 'rack-livereload',       '~> 0.3.15'

data/spec/fixtures/cassettes/authenticate.yml

@@ -27,16 +27,16 @@ http_interactions:
       Cache-Control:
       - no-cache
       X-Request-Id:
-      - d5acbb60-75e3-4167-91bc-1f6aee2caaa9
+      - 9fd5095f-e1f8-46bd-af70-4937d8952fa9
       X-Runtime:
-      - '0.405045'
+      - '0.475989'
       Content-Length:
       - '40'
     body:
       encoding: UTF-8
       string: '{"message":"Invalid email or password."}'
     http_version: 
-  recorded_at: Tue, 11 Aug 2015 16:47:38 GMT
+  recorded_at: Sat, 03 Oct 2015 22:51:13 GMT
 - request:
     method: post
     uri: http://localhost:3000/locomotive/api/v3/my_account.json
@@ -60,20 +60,20 @@ http_interactions:
       Content-Type:
       - application/json
       Etag:
-      - W/"2af9bbd65bd5918efea9dd9fd195971d"
+      - W/"f11c118ac1f73d61c33c0fe3b83a4bbe"
       Cache-Control:
       - max-age=0, private, must-revalidate
       X-Request-Id:
-      - 05621e5a-d0fc-4850-974b-025767e46794
+      - 0d392097-4546-4dea-aed7-aa78812b2cc6
       X-Runtime:
-      - '0.078440'
+      - '0.076062'
       Content-Length:
       - '250'
     body:
       encoding: UTF-8
-      string: '{"_id":"55ca272a87f6432b4e000000","created_at":"2015-08-11T16:47:38Z","updated_at":"2015-08-11T16:47:38Z","name":"John","email":"john@doe.net","locale":"en","api_key":"3e4794ac44f4cbf9efc9277eb59384120418c02b","super_admin":false,"local_admin":false}'
+      string: '{"_id":"56105be187f6432346000000","created_at":"2015-10-03T22:51:13Z","updated_at":"2015-10-03T22:51:13Z","name":"John","email":"john@doe.net","locale":"en","api_key":"d4e4bcc95dbaa0bc964fe5d759af3e17ae87b55f","super_admin":false,"local_admin":false}'
     http_version: 
-  recorded_at: Tue, 11 Aug 2015 16:47:38 GMT
+  recorded_at: Sat, 03 Oct 2015 22:51:13 GMT
 - request:
     method: post
     uri: http://localhost:3000/locomotive/api/v3/tokens.json
@@ -97,23 +97,23 @@ http_interactions:
       Content-Type:
       - application/json
       Etag:
-      - W/"3b6ceb0d2ba232a8d48dd0dc8f702ef4"
+      - W/"a9163fdeb161e2c161f3a0f3efe49ba1"
       Cache-Control:
       - max-age=0, private, must-revalidate
       X-Request-Id:
-      - 2bed1193-24c8-46d0-bcf3-6e462c4177ee
+      - 45b0e958-c517-473e-aabb-6c905328665a
       X-Runtime:
-      - '0.016216'
+      - '0.016623'
       Content-Length:
       - '32'
     body:
       encoding: UTF-8
-      string: '{"token":"xM_3r1zn2aQAinPFqSvd"}'
+      string: '{"token":"a2muK9TeBmVrpA5XrYQa"}'
     http_version: 
-  recorded_at: Tue, 11 Aug 2015 16:47:38 GMT
+  recorded_at: Sat, 03 Oct 2015 22:51:13 GMT
 - request:
     method: get
-    uri: http://localhost:3000/locomotive/api/v3/my_account.json?auth_token=xM_3r1zn2aQAinPFqSvd
+    uri: http://localhost:3000/locomotive/api/v3/my_account.json?auth_token=a2muK9TeBmVrpA5XrYQa
     body:
       encoding: US-ASCII
       string: ''
@@ -123,7 +123,7 @@ http_interactions:
       X-Locomotive-Account-Email:
       - admin@locomotivecms.com
       X-Locomotive-Account-Token:
-      - xM_3r1zn2aQAinPFqSvd
+      - a2muK9TeBmVrpA5XrYQa
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       User-Agent:
@@ -136,24 +136,23 @@ http_interactions:
       Content-Type:
       - application/json
       Etag:
-      - W/"52bd05e384c279a85dca7d54c93622f3"
+      - W/"eca3fa55990117bf008694b4895520d9"
       Cache-Control:
       - max-age=0, private, must-revalidate
       X-Request-Id:
-      - 1ff524e7-715b-4a2d-b282-281975ca8f94
+      - fc3ee76e-4de2-4487-bfc4-9b51d7842cd7
       X-Runtime:
-      - '0.050613'
+      - '0.027375'
       Content-Length:
-      - '264'
+      - '261'
     body:
       encoding: UTF-8
-      string: '{"_id":"55c9f4a387f6432a1e000000","created_at":"2015-08-11T13:12:03Z","updated_at":"2015-08-11T13:12:39Z","name":"John
-        Doe","email":"admin@locomotivecms.com","locale":"en","api_key":"d49cd50f6f0d2b163f48fc73cb249f0244c37074","super_admin":false,"local_admin":true}'
+      string: '{"_id":"56105bac87f6432326000000","created_at":"2015-10-03T22:50:20Z","updated_at":"2015-10-03T22:50:20Z","name":"Admin","email":"admin@locomotivecms.com","locale":"en","api_key":"d49cd50f6f0d2b163f48fc73cb249f0244c37074","super_admin":false,"local_admin":true}'
     http_version: 
-  recorded_at: Tue, 11 Aug 2015 16:47:38 GMT
+  recorded_at: Sat, 03 Oct 2015 22:51:13 GMT
 - request:
     method: get
-    uri: http://localhost:3000/locomotive/api/v3/my_account.json?auth_token=xM_3r1zn2aQAinPFqSvd
+    uri: http://localhost:3000/locomotive/api/v3/my_account.json?auth_token=a2muK9TeBmVrpA5XrYQa
     body:
       encoding: US-ASCII
       string: ''
@@ -163,7 +162,7 @@ http_interactions:
       X-Locomotive-Account-Email:
       - admin@locomotivecms.com
       X-Locomotive-Account-Token:
-      - xM_3r1zn2aQAinPFqSvd
+      - a2muK9TeBmVrpA5XrYQa
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       User-Agent:
@@ -176,19 +175,18 @@ http_interactions:
       Content-Type:
       - application/json
       Etag:
-      - W/"52bd05e384c279a85dca7d54c93622f3"
+      - W/"eca3fa55990117bf008694b4895520d9"
       Cache-Control:
       - max-age=0, private, must-revalidate
       X-Request-Id:
-      - 41e6457b-6fba-4e25-b58d-43bd072c22bd
+      - f29a44e9-95b9-46ca-950c-522f4fc36cee
       X-Runtime:
-      - '0.014797'
+      - '0.013873'
       Content-Length:
-      - '264'
+      - '261'
     body:
       encoding: UTF-8
-      string: '{"_id":"55c9f4a387f6432a1e000000","created_at":"2015-08-11T13:12:03Z","updated_at":"2015-08-11T13:12:39Z","name":"John
-        Doe","email":"admin@locomotivecms.com","locale":"en","api_key":"d49cd50f6f0d2b163f48fc73cb249f0244c37074","super_admin":false,"local_admin":true}'
+      string: '{"_id":"56105bac87f6432326000000","created_at":"2015-10-03T22:50:20Z","updated_at":"2015-10-03T22:50:20Z","name":"Admin","email":"admin@locomotivecms.com","locale":"en","api_key":"d49cd50f6f0d2b163f48fc73cb249f0244c37074","super_admin":false,"local_admin":true}'
     http_version: 
-  recorded_at: Tue, 11 Aug 2015 16:47:38 GMT
+  recorded_at: Sat, 03 Oct 2015 22:51:13 GMT
 recorded_with: VCR 2.9.3