google_apps 0.4.8.1 → 0.4.9

data/lib/google_apps/atom/atom.rb

@@ -38,8 +38,8 @@ module GoogleApps
 
     CATEGORY = {
       user: [['scheme', 'http://schemas.google.com/g/2005#kind'], ['term', 'http://schemas.google.com/apps/2006#user']],
-      nickname: [['scheme', 'http://schemas.google.com/g/2005#kind'], ['term', 'http://schemas.google.com/apps/2006#nickname']],
-      group: [['scheme', 'http://schemas.google.com/g/2005#kind'], ['term', 'http://schemas.google.com/apps/2006#group']]
+      nickname: [['scheme', 'http://schemas.google.com/g/2005#kind'], ['term', 'http://schemas.google.com/apps/2006#nickname']]
+      #group: [['scheme', 'http://schemas.google.com/g/2005#kind'], ['term', 'http://schemas.google.com/apps/2006#group']]
     }
 
     ENTRY_TAG = ["<atom:entry xmlns:atom=\"#{NAMESPACES[:atom]}\" xmlns:apps=\"#{NAMESPACES[:apps]}\" xmlns:gd=\"#{NAMESPACES[:gd]}\">", '</atom:entry>']

data/lib/google_apps/atom/document.rb

@@ -36,6 +36,84 @@ module GoogleApps
       def new_empty_doc
         Atom::XML::Document.new
       end
+
+
+      # find_values searches @document and assigns any values
+      # to their corresponding instance variables.  This is
+      # useful when we've been given a string of XML and need
+      # internal consistency in the object.
+      #
+      # find_values
+      def find_values # Moved from User and Group, causing segfault but only at odd times
+        map_key = self.class.to_s.split(':').last.downcase.to_sym
+        map = Atom::MAPS[map_key]
+
+        @document.root.each do |entry|
+          unless entry.name.match 'gd' or entry.name.match 'atom' or entry.name.match 'openSearch'
+            entry.attributes.each do |attribute|
+              instance_variable_set "@#{map[attribute.name.to_sym]}", check_value(attribute.value)
+            end
+          end
+        end
+      end
+
+
+      # build_root creates the shared root structure for the
+      # document.
+      #
+      # build_root
+      #
+      # build_root returns an atom:entry node with an
+      # apps:category element appropriate for the document
+      # type.
+      def build_root
+        root = create_node(type: 'atom:entry')
+
+        add_namespaces root, determine_namespaces
+        root << create_node(type: 'apps:category', attrs: Atom::CATEGORY[type_to_sym]) if Atom::CATEGORY[type_to_sym]
+
+        root
+      end
+
+
+      # type_to_s returns the current document's type as a
+      # string.
+      #
+      # type_to_s
+      #
+      # type_to_s returns a string
+      def type_to_s
+        self.class.to_s.split(':').last.downcase
+      end
+
+
+      # type_to_sym returns the current document's type as a
+      # symbol.
+      #
+      # type_to_sym
+      #
+      # type_to_sym returns a symbol
+      def type_to_sym
+        type_to_s.to_sym
+      end
+
+
+      # determine_namespaces builds a hash of namespace key/value
+      # pairs.
+      #
+      # determine_namespaces
+      #
+      # determine_namespaces returns a hash
+      def determine_namespaces
+        ns = { atom: Atom::NAMESPACES[:atom], apps: Atom::NAMESPACES[:apps] }
+
+        case type_to_s
+          when 'group', 'groupmember'
+            ns[:gd] = Atom::NAMESPACES[:gd]
+        end
+
+        ns          
+      end
     end
   end
 end

data/lib/google_apps/atom/export.rb

@@ -1,12 +1,15 @@
 module GoogleApps
   module Atom
     class Export
+      include Atom::Node
+      include Atom::Document
+
       HEADER = 'HEADER_ONLY'
       FULL = 'FULL_MESSAGE'
 
       def initialize
         @document = Atom::XML::Document.new
-        set_header
+        @document.root = build_root
       end
 
       # to_s returns @document as a string.

data/lib/google_apps/atom/group.rb

@@ -11,7 +11,7 @@ module GoogleApps
           @document = parse(xml)
         else
           @document = Atom::XML::Document.new
-          add_header
+          @document.root = build_root
         end
       end
 
@@ -56,29 +56,6 @@ module GoogleApps
 
       private
 
-      # add_header sets the required boilerplate for a
-      # Google Apps group.
-      def add_header
-        @document.root = Atom::XML::Node.new('atom:entry')
-
-        Atom::XML::Namespace.new(@document.root, 'atom', 'http://www.w3.org/2005/Atom')
-        Atom::XML::Namespace.new(@document.root, 'apps', 'http://schemas.google.com/apps/2006')
-        Atom::XML::Namespace.new(@document.root, 'gd', 'http://schemas.google.com/g/2005')
-      end
-
-
-      def find_values
-        map = Atom::MAPS[:user]
-
-        @document.root.each do |entry|
-          unless entry.name.match 'gd' or entry.name.match 'atom'
-            entry.attributes.each do |attribute|
-              instance_variable_set "@#{map[attribute.name.to_sym]}", check_value(attribute.value)
-            end
-          end
-        end
-      end
-
 
       def check_value(value)
         case value

data/lib/google_apps/atom/group_member.rb

@@ -8,7 +8,7 @@ module GoogleApps
 
       def initialize
         @document = Atom::XML::Document.new
-        add_header
+        @document.root = build_root
       end
 
 
@@ -69,16 +69,6 @@ module GoogleApps
       def parse_doc(document = @document)
         Atom::XML::Parser.document(document).parse
       end
-
-
-      # add_header sets the root element of @document
-      def add_header
-        @document.root = Atom::XML::Node.new('atom:entry')
-
-        Atom::XML::Namespace.new(@document.root, 'atom', 'http://www.w3.org/2005/Atom')
-        Atom::XML::Namespace.new(@document.root, 'apps', 'http://schemas.google.com/apps/2006')
-        Atom::XML::Namespace.new(@document.root, 'gd', 'http://schemas.google.com/g/2005')
-      end
     end
   end
 end

data/lib/google_apps/atom/nickname.rb

@@ -10,8 +10,7 @@ module GoogleApps
 
       def initialize
         @document = Atom::XML::Document.new
-        @document.root = header
-        @document.root << category
+        @document.root = build_root
       end
 
       # nickname= sets the nickname value on the object and in the
@@ -21,7 +20,9 @@ module GoogleApps
       #
       # nickname= returns the new nickname value
       def nickname=(nick)
-        @nickname.nil? ? set_nickname(nick) : change_nickname(nick)
+        @nickname ? find_and_update(@document, '//apps:nickname', name: [@nickname, nick]) : create('nickname', nick)
+
+        @nickname = nick
       end
 
 
@@ -33,7 +34,9 @@ module GoogleApps
       #
       # user= returns the new username value
       def user=(username)
-        @user.nil? ? set_user(username) : change_user(username)
+        @user ? find_and_update(@document, '//apps:login', userName: [@user, username]) : create('login', username)
+
+        @user = username
       end
 
 
@@ -47,94 +50,21 @@ module GoogleApps
       private
 
 
-      # header returns an atom:entry node with the appropriate
-      # namespaces for a GoogleApps nickname document
-      def header
-        add_namespaces create_node(type: 'atom:entry'), atom: 'http://www.w3.org/2005/Atom', apps: 'http://schemas.google.com/apps/2006'
-      end
-
-
-      # category constructs an atom:category node with the
-      # appropriate attributes for a GoogleApps nickname
-      # document.
-      def category
-        create_node type: 'atom:category', attrs: Atom::CATEGORY[:nickname]
-      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.
+      # create adds the specified node to @document.  It takes
+      # a type and a value as arguments.
       #
-      # set_nickname 'Timmy'
+      # create 'nickname', 'Bob'
       #
-      # 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
+      # create returns a parsed copy of the document.
+      def create(type, value)
+        case type
+        when 'nickname'
+          @document.root << create_node(type: 'apps:nickname', attrs: [['name', value]])
+        when 'login'
+          @document.root << create_node(type: 'apps:login', attrs: [['userName', value]])
         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
+        @document = parse @document
       end
     end
   end

data/lib/google_apps/atom/public_key.rb

@@ -1,9 +1,14 @@
 module GoogleApps
   module Atom
     class PublicKey
+      include Atom::Node
+      include Atom::Document
+
+      attr_reader :document
+
       def initialize
         @document = Atom::XML::Document.new
-        add_header
+        @document.root = build_root
       end
       
       # new_key adds the actual key to the PublicKey
@@ -24,15 +29,6 @@ module GoogleApps
       def to_s
         @document.to_s
       end
-
-      private
-
-      def add_header
-        @document.root = Atom::XML::Node.new('atom:entry')
-
-        Atom::XML::Namespace.new(@document.root, 'atom', 'http://www.w3.org/2005/Atom')
-        Atom::XML::Namespace.new(@document.root, 'apps', 'http://schemas.google.com/apps/2006')
-      end
     end
   end
 end

data/lib/google_apps/atom/user.rb

@@ -14,7 +14,7 @@ module GoogleApps
           find_values
         else
           @document = new_empty_doc
-  			  add_header
+  			  @document.root = build_root
         end
   		end
 
@@ -166,22 +166,6 @@ module GoogleApps
       end
 
 
-      # TODO: This needs to target the proper nodes.
-      # TODO: This needs to treat 'true' and 'false' properly
-      def find_values
-        map = Atom::MAPS[:user]
-
-        @document.root.each do |entry|
-          # Something in the feedLink entries causes a segfault.
-          unless entry.name.match 'gd' or entry.name.match 'atom'
-            entry.attributes.each do |attribute|
-              instance_variable_set "@#{map[attribute.name.to_sym]}", check_value(attribute.value)
-            end
-          end
-        end
-      end
-
-
       def check_value(value)
         case value
           when 'true'
@@ -192,20 +176,6 @@ module GoogleApps
             value
         end
       end
-
-
-      def add_header
-        @document.root = Atom::XML::Node.new('atom:entry')
-
-        Atom::XML::Namespace.new(@document.root, 'atom', 'http://www.w3.org/2005/Atom')
-        Atom::XML::Namespace.new(@document.root, 'apps', 'http://schemas.google.com/apps/2006')
-
-        category = Atom::XML::Node.new('atom:category')
-        category.attributes['scheme'] = 'http://schemas.google.com/g/2005#kind'
-        category.attributes['term'] = 'http://schemas.google.com/apps/2006#user'
-
-        @document.root << category
-      end
   	end
   end
 end

data/lib/google_apps/transport.rb

@@ -4,9 +4,9 @@ require 'openssl'
 require 'rexml/document'
 
 module GoogleApps
-	class Transport
-		attr_reader :request, :response, :domain, :feeds
-		attr_accessor :auth, :user, :group, :nickname, :export
+  class Transport
+    attr_reader :request, :response, :domain, :feeds
+    attr_accessor :auth, :user, :group, :nickname, :export
 
     BOUNDARY = "=AaB03xDFHT8xgg"
     PAGE_SIZE = {
@@ -14,20 +14,20 @@ module GoogleApps
       group: 200
     }
 
-		def initialize(domain, targets = {})
-			@auth = targets[:auth] || "https://www.google.com/accounts/ClientLogin"
-			@user = targets[:user] || "https://apps-apis.google.com/a/feeds/#{domain}/user/2.0"
+    def initialize(domain, targets = {})
+      @auth = targets[:auth] || "https://www.google.com/accounts/ClientLogin"
+      @user = targets[:user] || "https://apps-apis.google.com/a/feeds/#{domain}/user/2.0"
       @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] || "https://apps-apis.google.com/a/feeds/#{domain}/nickname/2.0"
+      @group = targets[:group] || "https://apps-apis.google.com/a/feeds/group/2.0/#{domain}"
+      @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
-			@response = nil
-			@request = nil
+      @token = nil
+      @response = nil
+      @request = nil
       @feeds = []
-		end
+    end
 
 
     # authenticate will take the provided account and
@@ -38,18 +38,18 @@ module GoogleApps
     #
     # authenticate returns the HTTP response received
     # from Google
-		def authenticate(account, pass)
-			uri = URI(@auth)
-			@request = Net::HTTP::Post.new(uri.path)
-			@request.body = auth_body(account, pass)
-			set_headers :auth
+    def authenticate(account, pass)
+      uri = URI(@auth)
+      @request = Net::HTTP::Post.new(uri.path)
+      @request.body = auth_body(account, pass)
+      set_headers :auth
 
-			@response = request uri
+      @response = request uri
 
-			set_auth_token
+      set_auth_token
 
       @response
-		end
+    end
 
     # request_export performs the GoogleApps API call to
     # generate a mailbox export.  It takes the username
@@ -131,17 +131,41 @@ module GoogleApps
     #
     # get_users returns the final response from google.
     def get_users(options = {})
-      @feeds, pages = [], 0
+      get_all :users, options
+    end
+
+
+    # get_groups retrieves all the groups from the domain
+    #
+    # get_groups
+    #
+    # get_groups returns the final response from Google.
+    def get_groups(options = {})
+      get_all :groups, options
+    end
+
+
+    # get_all retrieves a batch of records of the specified type
+    # from google.  You must specify the type of object you want
+    # to retreive.  You can also specify a start point and a limit.
+    #
+    # get_all 'users', start: 'lholcomb2', limit: 300
+    #
+    # get_all returns the HTTP response received from Google.
+    def get_all(type, options = {})
+      @feeds, current_page = [], 0
+      type = type.to_s
+      type.gsub!(/\w*s$/) { |match| match[0..-2] }
 
       options[:limit] ? limit = options[:limit] : limit = 1000000
-      options[:start] ? get(@user + "?startUsername=#{options[:start]}") : get(@user)
+      options[:start] ? get(instance_variable_get("@#{type}") + "?#{start_query(type)}=#{options[:start]}") : get(instance_variable_get("@#{type}"))
 
       add_feed
-      pages += 1
+      current_page += 1
 
-      while (@feeds.last.next_page) and (pages * PAGE_SIZE[:user] < limit)
+      while (@feeds.last.next_page) and (current_page * PAGE_SIZE[:user] < limit)
         get_next_page
-        pages += 1
+        current_page += 1
       end
 
       @response
@@ -171,6 +195,17 @@ module GoogleApps
     end
 
 
+    # get_nicknames_for retrieves all the nicknames associated
+    # with the requested user.  It takes the username as a string.
+    #
+    # get_nickname_for 'lholcomb2'
+    #
+    # get_nickname_for returns the HTTP response from Google
+    def get_nicknames_for(login)
+      get_nickname "?username=#{login}"
+    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
@@ -179,14 +214,14 @@ module GoogleApps
     # add 'endpoint', document
     #
     # add returns the HTTP response received from Google.
-		def add(endpoint, document)
-			uri = URI(endpoint)
-			@request = Net::HTTP::Post.new(uri.path)
-			@request.body = document.to_s
-			set_headers :user
+    def add(endpoint, document)
+      uri = URI(endpoint)
+      @request = Net::HTTP::Post.new(uri.path)
+      @request.body = document.to_s
+      set_headers :user
 
-			@response = request uri
-		end
+      @response = request uri
+    end
 
     # update is a generic target for method_missing.  It is
     # intended to handle the general case of updating an
@@ -243,27 +278,26 @@ module GoogleApps
 
     # TODO: This should perform the instance_variable_get and pass the value to the appropriate method.
     def method_missing(name, *args)
-    	super unless name.match /([a-z]*)_([a-z]*)/
+      super unless name.match /([a-z]*)_([a-z]*)/
 
       case $1
-      when "new"
-      	self.send(:add, instance_variable_get("@#{$2}"), *args)
+      when "new", "add"
+        self.send(:add, instance_variable_get("@#{$2}"), *args)
       when "delete"
         self.send(:delete, instance_variable_get("@#{$2}"), *args)
       when "update"
         self.send(:update, instance_variable_get("@#{$2}"), *args)
       when "get"
         self.send(:get, instance_variable_get("@#{$2}"), *args)
-      when "add"
-        self.send(:add, instance_variable_get("@#{$2}"), *args)
       else
-      	super
+        super
       end
     end
 
 
     private
 
+
     # auth_body generates the body for the authentication
     # request made by authenticate.
     #
@@ -298,20 +332,33 @@ module GoogleApps
     end
 
 
+    # start_query builds the value for the starting point
+    # query string used for retrieving batches of objects
+    # from Google.
+    def start_query(type)
+      case type
+      when 'user'
+        "startUsername"
+      when 'group'
+        "startGroup"
+      end
+    end
+
+
     # add_feed adds a feed to the @feeds array.
     def add_feed
       @feeds << GoogleApps::Atom.feed(@response.body)
     end
 
 
-		def request(uri)
+    def request(uri)
       # TODO: Clashes with @request reader
-			Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
-				http.request(@request)
-			end
-		end
+      Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+        http.request(@request)
+      end
+    end
 
-		def set_headers(request_type)
+    def set_headers(request_type)
       case request_type
       when :auth
         @request['content-type'] = "application/x-www-form-urlencoded"
@@ -322,7 +369,7 @@ module GoogleApps
         @request['content-type'] = "application/atom+xml"
         @request['authorization'] = "GoogleLogin auth=#{@token}"
       end
-		end
+    end
 
     def multi_part(properties, message)
       post_body = []
@@ -336,5 +383,5 @@ module GoogleApps
 
       post_body.join
     end
-	end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google_apps
 version: !ruby/object:Gem::Version
-  version: 0.4.8.1
+  version: 0.4.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-09 00:00:00.000000000 Z
+date: 2012-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
-  requirement: &70095956650300 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,41 +21,32 @@ dependencies:
         version: 2.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *70095956650300
+  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 |-
-  bGliL2dvb2dsZV9hcHBzL2F0b20vZG9jdW1lbnQucmI=
-- !binary |-
-  bGliL2dvb2dsZV9hcHBzL2F0b20vZXhwb3J0LnJi
-- !binary |-
-  bGliL2dvb2dsZV9hcHBzL2F0b20vZmVlZC5yYg==
-- !binary |-
-  bGliL2dvb2dsZV9hcHBzL2F0b20vZ3JvdXAucmI=
-- !binary |-
-  bGliL2dvb2dsZV9hcHBzL2F0b20vZ3JvdXBfbWVtYmVyLnJi
-- !binary |-
-  bGliL2dvb2dsZV9hcHBzL2F0b20vbWVzc2FnZS5yYg==
-- !binary |-
-  bGliL2dvb2dsZV9hcHBzL2F0b20vbWVzc2FnZV9hdHRyaWJ1dGVzLnJi
-- !binary |-
-  bGliL2dvb2dsZV9hcHBzL2F0b20vbmlja25hbWUucmI=
-- !binary |-
-  bGliL2dvb2dsZV9hcHBzL2F0b20vbm9kZS5yYg==
-- !binary |-
-  bGliL2dvb2dsZV9hcHBzL2F0b20vcHVibGljX2tleS5yYg==
-- !binary |-
-  bGliL2dvb2dsZV9hcHBzL2F0b20vdXNlci5yYg==
-- !binary |-
-  bGliL2dvb2dsZV9hcHBzL3RyYW5zcG9ydC5yYg==
-- !binary |-
-  bGliL2dvb2dsZV9hcHBzLnJi
+- lib/google_apps/atom/atom.rb
+- lib/google_apps/atom/document.rb
+- lib/google_apps/atom/export.rb
+- lib/google_apps/atom/feed.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: 
@@ -76,7 +67,7 @@ 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