locomotivecms_wagon 1.5.8 → 2.0.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6d6087af2e72aea37229a0dadf8f995a72d58d9
-  data.tar.gz: 94fc99a5b5a321e6cd6e6558a3a35bec52be9efb
+  metadata.gz: 739043b4c31b8face271da2d37048fcc126cc8ca
+  data.tar.gz: 5d10493f0944c8d441532881ff2347ff680e7d0a
 SHA512:
-  metadata.gz: 91544d852b84ace2828029c5dd365eedf8ccaed0558300e34add75782e69289c84a087bebe491afb1e828b522d6e261771d6c32b9bcf21ddcf395cbbecc12a98
-  data.tar.gz: 18ff58e922ab4347671519779613511640b0de2d4b5a4fece5a5081917278678aa1fc7b7d38f5b3d83625ed28f772c4b62ba6eda5bb69ebe2ae6438b0a4c0817
+  metadata.gz: 124f103b49617bc7f6185945dbe753259bc19ce350d6e9ba5a5bd44436508e4258a2f54739163d2821952d58df623b705f4c3aba1bcaf294ca97245106ab738c
+  data.tar.gz: 96f069b17d7d062dd831cc5580a525b53a24e2be3ae40c345989ddd20398a5e04335159a9d90b9fa17916b8bf261557001373f1b1d47488adefb206fc8ce718f

data/.gitignore

@@ -2,7 +2,6 @@
 tests
 .sass-cache
 .rbenv-gemsets
-dragonfly.log
 /site
 *.gem
 *.rbc
@@ -27,3 +26,7 @@ spec/fixtures/default/log
 /.sass-cache/
 
 /tests
+
+/deprecated
+
+dragonfly.log

data/.rspec

@@ -1,2 +1 @@
 --colour
---backtrace

data/Gemfile

@@ -13,7 +13,22 @@ gem 'rb-fsevent', '~> 0.9.1'
 
 gem 'therubyracer'
 
+# gem 'locomotivecms_steam', github: 'locomotivecms/steam', ref: 'b2de77e', require: false
+# gem 'locomotivecms_coal', github: 'locomotivecms/coal', ref: '32b2844', require: false
+# gem 'locomotivecms_common', github: 'locomotivecms/common', ref: '3046b79893', require: false
+
+# gem 'locomotivecms_coal', path: '../in_progress/coal', require: false
+# gem 'locomotivecms_steam', path: '../in_progress/steam', require: false
+# gem 'locomotivecms_common', path: '../in_progress/common', require: false
+
 group :test do
-  gem 'pry'
-  gem 'coveralls', require: false
+  gem 'rspec',              '~> 3.2.0'
+  gem 'json_spec',          '~> 1.1.4'
+
+  gem 'pry-byebug',         '~> 3.1.0'
+
+  gem 'webmock'
+  gem 'vcr'
+
+  gem 'coveralls',                  '~> 0.7.11', require: false
 end

data/README.md

@@ -1,10 +1,6 @@
 # LocomotiveCMS::Wagon
 
-[![Gem Version](https://badge.fury.io/rb/locomotivecms_wagon.svg)](http://badge.fury.io/rb/locomotivecms_wagon)
-[![Code Climate](https://codeclimate.com/github/locomotivecms/wagon.png)](https://codeclimate.com/github/locomotivecms/wagon)
-[![Dependency Status](https://gemnasium.com/locomotivecms/wagon.png)](https://gemnasium.com/locomotivecms/wagon)
-[![Build Status](https://travis-ci.org/locomotivecms/wagon.svg?branch=master)](https://travis-ci.org/locomotivecms/wagon)
-[![Coverage Status](https://coveralls.io/repos/locomotivecms/wagon/badge.png)](https://coveralls.io/r/locomotivecms/wagon)
+[![Gem Version](https://badge.fury.io/rb/locomotivecms_wagon.svg)](http://badge.fury.io/rb/locomotivecms_wagon) [![Code Climate](https://codeclimate.com/github/locomotivecms/wagon/badges/gpa.svg)](https://codeclimate.com/github/locomotivecms/wagon) [![Dependency Status](https://gemnasium.com/locomotivecms/wagon.png)](https://gemnasium.com/locomotivecms/wagon) [![Build Status](https://travis-ci.org/locomotivecms/wagon.svg?branch=master)](https://travis-ci.org/locomotivecms/wagon) [![Coverage Status](https://coveralls.io/repos/locomotivecms/wagon/badge.svg?branch=master)](https://coveralls.io/r/locomotivecms/wagon?branch=master)
 
 Wagon is the official site generator for the LocomotiveCMS engine powered by all the efficient and modern HTML development tools (Haml, SASS, Compass, Less).
 
@@ -37,7 +33,7 @@ Please, visit the documentation website of LocomotiveCMS.
 
 #### Run the server with a default site
 
-    $ bundle exec bin/wagon serve <path to the mounter gem>/spec/fixtures/default
+    $ bundle exec bin/wagon serve spec/fixtures/default
 
 #### Push a site
 

data/Rakefile

@@ -25,23 +25,8 @@ task release: :gem do
   sh "gem push pkg/locomotivecms_wagon-#{gemspec.version}.gem"
 end
 
-namespace :development do
-  desc 'create vcr cassettes'
-  task :bootstrap do
-    VCR.configure do |c|
-      c.cassette_library_dir = File.expand_path(File.dirname(__FILE__) + '/spec/integration/cassettes')
-      c.hook_into :webmock # or :fakeweb
-      c.allow_http_connections_when_no_cassette = true
-    end
-
-    FileUtils.rm_rf(File.join(File.dirname(__FILE__), 'site'))
-    VCR.use_cassette('pull') do
-      exit unless Locomotive::Wagon.clone('site', '.', { host: 'sample.example.com:3000', email: 'admin@locomotivecms.com', password: 'locomotive' })
-    end
-
-    Locomotive::Wagon.push('site', {host: 'sample.example.com:3000', email: 'admin@locomotivecms.com', password: 'locomotive'}, force: true, translations: false, data: true)
-  end
-end
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
 
 RSpec::Core::RakeTask.new('spec:unit') do |spec|
   spec.pattern = 'spec/unit/**/*_spec.rb'
@@ -52,6 +37,4 @@ RSpec::Core::RakeTask.new('spec:integration') do |spec|
   spec.pattern = 'spec/integration/**/*_spec.rb'
 end
 
-task spec: ['spec:integration']
-
-task default: :spec
+task default: :spec

data/lib/locomotive/wagon/cli.rb

@@ -177,14 +177,16 @@ module Locomotive
           say Locomotive::Wagon::VERSION
         end
 
-        desc 'auth [EMAIL] [PASSWORD]', 'Log into the LocomotiveHosting platform'
-        def auth(email = nil, password = nil)
-          say "LocomotiveHosting Sign in/up\n\n", :bold
+        desc 'auth [EMAIL] [PASSWORD] [PLATFORM_URL]', 'Log into your Locomotive platform'
+        def auth(email = nil, password = nil, platform_url = nil)
+          say "Locomotive Sign in/up\n\n", :bold
 
-          email     ||= ask('Enter your e-mail?')
-          password  ||= ask('Enter your password?')
+          platform_url ||= ask("Enter the URL of your platform? (default: #{Locomotive::Wagon::DEFAULT_PLATFORM_URL})")
+          platform_url = Locomotive::Wagon::DEFAULT_PLATFORM_URL if platform_url.strip == ''
+          while email.to_s.strip == ''; email = ask('Enter your e-mail?'); end
+          while password.to_s.strip == ''; password = ask('Enter your password?', echo: false); end
 
-          Locomotive::Wagon.authenticate(email, password, shell)
+          Locomotive::Wagon.authenticate(platform_url, email, password, shell)
         end
 
         desc 'init NAME [PATH] [GENERATOR_OPTIONS]', 'Create a brand new site'
@@ -297,24 +299,17 @@ module Locomotive
 
         desc 'push ENV [PATH]', 'Push a site to a remote LocomotiveCMS Engine'
         method_option :resources, aliases: '-r', type: 'array', default: nil, desc: 'Only push the resource(s) passed in argument'
-        method_option :force, aliases: '-f', type: 'boolean', default: false, desc: 'Force the push of a resource'
-        method_option :translations, aliases: '-t', type: 'boolean', default: false, desc: 'Push the local translations (by default, they are not)'
         method_option :data, aliases: '-d', type: 'boolean', default: false, desc: 'Push the content entries and the editable elements (by default, they are not)'
-        method_option :only_resource, aliases: '-o', type: 'array', default: [], desc: 'Push only the resources whose slug / fullpath matches the list of strings passed in argument'
         method_option :shell, type: 'boolean', default: true, desc: 'Use shell to ask for missing connection information like the subdomain (in this case, take a random one)'
         method_option :verbose, aliases: '-v', type: 'boolean', default: false, desc: 'display the full error stack trace if an error occurs'
         def push(env, path = '.')
           force_color_if_asked(options)
 
           if check_path!(path)
-            if connection_info = self.retrieve_connection_info(env, path, options[:shell])
-              begin
-                Locomotive::Wagon.push(path, connection_info, options)
-              rescue Exception => e
-                self.print_exception(e, options[:verbose])
-                exit(1)
-              end
-            else
+            begin
+              Locomotive::Wagon.push(env, path, options)
+            rescue Exception => e
+              self.print_exception(e, options[:verbose])
               exit(1)
             end
           end
@@ -381,28 +376,28 @@ module Locomotive
           end
         end
 
-        # From a site specified by a path, retrieve the information of the connection
-        # for a environment located in the config/deploy.yml file of the site.
-        #
-        # @param [ String ] env The environment (development, staging, production, ...etc)
-        # @param [ String ] path The path of the local site
-        # @param [ Boolean ] use_shell True by default, use it to ask for missing information (subdomain for instance)
-        #
-        # @return [ Hash ] The information of the connection or nil if errors
-        #
-        def retrieve_connection_info(env, path, use_shell = true)
-          require 'locomotive/wagon/misc/deployment_connection'
-
-          begin
-            service = Locomotive::Wagon::DeploymentConnection.new(path, use_shell ? shell : nil)
-
-            service.get_information(env)
-
-          rescue Exception => e
-            self.print_exception(e, options[:verbose])
-            nil
-          end
-        end
+        # # From a site specified by a path, retrieve the information of the connection
+        # # for a environment located in the config/deploy.yml file of the site.
+        # #
+        # # @param [ String ] env The environment (development, staging, production, ...etc)
+        # # @param [ String ] path The path of the local site
+        # # @param [ Boolean ] use_shell True by default, use it to ask for missing information (subdomain for instance)
+        # #
+        # # @return [ Hash ] The information of the connection or nil if errors
+        # #
+        # def retrieve_connection_info(env, path, use_shell = true)
+        #   require 'locomotive/wagon/misc/deployment_connection'
+
+        #   begin
+        #     service = Locomotive::Wagon::DeploymentConnection.new(path, use_shell ? shell : nil)
+
+        #     service.get_information(env)
+
+        #   rescue Exception => e
+        #     self.print_exception(e, options[:verbose])
+        #     nil
+        #   end
+        # end
 
       end
 

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

@@ -0,0 +1,65 @@
+require_relative 'concerns/api_concern'
+require_relative 'concerns/netrc_concern'
+
+module Locomotive::Wagon
+
+  class AuthenticateCommand < Struct.new(:platform_url, :email, :password, :shell)
+
+    include ApiConcern
+    include NetrcConcern
+
+    def self.authenticate(platform_url, email, password, shell)
+      self.new(platform_url, email, password, shell).authenticate
+    end
+
+    def authenticate
+      if api_key = fetch_api_key
+        write_credentials_to_netrc(api_host, email, api_key)
+      else
+        shell.say "Sorry, we were unable to authenticate you on \"#{platform_url}\"", :red
+      end
+
+      !api_key.nil?
+    end
+
+    def fetch_api_key
+      if my_account
+        my_account.api_key
+      else
+        shell.say "No account found for #{email} or invalid credentials", :yellow
+
+        # shall we create a new account?
+        if shell.yes?('Do you want to create a new account? [Y/N]')
+          create_account
+        else
+          false
+        end
+      end
+    end
+
+    def create_account
+      name = shell.ask 'What is your name?'
+
+      begin
+        account = api_client.my_account.create(name: name, email: email, password: password)
+        shell.say "Your account has been successfully created.", :green
+        account.api_key
+      rescue Locomotive::Coal::Error => e
+        shell.say "We were unable to create your account, reason(s): #{e.message}", :red
+        false
+      end
+    end
+
+    private
+
+    def my_account
+      begin
+        api_client.my_account.get
+      rescue Locomotive::Coal::UnauthorizedError
+        nil
+      end
+    end
+
+  end
+
+end

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

@@ -0,0 +1,57 @@
+require 'locomotive/coal'
+
+module Locomotive::Wagon
+
+  module ApiConcern
+
+    # Instance of the API client to request an account or his/her list of sites.
+    def api_client
+      @api_client ||= Locomotive::Coal::Client.new(api_uri, api_credentials)
+    end
+
+    # Instance of the API client to request resources of a site: pages, theme_assets, ...etc.
+    def api_site_client(connection)
+      return @api_site_client if @api_site_client
+
+      _host, _credentials = connection['host'], connection.slice('email', 'api_key', 'password')
+      _options = connection.slice('ssl', 'handle')
+
+      @api_site_client = Locomotive::Coal::Client.new(_host, _credentials, _options)
+    end
+
+    # Host (+ port) extracted from the platform_url instance variable.
+    # If port equals 80, do not add it to the host.
+    #
+    # Examples:
+    #
+    #     www.myengine.com
+    #     localhost:3000
+    #
+    def api_host
+      uri = api_uri
+      host, port = uri.host, uri.port
+
+      port == 80 ? uri.host : "#{uri.host}:#{uri.port}"
+    end
+
+    def api_credentials
+      if respond_to?(:email)
+        { email: email, password: password }
+      elsif respond_to?(:credentials)
+        credentials
+      end
+    end
+
+    private
+
+    def api_uri
+      if (self.platform_url =~ /^https?:\/\//).nil?
+        self.platform_url = 'http://' + self.platform_url
+      end
+
+      URI(platform_url)
+    end
+
+  end
+
+end

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

@@ -0,0 +1,32 @@
+require 'locomotive/coal'
+
+module Locomotive::Wagon
+
+  module DeployFileConcern
+
+    def write_deploy_setings(env, path, settings)
+      File.open(deploy_file(path), 'a+') do |f|
+        f.write({ env => settings }.to_yaml.sub(/^---/, ''))
+      end
+
+      settings
+    end
+
+    def read_deploy_settings(env, path)
+      # pre-processing: erb code to parse and render?
+      parsed_deploy_file = ERB.new(File.open(deploy_file(path)).read).result
+
+      # finally, get the hash from the YAML file
+      environments = YAML::load(parsed_deploy_file)
+      (environments.is_a?(Hash) ? environments : {})[env.to_s]
+    rescue Exception => e
+      raise "Unable to read the config/deploy.yml file (#{e.message})"
+    end
+
+    def deploy_file(path)
+      File.join(path, 'config', 'deploy.yml')
+    end
+
+  end
+
+end

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

@@ -0,0 +1,16 @@
+module Locomotive::Wagon
+
+  module InstrumentationConcern
+
+    def instrument(action, payload = {})
+      ActiveSupport::Notifications.instrument(instrument_scope_name(action), payload)
+    end
+
+    def instrument_scope_name(action)
+      name = self.class.name[/::(\w+)Command$/, 1].underscore
+      ['wagon', name, action.to_s].compact.join('.')
+    end
+
+  end
+
+end

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

@@ -0,0 +1,21 @@
+require 'netrc'
+
+module Locomotive::Wagon
+
+  module NetrcConcern
+
+    def write_credentials_to_netrc(host, email, api_key)
+      netrc = Netrc.read
+      netrc[host] = email, api_key
+      netrc.save
+    end
+
+    def read_credentials_from_netrc(host)
+      if entry = Netrc.read[host]
+        { email: entry.login, api_key: entry.password }
+      end
+    end
+
+  end
+
+end

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

@@ -0,0 +1,24 @@
+require 'locomotive/coal'
+
+module Locomotive::Wagon
+
+  module SteamConcern
+
+    def steam_services
+      return @steam_services if @steam_services
+
+      Locomotive::Steam.configure do |config|
+        config.mode         = :test
+        config.adapter      = { name: :filesystem, path: path }
+        config.asset_path   = File.expand_path(File.join(path, 'public'))
+      end
+
+      @steam_services = Locomotive::Steam::Services.build_instance.tap do |services|
+        repositories = services.repositories
+        services.set_site(repositories.site.all.first)
+        services.locale = services.current_site.default_locale
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,29 @@
+module Locomotive::Wagon
+
+  class GenerateCommand < Struct.new(:name, :args, :options)
+
+    def self.generate(name, args, options)
+      new(name, args, options).generate
+    end
+
+    def generate
+      Bundler.require 'misc'
+
+      generator = generator_klass.new(args, options, { behavior: :skip })
+      generator.destination_root = args.last
+      generator.force_color_if_asked(options)
+      generator.invoke_all
+    end
+
+    private
+
+    def generator_klass
+      lib = "locomotive/wagon/generators/#{name}"
+      require lib
+
+      lib.camelize.constantize
+    end
+
+  end
+
+end

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

@@ -0,0 +1,19 @@
+module Locomotive::Wagon
+
+  class InitCommand < Struct.new(:generator_klass, :args, :options)
+
+    def self.generate(klass, args, options)
+      new(klass, args, options).generate
+    end
+
+    def generate
+      args, opts = Thor::Options.split(self.args)
+
+      generator = generator_klass.new(args, opts, {})
+      generator.force_color_if_asked(options)
+      generator.invoke_all
+    end
+
+  end
+
+end

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

@@ -0,0 +1,59 @@
+module Locomotive::Wagon
+
+  class PushLogger
+
+    def initialize
+      subscribe 'site_created' do |event|
+        log "We created your site with the following handle: #{event.payload[:site].handle}", { mode: :bold }
+      end
+
+      subscribe :start do |event|
+        log "\n"
+        log "Pushing #{event.payload[:name].camelcase}", { color: :black, background: :white }
+      end
+
+      subscribe :persist do |event|
+        log "persisting #{event.payload[:label]}", :white, 2, true
+      end
+
+      subscribe :skip_persisting do |event|
+        log ' [' + 'skip'.colorize(:yellow) + ']'
+      end
+
+      subscribe :persist_with_success do |event|
+        log ' [' + 'done'.colorize(:green) + ']'
+      end
+
+      subscribe :persist_with_error do |event|
+        log ' [' + 'failed'.colorize(:red) + ']'
+        log event.payload[:message], :red, 4
+      end
+    end
+
+    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)
+      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/push_command.rb

@@ -0,0 +1,116 @@
+require 'locomotive/steam'
+
+require_relative 'loggers/push_logger'
+
+require_relative_all 'concerns'
+require_relative_all '../decorators/concerns'
+require_relative_all '../decorators'
+require_relative_all 'push_sub_commands'
+
+module Locomotive::Wagon
+
+  class PushCommand < Struct.new(:env, :path, :options)
+
+    RESOURCES = %w(content_types content_entries pages snippets theme_assets translations).freeze
+
+    RESOURCES_WITH_CONTENT = %w(content_entries translations).freeze
+
+    include ApiConcern
+    include NetrcConcern
+    include DeployFileConcern
+    include SteamConcern
+    include InstrumentationConcern
+
+    attr_accessor :platform_url, :credentials
+
+    def self.push(env, path, options)
+      self.new(env, path, options).push
+    end
+
+    def push
+      PushLogger.new if options[:verbose]
+
+      api_client = api_site_client(connection_information)
+
+      content_assets_pusher = Locomotive::Wagon::PushContentAssetsCommand.new(api_client, steam_services)
+
+      each_resource do |klass|
+        klass.push(api_client, steam_services, content_assets_pusher)
+      end
+    end
+
+    private
+
+    def each_resource
+      RESOURCES.each do |name|
+        next if !options[:resources].blank? && !options[:resources].include?(name)
+
+        next if RESOURCES_WITH_CONTENT.include?(name) && !options[:data]
+
+        klass = "Locomotive::Wagon::Push#{name.camelcase}Command".constantize
+
+        yield klass
+      end
+    end
+
+    def connection_information
+      if information = read_deploy_settings(self.env, self.path)
+        # the deployment env exists and contains all the information we need to move on
+        information
+      else
+        # mandatory to sign in
+        load_credentials_from_netrc
+
+        # create the remote site on the platform
+        site = create_remote_site
+
+        # update the deploy.yml by adding the new env since we've got all the information
+        write_deploy_setings(self.env, self.path, {
+          'host'    => api_host,
+          'handle'  => site.handle,
+          'email'   => credentials[:email],
+          'api_key' => credentials[:api_key]
+        })
+      end
+    end
+
+    def create_remote_site
+      # get an instance of the Steam services in order to load the information about the site (SiteRepository)
+      steam_services.current_site.tap do |site|
+        # ask for a handle if not found (blank: random one)
+        site[:handle] ||= shell.ask "What is the handle of your site?"
+
+        # create the site
+        attributes = SiteDecorator.new(site).to_hash
+        _site = api_client.sites.create(attributes)
+        site[:handle] = _site.handle
+
+        instrument :site_created, site: site
+      end
+    end
+
+    def load_credentials_from_netrc
+      # ask for the platform URL (or LOCOMOTIVE_PLATFORM_URL env variable)
+      ask_for_platform_url
+
+      # retrieve email + api_key. If no entry present in the .netrc, raise an error
+      self.credentials = read_credentials_from_netrc(self.api_host)
+
+      raise 'You need to run wagon authenticate before going further' if self.credentials.nil?
+    end
+
+    def ask_for_platform_url
+      default = ENV['LOCOMOTIVE_PLATFORM_URL'] || DEFAULT_PLATFORM_URL
+
+      url = shell.ask "What is the URL of your platform? (default: #{default})"
+
+      self.platform_url = url.blank? ? default : url
+    end
+
+    def shell
+      options[:shell]
+    end
+
+  end
+
+end