kynetx_am_api 0.1.10 → 0.1.11

data/LICENSE

@@ -1,18 +1,21 @@
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+The MIT License
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+Copyright (c) 2010 Kynetx Inc.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/kynetx_am_api/user.rb

@@ -1,17 +1,40 @@
 module KynetxAmApi
+  #
+  # Simple wrapper to allow access to the OAuth user information.   This also hold some basic user data like
+  # username, name and user id.
+  #
   class User
+    # OAuth Request Token
     attr_accessor :request_token
+    # OAuth Secret Token
     attr_accessor :request_secret
+    # OAuth Verifieer
     attr_accessor :oauth_verifier
+    # OAuth Access Token
     attr_accessor :access_token
+    # OAuth Acces sSecret
     attr_accessor :access_secret
+    # Kynetx User name
     attr_accessor :username
+    # Kynetx User ID
     attr_accessor :userid
+    # Full name of user
     attr_accessor :name
+    # Current Application context.
     attr_reader :current_application
 
-    # attr :api
-    # attr :applications
+
+    #
+    # Accepts a hash that has the following entries.
+    # - :request_token
+    # - :request_secret
+    # - :oauth_verifier
+    # - :access_token
+    # - :access_secret
+    # - :username
+    # - :userid
+    # - :name
+    #
 
     def initialize(attributes)
       @request_token = attributes[:request_token]
@@ -25,7 +48,9 @@ module KynetxAmApi
       @current_applicaion = nil
     end
 
-
+    #
+    # Returns the direct api to the Kynetx Application Manager.
+    #
     def api
       @api ||= KynetxAmApi::DirectApi.new({:access_token => @access_token, :access_secret => @access_secret})
       return @api
@@ -34,12 +59,12 @@ module KynetxAmApi
     #
     # Read applications list 
     #
-    # :offset => Start in list (not implemented)
-    # :size => Number of application to list (not implemented)
+    # - :offset => Start in list (not implemented)
+    # - :size => Number of application to list (not implemented)
     #
     # Returns a has with two keys
-    # "apps" => Array Off Hashes with :appid , :role, :name, :created
-    # "valid" => true
+    # - "apps" => Array Off Hashes with :appid , :role, :name, :created
+    # - "valid" => true
     #
     def applications(options = {})
       @applications = api.get_applist if !@applications
@@ -47,8 +72,8 @@ module KynetxAmApi
     end
 
     #
-    # :application_id => application_id
-    # :version => Version of application to obtain
+    # - :application_id => application_id
+    # - :version => Version of application to obtain
     #
     def find_application(options = {})
       options[:version] ||= "development"
@@ -75,7 +100,7 @@ module KynetxAmApi
     
     def duplicate_application(application_id)
       old_app = KynetxAmApi::Application.new(self, application_id)
-      new_app = create_application(old_app.name, "")
+      new_app = create_application(old_app.name || "", "")
       new_app.krl = old_app.krl
       return new_app
     end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 10
-  version: 0.1.10
+  - 11
+  version: 0.1.11
 platform: ruby
 authors: 
 - Michael Farmer, Cid Dennis