knock-knock 0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.1 2008-12-06
+
+* Singleton class for connection with Google
+* Request class for retrieve data from Google

data/Manifest.txt

@@ -0,0 +1,15 @@
+History.txt
+Manifest.txt
+PostInstall.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/README.rdoc

@@ -0,0 +1,47 @@
+= KnockKnock
+
+KnockKnock was made for turn login with Google Authentication API more easy.
+
+== Features
+* Singleton class for connection with Google.
+* Simple authentication and clear code.
+
+== Synopsis
+
+  require 'rubygems'
+  require 'knock_knock'
+  
+  include Bubble::KnockKnock
+  
+  Connection.connect('email@gmail.com', 'password', 'cp')
+  
+  print Request.get('http://www.google.com/m8/feeds/contacts/email%40gmail.com/full')
+
+== Install
+
+  sudo gem install knock-knock
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2008 Bruno Azisaka Maciel
+
+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.

data/Rakefile

@@ -0,0 +1,28 @@
+%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       = 'dookie' # TODO this is default value
+  p.extra_deps         = [
+    ['activesupport','>= 2.0.2'],
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  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/lib/bubble/knock_knock/connection.rb

@@ -0,0 +1,68 @@
+require 'singleton'
+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
+  
+  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
+    
+    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 for make the connection.
+  def setup
+    @uri = URI.parse('https://www.google.com/accounts/ClientLogin')
+  
+    @query = { 'accountType' => 'GOOGLE',
+               'Email' => @email,
+               'Passwd' => @password,
+               'service' => @service,
+               'source' => APP_NAME }
+                    
+    @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)
+  
+    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]
+  end
+end

data/lib/bubble/knock_knock/exceptions.rb

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

data/lib/bubble/knock_knock/hash.rb

@@ -0,0 +1,13 @@
+# 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
+  
+end
+
+class Hash
+  include Bubble::KnockKnock::Hash
+end

data/lib/bubble/knock_knock/request.rb

@@ -0,0 +1,34 @@
+# This class gives you a easy way to request informations from Google.
+class Bubble::KnockKnock::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?
+    
+    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
+
+  # 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
+    
+    uri = URI.parse(uri)
+                    
+    http = Net::HTTP.new(uri.host, 443)
+    http.use_ssl = true
+          
+    response, body = http.get("#{uri.path}?#{query}", @request.header)
+    
+    body
+  end
+end

data/lib/knock_knock.rb

@@ -0,0 +1,20 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'active_support'
+
+# A project developed by Bubble[http://bubble.com.br]
+module Bubble
+
+  # For more information take a look on README
+  module KnockKnock
+    VERSION = '0.1'
+    APP_NAME = 'KnockKnock Ruby Gem'
+  end
+end
+
+require File.dirname(__FILE__) + '/bubble/knock_knock/exceptions'
+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/script/console

@@ -0,0 +1,10 @@
+#!/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

@@ -0,0 +1,14 @@
+#!/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

@@ -0,0 +1,14 @@
+#!/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)

data/test/test_hash.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class Bubble::KnockKnock::TestHash < Test::Unit::TestCase # :nodoc:
+  def setup
+    @data = { :group=>'hour', 
+              :order=>'days_since_last_visit,bounce_rate' }
+  end
+    
+  def test_to_uri
+    assert_equal('group=hour&order=days_since_last_visit,bounce_rate', @data.to_uri)
+  end
+end

data/test/test_helper.rb

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

data/test/test_knock_knock.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestKnockKnock < Test::Unit::TestCase # :nodoc:
+  include Bubble::KnockKnock
+  
+  def setup
+    @kk = Connection.instance
+  end
+  
+  def test_stablish_connection
+    assert_raise(BadLogin) { @kk.connect('test@gmail.com', 'password', 'xapi') }
+    
+    authenticate
+    assert @kk.auth
+  end
+  
+  def test_retrieving_data
+    authenticate
+    
+    assert body = 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)
+  end
+  
+  private
+  def authenticate
+    @kk.connect('bubble.testing@gmail.com', 'bubblerocks', 'cp')
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: knock-knock
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Bruno Azisaka Maciel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-07 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: ""
+email: 
+- bruno@dookie.com.br
+executables: []
+
+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
+- 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
+has_rdoc: true
+homepage: KnockKnock was made for turn login with Google Authentication API more easy.
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: dookie
+rubygems_version: 1.3.0
+signing_key: 
+specification_version: 2
+summary: ""
+test_files: 
+- test/test_hash.rb
+- test/test_helper.rb
+- test/test_knock_knock.rb