rappa 0.0.3 → 0.0.4

data/README.md

@@ -3,6 +3,9 @@
 Rappa is a tool which lets you package your rack based application e.g. Sinatra, Rails etc for easy deployment to a ThunderCat container.
 Visit the ThunderCat project to understand how this works.
 
+[![Build Status](https://travis-ci.org/masterthought/rappa.png?branch=master)](https://travis-ci.org/masterthought/rappa)
+[![Code Climate](https://codeclimate.com/repos/51d89bb913d6376ff8018f91/badges/607d6b3238c1b52da631/gpa.png)](https://codeclimate.com/repos/51d89bb913d6376ff8018f91/feed)
+
 ## Background
 
 Rappa is written in ruby and was created to simplify the package and deploy process of Sinatra and Rails apps. The idea is to have a single artifact

data/src/property_validator.rb

@@ -0,0 +1,69 @@
+require File.dirname(__FILE__) + '/rappa_error'
+
+class PropertyValidator
+
+  def initialize(config,file)
+    @config = config
+    @file = file
+  end
+
+  def input_directory
+    unless @config[:input_directory].nil?
+      @config[:file_name] = (@config[:input_directory] == '.') ? 'default' : @file.basename(@config[:input_directory])
+    end
+    check_property(@config[:input_directory], :input_directory)
+    input_directory = append_trailing_slash(@config[:input_directory])
+    raise RappaError, "input directory: #{input_directory} does not exist" unless @file.exists?(input_directory)
+    input_directory
+  end
+
+  def output_directory
+    check_property(@config[:output_directory], :output_directory)
+    @config[:output_directory]
+  end
+
+  def input_archive
+    check_property(@config[:input_archive], :input_archive)
+    input_archive = @config[:input_archive]
+    raise RappaError, "input archive: #{@config[:input_archive]} does not exist" unless @file.exists?(@config[:input_archive])
+    input_archive
+  end
+
+  def output_archive
+    check_property(@config[:output_archive], :output_archive)
+    @config[:output_archive]
+  end
+
+  def input_rap
+    check_property(@config[:input_rap], :input_rap)
+    raise RappaError, "input rap: #{@config[:input_rap]} does not exist" unless @file.exists?(@config[:input_rap])
+    @config[:input_rap]
+  end
+
+  def url
+    check_property(@config[:url], :url)
+    @config[:url]
+  end
+
+  def api_key
+    check_property(@config[:api_key], :api_key)
+    @config[:api_key]
+  end
+
+
+  def validate_name(name)
+    raise RappaError, "a rap archive already exists with the name: #{@config[:file_name]}.rap - please remove it and try again" if @file.exists?(name)
+  end
+
+  private
+
+  def check_property(property, property_type)
+    raise RappaError, "property #{property_type} is mandatory but was not supplied" if property.nil? or property.empty?
+  end
+
+  def append_trailing_slash(path)
+    path = "#{path}/" if path[-1] != '/'
+    path
+  end
+
+end

data/src/rap_validator.rb

@@ -0,0 +1,56 @@
+require File.dirname(__FILE__) + '/rappa_error'
+
+class RapValidator
+
+  SUPPORTED_SERVERS = %w(thin unicorn webrick)
+
+  def initialize(file,yaml=YAML)
+    @file = file
+    @yaml = yaml
+  end
+
+  def validate_package(directory)
+    @rap = get_rap_file(directory + '/rap.yml')
+    validate_server_type
+    validate_scripts
+    validate_details
+  end
+
+  def validate_is_rap_archive(file, input_archive)
+    base_name = file.basename(input_archive)
+    extension = file.extname(base_name)
+    raise RappaError, "input archive: #{input_archive} is not a valid .rap archive" unless extension == '.rap'
+  end
+
+  private
+
+  def validate_details
+    raise RappaError, 'rap.yml :pids is required' if nil_or_empty?(@rap[:pids])
+    raise RappaError, 'rap.yml :name is required' if nil_or_empty?(@rap[:name])
+    raise RappaError, 'rap.yml :description is required' if nil_or_empty?(@rap[:description])
+    raise RappaError, 'rap.yml :version is required' if nil_or_empty?(@rap[:version])
+  end
+
+  def validate_scripts
+    raise RappaError, 'rap.yml :start_script is required' if nil_or_empty?(@rap[:start_script])
+    raise RappaError, 'rap.yml :stop_script is required' if nil_or_empty?(@rap[:stop_script])
+  end
+
+  def validate_server_type
+    raise RappaError, "rap.yml :server_type is required and must be one of: #{SUPPORTED_SERVERS}" if nil_or_empty?(@rap[:server_type])
+    raise RappaError, "rap.yml :server_type supplied: #{@rap[:server_type]} is not in the supported server list: #{SUPPORTED_SERVERS}" unless SUPPORTED_SERVERS.include?(@rap[:server_type])
+  end
+
+  def get_rap_file(rap_file_path)
+    if @file.exists?(rap_file_path)
+      @yaml.load_file(rap_file_path)
+    else
+      raise RappaError, 'rap.yml file is required - please run rappa generate to create a sample rap.yml'
+    end
+  end
+
+  def nil_or_empty?(item)
+    item.nil? or item.empty?
+  end
+
+end

data/src/rappa.rb

@@ -2,61 +2,42 @@ require 'zip/zip'
 require 'fileutils'
 require 'yaml'
 require 'rest-client'
-
-class RappaError < Exception;
-end
+require File.dirname(__FILE__) + '/rap_validator'
+require File.dirname(__FILE__) + '/property_validator'
 
 class Rappa
 
-  SUPPORTED_SERVERS = %w(thin unicorn webrick)
-
-  def initialize(config={},rest_client=RestClient,file=File)
+  def initialize(config={}, rest_client=RestClient, file=File, rap_validator=RapValidator, property_validator=PropertyValidator)
     @config = config
     @file = file
     @rest_client = rest_client
-    unless @config[:input_directory].nil?
-      @config[:file_name] = (@config[:input_directory] == '.') ? 'default' : @file.basename(@config[:input_directory])
-    end
+    @property_validator= property_validator.new(@config,@file)
+    @rap_validator = rap_validator.new(@file)
   end
 
   def package
-    check_property(@config[:input_directory], :input_directory)
-    check_property(@config[:output_directory], :output_directory)
-    input_directory = append_trailing_slash(@config[:input_directory])
-    raise RappaError, "input directory: #{input_directory} does not exist" unless @file.exists?(input_directory)
-    output_directory = @config[:output_directory]
+    input_directory = @property_validator.input_directory
+    output_directory = @property_validator.output_directory
     FileUtils.mkdir_p output_directory unless @file.exists?(output_directory)
-    name = "#{@config[:output_directory]}/#{@config[:file_name]}.rap"
-    raise RappaError, "a rap archive already exists with the name: #{@config[:file_name]}.rap - please remove it and try again" if @file.exists?(name)
-    validate(input_directory)
-    Zip::ZipFile.open(name, Zip::ZipFile::CREATE) do |zip_file|
-      Dir[@file.join(input_directory, '**', '**')].each do |file|
-        zip_file.add(file.sub(input_directory, ''), file)
-      end
-    end
+    name = "#{output_directory}/#{@config[:file_name]}.rap"
+    @property_validator.validate_name(name)
+    @rap_validator.validate_package(input_directory)
+    package_zip(input_directory, name)
   end
 
   def expand
-    check_property(@config[:input_archive], :input_archive)
-    check_property(@config[:output_archive], :output_archive)
-    raise RappaError, "input archive: #{@config[:input_archive]} does not exist" unless @file.exists?(@config[:input_archive])
-    validate_is_rap_archive
-    output_directory = @config[:output_archive]
+    input_archive = @property_validator.input_archive
+    output_directory = @property_validator.output_archive
+    @rap_validator.validate_is_rap_archive(@file,input_archive)
     FileUtils.mkdir_p output_directory unless @file.exists?(output_directory)
-    Zip::ZipFile.open(@config[:input_archive]) { |zip_file|
-      zip_file.each { |f|
-        f_path=@file.join(calculate_destination, f.name)
-        FileUtils.mkdir_p(@file.dirname(f_path))
-        zip_file.extract(f, f_path) { true } unless @file.exist?(f_path) # true will overwrite existing files.
-      }
-    }
+    expand_zip
   end
 
   def deploy
-    check_property(@config[:input_rap], :input_rap)
-    check_property(@config[:url], :url)
-    check_property(@config[:api_key], :api_key)
-    @rest_client.put "#{@config[:url]}?key=#{@config[:api_key]}", :file => @file.new(@config[:input_rap])
+    input_rap = @property_validator.input_rap
+    api_key = @property_validator.api_key
+    url = @property_validator.url
+    @rest_client.put "#{url}?key=#{ api_key}", :file => @file.new(input_rap)
   end
 
   def generate
@@ -73,42 +54,30 @@ class Rappa
 
   private
 
-  def check_property(property, property_type)
-    raise RappaError, "property #{property_type} is mandatory but was not supplied" if property.nil? or property.empty?
+  def expand_zip
+    Zip::ZipFile.open(@config[:input_archive]) { |zip_file|
+      zip_file.each { |f|
+        f_path=@file.join(calculate_destination, f.name)
+        FileUtils.mkdir_p(@file.dirname(f_path))
+        zip_file.extract(f, f_path) { true } unless @file.exist?(f_path) # true will overwrite existing files.
+      }
+    }
   end
 
-  def validate(directory)
-    rap_file = directory + '/rap.yml'
-    if @file.exists?(rap_file)
-      rap = YAML.load_file(rap_file)
-      raise RappaError, "rap.yml :server_type is required and must be one of: #{SUPPORTED_SERVERS}" if rap[:server_type].nil? or rap[:server_type].empty?
-      raise RappaError, "rap.yml :server_type supplied: #{rap[:server_type]} is not in the supported server list: #{SUPPORTED_SERVERS}" unless SUPPORTED_SERVERS.include?(rap[:server_type])
-      raise RappaError, 'rap.yml :start_script is required' if rap[:start_script].nil? or rap[:start_script].empty?
-      raise RappaError, 'rap.yml :stop_script is required' if rap[:stop_script].nil? or rap[:stop_script].empty?
-      raise RappaError, 'rap.yml :pids is required' if rap[:pids].nil? or rap[:pids].empty?
-      raise RappaError, 'rap.yml :name is required' if rap[:name].nil? or rap[:name].empty?
-      raise RappaError, 'rap.yml :description is required' if rap[:description].nil? or rap[:description].empty?
-      raise RappaError, 'rap.yml :version is required' if rap[:version].nil? or rap[:version].empty?
-    else
-      raise RappaError, 'rap.yml file is required - please run rappa generate to create a sample rap.yml'
+  def package_zip(input_directory, name)
+    Zip::ZipFile.open(name, Zip::ZipFile::CREATE) do |zip_file|
+      Dir[@file.join(input_directory, '**', '**')].each do |file|
+        zip_file.add(file.sub(input_directory, ''), file)
+      end
     end
   end
 
-  def validate_is_rap_archive
-    base_name = @file.basename(@config[:input_archive])
-    extension = @file.extname(base_name)
-    raise RappaError, "input archive: #{@config[:input_archive]} is not a valid .rap archive" unless extension == '.rap'
-  end
-
   def calculate_destination
     base_name = @file.basename(@config[:input_archive])
     name = base_name.chomp(@file.extname(base_name))
     @config[:output_archive] + '/' + name
   end
 
-  def append_trailing_slash(path)
-    path = "#{path}/" if path[-1] != '/'
-    path
-  end
+
 
 end

data/src/rappa_error.rb

@@ -0,0 +1,2 @@
+class RappaError < Exception;
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rappa
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-05 00:00:00.000000000 Z
+date: 2013-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -104,6 +104,9 @@ extra_rdoc_files:
 - README.md
 files:
 - src/rappa.rb
+- src/rap_validator.rb
+- src/property_validator.rb
+- src/rappa_error.rb
 - README.md
 - bin/rappa
 homepage: https://github.com/masterthought/rappa