railshoster 0.0.2 → 0.0.3

data/.travis.yml

@@ -0,0 +1,6 @@
+gemfile: gemfiles/Gemfile.ci
+rvm:
+  - 1.8.7 # (current default)
+  - 1.9.2
+  - 1.9.3
+  - ree

data/CHANGELOG.markdown

@@ -11,3 +11,10 @@ h2. 0.0.2
 
 * deploy.rb now creates a symlink to database.yml with -f (force) and overwrites an eventually existing database.yml from the customer's repository.
 
+h3. 0.0.3
+
+* Added travis testing meta data.
+* Added RSpec tests for basic functionality.
+* Fixed a Ruby 1.9.x issue.
+* Enhanced error messages for invalid application tokens.
+* Initial README.

data/README.markdown

@@ -1,11 +1,41 @@
 h1. RailsHoster Deployment Suite
 
-INTRDUCTON TEXT. TO BE DONE.
+The RailsHoster Deployment gem helps you to easily get your Rails app runing at RailsHoster.com. Check it out.
+
+h2. Travis Status of the current dev branch
+
+[![Build Status](https://secure.travis-ci.org/[railshoster]/[railshoster].png)](http://travis-ci.org/[railshoster]/[railshoster])
+
+h2. Requirements
+
+This is what you need on your client to run the RailsHoster gem to deploy your app:
+
+* Ruby
+* Ruby gems
+* Shell (e.g. Bash)
+* SSH Shell
+* Git
 
 h2. Installation
 
-TO BE DONE.
+    gem install railshoster
 
 h2. Usage
+ 
+Simply go to your project's git folder and invoke the following command to initialize your app and *make it deployment ready*.
+
+    railshoster init -a 'your application token' .
+
+Regarding to your *application token* please refer to your account information you have received after signing up at [RailsHoster.com](http://www.railshoster.com/).
+
+You can then either use *capistrano* to deploy or invoke
+
+    railshoster deploy
+
+It's as easy as this. Refer to the RailsHoster.com Support if any problems raise. We are happy to help you.
+
+h2. Debug
+
+In order to receive full stack traces when exceptions occure just pass a environment variable like this
 
-TO BE DONE.
+    RAILSHOSTER_DEV=1 railshoster 

data/ROADMAP.markdown

@@ -11,4 +11,5 @@ h2. 2.0.0
 
 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.
+* 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.
+* Test bin/railshoster

data/Rakefile

@@ -1 +1,6 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/railshoster

@@ -7,10 +7,10 @@ gem "json"
 gem "git"
 gem 'erubis'
 gem "gli"
-
-require File.join(File.dirname(__FILE__), '..', 'lib', 'railshoster')
 require 'fileutils'
 
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'railshoster'))
+
 require 'gli'
 include GLI
 
@@ -26,14 +26,15 @@ 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]
+  c.action do |global_options,options,args|    
+
+    raise "Option '-a' or '--apptoken' is require for the 'init' command. How else should I know where you want to deploy to?" unless options[:a]
+
+    cwd = FileUtils.pwd      
+    ask_for_project_dir(cwd) if args.empty?        
+    project_git_dir_name = args[0] || cwd
         
-    init_command = RailsHoster::InitCommand.new(project_git_dir_name)
+    init_command = Railshoster::InitCommand.new(project_git_dir_name)
     init_command.run_by_application_token(options[:a])
   end
 end
@@ -44,7 +45,7 @@ long_desc "Use this command to deploy your application to RailsHoster.com after
 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
+    Railshoster::DeployCommand.new(project_git_dir_name).deploy
   end
 end
 
@@ -59,7 +60,18 @@ post do |global,command,options,args|
   # Post logic here
 end
 
-on_error do |exception|
+# Invoke the app like this RAILSHOSTER_DEV=1 ~/git/railshoster/bin/railshoster 
+# in order to receive a full stack trace in case of errors.
+on_error do |exception|  
+  ret = true
+  ret = print_error(exception) if ENV["RAILSHOSTER_DEV"]  
+  ret
+end
+
+#### Helper methods
+
+def print_error(exception)    
+  
   puts "\n"
   puts "-" * 50
   puts "Sorry. An Exception has occured. Don't worry I try to explain what happened:"
@@ -73,10 +85,17 @@ on_error do |exception|
   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
 
+def ask_for_project_dir(current_working_dir)  
+  puts "You have not specified your local project folder to be deployed.\n" +
+    "I assume you want to use your current working directory: #{current_working_dir}.\n"
+  print "Correct? (y/n) [n]: "
+  decision = STDIN.getc
+  if decision !~ /y/i then
+    exit_now!("Initialization aborted.", -1)
+  end      
+end
+
 exit GLI.run(ARGV)

data/gemfiles/Gemfile.ci

@@ -0,0 +1,14 @@
+source 'http://rubygems.org'
+
+gem "rake"
+gem "capistrano"
+gem "capistrano-ext"
+gem "gli", ">= 1.2.5"
+gem "json"
+gem "git"
+gem 'erubis'
+
+group :test do
+  gem 'rspec'
+  gem 'fakefs'
+end

data/lib/railshoster/bad_application_json_hash_error.rb

@@ -0,0 +1,5 @@
+module Railshoster
+  class BadApplicationJSONHashError < ArgumentError
+    include Railshoster::Error
+  end
+end

data/lib/railshoster/bad_appliction_token_error.rb

@@ -0,0 +1,5 @@
+module Railshoster
+  class BadApplicationTokenError < ArgumentError
+    include Railshoster::Error
+  end
+end

data/lib/railshoster/capify_project_failed_error.rb

@@ -0,0 +1,5 @@
+module Railshoster
+  class CapifyProjectFailedError < StandardError
+    include Railshoster::Error
+  end  
+end

data/lib/railshoster/command.rb

@@ -1,4 +1,4 @@
-module RailsHoster
+module Railshoster
   
   # This action class helps to setup a new rails applicaton
   class Command

data/lib/railshoster/deploy_command.rb

@@ -1,4 +1,4 @@
-module RailsHoster
+module Railshoster
   
   # This action class helps to setup a new rails applicaton
   class DeployCommand < Command

data/lib/railshoster/error.rb

@@ -0,0 +1,7 @@
+module Railshoster
+
+  # This module will be included in all custom railshoster error classes.
+  # Using a module we don't enforce a certain superclass.
+  module Error
+  end
+end

data/lib/railshoster/init_command.rb

@@ -3,9 +3,9 @@ require 'json'
 require 'git'
 require 'fileutils'
 
-require File.join(File.dirname(__FILE__), '/capistrano/h')
+require File.expand_path(File.join(File.dirname(__FILE__), '/capistrano/h'))
 
-module RailsHoster
+module Railshoster
   
   # This action class helps to setup a new rails applicaton
   class InitCommand < Command        
@@ -16,7 +16,16 @@ module RailsHoster
         
     def run_by_application_token(application_token) 
       decoded_token = decode_token(application_token)
-      run_by_application_hash(decoded_token)
+      
+      begin
+        run_by_application_hash(decoded_token)
+      rescue BadApplicationJSONHashError => e
+        msg = "Please verify your application_token. It did not decode to a valid application hash.\n" +
+          "This is how your application token looked like:\n\n#{application_token.inspect}\n\n" +
+          "Please compare your application token char by char with your account information mail and try again!\n" +
+          "Here is what the application hash parser said:\n\n"
+        raise BadApplicationTokenError.new(msg + e.message)
+      end
     end
     
     def run_by_application_hash(application_hash_as_json_string)
@@ -47,18 +56,23 @@ module RailsHoster
     
     # Decodoes token to get the JSON hash back.
     # gQkUSMakKRPhm0EIaer => {"key":"value"}
-    def decode_token(token)
+    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)      
+      begin
+        ruby_app_hash = ::JSON.parse(app_hash_as_json_string)      
+      rescue JSON::ParserError => e      
+        msg = "The application hash you have passed is malformed. It could not be parsed as regular JSON. It looked like this:\n\n #{app_hash_as_json_string.inspect}\n"  
+        raise BadApplicationJSONHashError.new(msg + "\nHere is what the JSON parse said:\n\n" + e.message)
+      end
     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')
+      @git.config['remote.origin.url']
     end
     
     def write_deploy_rb(deployrb_str)
@@ -66,26 +80,12 @@ module RailsHoster
       FileUtils.mkdir_p(deployrb_basepath)
       
       deployrb_path = File.join(deployrb_basepath, "deploy.rb")
-      backup_file(deployrb_path) if File.exists?(deployrb_path)
+      Railshoster::Utilities.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
+    end      
     
     def capify_project      
       puts "\n\tWarning: You are initializing a project with an existing Capfile.\n" if capfile_exists?
@@ -99,13 +99,4 @@ module RailsHoster
       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/possibly_not_a_git_repo_error.rb

@@ -0,0 +1,5 @@
+module Railshoster
+  class PossiblyNotAGitRepoError < ArgumentError
+    include Railshoster::Error
+  end
+end

data/lib/railshoster/unsupported_application_type_error.rb

@@ -0,0 +1,5 @@
+module Railshoster  
+  class UnsupportedApplicationTypeError < StandardError
+    include Railshoster::Error
+  end  
+end

data/lib/railshoster/utilities.rb

@@ -0,0 +1,25 @@
+require 'fileutils'
+
+module Railshoster
+  class Utilities
+    
+    # Creates a backup of a file.
+    # Since this is a recursive method you'll never loose a file. it also creates backups of backups of ...
+    # == Examples
+    # myfile -> myfile.bak
+    # if there is already a myfile.bak:
+    # myfile.bak -> myfile.bak.bak
+    # myfile -> myfile.bak
+    # ...
+    def self.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
+  end
+end

data/lib/railshoster/version.rb

@@ -1,3 +1,3 @@
 module Railshoster
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/railshoster.rb

@@ -1,8 +1,14 @@
 require File.join(File.dirname(__FILE__), 'railshoster/version')
+require File.join(File.dirname(__FILE__), 'railshoster/error')
+require File.join(File.dirname(__FILE__), 'railshoster/utilities')
 require File.join(File.dirname(__FILE__), 'railshoster/command')
+require File.join(File.dirname(__FILE__), 'railshoster/possibly_not_a_git_repo_error')
+require File.join(File.dirname(__FILE__), 'railshoster/unsupported_application_type_error')
+require File.join(File.dirname(__FILE__), 'railshoster/capify_project_failed_error')
+require File.join(File.dirname(__FILE__), 'railshoster/bad_application_json_hash_error')
+require File.join(File.dirname(__FILE__), 'railshoster/bad_appliction_token_error')
 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

@@ -24,4 +24,7 @@ Gem::Specification.new do |s|
   s.add_dependency "json"
   s.add_dependency "git"
   s.add_dependency 'erubis'
+  
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('fakefs')
 end

data/spec/lib/railshoster/command_spec.rb

@@ -0,0 +1,19 @@
+require File.join(File.dirname(__FILE__), "..", "..", "spec_helper.rb")
+
+describe Railshoster::Command do
+  describe "#Basics" do
+    it "should instanciate a Command instance also initializing the project git repo" do
+
+      # We use the gem's dir as this should be a valid git repo
+      git_dir = File.join(File.dirname(__FILE__), "..", "..", "..")
+      expect { c = Railshoster::Command.new(git_dir) }.to_not raise_error(Railshoster::PossiblyNotAGitRepoError)
+    end
+  
+    it "should fail to instanciate a Command for a non-git project dir" do    
+
+      # The spec folder is part of a but not a git repo
+      non_git_dir = File.dirname(__FILE__)      
+      expect { c = Railshoster::Command.new(non_git_dir) }.to raise_error(Railshoster::PossiblyNotAGitRepoError)
+    end
+  end
+end

data/spec/lib/railshoster/init_command_spec.rb

@@ -0,0 +1,49 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "spec_helper.rb"))
+
+describe Railshoster::InitCommand do
+  
+  before do
+    # We use the gem's dir as this should be a valid git repo
+    git_dir = File.join(File.dirname(__FILE__), "..", "..", "..")    
+    @init = Railshoster::InitCommand.new(git_dir)
+  end
+  
+  describe "#Git" do 
+    it "should read the git repo url" do
+      @init.send(:get_git_remote_url_from_git_config).should =~ /railshoster/
+    end
+    
+    #TODO
+    it "should do sth useful if the given project dir has no remote url" do
+      pending("handle this situation in code an spec.")
+    end
+  end
+    
+  describe "#run_by_application_hash" do
+    it "should create a deploy rb and capify the project" do
+      pending("use fakefs to test this.")
+    end
+    
+    it "should deny to run for a non-git project dir" do
+      pending("not git -> no repo url -> no deploy rb -> fail")
+    end
+    
+    it "should gracefully die for a git project dir without a remote origin" do
+      pending("no remote origin -> no repo url -> no deploy rb -> fail")
+    end
+    
+    it "should raise an BadApplicationJSONHashError error for an invalid incoming JSON hash" do      
+      expect { @init.send(:parse_application_json_hash, "") }.to raise_error(Railshoster::BadApplicationJSONHashError)
+    end
+  end
+  
+  describe "#run_by_application_token" do
+    it "should create a deploy rb and capify the project" do
+      pending("use fakefs to test this.")
+    end
+    
+    it "should raise an BadApplicationTokenError error for an invalid incoming application token" do      
+      expect { @init.send(:run_by_application_token, "abab") }.to raise_error(Railshoster::BadApplicationTokenError)
+    end
+  end
+end

data/spec/lib/railshoster/utilities_spec.rb

@@ -0,0 +1,49 @@
+require File.join(File.dirname(__FILE__), "..", "..", "spec_helper.rb")
+
+describe Railshoster::Utilities do  
+  
+  before do
+     FakeFS.activate!
+  end
+  
+  describe "#Backup" do    
+    include FakeFS::SpecHelpers
+    
+    it "should create a backup file" do     
+      File.new("myfile.txt", "w+")
+      File.exists?("myfile.txt").should be_true
+      expect { Railshoster::Utilities.backup_file("myfile.txt") }.to_not raise_error
+      File.exists?("myfile.txt").should be_true
+      File.exists?("myfile.txt.bak").should be_true
+    end
+    
+    it "should create a backup of a backup file and then backup the file" do
+      
+      # File to be backed up
+      File.open("myfile.txt", "w+") do |f|
+        f << "1"
+      end
+      
+      # We assume there is already an older backup
+      File.open("myfile.txt.bak", "w+") do |f|
+        f << "2"
+      end            
+      expect { Railshoster::Utilities.backup_file("myfile.txt") }.to_not raise_error
+      File.exists?("myfile.txt").should be_true
+      File.exists?("myfile.txt.bak").should be_true
+      File.exists?("myfile.txt.bak.bak").should be_true
+      
+      File.open("myfile.txt").read.should eql("1")
+      
+      # .bak after backing up is the newest backup
+      File.open("myfile.txt.bak").read.should eql("1")
+      
+      # But the old backup is still there - being moved to .bak.bak.
+      File.open("myfile.txt.bak.bak").read.should eql("2")
+    end
+  end 
+  
+  after do
+    FakeFS.deactivate!
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rspec'
+require 'fakefs/safe'
+require 'fakefs/spec_helpers'
+
+# https://github.com/defunkt/fakefs
+# Turn FakeFS on and off in a given example group
+# describe "my spec" do
+#  include FakeFS::SpecHelpers
+# end
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'railshoster')
+
+#RSpec.configure do |c|
+#  c.mock_with :rspec
+#end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: railshoster
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Julian Fischer
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-04 00:00:00 Z
+date: 2011-11-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: capistrano
@@ -103,6 +103,34 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: fakefs
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id008
 description: Easily deploy your Rails app to RailsHoster.com by using this gem.
 email: 
 - fischer@enterprise-rails.de
@@ -114,6 +142,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .travis.yml
 - CHANGELOG.markdown
 - CONTRIB.txt
 - LICENSE
@@ -121,14 +150,26 @@ files:
 - ROADMAP.markdown
 - Rakefile
 - bin/railshoster
+- gemfiles/Gemfile.ci
 - lib/railshoster.rb
+- lib/railshoster/bad_application_json_hash_error.rb
+- lib/railshoster/bad_appliction_token_error.rb
+- lib/railshoster/capify_project_failed_error.rb
 - lib/railshoster/capistrano/h.rb
 - lib/railshoster/capistrano/v.rb
 - lib/railshoster/command.rb
 - lib/railshoster/deploy_command.rb
+- lib/railshoster/error.rb
 - lib/railshoster/init_command.rb
+- lib/railshoster/possibly_not_a_git_repo_error.rb
+- lib/railshoster/unsupported_application_type_error.rb
+- lib/railshoster/utilities.rb
 - lib/railshoster/version.rb
 - railshoster.gemspec
+- spec/lib/railshoster/command_spec.rb
+- spec/lib/railshoster/init_command_spec.rb
+- spec/lib/railshoster/utilities_spec.rb
+- spec/spec_helper.rb
 - templates/h/deploy.rb.erb
 homepage: http://www.railshoster.com
 licenses: []
@@ -163,5 +204,8 @@ rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: RailsHoster Applicatoin Deployment Suite
-test_files: []
-
+test_files: 
+- spec/lib/railshoster/command_spec.rb
+- spec/lib/railshoster/init_command_spec.rb
+- spec/lib/railshoster/utilities_spec.rb
+- spec/spec_helper.rb