redmine-installer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 764341505a7ad7b1fba7d8a0d1c7c22e2ac1b0ab
+  data.tar.gz: 28432d0c2505c781f50277fd0bb5b1b82fef66a4
+SHA512:
+  metadata.gz: 4d3567200830eb0b380b94e3412bedbe60507f337ebe6204f0a33f6b9d5c37fcba8aaa40292115c029648b436bc8809040a08cd6eb4bda8ad212ae117e004e2c
+  data.tar.gz: 89c151e10c70dd8b1ceb982cd28a36ed446b174b136b6a583091016be48c8afa8655e953261175c596a59025fa781991a679d296fd02076e4c5a55e6dfd564b4

data/.gitignore

@@ -0,0 +1,25 @@
+/.gemtags
+/.tags
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+test/*

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redmine-installer.gemspec
+gemspec
+
+gem 'gli'
+gem 'i18n'
+gem 'ansi'
+gem 'notifier'
+gem 'ruby-progressbar'
+
+group :development do
+  gem 'pry'
+  gem 'rspec'
+  gem 'rspec-mocks'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'rest_client'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ondřej Moravčík
+
+MIT License
+
+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,273 @@
+# Redmine::Installer
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'redmine-installer'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install redmine-installer
+```
+
+## Usage
+
+```
+redmine GLOBAL_ARGUMENTS ACTION ARGUMENTS
+```
+
+#### Global arguments
+
+<table>
+  <thead>
+    <tr>
+      <th>arguments</th>
+      <th>default value</th>
+      <th>description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>--verbose / -v</td>
+      <td>false</td>
+      <td>show verbosed output</td>
+    </tr>
+    <tr>
+      <td>--locale / -l</td>
+      <td>en</td>
+      <td>languages for application</td>
+    </tr>
+  </tbody>
+</table>
+
+
+#### Shortcut
+
+Some commands have defined shortcut for quicker access. Fox example:
+
+```
+redmine install package
+
+# is equal as
+
+redmine i package
+```
+
+Commands shortcut.
+
+```
+i -> install
+u -> upgrade
+b -> backup
+```
+
+#### Common arguments
+
+<table>
+  <thead>
+    <tr>
+      <th>arguments</th>
+      <th>default</th>
+      <th>description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>--environment / --env / -e</td>
+      <td>production</td>
+      <td>
+        environment for redmine
+      </td>
+    </tr>
+  </tbody>
+</table>
+
+### Instalation
+
+You can instal redmine package from archive or git.
+
+#### Steps:
+
+- *1. Redmine root* - where should be new redmine located
+- *2. Load package* - extract package
+- *3. Database configuration* - you can choose type of DB which you want to use
+- *4. Email sending configuration* - email sending configuration
+- *5. Install* - install commands are executed
+- *6. Moving redmine* - redmine is moved from temporarily folder to given redmine_root
+- *7. Webserve configuration* - generating webserver configuration
+
+#### From archive
+
+Supported archives are **.zip** and **.tar.gz**.
+
+```
+# minimal
+redmine install PATH_TO_PACKAGE
+
+# full
+redmine install PATH_TO_PACKAGE --env ENV1,ENV2,ENV3
+```
+
+#### From git
+
+```
+# minimal
+redmine install GIT_REPO --source git
+
+# full
+redmine install GIT_REPO --source git --branch GIT_BRANCH --env ENV1,ENV2,ENV3
+```
+
+##### Arguments
+
+<table>
+  <thead>
+    <tr>
+      <th>argumnest</th>
+      <th>default</th>
+      <th>description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>--branch / -b</td>
+      <td>master</td>
+      <td>
+        branch of git defined by GIT_REPO
+      </td>
+    </tr>
+  </tbody>
+</table>
+
+
+### Upgrade
+
+You can upgrade current redmine by archive or currently defined git repository. If your redmine contain plugins which are not part of new package - all these plugins will be kept otherwise are replaced with those from package.
+
+Final step will ask you if you want save steps configuration. If you say YES, configuration will be stored as profile so next time you can upgrade redmine faster.
+
+```
+redmine upgrade PACKAGE --profile PROFILE_ID
+```
+
+Profiles are stored on *HOME_FOLDER/.redmine-installer-profiles.yml*.
+
+#### Steps:
+
+- *1. Redmine root* - where should be new redmine located
+- *2. Load package* - extract package
+- *3. Validation* - current redmine should be valid
+- *4. Backup* - backup current redmine (see backup section)
+- *5. Upgrading* - install commands are executed
+- *6. Moving redmine* - redmine is moved from temporarily folder to given redmine_root
+- *7. Profile saving* - generating profile (see profile section)
+
+
+#### From archive
+
+```
+# minimal
+redmine upgrade PATH_TO_PACKAGE
+
+# full
+redmine upgrade PATH_TO_PACKAGE --env ENV1,ENV2,ENV3
+```
+
+#### From git
+
+```
+# minimal
+redmine upgrade --source git
+
+# full
+redmine upgrade --source git --env ENV1,ENV2,ENV3
+```
+
+
+### Backup
+
+```
+redmine backup
+```
+
+#### Steps:
+
+- *1. Redmine root* - where should be new redmine located
+- *2. Validation* - current redmine should be valid
+- *3. Backup* - backup current redmine (see backup section)
+- *4. Profile saving* - generating profile (see profile section)
+
+You can choose one of 3 types.
+
+<table>
+  <thead>
+    <tr>
+      <th>Type</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><b>Full backup</b></td>
+      <td>archive full redmine_root folder with all you databases defined at config/database.yml</td>
+    </tr>
+    <tr>
+      <td><b>Backup</b></td>
+      <td>
+        archive
+        <ul>
+          <li>files folder</li>
+          <li>config/database.yml, config/configuration.yml</li>
+          <li>databases</li>
+        </ul>
+      </td>
+    </tr>
+    <tr>
+      <td><b>Only database</b></td>
+      <td>archive only databases</td>
+    </tr>
+  </tbody>
+</table>
+
+## Examples
+
+Simple install and ugrade
+
+```
+$ wget http://www.redmine.org/releases/redmine-2.3.0.zip
+$ wget http://www.redmine.org/releases/redmine-2.5.0.zip
+
+$ redmine install redmine-2.3.0.zip
+$ redmine upgrade redmine-2.5.0.zip
+```
+
+Set languages
+
+```
+$ redmine --locale cs install redmine-2.3.0.zip
+```
+
+Install from git
+
+```
+$ redmine install git@github.com:redmine/redmine.git --source git
+$ redmine upgrade --source git
+```
+
+Install from git with specific branch
+
+```
+$ redmine install git@github.com:redmine/redmine.git --source git --branch 2.3-stable
+$ redmine upgrade --source git
+```
+ 

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test:    :spec

data/bin/redmine

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'redmine-installer'
+
+Redmine::Installer::CLI.start(ARGV)

data/lib/redmine-installer.rb

@@ -0,0 +1,72 @@
+module Redmine
+  module Installer
+    autoload :CLI,          'redmine-installer/cli'
+    autoload :Task,         'redmine-installer/task'
+    autoload :Utils,        'redmine-installer/utils'
+    autoload :Step,         'redmine-installer/step'
+    autoload :ConfigParams, 'redmine-installer/config_param'
+    autoload :Plugin,       'redmine-installer/plugin'
+    autoload :Helper,       'redmine-installer/helper'
+    autoload :Command,      'redmine-installer/command'
+    autoload :Exec,         'redmine-installer/exec'
+    autoload :Profile,      'redmine-installer/profile'
+    autoload :Git,          'redmine-installer/git'
+
+    # Root of the gem
+    def self.root_path
+      @root_path ||= File.expand_path('..', File.dirname(__FILE__))
+    end
+
+    # Path to locales dir
+    def self.locales_path
+      @locales_path ||= File.join(root_path, 'lib', 'redmine-installer', 'locales')
+    end
+
+    # Locales for I18n
+    def self.locales
+      @locales ||= Dir.glob(File.join(locales_path, '*.yml'))
+    end
+
+    # Default configurations fo I18n gem
+    def self.set_i18n
+      I18n.enforce_available_locales = false
+      I18n.load_path = Redmine::Installer.locales
+      I18n.locale = :en
+      I18n.default_locale = :en
+    end
+
+    def self.print_logo
+      $stdout.puts <<-PRINT
+                    _             _                     
+     _ __  ___   __| | _ __ ___  (_) _ __    ___        
+    | '__|/ _ \\ / _` || '_ ` _ \\ | || '_ \\  / _ \\ _____ 
+    | |  |  __/| (_| || | | | | || || | | ||  __/|_____|
+    |_|   \\___| \\__,_||_| |_| |_||_||_| |_| \\___|       
+     _              _          _  _             
+    (_) _ __   ___ | |_  __ _ | || |  ___  _ __ 
+    | || '_ \\ / __|| __|/ _` || || | / _ \\| '__|
+    | || | | |\\__ \\| |_| (_| || || ||  __/| |   
+    |_||_| |_||___/ \\__|\\__,_||_||_| \\___||_|  
+
+    #{I18n.translate(:powered_by)}
+
+      PRINT
+    end
+
+  end
+end
+
+# Requirements
+require 'pry'
+require 'i18n'
+require 'redmine-installer/version'
+require 'redmine-installer/error'
+require 'redmine-installer/ext/string'
+require 'redmine-installer/ext/module'
+require 'redmine-installer/install'
+require 'redmine-installer/upgrade'
+require 'redmine-installer/backup'
+
+# Default configurations
+Redmine::Installer.set_i18n
+Redmine::Installer.print_logo

data/lib/redmine-installer/backup.rb

@@ -0,0 +1,48 @@
+##
+# Backup redmine
+#
+# Usage: `redmine backup`
+#
+# == Steps:
+# 1. Redmine root - where should be new redmine located
+# 2. Validation - current redmine should be valid
+# 3. Backup - backup current redmine (see backup section)
+# 4. Profile saving - generating profile (see profile section)
+#
+# == Types:
+#
+# Full backup::
+#   archive full redmine_root folder with all you databases defined at config/database.yml
+#
+# Backup  archive::
+#   - files folder
+#   - config/database.yml, config/configuration.yml
+#   - databases
+#
+# Only database::
+#   archive only databases
+#
+module Redmine::Installer
+  class Backup < Task
+
+    STEPS = [
+      step::RedmineRoot,
+      step::Validation,
+      step::Backup
+    ]
+
+    attr_accessor :redmine_root
+
+    def initialize(redmine_root, options={})
+      self.redmine_root = redmine_root
+      super(options)
+    end
+
+    def run
+      Redmine::Installer::Profile.load(self, options[:profile])
+      super
+      Redmine::Installer::Profile.save(self) if options[:profile].nil?
+    end
+
+  end
+end