google_calendar 0.6.2 → 0.7.0

data/test/test_google_calendar.rb

@@ -13,38 +13,69 @@ class TestGoogleCalendar < Minitest::Test
       @refresh_token = ENV['REFRESH_TOKEN']
       @calendar_id = ENV['CALENDAR_ID']
       @access_token = ENV['ACCESS_TOKEN']
+      @redirect_url = ENV['REDIRECT_URL']
 
-      @calendar = Calendar.new(:client_id => @client_id, :client_secret => @client_secret, :redirect_url => ENV['REDIRECT_URL'], :refresh_token => @refresh_token, :calendar => @calendar_id)
+      @calendar = Calendar.new(:client_id => @client_id, :client_secret => @client_secret, :redirect_url => @redirect_url, :refresh_token => @refresh_token, :calendar => @calendar_id)
 
     end
 
     context "a calendar" do
 
       should "generate auth url" do
-        assert_equal @calendar.authorize_url.to_s, 'https://accounts.google.com/o/oauth2/auth?access_type=offline&client_id=671053090364-ntifn8rauvhib9h3vnsegi6dhfglk9ue.apps.googleusercontent.com&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=code&scope=https://www.googleapis.com/auth/calendar'
+        assert_equal @calendar.authorize_url.to_s, 'https://accounts.google.com/o/oauth2/auth?access_type=offline&client_id=671053090364-ntifn8rauvhib9h3vnsegi6dhfglk9ue.apps.googleusercontent.com&redirect_uri=https://mytesturl.com/&response_type=code&scope=https://www.googleapis.com/auth/calendar'
       end
 
       should "login with auth code" do
         @client_mock.stubs(:body).returns( get_mock_body("login_with_auth_code_success.json") )
         @calendar.login_with_auth_code('4/QzBU-n6GXnHUkorG0fiu6AhoZtIjW53qKLOREiJWFpQ.wn0UfiyaDlEfEnp6UAPFm0EazsV1kwI')
-        assert_equal @calendar.auth_code, nil # the auth_code is discarded after it is used.
+        assert_nil @calendar.auth_code # the auth_code is discarded after it is used.
         assert_equal @calendar.access_token, @access_token
         assert_equal @calendar.refresh_token, '1/aJUy7pQzc4fUMX89BMMLeAfKcYteBKRMpQvf4fQFX0'
       end
 
       should "login with refresh token" do
         # no refresh_token specified
-        cal = Calendar.new(:client_id => @client_id, :client_secret => @client_secret, :redirect_url => "urn:ietf:wg:oauth:2.0:oob", :calendar => @calendar_id)
+        cal = Calendar.new(:client_id => @client_id, :client_secret => @client_secret, :redirect_url => @redirect_url, :calendar => @calendar_id)
         @client_mock.stubs(:body).returns( get_mock_body("login_with_refresh_token_success.json") )
         cal.login_with_refresh_token(@refresh_token)
         assert_equal @calendar.access_token, @access_token
       end
 
+      should "login with get method" do
+        cal = Calendar.get(:client_id => @client_id, :client_secret => @client_secret, :redirect_url => @redirect_url,
+                           :calendar => @calendar_id, :refresh_token  => @refresh_token)
+        @client_mock.stubs(:body).returns( get_mock_body("get_calendar.json") )
+        assert_equal cal.id, @calendar_id
+      end
+
+      should "update calendar" do
+        cal = Calendar.get(:client_id => @client_id, :client_secret => @client_secret, :redirect_url => @redirect_url,
+                           :calendar => @calendar_id, :refresh_token  => @refresh_token)
+        @client_mock.stubs(:body).returns( get_mock_body("update_calendar.json") )
+        cal.update(:summary => 'Our Company', :description => "Work event list")
+        assert_equal @calendar.id, @calendar_id
+      end
+
+      should "create calendar" do
+        cal = Calendar.create(:client_id => @client_id, :client_secret => @client_secret, :redirect_url => @redirect_url,
+                              :refresh_token  => @refresh_token, :summary => 'A New Calendar', :description => 'Our new calendar')
+        assert_equal cal.summary, 'A New Calendar'
+      end
+
+      should "destroy a calendar" do
+        reusable_connection = mock('Google::Connection')
+        reusable_connection.expects(:send).with("/calendars/#{@calendar_id}", :delete, '').returns(@client_mock)
+
+        calendar = Calendar.new({:calendar => @calendar_id}, reusable_connection)
+        calendar.destroy
+      end
+
       should "catch login with invalid credentials" do
         @client_mock.stubs(:status).returns(403)
         @client_mock.stubs(:body).returns( get_mock_body("403.json") )
         assert_raises(HTTPAuthorizationFailed) do
-          Calendar.new(:client_id => 'abadid', :client_secret => 'abadsecret', :redirect_url => "urn:ietf:wg:oauth:2.0:oob", :refresh_token => @refresh_token, :calendar => @calendar_id)
+          Calendar.new(:client_id => 'abadid', :client_secret => 'abadsecret', :redirect_url => @redirect_url,
+                       :refresh_token => @refresh_token, :calendar => @calendar_id)
         end
       end
 
@@ -65,11 +96,29 @@ class TestGoogleCalendar < Minitest::Test
         calendar.events
       end
 
+      should "throw ForbiddenError if not logged in" do
+        @client_mock.stubs(:status).returns(403)
+        @client_mock.stubs(:body).returns( get_mock_body("403_forbidden.json") )
+
+        assert_raises(ForbiddenError) do
+          @calendar.find_event_by_id('1234')
+        end
+      end
+
+      should "throw ForbiddenError if unknown 403 response" do
+        @client_mock.stubs(:status).returns(403)
+        @client_mock.stubs(:body).returns( get_mock_body("403_unknown.json") )
+
+        assert_raises(ForbiddenError) do
+          @calendar.find_event_by_id('1234')
+        end
+      end
+
     end # login context
 
     context "and logged in" do
       setup do
-        @calendar = Calendar.new(:client_id => @client_id, :client_secret => @client_secret, :redirect_url => "urn:ietf:wg:oauth:2.0:oob", :refresh_token => @refresh_token, :calendar => @calendar_id)
+        @calendar = Calendar.new(:client_id => @client_id, :client_secret => @client_secret, :redirect_url => @redirect_url, :refresh_token => @refresh_token, :calendar => @calendar_id)
       end
 
       should "find all events" do
@@ -159,6 +208,96 @@ class TestGoogleCalendar < Minitest::Test
         assert_equal @calendar.find_event_by_id('1234'), []
       end
 
+      should "throw Request Failed with 400 error" do
+        @client_mock.stubs(:status).returns(400)
+        @client_mock.stubs(:body).returns( get_mock_body("400.json") )
+
+        assert_raises(HTTPRequestFailed) do
+          @calendar.create_event do |e|
+            e.title = 'New Event with no time'
+            e.description = "A new event with &"
+            e.location = "Joe's House & Backyard"
+          end
+        end
+      end
+
+      should "throw DailyLimitExceededError when limit exceeded" do
+        @client_mock.stubs(:status).returns(403)
+        @client_mock.stubs(:body).returns( get_mock_body("403_daily_limit.json") )
+
+        assert_raises(DailyLimitExceededError) do
+          @calendar.find_event_by_id('1234')
+        end
+      end
+
+      should "throw RateLimitExceededError when rate limit exceeded" do
+        @client_mock.stubs(:status).returns(403)
+        @client_mock.stubs(:body).returns( get_mock_body("403_rate_limit.json") )
+
+        assert_raises(RateLimitExceededError) do
+          @calendar.find_event_by_id('1234')
+        end
+      end
+
+      should "throw UserRateLimitExceededError when user rate limit exceeded" do
+        @client_mock.stubs(:status).returns(403)
+        @client_mock.stubs(:body).returns( get_mock_body("403_user_rate_limit.json") )
+
+        assert_raises(UserRateLimitExceededError) do
+          @calendar.find_event_by_id('1234')
+        end
+      end
+
+      should "throw CalendarUsageLimitExceededError when calendar rate limit exceeded" do
+        @client_mock.stubs(:status).returns(403)
+        @client_mock.stubs(:body).returns( get_mock_body("403_calendar_rate_limit.json") )
+
+        assert_raises(CalendarUsageLimitExceededError) do
+          @calendar.find_event_by_id('1234')
+        end
+      end
+
+      should "throw RequestedIdentifierAlreadyExistsError if bad eTag" do
+        @client_mock.stubs(:status).returns(409)
+        @client_mock.stubs(:body).returns( get_mock_body("409.json") )
+
+        assert_raises(RequestedIdentifierAlreadyExistsError) do
+          @calendar.create_event do |e|
+            e.id = 'duplicate'
+            e.title = 'New Event'
+            e.start_time = Time.now + (60 * 60)
+            e.end_time = Time.now + (60 * 60 * 2)
+          end
+        end
+      end
+
+      should "throw GoneError if bad eTag" do
+        @client_mock.stubs(:status).returns(410)
+        @client_mock.stubs(:body).returns( get_mock_body("410.json") )
+
+        assert_raises(GoneError) do
+          @calendar.find_event_by_id('deleted')
+        end
+      end
+
+      should "throw PreconditionFailedError if bad eTag" do
+        @client_mock.stubs(:status).returns(412)
+        @client_mock.stubs(:body).returns( get_mock_body("412.json") )
+
+        assert_raises(PreconditionFailedError) do
+          @calendar.find_event_by_id('1234')
+        end
+      end
+
+      should "throw BackendError if Google is having issues" do
+        @client_mock.stubs(:status).returns(500)
+        @client_mock.stubs(:body).returns( get_mock_body("500.json") )
+
+        assert_raises(BackendError) do
+          @calendar.find_event_by_id('1234')
+        end
+      end
+
       should "create an event with block" do
         @client_mock.stubs(:body).returns( get_mock_body("create_event.json") )
 
@@ -248,7 +387,7 @@ class TestGoogleCalendar < Minitest::Test
 
         @client_mock.stubs(:body).returns('')
         event.delete
-        assert_equal event.id, nil
+        assert_nil event.id
       end
 
       should "throw exception on bad request" do
@@ -258,14 +397,25 @@ class TestGoogleCalendar < Minitest::Test
         end
       end
 
-      should "create event when id is NIL" do
+      should "create event when id is nil" do
         @client_mock.stubs(:body).returns( get_mock_body("find_event_by_id.json") )
 
-        event = @calendar.find_or_create_event_by_id(NIL) do |e|
-          e.title = 'New Event Update when id is NIL'
+        event = @calendar.find_or_create_event_by_id(nil) do |e|
+          e.title = 'New Event Update when id is nil'
+        end
+
+        assert_equal event.title, 'New Event Update when id is nil'
+      end
+
+      should "create an event with a specified id when none is found on the server" do
+        @client_mock.stubs(:body).returns( get_mock_body("empty_events.json") )
+
+        event = @calendar.find_or_create_event_by_id('fhru34kt6ikmr20knd2456l08n') do |e|
+          e.title = 'New Event With Predefined Id'
         end
 
-        assert_equal event.title, 'New Event Update when id is NIL'
+        assert_equal event.title, 'New Event With Predefined Id'
+        assert_equal event.id, 'fhru34kt6ikmr20knd2456l08n'
       end
 
       should "provide the calendar summary" do
@@ -285,10 +435,10 @@ class TestGoogleCalendar < Minitest::Test
         event.id = '8os94knodtv84h0jh4pqq4ut35'
         assert_equal event.id, '8os94knodtv84h0jh4pqq4ut35'
       end
-      should "work with a passed-in NIL id" do
+      should "work with a passed-in nil id" do
         event = Event.new
         event.id = nil
-        assert_equal event.id, nil
+        assert_nil event.id
       end
       should "raise an error with an invalid ID" do
         event = Event.new
@@ -371,15 +521,30 @@ class TestGoogleCalendar < Minitest::Test
     end
 
     context "transparency" do
-      should "be transparent" do
-        @event = Event.new(:transparency => true)
-        assert @event.transparent?
+      should "be opaque when nil" do
+        @event = Event.new
+        assert @event.opaque?
+      end
+
+      should "be opaque when transparency = opaque" do
+        @event = Event.new(:transparency => 'opaque')
+        assert @event.opaque?
       end
 
       should "be opaque?" do
         @event = Event.new(:transparency => false)
         assert @event.opaque?
       end
+
+      should "be transparent" do
+        @event = Event.new(:transparency => true)
+        assert @event.transparent?
+      end
+
+      should "be transparent when transparency = transparent" do
+        @event = Event.new(:transparency => 'transparent')
+        assert @event.transparent?
+      end
     end
 
     context "event json" do
@@ -509,6 +674,67 @@ class TestGoogleCalendar < Minitest::Test
         assert_equal correct_hash.inspect, Event.parse_recurrence_rule(rrule).inspect
       end
     end
+
+    context "visibility" do
+      should "default to 'default' when not specified" do
+        assert_equal Event.new.visibility, "default"
+      end
+
+      should "accept a valid visibility" do
+        assert_equal Event.new(:visibility => "private").visibility, "private"
+      end
+
+      should "raise an error on an invalid visibility" do
+        assert_raises(ArgumentError) { Event.new(:visibility => "bogus") }
+      end
+    end
+
+    context "default hashes" do
+      should "return an empty hash for recurrence when unset" do
+        assert_equal Event.new.recurrence, {}
+      end
+
+      should "return an empty hash for extended_properties when unset" do
+        assert_equal Event.new.extended_properties, {}
+      end
+    end
+
+    context "attribute JSON helpers" do
+      setup do
+        @event = Event.new(
+          :color_id => 5,
+          :attendees => [{'email' => 'a@example.com', 'displayName' => 'A', 'responseStatus' => 'accepted'}],
+          :reminders => { 'useDefault' => false, 'overrides' => [{'minutes' => 10, 'method' => 'popup'}] },
+          :recurrence => { freq: 'weekly' },
+          :extended_properties => { 'shared' => { 'key' => 'value' } }
+        )
+      end
+
+      should "expose colorId as a hash and as json" do
+        assert_equal @event.color_attributes, { "colorId" => "5" }
+        assert_equal JSON.parse(@event.color_json), { "colorId" => "5" }
+      end
+
+      should "expose attendees as json" do
+        assert_equal JSON.parse(@event.attendees_json)["attendees"].first["email"], 'a@example.com'
+      end
+
+      should "expose reminders as json" do
+        assert_equal JSON.parse(@event.reminders_json)["useDefault"], false
+      end
+
+      should "expose recurrence as json" do
+        assert_equal JSON.parse(@event.recurrence_json)["recurrence"], ["RRULE:FREQ=WEEKLY"]
+      end
+
+      should "expose extended properties as json" do
+        assert_equal JSON.parse(@event.extended_properties_json)["extendedProperties"]["shared"]["key"], 'value'
+      end
+
+      should "expose the local timezone as json" do
+        assert_equal JSON.parse(@event.local_timezone_json)["timeZone"], TimezoneParser::getTimezones(Time.now.getlocal.zone).last
+      end
+    end
   end
 
   context "a calendar list" do
@@ -519,11 +745,12 @@ class TestGoogleCalendar < Minitest::Test
       @client_id = "671053090364-ntifn8rauvhib9h3vnsegi6dhfglk9ue.apps.googleusercontent.com"
       @client_secret = "roBgdbfEmJwPgrgi2mRbbO-f"
       @refresh_token = "1/eiqBWx8aj-BsdhwvlzDMFOUN1IN_HyThvYTujyksO4c"
+      @redirect_url = "https://mytesturl.com/"
 
       @calendar_list = Google::CalendarList.new(
         :client_id => @client_id,
         :client_secret => @client_secret,
-        :redirect_url => "urn:ietf:wg:oauth:2.0:oob",
+        :redirect_url => @redirect_url,
         :refresh_token => @refresh_token
       )
 
@@ -566,18 +793,18 @@ class TestGoogleCalendar < Minitest::Test
   end
 
   context "a freebusy query" do
-
     setup do
       @client_mock = setup_mock_client
 
       @client_id = "671053090364-ntifn8rauvhib9h3vnsegi6dhfglk9ue.apps.googleusercontent.com"
       @client_secret = "roBgdbfEmJwPgrgi2mRbbO-f"
       @refresh_token = "1/eiqBWx8aj-BsdhwvlzDMFOUN1IN_HyThvYTujyksO4c"
+      @redirect_url = "https://mytesturl.com/"
 
       @freebusy = Google::Freebusy.new(
         :client_id => @client_id,
         :client_secret => @client_secret,
-        :redirect_url => "urn:ietf:wg:oauth:2.0:oob",
+        :redirect_url => @redirect_url,
         :refresh_token => @refresh_token
       )
 
@@ -595,12 +822,28 @@ class TestGoogleCalendar < Minitest::Test
     should "returns the busy times for each calendar supplied" do
       freebusy_result = @freebusy.query(@calendar_ids, @start_time, @end_time)
 
-      assert_equal ({'start' => '2015-03-06T10:00:00Z', 'end' => '2015-03-06T11:00:00Z' }), freebusy_result['busy-calendar-id'].first
-      assert_equal ({'start' => '2015-03-06T11:30:00Z', 'end' => '2015-03-06T11:30:00Z' }), freebusy_result['busy-calendar-id'].last
+      assert_equal ({'start' => DateTime.new(2015, 3, 6, 10, 0, 0, 0), 'end' => DateTime.new(2015, 3, 6, 11, 0, 0, 0) }), freebusy_result['busy-calendar-id'].first
+      assert_equal ({'start' => DateTime.new(2015, 3, 6, 11, 30, 0, 0), 'end' => DateTime.new(2015, 3, 6, 11, 30, 0, 0) }), freebusy_result['busy-calendar-id'].last
       assert_equal [], freebusy_result['not-busy-calendar-id']
     end
   end
 
+  context "with a service account" do
+    setup do
+      @client_mock = setup_mock_client
+    end
+
+    should "connect and obtain an access token" do
+      connection = Google::Connection.new_with_service_account(
+        :client_id   => "the-issuer@example.iam.gserviceaccount.com",
+        :signing_key => OpenSSL::PKey::RSA.new(2048),
+        :person      => "user@example.com"
+      )
+
+      assert_equal connection.access_token, ENV['ACCESS_TOKEN']
+    end
+  end
+
   protected
 
   def get_mock_body(name)