knock-knock 0.1.3 → 0.1.4

data/History.txt

@@ -1,12 +1,18 @@
+== 0.1.4 2008-12-08
+
+* New features
+	* Put method included
+	* Delete method included
+
 == 0.1.3 2008-12-07
 
 * New features
-  * Post method supports
+  * Post method included
 
 == 0.1.2 2008-12-07
 
 * Bug fix
-  * Fixing a problem with namespaces
+	* Fixing a problem with namespaces
 
 == 0.1.1 2008-12-07
 

data/Manifest.txt

@@ -1,6 +1,5 @@
 History.txt
 Manifest.txt
-PostInstall.txt
 README.rdoc
 Rakefile
 lib/knock_knock.rb

data/README.rdoc

@@ -5,6 +5,7 @@ KnockKnock was made to turn login with Google Authentication API easier.
 == Features
 * Singleton class for connection with Google.
 * Simple authentication and clear code.
+* GET, POST, PUT, DELETE method implemented
 
 == Synopsis
 

data/Rakefile

@@ -9,10 +9,11 @@ $hoe = Hoe.new('knock-knock', Bubble::KnockKnock::VERSION) do |p|
   # p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
   p.rubyforge_name       = 'knock-knock' # TODO this is default value
   p.extra_deps         = [
-    ['activesupport','>= 2.0.2'],
+    ['activesupport','>= 2.0.2']
   ]
   p.extra_dev_deps = [
-    ['newgem', ">= #{::Newgem::VERSION}"]
+    ['newgem', ">= #{::Newgem::VERSION}"],
+    ['xml-object', '>= 0.9.8']
   ]
   
   p.clean_globs |= %w[**/.DS_Store tmp *.log]

data/lib/bubble/knock_knock/connection.rb

@@ -10,6 +10,8 @@ module Bubble
     # It's a Singleton class, turning the management of the connection easier. Just one connection will be created during all your script.
     class Connection
       include Singleton
+      include Bubble::KnockKnock
+      include Bubble::KnockKnock::Exceptions
   
       attr_accessor :email, :service
       attr_reader :password, :auth
@@ -48,7 +50,7 @@ module Bubble
                    'Email' => @email,
                    'Passwd' => @password,
                    'service' => @service,
-                   'source' => Bubble::KnockKnock::APP_NAME }
+                   'source' => APP_NAME }
                     
         @http = Net::HTTP.new(@uri.host, 443)
         @http.use_ssl = true

data/lib/bubble/knock_knock/exceptions.rb

@@ -1,14 +1,14 @@
 module Bubble
   module KnockKnock
-
-    # For login errors
-    class BadLogin < Exception; end
-    # For requests to Google services without a connection
-    class UnstablishedConnection < Exception; end
-    # Bad request at Google returns 400
-    class BadRequest < Exception; end
-    # When a 409 (HTTP Conflict) occurs. It happens when, for example, you try to create a contact but it exists.
-    class HTTPConflict < Exception; end
-    
+    module Exceptions
+      # For login errors
+      class BadLogin < Exception; end
+      # For requests to Google services without a connection
+      class UnstablishedConnection < Exception; end
+      # Bad request at Google returns 400
+      class BadRequest < Exception; end
+      # When a 409 (HTTP Conflict) occurs. It happens when, for example, you try to create a contact but it exists.
+      class HTTPConflict < Exception; end
+    end
   end
 end

data/lib/bubble/knock_knock/request.rb

@@ -2,13 +2,16 @@ module Bubble
   module KnockKnock
     # This class gives you an easy way to request informations from Google.
     class Request
+      include Bubble::KnockKnock
+      include Bubble::KnockKnock::Exceptions
+      
       attr_reader :header
   
       # Finds the Singleton Connection and creates the header structure to requesting informations.
       def initialize
-        raise Bubble::KnockKnock::UnstablishedConnection if Bubble::KnockKnock::Connection.instance.auth.nil?
+        raise UnstablishedConnection if Connection.instance.auth.nil?
     
-        connection = Bubble::KnockKnock::Connection.instance
+        connection = Connection.instance
         @header = {'Cookie' => "Name=#{connection.auth};Auth=#{connection.auth};Domain=.google.com;Path=/;Expires=160000000000",
                    'Content-length' => '0',
                    'Authorization' => "GoogleLogin auth=#{connection.auth}"
@@ -23,8 +26,7 @@ module Bubble
       #
       #   Request.get('http://www.google.com/m8/feeds/contacts/email%40gmail.com/full')
       def self.get(uri, params=nil)
-        response, body = action(:get, uri, params)
-    
+        response, body = action(:get, uri, params)    
         body
       end
       
@@ -36,14 +38,32 @@ module Bubble
       #
       #   Request.post('http://www.google.com/m8/feeds/contacts/email%40gmail.com/full', body)      
       def self.post(uri, params=nil)
-        response, body = action(:post, uri, params)
-        
-        case response.code.to_i
-          when 400; raise BadRequest
-          when 409; raise HTTPConflict
-          when 201; body
-          else; response.code << ' => ' << body
-        end
+        @response, @body = action(:post, uri, params)        
+        handling
+      end
+      
+      # Delete data at any Google Service.
+      # You just need to indicate the URI of the API and also get the entity's ID you're trying to delete.
+      # For more information on how to get the entity's ID,go to google code and check it out.
+      # === Example
+      # You must to be connected. Take a look at Connection for more information.
+      #
+      #   Request.delete('http://www.google.com/m8/feeds/contacts/email%40gmail.com/full/6f669dbb0f3d75ce/1228698987605000')
+      def self.delete(uri,params=nil)
+        @response, body = action(:delete, uri, params)        
+        handling
+      end
+      
+      # Update data at any Google Service.
+      # You just need to indicate the URI of the API and also get the entity's ID you're trying to delete.
+      # For more information on how to get the entity's ID,go to google code and check it out.
+      # === Example
+      # You must to be connected. Take a look at Connection for more information.
+      #
+      #   Request.put('http://www.google.com/m8/feeds/contacts/email%40gmail.com/full/6f669dbb0f3d75ce/1228698987605000')      
+      def self.put(uri,params=nil)
+        @response, @body = action(:put, uri, params)        
+        handling
       end
       
       protected 
@@ -61,6 +81,10 @@ module Bubble
           @request.header.merge!('Content-Type' => 'application/atom+xml')
         when :get
           @request.header.merge!('Content-Type' => 'application/xml')
+        when :delete
+          @request.header.merge!('Content-Type' => 'application/atom+xml')
+        when :put
+          @request.header.merge!('X-HTTP-Method-Override' =>'PUT', 'Content-Type' => 'application/atom+xml')
         end
         
         @http = Net::HTTP.new(@uri.host, 443)
@@ -76,8 +100,24 @@ module Bubble
           @http.post(@uri.path, params, @request.header)
         when :get
           @http.get("#{@uri.path}?#{params}", @request.header)
+        when :delete
+          @http.delete(@uri.path, @request.header)
+        when :put
+          @http.post(@uri.path, params, @request.header)
         end
       end
+      
+      # Returns the request's response, might be a error or XML
+      def self.handling
+        
+        case @response.code.to_i
+          when 400; raise BadRequest
+          when 409; raise HTTPConflict
+          else; @body
+        end
+        
+      end
+      
     end
   end
 end

data/lib/knock_knock.rb

@@ -9,7 +9,7 @@ module Bubble
 
   # For more information take a look at the README
   module KnockKnock
-    VERSION = '0.1.3'
+    VERSION = '0.1.4'
     APP_NAME = 'KnockKnock Ruby Gem'
   end
 end

data/test/test_helper.rb

@@ -1,3 +1,4 @@
 require 'stringio'
 require 'test/unit'
+require File.dirname(__FILE__) + '/resources/contact'
 require File.dirname(__FILE__) + '/../lib/knock_knock'

data/test/test_knock_knock.rb

@@ -1,12 +1,15 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
 class TestKnockKnock < Test::Unit::TestCase # :nodoc:
+  include Bubble::KnockKnock
+  include Bubble::KnockKnock::Exceptions
+  
   def setup
-    @kk = Bubble::KnockKnock::Connection.instance
+    @kk = Connection.instance
   end
   
   def test_stablish_connection
-    assert_raise(Bubble::KnockKnock::BadLogin) { @kk.connect('test@gmail.com', 'password', 'xapi') }
+    assert_raise(BadLogin) { @kk.connect('test@gmail.com', 'password', 'xapi') }
     
     @kk.connect('bubble.testing@gmail.com', 'bubblerocks', 'cp')
     assert @kk.auth

data/test/test_request.rb

@@ -2,6 +2,7 @@ require File.dirname(__FILE__) + '/test_helper.rb'
 
 class Bubble::KnockKnock::TestRequest < Test::Unit::TestCase # :nodoc: #
   include Bubble::KnockKnock
+  include Bubble::KnockKnock::Exceptions
   
   def setup
     @atom = File.open(File.dirname(__FILE__) + "/fixtures/atom_feed.atom").readlines.join
@@ -10,18 +11,30 @@ class Bubble::KnockKnock::TestRequest < Test::Unit::TestCase # :nodoc: #
   
   def test_retrieving_data
     assert content = Request.get("http://www.google.com/m8/feeds/contacts/bubble.testing%40gmail.com/full")
-    assert_match(/^<\?xml.*/, content)
+    assert_match(/^<\?xml.*$/, content)
   end
   
-  def test_retrieving_post_feed
-    # Cause the contact is all right created, it can't be created again. Then a 409 occurs (HTTP Conflict).
-    # We need to implement the DELETE HTTP Method to delete this contact.
+  def test_deleting_contact
+    create_contact
     
-    assert_raise(HTTPConflict) do
-      Request.post("http://www.google.com/m8/feeds/contacts/bubble.testing%40gmail.com/full", @atom)
-    end
+    assert content = Request.delete(@contact.delete_uri)
+    assert_match(/^<\?xml.*$/, content)
   end
   
+  def test_updating_contact
+    create_contact
+    @contact.change_title
+    
+    content = Request.put(@contact.edit_uri,@contact.content)
+    assert_match(/^<\?xml.*$/, content)
+    
+    # Everytime you update something at Google, your edit url changes, which means 
+    # you have to instanciate a new contact in order to work
+    @contact = Contact.new(content)
+    assert content = Request.delete(@contact.delete_uri)
+    assert_match(/^<\?xml.*$/, content)
+  end
+    
   def test_bad_request
     bad_atom = @atom << "this_should_get a bad request" 
     
@@ -34,4 +47,9 @@ class Bubble::KnockKnock::TestRequest < Test::Unit::TestCase # :nodoc: #
   def authenticate
     Connection.instance.connect('bubble.testing@gmail.com', 'bubblerocks', 'cp')
   end
+  
+  def create_contact
+    @content = Request.post("http://www.google.com/m8/feeds/contacts/bubble.testing%40gmail.com/full", @atom)
+    @contact = Contact.new(@content)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: knock-knock
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Bruno Azisaka Maciel
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-07 00:00:00 -02:00
+date: 2008-12-08 00:00:00 -02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.1.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: xml-object
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.8
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -52,12 +62,10 @@ extensions: []
 extra_rdoc_files: 
 - History.txt
 - Manifest.txt
-- PostInstall.txt
 - README.rdoc
 files: 
 - History.txt
 - Manifest.txt
-- PostInstall.txt
 - README.rdoc
 - Rakefile
 - lib/knock_knock.rb