google_apps 0.3.3 → 0.3.4

data/lib/google_apps/atom/user.rb

@@ -8,6 +8,15 @@ module GoogleApps
   			add_header
   		end
 
+      # new_user adds the nodes necessary to create a new
+      # user in Google Apps.  new_user requires a username,
+      # first name, last name and password.  You can also
+      # provide an optional quota argument, this will override
+      # the default quota in Google Apps.
+      #
+      # new_user 'username', 'first_name', 'last_name', 'password', 1024
+      #
+      # new_user returns the full XML document.
   		def new_user(user_name, first, last, password, quota=nil)
         new_doc
         add_header
@@ -18,20 +27,39 @@ module GoogleApps
         @document
   		end
 
+      # new_doc re-initializes the XML document.
       def new_doc
         @document = Atom::XML::Document.new
       end
 
-  		def login_node(user_name, password)
+      # login_node adds an apps:login attribute to @document.
+      #  login_node takes a username and password as arguments
+      # it is also possible to specify that the account be 
+      # suspended.
+      #
+      # login_node 'username', 'password', suspended
+      #
+      # login_node returns an 'apps:login' LibXML::XML::Node
+  		def login_node(user_name, password, suspended="false")
+        suspended = "true" unless suspended == "false"
   			login = Atom::XML::Node.new('apps:login')
   			login['userName'] = user_name
   			login['password'] = OpenSSL::Digest::SHA1.hexdigest password
   			login['hashFunctionName'] = Atom::HASH_FUNCTION
-  			login['suspended'] = "false"
+  			login['suspended'] = suspended
 
   			login
   		end
 
+
+      # quota_node adds an apps:quota attribute to @document.  
+      # quota_node takes an integer value as an argument.  This
+      # argument translates to the number of megabytes available
+      # on the Google side.
+      #
+      # quota_node 1024
+      #
+      # quota_node returns an 'apps:quota' LibXML::XML::Node
   		def quota_node(limit)
   			quota = Atom::XML::Node.new('apps:quota')
   			quota['limit'] = limit.to_s
@@ -39,6 +67,12 @@ module GoogleApps
   			quota
   		end
 
+      # name_node adds an apps:name attribute to @document.  
+      # name_node takes the first and last names as arguments.
+      #
+      # name_node 'first name', 'last name'
+      #
+      # name_node returns an apps:name LibXML::XML::Node
   		def name_node(first, last)
   			name = Atom::XML::Node.new('apps:name')
   			name['familyName'] = last
@@ -47,6 +81,7 @@ module GoogleApps
   			name
   		end
 
+      # to_s returns @document as a string
       def to_s
         @document.to_s
       end

data/lib/google_apps/transport.rb

@@ -109,6 +109,22 @@ module GoogleApps
       end
     end
 
+    # get is a generic target for method_missing.  It is
+    # intended to handle the general case of retrieving a
+    # record from the Google Apps Domain.  It takes an API
+    # endpoint and an id as arguments.
+    #
+    # get 'endpoint', 'username'
+    #
+    # get returns the HTTP response received from Google.
+    def get(endpoint, id)
+      uri = URI(instance_variable_get("@#{endpoint.to_s}") + "/#{id}")
+      @request = Net::HTTP::Get.new(uri.path)
+      set_headers :user
+
+      @response = request(uri)
+    end
+
     # add is a generic target for method_missing.  It is
     # intended to handle the general case of adding
     # to the GoogleApps Domain.  It takes an API endpoint
@@ -181,6 +197,8 @@ module GoogleApps
       	self.send(:add, $2, *args)
       when "delete"
         self.send(:delete, $2, *args)
+      when "get"
+        self.send(:get, $2, *args)
       else
       	super
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google_apps
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-05 00:00:00.000000000 Z
+date: 2012-03-15 00:00:00.000000000 Z
 dependencies: []
 description: Library for interfacing with Google Apps' Domain and Application APIs
 email: