railshoster 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/CHANGELOG.markdown

@@ -0,0 +1,8 @@
+h2. 0.0.1
+
+* Implementation of init command started.
+* Current status: 
+** Decode and parse credentials - done
+** Gather Git Repository URL using git gem - done
+* Stil to be done:
+** Write deploy.rb

data/CONTRIB.txt

@@ -0,0 +1,13 @@
+Contributing
+======================
+
+To contribute to the RailsHoster project:
+
+* Fork railshoster/railshoster
+
+* Push your contribution to a branch named after your change
+  ie: git push origin master:fixed-whatever
+
+* Send me a pull request through GitHub with a description of
+  what you are contributing.
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Julian Fischer
+
+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.markdown

@@ -0,0 +1,11 @@
+h1. RailsHoster Deployment Suite
+
+INTRDUCTON TEXT. TO BE DONE.
+
+h2. Installation
+
+TO BE DONE.
+
+h2. Usage
+
+TO BE DONE.

data/ROADMAP.markdown

@@ -0,0 +1,14 @@
+h2. 0.0.1
+
+* Prepare a deployment for a RailsHoster shared hosting.
+* Be prepared to at RailsHoster vps deployments later.
+
+h2. 1.0.0
+
+h2. 2.0.0
+
+* RailsHoster VPS Deployments
+
+h3. General TODOs
+
+* Railshoster::InitCommand - Check wether it is possible to replace "system" call with a pure ruby version possibly by using the capistrano gem directly via ruby.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/railshoster

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+# require 'bundler/setup'
+
+gem "json"
+gem "git"
+gem 'erubis'
+gem "gli"
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'railshoster')
+require 'fileutils'
+
+require 'gli'
+include GLI
+
+version Railshoster::VERSION
+
+program_desc "RailsHoster.com Application Deployment Suite"
+
+desc 'Create new RailsHoster.com application deployment'
+arg_name 'dir_name'
+long_desc 'This command helps to deploy a Ruby on Rails application to your RailsHoster account using the application token you have received after signing up.'
+command [:init] do |c|
+  
+  c.desc "Use the RailsHoster application_token pass your account credentials."
+  c.flag [:a, :apptoken]      
+
+  c.action do |global_options,options,args|
+    
+    raise "Argument 'dir_name' is required for the 'init' command." if args.empty?
+    raise "Option '-a' or '--apptoken' is require for the 'init' comannd" unless options[:a]
+    
+    project_git_dir_name = args[0]
+        
+    init_command = RailsHoster::InitCommand.new(project_git_dir_name)
+    init_command.run_by_application_token(options[:a])
+  end
+end
+
+desc "Deploy your application to RailsHoster.com"
+arg_name 'dir_name'
+long_desc "Use this command to deploy your application to RailsHoster.com after you have successfully initialized it using the 'init' command."
+command [:deploy] do |c|
+  c.action do |global_options,options,args|
+    project_git_dir_name = args[0] || FileUtils.pwd
+    RailsHoster::DeployCommand.new(project_git_dir_name).deploy
+  end
+end
+
+pre do |global,command,options,args|
+  # Pre logic here
+  # Return true to proceed; false to abourt and not call the
+  # chosen command
+  true
+end
+
+post do |global,command,options,args|
+  # Post logic here
+end
+
+on_error do |exception|
+  puts "\n"
+  puts "-" * 50
+  puts "Sorry. An Exception has occured. Don't worry I try to explain what happened:"
+  puts "-" * 50
+  puts "The Exception class is: #{exception.class}"
+  puts "The Exception message is:\n"
+  puts exception.message
+  puts "Here is the backtrace:"
+  puts "-" * 50
+  puts exception.backtrace
+  puts "-" * 50
+  puts "If this does not help write to support@railshoster.com."
+  puts "Please provide the command you invoked, in which directory as well as information about your runtime environment (Ruby Version, OS, ...)."
+  
+  # Error logic here
+  # return false to skip default error handling
+  false
+end
+
+exit GLI.run(ARGV)

data/lib/railshoster/capistrano/h.rb

@@ -0,0 +1,18 @@
+require 'erubis'
+
+module Railshoster
+  module Capistrano
+    
+    # Strategy to generate a capistrano config for a shared hosting
+    class H
+      
+      #### Static
+      
+      def self.render_deploy_rb_to_s(application_hash)
+        deployrb_template = File.read(File.join(File.dirname(__FILE__), "../../../templates/h/deploy.rb.erb"))
+        eruby = Erubis::Eruby.new(deployrb_template)
+        eruby.result(:app => application_hash)
+      end
+    end
+  end
+end

data/lib/railshoster/capistrano/v.rb

@@ -0,0 +1,6 @@
+module Railshoster
+  module Capistrano
+    class V
+    end
+  end
+end

data/lib/railshoster/command.rb

@@ -0,0 +1,26 @@
+module RailsHoster
+  
+  # This action class helps to setup a new rails applicaton
+  class Command
+    
+    def initialize(project_dir)      
+      @project_dir = project_dir
+      
+      begin      
+        @git = Git.open(project_dir)
+      rescue ArgumentError => e
+        raise PossiblyNotAGitRepoError.new(e)
+      end
+    end
+    
+    protected
+    
+    def capfile_exists?
+      File.exists?(capfile_path)
+    end
+    
+    def capfile_path 
+      File.join(@project_dir, "Capfile")
+    end
+  end
+end

data/lib/railshoster/deploy_command.rb

@@ -0,0 +1,19 @@
+module RailsHoster
+  
+  # This action class helps to setup a new rails applicaton
+  class DeployCommand < Command
+    
+    def initialize(project_dir)
+      super(project_dir)
+    end
+    
+    def deploy
+      if capfile_exists? then
+        system("cap deploy")
+      else
+        puts "\nDeployment abortet!\nYou haven't initialized your application, yet." 
+        puts "Please use the 'railshoster init' command as described in your account information mail you have received from RailsHoster.com and try again.\n\n"
+      end
+    end
+  end
+end

data/lib/railshoster/init_command.rb

@@ -0,0 +1,111 @@
+require 'base64'
+require 'json'
+require 'git'
+require 'fileutils'
+
+require File.join(File.dirname(__FILE__), '/capistrano/h')
+
+module RailsHoster
+  
+  # This action class helps to setup a new rails applicaton
+  class InitCommand < Command        
+    
+    def initialize(project_dir)
+      super(project_dir)
+    end
+        
+    def run_by_application_token(application_token) 
+      decoded_token = decode_token(application_token)
+      run_by_application_hash(decoded_token)
+    end
+    
+    def run_by_application_hash(application_hash_as_json_string)
+      app_hash = parse_application_json_hash(application_hash_as_json_string)
+      
+      git_url = get_git_remote_url_from_git_config          
+      app_hash["git"] = git_url
+
+      deployrb_str = ""
+      
+      # Choose the further process depending on the application type by applying a strategy pattern.
+      case app_hash["t"].to_sym
+        when :h
+          # Shared Hosting Deployments
+          deployrb_str = Railshoster::Capistrano::H.render_deploy_rb_to_s(app_hash)
+        # Later also support VPS Deployments
+        # when :v
+        else
+          raise UnsupportedApplicationTypeError.new
+      end
+      
+      write_deploy_rb(deployrb_str)
+      capify_project
+      success_message
+    end
+    
+    protected
+    
+    # Decodoes token to get the JSON hash back.
+    # gQkUSMakKRPhm0EIaer => {"key":"value"}
+    def decode_token(token)
+      Base64.decode64(token)
+    end
+    
+    def parse_application_json_hash(app_hash_as_json_string)
+      ruby_app_hash = ::JSON.parse(app_hash_as_json_string)      
+    end
+    
+    def get_git_remote_url_from_git_config
+      
+      #TODO Error management: what if there is not remote url (local repo)?
+      @git.config('remote.origin.url')
+    end
+    
+    def write_deploy_rb(deployrb_str)
+      deployrb_basepath = File.join(@project_dir, "config")
+      FileUtils.mkdir_p(deployrb_basepath)
+      
+      deployrb_path = File.join(deployrb_basepath, "deploy.rb")
+      backup_file(deployrb_path) if File.exists?(deployrb_path)
+      
+      File.open(deployrb_path, "w+") do |f|
+        f << deployrb_str
+      end
+    end
+    
+    # Creates a backup of a file.
+    # If there is already a backup 
+    #TODO Test
+    def backup_file(path)
+      backup_path = path + ".bak"
+            
+      if File.exists?(backup_path) then
+        # There is already a backup, so we need to backup the backup first.
+        backup_file(backup_path)
+      end
+      
+      FileUtils.cp(path, backup_path)      
+    end
+    
+    def capify_project      
+      puts "\n\tWarning: You are initializing a project with an existing Capfile.\n" if capfile_exists?
+      successful = system("capify #{@project_dir}")
+      raise CapifyProjectFailedError.new("Couldn't capify project at #{@project_dir}") unless successful
+    end
+    
+    def success_message
+      puts "Your application has been successfully initialized."
+      puts "\n\tYou can now use 'railshoster deploy' to deploy your app.\n\n"
+      puts "Alternatively, you can use capistrano commands such as 'cap deploy' and 'cap shell'."
+    end
+  end
+  
+  class PossiblyNotAGitRepoError < ArgumentError
+  end
+  
+  class UnsupportedApplicationTypeError < StandardError
+  end
+  
+  class CapifyProjectFailedError < StandardError
+  end
+end

data/lib/railshoster/version.rb

@@ -0,0 +1,3 @@
+module Railshoster
+  VERSION = "0.0.1"
+end

data/lib/railshoster.rb

@@ -0,0 +1,8 @@
+require File.join(File.dirname(__FILE__), 'railshoster/version')
+require File.join(File.dirname(__FILE__), 'railshoster/command')
+require File.join(File.dirname(__FILE__), 'railshoster/init_command')
+require File.join(File.dirname(__FILE__), 'railshoster/deploy_command')
+
+module Railshoster
+  # Your code goes here...
+end

data/railshoster.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "railshoster/version"
+
+Gem::Specification.new do |s|
+  s.name        = "railshoster"
+  s.version     = Railshoster::VERSION
+  s.authors     = ["Julian Fischer"]
+  s.email       = ["fischer@enterprise-rails.de"]
+  s.homepage    = "http://www.railshoster.com"
+  s.summary     = %q{RailsHoster Applicatoin Deployment Suite}
+  s.description = %q{Easily deploy your Rails app to RailsHoster.com by using this gem.}
+
+  s.rubyforge_project = "railshoster"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency "capistrano"
+  s.add_dependency "capistrano-ext"
+  s.add_dependency "gli", ">= 1.2.5"
+  s.add_dependency "json"
+  s.add_dependency "git"
+  s.add_dependency 'erubis'
+end

data/templates/h/deploy.rb.erb

@@ -0,0 +1,71 @@
+###############################
+#
+# Capistrano Deployment on shared Webhosting by RailsHoster
+#
+# maintained by support@railshoster.de
+#
+###############################
+
+# BITTE ENTFERNEN SIE DIE FOLGENDE ZEILE WENN SIE BUNDLER NICHT BENUTZEN
+require 'bundler/capistrano'
+
+
+#### Personal Settings
+## User and Password
+
+# user to login to the target server
+set :user, "<%= app["u"] %>"
+
+# password to login to the target server
+set :password, "<%= app["p"] %>"
+
+# allow SSH-Key-Forwarding
+set :ssh_options, { :forward_agent => true }
+
+## Application name and repository
+
+# application name ( should be rails1 rails2 rails3 ... )
+set :application, "<%= app["a"] %>"
+
+# repository location
+set :repository, "<%= app["git"]%>"
+
+# :subversionn or :git
+set :scm, :git
+set :scm_verbose, true
+
+#### System Settings
+## General Settings ( don't change them please )
+
+# run in pty to allow remote commands via ssh
+default_run_options[:pty] = true
+
+# don't use sudo it's not necessary
+set :use_sudo, false
+
+# set the location where to deploy the new project
+set :deploy_to, "/home/#{user}/#{application}"
+
+# live
+role :app, "<%= app["h"]%>"
+role :web, "<%= app["h"]%>"
+role :db,  "<%= app["h"]%>", :primary => true
+
+
+############################################
+# Default Tasks by RailsHoster.de
+############################################
+namespace :deploy do
+
+  desc "Restarting mod_rails with restart.txt"
+  task :restart, :roles => :app, :except => { :no_release => true } do
+    run "touch #{current_path}/tmp/restart.txt"
+  end
+
+  desc "Additional Symlinks ( database.yml, etc. )"
+  task :additional_symlink, :roles => :app do
+    run "ln -s #{shared_path}/config/database.yml #{current_path}/config/database.yml"
+  end
+
+end
+after "deploy:symlink","deploy:additional_symlink","deploy:migrate"

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification 
+name: railshoster
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Julian Fischer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: capistrano-ext
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: gli
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 2
+        - 5
+        version: 1.2.5
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: git
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: erubis
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+description: Easily deploy your Rails app to RailsHoster.com by using this gem.
+email: 
+- fischer@enterprise-rails.de
+executables: 
+- railshoster
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG.markdown
+- CONTRIB.txt
+- LICENSE
+- README.markdown
+- ROADMAP.markdown
+- Rakefile
+- bin/railshoster
+- lib/railshoster.rb
+- lib/railshoster/capistrano/h.rb
+- lib/railshoster/capistrano/v.rb
+- lib/railshoster/command.rb
+- lib/railshoster/deploy_command.rb
+- lib/railshoster/init_command.rb
+- lib/railshoster/version.rb
+- railshoster.gemspec
+- templates/h/deploy.rb.erb
+homepage: http://www.railshoster.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: railshoster
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: RailsHoster Applicatoin Deployment Suite
+test_files: []
+