google_calendar 0.1.2 → 0.1.3

data/README.rdoc

@@ -5,13 +5,15 @@ A fast lightweight and minimalist wrapper around the google calendar api.
 == Install
   [sudo] gem install 'google_calendar'
 
-Note: Make sure to customize the APP_NAME constant in the Connection class.
+Note: Google requests that you set the name of your application so they can better monitor the use of their services.
 
 == Usage
   require 'rubygems'
   require 'google_calendar'
 
-  cal = Google::Calendar.new(:username => 'some.person@gmail.com', :password => 'super-secret')
+  cal = Google::Calendar.new(:username => 'some.person@gmail.com',
+                             :password => 'super-secret',
+                             :app_name => 'mycompany.com-googlecalendar-integration')
 
   event = cal.create_event do |e|
     e.title = 'A Cool Event'

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/google_calendar.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{google_calendar}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Steve Zich"]
-  s.date = %q{2011-01-06}
+  s.date = %q{2011-01-28}
   s.description = %q{A minimal wrapper around the google calendar API, which uses nokogiri for fast parsing.}
   s.email = %q{steve.zich@gmail.com}
   s.extra_rdoc_files = [
@@ -42,7 +42,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/northworld/google_calendar}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.4.1}
+  s.rubygems_version = %q{1.4.2}
   s.summary = %q{A lightweight google calendar API wrapper}
   s.test_files = [
     "test/helper.rb",

data/lib/google/calendar.rb

@@ -10,6 +10,8 @@ module Google
     # * :username => the username of the specified calendar (i.e. some.guy@gmail.com)
     # * :password => the password for the specified user (i.e. super-secret)
     # * :calendar => the name of the calendar you would like to work with (optional, defaults to the calendar the user setup as their default one.)
+    # * :app_name => the name of your application (defaults to 'northworld.com-googlecalendar-integration')
+    # * :auth_url => the base url that is used to connect to google (defaults to 'https://www.google.com/accounts/ClientLogin')
     #
     # After creating an instace you are immediatly logged on and ready to go.
     #
@@ -20,12 +22,20 @@ module Google
     #   # Specify the calendar
     #   Calendar.new(username: => 'some.guy@gmail.com', :password => 'ilovepie!', :calendar => 'my.company@gmail.com')
     #
+    #   # Specify the app_name
+    #   Calendar.new(username: => 'some.guy@gmail.com', :password => 'ilovepie!', :app_name => 'mycompany.com-googlecalendar-integration')
+    #
     def initialize(params)
       username = params[:username]
       password = params[:password]
       @calendar = params[:calendar]
+      app_name = params[:app_name]
+      auth_url = params[:auth_url]
 
-      @connection = Connection.new(:username => username, :password => password)
+      @connection = Connection.new(:username => username,
+                                   :password => password,
+                                   :app_name => app_name,
+                                   :auth_url => auth_url)
     end
 
     # Find all of the events associated with this calendar.

data/lib/google/connection.rb

@@ -7,14 +7,13 @@ module Google
   # communication with the google calendar api.
   #
   class Connection
-    AUTH_URL = "https://www.google.com/accounts/ClientLogin"
-    APP_NAME = "northworld.com-googlecalendar-integration"
-
-    # set the username and password and login.
+    # set the username, password, auth_url, app_name, and login.
     #
     def initialize(params)
       @username = params[:username]
       @password = params[:password]
+      @auth_url = params[:auth_url] || "https://www.google.com/accounts/ClientLogin"
+      @app_name = params[:app_name] || "northworld.com-googlecalendar-integration"
 
       login()
     end
@@ -25,11 +24,11 @@ module Google
       content = {
         'Email' => @username,
         'Passwd' => @password,
-        'source' => APP_NAME,
+        'source' => @app_name,
         'accountType' => 'HOSTED_OR_GOOGLE',
         'service' => 'cl'}
 
-      response = send(Addressable::URI.parse(AUTH_URL), :post_form, content)
+      response = send(Addressable::URI.parse(@auth_url), :post_form, content)
 
       raise HTTPRequestFailed unless response.kind_of? Net::HTTPSuccess
 

data/test/test_google_calendar.rb

@@ -31,6 +31,42 @@ class TestGoogleCalendar < Test::Unit::TestCase
           Calendar.new(:username => 'some.one@gmail.com', :password => 'wrong-password')
         end
       end
+      
+      should "login properly with an app_name" do 
+        assert_nothing_thrown do
+          Calendar.new(:username => 'some.one@gmail.com', :password => 'super-secret', 
+            :app_name => 'northworld.com-googlecalendar-integration'
+          )
+        end
+      end
+      
+      should "catch login with invalid app_name" do 
+          @http_mock.stubs(:kind_of?).with(Net::HTTPForbidden).returns(true)
+          @http_mock.stubs(:body).returns('Error=BadAuthentication')
+          assert_raise(HTTPAuthorizationFailed) do
+            Calendar.new(:username => 'some.one@gmail.com', :password => 'super-secret', 
+              :app_name => 'northworld.com-silly-cal'
+            )
+          end
+        end 
+        
+        should "login properly with an auth_url" do 
+          assert_nothing_thrown do
+            Calendar.new(:username => 'some.one@gmail.com', :password => 'super-secret', 
+              :auth_url => "https://www.google.com/accounts/ClientLogin"
+            )
+          end
+        end
+
+        should "catch login with invalid auth_url" do 
+            @http_mock.stubs(:kind_of?).with(Net::HTTPForbidden).returns(true)
+            @http_mock.stubs(:body).returns('Error=BadAuthentication')
+            assert_raise(HTTPAuthorizationFailed) do
+              Calendar.new(:username => 'some.one@gmail.com', :password => 'super-secret', 
+                :auth_url => "https://www.google.com/accounts/ClientLogin/waffles"
+              )
+            end
+          end               
 
     end # login context
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: google_calendar
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: 
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Steve Zich
@@ -15,10 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-06 00:00:00 -08:00
+date: 2011-01-28 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  type: :runtime
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -33,8 +34,8 @@ dependencies:
   requirement: *id001
   prerelease: false
   name: nokogiri
-  type: :runtime
 - !ruby/object:Gem::Dependency 
+  type: :runtime
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -49,8 +50,8 @@ dependencies:
   requirement: *id002
   prerelease: false
   name: addressable
-  type: :runtime
 - !ruby/object:Gem::Dependency 
+  type: :development
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -63,8 +64,8 @@ dependencies:
   requirement: *id003
   prerelease: false
   name: shoulda
-  type: :development
 - !ruby/object:Gem::Dependency 
+  type: :development
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -79,8 +80,8 @@ dependencies:
   requirement: *id004
   prerelease: false
   name: bundler
-  type: :development
 - !ruby/object:Gem::Dependency 
+  type: :development
   version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -95,8 +96,8 @@ dependencies:
   requirement: *id005
   prerelease: false
   name: jeweler
-  type: :development
 - !ruby/object:Gem::Dependency 
+  type: :development
   version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -109,8 +110,8 @@ dependencies:
   requirement: *id006
   prerelease: false
   name: rcov
-  type: :development
 - !ruby/object:Gem::Dependency 
+  type: :development
   version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -123,7 +124,6 @@ dependencies:
   requirement: *id007
   prerelease: false
   name: mocha
-  type: :development
 description: A minimal wrapper around the google calendar API, which uses nokogiri for fast parsing.
 email: steve.zich@gmail.com
 executables: []
@@ -185,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.1
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: A lightweight google calendar API wrapper