google_apps 0.3.1 → 0.3.2

data/lib/google_apps/atom/export.rb

@@ -6,26 +6,75 @@ module GoogleApps
         set_header
       end
 
+      # to_s returns @document as a string.
       def to_s
         @document.to_s
       end
       
+      # start_date specifies a start date for the extract.  
+      # Matching results that occurred before this date will
+      # not be included in the result set.  start_date takes
+      # a string as an argument, the format is as follows:
+      #
+      # 'yyyy-MM-dd HH:mm' where yyyy is the four digit year,
+      # MM is the two digit month, dd is the two digit day,
+      # HH is the hour of the day 0-23 and mm is the minute
+      # 0-59
+      #
+      # start_date '2012-01-01 00:00'
+      #
+      # start_date returns @document.root
       def start_date(date)
         add_prop('beginDate', date)
       end
 
+      # end_date specifies an end date for the extract.  
+      # Matching results that occurred past this date will
+      # not be included in the result set.  end_date takes
+      # a string as an argument, the format is as follows:
+      #
+      # 'yyyy-MM-dd HH:mm' where yyyy is the four digit year,
+      # MM is the two digit month, dd is the two digit day,
+      # HH is the hour of the day 0-23 and mm is the minute
+      # 0-59
+      #
+      # end_date '2012-01-01 08:30'
+      #
+      # end_date returns @document.root
       def end_date(date)
         add_prop('endDate', date)
       end
 
+      # include_deleted will specify that matches which
+      # have been deleted should be returned as well.  
+      # The default is to omit deleted matches.
+      #
+      # include_deleted
+      #
+      # include_deleted returns @document.root
       def include_deleted
         add_prop('includeDeleted', 'true')
       end
 
+      # query specifies a query string to be used when
+      # filtering the messages to be returned.  You can
+      # use any string that you could use in Google's
+      # Advanced Search interface.
+      #
+      # query 'from: Bob'
+      #
+      # query returns @document.root
       def query(query_string)
         add_prop('searchQuery', query_string)
       end
 
+      # content specifies the data to be returned in the
+      # mailbox export.  There are two valid arguments: 
+      # 'FULL_MESSAGE' or 'HEADER_ONLY'
+      #
+      # content 'HEADER_ONLY'
+      #
+      # content returns @document.root
       def content(type)
         add_prop('packageContent', type)
       end
@@ -33,6 +82,9 @@ module GoogleApps
       
       private
 
+      # set_header adds the appropriate XML boilerplate for
+      # a mailbox extract as specified by the GoogleApps
+      # Email Audit API.
       def set_header
         @document.root = Atom::XML::Node.new 'atom:entry'
 
@@ -40,6 +92,8 @@ module GoogleApps
         Atom::XML::Namespace.new(@document.root, 'apps', 'http://schemas.google.com/apps/2006')
       end
 
+      # add_prop adds an element of the type: apps:property
+      # to the extract document.
       def add_prop(name, value)
         prop = Atom::XML::Node.new('apps:property')
         prop['name'] = name

data/lib/google_apps/transport.rb

@@ -81,8 +81,9 @@ module GoogleApps
       (@response = request(uri)).body
     end
 
-    def fetch_export(flename) # :nodoc:
+    def fetch_export(username, req_id, filename) # :nodoc:
       # TODO: Shouldn't rely on export_status being run first.  Self, this is lazy and stupid.
+      export_status(username, req_id)
       doc = REXML::Document.new(@response.body)
       urls = []
       doc.elements.each('entry/apps:property') do |property|
@@ -90,7 +91,7 @@ module GoogleApps
       end
 
       urls.each do |url|
-        download(url, filename)
+        download(url, filename + "#{urls.index[url]}")
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google_apps
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors: