google_apps 0.4.5 → 0.4.6

data/lib/google_apps/atom/atom.rb

@@ -2,9 +2,30 @@ require 'libxml'
 require 'openssl'
 require 'base64'
 
+class String
+  def camel_up
+    self.split('_').map(&:capitalize).join('')
+  end
+end
+
 module GoogleApps
   module Atom
     include LibXML
+
     HASH_FUNCTION = "SHA-1"
+    DOCUMENTS = %w(user export group group_member message_attributes public_key)
+
+    NAMESPACES = {
+      atom: 'http://www.w3.org/2005/Atom',
+      apps: 'http://schemas.google.com/apps/2006',
+      gd: 'http://schemas.google.com/g/2005'
+    }
+
+    # The idea is to make document distribution more dynamic.
+    # Might be pointless but it's here for now.
+    DOCUMENTS.each do |doc|
+      eval "def #{doc}\n  #{doc.camel_up}.new\nend"
+      module_function doc.to_sym
+    end
   end
 end

data/lib/google_apps/atom/group_member.rb

@@ -1,6 +1,7 @@
 module GoogleApps
   module Atom
     class GroupMember
+      include GoogleApps::Atom::Node
       attr_accessor :member
 
       def initialize
@@ -37,28 +38,12 @@ module GoogleApps
       #
       # set_member returns the value of @member
       def set_member(member)
-        @document.root << build_node(member)
+        @document.root << create_node(type: 'apps:property', attrs: [['name', 'memberId'], ['value', member]])
 
         @member = member
       end
 
 
-      # build_node creates an apps:property element
-      # for memberId with the provided argument as
-      # the value.
-      #
-      # build_node 'test_user@cnm.edu'
-      #
-      # build_node returns an apps:property XML Node.
-      def build_node(member)
-        node = Atom::XML::Node.new('apps:property')
-        node.attributes['name'] = 'memberId'
-        node.attributes['value'] = member
-
-        node
-      end
-
-
       # change_member changes the value attribute of the
       # apps:property element in @document to the value
       # of the provided argument.  It also sets @member
@@ -77,6 +62,12 @@ module GoogleApps
         @member = member
       end
 
+      # parse_doc parses the current @document so that it can
+      # be searched with find.
+      def parse_doc(document = @document)
+        Atom::XML::Parser.document(document).parse
+      end
+
 
       # add_header sets the root element of @document
       def add_header

data/lib/google_apps/atom/nickname.rb

@@ -0,0 +1,148 @@
+module GoogleApps
+  module Atom
+    class Nickname
+      include GoogleApps::Atom::Node
+      attr_reader :nickname, :user, :document
+
+      ELEMENTS = { nick: ['apps:nickname', 'name'], user: ['apps:login', 'userName'] }
+
+      def initialize
+        @document = Atom::XML::Document.new
+        @document.root = header
+        @document.root << category
+      end
+
+      # nickname= sets the nickname value on the object and in the
+      # underlying XML document.  It takes a string as an argument.
+      #
+      # nickname = 'Timmy'
+      #
+      # nickname= returns the new nickname value
+      def nickname=(nick)
+        @nickname.nil? ? set_nickname(nick) : change_nickname(nick)
+      end
+
+
+      # user= sets the username value on the object and in the
+      # underlying XML document.  It takes a string (default/current username)
+      # as an argument.
+      #
+      # user = 'tom'
+      #
+      # user= returns the new username value
+      def user=(username)
+        @user.nil? ? set_user(username) : change_user(username)
+      end
+
+
+      # to_s returns the underlying XML document as a string.
+      def to_s
+        @document.to_s
+      end
+
+
+
+      private
+
+
+      # header returns an atom:entry node with the appropriate
+      # namespaces for a GoogleApps nickname document
+      def header
+        node = Atom::XML::Node.new('atom:entry')
+
+        Atom::XML::Namespace.new(node, 'atom', 'http://www.w3.org/2005/Atom')
+        Atom::XML::Namespace.new(node, 'apps', 'http://schemas.google.com/apps/2006')
+
+        node
+      end
+
+
+      # category constructs an atom:category node with the
+      # appropriate attributes for a GoogleApps nickname
+      # document.
+      def category
+        node = Atom::XML::Node.new('atom:category')
+        node.attributes['scheme'] = 'http://schemas.google.com/g/2005#kind'
+        node.attributes['term'] = 'http://schemas.google.com/apps/2006#nickname'
+
+        node
+      end
+
+
+      # set_nickname adds an apps:nickname node to the
+      # underlying XML document and sets @nickname.
+      # It takes a nickname in string form for its
+      # argument.
+      #
+      # set_nickname 'Timmy'
+      #
+      # set_nickname returns the new nickname value.
+      def set_nickname(nick)
+        @document.root << create_node(type: 'apps:nickname', attrs: [['name', nick]])
+
+        @nickname = nick
+      end
+
+
+      # set_user adds an apps:login node to the underlying
+      # XML document and sets @user.  It takes a username
+      # (current/default username) in string form for its
+      # argument.
+      #
+      # set_user 'bob'
+      #
+      # set_user returns the new user value.
+      def set_user(username)
+        @document.root << create_node(type: 'apps:login', attrs: [['userName', username]])
+
+        @user = username
+      end
+
+
+      # change_nickname changes the name attribute for the
+      # apps:nickname node in the underlying XML document.
+      # It takes a nickname in string form.
+      #
+      # change_nickname 'Timmy'
+      #
+      # change_nickname returns the new nickname.
+      def change_nickname(nick)
+        @document.root.each do |node|
+          node.attributes['name'] = nick if node.attributes['name'] == @nickname
+        end
+
+        @nickname = nick
+      end
+
+
+      # change_user changes the userName attribute for the
+      # apps:login node in the underlying XML document. It
+      # takes a username (Email format) in string form.
+      #
+      # change_user 'bob@work.com'
+      #
+      # change_user returns the new user value.
+      def change_user(username)
+        @document.root.each do |node|
+          node.attributes['userName'] = username if node.attributes['userName'] == @user
+        end
+
+        @user = username
+      end
+
+      # :nodoc:
+      def change_element(type, value)
+        @document.root.each do |node|
+          node.attributes[ELEMENTS[type][1]] = value
+        end
+      end
+
+
+      # parse_document takes an XML document and returns
+      # a parsed copy of that document.
+      def parse_document(document = @document)
+        Atom::XML::Parser.document(document).parse
+      end
+    end
+  end
+end

data/lib/google_apps/atom/node.rb

@@ -0,0 +1,59 @@
+module GoogleApps
+  module Atom
+    module Node
+
+      # create_node takes a hash of properties from which to
+      # build the XML node.  The properties hash must have
+      # a :type key, it is also possible to pass an :attrs
+      # key with an array of attribute name, value pairs.
+      #
+      # create_node type: 'apps:property', attrs: [['name', 'Tim'], ['userName', 'tim@bob.com']]
+      #
+      # create_node returns an Atom::XML::Node with the specified
+      # properties.
+      def create_node(properties)
+        if properties[:attrs]
+          add_attributes Atom::XML::Node.new(properties[:type]), properties[:attrs]
+        else
+          Atom::XML::Node.new properties[:type]
+        end
+      end
+
+
+      # add_attributes adds the specified attributes to the
+      # given node.  It takes a LibXML::XML::Node and an
+      # array of name, value attribute pairs.
+      #
+      # add_attribute node, [['title', 'emperor'], ['name', 'Napoleon']]
+      #
+      # add_attribute returns the modified node.
+      def add_attributes(node, attributes)
+        attributes.each do |attribute|
+          node.attributes[attribute[0]] = attribute[1]
+        end
+
+        node
+      end
+
+
+      # update_node updates the values for the specified
+      # attributes on the node specified by the given xpath
+      # value.  It is ill behaved and will change any
+      # matching attributes in any node returned using the
+      # given xpath.
+      #
+      # update_node takes a document (must be parsed), an
+      # xpath value and a hash of attribute names with
+      # current and new value pairs.
+      #
+      # update_node document, '/apps:nickname', name: ['Bob', 'Tom']
+      def find_and_update(document, xpath, attributes)
+        document.find(xpath).each do |node|
+          attributes.each_key do |attrib|
+            node.attributes[attrib.to_s] = attributes[attrib][1] if node.attributes[attrib.to_s] == attributes[attrib][0]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google_apps/transport.rb

@@ -6,7 +6,7 @@ require 'rexml/document'
 module GoogleApps
 	class Transport
 		attr_reader :request, :response, :domain
-		attr_accessor :auth, :user, :group, :nickname
+		attr_accessor :auth, :user, :group, :nickname, :export
 
     BOUNDARY = "=AaB03xDFHT8xgg"
 
@@ -16,7 +16,7 @@ module GoogleApps
       @pubkey = targets[:pubkey] || "https://apps-apis.google.com/a/feeds/compliance/audit/publickey/#{domain}"
       @migration = targets[:migration] || "https://apps-apis.google.com/a/feeds/migration/2.0/#{domain}"
 			@group = targets[:group] || "https://apps-apis.google.com/a/feeds/group/2.0/#{domain}"
-			@nickname = targets[:nickname]
+			@nickname = targets[:nickname] || "https://apps-apis.google.com/a/feeds/#{domain}/nickname/2.0"
       @export = targets[:export] || "https://apps-apis.google.com/a/feeds/compliance/audit/mail/export/#{domain}"
       @domain = domain
 			@token = nil
@@ -39,7 +39,7 @@ module GoogleApps
 			@request.body = auth_body(account, pass)
 			set_headers :auth
 
-			@response = request(uri)
+			@response = request uri
 
 			set_auth_token
 
@@ -56,12 +56,7 @@ module GoogleApps
     # request_export returns the HTTP response received
     # from Google.
     def request_export(username, document)
-      uri = URI(@export + "/#{username}")
-      @request = Net::HTTP::Post.new uri.path
-      @request.body = document.to_s
-      set_headers :user
-
-      @response = request(uri)
+      add(@export + "/#{username}", document)
     end
 
     # export_status checks the status of a mailbox export
@@ -70,15 +65,10 @@ module GoogleApps
     #
     # export_status 'username', 847576
     #
-    # export_status will return the body of the HTTP
+    # export_status will return the status of the HTTP
     # response from Google
     def export_status(username, req_id)
-      uri = URI(@export + "/#{username}/#{req_id}")
-      @request = Net::HTTP::Get.new uri.path
-      set_headers :user
-
-      # TODO: Return actual status not whole body.
-      (@response = request(uri)).body
+      get(@export + "/#{username}", req_id)
     end
 
     def fetch_export(username, req_id, filename) # :nodoc:
@@ -124,7 +114,7 @@ module GoogleApps
       @request = Net::HTTP::Get.new(uri.path)
       set_headers :user
 
-      @response = request(uri)
+      @response = request uri
     end
 
 
@@ -165,7 +155,7 @@ module GoogleApps
 			@request.body = document.to_s
 			set_headers :user
 
-			@response = request(uri)
+			@response = request uri
 		end
 
     # update is a generic target for method_missing.  It is
@@ -184,7 +174,7 @@ module GoogleApps
       @request.body = document.to_s
       set_headers :user
 
-      @response = request(uri)
+      @response = request uri
     end
 
     # delete is a generic target for method_missing.  It is
@@ -200,7 +190,7 @@ module GoogleApps
       @request = Net::HTTP::Delete.new(uri.path)
       set_headers :user
 
-      @response = request(uri)
+      @response = request uri
     end
 
     # migration performs mail migration from a local
@@ -217,7 +207,7 @@ module GoogleApps
       @request.body = multi_part(properties.to_s, message)
       set_headers :migrate
 
-      @response = request(uri)
+      @response = request uri
     end
 
 

data/lib/google_apps.rb

@@ -1,9 +1,11 @@
 require 'google_apps/transport'
 require 'google_apps/atom/atom'
+require 'google_apps/atom/node'
 require 'google_apps/atom/user'
 require 'google_apps/atom/group'
 require 'google_apps/atom/public_key'
 require 'google_apps/atom/export'
 require 'google_apps/atom/message'
 require 'google_apps/atom/message_attributes'
-require 'google_apps/atom/group_member'
+require 'google_apps/atom/group_member'
+require 'google_apps/atom/nickname'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google_apps
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-11 00:00:00.000000000 Z
+date: 2012-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
-  requirement: &70341104167920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,33 +21,30 @@ dependencies:
         version: 2.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *70341104167920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
 description: Library for interfacing with Google Apps' Domain and Application APIs
 email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- !binary |-
-  bGliL2dvb2dsZV9hcHBzL2F0b20vYXRvbS5yYg==
-- !binary |-
-  bGliL2dvb2dsZV9hcHBzL2F0b20vZXhwb3J0LnJi
-- !binary |-
-  bGliL2dvb2dsZV9hcHBzL2F0b20vZ3JvdXAucmI=
-- !binary |-
-  bGliL2dvb2dsZV9hcHBzL2F0b20vZ3JvdXBfbWVtYmVyLnJi
-- !binary |-
-  bGliL2dvb2dsZV9hcHBzL2F0b20vbWVzc2FnZS5yYg==
-- !binary |-
-  bGliL2dvb2dsZV9hcHBzL2F0b20vbWVzc2FnZV9hdHRyaWJ1dGVzLnJi
-- !binary |-
-  bGliL2dvb2dsZV9hcHBzL2F0b20vcHVibGljX2tleS5yYg==
-- !binary |-
-  bGliL2dvb2dsZV9hcHBzL2F0b20vdXNlci5yYg==
-- !binary |-
-  bGliL2dvb2dsZV9hcHBzL3RyYW5zcG9ydC5yYg==
-- !binary |-
-  bGliL2dvb2dsZV9hcHBzLnJi
+- lib/google_apps/atom/atom.rb
+- lib/google_apps/atom/export.rb
+- lib/google_apps/atom/group.rb
+- lib/google_apps/atom/group_member.rb
+- lib/google_apps/atom/message.rb
+- lib/google_apps/atom/message_attributes.rb
+- lib/google_apps/atom/nickname.rb
+- lib/google_apps/atom/node.rb
+- lib/google_apps/atom/public_key.rb
+- lib/google_apps/atom/user.rb
+- lib/google_apps/transport.rb
+- lib/google_apps.rb
 homepage: https://github.com/LeakyBucket/google_apps
 licenses: []
 post_install_message: 
@@ -68,8 +65,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Google Apps APIs
 test_files: []
+has_rdoc: