squall 1.3.0 → 1.3.1

data/lib/squall/user.rb

@@ -1,183 +1,184 @@
 module Squall
   # OnApp User
   class User < Base
-    # Return a list of all users
+    # Public: Lists all users.
+    #
+    # Returns an Array.
     def list
       response = request(:get, '/users.json')
       response.collect { |user| user['user'] }
     end
 
-
-    # Create a new User
-    #
-    # ==== Params
-    #
-    # * +options+ - Params for creating the User
-    #
-    # ==== Options
-    #
-    # * +login*+ - Login name
-    # * +email*+ - Email address
-    # * +first_name*+ - First name
-    # * +last_name*+ - Last name
-    # * +password*+ - Password
-    # * +passwor_confirmation*+ - Password
-    # * +role+ - Role to be assigned to user
-    # * +time_zone+ - Time zone for user.  If not provided it will be set automatically.
-    # * +locale+ - Locale for user.  If not provided it will be set automatically.
-    # * +status+ - User's status: +active+, +suspended+, +deleted+
-    # * +billing_plan_id+ - ID of billing plan to be applied to user's account
-    # * +role_ids+ - Array of IDs of roles to be assigned to the user
-    # * +suspend_after_hours+ - Number of hours after which the account will be automatically suspended
-    # * +suspend_at+ - Time after which the account will automatically be suspended, formatted as +YYYYMMDD ThhmmssZ+
-    #
-    # ==== Example
-    #
-    #   create :login                 => 'bob',
-    #          :email                 => 'something@example.com',
-    #          :password              => 'secret',
-    #          :password_confirmation => 'secret'
-    #          :first_name            => 'Bob',
-    #          :last_name             => 'Smith'
+    # Public: Create a new User
+    #
+    # options - Params for creating the User:
+    #           :login                - Login name
+    #           :email                - Email address
+    #           :first_name           - First name
+    #           :last_name            - Last name
+    #           :password             - Password
+    #           :passwor_confirmation - Password
+    #           :role                 - Role to be assigned to user
+    #           :time_zone            - Time zone for user. If not provided it
+    #                                   will be set automatically.
+    #           :locale               - Locale for user. If not provided it will
+    #                                   be set automatically.
+    #           :status               - User's status: `active`, `suspended`,
+    #                                   `deleted`
+    #           :billing_plan_id      - ID of billing plan to be applied to
+    #                                   user's account
+    #           :role_ids             - Array of IDs of roles to be assigned to
+    #                                   the user
+    #           :suspend_after_hours  - Number of hours after which the account
+    #                                   will be automatically suspended
+    #           :suspend_at           - Time after which the account will
+    #                                   automatically be suspended, formatted
+    #                                   as +YYYYMMDD ThhmmssZ+
+    #
+    # Example
+    #
+    #     create login:                 'bob',
+    #            email:                 'something@example.com',
+    #            password:              'secret',
+    #            password_confirmation: 'secret'
+    #            first_name:            'Bob',
+    #            last_name:             'Smith'
+    #
+    # Returns a Hash.
     def create(options = {})
-      params.required(:login, :email,:first_name, :last_name, :password, :password_confirmation).accepts(:role, :time_zone, :locale, :status, :billing_plan_id, :role_ids, :suspend_after_hours, :suspend_at).validate!(options)
       request(:post, '/users.json', default_params(options))
     end
 
-    # Edit a user
-    #
-    # ==== Params
+    # Public: Edit a user
     #
-    # * +id*+ - ID of user
-    # * +options+ - Params for creating the user
+    # id      - ID of user
+    # options - Params for creating the user, see `#create`
     #
-    # ==== Options
-    #
-    # See #create
-    def edit(id, options={})
-      params.accepts(:email, :password, :password_confirmation, :first_name, :last_name, :user_group_id, :billing_plan_id, :role_ids, :suspend_at).validate!(options)
+    # Returns a Hash.
+    def edit(id, options = {})
       request(:put, "/users/#{id}.json", default_params(options))
     end
 
-    # Return a Hash of the given user
+    # Public: Get info for a user.
     #
-    # ==== Params
+    # id - ID of user
     #
-    # * +id*+ - ID of user
+    # Returns a Hash.
     def show(id)
       response = request(:get, "/users/#{id}.json")
       response["user"]
     end
 
-    # Create a new API Key for a user
+    # Public: Create a new API Key for a user.
     #
-    # ==== Params
+    # id - ID of user
     #
-    # * +id*+ - ID of user
+    # Return a Hash.
     def generate_api_key(id)
       response = request(:post, "/users/#{id}/make_new_api_key.json")
       response["user"]
     end
 
-    # Suspend a user
+    # Public: Suspend a user.
     #
-    # ==== Params
+    # id - ID of user
     #
-    # * +id*+ - ID of user
+    # Return a Hash.
     def suspend(id)
       response = request(:get, "/users/#{id}/suspend.json")
       response["user"]
     end
 
-    # Activate a user
+    # Public: Activate a user.
     #
-    # ==== Params
+    # id - ID of user
     #
-    # * +id*+ - ID of user
+    # Return a Hash.
     def activate(id)
       response = request(:get, "/users/#{id}/activate_user.json")
       response["user"]
     end
     alias_method :unsuspend, :activate
 
-    # Delete a user
+    # Public: Delete a user.
     #
-    # ==== Params
+    # id - ID of user
     #
-    # * +id*+ - ID of user
+    # Note: this does not delete remove a user from the database.  First,
+    # their status will be set to "Deleted."  If you call this method again,
+    # the user will be completely removed.
     #
-    # Note: this does not delete remove a user from the database.  First, their status will be set to "Deleted."  If you call this method again, the user will be completely removed.
+    # Return a Hash.
     def delete(id)
       request(:delete, "/users/#{id}.json")
     end
 
-    # Get the stats for each of a User's VirtualMachines
+    # Public: Get the stats for each of a User's VirtualMachines
     #
-    # ==== Params
+    # id - ID of user
     #
-    # * +id*+ - ID of user
+    # Return a Hash.
     def stats(id)
       request(:get, "/users/#{id}/vm_stats.json")
     end
 
-    # Get a list of bills for the User
+    # Public: List a User's bills.
     #
-    # ==== Params
+    # id - ID of user
     #
-    # * +id*+ - ID of user
+    # Return a Hash.
     def monthly_bills(id)
-      response = request(:get, "/users/#{id}/monthly_bills.json")
+      request(:get, "/users/#{id}/monthly_bills.json")
     end
 
-    # Return a list of VirtualMachines for a User
+    # Public: List User's VirtualMachines.
     #
-    # ==== Params
+    # id - ID of user
     #
-    # * +id*+ - ID of user
+    # Return a Hash.
     def virtual_machines(id)
       response = request(:get, "/users/#{id}/virtual_machines.json")
       response.collect { |vm| vm['virtual_machine']}
     end
 
-    # Return a list of Hypervisors for a User's VirtualMachines
+    # Public: List Hypervisors for a User's VirtualMachines.
     #
-    # ==== Params
+    # id - ID of user
     #
-    # * +id*+ - ID of user
+    # Return a Hash.
     def hypervisors(id)
       response = request(:get, "/users/#{id}/hypervisors.json")
       response.collect { |vm| vm['hypervisor']}
     end
 
-    # Return a list of data store zones associated with user
+    # Public: List data store zones associated with user.
     #
-    # ==== Params
+    # id - ID of user
     #
-    # * +id*+ - ID of user
+    # Return a Hash.
     def data_store_zones(id)
       response = request(:get, "/users/#{id}/data_store_zones.json")
       response.collect { |vm| vm['data-store-group']}
     end
 
-    # Return a list of network zones associated with user
+    # Public: List network zones associated with user.
     #
-    # ==== Params
+    # id - ID of user
     #
-    # * +id*+ - ID of user
+    # Return a Hash.
     def network_zones(id)
       response = request(:get, "/users/#{id}/network_zones.json")
       response.collect { |vm| vm['network_group']}
     end
 
-    # Return a description of resources available to a user for creating a virtual machine
+    # Public: Show resources available to a user for creating a virtual machine.
     #
-    # ==== Params
+    # id - ID of user
     #
-    # * +id*+ - ID of user
+    # Returns a Hash.
     def limits(id)
       response = request(:get, "/users/#{id}/limits.json")
       response["limits"]
     end
-
   end
 end

data/lib/squall/user_group.rb

@@ -1,56 +1,43 @@
 module Squall
   # OnApp UserGroup
   class UserGroup < Base
-
-    # Return a list of all user groups
+    # Public: List all user groups.
+    #
+    # Returns an Array.
     def list
       response = request(:get, "/user_groups.json")
       response.collect { |user_group| user_group['user_group'] }
     end
 
-    # Create a user group
-    #
-    # ==== Params
-    #
-    # * +options+ - Params for creating the user groups
-    #
-    # ==== Options
+    # Public: Create a user group.
     #
-    # * +label*+ - Label for the user group
+    # options - Params for creating the user groups:
+    #           :label - Label for the user group
     #
-    # ==== Example
+    # Example
     #
-    #   create :label => "My new user group"
-    def create(options={})
-      params.required(:label).validate!(options)
+    #     create label: "My new user group"
+    def create(options = {})
       request(:post, "/user_groups.json", default_params(options))
     end
 
-    # Edit a user group
+    # Public: Edit a user group.
     #
-    # ==== Params
+    # id      - ID of the user group
+    # options - Params for editing the user group, see `#create`
     #
-    # * +id*+ - ID of the user group
-    # * +options+ - Params for creating the user groups
-    #
-    # ==== Options
-    #
-    # See #create
-    #
-    # * +options+ - Params for editing the user group.
-    def edit(id, options={})
-      params.accepts(:label).validate!(options)
+    # Returns a Hash.
+    def edit(id, options = {})
       request(:put, "/user_groups/#{id}.json", default_params(options))
     end
 
-    # Delete a user group
+    # Public: Delete a user group.
     #
-    # ==== Params
+    # id - ID of the user group
     #
-    # * +id*+ - ID of the user group
+    # Returns a Hash.
     def delete(id)
       request(:delete, "/user_groups/#{id}.json")
     end
-
   end
 end