google_apps_api 0.1.0 → 0.2.1

data/.gitignore

@@ -17,5 +17,5 @@ tmtags
 coverage
 rdoc
 pkg
-
+private
 ## PROJECT::SPECIFIC

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.1

data/google_apps_api.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{google_apps_api}
-  s.version = "0.1.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["James Stuart"]
-  s.date = %q{2010-05-05}
+  s.date = %q{2010-05-25}
   s.description = %q{APIs for Google Apps (currently Provisioning, Calendar, Calendar Resources)}
   s.email = %q{tastyhat@jamesstuart.org}
   s.extra_rdoc_files = [
@@ -25,6 +25,8 @@ Gem::Specification.new do |s|
      "VERSION",
      "google_apps_api.gemspec",
      "lib/config/calendar.yml",
+     "lib/config/contacts.yml",
+     "lib/config/profiles.yml",
      "lib/config/provisioning.yml",
      "lib/google_apps_api.rb",
      "lib/google_apps_api/base_api.rb",
@@ -35,11 +37,12 @@ Gem::Specification.new do |s|
      "lib/google_apps_api/provisioning.rb",
      "lib/google_apps_api/user_profiles.rb",
      "lib/load_config.rb",
-     "private/gapps-config.yml",
-     "private/userscalendars.xml",
+     "test/example_connection_config.yml",
      "test/google_apps_api-calendar_resources_test.rb",
+     "test/google_apps_api_base_api_test.rb",
      "test/google_apps_api_calendar_test.rb",
      "test/google_apps_api_contacts_test.rb",
+     "test/google_apps_api_off_domain_calendar_test.rb",
      "test/google_apps_api_provisioning_test.rb",
      "test/google_apps_api_user_profiles_test.rb",
      "test/helper.rb",
@@ -52,8 +55,10 @@ Gem::Specification.new do |s|
   s.summary = %q{Various APIs for Google Apps}
   s.test_files = [
     "test/google_apps_api-calendar_resources_test.rb",
+     "test/google_apps_api_base_api_test.rb",
      "test/google_apps_api_calendar_test.rb",
      "test/google_apps_api_contacts_test.rb",
+     "test/google_apps_api_off_domain_calendar_test.rb",
      "test/google_apps_api_provisioning_test.rb",
      "test/google_apps_api_user_profiles_test.rb",
      "test/helper.rb",

data/lib/config/calendar.yml

@@ -15,20 +15,47 @@
       :method: :post
       :path: ":auth:/accounts/ClientLogin"
       :format: :text
-    :retrieve_users_calendars:
+    :retrieve_calendar_for_user:
       :method: :get
-      :path: ":feed_basic:/:username:/allcalendars/full"
-      :feed: true
-      :class: GoogleAppsApi::CalendarEntry
-    :retrieve_users_own_calendars:
+      :path: ":feed_basic:/:username:/allcalendars/full/:calendar:"
+      :format: GoogleAppsApi::CalendarEntity
+    :update_calendar_for_user:
+      :method: :put
+      :path: ":feed_basic:/:username:/allcalendars/full/:calendar:"
+      :format: GoogleAppsApi::CalendarEntity
+    :retrieve_calendars_for_user:
       :method: :get
-      :path: ":feed_basic:/:username:/owncalendars/full"  
+      :path: ":feed_basic:/:username:/allcalendars/full"
       :feed: true
-      :class: GoogleAppsApi::CalendarEntry
+      :format: GoogleAppsApi::CalendarEntity
     :add_calendar_to_user:
       :method: :post
       :path: ":feed_basic:/:username:/allcalendars/full"
-    :delete_calendar_from_user:
+      :format: GoogleAppsApi::CalendarEntity
+    :remove_calendar_from_user:
+      :method: :delete
+      :path: ":feed_basic:/:username:/allcalendars/full/:calendar:"
+      :format: :text
+    :retrieve_calendar_acl_for_user:
+      :method: :get
+      :path: ":feed_basic:/:calendar:/acl/full/:scope_type:%3a:scope_id:"  
+      :format: GoogleAppsApi::CalendarAcl
+    :retrieve_acls_for_calendar:
+      :method: :get
+      :path: ":feed_basic:/:calendar:/acl/full"
+      :format: GoogleAppsApi::CalendarAcl
+      :feed: true
+    :create_calendar_acl:
+      :method: :post
+      :path: ":feed_basic:/:calendar:/acl/full"  
+      :format: GoogleAppsApi::CalendarAcl
+    :set_calendar_acl:
+      :method: :put
+      :path: ":feed_basic:/:calendar:/acl/full/:scope:"  
+      :format: GoogleAppsApi::CalendarAcl
+    :remove_calendar_acl:
       :method: :delete
-      :path: ":feed_basic:/:username:/allcalendars/full/:id:"
+      :path: ":feed_basic:/:calendar:/acl/full/:scope:"  
+      :format: :text
+      
     

data/lib/config/contacts.yml

@@ -0,0 +1,35 @@
+:contacts:
+  :service: cp
+
+  :headers:
+    GData-Version: "2"
+
+  :action_subs:
+    :service: cl
+    :auth: https://www.google.com
+    :feed: https://www.google.com/m8/feeds/contacts
+    
+  :action_hash:
+    :domain_login:
+      :method: :post
+      :path: ":auth:/accounts/ClientLogin"
+      :format: :text
+    :retrieve_all_contacts:
+      :method: :get
+      :path: ":feed:/:domain:/full"
+      :feed: true
+      :format: GoogleAppsApi::ContactEntity
+    :retrieve_contact:
+      :method: :get
+      :path: ":feed:/:domain:/full/:contact:"
+      :format: GoogleAppsApi::ContactEntity
+    :create_contact:
+      :method: :post
+      :path: ":feed:/:domain:/full"
+      :format: GoogleAppsApi::ContactEntity
+    :remove_contact:
+      :method: :delete
+      :path: ":feed:/:domain:/full/:contact:"
+      :format: :text
+      
+    

data/lib/config/profiles.yml

@@ -0,0 +1 @@
+:profiles:

data/lib/config/provisioning.yml

@@ -12,25 +12,32 @@
       :method: :post
       :path: ":auth:/accounts/ClientLogin"
       :format: :text
+
     :rename_user:
       :method: :put
       :path: ":path_user:/:username:"
+
     :delete_user:
       :method: :delete
       :path: ":path_user:/:username:"
+
     :create_user:
       :method: :post
       :path: ":path_user:"
+      :format: GoogleAppsApi::UserEntity
+
     :retrieve_user:
       :method: :get
       :path: ":path_user:/:username:"
-      :class: GoogleAppsApi::UserEntry
+      :format: GoogleAppsApi::UserEntity
+
     :retrieve_all_users:
       :method: :get
       :path: ":path_user:"
       :feed: true
-      :class: GoogleAppsApi::UserEntry
+      :format: GoogleAppsApi::UserEntity
+
     :update_user:
       :method: :put
       :path: ":path_user:/:username:"
-      :format: :text
+      :format: GoogleAppsApi::UserEntity

data/lib/google_apps_api/base_api.rb

@@ -1,7 +1,6 @@
-include REXML
-
 module GoogleAppsApi
   class BaseApi
+    attr_reader :domain
 
 
     def initialize(api_name, *args)
@@ -9,87 +8,97 @@ module GoogleAppsApi
       options = args.extract_options!.merge!(api_config)
       raise("Must supply admin_user") unless options[:admin_user] 
       raise("Must supply admin_password") unless options[:admin_password]
-      raise("Must supply domain") unless options[:domain]
+      @domain = options[:domain] || raise("Must supply domain") 
       @actions_hash = options[:action_hash] || raise("Must supply action hash")
       @actions_subs = options[:action_subs] || raise("Must supply action subs")
       @actions_hash[:next] = [:get, '']
-      @actions_subs[:domain] = options[:domain]
+      @actions_subs[:domain] = @domain
 
-      @token = login(options[:admin_user], options[:domain], options[:admin_password], options[:service])
+      @token = login(options[:admin_user], @domain, options[:admin_password], options[:service])
       @headers = {'Content-Type'=>'application/atom+xml', 'Authorization'=> 'GoogleLogin auth='+@token}.merge(options[:headers] || {})
 
     end
 
-    def method_missing(method, *args, &block)
-      if @actions_hash.has_key?(method.to_sym)
-        request(method.to_sym, *args)
-      end
-    end
 
-    private
+    def entity(*args)
+      entity.merge(:domain => @domain)
+    end
 
-    def setup_action(*args)
-      options = args.extract_options!
-      actions = options[:action_hash]
 
-      actions.each_pair do |k,v|
-        actions[k] = {:method => v[0], :path => (v[1].to_s.gsub!(/\:([^\:]+)\:/) { |sub| options[sub.gsub(/\:/,"").to_sym] })}
-      end
-
-      return actions
-    end
+    private
 
     def login(username, domain, password, service)
+      @gsession_id = nil
       request_body = '&Email='+CGI.escape(username + "@" + domain)+'&Passwd='+CGI.escape(password)+'&accountType=HOSTED&service='+ service + '&source=columbiaUniversity-google_apps_api-0.1'
       res = request(:domain_login, :headers =>  {'Content-Type'=>'application/x-www-form-urlencoded'}, :body => request_body)
 
 
       return /^Auth=(.+)$/.match(res.to_s)[1]
     end
+    
+    
 
     def request(action, *args)
       options = args.extract_options!
       options = {:headers => @headers}.merge(options)
+      options[:headers] = (options[:headers] || {}).merge(options.delete(:merge_headers) || {})
       action_hash = @actions_hash[action] || raise("invalid action #{action} called")
       
       subs_hash = @actions_subs.merge(options)
       subs_hash.each { |k,v| subs_hash[k] = action_gsub(v, subs_hash) if v.kind_of?(String)}
-
+      
       method = action_hash[:method]
       path = action_gsub(action_hash[:path], subs_hash) + options[:query].to_s
       is_feed = action_hash[:feed]
-      feed_class = action_hash[:class].constantize if action_hash[:class]
-      format = action_hash[:format] || :xml
+      format = options[:return_format] || action_hash[:format] || :xml
+      format = format.constantize unless [:xml, :text].include?(format) || format.kind_of?(Class)
+      
+      
+      if options[:debug]
+        puts "method: #{method}"
+        puts "path: #{path}"
+        puts "body: #{options[:body]}"
+        puts "headers: #{options[:headers]}"
+        puts "---\n"
+      end
+      
       response = http_request(method, path, options[:body], options[:headers])
 
       if format == :text
+        puts response.body.content if options[:debug]
         return response.body.content
       else
         begin 
-          xml = Nokogiri::XML(response.body.content) { |c| c.strict}
+          xml = Nokogiri::XML(response.body.content) { |c| c.strict.noent}
+
           test_errors(xml)
-          if is_feed
-            entries = entryset(xml.css('feed>entry'),feed_class)
+          puts xml.to_s if options[:debug]
+          
+                    
+          if format == :xml || !is_feed
+            format.kind_of?(Class) ? format.new(:xml => xml) : xml
+          else
+            entries = entryset(xml.css('feed>entry'), format)
 
           
             while (next_feed = xml.at_css('feed>link[rel=next]'))
               response = http_request(:get, next_feed.attribute("href").to_s, nil, options[:headers])
               xml = Nokogiri::XML(response.body.content) { |c| c.strict}
-              entries += entryset(xml.css('feed>entry'),feed_class)
+              entries += entryset(xml.css('feed>entry'),format)
             end
               
             entries
-          else
-            feed_class ? feed_class.new(xml) : xml
           end
         
 
         rescue Nokogiri::XML::SyntaxError  => e
+          puts response.body.content if options[:debug]
+
           error = GDataError.new()
           error.code = "SyntaxError"
           error.input = "path: #{path}"
-          error.reason = "XML expected, syntax error"
-          raise error, e.to_s
+          error.reason = "#{response.body.content}"
+          raise error, error.inspect
         end
       end
     end
@@ -97,15 +106,25 @@ module GoogleAppsApi
     def http_request(method, path, body, headers, redirects = 0)
       @hc ||= HTTPClient.new
       
+      path_with_gsession = path
+      
+      if @gsession_id && redirects == 0
+        operator = path.include?("?") ? "&" : "?"
+        path_with_gsession += "#{operator}gsessionid=#{@gsession_id.to_s}"
+      end
+      
       response = case method
       when :delete
-        @hc.send(method, path, headers)
+        @hc.send(method, path_with_gsession, headers)
       else
-        @hc.send(method, path, body, headers)
+        @hc.send(method, path_with_gsession, body, headers)
       end
       
       if response.status_code == 302 && (redirects += 1) < 10
-        response = http_request(method, response.header["Location"], body, headers, requests)
+        new_loc = response.header["Location"].to_s
+        gsession_match = new_loc.match(/gsessionid=([\w\-_]+)/)
+        @gsession_id = gsession_match[1].to_s if gsession_match
+        response = http_request(method, new_loc, body, headers, redirects)
       end
       return response
     end
@@ -128,8 +147,8 @@ module GoogleAppsApi
       end
     end
 
-    def entryset(entries, feed_class)
-      feed_class ? entries.collect { |en| feed_class.new(en)} : entries
+    def entryset(entries, return_class)
+      return_class ? entries.collect { |en| return_class.new(:xml => en)} : entries
     end
 
     def escapeXML(text)
@@ -148,10 +167,75 @@ module GoogleAppsApi
 
   end
   
+  
+  
+
+  class Entity
+    VALID_ENTITY_TYPES = [:user, :calendar, :domain, :contact]
+    
+    attr_reader :kind, :id, :domain
+    def initialize(*args)
+      options = args.extract_options!
+
+      @kind = options.delete(:kind)
+      @id = options.delete(:id)
+      @domain = options.delete(:domain)
+    
+      if (kind = options.keys.detect { |k| VALID_ENTITY_TYPES.include?(k.to_sym)})
+        @kind = kind.to_s
+      
+        value = CGI::unescape(options[kind])
+        
+        if value.include?("@")
+          @id, @domain = value.split("@",2)
+        else
+          @id = value
+        end
+      end
+      
+
+      raise(ArgumentError, "Kind and Id must be specified") unless @kind && @id
+    end
+    
+    def id_escaped
+      CGI::escape(@id)
+    end
+    
+    def full_id
+      @id + (@domain.nil? ? "" : "@" + @domain)
+    end
+    
+    def full_id_escaped
+      CGI::escape(full_id)
+    end
+    
+    def qualified_id
+      @kind + ":" + full_id
+    end
+    
+    def qualified_id_escaped
+      CGI::escape(qualified_id)
+    end
+
+
+    def ==(other)
+      other.kind_of?(Entity) && @kind == other.kind && @id == other.id && @domain == other.domain
+    end
+  end
+  
 	class GDataError < RuntimeError
 		attr_accessor :code, :input, :reason
 		
 		def initialize()
 		end
+		
+		def to_s
+		  "#{code}: #{reason}"
+		end
+		
+		def inspect
+		  "#{code}: #{reason}"
+		  
+		end
 	end
 end