google_apps 0.3.0

data/lib/google_apps.rb

@@ -0,0 +1,8 @@
+require 'google_apps/transport'
+require 'google_apps/atom/atom'
+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'

data/lib/google_apps/atom/atom.rb

@@ -0,0 +1,10 @@
+require 'libxml'
+require 'digest/sha1'
+require 'base64'
+
+module GoogleApps
+  module Atom
+    include LibXML
+    HASH_FUNCTION = "SHA-1"
+  end
+end

data/lib/google_apps/atom/export.rb

@@ -0,0 +1,52 @@
+module GoogleApps
+  module Atom
+    class Export
+      def initialize
+        @document = Atom::XML::Document.new
+        set_header
+      end
+
+      def to_s
+        @document.to_s
+      end
+      
+      def start_date(date)
+        add_prop('beginDate', date)
+      end
+
+      def end_date(date)
+        add_prop('endDate', date)
+      end
+
+      def include_deleted
+        add_prop('includeDeleted', 'true')
+      end
+
+      def query(query_string)
+        add_prop('searchQuery', query_string)
+      end
+
+      def content(type)
+        add_prop('packageContent', type)
+      end
+
+      
+      private
+
+      def set_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
+
+      def add_prop(name, value)
+        prop = Atom::XML::Node.new('apps:property')
+        prop['name'] = name
+        prop['value'] = value
+
+        @document.root << prop
+      end
+    end
+  end
+end

data/lib/google_apps/atom/group.rb

@@ -0,0 +1,48 @@
+module GoogleApps
+  module Atom
+    class Group
+      def initialize
+        @document = Atom::XML::Document.new
+        add_header
+      end
+      
+      def new_group(group_data)
+        group_data.keys.each do |key|
+          prop = Atom::XML::Node.new('apps:property')
+          prop_name(prop, key)
+          prop.attributes['value'] = group_data[key]
+          @document.root << prop 
+        end
+      end
+
+      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')
+        Atom::XML::Namespace.new(@document.root, 'gd', 'http://schemas.google.com/g/2005')
+      end
+
+      def prop_name(property, key)
+        case key
+        when :id
+          property.attributes['name'] = 'groupId'
+        when :name
+          property.attributes['name'] = 'groupName'
+        when :description
+          property.attributes['name'] = 'description'
+        when :perms
+          property.attributes['name'] = 'emailPermission'
+        end
+
+        property
+      end
+    end
+  end
+end

data/lib/google_apps/atom/message.rb

@@ -0,0 +1,21 @@
+module GoogleApps
+  module Atom
+    class Message
+      def initialize
+        @document = Atom::XML::Document.new
+      end
+      
+      def from(filename)
+        message = File.read(filename)
+        @document.root = Atom::XML::Node.new('apps:rfc822Msg', message)
+        Atom::XML::Namespace.new(@document.root, 'apps', 'http://schemas.google.com/apps/2006')
+
+        @document
+      end
+
+      def to_s
+        @document.to_s
+      end
+    end
+  end
+end

data/lib/google_apps/atom/message_attributes.rb

@@ -0,0 +1,56 @@
+module GoogleApps
+  module Atom
+    class MessageAttributes
+      def initialize
+        @document = Atom::XML::Document.new
+        set_header
+      end
+      
+      def add_property(prop)
+        property = Atom::XML::Node.new 'apps:mailItemProperty'
+        property['value'] = prop
+
+        @document.root << property
+      end
+
+      def add_label(name)
+        label = Atom::XML::Node.new 'apps:label'
+        label['labelName'] = name
+
+        @document.root << label
+      end
+
+      def to_s
+        @document.to_s
+      end
+
+      private
+
+      def set_header
+        @document.root = Atom::XML::Node.new 'atom:entry' # API Docs show just entry here
+
+        Atom::XML::Namespace.new(@document.root, 'atom', 'http://www.w3.org/2005/Atom') # API Docs show this as just xmlns
+        Atom::XML::Namespace.new(@document.root, 'apps', 'http://schemas.google.com/apps/2006')
+
+        @document.root << category
+        @document.root << content
+      end
+
+      def category
+        header = Atom::XML::Node.new 'category'
+        header['scheme'] = 'http://schemas.google.com/g/2005#kind'
+        header['term'] = 'http://schemas.google.com/apps/2006#mailItem'
+
+        header
+      end
+
+      def content
+        header = Atom::XML::Node.new 'atom:content'
+        Atom::XML::Namespace.new(header, 'atom', 'http://www.w3.org/2005/Atom')
+        header['type'] = 'message/rfc822'
+
+        header
+      end
+    end
+  end
+end

data/lib/google_apps/atom/public_key.rb

@@ -0,0 +1,31 @@
+module GoogleApps
+  module Atom
+    class PublicKey
+      def initialize
+        @document = Atom::XML::Document.new
+        add_header
+      end
+      
+      def new_key(key)
+        property = Atom::XML::Node.new('apps:property')
+        property['name'] = 'publicKey'
+        property['value'] = Base64.encode64 key
+
+        @document.root << property
+      end
+
+      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

@@ -0,0 +1,70 @@
+module GoogleApps
+	module Atom
+  	class User
+      attr_reader :document
+      
+  		def initialize
+  			@document = Atom::XML::Document.new
+  			add_header
+  		end
+
+  		def new_user(user_name, first, last, password, quota)
+        new_doc
+        add_header
+  			@document.root << login_node(user_name, password)
+  			@document.root << quota_node(quota)
+  			@document.root << name_node(first, last)
+
+        @document
+  		end
+
+      def new_doc
+        @document = Atom::XML::Document.new
+      end
+
+  		def login_node(user_name, password)
+  			login = Atom::XML::Node.new('apps:login')
+  			login['userName'] = user_name
+  			login['password'] = Digest::SHA1.hexdigest password
+  			login['hashFunctionName'] = Atom::HASH_FUNCTION
+  			login['suspended'] = "false"
+
+  			login
+  		end
+
+  		def quota_node(limit)
+  			quota = Atom::XML::Node.new('apps:quota')
+  			quota['limit'] = limit.to_s
+
+  			quota
+  		end
+
+  		def name_node(first, last)
+  			name = Atom::XML::Node.new('apps:name')
+  			name['familyName'] = last
+  			name['givenName'] = first
+
+  			name
+  		end
+
+      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')
+
+        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

@@ -0,0 +1,235 @@
+require 'net/http'
+require 'cgi'
+require 'openssl'
+require 'rexml/document'
+
+module GoogleApps
+	class Transport
+		attr_reader :request, :response
+		attr_accessor :auth, :user, :group, :nickname
+
+    BOUNDARY = "=AaB03xDFHT8xgg"
+
+		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]
+			@nickname = targets[:nickname]
+      @export = targets[:export] || "https://apps-apis.google.com/a/feeds/compliance/audit/mail/export/#{domain}"
+			@token = nil
+			@response = nil
+			@request = nil
+		end
+		
+
+    # authenticate will take the provided account and
+    # password and attempt to authenticate them with
+    # Google
+    #
+    # authenticate 'username@domain', 'password'
+    #
+    # 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
+
+			@response = request(uri)
+			@response.body.split("\n").grep(/auth=(.*)/i)
+
+			@token = $1
+
+      @response
+		end
+
+    # request_export performs the GoogleApps API call to
+    # generate a mailbox export.  It takes the username
+    # and an GoogleApps::Atom::Export instance as
+    # arguments
+    #
+    # request_export 'username', document
+    #
+    # 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
+      set_headers :user
+
+      @response = request(uri)
+    end
+
+    # export_status checks the status of a mailbox export
+    # request.  It takes the username and the request_id
+    # as arguments
+    #
+    # export_status 'username', 847576
+    #
+    # export_status will return the body 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
+    end
+
+    def fetch_export(flename) # :nodoc:
+      # TODO: Shouldn't rely on export_status being run first.  Self, this is lazy and stupid.
+      doc = REXML::Document.new(@response.body)
+      urls = []
+      doc.elements.each('entry/apps:property') do |property|
+        urls << property.attributes['value'] if property.attributes['name'].match 'fileUrl'
+      end
+
+      urls.each do |url|
+        download(url, filename)
+      end
+    end
+
+    # download makes a get request of the provided url
+    # and writes the body to the provided filename.
+    #
+    # download 'url', 'save_file'
+    def download(url, filename)
+      uri = URI(url)
+      @request = Net::HTTP::Get.new uri.path
+      set_headers :user
+
+      File.new(filename, "w") do |file|
+        file.puts request(uri).body
+      end
+    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
+    # and a GoogleApps::Atom document as arguments.
+    #
+    # add 'endpoint', document
+    #
+    # add returns the HTTP response received from Google.
+		def add(endpoint, document)
+			uri = URI(instance_variable_get("@#{endpoint.to_s}"))
+			@request = Net::HTTP::Post.new(uri.path)
+			@request.body = document
+			set_headers :user
+
+			@response = request(uri)
+		end
+
+    # update is a generic target for method_missing.  It is
+    # intended to handle the general case of updating an
+    # item that already exists in your GoogleApps Domain.
+    # It takes an API endpoint and a GoogleApps::Atom document
+    # as arguments.
+    #
+    # update 'endpoint', document
+    #
+    # update returns the HTTP response received from Google
+    def update(endpoint, document)
+    	# TODO: Username needs to come from somewhere for uri
+      uri = URI(instance_variable_get("@#{endpoint.to_s}") + "/")
+    end
+
+    # delete is a generic target for method_missing.  It is
+    # intended to handle the general case of deleting an
+    # item from your GoogleApps Domain.  delete takes an
+    # API endpoint and an item identifier as argumets.
+    #
+    # delete 'endpoint', 'id'
+    #
+    # delete returns the HTTP response received from Google.
+    def delete(endpoint, id)
+      uri = URI(instance_variable_get("@#{endpoint.to_s}") + "/#{id}")
+      @request = Net::HTTP::Delete.new(uri.path)
+      set_headers :user
+      
+      @response = request(uri)
+    end
+
+    # migration performs mail migration from a local
+    # mail environment to GoogleApps.  migrate takes a
+    # username a GoogleApps::Atom::Properties dcoument 
+    # and the message as plain text (String) as arguments.
+    #
+    # migrate 'user', properties, message
+    #
+    # migrate returns the HTTP response received from Google.
+    def migrate(username, properties, message)
+      uri = URI(@migration + "/#{username}/mail")
+      @request = Net::HTTP::Post.new(uri.path)
+      @request.body = multi_part(properties, message)
+      set_headers :migrate
+
+      @response = request(uri)
+    end
+
+    def method_missing(name, *args)
+    	super unless name.match /([a-z]*)_([a-z]*)/
+
+      case $1
+      when "new"
+      	self.send(:add, $2, *args)
+      when "delete"
+        self.send(:delete, $2, *args)
+      else
+      	super
+      end
+    end
+
+
+    private
+
+    # auth_body generates the body for the authentication
+    # request made by authenticate.
+    #
+    # auth_body 'username@domain', 'password'
+    #
+    # auth_body returns a string in the form of HTTP
+    # query parameters.
+    def auth_body(account, pass)
+      "&Email=#{CGI::escape(account)}&Passwd=#{CGI::escape(pass)}&accountType=HOSTED&service=apps"
+    end
+
+		def request(uri)
+      # TODO: Clashes with @request reader
+			Net::HTTP.start(uri.hostname, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+				http.request(@request)
+			end
+		end
+
+		def set_headers(request_type)
+      case request_type
+      when :auth
+        @request['content-type'] = "application/x-www-form-urlencoded"
+      when :migrate
+        @request['content-type'] = "multipart/related; boundary=\"#{BOUNDARY}\""
+        @request['authorization'] = "GoogleLogin auth=#{@token}"
+      else
+        @request['content-type'] = "application/atom+xml"
+        @request['authorization'] = "GoogleLogin auth=#{@token}"
+      end
+		end
+
+    def multi_part(properties, message)
+      post_body = []
+      post_body << "--#{BOUNDARY}\n"
+      post_body << "Content-Type: application/atom+xml\n\n"
+      post_body << properties.to_s
+      post_body << "\n--#{BOUNDARY}\n"
+      post_body << "Content-Type: message/rfc822\n\n"
+      post_body << message.to_s
+      post_body << "--#{BOUNDARY}--}"
+
+      post_body.join
+    end
+	end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: google_apps
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease: 
+platform: ruby
+authors:
+- Glen Holcomb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-05 00:00:00.000000000 Z
+dependencies: []
+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 |-
+  bGliL2dvb2dsZV9hcHBzL2F0b20vbWVzc2FnZS5yYg==
+- !binary |-
+  bGliL2dvb2dsZV9hcHBzL2F0b20vbWVzc2FnZV9hdHRyaWJ1dGVzLnJi
+- !binary |-
+  bGliL2dvb2dsZV9hcHBzL2F0b20vcHVibGljX2tleS5yYg==
+- !binary |-
+  bGliL2dvb2dsZV9hcHBzL2F0b20vdXNlci5yYg==
+- !binary |-
+  bGliL2dvb2dsZV9hcHBzL3RyYW5zcG9ydC5yYg==
+- !binary |-
+  bGliL2dvb2dsZV9hcHBzLnJi
+homepage: https://github.com/LeakyBucket/google_apps
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Google Apps APIs
+test_files: []