bushido 0.0.12 → 0.0.13

data/Gemfile

@@ -1,3 +1,4 @@
+#:nodoc:
 source "http://rubygems.org"
 
 # Specify your gem's dependencies in bushido.gemspec

data/bushido.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Sean Grove"]
   s.email       = ["s@bushi.do"]
-  s.homepage    = "http://gem.bushi.do"
-  s.summary     = %q{Command-lin interface for bushi.do}
+  s.homepage    = "https://github.com/sgrove/bushidogem"
+  s.summary     = %q{Command-line interface for bushi.do}
   s.description = %q{A module for a Bushido app to manipulate everything about itself while running on Bushido, from deploying new apps, to claiming, restarting, updating existing apps, changing public domain, subdomains, etc.}
 
   s.add_dependency "rest-client", ">=1.6.1"

data/lib/bushido.rb

@@ -1,12 +1,15 @@
-module Bushido
+module Bushido #:nodoc:
   require 'rubygems'
   require 'optparse'
   require 'rest-client'
   require 'json'
   require 'highline/import'
+  require 'yaml'
 
   require "bushido/platform"
   require "bushido/utils"
   require "bushido/command"
   require "bushido/app"
+  require "bushido/user"
+  require "bushido/events"
 end

data/lib/bushido/app.rb

@@ -1,53 +1,80 @@
 module Bushido
+  # Bushido::App provides all of the methods to interact with the app it's included in,
+  # and only contains class methods. Each method will check for the most recent data,
+  # so it's possible the data may change between two separate calls.
   class App
     class << self
-      def app_url
+      def app_url #:nodoc:
         "#{Bushido::Platform.host}/apps/#{Bushido::Platform.app}.json"
       end
 
 
-      def get(params={})
+      def get(params={}) #:nodoc:
         Bushido::Command.get_command(app_url, params)
       end
 
 
-      def put(command, params={})
+      def put(command, params={})  #:nodoc:
         params[:command] = command
 
         Bushido::Command.put_command(app_url, params)
       end
 
 
+      # Get all of the information related to the current app, returns a hash
       def show
         result = get
       end
 
 
+      # Starts a currently stopped app
+      # ==== Example Scenario
+      # You may want to use this when recieving a \<tt>rake bushido:message</tt> event to
+      # start up your app for an incoming message
       def start
         put :start
       end
 
 
+      # Stops an app.
+      # ==== Example Scenario
+      # Use this if you want to put your application in 'maintenance mode'.
       def stop
         put :stop
       end
 
 
-      def restart
+      # Stops (if started) and then starts an app
+      # ==== Example Scenario
+      # if you've added environmental variables to an application and need the app
+      # to restart to pick them up, use this.
+      def restart # :nodoc:
         put :restart
       end
 
-
+      # Claims an app for the current Bushido user
+      # Raises an exception if app is launched anonymously
+      # ==== Example Scenario
+      # Integrate Bushido app claiming behavior directly into your app to help
+      # conversion rates
       def claim
         put :claim
       end
 
 
+      # Updates the app to the latest git checkout, using the branch the app
+      # was initially dpeloyed from
+      # ==== Example Scenario
+      # Allow your users to upgrade to the latest version via a link directly in your application
       def update
         put :update
       end
 
 
+      # Add an environmental variable
+      # ==== Example Scenario
+      # Allows your app to easily integrate into third-party services, e.g. mixpanel.
+      # A user can enter their own API key, and you can activate your mixpanel code.
       def add_var(key, value)
         put :add_var, {:key => key, :value => value}
         if Bushido::Command.last_command_successful?
@@ -56,6 +83,9 @@ module Bushido
       end
 
 
+      # Remove an environmental variable
+      # ==== Example Scenario
+      # 
       def remove_var(key)
         put :remove_var, {:key => key}
         if Bushido::Command.last_command_successful?
@@ -64,16 +94,27 @@ module Bushido
       end
 
 
+      # List all custom domains belonging to the current application
+      # ==== Example Scenario
+      # A CMS may want to use this if hosting multiple sites
       def domains
         get()["app"]["domains"]
       end
 
 
+      # Returns the current subdomain of the app, whether that's the default
+      # (e.g. "happy-rabbit-12") or a custom-set subdomain ("my-example")
+      # ==== Example Scenario
+      # A CMS will use this to know which subdomain to respond to
       def subdomain
         get()["app"]["subdomain"]
       end
 
 
+      # Check if a subdomain of bushi.do is currently available
+      # ==== Example Scenario
+      # An application may want to change its subdomain to something user-chosen;
+      # use this before-hand to ensure it's available
       def subdomain_available?(subdomain)
         begin
           return put :subdomain_available?, {:subdomain => subdomain}
@@ -83,6 +124,10 @@ module Bushido
       end
 
 
+      # Set the bushi.do subdomain of an application
+      # ==== Example Scenario
+      # An app is initially launched to a randomly-generated subdomain, but may
+      # want to move to something more memorable for a given user.
       def set_subdomain(subdomain)
         result = put :set_subdomain!, {:subdomain => subdomain}
         if Bushido::Command.last_command_successful?
@@ -95,28 +140,54 @@ module Bushido
       end
 
 
+      # Adds a domain to the Bushido webrecords for an app. The app \<b>must</b>
+      # be a premium-app in order to add domains
+      # ==== Example Scenario
+      # If after launching a CMS a user decides to use a custom domain, an app
+      # can allow a user to customize it directly without resorting to the Bushido
+      # app control panel.
       def add_domain(domain)
         put :add_domain!, {:domain => domain}
       end
 
 
+      # Removes a custom domain from the Bushido webrecords. Only works if the
+      # custom domain:
+      # * belongs to the current user
+      # * points at the current app
+      # ==== Example Scenario
+      # A user may decide to migrate a domain to a different app. This allows an app
+      # to remove it from its records without resorting to the Bushido app
+      # control panel
       def remove_domain(domain)
         put :remove_domain!, {:domain => domain}
       end
 
 
+      # Clear out the given log
+      # ==== Example Scenario
+      # An app may keep its production log for analysis by the end-user, but the
+      # user may want to clear out the irrelevant past logs.
       def clear_log!(name)
         put :clear_log!, {:name => name}
       end
 
 
+      # Get all of the new logs. Returns a hash of the form {:name_of_log_X => "content of log X"}
+      # On Bushido, there are by default the following logs:
+      # * access - Any page hit or asset request
+      # * error - Any error we had serving the page/asset
+      # * production - Output from the rails server
+      # * bushido - logs from the bushido deploy, update, start/stop process
+      #--
       # TODO: Update to use the new logs controller
+      #++
       def logs
         get({:gift => "logs"})
       end
 
 
-      def ssh_key
+      def ssh_key #:nodoc:
         get({:gift => "ssh_key"})["ssh_key"]
       end
     end

data/lib/bushido/command.rb

@@ -1,5 +1,5 @@
 module Bushido
-  class Command
+  class Command #:nodoc:
     @@last_request  = nil
     @@request_count = 0
     @@last_request_successful = true

data/lib/bushido/event.rb

@@ -0,0 +1,32 @@
+module Bushido
+  # Bushido::Event lists all the events from the Bushido server. All events
+  # are hashes with the following keys:
+  # * category
+  # * name
+  # * data
+  # Data will hold the arbitrary data for the type of event signalled
+  class Event
+    begin
+      @@events = YAML.load(ENV["BUSHIDO_EVENTS"]) #:nodoc:
+    rescue
+      @@events = []
+    end
+
+    class << self
+      # Lists all events
+      def all
+        @@events
+      end
+
+      # Lists the first (oldest) event
+      def first
+        @@events.first
+      end
+
+      # Lists the last (newest) event
+      def last
+        @@events.last
+      end
+    end
+  end
+end

data/lib/bushido/platform.rb

@@ -1,5 +1,5 @@
 module Bushido
-  class Platform
+  class Platform #:nodoc:
     class << self
       def app
         ENV['BUSHIDO_APP']

data/lib/bushido/user.rb

@@ -0,0 +1,29 @@
+module Bushido
+  # Bushido User enables user validation against Bushido's server
+  class User
+    class << self
+      def unity_url #:nodoc:
+        "#{Bushido::Platform.host}/connect/v1"
+      end
+
+
+      # Checks whether user an email and password correspond to a valid bushido
+      # user. Returns nil if false, or the Bushido user's ID if true.
+      def valid?(email, pass)
+        params = {}
+        params[:email] = email
+        params[:pass] = pass
+        Bushido::Command.post_command("#{unity_url}/valid", params)
+      end
+      
+
+      # Checks whether email corresponds to a valid Bushido user.
+      # Returns true or false
+      def exists?(email)
+        params = {}
+        params[:email] = email
+        Bushido::Command.post_command("#{unity_url}/exists", params)
+      end
+    end
+  end
+end

data/lib/bushido/utils.rb

@@ -1,5 +1,5 @@
 module Bushido
-  class Utils
+  class Utils #:nodoc:
     class << self
       # TODO: Make this update all the available ENV variables 
       def refresh_env!

data/lib/bushido/version.rb

@@ -1,3 +1,4 @@
 module Bushido
-  VERSION = "0.0.12"
+  # Current version of the Bushido gem 
+  VERSION = "0.0.13"
 end

data/test/test_executable.rb

@@ -1,6 +1,6 @@
 require 'test/unit'
 
-class TestExecutable < Test::Unit::TestCase
+class TestExecutable < Test::Unit::TestCase #:nodoc:
   EXECUTABLE = 
   def test_complains_with_no_args
     output = %x{#{File.expand_path('../../bin/bushido', __FILE__)}}

metadata

@@ -2,7 +2,7 @@
 name: bushido
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors: 
 - Sean Grove
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-31 00:00:00 -07:00
+date: 2011-05-27 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -64,12 +64,14 @@ files:
 - lib/bushido.rb
 - lib/bushido/app.rb
 - lib/bushido/command.rb
+- lib/bushido/event.rb
 - lib/bushido/platform.rb
+- lib/bushido/user.rb
 - lib/bushido/utils.rb
 - lib/bushido/version.rb
 - test/test_executable.rb
 has_rdoc: true
-homepage: http://gem.bushi.do
+homepage: https://github.com/sgrove/bushidogem
 licenses: []
 
 post_install_message: 
@@ -92,9 +94,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: bushido
-rubygems_version: 1.5.0
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Command-lin interface for bushi.do
+summary: Command-line interface for bushi.do
 test_files: 
 - test/test_executable.rb