redmine-installer 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf4c9b2139402f260abc11c1a6df7d587640273a
-  data.tar.gz: c1be909a5caecc19b023c665e79aa849a3e526f8
+  metadata.gz: 6952796bd301dde3ee7ca67d1c8f56d03b0df632
+  data.tar.gz: 7f70e35b172302737ef4309d31067d08c3d309ef
 SHA512:
-  metadata.gz: 1b2aeb3bd1a57421b47411cd6d735454146cb0df36b92fdc472610e8802ffdacb2767dd918c004a4b11c25a8f4f429d5e7bad488446025d4dde383889dc96d34
-  data.tar.gz: ba426bac1c039dccac92a8471dba5384ef7b113c0bec6f655e24f5ba388cdada5d46547a67ab6c48952d82653118b1e7927efecc835d3b9008aee64e7ba0e442
+  metadata.gz: fddebfbfe71cc4c9a26283ac5a8242762548130849a1654f330cfda56a7ca1524c95993658fdafadae68807542606519d69f464e68f2ff0279f7780de5a615fd
+  data.tar.gz: 5fa2b8a75e41b6c5cc71bd217c83c7a2f9ab2d7d05506b74e7b43bd01010164c60fc75e4623577d67d03b7677ee9e32ee0978dbd870be6528963747ef459221c

data/README.md

@@ -27,11 +27,16 @@ $ gem install redmine-installer
 Simple install and ugrade
 
 ```
+# From archive
 $ 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
+
+# From website
+$ redmine install v2.3.0
+$ redmine upgrade v2.5.0
 ```
 
 Set languages
@@ -40,20 +45,6 @@ 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
-```
-
 ## Usage
 
 ```
@@ -134,7 +125,7 @@ b -> backup
 
 ## Install
 
-Install new redmine instance from archive or git.
+Install new redmine instance from archive or website.
 
 #### Steps:
 
@@ -161,40 +152,9 @@ redmine install PATH_TO_PACKAGE
 redmine install PATH_TO_PACKAGE --env environment
 ```
 
-#### From git
-
-```
-redmine install GIT_REPO --source git
-
-# with specific branch
-redmine install GIT_REPO --source git --branch GIT_BRANCH --env environment
-```
-
-##### Arguments
-
-<table>
-  <thead>
-    <tr>
-      <th>argument</th>
-      <th>default</th>
-      <th>description</th>
-    </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <td>--branch / -b</td>
-      <td>master</td>
-      <td>
-        git branch
-      </td>
-    </tr>
-  </tbody>
-</table>
-
-
 ## Upgrade
 
-Upgrading existing instance of redmine with archive or 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.
+Upgrading existing instance of redmine with archive or defined version. 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.
 
@@ -227,15 +187,6 @@ redmine upgrade PATH_TO_PACKAGE
 redmine upgrade PATH_TO_PACKAGE --env environment
 ```
 
-#### From git
-
-```
-redmine upgrade --source git
-
-# with environment
-redmine upgrade --source git --env environment
-```
-
 ### Easyproject
 
 If you are using easyproject plugin and you dont want copy client modifications from old instance use switch `--skip-old-modifications`.

data/lib/redmine-installer.rb

@@ -37,16 +37,11 @@ module Redmine
 
     def self.print_logo
       $stdout.puts <<-PRINT
-                    _             _                     
-     _ __  ___   __| | _ __ ___  (_) _ __    ___        
-    | '__|/ _ \\ / _` || '_ ` _ \\ | || '_ \\  / _ \\ _____ 
-    | |  |  __/| (_| || | | | | || || | | ||  __/|_____|
-    |_|   \\___| \\__,_||_| |_| |_||_||_| |_| \\___|       
-     _              _          _  _             
-    (_) _ __   ___ | |_  __ _ | || |  ___  _ __ 
-    | || '_ \\ / __|| __|/ _` || || | / _ \\| '__|
-    | || | | |\\__ \\| |_| (_| || || ||  __/| |   
-    |_||_| |_||___/ \\__|\\__,_||_||_| \\___||_|  
+                  __      _
+      _______ ___/ /_ _  (_)__  ___
+     / __/ -_) _  /  ' \\/ / _ \\/ -_)
+    /_/  \\__/\\_,_/_/_/_/_/_//_/\\__/
+
 
     #{I18n.translate(:powered_by)}
 

data/lib/redmine-installer/install.rb

@@ -16,24 +16,19 @@
 #
 # From archive::
 #   Supported archives are .zip and .tar.gz.
-# => 
-#   # minimal
-#   redmine upgrade PATH_TO_PACKAGE
-#
-#   # full
-#   redmine upgrade PATH_TO_PACKAGE --env ENV1,ENV2,ENV3
 #
-# From git::
 #   # minimal
-#   redmine upgrade GIT_REPO --source git
+#   redmine install PATH_TO_PACKAGE
+#   redmine install REDMINE_VERSION
 #
 #   # full
-#   redmine upgrade GIT_REPO --source git --env ENV1,ENV2,ENV3
+#   redmine install PATH_TO_PACKAGE --env ENV1,ENV2,ENV3
 #
 module Redmine::Installer
   class Install < Task
 
     STEPS = [
+      step::EnvCheck,
       step::RedmineRoot,
       step::LoadPackage,
       step::DatabaseConfig,

data/lib/redmine-installer/locales/en.yml

@@ -1,8 +1,8 @@
-
 en:
   redmine_installer_summary: 'Easy way how install/upgrade redmine or plugin.'
   backup: 'Backup'
   backup_is_stored_at: 'Backup is stored at <bright>%{dir}</bright>'
+  cannot_download_redmine_version: 'Cannot download redmine %{version}'
   cli_install_desc: 'Install redmine'
   cli_show_verbose_output: 'Show verbose output'
   cli_upgrade_desc: 'Upgrade redmine'
@@ -32,6 +32,8 @@ en:
   only_database: 'Only database'
   path_for_redmine_root: 'Path for redmine_root'
   powered_by: 'Powered by EasyRedmine'
+  redmine_downloading: 'Redmine downloading'
+  redmine_was_installed_to: 'Redmine was installed to %{dir}'
   restoring_database: '... Restoring database'
   skip: 'Skip'
   try_again: 'try again'
@@ -40,6 +42,8 @@ en:
   what_web_server_do_you_want: 'What web-server do you want?'
   yes_t: 'yes'
   your_profile_can_be_used_as: 'Your profile is saved as #%{id} and can be use with <bright>--profile %{id}</bright>'
+  installer_run_as_root: 'Installer run as root. This can be dangerous. Continue?'
+  terminated_by_user: Terminated by user.
 
   step:
     load_package:
@@ -63,7 +67,9 @@ en:
     save_profile:
       title: 'Saving profile'
     redmine_root:
-      title: 'Redmine root'
+      title: 'Getting a redmine root'
+    env_check:
+      title: 'Environment checking'
 
   plugin:
     database:
@@ -89,17 +95,17 @@ en:
         configuration: |
           Add:
             <bright>gem 'thin'</bright>
-          
+
           to <bright>Gemfile.local</bright>
-          
+
           and run: <bright>bundle install</bright>
-          
+
           (More informations can be found at http://code.macournoyer.com/thin)
       apachepassenger:
         title: 'Passenger (apache)'
         configuration: |
           Add this to apache configuration file.
-          
+
           <bright><VirtualHost *:80>
             ServerName www.yourhost.com
             DocumentRoot %{redmine_root}/public
@@ -112,29 +118,29 @@ en:
               #Require all granted
             </Directory>
           </VirtualHost></bright>
-          
+
           More informations can be found at https://www.phusionpassenger.com/documentation/Users%20guide%20Apache.html
       nginxpassenger:
         title: 'Passenger (nginx)'
         configuration: |
           Add this to nginx configuration file.
-          
+
           <bright>server {
             listen 80;
             server_name www.yourhost.com;
             root %{redmine_root}/public;   # <--- be sure to point to 'public'!
             passenger_enabled on;
           }</bright>
-          
+
           More informations can be found at https://www.phusionpassenger.com/documentation/Users%20guide%20Nginx.html
       puma:
         title: 'Puma'
         configuration: |
           Add:
             <bright>gem 'puma'</bright>
-          
+
           to <bright>Gemfile.local</bright>
-          
+
           More informations can be found at http://puma.io
     redmine_plugin:
       easyproject:

data/lib/redmine-installer/plugins/base.rb

@@ -2,7 +2,7 @@ module Redmine::Installer::Plugin
   class Base
 
     include Redmine::Installer::Utils
-    
+
     # Register children
     def self.inherited(child)
       all << child
@@ -12,7 +12,7 @@ module Redmine::Installer::Plugin
       unless self.instance_variable_defined?(:@all)
         self.instance_variable_set(:@all, Array.new)
       end
-      
+
       self.instance_variable_get(:@all)
     end
 
@@ -20,9 +20,5 @@ module Redmine::Installer::Plugin
       translate("plugin.#{self.superclass.class_name.downcase}.#{self.class_name.downcase}.title")
     end
 
-    # def self.plugin_name
-    #   binding.pry unless @__binding
-    # end
-
   end
 end

data/lib/redmine-installer/plugins/redmine_plugin.rb

@@ -11,6 +11,9 @@ module Redmine::Installer::Plugin
       records.include?(self.class_name.downcase)
     end
 
+    def self.final(*)
+    end
+
   end
 end
 
@@ -52,4 +55,28 @@ class EasyProject < Redmine::Installer::Plugin::RedminePlugin
 
     install(base)
   end
+
+  def self.final(base)
+    return unless am_i_there?
+
+    say %{
+<bright>EasyRedmine notes:</bright>
+  You should create a maintenance task to CRON (on Linux) or Scheduled Tasks (on Windows)
+  that will be running every 5-15 minutes. This one task aggregates all required tasks
+  such as mail receiving, alerts evaluation etc. You should set up required parameters via
+  administration -> scheduled tasks.
+  Do not run this task under root, use same user that is used for web server.:
+
+  <bright>bundle exec rake easyproject:scheduler:run_tasks RAILS_ENV=production</bright>
+
+  For example:
+  1. Edit crontab
+    crontab -e
+
+  2. Add:
+    */15 * * * * cd #{base.redmine_root} && bundle exec rake easyproject:scheduler:run_tasks RAILS_ENV=production
+
+
+}
+  end
 end

data/lib/redmine-installer/step.rb

@@ -11,5 +11,6 @@ module Redmine::Installer
     autoload :Backup,          'redmine-installer/steps/backup'
     autoload :Upgrade,         'redmine-installer/steps/upgrade'
     autoload :RedmineRoot,     'redmine-installer/steps/redmine_root'
+    autoload :EnvCheck,        'redmine-installer/steps/env_check'
   end
 end

data/lib/redmine-installer/steps/backup.rb

@@ -32,7 +32,7 @@ module Redmine::Installer::Step
       end
     end
 
-    def final_step
+    def final
       if @current_backup_dir
         say t(:backup_is_stored_at, dir: @current_backup_dir), 2
       end

data/lib/redmine-installer/steps/base.rb

@@ -1,4 +1,20 @@
 module Redmine::Installer::Step
+  ##
+  # Base
+  #
+  # == Steps:
+  # prepare::
+  #   used for argument validation
+  #
+  # up::
+  #   actions
+  #
+  # final::
+  #   for printing informations
+  #
+  # down::
+  #   if something went wrong
+  #
   class Base
 
     include Redmine::Installer::Utils
@@ -29,12 +45,15 @@ module Redmine::Installer::Step
     def print_footer
     end
 
-    def final_step
+    def prepare
     end
 
     def up
     end
 
+    def final
+    end
+
     def down
     end
 

data/lib/redmine-installer/steps/env_check.rb

@@ -0,0 +1,20 @@
+module Redmine::Installer::Step
+  class EnvCheck < Base
+
+    def prepare
+      # Check if windows
+      # if windows?
+      #   confirm(:do_you_want_continue_if_windows, false)
+      # end
+
+      if root? && !confirm(:installer_run_as_root, false)
+        error(:terminated_by_user)
+      end
+    end
+
+    def up
+      say '<green>... OK</green>', 1
+    end
+
+  end
+end

data/lib/redmine-installer/steps/load_package.rb

@@ -1,9 +1,11 @@
 require 'rubygems/package'
 require 'ruby-progressbar'
 require 'fileutils'
-require 'zip'
+require 'net/http'
 require 'tmpdir'
 require 'zlib'
+require 'zip'
+require 'uri'
 
 module Redmine::Installer::Step
   class LoadPackage < Base
@@ -12,20 +14,49 @@ module Redmine::Installer::Step
     TAR_LONGLINK = '././@LongLink'
     PROGRESSBAR_FORMAT = '%a [%b>%i] %p%% %t'
 
-    def up
+    def prepare
       case base.options[:source]
       when 'file'
-        load_file
+
+        unless File.exist?(base.package)
+          if base.package =~ /\Av?(\d\.\d\.\d)\Z/
+            download_redmine($1)
+          end
+        end
+
+        unless File.exist?(base.package)
+          error :file_not_exist, file: base.package
+        end
+
+        @type = File.extname(base.package)
+        unless SUPPORTED_ARCHIVE_FORMATS.include?(@type)
+          error :file_must_have_format, file: base.package, formats: SUPPORTED_ARCHIVE_FORMATS.join(', ')
+        end
+
       when 'git'
-        load_git
+        nil
       else
         error :error_unsupported_source, source: base.options[:source]
       end
     end
 
-    def final_step
-      # Delete tmp_redmine_root
+    def up
+      case base.options[:source]
+      when 'file'
+        load_from_archive
+      when 'git'
+        load_from_git
+      end
+    end
+
+    def down
       FileUtils.remove_entry_secure(@tmpdir) if @tmpdir
+      FileUtils.safe_unlink(@tmpfile) if @tmpfile
+    end
+
+    def final
+      down
+      say(t(:redmine_was_installed_to, dir: base.redmine_root), 1)
     end
 
     private
@@ -33,12 +64,6 @@ module Redmine::Installer::Step
       # =======================================================================
       # General
 
-      def create_tmp_dir
-        @tmpdir = Dir.mktmpdir
-      rescue
-        FileUtils.remove_entry_secure(@tmpdir)
-      end
-
       # Move files from temp dir to target. First check
       # if folder contains redmine or contains
       # folder which contains redmine :-)
@@ -67,16 +92,7 @@ module Redmine::Installer::Step
       # =======================================================================
       # File
 
-      def load_file
-        unless File.exist?(base.package)
-          error :file_not_exist, file: base.package
-        end
-
-        @type = File.extname(base.package)
-        unless SUPPORTED_ARCHIVE_FORMATS.include?(@type)
-          error :file_must_have_format, file: base.package, formats: SUPPORTED_ARCHIVE_FORMATS.join(', ')
-        end
-
+      def load_from_archive
         # Make temp directory and extract archive + move it to the redmine_folder
         extract_to_tmp
 
@@ -84,8 +100,38 @@ module Redmine::Installer::Step
         get_tmp_redmine_root
       end
 
+      def download_redmine(version)
+        @tmpfile = Tempfile.new(['redmine', '.zip'])
+        @tmpfile.binmode
+
+        uri = URI("http://www.redmine.org/releases/redmine-#{version}.zip")
+
+        Net::HTTP.start(uri.host, uri.port) do |http|
+          head = http.request_head(uri)
+
+          unless head.is_a?(Net::HTTPSuccess)
+            error :cannot_download_redmine_version, version: version
+          end
+
+          say(:redmine_downloading, 1)
+          progressbar = ProgressBar.create(format: PROGRESSBAR_FORMAT, total: head['content-length'].to_i)
+
+          http.get(uri) do |data|
+            @tmpfile.write(data)
+            progressbar.progress += data.size
+          end
+
+          progressbar.finish
+          say(nil, 1)
+        end
+
+        @tmpfile.close
+
+        base.package = @tmpfile.path
+      end
+
       def extract_to_tmp
-        create_tmp_dir
+        @tmpdir = Dir.mktmpdir
 
         case @type
         when '.zip'
@@ -112,10 +158,10 @@ module Redmine::Installer::Step
 
       # Extract .tar.gz archive
       # based on http://dracoater.blogspot.cz/2013/10/extracting-files-from-targz-with-ruby.html
-      # 
-      # Originally tar did not support paths longer than 100 chars. GNU tar is better and they 
-      # implemented support for longer paths, but it was made through a hack called ././@LongLink. 
-      # Shortly speaking, if you stumble upon an entry in tar archive which path equals to above 
+      #
+      # Originally tar did not support paths longer than 100 chars. GNU tar is better and they
+      # implemented support for longer paths, but it was made through a hack called ././@LongLink.
+      # Shortly speaking, if you stumble upon an entry in tar archive which path equals to above
       # mentioned ././@LongLink, that means that the following entry path is longer than 100 chars and
       # is truncated. The full path of the following entry is actually the value of the current entry.
       #
@@ -158,8 +204,8 @@ module Redmine::Installer::Step
       # =======================================================================
       # Git
 
-      def load_git
-        create_tmp_dir
+      def load_from_git
+        @tmpdir = Dir.mktmpdir
 
         # Package is remote url to git repository
         remote = base.package

data/lib/redmine-installer/task.rb

@@ -27,17 +27,27 @@ module Redmine::Installer
     end
 
     def run
-      @steps.each do |id, step|
+      @steps.each do |_, step|
+        step.prepare
+      end
+
+      @steps.each do |_, step|
         step.print_title
         step.print_header
         step.up
         step.print_footer
         step.ran = true
-        puts # new line
+        puts
+      end
+
+      @steps.each do |_, step|
+        step.final
       end
 
-      @steps.each do |id, step|
-        step.final_step
+      Dir.chdir(redmine_root) do
+        Redmine::Installer::Plugin::RedminePlugin.all.each do |plugin|
+          plugin.final(self)
+        end
       end
     rescue Redmine::Installer::Error => e
       # Rescue from error comes from installer

data/lib/redmine-installer/upgrade.rb

@@ -6,7 +6,7 @@
 # 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 
+# If you say YES, configuration will be stored as profile so next time
 # you can upgrade redmine faster.
 #
 # redmine upgrade PACKAGE --profile PROFILE_ID
@@ -41,6 +41,7 @@ module Redmine::Installer
   class Upgrade < Task
 
     STEPS = [
+      step::EnvCheck,
       step::RedmineRoot,
       step::LoadPackage,
       step::Validation,

data/lib/redmine-installer/utils.rb

@@ -5,7 +5,7 @@ require 'io/console'
 
 module Redmine::Installer
   module Utils
-    
+
     def self.included(base)
       base.send :extend,  Methods
       base.send :include, Methods
@@ -69,6 +69,14 @@ module Redmine::Installer
         Dir.glob(File.join('plugins', '*')).select{|record| File.directory?(record)}.any?
       end
 
+      def windows?
+        RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
+      end
+
+      def root?
+        Process.euid == 0
+      end
+
 
       # =======================================================================
       # Input, output

data/lib/redmine-installer/version.rb

@@ -1,5 +1,5 @@
 module Redmine
   module Installer
-    VERSION = '1.0.4'
+    VERSION = '1.0.5'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redmine-installer
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Ondřej Moravčík
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-25 00:00:00.000000000 Z
+date: 2015-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ansi
@@ -166,6 +166,7 @@ files:
 - lib/redmine-installer/steps/base.rb
 - lib/redmine-installer/steps/database_config.rb
 - lib/redmine-installer/steps/email_config.rb
+- lib/redmine-installer/steps/env_check.rb
 - lib/redmine-installer/steps/install.rb
 - lib/redmine-installer/steps/load_package.rb
 - lib/redmine-installer/steps/move_redmine.rb
@@ -202,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Easy way how install/upgrade redmine or plugin.