chdorner-gdocsapi-wrapper 0.0.3 → 0.0.4

data/Manifest.txt

@@ -3,10 +3,16 @@ History.txt
 lib/gdocsapi-wrapper/auth/login.rb
 lib/gdocsapi-wrapper/auth.rb
 lib/gdocsapi-wrapper/base.rb
+lib/gdocsapi-wrapper/client/client.rb
+lib/gdocsapi-wrapper/client/service.rb
 lib/gdocsapi-wrapper/client.rb
 lib/gdocsapi-wrapper/http/request.rb
 lib/gdocsapi-wrapper/http/response.rb
 lib/gdocsapi-wrapper/http.rb
+lib/gdocsapi-wrapper/models/author.rb
+lib/gdocsapi-wrapper/models/document.rb
+lib/gdocsapi-wrapper/models/folder.rb
+lib/gdocsapi-wrapper/models.rb
 lib/gdocsapi-wrapper.rb
 Manifest.txt
 PostInstall.txt

data/gdocsapi-wrapper.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gdocsapi-wrapper}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Christof Dorner"]
@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.description = %q{A Ruby wrapper around the Google Documents List Data API}
   s.email = ["christof@chdorner.com"]
   s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt"]
-  s.files = ["gdocsapi-wrapper.gemspec", "History.txt", "lib/gdocsapi-wrapper/auth/login.rb", "lib/gdocsapi-wrapper/auth.rb", "lib/gdocsapi-wrapper/base.rb", "lib/gdocsapi-wrapper/client.rb", "lib/gdocsapi-wrapper/http/request.rb", "lib/gdocsapi-wrapper/http/response.rb", "lib/gdocsapi-wrapper/http.rb", "lib/gdocsapi-wrapper.rb", "Manifest.txt", "PostInstall.txt", "Rakefile", "README.rdoc", "test/test_gdocsapi-wrapper.rb", "test/test_helper.rb"]
+  s.files = ["gdocsapi-wrapper.gemspec", "History.txt", "lib/gdocsapi-wrapper/auth/login.rb", "lib/gdocsapi-wrapper/auth.rb", "lib/gdocsapi-wrapper/base.rb", "lib/gdocsapi-wrapper/client/client.rb", "lib/gdocsapi-wrapper/client/service.rb", "lib/gdocsapi-wrapper/client.rb", "lib/gdocsapi-wrapper/http/request.rb", "lib/gdocsapi-wrapper/http/response.rb", "lib/gdocsapi-wrapper/http.rb", "lib/gdocsapi-wrapper/models/author.rb", "lib/gdocsapi-wrapper/models/document.rb", "lib/gdocsapi-wrapper/models/folder.rb", "lib/gdocsapi-wrapper/models.rb", "lib/gdocsapi-wrapper.rb", "Manifest.txt", "PostInstall.txt", "Rakefile", "README.rdoc", "test/test_gdocsapi-wrapper.rb", "test/test_helper.rb"]
   s.homepage = %q{http://github.com/chdorner/gdocs-wrapper}
   s.post_install_message = %q{PostInstall.txt}
   s.rdoc_options = ["--main", "README.rdoc"]

data/lib/gdocsapi-wrapper.rb

@@ -29,5 +29,5 @@ require 'gdocsapi-wrapper/client'
 require 'gdocsapi-wrapper/models'
 
 module GDocsAPIWrapper
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/lib/gdocsapi-wrapper/base.rb

@@ -41,4 +41,7 @@ module GDocsAPIWrapper
   class LoginRequiredError < Error
   end
   
+  class ServiceNotFoundError < Error
+  end
+  
 end

data/lib/gdocsapi-wrapper/client/client.rb

@@ -0,0 +1,98 @@
+# Copyright (c) 2009 Christof Dorner
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# 'Software'), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'rexml/document'
+
+module GDocsAPIWrapper
+  module Client
+    class GDocsClient
+    
+      # Identifying the application which uses the GDocsAPIWrapper
+      attr_accessor :source
+      attr_accessor :login_handler
+    
+      def initialize(options = {})
+        options.each do |key, value|
+          self.send("#{key}=", value)
+        end
+      
+        @source ||= 'UndefinedApplication'
+        @login_handler = GDocsAPIWrapper::Auth::Login.new
+      end
+    
+      # Performs login on GDocsAPIWrapper:Auth
+      def login(username, password)
+        source = GDocsAPIWrapper::Auth::SOURCE_PREFIX + @source
+      
+        @login_handler.perform_login(username, password, source)
+      end
+    
+      # Get a list of documents, possible options: :type => :all, :word, :spreadsheet, :presentation and :filter => :none, :starred, :trashed
+      def list_documents(options = {})
+        options[:type] ||= :all
+        options[:filter] ||= :none
+        
+        # login required to call this function
+        raise LoginRequiredError.new unless loggedin?
+        
+        request = GDocsAPIWrapper::HTTP::Request.new(GDocsAPIWrapper::Client::Service.get(:documents, :type => options[:type], :filter => options[:filter]), :method => :get, :headers => base_headers)
+        response = request.send_request
+        
+        documents = Array.new
+        doc = REXML::Document.new(response.body)
+        doc.elements.each("/feed/entry") do |entry|
+          documents << GDocsAPIWrapper::Models::Document.parse(entry)
+        end
+        
+        return documents
+      end
+      
+      # Get a list of folders
+      def list_folders
+        # login required to call this function
+        raise LoginRequiredError.new unless loggedin?
+        
+        request = GDocsAPIWrapper::HTTP::Request.new(GDocsAPIWrapper::Client::Service.get(:folders), :method => :get, :headers => base_headers)
+        response = request.send_request
+        
+        folders = Array.new
+        doc = REXML::Document.new(response.body)
+        doc.elements.each("/feed/entry") do |entry|
+          folders << GDocsAPIWrapper::Models::Folder.parse(entry)
+        end
+        
+        return folders
+      end
+    
+      def loggedin?
+        return !(@login_handler.token.nil?)
+      end
+      
+      def base_headers
+        headers = Hash.new
+        if loggedin?
+          headers['Authorization'] = 'GoogleLogin auth=' + @login_handler.token
+        end
+        return headers
+      end
+    end
+  end
+end

data/lib/gdocsapi-wrapper/client/service.rb

@@ -0,0 +1,68 @@
+# Copyright (c) 2009 Christof Dorner
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# 'Software'), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module GDocsAPIWrapper
+  module Client
+    class Service
+      
+      @@base_uri = 'https://docs.google.com'
+      @@documents = '/feeds/documents/private/full'
+      @@folders = '/feeds/documents/private/full/-/folder?showfolders=true'
+      
+      def self.get(object, options = {})
+        case object
+        when :documents
+          uri = @@base_uri + @@documents
+          
+          # process types
+          case options[:type]
+          when :word
+            uri += '/-/document'
+          when :spreadsheet
+            uri += '/-/spreadsheet'
+          when :presentation
+            uri += '/-/presentation'
+          end
+          
+          #process filters
+          case options[:filter]
+          when :starred
+            if options[:type] == :all
+              uri += '/-'
+            end
+            uri += '/starred'
+          when :trashed
+            if options[:type] == :all
+              uri += '/-'
+            end
+            uri += '/trashed'
+          end
+          return uri
+          
+        when :folders
+          return @@base_uri + '/feeds/documents/private/full/-/folder?showfolders=true'
+        else
+          raise ServiceNotFoundError.new
+        end
+      end
+    end
+  end
+end

data/lib/gdocsapi-wrapper/models.rb

@@ -0,0 +1,24 @@
+# Copyright (c) 2009 Christof Dorner
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# 'Software'), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'gdocsapi-wrapper/models/document'
+require 'gdocsapi-wrapper/models/author'
+require 'gdocsapi-wrapper/models/folder'

data/lib/gdocsapi-wrapper/models/author.rb

@@ -0,0 +1,38 @@
+# Copyright (c) 2009 Christof Dorner
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# 'Software'), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module GDocsAPIWrapper
+  module Models
+    class Author
+      attr_accessor :name
+      attr_accessor :email
+      
+      def self.parse(element)
+        author = GDocsAPIWrapper::Models::Author.new
+        
+        author.name = element.elements['name'].text
+        author.email = element.elements['email'].text
+        
+        return author
+      end
+    end
+  end
+end

data/lib/gdocsapi-wrapper/models/document.rb

@@ -0,0 +1,46 @@
+# Copyright (c) 2009 Christof Dorner
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# 'Software'), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'date'
+
+module GDocsAPIWrapper
+  module Models
+    class Document
+      attr_accessor :title
+      attr_accessor :published
+      attr_accessor :updated
+      attr_accessor :link
+      attr_accessor :author
+      
+      def self.parse(element)
+        document = GDocsAPIWrapper::Models::Document.new
+        
+        document.title = element.elements['title'].text
+        document.published = DateTime.parse(element.elements['published'].text)
+        document.updated = DateTime.parse(element.elements['updated'].text)
+        document.link = element.elements['link[@rel="alternate"]'].attributes['href']
+        document.author = GDocsAPIWrapper::Models::Author.parse(element.elements['author'])
+        
+        return document
+      end
+    end
+  end
+end

data/lib/gdocsapi-wrapper/models/folder.rb

@@ -0,0 +1,46 @@
+# Copyright (c) 2009 Christof Dorner
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# 'Software'), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'date'
+
+module GDocsAPIWrapper
+  module Models
+    class Folder
+      attr_accessor :title
+      attr_accessor :published
+      attr_accessor :updated
+      attr_accessor :link
+      attr_accessor :author
+      
+      def self.parse(element)
+        document = GDocsAPIWrapper::Models::Document.new
+        
+        document.title = element.elements['title'].text
+        document.published = DateTime.parse(element.elements['published'].text)
+        document.updated = DateTime.parse(element.elements['updated'].text)
+        document.link = element.elements['link[@rel="alternate"]'].attributes['href']
+        document.author = GDocsAPIWrapper::Models::Author.parse(element.elements['author'])
+        
+        return document
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: chdorner-gdocsapi-wrapper
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Christof Dorner
@@ -39,10 +39,16 @@ files:
 - lib/gdocsapi-wrapper/auth/login.rb
 - lib/gdocsapi-wrapper/auth.rb
 - lib/gdocsapi-wrapper/base.rb
+- lib/gdocsapi-wrapper/client/client.rb
+- lib/gdocsapi-wrapper/client/service.rb
 - lib/gdocsapi-wrapper/client.rb
 - lib/gdocsapi-wrapper/http/request.rb
 - lib/gdocsapi-wrapper/http/response.rb
 - lib/gdocsapi-wrapper/http.rb
+- lib/gdocsapi-wrapper/models/author.rb
+- lib/gdocsapi-wrapper/models/document.rb
+- lib/gdocsapi-wrapper/models/folder.rb
+- lib/gdocsapi-wrapper/models.rb
 - lib/gdocsapi-wrapper.rb
 - Manifest.txt
 - PostInstall.txt