squall 1.3.0 → 1.3.1

data/lib/squall/network_zone.rb

@@ -1,71 +1,69 @@
 module Squall
   # OnApp NetworkZone
   class NetworkZone < Base
-    # Returns a list of network zones
+    # Public: Lists all network zones.
+    #
+    # Returns an Array.
     def list
       response = request(:get, "/network_zones.json")
       response.collect { |i| i['network_group'] }
     end
 
-    # Get the details for a network zone
+    # Public: Get the details for a network zone.
     #
-    # ==== Params
+    # id - ID of the network zone
     #
-    # * +id*+ - ID of the network zone
+    # Returns a Hash.
     def show(id)
       response = request(:get, "/network_zones/#{id}.json")
       response['network_group']
     end
 
-    # Updates an existing network zone
-    #
-    # ==== Params
-    #
-    # * +id*+ - ID of the network zone
+    # Public: Updates an existing network zone.
     #
-    # ==== Options
+    # id      - ID of the network zone
+    # options - Options to update the network zone, see `#create`
     #
-    # See #create
+    # Returns a Hash.
     def edit(id, options = {})
-      params.required(:label).validate!(options)
-      response = request(:put, "/network_zones/#{id}.json", :query => {:pack => options})
+      request(:put, "/network_zones/#{id}.json", query:  { pack: options })
     end
 
-    # Creates a new network zone
+    # Public: Creates a new network zone.
     #
-    # ==== Options
+    # options - Options for creating the new network zone:
+    #           :label - Label for the network zone
     #
-    # * +label*+ - Label for the network zone
+    # Returns a Hash.
     def create(options = {})
-      params.required(:label).validate!(options)
-      response = request(:post, "/network_zones.json", :query => {:pack => options})
+      request(:post, "/network_zones.json", query: { pack: options })
     end
 
-    # Deletes an existing network zone
+    # Public: Deletes an existing network zone.
     #
-    # ==== Params
+    # id - ID of the network zone
     #
-    # * +id*+ - ID of the network zone
+    # Returns a Hash.
     def delete(id)
       request(:delete, "/network_zones/#{id}.json")
     end
 
-    # Attach a network to a network zone
+    # Public: Attach a network to a network zone.
     #
-    # ==== Params
+    # id         - ID of the network zone
+    # network_id - ID of the network
     #
-    # * +id*+ - ID of the network zone
-    # * +network_id+ - ID of the network
+    # Returns a Hash.
     def attach(id, network_id)
       request(:post, "/network_zones/#{id}/networks/#{network_id}/attach.json")
     end
 
-    # Detach a network from a network zone
+    # Public: Detach a network from a network zone.
     #
-    # ==== Params
+    # id         - ID of the network zone
+    # network_id - ID of the network
     #
-    # * +id*+ - ID of the network zone
-    # * +network_id+ - ID of the network
+    # Returns a Hash.
     def detach(id, network_id)
       request(:post, "/network_zones/#{id}/networks/#{network_id}/detach.json")
     end

data/lib/squall/payment.rb

@@ -1,59 +1,49 @@
 module Squall
   # OnApp Payment
   class Payment < Base
-
-    # Return a list of all payments
+    # Public: Lists all payments.
+    #
+    # Returns an Array.
     def list(user_id)
       response = request(:get, "/users/#{user_id}/payments.json")
       response.collect { |user| user['payment'] }
     end
 
-    # Create a payment for a user
-    #
-    # ==== Params
-    #
-    # * +user_id*+ - ID of the user
-    # * +options+ - Params for creating the User
+    # Public: Create a payment for a user.
     #
-    # ==== Options
+    # user_id - ID of the user
+    # options - Params for creating the User:
+    #           :amount         - Amount of the payment
+    #           :invoice_number - Number of the invoice
     #
-    # * +amount*+ - Amount of the payment
-    # * +invoice_number+ - Number of the invoice
+    # Example
     #
-    # ==== Example
+    #     create amount: 500, invoice_number: "01234"
     #
-    #   create :amount                 => 500,
-    #          :invoice_number         => "01234",
-    def create(user_id, options={})
-      params.required(:amount).accepts(:invoice_number).validate!(options)
+    # Returns a Hash.
+    def create(user_id, options = {})
       request(:post, "/users/#{user_id}/payments.json", default_params(options))
     end
 
-    # Edit a payment
+    # Public: Edit a payment
     #
-    # ==== Params
+    # user_id - ID of the user
+    # id      - ID of the payment
+    # options - Params for editing the payment, see `#create`
     #
-    # * +user_id*+ - ID of the user
-    # * +id*+ - ID of the payment
-    # * +options+ - Params for editing the payment
-    #
-    # ==== Options
-    #
-    # See #create
-    def edit(user_id, id, options={})
-      params.accepts(:amount, :invoice_number).validate!(options)
+    # Returns a Hash.
+    def edit(user_id, id, options = {})
       request(:put, "/users/#{user_id}/payments/#{id}.json", default_params(options))
     end
 
-    # Delete a payment
+    # Public: Delete a payment
     #
-    # ==== Params
+    # user_id - ID of the user
+    # id      - ID of the payment
     #
-    # * +user_id*+ - ID of the user
-    # * +id*+ - ID of the payment
+    # Returns a Hash.
     def delete(user_id, id)
       request(:delete, "/users/#{user_id}/payments/#{id}.json")
     end
-
   end
 end

data/lib/squall/role.rb

@@ -1,73 +1,66 @@
 module Squall
   # OnApp Role
   class Role < Base
-    # Return a list of roles
+    # Public: Lists all roles.
+    #
+    # Returns an Array.
     def list
       response = request(:get, '/roles.json')
       response.collect { |role| role['role']}
     end
 
-    # Returns a Hash of the given roles
+    # Public: Show info for the given role.
     #
-    # ==== Params
+    # id - ID of the role
     #
-    # * +id*+ - ID of the role
+    # Returns a Hash.
     def show(id)
       response = request(:get, "/roles/#{id}.json")
       response["role"]
     end
 
-    # Edit a Role
+    # Public: Create a new Role
+    #
+    # options - Params for creating the roles:
+    #           :label          - Label for the role
+    #           :permission_ids - An array of permission ids granted to the role.
     #
-    # ==== Params
+    # Example
     #
-    # * +id*+ - ID of the role
-    # * +options+ - Params for editing the roles
+    #     create label: 'Admin'
+    def create(options = {})
+      request(:post, '/roles.json', default_params(options))
+    end
+
+    # Public: Edit a Role.
     #
-    # ==== Options
+    # id      - ID of the role
+    # options - Params for editing the roles, see `#create`
     #
-    # See #create
+    # Example
     #
-    # ==== Example
+    #     edit 1, label: 'myrole', permission_ids: [1, 3]
     #
-    #   edit 1, :label => 'myrole', :permission_ids => [1,3]
+    # Returns a Hash.
     def edit(id, options = {})
-      params.accepts(:label, :permission_ids).validate!(options)
-      response = request(:put, "/roles/#{id}.json", default_params(options))
+      request(:put, "/roles/#{id}.json", default_params(options))
     end
 
-    # Delete a Role
+    # Public: Delete a Role.
     #
-    # ==== Params
+    # id - ID of the role
     #
-    # * +id*+ - ID of the role
+    # Returns a Hash.
     def delete(id)
       request(:delete, "/roles/#{id}.json")
     end
 
-    # Returns a list of permissions available
+    # Public: Lists all permissions available.
+    #
+    # Returns an Array.
     def permissions
       response = request(:get, '/permissions.json')
       response.collect { |perm| perm['permission'] }
     end
-
-    # Create a new Role
-    #
-    # ==== Params
-    #
-    # * +options+ - Params for creating the roles
-    #
-    # ==== Options
-    #
-    # * +label*+ - Label for the role
-    # * +permission_ids+ - An array of permission ids granted to the role.
-    #
-    # ==== Example
-    #
-    #   create :label => 'Admin'
-    def create(options = {})
-      params.required(:label).accepts(:permission_ids).validate!(options)
-      response = request(:post, '/roles.json', default_params(options))
-    end
   end
 end

data/lib/squall/statistic.rb

@@ -1,7 +1,9 @@
 module Squall
   # OnApp Statistic
   class Statistic < Base
-    # Returns statitics for virtual machines
+    # Public: Get usage statistics for virtual machines.
+    #
+    # Returns an Array.
     def daily_stats
       response = request(:get, "/usage_statistics.json")
       response.collect {|s| s["vm_stat"]}

data/lib/squall/support/base.rb

@@ -1,49 +1,46 @@
 module Squall
-  # All OnApp API classes subclass Base to get access to
-  # HTTParty methods and other convenience methods
+  # All OnApp API classes subclass Base to get access to HTTP methods and
+  # other convenience methods.
   class Base
-    # Params instance
-    attr_reader :params
-
-    # Returns true/false for successful/unsuccessful requests
+    # Public: Returns true/false for successful/unsuccessful requests
     attr_reader :success
 
-    # HTTPart request result
+    # Public: Faraday response body
     attr_reader :result
 
-    # Returns a Params.new
-    def params
-      @params = Squall::Params.new
-    end
-
-    # Sets the default URL params for requests and merges +options+
+    # Public: Sets the default URL params for requests and merges `options`
     #
-    # ==== Options
+    # *options - One or more options
     #
-    # * +options+
+    # Example
     #
-    # ==== Example
+    #     default_params(something: 1)
     #
-    #   default_params(:something => 1)
+    # Returns a Hash.
     def default_params(*options)
-      options.empty? ? {} : {:query => { key_for_class => options.first}}
+      options.empty? ? {} : { query: { key_for_class => options.first } }
     end
 
-    # Peforms an HTTP Request
+    # Public: Performs an HTTP Request
+    #
+    # request_method - The HTTP verb for the request, one of
+    #                  :get/:post/:delete/:put, etc
+    # path           - URL path
+    # options        - HTTP query params
     #
-    # ==== Options
-    # * +request_method+ - The HTTP verb for the #request. (:get/:post/:delete etc)
-    # * +path+ - URL path
-    # * +options+ - HTTP query params
+    # Example
     #
-    # ==== Example
+    #   # GET /something.json
+    #   request :get, '/something.json'
     #
-    #   request :get, '/something.json' # GET /seomthing.json
-    #   request :put, '/something.json', :something => 1 # PUT /something.json?something=1
+    #   # PUT /something.json?something=1
+    #   request :put, '/something.json', something: 1
+    #
+    # Returns the JSON response.
     def request(request_method, path, options = {})
       check_config
 
-      conn = Faraday.new(:url => Squall.config[:base_uri]) do |c|
+      conn = Faraday.new(url: Squall.config[:base_uri]) do |c|
         c.basic_auth Squall.config[:username], Squall.config[:password]
         c.params = (options[:query] || {})
         c.request :url_encoded
@@ -60,14 +57,21 @@ module Squall
       @result  = response.body
     end
 
-    # Raises an error if a request is made without first calling Squall.config
+    # Public: Ensures `Squall.config` is set.
+    #
+    # Raises Squall::NoConfig if a request is made without first calling
+    # Squall.config.
+    #
+    # Returns nothing.
     def check_config
       raise NoConfig, "Squall.config must be specified" if Squall.config.empty?
     end
 
-    # Sets the default param container for request. It is derived from the
-    # class name. Given the class name *Sandwich* and a param *bread* the
-    # resulting params would be 'bob[bread]=wheat'
+    # Public: Sets the default param container for request. It is derived from
+    # the class name. Given the class name `Sandwich` and a param `bread` the
+    # resulting params would be `bob[bread]=wheat`.
+    #
+    # Returns a String
     def key_for_class
       word = self.class.name.split("::").last.to_s.dup
       word.gsub!(/::/, '/')

data/lib/squall/support/config.rb

@@ -1,28 +1,52 @@
 module Squall
   # Holds the configuration for Squall
   class Config
+    # Public: A Hash that stores configuration info.
     attr_accessor :config
 
     def initialize
       @config = {}
     end
 
+    # Public: Hash accessor, delegates to `@config`.
+    #
+    # Returns the value from `@config`.
     def [](v)
       @config[v]
     end
 
+    # Public: Sets the URL of your OnApp instance.
+    #
+    # value - The String URL
+    #
+    # Returns value.
     def base_uri(value)
-      @config[:base_uri]  = value
+      @config[:base_uri] = value
     end
 
+    # Public: Sets the API username.
+    #
+    # value - The String username
+    #
+    # Returns value.
     def username(value)
       @config[:username] = value
     end
 
+    # Public: Sets the API Password>
+    #
+    # value - The String password
+    #
+    # Returns value.
     def password(value)
       @config[:password] = value
     end
 
+    # Public: Set to true to enable HTTP logging.
+    #
+    # value - A Boolean
+    #
+    # Returns value.
     def debug(value)
       @config[:debug] = value
     end

data/lib/squall/support/version.rb

@@ -1,3 +1,3 @@
 module Squall
-  VERSION = '1.3.0'
+  VERSION = '1.3.1'
 end

data/lib/squall/template.rb

@@ -1,18 +1,20 @@
 module Squall
   # OnApp Template
   class Template < Base
-    # Return a list of available Templates
+    # Public: Lists available templates.
+    #
+    # Returns an Array.
     def list
       response = request(:get, '/templates.json')
       response.collect { |temp| temp['image_template'] }
     end
 
-    # Make a Template public so that it can be downloaded
-    # via a HTTP url
+    # Public: Make a Template public so that it can be downloaded via a HTTP
+    # URL.
     #
-    # ==== Params
+    # id - ID of template
     #
-    # * +id*+ - ID of template
+    # Returns a Hash.
     def make_public(id)
       response = request(:post, "/templates/#{id}/make_public.json")
       response.first[1]

data/lib/squall/transaction.rb

@@ -1,17 +1,19 @@
 module Squall
   # OnApp Transaction
   class Transaction < Base
-    # Returns a list of all Transactions.
+    # Public: Lists all transactions.
+    #
+    # Returns an Array.
     def list
       response = request :get, '/transactions.json'
       response.collect { |t| t['transaction'] }
     end
 
-    # Return a Hash for the given Transaction
+    # Public: Get info for the given transaction.
     #
-    # ==== Params
+    # id - ID of transaction
     #
-    # * +id*+ - ID of transaction
+    # Returns a Hash.
     def show(id)
       response = request :get, "/transactions/#{id}.json"
       response['transaction']