cavalerie_web 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29a657fe6a1d7a824ca68d7c2f9727b69e76b3da
+  data.tar.gz: 72854351f19fbe74bf11254ac4be05563227c5d1
+SHA512:
+  metadata.gz: 94bdfd19e535a244ddc3a114c1a835f1358bb88e43fd6ac70d49e8091c08ee1b3da5cf1fb941f8ac155d8e43770968b95fe579cce1c70245a465192bb199e5bb
+  data.tar.gz: 8934f480efe3e21be7a9b071e009187c8349e78c0dd85985a028a57d5cf8ce9030799e7b99fd80087ef90ebb6e0b815ededcbdfc49471dfb8835594c20c84ba9

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+tmp/
+/vendor/
+*.gem
+.vagrant
+*.log
+.DS_Store
+sites_virtualhosts

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cavalerie_web.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,77 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(bin lib lib/cavalerie_web spec)
+
+## Uncomment to clear the screen before every task
+clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Arnaud Lenglet
+
+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,36 @@
+# Cavalerie Web Gem
+
+[ ![Codeship Status for lacavalerie/cavalerie_web_gem](https://codeship.com/projects/7190ffb0-c0e1-0132-055e-6ae52d217161/status?branch=master)](https://codeship.com/projects/73341)
+
+## Installation
+
+In your Terminal, run the following commands:
+
+```bash
+$ gem install cavalerie_web
+
+$ cavalerie init
+```
+
+Then follow instructions to complete installation.
+
+## Usage
+
+Right after the installation is completed, you can run:
+
+```bash
+$ cavalerie up
+```
+
+This will power up a virtual machine inside VirtualBox, with:
+- Apache2 web server
+- MySQL server
+- phpMyAdmin
+
+At any time, to know the current status, you can run:
+
+```bash
+$ cavalerie status
+```
+
+To get help, feel free to run the command `cavalerie` without argument.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/cavalerie

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "cavalerie_web"
+
+CavalerieWeb::CLI::Command.start ARGV

data/cavalerie_web.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "cavalerie_web"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Arnaud Lenglet"]
+  spec.email         = ["arlenglet@gmail.com"]
+
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = "http://mygemserver.com"
+  end
+
+  spec.summary       = %q{La Cavalerie web toolbox}
+  spec.description   = %q{Contain everything your need to create and manage websites}
+  spec.homepage      = "https://bitbucket.org/lacavalerie/web_toolbox"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   << "cavalerie"
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "thor", "~> 0.19"
+  spec.add_runtime_dependency "colorize", "~> 0.7"
+  spec.add_runtime_dependency "ghost", "~> 1.0"
+  spec.add_runtime_dependency "ptools", "~> 1.3"
+  spec.add_runtime_dependency "mysql2", "~> 0.3"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec-core", '~> 3.2'
+  spec.add_development_dependency "rspec-mocks", "~> 3.2"
+  spec.add_development_dependency "rspec-expectations", '~> 3.2'
+  spec.add_development_dependency "rspec", '~> 3.2'
+  spec.add_development_dependency "guard", '~> 2.12'
+  spec.add_development_dependency "guard-rspec", '~> 4.5'
+end

data/lib/cavalerie_web/checks/file_folder_check.rb

@@ -0,0 +1,23 @@
+module CavalerieWeb
+
+  class FileFolderCheck
+
+    def self.is_a_required_folder_unavailable?
+      unavailable_folders = []
+
+      Config.get_required_folders_list.each do |folder_name|
+        folder_path = get_folder_path folder_name
+        unavailable_folders << folder_path unless File.directory? folder_path
+      end
+
+      unavailable_folders unless unavailable_folders.empty?
+    end
+
+    private
+      def self.get_folder_path folder_name
+        eval("$#{folder_name}_folder_path")
+      end
+
+  end
+
+end

data/lib/cavalerie_web/checks/vagrant_check.rb

@@ -0,0 +1,24 @@
+require 'ptools'
+
+module CavalerieWeb
+
+  class VagrantCheck
+
+    def self.is_vagrant_installed?
+      !File.which("vagrant").nil?
+    end
+
+    def self.is_a_required_plugin_missing?
+      missing_plugins = []
+
+      installed_plugins = VagrantHelper.plugin_list
+      Config.get_required_plugins_list.each do |plugin|
+        missing_plugins << plugin unless installed_plugins.include? plugin
+      end
+
+      missing_plugins unless missing_plugins.empty?
+    end
+
+  end
+
+end

data/lib/cavalerie_web/cli/command.rb

@@ -0,0 +1,37 @@
+module CavalerieWeb::CLI
+
+  class Command < Thor
+
+    desc "up", "Kickoff everything! Initial checks, then Vagrant Up, followed by starting Apache/Mysql servers start inside docker containers"
+    def up
+      CavalerieWeb::Banner.cavalerie
+      CavalerieWeb::SequenceManager.start_sequence :cavalerie_up
+    end
+
+    desc "refresh", "Update Hosts file + Apache VirtualHosts, useful after adding a new website"
+    def refresh
+      CavalerieWeb::Banner.cavalerie
+      CavalerieWeb::SequenceManager.start_sequence :cavalerie_refresh
+    end
+
+    desc "status", "Status of Vagrant VM, Docker containers and sites"
+    def status
+      CavalerieWeb::Banner.cavalerie
+      CavalerieWeb::SequenceManager.start_sequence :cavalerie_status
+    end
+
+    desc "destroy", "Stop Apache and MySQL server containers and poweroff virtual machine"
+    def destroy
+      CavalerieWeb::Banner.cavalerie
+      CavalerieWeb::SequenceManager.start_sequence :cavalerie_destroy
+    end
+
+    desc "init", "Configure everything to be up and runnnig quicky"
+    def init
+      CavalerieWeb::Banner.cavalerie
+      CavalerieWeb::SequenceManager.start_sequence :cavalerie_init
+    end
+
+  end
+
+end

data/lib/cavalerie_web/cli/subcommands/new.rb

@@ -0,0 +1,13 @@
+class CavalerieWeb::CLI::Subcommand::New < Thor
+
+    desc "website", "Create a new empty website structure"
+    def website
+      p "Not implemented yet"
+    end
+
+    desc "wordpress", "Same as website + install WordPress Skeleton"
+    def wordpress
+      p "Not implemented yet"
+    end
+
+end

data/lib/cavalerie_web/cli/subcommands/server.rb

@@ -0,0 +1,23 @@
+module CavalerieWeb::CLI::Subcommand
+
+  class Server < Thor
+
+    desc "start", "Run Docker containers"
+    def start
+      CavalerieWeb::SequenceManager.start_sequence :cavalerie_server_start
+    end
+
+    desc "stop", "Stop Docker containers"
+    def stop
+      CavalerieWeb::SequenceManager.start_sequence :cavalerie_server_stop
+    end
+
+    desc "restart", "Stop then start Docker containers"
+    def restart
+      CavalerieWeb::SequenceManager.start_sequence :cavalerie_server_start
+      CavalerieWeb::SequenceManager.start_sequence :cavalerie_server_stop
+    end
+
+  end
+
+end

data/lib/cavalerie_web/configs/VirtualHost.sample

@@ -0,0 +1,8 @@
+<VirtualHost *:80>
+  ServerAdmin maintenance@agencecavalerie.com
+  DocumentRoot /var/www/_site_name_here_
+  ServerName _site_name_here_.dev
+  ServerAlias www._site_name_here_.dev
+  ErrorLog "/var/www/_site_name_here_/logs/dev-_site_name_here_-error_log"
+  CustomLog "/var/www/_site_name_here_/logs/dev-_site_name_here_-access_log" common
+</VirtualHost>

data/lib/cavalerie_web/configs/apache_container_ip

@@ -0,0 +1 @@
+172.17.0.5

data/lib/cavalerie_web/configs/config.rb

@@ -0,0 +1,55 @@
+require 'json'
+require 'fileutils'
+
+module CavalerieWeb
+
+  class Config
+
+    Thread.abort_on_exception = true
+
+    def self.get_environment_variables
+      {
+        sites: { name: "CAVALERIE_SITES_PATH", folder: "sites", description: "This is where your sites will live." },
+        shared: { name: "CAVALERIE_SHARED_PATH", folder: "shared", description: "This is the shared folder used by WordPress" },
+        mysql: { name: "CAVALERIE_MYSQL_PATH", folder: "mysql", description: "This is your main MySQL directory, used by MySQL server." },
+        export: { name: "CAVALERIE_EXPORT_PATH", folder: "export", description: <<-EOF
+This folder will be use to share non-versionned stuff between mates, like DB dumps and assets.
+This folder could be sync via rsync or Dropbox/Google Drive.
+Use of NFS mount is discouraged since it could lead to stability issue
+(in case of network error, when you work offline for example)."
+        EOF
+        }
+      }
+    end
+
+    def self.get_required_plugins_list
+      ["vagrant-hostmanager", "vagrant-share"]
+    end
+
+    def self.get_required_folders_list
+      ["sites", "shared", "mysql", "credentials", "samples", "db_dumps", "export"]
+    end
+
+    def self.get_containers_names
+      get_docker_configs["containers_names"]
+    end
+
+    def self.get_docker_configs
+      docker_configs_file = File.read "#{$configs_path}/docker_configs.json"
+      parsed = JSON.parse docker_configs_file
+    end
+
+    def self.get_setup_status
+      setup_status_file = File.read "#{$configs_path}/setup_status.json"
+      parsed = JSON.parse setup_status_file
+    end
+
+    def self.reset_setup_status
+      setup_status_file_default = "#{$configs_path}/setup_status.default.json"
+      setup_status_file = "#{$configs_path}/setup_status.json"
+      FileUtils.cp setup_status_file_default, setup_status_file
+    end
+
+  end
+
+end

data/lib/cavalerie_web/configs/docker_configs.json

@@ -0,0 +1,22 @@
+// Variables used by Vagrantfiles to configure
+// Docker containers and then completed by
+// containers at runtime.
+
+{
+  "containers_names": ["mysql-server", "apache-server", "phpmyadmin"],
+
+  "mysql-server_container_ip": "",
+  "mysql-server_user": "dev",
+  "mysql-server_user_password": "devpass",
+  "mysql-server_root_password": "cavalerie",
+  "mysql-server_os": "Ubuntu 4.8.2-19",
+  "mysql-server_version": "MySQL Community Server 5.6.24",
+  "mysql-server_post_start_script": false,
+
+  "apache-server_container_ip": "",
+  "apache-server_os": "Debian",
+  "apache-server_version": "Apache/2.2.22",
+  "apache-server_post_start_script": false,
+
+  "phpmyadmin_post_start_script": false
+}

data/lib/cavalerie_web/configs/local-config.sample.php

@@ -0,0 +1,15 @@
+<?php
+
+define( 'DB_NAME', '_db_name_here_' );
+define( 'DB_USER', 'dev' );
+define( 'DB_PASSWORD', 'cavalerie' );
+define( 'DB_HOST', '_db_host_here_' );
+
+define( 'AUTH_KEY', '_auth_key_here_' );
+define( 'SECURE_AUTH_KEY',  '_secure_auth_key_here_' );
+define( 'LOGGED_IN_KEY', '_logged_in_key_here_' );
+define( 'NONCE_KEY', '_nonce_key_here_' );
+define( 'AUTH_SALT', '_auth_salt_here_' );
+define( 'SECURE_AUTH_SALT',  '_secure_auth_salt_here_' );
+define( 'LOGGED_IN_SALT', '_logged_in_salt_here_' );
+define( 'NONCE_SALT', '_nonce_salt_here_' );

data/lib/cavalerie_web/configs/mysql_container_ip

@@ -0,0 +1 @@
+172.17.0.1

data/lib/cavalerie_web/configs/setup_status.default.json

@@ -0,0 +1,13 @@
+// File used to speed up EnsureSetupIsCorrectSequence
+// When the sequence is successfully completed one,
+// the result is written to this file.
+// This allow us not to check for Vagrant + plugins
+// installation every time we run a command.
+//
+// When an error is raised during a sequence, the values
+// are reset to false
+
+{
+  "is_vagrant_installed?": false,
+  "are_required_plugins_installed?": false
+}

data/lib/cavalerie_web/configs/setup_status.json

@@ -0,0 +1,13 @@
+// File used to speed up EnsureSetupIsCorrectSequence
+// When the sequence is successfully completed one,
+// the result is written to this file.
+// This allow us not to check for Vagrant + plugins
+// installation every time we run a command.
+//
+// When an error is raised during a sequence, the values
+// are reset to false
+
+{
+  "is_vagrant_installed?": false,
+  "are_required_plugins_installed?": false
+}

data/lib/cavalerie_web/errors/container_not_running_error.rb

@@ -0,0 +1,2 @@
+class ContainerNotRunningError < StandardError
+end

data/lib/cavalerie_web/errors/logs_folder_not_found_error.rb

@@ -0,0 +1,2 @@
+class LogsFolderNotFoundError < StandardError
+end

data/lib/cavalerie_web/errors/max_retries_reach_error.rb

@@ -0,0 +1,2 @@
+class MaxRetriesReachError < StandardError
+end

data/lib/cavalerie_web/errors/required_folder_unavailable_error.rb

@@ -0,0 +1,2 @@
+class RequiredFolderUnavailableError < StandardError
+end

data/lib/cavalerie_web/errors/required_plugin_missing_error.rb

@@ -0,0 +1,2 @@
+class RequiredPluginMissingError < StandardError
+end

data/lib/cavalerie_web/errors/unable_to_access_hosts_file_on_windows_os_error.rb

@@ -0,0 +1,2 @@
+class UnableToAccessHostsFileOnWindowsOSError < StandardError
+end

data/lib/cavalerie_web/errors/unknown_docker_container_status_error.rb

@@ -0,0 +1,2 @@
+class UnknownDockerContainerStatusError < StandardError
+end

data/lib/cavalerie_web/errors/vagrant_not_installed_error.rb

@@ -0,0 +1,2 @@
+class VagrantNotInstalledError < StandardError
+end

data/lib/cavalerie_web/errors/vagrant_vm_already_running_error.rb

@@ -0,0 +1,2 @@
+class VagrantVMAlreadyRunningError < StandardError
+end

data/lib/cavalerie_web/errors/vagrant_vm_not_running_error.rb

@@ -0,0 +1,2 @@
+class VagrantVMNotRunningError < StandardError
+end

data/lib/cavalerie_web/errors/virtual_host_file_not_found_error.rb

@@ -0,0 +1,2 @@
+class VirtualHostFileNotFoundError < StandardError
+end

data/lib/cavalerie_web/helpers/os_helper.rb

@@ -0,0 +1,9 @@
+require 'rbconfig'
+
+class CavalerieWeb::OSHelper
+
+  def self.is_windows?
+    RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
+  end
+
+end

data/lib/cavalerie_web/helpers/vagrant_helper.rb

@@ -0,0 +1,73 @@
+require 'open3'
+
+module CavalerieWeb
+
+  class VagrantHelper
+
+    def self.start_container container_name
+      puts Message.notice "Starting container \"#{container_name}\""
+      long_vagrant_command "vagrant up #{container_name}"
+    end
+
+    def self.plugin_list
+      vagrant_command "vagrant plugin list"
+    end
+
+    def self.plugin_install plugin_name
+      vagrant_command "vagrant plugin install #{plugin_name}"
+      puts Message.success "Plugin \"#{plugin_name}\": installation completed."
+    end
+
+    def self.destroy_container container_name
+      vagrant_command "vagrant destroy -f #{container_name}"
+      puts Message.notice "Container \"#{container_name}\" destroyed"
+    end
+
+    def self.status container_name=nil
+      vagrant_command "vagrant status #{container_name}"
+    end
+
+    def self.run_script container_name, script_path
+      puts Message.notice "Running script \"#{script_path}\" inside container \"#{container_name}\""
+      background_vagrant_command "vagrant docker-run -t #{container_name} -- /bin/bash -c #{script_path}"
+    end
+
+    private
+
+      def self.move_to_vagrant_folder
+        vagrant_directory_path = "#{$gem_path}/lib/vagrant"
+        if Dir.pwd != vagrant_directory_path
+          Dir.chdir vagrant_directory_path
+        end
+      end
+
+      def self.vagrant_command command
+        move_to_vagrant_folder
+        run_command command
+      end
+
+      def self.background_vagrant_command command
+        move_to_vagrant_folder
+        run_background_command command
+      end
+
+      def self.long_vagrant_command command
+        move_to_vagrant_folder
+        Open3.popen3(command) do |stdin, stdout, stderr, wait_thr|
+          while line = stdout.gets
+            puts line
+          end
+        end
+      end
+
+      def self.run_command command
+        `#{command}`
+      end
+
+      def self.run_background_command command
+        exec command
+      end
+
+  end
+
+end

data/lib/cavalerie_web/managers/database_manager.rb

@@ -0,0 +1,10 @@
+module CavalerieWeb
+
+  class DatabaseManager
+
+    def self.create_sites_database_if_not_exist
+    end
+
+  end
+
+end