cfoundry 0.2.1 → 0.2.2

data/lib/cfoundry/app.rb

@@ -60,7 +60,8 @@ module CFoundry
       @manifest = manifest
     end
 
-    def inspect # :nodoc:
+    # Show string representing the application.
+    def inspect
       "#<App '#@name'>"
     end
 
@@ -209,7 +210,8 @@ module CFoundry
     alias :url :uri
     alias :url= :uri=
 
-    def framework # :nodoc:
+    # Application framework.
+    def framework
       manifest["staging"]["framework"] ||
         manifest["staging"]["model"]
     end
@@ -225,7 +227,8 @@ module CFoundry
       end
     end
 
-    def runtime # :nodoc:
+    # Application runtime.
+    def runtime
       manifest["staging"]["runtime"] ||
         manifest["staging"]["stack"]
     end
@@ -242,7 +245,10 @@ module CFoundry
     end
 
 
-    def command # :nodoc:
+    # Application startup command.
+    #
+    # Used for standalone apps.
+    def command
       manifest["staging"]["command"]
     end
 
@@ -253,7 +259,8 @@ module CFoundry
     end
 
 
-    def memory # :nodoc:
+    # Application memory.
+    def memory
       manifest["resources"]["memory"]
     end
 
@@ -264,7 +271,8 @@ module CFoundry
     end
 
 
-    def debug_mode # :nodoc:
+    # Application debug mode.
+    def debug_mode
       manifest.fetch("debug") do
         manifest["meta"] && manifest["meta"]["debug"]
       end
@@ -310,8 +318,6 @@ module CFoundry
     end
 
     # Default paths to exclude from upload payload.
-    #
-    # Value: .git, _darcs, .svn
     UPLOAD_EXCLUDE = %w{.git _darcs .svn}
 
     # Upload application's code to target. Do this after #create! and before
@@ -402,8 +408,6 @@ module CFoundry
     end
 
     # Minimum size for an application payload to bother checking resources.
-    #
-    # Value: 64kb
     RESOURCE_CHECK_LIMIT = 64 * 1024
 
     def determine_resources(path)
@@ -480,7 +484,8 @@ module CFoundry
         @manifest = manifest
       end
 
-      def inspect # :nodoc:
+      # Show string representing the application instance.
+      def inspect
         "#<App::Instance '#@app' \##@index>"
       end
 

data/lib/cfoundry/client.rb

@@ -9,13 +9,14 @@ module CFoundry
   # values. Initialize with the target and, optionally, an auth token. These
   # are the only two internal states.
   class Client
-    attr_reader :rest #:nodoc:
+    # Internal RESTClient instance. Normally won't be touching this.
+    attr_reader :rest
 
     # Create a new Client for interfacing with the given target.
     #
     # A token may also be provided to skip the login step.
     def initialize(target = "http://api.cloudfoundry.com", token = nil)
-      @rest = RESTClient.new(*args)
+      @rest = RESTClient.new(target, token)
     end
 
     # The current target URL of the client.

data/lib/cfoundry/errors.rb

@@ -1,10 +1,16 @@
 module CFoundry
   # Exception representing errors returned by the API.
   class APIError < RuntimeError
-    class << self # :nodoc:
-      attr_reader :error_code, :description # :nodoc:
+    class << self
+      # Generic error code for the exception.
+      attr_reader :error_code
 
-      def setup(code, description = nil) # :nodoc:
+      # Generic description for the exception.
+      attr_reader :description
+
+      private
+
+      def setup(code, description = nil)
         @error_code = code
         @description = description
       end
@@ -26,7 +32,8 @@ module CFoundry
       @description || self.class.description
     end
 
-    def to_s # :nodoc:
+    # Exception message.
+    def to_s
       if error_code
         "#{error_code}: #{description}"
       else
@@ -53,7 +60,8 @@ module CFoundry
       @message = message
     end
 
-    def to_s # :nodoc:
+    # Exception message.
+    def to_s
       "#{description} (#{@message})"
     end
   end
@@ -66,7 +74,11 @@ module CFoundry
   # Exception raised when access is denied to something, either because the
   # user is not logged in or is not an administrator.
   class Denied < APIError
-    attr_reader :error_code, :description # :nodoc:
+    # Specific error code.
+    attr_reader :error_code
+
+    # Specific description.
+    attr_reader :description
 
     # Initialize, with a default error code and message.
     def initialize(
@@ -86,7 +98,8 @@ module CFoundry
       @body = body
     end
 
-    def to_s # :nodoc:
+    # Exception message.
+    def to_s
       "target failed to handle our request due to an internal error (#{@code})"
     end
   end

data/lib/cfoundry/service.rb

@@ -36,7 +36,8 @@ module CFoundry
       @manifest = manifest
     end
 
-    def inspect # :nodoc:
+    # Show string representing the service.
+    def inspect
       "#<Service '#@name'>"
     end
 

data/lib/cfoundry/user.rb

@@ -18,7 +18,8 @@ module CFoundry
       @manifest = manifest
     end
 
-    def inspect # :nodoc:
+    # Show string representing the user.
+    def inspect
       "#<User '#@email'>"
     end
 

data/lib/cfoundry/version.rb

@@ -1,4 +1,4 @@
 module CFoundry # :nodoc:
   # CFoundry library version number.
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cfoundry
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Alex Suraci
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-02 00:00:00 Z
+date: 2012-06-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rest-client
@@ -154,3 +154,4 @@ test_files:
 - spec/client_spec.rb
 - spec/helpers.rb
 - spec/Rakefile
+has_rdoc: