debox 0.0.1 → 0.0.2

data/.gitignore

@@ -18,3 +18,4 @@ tmp
 *~
 #*
 .#*
+config/database.yml

data/Gemfile

@@ -11,5 +11,7 @@ gemspec
 group :test do
   gem 'debox_server'
   gem 'rspec'
-  gem 'thin'
+  gem 'thin' # We need it for eventsource
+  gem 'database_cleaner'
+  gem 'mysql2'
 end

data/README.org

@@ -0,0 +1,116 @@
+* Debox
+
+This gem is the client for the Debox Server. It allow you to create and update capistrano recipes, run tasks and manage users in the server.
+
+* Installation
+
+To install the latest version, run:
+
+#+BEGIN_SRC sh
+  $ [sudo] gem install debox
+#+END_SRC
+
+* Usage
+
+First thing to do after install the gem is login into your debox server.
+
+#+BEGIN_SRC sh
+  $ debox login -h deboxserver.com -u youruser@email.com
+#+END_SRC
+
+** Getting help
+
+To get a list of available commands run:
+
+#+BEGIN_SRC sh
+  $ debox -h
+
+  Usage: debox command [options]
+  Commands:
+      recipes application                            # List recipes for the application
+      recipes:show application environment           # Show a new capistrano recipe
+      recipes:new application environment            # Create a new capistrano recipe
+      recipes:edit application environment           # Edit a capistrano recipe
+      recipes:delete application environment         # Delete a capistrano recipe
+      users                                          # List all users in the debox server
+      users:new                                      # Create user
+      users:delete email                             # Delete user with a given email
+      apps                                           # List apps and envs
+      log application [environment] [index]          # Show log. Last by default
+      logs application [environment]                 # List logs for application and env
+      deploy application enviroment                  # Deploy application
+      cap task application [environment]             # Deploy application
+      login                                          # Login in the debox server. Require -h param.
+      live application enviroment                    # Live log for application
+      key:show                                       # Show the server ssh public key
+      key:copy target_host                           # Copy the server ssh public key to the target host
+  Options:
+      -h, --host SERVER_HOST           Debox server url
+      -p, --port PORT                  Debox server port
+      -u, --user EMAIL                 User name
+      -?, --help                       Show this help
+#+END_SRC
+
+** Keys setup
+
+You must add the public key for the user runnin the debox server to the server where capistrano have to connect and run task.
+The debox client includes a command for help with this, you can run:
+
+#+BEGIN_SRC sh
+  $ debox key:copy your_application_server
+#+END_SRC
+
+If you haven't access to this server, you can get the key with this command:
+
+#+BEGIN_SRC sh
+  $ debox key:show
+#+END_SRC
+
+** Display applications configured in the server
+
+To get a list of configured apps and its environment run:
+
+#+BEGIN_SRC sh
+  $ debox apps
+#+END_SRC
+
+It will show a list of apps and configured envirments
+
+** Adding applications or environments
+
+To create an application or add a new env to an existent application.
+
+#+BEGIN_SRC sh
+  $ debox recipes:new application_name environment_name
+#+END_SRC
+
+This command will open your default text editor, defined in the environment variable $EDITOR, with a boostraped capistrano recipe.
+After save and close this file, it will be automatically uploaded to the server and ready to use.
+
+** Edit environments
+
+For change the capistrano recipe configured for any recipe run:
+#+BEGIN_SRC sh
+  $ debox recipes:edit application_name environment_name
+#+END_SRC
+
+** Show environments
+
+To get the content for a recipe just run:
+
+#+BEGIN_SRC sh
+  $ debox recipes:show
+#+END_SRC
+
+** Run tasks
+
+You can run any task defined in the capistrano recipe with the cap command:
+
+#+BEGIN_SRC sh
+  $ debox cap deploy:setup app env
+  $ debox cap deploy app env
+  $ debox cap deploy:migrate app env
+  $ debox cap deploy:restart app env
+#+END_SRC
+
+It will stream the server output to the stdout

data/config/database.yml.sample

@@ -0,0 +1,26 @@
+development:
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  database: debox_development
+  pool: 5
+  username: root
+  password:
+
+test:
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  database: debox_test
+  pool: 5
+  username: root
+  password:
+
+production:
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  database: debox_production
+  pool: 5
+  username: root
+  password:

data/lib/debox/api.rb

@@ -21,6 +21,11 @@ module Debox
       get '/v1/apps'
     end
 
+    # Server status
+    def self.status
+      get '/v1/status'
+    end
+
     # users
     #----------------------------------------------------------------------
 
@@ -90,10 +95,12 @@ module Debox
     #----------------------------------------------------------------------
 
     def self.live(opt, &block)
-      path = "/v1/live/log/#{opt[:app]}"
-      path += "/#{opt[:env]}" if opt[:env]
+      path = "/v1/live/log/job/#{opt[:job_id]}"
+      eventSource path, { }, block
+    end
 
-      # stream path, nil, { }, block
+    def self.notifications(opt={ }, &block)
+      path = "/v1/live/notifications"
       eventSource path, { }, block
     end
 
@@ -106,7 +113,7 @@ module Debox
     def self.log(opt)
       path = "/v1/log/#{opt[:app]}"
       path += "/#{opt[:env]}" if opt[:env]
-      path += "?index=#{opt[:index]}" if opt[:index]
+      path += "?job_id=#{opt[:job_id]}" if opt[:job_id]
       get_raw(path).body
     end
 

data/lib/debox/command/cap.rb

@@ -7,8 +7,8 @@ class Debox::Command::Cap < Debox::Command::Base
     deploy_params = { task: args[0], app: args[1] }
     deploy_params[:env] = args[2] if args.count == 3
     cap_request = Debox::API.cap(deploy_params)
-    sleep 1
-    Debox::API.live(deploy_params) do |chunk|
+    job_id = cap_request[:job_id]
+    Debox::API.live(job_id: job_id) do |chunk|
       puts chunk
     end
   end

data/lib/debox/command/live.rb

@@ -2,8 +2,8 @@ require 'debox/command/base'
 
 class Debox::Command::Live < Debox::Command::Base
 
-  help :index, params: ['application', 'enviroment'], text: 'Live log for application'
-  def index
+  help :log, params: ['job_id'], text: 'Live log for job'
+  def log
     opt = { app: args[0] }
     opt[:env] = args[1] if args[1]
     Debox::API.live(opt) do |chunk|
@@ -11,4 +11,12 @@ class Debox::Command::Live < Debox::Command::Base
     end
   end
 
+
+  help :notifications, text: 'Live notifications'
+  def notifications
+    Debox::API.notifications do |chunk|
+      puts chunk
+    end
+  end
+
 end

data/lib/debox/command/log.rb

@@ -3,13 +3,13 @@ require 'debox/command/base'
 class Debox::Command::Log < Debox::Command::Base
   include Debox::Utils
 
-  help :index, params: ['application'],opt_params: ['environment', 'index'],
+  help :index, params: ['application'],opt_params: ['environment', 'job_id'],
   text: "Show log. Last by default"
 
   def index
     opt = { app: args[0] }
     opt[:env] = args[1] if args.length > 1
-    opt[:index] = args[2] if args.length > 2
+    opt[:job_id] = args[2] if args.length > 2
 
     puts Debox::API.log opt
   end

data/lib/debox/command/logs.rb

@@ -16,11 +16,15 @@ class Debox::Command::Logs < Debox::Command::Base
   private
 
   def format_log_info(log)
+    status = log[:success] ? "SUCCESS" : "FAILED"
+    start_time = log[:start_time] ? DateTime.parse(log[:start_time]).to_s : ""
+    end_time = log[:end_time] ? DateTime.parse(log[:end_time]).to_s : ""
+
     l = []
-    l << log[:job_id]
-    l << log[:status]
+    l << log[:id]
+    l << status
     l << log[:task]
-    l << DateTime.parse(log[:time]).to_s
+    l << start_time
     l << log[:error]
     l.join "\t"
   end

data/lib/debox/command/status.rb

@@ -0,0 +1,11 @@
+require 'debox/command/base'
+
+class Debox::Command::Status < Debox::Command::Base
+
+  help :index, text: 'Show server status'
+  def index
+    status = Debox::API.status
+    puts status
+  end
+
+end

data/lib/debox/version.rb

@@ -1,3 +1,3 @@
 module Debox
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/integration/api/cap/cap_spec.rb

@@ -3,25 +3,25 @@ describe 'cap' do
 
   it 'should deal with invalid app' do
     configure_admin
-    DeboxServer::Deployer.should_not_receive(:add_job_to_queue)
+    DeboxServer::jobs_queue.should_not_receive(:add)
     expect {
       Debox::API.cap(app: 'test')
-    }.to raise_error Debox::DeboxServerException, '400: App not found'
+    }.to raise_error Debox::DeboxServerException, "400: Couldn't find App with name = test"
   end
 
   it 'should deal with invalid env' do
     configure_admin
     server.create_recipe('test', :production, 'invalid content')
-    DeboxServer::Deployer.should_not_receive(:add_job_to_queue)
+    DeboxServer::jobs_queue.should_not_receive(:add)
     expect {
       Debox::API.cap(app: 'test', env: 'invalid')
-    }.to raise_error Debox::DeboxServerException, '400: Environment not found.'
+    }.to raise_error Debox::DeboxServerException, "400: Couldn't find Recipe with name = invalid"
   end
 
   it 'should run a cap task gith a given app' do
     configure_admin
     server.create_recipe('test', :production, 'invalid content')
-    DeboxServer::Deployer.should_receive(:add_job_to_queue)
+    DeboxServer::jobs_queue.should_receive(:add)
 
     job = Debox::API.cap app: 'test'
     job[:app].should eq 'test'
@@ -33,7 +33,7 @@ describe 'cap' do
     configure_admin
     server.create_recipe('test', :production, 'invalid content')
     server.create_recipe('test', :staging, 'invalid content')
-    DeboxServer::Deployer.should_receive(:add_job_to_queue)
+    DeboxServer::jobs_queue.should_receive(:add)
 
     job = Debox::API.cap app: 'test', env: 'staging'
     job[:app].should eq 'test'
@@ -46,7 +46,7 @@ describe 'cap' do
     configure_admin
     server.create_recipe('test', :production, 'invalid content')
     server.create_recipe('test', :staging, 'invalid content')
-    DeboxServer::Deployer.should_receive(:add_job_to_queue)
+    DeboxServer::jobs_queue.should_receive(:add)
 
     job = Debox::API.cap app: 'test', env: 'staging', task: 'node:setup'
     job[:app].should eq 'test'

data/spec/integration/api/logs/index_spec.rb

@@ -2,38 +2,31 @@ require 'spec_helper'
 
 describe 'logs' do
   it 'should return all the logs' do
-    time = DateTime.now
-    out = OpenStruct.new time: time, success: true, buffer: 'Some log content', error: 'Log result'
     server.create_recipe('test', 'production', 'content')
-    job = stubbed_job 'test', 'production', 'deploy', out
-    job.save_log
+    job = Job.new error: 'Log result'
+    Recipe.any_instance.should_receive(:jobs).and_return [job]
 
     configure_admin
 
     logs = Debox::API.logs app: 'test', env: 'production'
     logs.count.should eq 1
     saved = logs.first
-    DateTime.parse(saved[:time]).to_s.should eq time.to_s
+
     saved[:error].should eq 'Log result'
-    saved[:status].should eq 'success'
   end
 
   it 'should set default env if not set and only one available' do
-    time = DateTime.now
-    out = OpenStruct.new time: time, success: true, buffer: 'Some log content', error: 'Log result'
     server.create_recipe('test', 'production', 'content')
-    job = stubbed_job 'test', 'production', 'deploy', out
-    job.save_log
+    job = Job.new error: 'Log result'
+    Recipe.any_instance.should_receive(:jobs).and_return [job]
 
     configure_admin
 
-    logs = Debox::API.logs app: 'test', env: 'production'
+    logs = Debox::API.logs app: 'test'
     logs.count.should eq 1
     saved = logs.first
 
-    DateTime.parse(saved[:time]).to_s.should eq time.to_s
     saved[:error].should eq 'Log result'
-    saved[:status].should eq 'success'
   end
 
   it 'should empty array withut logs' do
@@ -47,7 +40,7 @@ describe 'logs' do
     configure_admin
     expect {
       Debox::API.logs app: 'test', env: 'production'
-    }.to raise_error Debox::DeboxServerException, '400: App not found'
+    }.to raise_error Debox::DeboxServerException, "400: Couldn't find App with name = test"
 
   end
 

data/spec/integration/api/logs/show_spec.rb

@@ -1,10 +1,11 @@
 require 'spec_helper'
 describe 'log' do
   it 'should return the log' do
-    out = OpenStruct.new time: DateTime.now, success: true, buffer: 'Some log content', error: 'Log result'
     server.create_recipe('test', 'production', 'content')
-    job = stubbed_job 'test', 'production', 'deploy', out
-    job.save_log
+    job = Job.new error: 'Log result', log: 'Some log content'
+    jobs = double('jobs')
+    jobs.should_receive(:last).and_return job
+    Recipe.any_instance.should_receive(:jobs).and_return jobs
 
     configure_admin
 
@@ -13,10 +14,11 @@ describe 'log' do
   end
 
   it 'should return the log without env' do
-    out = OpenStruct.new time: DateTime.now, success: true, buffer: 'Some log content', error: 'Log result'
     server.create_recipe('test', 'production', 'content')
-    job = stubbed_job 'test', 'production', 'deploy', out
-    job.save_log
+    job = Job.new error: 'Log result', log: 'Some log content'
+    jobs = double('jobs')
+    jobs.should_receive(:last).and_return job
+    Recipe.any_instance.should_receive(:jobs).and_return jobs
 
     configure_admin
 

data/spec/integration/api/recipes/destroy_spec.rb

@@ -5,10 +5,10 @@ describe 'recipes_delete' do
 
   it 'should destroy the recipe if exists' do
     configure_admin
-    server.create_recipe('test', :staging, 'sample content')
-    server.create_recipe('test', :production, 'sample content')
+    staging_recipe = server.create_recipe('test', :staging, 'sample content')
+    production_recipe = server.create_recipe('test', :production, 'sample content')
     response = Debox::API.recipes_destroy app: 'test', env: 'staging'
     response.code.should eq '200'
-    server.recipes_list('test').should eq ['production']
+    Recipe.all.should eq [production_recipe]
   end
 end

data/spec/integration/api/recipes/index_spec.rb

@@ -1,11 +1,14 @@
 require 'spec_helper'
 
 describe 'recipes index' do
-  it 'should return an empty array without recipes' do
+
+  it 'should return invalid if app does not exists' do
     configure_admin
-    Debox::API.recipes(app: 'test').should eq []
-  end
+    expect {
+      Debox::API.recipes(app: 'test')
+    }.to raise_error Debox::DeboxServerException, "400: Couldn't find App with name = test"
 
+  end
 
   it 'should return current recipes if any' do
     app = 'test'

data/spec/integration/api/recipes/new_spec.rb

@@ -1,7 +1,9 @@
 require 'spec_helper'
 
 describe 'recipes new' do
-  it 'should create a new config file with the content of the template' do
+
+  xit 'should create a new config file with the content of the template' do
+
     configure_admin
     response = Debox::API.recipes_new app: 'test_app', env: 'production'
     response.should match 'test_app'

data/spec/integration/api/users/delete_spec.rb

@@ -6,6 +6,6 @@ describe 'users_delete' do
     create_admin 'other@indeos.es'
     response = Debox::API.users_delete user: 'other@indeos.es'
     response.code.should eq '200'
-    server.users_list.should eq [user.email]
+    User.all.collect(&:email).should eq [user.email]
   end
 end

data/spec/integration/api/users/index_spec.rb

@@ -5,6 +5,6 @@ describe 'users' do
     user = create_admin
     configure_admin user
     create_admin 'other@email.com'
-    Debox::API.users.should eq ['other@email.com', user.email]
+    Debox::API.users.should eq [user.email, 'other@email.com']
   end
 end

data/spec/integration/commands/cap_spec.rb

@@ -2,14 +2,14 @@ require 'spec_helper'
 
 describe 'cap command' do
   it 'should call API::cap and API::live' do
-    Debox::API.should_receive(:cap).with(app: 'test', env: 'prod', task: 'deploy').and_return '1'
-    Debox::API.should_receive(:live).with(app: 'test', env: 'prod', task: 'deploy')
+    Debox::API.should_receive(:cap).with(app: 'test', env: 'prod', task: 'deploy').and_return job_id: 1
+    Debox::API.should_receive(:live).with(job_id: 1)
     run_command 'cap deploy test prod'
   end
 
   it 'env is optional' do
-    Debox::API.should_receive(:cap).with(app: 'test', task: 'deploy').and_return '1'
-    Debox::API.should_receive(:live).with(app: 'test', task: 'deploy')
+    Debox::API.should_receive(:cap).with(app: 'test', task: 'deploy').and_return job_id: 1
+    Debox::API.should_receive(:live).with(job_id: 1)
     run_command 'cap deploy test'
   end
 

data/spec/spec_helper.rb

@@ -1,11 +1,13 @@
 ENV['RACK_ENV'] = 'test'
+ENV['DEBOX_ROOT'] = File.join(File.dirname(__FILE__), '../')
 
 require 'rubygems'
 require 'bundler'
 require 'rack'
 require 'thin'
 require 'debox_server'
-
+require 'debox_server/api'
+require 'database_cleaner'
 Bundler.require
 
 require "debox/cli"
@@ -26,10 +28,13 @@ DEBOX_SERVER_PORT = 9393
 debox_server_start DEBOX_SERVER_PORT
 
 RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.clean
+  end
 
   # Cleanup database after each test
   config.after(:each) do
-    DeboxServer::RedisDB.flush_test_db
+    DatabaseCleaner.clean
   end
-
 end

data/spec/support/herlpers.rb

@@ -26,15 +26,6 @@ def configure
   Debox::Config.stub(:config).and_return host: 'localhost', port: DEBOX_SERVER_PORT
 end
 
-# Build a job with stdout and capistrano methos stubbed
-def stubbed_job(app, env, task='deploy', out=nil)
-  out = OpenStruct.new time: DateTime.now, success: true unless out
-  job = DeboxServer::Job.new(app, env, task)
-  job.stub(:stdout) { out }
-  job.stub(:capistrano) { { } }
-  return job
-end
-
 def run_command(args_str, options={})
   args = args_str.split
   given_command = args.shift.strip

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: debox
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-08 00:00:00.000000000 Z
+date: 2013-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -103,9 +103,10 @@ files:
 - .rspec
 - Gemfile
 - LICENSE
-- README.md
+- README.org
 - Rakefile
 - bin/debox
+- config/database.yml.sample
 - debox.gemspec
 - lib/debox.rb
 - lib/debox/api.rb
@@ -122,6 +123,7 @@ files:
 - lib/debox/command/login.rb
 - lib/debox/command/logs.rb
 - lib/debox/command/recipes.rb
+- lib/debox/command/status.rb
 - lib/debox/config.rb
 - lib/debox/utils.rb
 - lib/debox/version.rb

data/README.md

@@ -1,29 +0,0 @@
-# Debox
-
-Command line tool for Debox
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'debox'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install debox
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request