google_calendar 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,4 @@
 ---
-SHA1:
-  metadata.gz: 2c17b12f3368a1500b481e98511d25a58e8822c5
-  data.tar.gz: 1deb46615f678e7e445765895cca36af94f284f4
 SHA512:
-  metadata.gz: de0d7043457f15f227a5ce37e5394fa26ca494329c9da4e83e9ddd4d6d314ab5a7a2c38adbe95b75e34b98ff6cc6bac06520ee5264db98ed4da26aa8b7662460
-  data.tar.gz: 3034d06715304ca240b9849565231ce08ca263443cb8ada17546a2a3ea2b4ffecb3f7995e656a7e6de5db10f1986c3adf840eaba68f9d506d10734b69ae2170d
+  metadata.gz: 37b7d1c2914d9c4975ff8477a94a5c5ae18d5cb8dacf089bbadb1a16414984adc4b606a97a08f52b9baae9beb018344c6cf6616f65d1064d4c5499d7ddc494a9
+  data.tar.gz: be2f3af778d82be79cebfac47135c2441363eeeffeed43d7eab04a3935f192b287fcc79b9b55b3bd02ccb6beac58eaf33c75db9d2a947efe42aadf64e106a25b

data/.env.default

@@ -0,0 +1,6 @@
+CLIENT_ID=
+CLIENT_SECRET=
+REFRESH_TOKEN=
+CALENDAR_ID=
+ACCESS_TOKEN=
+REDIRECT_URL=

data/.env.test

@@ -0,0 +1,6 @@
+CLIENT_ID='671053090364-ntifn8rauvhib9h3vnsegi6dhfglk9ue.apps.googleusercontent.com'
+CLIENT_SECRET='roBgdbfEmJwPgrgi2mRbbO-f'
+REFRESH_TOKEN='1/eiqBWx8aj-BsdhwvlzDMFOUN1IN_HyThvYTujyksO4c'
+CALENDAR_ID='klei8jnelo09nflqehnvfzipgs@group.calendar.google.com'
+ACCESS_TOKEN='ya29.hYjPO0uHt63uWr5qmQtMEReZEvILcdGlPCOHDy6quKPyEQaQQvqaVAlLAVASaRm_O0a7vkZ91T8xyQ'
+REDIRECT_URL='urn:ietf:wg:oauth:2.0:oob'

data/.gitignore

@@ -36,3 +36,5 @@ tmtags
 notes.md
 test_harness.rb
 *.gem
+# dotenv
+.env

data/.travis.yml

@@ -2,8 +2,14 @@ language: ruby
 rvm:
   - "2.1"
   - "2.2"
-  - "2.3.0"
+  - "2.3"
+  - "2.4"
 before_install:
   - gem install bundler
+addons:
+  code_climate:
+    repo_token: 35bb9d218078742d37436a9c9a8b78199e8c7312d034081881de670e95b8dcad
+after_success:
+  - bundle exec codeclimate-test-reporter      
 # uncomment this line if your project needs to run something other than `rake`:
 # script: bundle exec rspec spec

data/Gemfile.lock

@@ -12,40 +12,42 @@ GEM
     TimezoneParser (0.2.0)
       insensitive_hash
       tzinfo
-    addressable (2.4.0)
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
     ansi (1.5.0)
-    builder (3.2.2)
-    codeclimate-test-reporter (0.6.0)
-      simplecov (>= 0.7.1, < 1.0.0)
+    builder (3.2.3)
+    codeclimate-test-reporter (1.0.5)
+      simplecov
     docile (1.1.5)
-    faraday (0.9.2)
+    dotenv (2.2.0)
+    faraday (0.11.0)
       multipart-post (>= 1.2, < 3)
     insensitive_hash (0.3.3)
-    json (1.8.3)
+    json (2.0.3)
     jwt (1.5.6)
     metaclass (0.0.4)
-    minitest (5.9.1)
-    minitest-reporters (1.1.11)
+    minitest (5.10.1)
+    minitest-reporters (1.1.14)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    mocha (1.1.0)
+    mocha (1.2.1)
       metaclass (~> 0.0.1)
     multi_json (1.12.1)
     multipart-post (2.0.0)
+    public_suffix (2.0.5)
     rake (11.3.0)
-    rb-fsevent (0.9.7)
-    rdoc (4.2.2)
-      json (~> 1.4)
+    rb-fsevent (0.9.8)
+    rdoc (4.3.0)
     ruby-progressbar (1.8.1)
-    shoulda-context (1.2.1)
+    shoulda-context (1.2.2)
     signet (0.7.3)
       addressable (~> 2.3)
       faraday (~> 0.9)
       jwt (~> 1.5)
       multi_json (~> 1.10)
-    simplecov (0.12.0)
+    simplecov (0.13.0)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
@@ -61,6 +63,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (>= 1.2)
   codeclimate-test-reporter
+  dotenv (~> 2.1)
   google_calendar!
   minitest (~> 5.1)
   minitest-reporters (~> 1.0)
@@ -72,4 +75,4 @@ DEPENDENCIES
   terminal-notifier-guard (~> 1.6)
 
 BUNDLED WITH
-   1.13.2
+   1.14.4

data/README.rdoc

@@ -1,4 +1,3 @@
-
 = Google Calendar
 
 A fast lightweight and minimalist wrapper around the {Google Calendar}[https://www.google.com/calendar/] api.
@@ -7,7 +6,7 @@ A fast lightweight and minimalist wrapper around the {Google Calendar}[https://w
 == Install
   [sudo] gem install 'google_calendar'
 
-== Setup 
+== Setup
 
 <b>Obtain a Client ID and Secret</b>
 
@@ -32,7 +31,7 @@ A fast lightweight and minimalist wrapper around the {Google Calendar}[https://w
   require 'google_calendar'
 
   # Create an instance of the calendar.
-  cal = Google::Calendar.new(:client_id     => YOUR_CLIENT_ID, 
+  cal = Google::Calendar.new(:client_id     => YOUR_CLIENT_ID,
                              :client_secret => YOUR_SECRET,
                              :calendar      => YOUR_CALENDAR_ID,
                              :redirect_url  => "urn:ietf:wg:oauth:2.0:oob" # this is what Google uses for 'applications'
@@ -106,6 +105,15 @@ The current google_calendar gem supports Ruby 2.1 and higher -- because of the j
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
+== Running Tests
+The first time you run +rake+ +test+ Rake will copy over +.env.test+
+to +.env+ for use by Dotenv.  You can also use +.env.default+ as your
+own starting point, just remember to copy it over to +.env+ before
+running tests.
+
+You can modify +.env+ with your own credentials and not worry about
+accidentally committing to the repo as +.env+ is in the +.gitignore+.
+
 == Copyright
 
 Copyright (c) 2010-2014 Steve Zich. See LICENSE.txt for further details.

data/Rakefile

@@ -27,3 +27,13 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+desc "Load environment settings from .env"
+task :dotenv do
+  require "dotenv"
+  FileUtils.copy('.env.test', '.env') unless File.exist?('.env')
+  Dotenv.load
+end
+
+task :environment => :dotenv
+task :test => :dotenv

data/google_calendar.gemspec

@@ -2,8 +2,8 @@
 
 Gem::Specification.new do |s|
   s.name = "google_calendar"
-  s.version = "0.6.1"
-  s.date = "2016-09-30"
+  s.version = "0.6.2"
+  s.date = "2017-02-17"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
 
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
 
   s.require_paths = ["lib"]
-  s.rubygems_version = "2.2.2"
+  s.rubygems_version = "2.6.10"
 
   s.add_runtime_dependency(%q<signet>, ["~> 0.7"])
   s.add_runtime_dependency(%q<json>, [">= 1.8.3", "< 2.1"])
@@ -39,5 +39,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency(%q<mocha>, ["~> 1.1"])
   s.add_development_dependency(%q<rake>, ["~> 11"])
   s.add_development_dependency(%q<rdoc>, ["~> 4.1"])
+  s.add_development_dependency(%q<dotenv>, ["~> 2.1"])
 
 end

data/lib/google/calendar.rb

@@ -270,10 +270,14 @@ module Google
     # Works like the create_event method.
     #
     def find_or_create_event_by_id(id, &blk)
-      if id.nil?
-        setup_event(Event.new, &blk)
+      if id && event = find_event_by_id(id)[0]
+        setup_event(event, &blk)
+      elsif id
+        event = Event.new(id: id, new_event_with_id_specified: true)
+        setup_event(event, &blk)
       else
-        setup_event(find_event_by_id(id)[0] || Event.new, &blk)
+        event = Event.new
+        setup_event(event, &blk)
       end
     end
 
@@ -284,12 +288,13 @@ module Google
     def save_event(event)
       method = event.new_event? ? :post : :put
       body = event.use_quickadd? ? nil : event.to_json
+      notifications = "sendNotifications=#{event.send_notifications?}"
       query_string =  if event.use_quickadd?
-        "/quickAdd?text=#{event.title}"
+        "/quickAdd?#{notifications}&text=#{event.title}"
       elsif event.new_event?
-        ''
+        "?#{notifications}"
       else # update existing event.
-        "/#{event.id}"
+        "/#{event.id}?#{notifications}"
       end
 
       send_events_request(query_string, method, body)
@@ -300,7 +305,8 @@ module Google
     # This is a callback used by the Event class.
     #
     def delete_event(event)
-      send_events_request("/#{event.id}", :delete)
+      notifications = "sendNotifications=#{event.send_notifications?}"
+      send_events_request("/#{event.id}?#{notifications}", :delete)
     end
 
     protected

data/lib/google/connection.rb

@@ -18,7 +18,8 @@ module Google
         :issuer => params[:client_id],
         :audience => TOKEN_URI,
         :token_credential_uri => TOKEN_URI,
-        :signing_key => params[:signing_key]
+        :signing_key => params[:signing_key],
+        :person => params[:person]
       )
       Connection.new(params, client)
     end

data/lib/google/event.rb

@@ -30,11 +30,12 @@ module Google
   # * +extended_properties+ - Custom properties which may be shared or private. Read Write
   # * +guests_can_invite_others+ - Whether attendees other than the organizer can invite others to the event (*true*, false). Read Write.
   # * +guests_can_see_other_guests+ - Whether attendees other than the organizer can see who the event's attendees are (*true*, false). Read Write.
+  # * +send_notifications+ - Whether to send notifications about the event update (true, *false*). Write only.
   #
   class Event
     attr_reader :id, :raw, :html_link, :status, :transparency, :visibility
     attr_writer :reminders, :recurrence, :extended_properties
-    attr_accessor :title, :location, :calendar, :quickadd, :attendees, :description, :creator_name, :color_id, :guests_can_invite_others, :guests_can_see_other_guests
+    attr_accessor :title, :location, :calendar, :quickadd, :attendees, :description, :creator_name, :color_id, :guests_can_invite_others, :guests_can_see_other_guests, :send_notifications, :new_event_with_id_specified
 
     #
     # Create a new event, and optionally set it's attributes.
@@ -60,9 +61,10 @@ module Google
     # event.extendedProperties = {'shared' => {'custom_str' => 'some custom string'}}
     # event.guests_can_invite_others = false
     # event.guests_can_see_other_guests = false
+    # event.send_notifications = true
     #
     def initialize(params = {})
-      [:id, :status, :raw, :html_link, :title, :location, :calendar, :quickadd, :attendees, :description, :reminders, :recurrence, :start_time, :end_time, :color_id, :extended_properties, :guests_can_invite_others, :guests_can_see_other_guests].each do |attribute|
+      [:id, :status, :raw, :html_link, :title, :location, :calendar, :quickadd, :attendees, :description, :reminders, :recurrence, :start_time, :end_time, :color_id, :extended_properties, :guests_can_invite_others, :guests_can_see_other_guests, :send_notifications].each do |attribute|
         instance_variable_set("@#{attribute}", params[attribute])
       end
 
@@ -70,6 +72,7 @@ module Google
       self.transparency = params[:transparency]
       self.all_day      = params[:all_day] if params[:all_day]
       self.creator_name = params[:creator]['displayName'] if params[:creator]
+      self.new_event_with_id_specified = !!params[:new_event_with_id_specified]
     end
 
     #
@@ -259,30 +262,28 @@ module Google
     # Google JSON representation of an event object.
     #
     def to_json
-
       attributes = {
         "summary" => title,
         "visibility" => visibility,
         "transparency" => transparency,
         "description" => description,
         "location" => location,
-        "start" => {
-          "dateTime" => start_time
-        },
-        "end" => {
-          "dateTime" => end_time
-        },
+        "start" => time_or_all_day(start_time),
+        "end" => time_or_all_day(end_time),
         "reminders" => reminders_attributes,
         "guestsCanInviteOthers" => guests_can_invite_others,
         "guestsCanSeeOtherGuests" => guests_can_see_other_guests
       }
 
+      if id
+        attributes["id"] = id
+      end
+
       if timezone_needed?
         attributes['start'].merge!(local_timezone_attributes)
         attributes['end'].merge!(local_timezone_attributes)
       end
 
-
       attributes.merge!(recurrence_attributes)
       attributes.merge!(color_attributes)
       attributes.merge!(attendees_attributes)
@@ -442,7 +443,31 @@ module Google
     # Returns true if this a new event.
     #
     def new_event?
-      id == nil || id == ''
+      new_event_with_id_specified? || id == nil || id == ''
+    end
+
+    #
+    # Returns true if notifications were requested to be sent
+    #
+    def send_notifications?
+      !!send_notifications
+    end
+
+
+    private
+
+    def new_event_with_id_specified?
+      !!new_event_with_id_specified
+    end
+
+    def time_or_all_day(time)
+      time = Time.parse(time) if time.is_a? String
+
+      if all_day?
+        { "date" => time.strftime("%Y-%m-%d") }
+      else
+        { "dateTime" => time.xmlschema }
+      end
     end
 
     protected
@@ -529,7 +554,11 @@ module Google
     # Validates id format
     #
     def self.parse_id(id)
-      raise ArgumentError, "Event ID is invalid. Please check Google documentation: https://developers.google.com/google-apps/calendar/v3/reference/events/insert" unless id.gsub(/(^[a-v0-9]{5,1024}$)/o)
+      if id.to_s =~ /\A[a-v0-9]{5,1024}\Z/
+        id
+      else
+        raise ArgumentError, "Event ID is invalid. Please check Google documentation: https://developers.google.com/google-apps/calendar/v3/reference/events/insert"
+      end
     end
 
     #

data/test/helper.rb

@@ -1,7 +1,5 @@
-#require 'simplecov'
-#SimpleCov.start
-require "codeclimate-test-reporter"
-CodeClimate::TestReporter.start
+require 'simplecov'
+SimpleCov.start
 
 require 'rubygems'
 require 'bundler'

data/test/test_google_calendar.rb

@@ -8,13 +8,13 @@ class TestGoogleCalendar < Minitest::Test
     setup do
       @client_mock = setup_mock_client
 
-      @client_id = "671053090364-ntifn8rauvhib9h3vnsegi6dhfglk9ue.apps.googleusercontent.com"
-      @client_secret = "roBgdbfEmJwPgrgi2mRbbO-f"
-      @refresh_token = "1/eiqBWx8aj-BsdhwvlzDMFOUN1IN_HyThvYTujyksO4c"
-      @calendar_id = "klei8jnelo09nflqehnvfzipgs@group.calendar.google.com"
-      @access_token = 'ya29.hYjPO0uHt63uWr5qmQtMEReZEvILcdGlPCOHDy6quKPyEQaQQvqaVAlLAVASaRm_O0a7vkZ91T8xyQ'
+      @client_id = ENV['CLIENT_ID']
+      @client_secret = ENV['CLIENT_SECRET']
+      @refresh_token = ENV['REFRESH_TOKEN']
+      @calendar_id = ENV['CALENDAR_ID']
+      @access_token = ENV['ACCESS_TOKEN']
 
-      @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 => ENV['REDIRECT_URL'], :refresh_token => @refresh_token, :calendar => @calendar_id)
 
     end
 
@@ -279,6 +279,45 @@ class TestGoogleCalendar < Minitest::Test
   end # Connected context
 
   context "Event instance methods" do
+    context "#id=" do
+      should "retain a passed-in id" do
+        event = Event.new
+        event.id = '8os94knodtv84h0jh4pqq4ut35'
+        assert_equal event.id, '8os94knodtv84h0jh4pqq4ut35'
+      end
+      should "work with a passed-in NIL id" do
+        event = Event.new
+        event.id = nil
+        assert_equal event.id, nil
+      end
+      should "raise an error with an invalid ID" do
+        event = Event.new
+        assert_raises(ArgumentError) do
+          event.id = 'ZZZZ' # too short, invalid characters
+        end
+      end
+    end
+
+    context "send_notifications" do
+      should "work when initialized with true" do
+        event = Event.new(:send_notifications => true)
+        assert event.send_notifications?
+      end
+
+      should "work when initialized with false" do
+        event = Event.new(:send_notifications => false)
+        refute event.send_notifications?
+      end
+
+      should "be dynamic" do
+        event = Event.new
+        event.send_notifications = false
+        refute event.send_notifications?
+        event.send_notifications = true
+        assert event.send_notifications?
+      end
+    end
+
     context "#all_day?" do
       context "when the event is marked as All Day in google calendar" do
         should "be true" do
@@ -344,7 +383,12 @@ class TestGoogleCalendar < Minitest::Test
     end
 
     context "event json" do
-      should "be correct format" do
+      should "include ID key when ID specified" do
+        @event = Event.new(id: "nfej9pqigzneknf8llso0iehlv")
+        assert_equal JSON.parse(@event.to_json)["id"], "nfej9pqigzneknf8llso0iehlv"
+      end
+
+      should "be correct format without ID specified" do
         now = Time.now
         @event = Event.new
         @event.start_time = now
@@ -381,6 +425,13 @@ class TestGoogleCalendar < Minitest::Test
         }
         assert_equal JSON.parse(@event.to_json), expected_structure
       end
+
+      should "return date instead of dateTime for all-day event" do
+        @event = Event.new(all_day: "2016-10-15")
+        json = JSON.parse(@event.to_json)
+        assert_equal json['start']['date'], "2016-10-15"
+        assert_equal json['end']['date'], "2016-10-16"
+      end
     end
 
     context "reminders" do
@@ -425,7 +476,7 @@ class TestGoogleCalendar < Minitest::Test
         require 'timezone_parser'
         expected_structure = {
           "summary" => "Go Swimming",
-          "visibility"=>"default",          
+          "visibility"=>"default",
           "transparency"=>"opaque",
           "description" => "The polar bear plunge",
           "location" => "In the arctic ocean",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google_calendar
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Steve Zich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-30 00:00:00.000000000 Z
+date: 2017-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: signet
@@ -184,6 +184,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 description: A minimal wrapper around the google calendar API
 email: steve.zich@gmail.com
 executables: []
@@ -193,6 +207,8 @@ extra_rdoc_files:
 - README.rdoc
 files:
 - ".document"
+- ".env.default"
+- ".env.test"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
@@ -253,7 +269,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: A lightweight Google Calendar API wrapper