revup 0.1.0 → 0.2.0

data/README.md

@@ -0,0 +1,81 @@
+# Revup
+
+Revup is a simple deployment utility, for the Sauspiel client versioned_assets, packaged as a rake task.
+
+You tell it which files to deploy and Revup will push it to the server and register the new revision of the versioned_asset.
+
+
+## Install
+
+Revup is packaged as a Ruby gem and can be added to the Gemfile of the versioned_asset project:
+
+```Ruby
+    gem "revup", "~> 0.1.0"
+```
+
+## Usage
+
+To add a deploy task for a versioned_asset, add the following to its Rakefile:
+
+```Ruby
+    task :build do
+      # builds the versioned_asset
+    end
+
+    namespace :deploy do
+      require 'revup/deploy_task'
+
+      Revup::DeployTask.new(:desktop => build) do |deploy|
+        deploy.host           = 'remote.server.hostname'
+        deploy.app_dir        = '/path/to/app/root'
+        deploy.files_root     = File.expand_path('../build', __FILE__)
+        deploy.versioned_asset_name = 'html5-desktop-game-client'
+        deploy.files          = %w{
+          game_client_desktop.html
+          sauspiel.desktop-datauri.css
+          libs.js
+          sauspiel.desktop.js
+        }
+        deploy.remote_setup   = 'export PATH=/foo/bin:$PATH APP=sauspiel; eval "$(rbenv init -)"'
+      end
+    end
+```
+
+This will add a task called `deploy:desktop`. You could also call the task ‘html5-desktop-game-client’, in which case you don’t have to explicitely specify the `versioned_asset_name`.
+
+The, optional, `remote_setup` setting is a string that will be prepended to each command performed on the remote host.
+
+If you have multiple deploy tasks it can be handy to define shared settings on the class. Eg:
+
+```Ruby
+    namespace :deploy do
+      require 'revup/deploy_task'
+
+      Revup::DeployTask.host         = 'remote.server.hostname'
+      Revup::DeployTask.remote_setup = 'export PATH=/foo/bin:$PATH APP=sauspiel; eval "$(rbenv init -)"'
+      Revup::DeployTask.app_dir      = '/path/to/app/root'
+      Revup::DeployTask.files_root   = File.expand_path('../build', __FILE__)
+
+      Revup::DeployTask.new(:desktop => build) do |deploy|
+        deploy.versioned_asset_name = 'html5-desktop-game-client'
+        deploy.files          = %w{
+          game_client_desktop.html
+          sauspiel.desktop-datauri.css
+          libs.js
+          sauspiel.desktop.js
+        }
+      end
+    end
+```
+
+## Register versioned_asset with Rails app
+
+Before you can actually deploy a new revision of a versioned_asset, the Rails application will have to know about that versioned_asset.
+
+    % APP=sauspiel RAILS_ENV=test bundle exec rails console
+    Loading test environment (Rails 3.1.3)
+    irb(main):001:0> VersionedAsset.create(:name => 'html5-desktop-game-client')
+       (0.1ms)  BEGIN
+      SQL (0.5ms)  INSERT INTO `versioned_assets` (`created_at`, `name`, `released_revision_id`, `updated_at`) VALUES ('2012-01-12 14:27:23', 'html5-desktop-game-client', NULL, '2012-01-12 14:27:23')
+       (0.6ms)  COMMIT
+    => #<VersionedAsset id: 909168789, name: "html5-desktop-game-client", released_revision_id: nil, created_at: "2012-01-12 14:27:23", updated_at: "2012-01-12 14:27:23">

data/lib/revup/deploy_task.rb

@@ -7,7 +7,7 @@ require 'revup/version'
 
 module Revup
   class DeployTask < Rake::TaskLib
-    DEFAULT_TO_CLASS_ATTRS = [:host, :app_dir, :remote_setup, :files_root, :logger, :local_tmp_dir, :remote_tmp_dir]
+    DEFAULT_TO_CLASS_ATTRS = [:host, :user, :app_dir, :remote_setup, :files_root, :logger, :local_tmp_dir, :remote_tmp_dir]
     class << self
       attr_accessor *DEFAULT_TO_CLASS_ATTRS
     end
@@ -18,14 +18,16 @@ module Revup
     logger.level    = Logger::INFO
     logger.progname = "revup (#{VERSION})"
 
-    attr_accessor :component_name
+    attr_accessor :versioned_asset_name
 
-    attr_accessor :component_name_and_prerequisites
+    attr_accessor :versioned_asset_name_and_prerequisites
 
     attr_accessor :files_root, :files
 
     attr_accessor :host
 
+    attr_accessor :user
+
     attr_accessor :app_dir
 
     attr_accessor :revision
@@ -36,14 +38,14 @@ module Revup
 
     attr_accessor :logger
 
-    def initialize(component_name_and_prerequisites)
+    def initialize(versioned_asset_name_and_prerequisites)
       DEFAULT_TO_CLASS_ATTRS.each do |attr|
         send("#{attr}=", self.class.send(attr))
       end
 
-      @component_name_and_prerequisites = component_name_and_prerequisites
-      @component_name = @component_name_and_prerequisites.is_a?(Hash) ?
-        @component_name_and_prerequisites.keys.first : @component_name_and_prerequisites
+      @versioned_asset_name_and_prerequisites = versioned_asset_name_and_prerequisites
+      @versioned_asset_name = @versioned_asset_name_and_prerequisites.is_a?(Hash) ?
+        @versioned_asset_name_and_prerequisites.keys.first : @versioned_asset_name_and_prerequisites
 
       yield self if block_given?
       define
@@ -57,7 +59,7 @@ module Revup
     end
 
     def archive_basename
-      "#{@component_name}-#{@revision}"
+      "#{@versioned_asset_name}-#{@revision}"
     end
 
     def local_archive_path
@@ -75,8 +77,8 @@ module Revup
     # Actual task definition
 
     def define
-      desc "Deploy build of the `#{@component_name}' component"
-      task(@component_name_and_prerequisites) do
+      desc "Deploy build of the `#{@versioned_asset_name}' versioned_asset"
+      task(@versioned_asset_name_and_prerequisites) do
         deploy
       end
     end
@@ -85,6 +87,7 @@ module Revup
       validate files_root, "Please specify the location of the root of the files that should be deployed."
       validate files,      "Please specify a list of files that should be deployed."
       validate host,       "Please specify the host of the machine to deploy to."
+      validate user,       "Please specify the user of the machine to deploy to."
       validate app_dir,    "Please specify the path to the application."
       validate revision,   "Please specify the Git revision hash."
 
@@ -102,7 +105,7 @@ module Revup
     end
 
     def upload_and_register
-      Net::SSH.start(@host, ENV['USER']) do |connection|
+      Net::SSH.start(@host, @user) do |connection|
         @ssh = connection
 
         ssh "mkdir -p '#{remote_archive_dir}'"
@@ -112,7 +115,7 @@ module Revup
         # Unpack archive
         ssh "tar -C '#{remote_archive_dir}' -zxf '#{remote_archive_path}'"
         # Register revision
-        ssh "cd '#{@app_dir}' && bundle exec ./script/register_component_revision '#{remote_archive_dir}' '#{component_name}' '#{revision}'"
+        ssh "cd '#{@app_dir}' && bundle exec ./script/register_versioned_asset_revision '#{remote_archive_dir}' '#{versioned_asset_name}' '#{revision}'"
 
         cleanup!
       end

data/lib/revup/version.rb

@@ -1,3 +1,3 @@
 module Revup
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,107 +1,84 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: revup
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Eloy Duran
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-12 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: net-ssh
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
+  requirement: &70336829881540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 3
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.3.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: net-scp
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: *70336829881540
+- !ruby/object:Gem::Dependency
+  name: net-scp
+  requirement: &70336829881020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 4
+      - !ruby/object:Gem::Version
         version: 1.0.4
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: *70336829881020
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70336829880220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 8
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.8.0
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *70336829880220
 description: 
-email: 
+email:
 - eloy@fngtps.com
 - martin@sauspiel.de
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/revup/deploy_task.rb
 - lib/revup/version.rb
 - LICENSE
-has_rdoc: true
+- README.md
 homepage: 
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: A simple deploy tool, packaged as a rake task. Currently targeted for sauspiel.de
 test_files: []
-