strobe 0.3.7 → 0.3.8

data/lib/strobe/cli/deploys.rb

@@ -4,7 +4,7 @@ module Strobe
   class CLI::Deploys < CLI
 
     method_option "application-id", :type => :numeric, :banner => "Use application with given id"
-    action "list", "list deploys" do
+    action "list", "List all deploys for an application" do
       app = get_application(options)
       deploys = app.deploys.all
 
@@ -14,7 +14,7 @@ module Strobe
     method_option "application-id", :type => :numeric, :banner => "Use application with given id"
     method_option "full",           :type => :boolean, :banner => "Display full deploy info"
     method_option "include-builds", :type => :boolean, :banner => "Include builds data"
-    action "show", "show the last deploy" do |*args|
+    action "show", "Show the last deploy for an application" do |*args|
       sha = args.first
 
       app = get_application(options)

data/lib/strobe/cli/main.rb

@@ -7,9 +7,25 @@ module Strobe
   class CLI::Main < CLI
     include CLI::Preview
 
+
+    def self.help(shell, subcommand = false)
+      shell.say <<LONGDESC
+strobe-cli (v#{Strobe::VERSION}) - cli tool for the Strobe Platform
+
+Deploy and manage your applications on the Strobe Platform.
+
+To get started, just run `strobe deploy` in your application directory.
+
+LONGDESC
+
+      super shell, subcommand
+    end
+
     def help(*args)
       if args.first == "users"
         CLI::Users.start( [ "help" ] + args[1..-1] )
+      elsif args.first == "deploys"
+        CLI::Deploys.start( [ "help" ] + args[1..-1] )
       else
         super
       end
@@ -23,7 +39,15 @@ module Strobe
 
     method_option "global", :type => :boolean, :banner => "Set option globally (for all applications)"
     method_option "unset",  :type => :boolean, :banner => "Unset a config option"
-    action "config", "configure strobe", :usage => "config [KEY] [VALUE]" do  |key, *val|
+    long_desc <<-LONGDESC
+      Set configuration variables for your application(s). These are primarily used by
+      the `strobe preview` server.
+
+      For example, you set up the social add-on with:
+
+      > $ strobe config social.twitter.consumer_key [YOUR_CONSUMER_KEY]
+    LONGDESC
+    action "config", "Set configuration variables", :usage => "config KEY [VALUE]" do  |key, *val|
       val = val.first
       case
       when val
@@ -46,14 +70,14 @@ module Strobe
       end
     end
 
-    action "users", 'manage users' do |*args|
+    action "users", 'Manage users' do |*args|
       argv = $__ARGV[1..-1]
       argv = [ 'list' ] + argv if args.empty?
       CLI::Users.start(argv)
     end
 
     method_option "production", :type => :boolean, :banner => "open production version of this application"
-    action "open", "opens application in browser" do
+    action "open", "Opens your application in a web browser" do
       resource get_application
 
       environment = options[:production] ? "production" : "staging"
@@ -62,13 +86,13 @@ module Strobe
       Launchy.open("http://#{url}")
     end
 
-    action "deploys", "manage deploys" do |*args|
+    action "deploys", "Manage deploys" do |*args|
       argv = $__ARGV[1..-1]
       argv = [ 'list' ] + argv if args.empty?
       CLI::Deploys.start(argv)
     end
 
-    action "signup", "signup for a new Strobe account" do
+    action "signup", "Sign up for a new Strobe account" do
       resource Signup.new :account => { :name => 'default' }
 
       if settings[:token]
@@ -98,7 +122,7 @@ module Strobe
       end
     end
 
-    action "login", "register this computer with an existing Strobe account" do
+    action "login", "Register this computer with an existing Strobe account" do
       resource Me.new
 
       until_success do
@@ -116,14 +140,32 @@ module Strobe
     end
 
     method_option "port", :type => :string, :banner => "port to start server on", :aliases => "-p", :default => "9292"
-    action "preview", "preview your application as it would show up on Strobe Platform" do
+    long_desc <<-LONGDESC
+      Preview your application as it would show up on Strobe Platform.
+
+      This command runs a development server that mimics the Strobe
+      Platform on your local computer, making it possible to check your
+      code without having to deploy it.
+
+      By default the preview server runs on port 9292 but you can specify
+      a different port with the `--port` option.
+    LONGDESC
+    action "preview", "Preview your application as it would show up on Strobe Platform" do
       preview_strobe_application(options[:port])
     end
 
     application_path_option
     method_option "message",    :type => :string,  :banner => "add rollback message", :aliases => "-m"
     method_option "production", :type => :boolean, :banner => "rollback a production environment"
-    action "rollback", "rollback application to a state from given deploy" do |sha|
+    long_desc <<-LONGDESC
+      Rollback an application to the state specified by a given deploy key.
+
+      This is useful if you discovered that you deployed bad code and allows
+      you to quickly return to a known good state.
+
+      For a list of deploy keys, run `strobe deploys list`.
+    LONGDESC
+    action "rollback", "Rollback application to a state from given deploy", :usage => "rollback KEY" do |sha|
       ensure_computer_is_registered
 
       id = options['application-id'] || config[:application_id]
@@ -150,7 +192,16 @@ module Strobe
     method_option "sc-build",        :type => :boolean, :banner => "run `sc-build -c` before deploying"
     method_option "no-sc-build",     :type => :boolean, :banner => "skip the `sc-build -c` step"
     method_option "url",                                :banner => "set application's url"
-    action "deploy", "deploy your application to Strobe" do
+    long_desc <<-LONGDESC
+      Deploy your application to the Strobe Platform.
+
+      If you have not yet logged in or created an application, you will
+      be prompted to do so.
+
+      By default your application is deployed to the staging enviroment.
+      To deploy to production, use `--production`.
+    LONGDESC
+    action "deploy", "Deploy your application to Strobe Platform" do
       ensure_computer_is_registered
       env  = (options[:production] ? "production" : "staging")
 
@@ -218,14 +269,22 @@ module Strobe
     end
 
 
-    action "applications", "list all of your applications" do
+    action "applications", "List all of your applications" do
       empty = "You do not have any applications. Try deploying one with `strobe deploy`."
       list_applications :empty => empty
     end
 
     method_option "url",  :type => :string
     application_path_option
-    action "set", "update the settings for the application" do
+    long_desc <<-LONGDESC
+      Update the settings for your Application.
+
+      At the moment, this command is only used for setting your application's URL.
+      To do this, run as:
+
+      > $ strobe set --url URL
+    LONGDESC
+    action "set", "Update the settings for the application" do
       resource get_application
 
       if options['url'].blank?
@@ -241,7 +300,12 @@ module Strobe
 
     application_path_option
     method_option "application-id", :type => :numeric, :banner => "Delete application with given id"
-    action "delete", "delete a specific application" do
+    long_desc <<-LONGDESC
+      Delete a specific application.
+
+      This is a dangerous and permanant action. Fortunately, we confirm it with you before proceeding.
+    LONGDESC
+    action "delete", "Delete a specific application" do
       id = options['application-id'] || (application_dir? && config[:application_id])
       resource(id ? Application.get!(id) : pick_application)
 
@@ -263,7 +327,14 @@ module Strobe
 
     application_path_option
     method_option "application-id", :type => :numeric, :banner => "The ID of the remote application"
-    action "register", "registers a local application with an existing Strobe application" do
+    long_desc <<-LONGDESC
+      Register a local application with an existing Strobe application.
+
+      In the event that you have already set up a Strobe application elsewhere
+      (i.e. via the web interface or on another computer), you can use this
+      command to link your local application to the one on Strobe Platform.
+    LONGDESC
+    action "register", "Registers a local application with an existing Strobe application" do
       if config[:application_id] && app = Application.get(config[:application_id])
         say "The directory is already registered with the application `#{app[:name]}`"
         say "Aborting..."

data/lib/strobe/cli/users.rb

@@ -2,7 +2,7 @@ module Strobe
   class CLI::Users < CLI
 
     application_path_option
-    action "list", "list users that have access to this application" do
+    action "list", "List users that have access to this application" do
       @team = get_current_team!
       if @team.memberships.any?
         say "The following users also have access to the application"
@@ -18,7 +18,7 @@ module Strobe
     end
 
     application_path_option
-    action "add", "give a user access to this application",
+    action "add", "Give a user access to this application",
            :usage => "users add <email>"  do |email|
       @team = get_current_team!
       @team.memberships.create! :email => email
@@ -27,7 +27,7 @@ module Strobe
     end
 
     application_path_option
-    action "remove", "remove a user's access from this application",
+    action "remove", "Remove a user's access to this application",
            :usage => "users remove <email>" do |email|
       @team = get_current_team!
       @team.memberships.each do |m|

data/lib/strobe/cli.rb

@@ -68,8 +68,12 @@ module Strobe
       options = args.last if args.last.is_a?(Hash)
       usage = if options && options[:usage]
         options[:usage]
+      elsif self == Users
+        "users #{name}"
+      elsif self == Deploys
+        "deploys #{name}"
       else
-        self == Users ? "users #{name}" : name
+        name
       end
       desc usage, *args
       define_method("__hax__#{name}", &blk)

data/lib/strobe/connection.rb

@@ -89,17 +89,17 @@ module Strobe
       end
 
       def validate!
-        msg = body['errors'] && body['errors']['request']
         case status
         when 401
-          # TODO Fix this on the server
-          raise UnauthenticatedError, msg
+          raise UnauthenticatedError, error_message
         when 404
-          raise ResourceNotFoundError, msg
+          raise ResourceNotFoundError, error_message
         when 412
-          raise OutdatedStrobeVersionError, msg
+          raise OutdatedStrobeVersionError, error_message
+        when 503
+          headers["x-strobe-maintenance"] ? raise(UnderMaintenanceError) : server_error
         when 500...600
-          raise ServerError.new("The server encountered an error", :response => to_hash, :request => @request.to_hash)
+          server_error
         end
 
         self
@@ -123,12 +123,19 @@ module Strobe
         end
       end
 
+      def error_message
+        body['errors'] && body['errors']['request']
+      end
+
       def json_decode(data)
         ActiveSupport::JSON.decode(@response.body)
       rescue ActiveSupport::JSON.parse_error => e
         raise JSONParseError.new(e, data)
       end
 
+      def server_error
+        raise ServerError.new("The server encountered an error", :response => to_hash, :request => @request.to_hash)
+      end
     end
 
     class Request

data/lib/strobe/version.rb

@@ -1,3 +1,3 @@
 module Strobe
-  VERSION = "0.3.7"
+  VERSION = "0.3.8"
 end

data/lib/strobe.rb

@@ -45,6 +45,12 @@ module Strobe
   class ValidationError            < StrobeError  ; end
   class OutdatedStrobeVersionError < StrobeError  ; end
   class InvalidPortError           < StrobeError  ; end
+  class UnderMaintenanceError      < StrobeError
+    def initialize
+      super("We are currently down for maintenance. You can check our status " \
+        "at http://twitter.com/strobestatus. Please try again soon.")
+    end
+  end
 
   class NotifiableError < StrobeError
     attr_reader :data

metadata

@@ -1,113 +1,160 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: strobe
-version: !ruby/object:Gem::Version
-  version: 0.3.7
+version: !ruby/object:Gem::Version 
+  hash: 3
   prerelease: 
+  segments: 
+  - 0
+  - 3
+  - 8
+  version: 0.3.8
 platform: ruby
-authors:
+authors: 
 - Carl Lerche
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-02 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2011-09-20 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: activemodel
-  requirement: &2153617160 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
         version: 3.0.0
   type: :runtime
-  prerelease: false
-  version_requirements: *2153617160
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: mime-types
-  requirement: &2153616420 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 87
+        segments: 
+        - 1
+        - 16
+        - 0
         version: 1.16.0
   type: :runtime
-  prerelease: false
-  version_requirements: *2153616420
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: rack
-  requirement: &2153615720 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
         version: 1.3.0
   type: :runtime
-  prerelease: false
-  version_requirements: *2153615720
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: thin
-  requirement: &2153614780 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 2
+        - 0
         version: 1.2.0
   type: :runtime
-  prerelease: false
-  version_requirements: *2153614780
-- !ruby/object:Gem::Dependency
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: em-http-request
-  requirement: &2153613700 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 31098193
+        segments: 
+        - 1
+        - 0
+        - 0
+        - beta
         version: 1.0.0.beta
   type: :runtime
-  prerelease: false
-  version_requirements: *2153613700
-- !ruby/object:Gem::Dependency
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: thor
-  requirement: &2153612040 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 39
+        segments: 
+        - 0
+        - 14
+        - 0
         version: 0.14.0
   type: :runtime
-  prerelease: false
-  version_requirements: *2153612040
-- !ruby/object:Gem::Dependency
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
   name: oauth
-  requirement: &2153610140 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 4
+        - 5
         version: 0.4.5
   type: :runtime
-  prerelease: false
-  version_requirements: *2153610140
-- !ruby/object:Gem::Dependency
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
   name: launchy
-  requirement: &2153602640 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *2153602640
-description: The client library for deploying applications to Strobe's HTML5 deployment
-  platform
-email:
+  version_requirements: *id008
+description: The client library for deploying applications to Strobe's HTML5 deployment platform
+email: 
 - carl@strobecorp.com
-executables:
+executables: 
 - strobe
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - lib/strobe/addons/social/facebook.rb
 - lib/strobe/addons/social/twitter.rb
 - lib/strobe/addons/social.rb
@@ -154,28 +201,41 @@ files:
 - README.md
 - lib/strobe/certs/cacert.pem
 - bin/strobe
+has_rdoc: true
 homepage: http://rubygems.org/gems/strobe
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  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
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
       version: 1.3.6
 requirements: []
+
 rubyforge_project: strobe
-rubygems_version: 1.8.6
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A deployment tool for HTML5 applications
 test_files: []
+