knock-knock 0.1.1 → 0.1.2

data/History.txt

@@ -1,3 +1,8 @@
+== 0.1.2 2008-12-07
+
+* Bug fix
+  * Fixing a problem with namespaces
+
 == 0.1.1 2008-12-07
 
 * Bug fix

data/README.rdoc

@@ -1,6 +1,6 @@
 = KnockKnock
 
-KnockKnock was made for turn login with Google Authentication API more easy.
+KnockKnock was made to turn login with Google Authentication API easier.
 
 == Features
 * Singleton class for connection with Google.
@@ -25,7 +25,7 @@ KnockKnock was made for turn login with Google Authentication API more easy.
 
 (The MIT License)
 
-Copyright (c) 2008 Bruno Azisaka Maciel
+Copyright (c) 2008 Bubble[http://bubble.com.br]
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/bubble/knock_knock/connection.rb

@@ -3,66 +3,71 @@ require 'uri'
 require 'net/http'
 require 'net/https'
 
-# This class make the connection between Ruby and Google.
-# It's a Singleton class, turning the management of the connection more easy. Just one connection will be created during all your script.
-class Bubble::KnockKnock::Connection
-  include Singleton
+module Bubble
+  module KnockKnock
+
+    # This class make the connection between Ruby and Google.
+    # 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
   
-  attr_accessor :email, :service
-  attr_reader :password, :auth
+      attr_accessor :email, :service
+      attr_reader :password, :auth
 
-  # This method create the connection. First of all it set up the environment for make the connection and after it stablish the connection with Google
-  # The service should be (i.e.):
-  # * [cp] Google Mail Contact Book
-  # * [analytics] Google Analytics
-  #
-  # === Example
-  #   require 'rubygems'
-  #   require 'knock_knock'
-  #   
-  #   Bubble::KnockKnock::Connection.connect('email@gmail.com', 'password', 'cp')
-  def connect(email, password, service)
-    @email = email
-    @password = password
-    @service = service
+      # This method creates the connection. First of all it set up the environment to make the connection and after it stablish the connection with Google
+      # The service should be (i.e.):
+      # * [cp] Google Mail Contact Book
+      # * [analytics] Google Analytics
+      #
+      # === Example
+      #   require 'rubygems'
+      #   require 'knock_knock'
+      #   
+      #   Bubble::KnockKnock::Connection.connect('email@gmail.com', 'password', 'cp')
+      def connect(email, password, service)
+        @email = email
+        @password = password
+        @service = service
     
-    setup
-    stablish
-  end
+        setup
+        stablish
+      end
   
-  # Retrieve the Auth Token required for authentications on all Google Services.
-  def auth
-    @auth
-  end
+      # Retrieve the Auth Token required for authentications on all Google Services.
+      def auth
+        @auth
+      end
 
-  protected
+      protected
   
-  # It gives the correct values to attributes and variables required for make the connection.
-  def setup
-    @uri = URI.parse('https://www.google.com/accounts/ClientLogin')
+      # It gives the correct values to attributes and variables required to make the connection.
+      def setup
+        @uri = URI.parse('https://www.google.com/accounts/ClientLogin')
   
-    @query = { 'accountType' => 'GOOGLE',
-               'Email' => @email,
-               'Passwd' => @password,
-               'service' => @service,
-               'source' => Bubble::KnockKnock::APP_NAME }
+        @query = { 'accountType' => 'GOOGLE',
+                   'Email' => @email,
+                   'Passwd' => @password,
+                   'service' => @service,
+                   'source' => Bubble::KnockKnock::APP_NAME }
                     
-    @http = Net::HTTP.new(@uri.host, 443)
-    @http.use_ssl = true
-  end
+        @http = Net::HTTP.new(@uri.host, 443)
+        @http.use_ssl = true
+      end
 
-  # Makes the connection with Google. If the login and password are wrong an BadLogin exception occours.
-  def stablish
-    response, body = @http.post(@uri.path, @query.to_uri)
+      # Makes the connection with Google. If the login and password are wrong a BadLogin exception occurs.
+      def stablish
+        response, body = @http.post(@uri.path, @query.to_uri)
   
-    case response.code.to_i
-      when 403; raise BadLogin
-      else; parse(body)
-    end
-  end
+        case response.code.to_i
+          when 403; raise BadLogin
+          else; parse(body)
+        end
+      end
 
-  # Gives the Auth Token from authentication request.
-  def parse(body)
-     @auth = body.match(/Auth=(.*)/)[1]
+      # Gives the Auth Token from authentication request.
+      def parse(body)
+         @auth = body.match(/Auth=(.*)/)[1]
+      end
+    end
   end
 end

data/lib/bubble/knock_knock/exceptions.rb

@@ -1,4 +1,10 @@
-# For login errors
-class Bubble::KnockKnock::BadLogin < Exception; end
-# For requests to Google services without a connection
-class Bubble::KnockKnock::UnstablishedConnection < Exception; end
+module Bubble
+  module KnockKnock
+
+    # For login errors
+    class BadLogin < Exception; end
+    # For requests to Google services without a connection
+    class UnstablishedConnection < Exception; end
+    
+  end
+end

data/lib/bubble/knock_knock/hash.rb

@@ -1,11 +1,15 @@
-# A collection of util methods for KnockKnock gem
-module Bubble::KnockKnock::Hash
+module Bubble
+  module KnockKnock
+    # A collection of util methods for KnockKnock gem
+    module Bubble::KnockKnock::Hash
   
-  # Transforms the hash into to a string which will be used to transmit data with the requests.
-  def to_uri
-    self.map { |k,v| "#{k}=#{v}"}.join('&')
-  end
+      # 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('&')
+      end
   
+    end
+  end
 end
 
 class Hash

data/lib/bubble/knock_knock/request.rb

@@ -1,34 +1,38 @@
-# This class gives you a easy way to request informations from Google.
-class Bubble::KnockKnock::Request
-  attr_reader :header
+module Bubble
+  module KnockKnock
+    # This class gives you an easy way to request informations from Google.
+    class Request
+      attr_reader :header
   
-  # Finds the Singleton Connection and creates the header structure to requesting informations.
-  def initialize
-    raise UnstablishedConnection if Connection.instance.auth.nil?
+      # 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?
     
-    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}" }
-  end
+        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}" }
+      end
 
-  # Get the data from any Google Service.
-  # You just need to indicate the URI of the API and the attributes must be sent with the request.
-  # The content of the response will be returned if all occour as well.
-  # === Example
-  # 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
+      # Get the data from any Google Service.
+      # You just need to indicate the URI of the API and the attributes must that be sent with the request.
+      # The response's content will be returned if all occur as well.
+      # === Example
+      # 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)
+        uri = URI.parse(uri)
                     
-    http = Net::HTTP.new(uri.host, 443)
-    http.use_ssl = true
+        http = Net::HTTP.new(uri.host, 443)
+        http.use_ssl = true
           
-    response, body = http.get("#{uri.path}?#{query}", @request.header)
+        response, body = http.get("#{uri.path}?#{query}", @request.header)
     
-    body
+        body
+      end
+    end
   end
 end

data/lib/knock_knock.rb

@@ -7,9 +7,9 @@ require 'active_support'
 # A project developed by Bubble[http://bubble.com.br]
 module Bubble
 
-  # For more information take a look on README
+  # For more information take a look at the README
   module KnockKnock
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
     APP_NAME = 'KnockKnock Ruby Gem'
   end
 end

data/test/test_knock_knock.rb

@@ -1,14 +1,12 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
 class TestKnockKnock < Test::Unit::TestCase # :nodoc:
-  include Bubble::KnockKnock
-  
   def setup
-    @kk = Connection.instance
+    @kk = Bubble::KnockKnock::Connection.instance
   end
   
   def test_stablish_connection
-    assert_raise(BadLogin) { @kk.connect('test@gmail.com', 'password', 'xapi') }
+    assert_raise(Bubble::KnockKnock::BadLogin) { @kk.connect('test@gmail.com', 'password', 'xapi') }
     
     authenticate
     assert @kk.auth
@@ -17,9 +15,9 @@ class TestKnockKnock < Test::Unit::TestCase # :nodoc:
   def test_retrieving_data
     authenticate
     
-    assert body = Request.get("http://www.google.com/m8/feeds/contacts/bubble.testing%40gmail.com/full")
+    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, Connection.instance.auth)
+    assert_equal(@kk.auth, Bubble::KnockKnock::Connection.instance.auth)
   end
   
   private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: knock-knock
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Bruno Azisaka Maciel
@@ -71,7 +71,7 @@ files:
 - test/test_helper.rb
 - test/test_knock_knock.rb
 has_rdoc: true
-homepage: KnockKnock was made for turn login with Google Authentication API more easy.
+homepage: KnockKnock was made to turn login with Google Authentication API easier.
 post_install_message: 
 rdoc_options: 
 - --main