knock-knock 0.1.2 → 0.1.3

data/History.txt

@@ -1,3 +1,8 @@
+== 0.1.3 2008-12-07
+
+* New features
+  * Post method supports
+
 == 0.1.2 2008-12-07
 
 * Bug fix

data/lib/bubble/knock_knock/exceptions.rb

@@ -5,6 +5,10 @@ module Bubble
     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

data/lib/bubble/knock_knock/hash.rb

@@ -5,7 +5,7 @@ module Bubble
   
       # Transforms the hash into a string which will be used to transmit data with the requests.
       def to_uri
-        self.map { |k,v| "#{k}=#{v}"}.join('&')
+        self.sort_by { |k,v| k.to_s }.map { |k,v| "#{k}=#{v}"}.join('&')
       end
   
     end

data/lib/bubble/knock_knock/request.rb

@@ -11,7 +11,8 @@ module Bubble
         connection = Bubble::KnockKnock::Connection.instance
         @header = {'Cookie' => "Name=#{connection.auth};Auth=#{connection.auth};Domain=.google.com;Path=/;Expires=160000000000",
                    'Content-length' => '0',
-                   'Authorization' => "GoogleLogin auth=#{connection.auth}" }
+                   'Authorization' => "GoogleLogin auth=#{connection.auth}"
+                   }
       end
 
       # Get the data from any Google Service.
@@ -21,18 +22,62 @@ module Bubble
       # You must to be connected. Take a look in Connection for more information.
       #
       #   Request.get('http://www.google.com/m8/feeds/contacts/email%40gmail.com/full')
-      def self.get(uri, query=nil)
-        @request = self.new
-    
-        uri = URI.parse(uri)
-                    
-        http = Net::HTTP.new(uri.host, 443)
-        http.use_ssl = true
-          
-        response, body = http.get("#{uri.path}?#{query}", @request.header)
+      def self.get(uri, params=nil)
+        response, body = action(:get, uri, params)
     
         body
       end
+      
+      # Post data to any Google Service.
+      # You just need to indicate the URI of the API and the attributes must that be sent in the request's body.
+      # A Status code 201 CREATED will be return in case everything goes as planned!
+      # === Example
+      # You must to be connected. Take a look at Connection for more information.
+      #
+      #   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
+      end
+      
+      protected 
+      
+      # Generates the basic setup for both GET and POST requests(later on PUT and DELETE also). Any request at Google's services
+      # must have SSL activated.
+      # POST requests at Google always use atom+xml as their content type default.
+      def self.setup(http_method, uri)
+        
+        @request = self.new
+        @uri = URI.parse(uri)
+        
+        case http_method
+        when :post
+          @request.header.merge!('Content-Type' => 'application/atom+xml')
+        when :get
+          @request.header.merge!('Content-Type' => 'application/xml')
+        end
+        
+        @http = Net::HTTP.new(@uri.host, 443)
+        @http.use_ssl = true        
+      end
+      
+      # Responsible by makes the right request when the developer points the HTTP Method (Post, Get), adding the parameters and the right header.
+      def self.action(http_method, uri, params)
+        setup(http_method, uri)
+        
+        case http_method
+        when :post
+          @http.post(@uri.path, params, @request.header)
+        when :get
+          @http.get("#{@uri.path}?#{params}", @request.header)
+        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.2'
+    VERSION = '0.1.3'
     APP_NAME = 'KnockKnock Ruby Gem'
   end
 end

data/test/test_knock_knock.rb

@@ -8,20 +8,7 @@ class TestKnockKnock < Test::Unit::TestCase # :nodoc:
   def test_stablish_connection
     assert_raise(Bubble::KnockKnock::BadLogin) { @kk.connect('test@gmail.com', 'password', 'xapi') }
     
-    authenticate
-    assert @kk.auth
-  end
-  
-  def test_retrieving_data
-    authenticate
-    
-    assert body = Bubble::KnockKnock::Request.get("http://www.google.com/m8/feeds/contacts/bubble.testing%40gmail.com/full")
-    assert_match(/^<\?xml.*/, body)
-    assert_equal(@kk.auth, Bubble::KnockKnock::Connection.instance.auth)
-  end
-  
-  private
-  def authenticate
     @kk.connect('bubble.testing@gmail.com', 'bubblerocks', 'cp')
+    assert @kk.auth
   end
-end
+end

data/test/test_request.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class Bubble::KnockKnock::TestRequest < Test::Unit::TestCase # :nodoc: #
+  include Bubble::KnockKnock
+  
+  def setup
+    @atom = File.open(File.dirname(__FILE__) + "/fixtures/atom_feed.atom").readlines.join
+    authenticate
+  end
+  
+  def test_retrieving_data
+    assert content = Request.get("http://www.google.com/m8/feeds/contacts/bubble.testing%40gmail.com/full")
+    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.
+    
+    assert_raise(HTTPConflict) do
+      Request.post("http://www.google.com/m8/feeds/contacts/bubble.testing%40gmail.com/full", @atom)
+    end
+  end
+  
+  def test_bad_request
+    bad_atom = @atom << "this_should_get a bad request" 
+    
+    assert_raise(BadRequest) do
+      Request.post("http://www.google.com/m8/feeds/contacts/bubble.testing%40gmail.com/full", bad_atom)    
+    end
+  end
+  
+  private
+  def authenticate
+    Connection.instance.connect('bubble.testing@gmail.com', 'bubblerocks', 'cp')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: knock-knock
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Bruno Azisaka Maciel
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: knock-knock
-rubygems_version: 1.3.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: ""
@@ -101,3 +101,4 @@ test_files:
 - test/test_hash.rb
 - test/test_helper.rb
 - test/test_knock_knock.rb
+- test/test_request.rb