knock-knock 0.1.5 → 0.1.6

data/History.txt

@@ -1,3 +1,8 @@
+== 0.1.6 2008-12-24
+* Refatoring
+* New features
+  * Added Services module with Google Services code shortcuts
+  
 == 0.1.5 2008-12-24
 * New features
   * Connection with any Google Accounts, even Hosted Google Accounts

data/README.rdoc

@@ -6,7 +6,7 @@ KnockKnock was made to turn login with Google Authentication API easier.
 * Singleton class for connection with Google.
 * Simple authentication and clear code.
 * GET, POST, PUT, DELETE method implemented
-* Connection with any Google Account, even (Hosted Google Accounts)[http://google.com/a]
+* Connection with any Google Account, even Hosted Google Accounts[http://google.com/a]
 
 == Synopsis
 
@@ -15,16 +15,20 @@ KnockKnock was made to turn login with Google Authentication API easier.
   
   include Bubble::KnockKnock
   
-  Connection.instance.connect('email@gmail.com', 'password', 'cp')
+  Connection.connect('email@gmail.com', 'password', Services::GoogleContacts)
   
   print Request.get('http://www.google.com/m8/feeds/contacts/email%40gmail.com/full')
 
+== Services
+
+All the API for any Google Service works with KnockKnock. You can check the Services[http://knock-knock.rubyforge.org/rdoc/classes/Bubble/KnockKnock/Services.html] module to see some examples.
+
 == Install
 
   sudo gem install knock-knock
 
 == Contributors
-* (Jonathan Towell)[http://moxiemachine.com/blog]
+* Jonathan Towell (http://moxiemachine.com/blog)
 
 == License
 

data/lib/bubble/knock_knock/connection.rb

@@ -26,6 +26,16 @@ module Bubble
       #   require 'knock_knock'
       #   
       #   Bubble::KnockKnock::Connection.connect('email@gmail.com', 'password', 'cp')
+      def self.connect(email, password, service)
+        instance.connect(email, password, service)
+      end
+      
+      # Retrieve the Auth Token required for authentications on all Google Services.
+      def self.auth
+        instance.auth
+      end
+
+      # This method creates the connection, but internally. To create the connection you must use Connection.connect() method.
       def connect(email, password, service)
         @email = email
         @password = password
@@ -34,14 +44,8 @@ module Bubble
         setup
         stablish
       end
-  
-      # Retrieve the Auth Token required for authentications on all Google Services.
-      def auth
-        @auth
-      end
 
       protected
-  
       # It gives the correct values to attributes and variables required to make the connection.
       # You can connect with any Google Account, even it's a hosted account (thanks, Jonathan Towell)
       def setup

data/lib/bubble/knock_knock/request.rb

@@ -9,13 +9,11 @@ module Bubble
   
       # Finds the Singleton Connection and creates the header structure to requesting informations.
       def initialize
-        raise UnstablishedConnection if Connection.instance.auth.nil?
-    
-        connection = Connection.instance
-        @header = {'Cookie' => "Name=#{connection.auth};Auth=#{connection.auth};Domain=.google.com;Path=/;Expires=160000000000",
+        raise UnstablishedConnection if Connection.auth.nil?
+      
+        @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.

data/lib/bubble/knock_knock/services.rb

@@ -0,0 +1,36 @@
+module Bubble
+  module KnockKnock
+    
+    # This module helps the developer to use many Google Services
+    module Services
+      
+      # http://code.google.com/apis/contacts/docs/2.0/developers_guide_protocol.html#client_login
+      GoogleContacts = 'cp'
+      
+      # http://code.google.com/apis/calendar/docs/2.0/developers_guide_protocol.html#AuthClientLogin
+      GoogleCalendar = 'cl'
+      
+      # http://code.google.com/apis/apps/gdata_provisioning_api_v2.0_reference.html#Authentication
+      GoogleApps = 'apps'
+  
+      # http://code.google.com/apis/finance/developers_guide_protocol.html#ClientLogin
+      GoogleFinance = 'finance'
+      
+      # http://code.google.com/apis/spreadsheets/docs/2.0/developers_guide_protocol.html#Authenticating
+      GoogleSpreadsheets = 'wise'
+      
+      # http://code.google.com/apis/documents/docs/2.0/developers_guide_protocol.html#AuthClientLogin
+      GoogleDocuments = 'writely'
+      
+      # http://code.google.com/apis/blogger/docs/2.0/developers_guide_protocol.html#ClientLogin
+      Blogger = 'blogger'
+      
+      # http://code.google.com/apis/youtube/2.0/developers_guide_protocol_clientlogin.html#ClientLogin_Authentication
+      Youtube = 'youtube'
+      
+      # http://code.google.com/apis/picasaweb/developers_guide_protocol.html#ClientLogin
+      Picasa = 'picasa'
+      
+    end
+  end
+end

data/lib/knock_knock.rb

@@ -9,12 +9,13 @@ module Bubble
 
   # For more information take a look at the README
   module KnockKnock
-    VERSION = '0.1.5'
+    VERSION = '0.1.6'
     APP_NAME = 'KnockKnock Ruby Gem'
   end
 end
 
 require File.dirname(__FILE__) + '/bubble/knock_knock/exceptions'
+require File.dirname(__FILE__) + '/bubble/knock_knock/services'
 require File.dirname(__FILE__) + '/bubble/knock_knock/hash'
 require File.dirname(__FILE__) + '/bubble/knock_knock/connection'
 require File.dirname(__FILE__) + '/bubble/knock_knock/request'

data/test/test_knock_knock.rb

@@ -4,19 +4,15 @@ class TestKnockKnock < Test::Unit::TestCase # :nodoc:
   include Bubble::KnockKnock
   include Bubble::KnockKnock::Exceptions
   
-  def setup
-    @kk = Connection.instance
-  end
-  
   def test_stablish_connection
-    assert_raise(BadLogin) { @kk.connect('test@gmail.com', 'password', 'xapi') }
+    assert_raise(BadLogin) { Connection.connect('test@gmail.com', 'password', 'xapi') }
     
-    @kk.connect('bubble.testing@gmail.com', 'bubblerocks', 'cp')
-    assert google = @kk.auth
+    Connection.connect('bubble.testing@gmail.com', 'bubblerocks', Services::GoogleContacts)
+    assert google = Connection.auth
     
     # Test with a hosted Google Account
-    @kk.connect('test@bubble.com.br', 'B48938', 'cp')
-    assert @kk.auth
-    assert @kk.auth != google
+    Connection.connect('test@bubble.com.br', 'B48938', Services::GoogleApps)
+    assert Connection.auth
+    assert Connection.auth != google
   end
 end

data/test/test_request.rb

@@ -45,7 +45,7 @@ class Bubble::KnockKnock::TestRequest < Test::Unit::TestCase # :nodoc: #
   
   private
   def authenticate
-    Connection.instance.connect('bubble.testing@gmail.com', 'bubblerocks', 'cp')
+    Connection.connect('bubble.testing@gmail.com', 'bubblerocks', 'cp')
   end
   
   def create_contact

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: knock-knock
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors: 
 - Bruno Azisaka Maciel
@@ -61,23 +61,16 @@ extensions: []
 
 extra_rdoc_files: 
 - History.txt
-- Manifest.txt
 - README.rdoc
 files: 
 - History.txt
-- Manifest.txt
 - README.rdoc
-- Rakefile
 - lib/knock_knock.rb
 - lib/bubble/knock_knock/connection.rb
 - lib/bubble/knock_knock/exceptions.rb
 - lib/bubble/knock_knock/hash.rb
 - lib/bubble/knock_knock/request.rb
-- script/console
-- script/destroy
-- script/generate
-- test/test_helper.rb
-- test/test_knock_knock.rb
+- lib/bubble/knock_knock/services.rb
 has_rdoc: true
 homepage: KnockKnock was made to turn login with Google Authentication API easier.
 post_install_message: 

data/Manifest.txt

@@ -1,14 +0,0 @@
-History.txt
-Manifest.txt
-README.rdoc
-Rakefile
-lib/knock_knock.rb
-lib/bubble/knock_knock/connection.rb
-lib/bubble/knock_knock/exceptions.rb
-lib/bubble/knock_knock/hash.rb
-lib/bubble/knock_knock/request.rb
-script/console
-script/destroy
-script/generate
-test/test_helper.rb
-test/test_knock_knock.rb

data/Rakefile

@@ -1,29 +0,0 @@
-%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
-require File.dirname(__FILE__) + '/lib/knock_knock'
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.new('knock-knock', Bubble::KnockKnock::VERSION) do |p|
-  p.developer('Bruno Azisaka Maciel', 'bruno@dookie.com.br')
-  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  # 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']
-  ]
-  p.extra_dev_deps = [
-    ['newgem', ">= #{::Newgem::VERSION}"],
-    ['xml-object', '>= 0.9.8']
-  ]
-  
-  p.clean_globs |= %w[**/.DS_Store tmp *.log]
-  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
-  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
-  p.rsync_args = '-av --delete --ignore-errors'
-end
-
-require 'newgem/tasks' # load /tasks/*.rake
-Dir['tasks/**/*.rake'].each { |t| load t }
-
-# TODO - want other tests/tasks run by default? Add them to the list
-# task :default => [:spec, :features]

data/script/console

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-# File: script/console
-irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
-
-libs =  " -r irb/completion"
-# Perhaps use a console_lib to store any extra methods I may want available in the cosole
-# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
-libs <<  " -r #{File.dirname(__FILE__) + '/../lib/knock_knock.rb'}"
-puts "Loading knock_knock gem"
-exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-
-begin
-  require 'rubigen'
-rescue LoadError
-  require 'rubygems'
-  require 'rubigen'
-end
-require 'rubigen/scripts/destroy'
-
-ARGV.shift if ['--help', '-h'].include?(ARGV[0])
-RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
-RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-
-begin
-  require 'rubigen'
-rescue LoadError
-  require 'rubygems'
-  require 'rubigen'
-end
-require 'rubigen/scripts/generate'
-
-ARGV.shift if ['--help', '-h'].include?(ARGV[0])
-RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
-RubiGen::Scripts::Generate.new.run(ARGV)