calendav 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 605ae687dccd58f74c2c2ec01b44bf27b2cc71de6f5453d26c398b7828325d40
-  data.tar.gz: '08c0253e9cc5479f1370a2acb5973901a4d9079078a9f51aba2ac28fccf75b9d'
+  metadata.gz: 6bae509ffc0254b00db9e4380a76278770a0868093ff69b597b6b10fcf9ecd01
+  data.tar.gz: 26cfe5ccbc19dba770cf2d255cbb36bc3529039903af8d28281536f70cb55c49
 SHA512:
-  metadata.gz: 20d4fefd21bdf9d58a2c76e557b80be9a6f62c0a4c38667ab806f91e9081e34179941ad9238ca25007db41525a9ac21ec1fe2ce84ac311418e50458af55a413a
-  data.tar.gz: e3584378cea92199c918f81df44394ccac34b20b2f963abd72d2488d0356dd2108e06ec038ea68e511e2548f9ee48684b3584950cd737d431530479d57430ae2
+  metadata.gz: 56fd5c731ad0d4b05d29a68df6624bad4809a6a146806c8190ba765b233e39598572711ff6f5f61a59df09a8d919090b45641bfbc2214a1ad746f4a7f5bf8662
+  data.tar.gz: fa897448f63e9c5a04f8c97acebb950d0213fbc8aa10eb8d4069aaaafbe9849148dafe526de9c78a6d947c4a43eaaa78260665dfd05d66b429c21d5e1caf5a7e

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 ## Unreleased
 
-...
+## 0.3.0 - 2022-03-14
+
+* Add location to event wrapper.
+* Allow setting timeouts for client calls.
+* Avoid external calls to calculate calendar URLs where possible.
 
 ## 0.2.0 - 2021-07-07
 

data/Gemfile

@@ -3,3 +3,7 @@
 source "https://rubygems.org"
 
 gemspec
+
+gem "icalendar",
+    git: "https://github.com/pat/icalendar.git",
+    branch: "fix/activesupport-7"

data/lib/calendav/client.rb

@@ -8,8 +8,9 @@ require_relative "./requests/current_user_principal"
 
 module Calendav
   class Client
-    def initialize(credentials)
+    def initialize(credentials, timeout: nil)
       @credentials = credentials
+      @timeout = timeout
     end
 
     def calendars
@@ -34,10 +35,10 @@ module Calendav
 
     private
 
-    attr_reader :credentials
+    attr_reader :credentials, :timeout
 
     def endpoint
-      @endpoint ||= Endpoint.new(credentials)
+      @endpoint ||= Endpoint.new(credentials, timeout: timeout)
     end
   end
 end

data/lib/calendav/clients/calendars_client.rb

@@ -64,7 +64,7 @@ module Calendav
         endpoint
           .propfind(request.to_xml, url: url, depth: depth)
           .select { |node| node.xpath(calendar_xpath).any? }
-          .collect { |node| Calendar.from_xml(home_url, node) }
+          .collect { |node| Calendar.from_xml(url, node) }
       end
 
       def options

data/lib/calendav/endpoint.rb

@@ -11,8 +11,9 @@ module Calendav
       xml: "application/xml; charset=utf-8"
     }.freeze
 
-    def initialize(credentials)
+    def initialize(credentials, timeout: nil)
       @credentials = credentials
+      @timeout = timeout
     end
 
     def delete(url:, etag: nil)
@@ -76,7 +77,7 @@ module Calendav
 
     private
 
-    attr_reader :credentials
+    attr_reader :credentials, :timeout
 
     def authenticated
       case credentials.authentication
@@ -93,6 +94,7 @@ module Calendav
     def with_headers(content_type: nil, depth: nil, etag: nil)
       http = authenticated
 
+      http = http.timeout(timeout) if timeout
       http = http.headers(depth: depth) if depth
       http = http.headers("If-Match" => etag) if etag
       if content_type

data/lib/calendav/event.rb

@@ -33,6 +33,10 @@ module Calendav
       inner_event.summary
     end
 
+    def location
+      inner_event.location
+    end
+
     def dtstart
       inner_event.dtstart
     end

data/lib/calendav.rb

@@ -16,7 +16,7 @@ module Calendav
     PROVIDERS.fetch(provider).new(username: username, password: password)
   end
 
-  def self.client(credentials)
-    Client.new(credentials)
+  def self.client(credentials, timeout: nil)
+    Client.new(credentials, timeout: timeout)
   end
 end

data/spec/acceptance/apple_spec.rb

@@ -4,7 +4,7 @@ require "securerandom"
 
 require_relative "./shared"
 
-RSpec.describe "Apple" do
+RSpec.describe "Apple", :vcr do
   let(:provider) { :apple }
   let(:username) { ENV.fetch("APPLE_USERNAME") }
   let(:password) { ENV.fetch("APPLE_PASSWORD") }
@@ -27,10 +27,14 @@ RSpec.describe "Apple" do
 
   context "with a calendar" do
     let(:calendar_url) do
-      subject.calendars.create(SecureRandom.uuid, display_name: "Calendav Test")
+      subject.calendars.create(@name, display_name: "Calendav Test")
     end
     let(:calendar) { subject.calendars.find(calendar_url) }
 
+    before :each do |example|
+      @name = Digest::MD5.hexdigest(example.metadata[:full_description])
+    end
+
     after :each do
       subject.calendars.delete(calendar.url)
     end

data/spec/acceptance/google_spec.rb

@@ -8,7 +8,7 @@ require "uri"
 
 require_relative "./shared"
 
-RSpec.describe "Google" do
+RSpec.describe "Google", :vcr do
   let(:provider) { :google }
   let(:username) { ENV.fetch("GOOGLE_USERNAME") }
   let(:access_token) { @access_token }
@@ -17,7 +17,7 @@ RSpec.describe "Google" do
 
   subject { Calendav.client(credentials) }
 
-  before :context do
+  before :each do
     @google_auth = Google::Auth::UserRefreshCredentials.new(
       client_id: ENV.fetch("GOOGLE_CLIENT_ID"),
       scope: [],
@@ -84,7 +84,7 @@ RSpec.describe "Google" do
 
     it "does not respect etag conditions for deletions" do
       event_url = subject.events.create(
-        calendar.url, event_identifier, ical_event("Brunch", 10, 30)
+        calendar.url, "calendav-event.ics", ical_event("Brunch", 10, 30)
       )
       event = subject.events.find(event_url)
 

data/spec/acceptance/radicale_spec.rb

@@ -34,7 +34,7 @@ RSpec.describe "Radicale" do
 
   context "with a calendar" do
     let(:calendar_url) do
-      subject.calendars.create(SecureRandom.uuid, display_name: "Calendav Test")
+      subject.calendars.create("calendav-test", display_name: "Calendav Test")
     end
     let(:calendar) { subject.calendars.find(calendar_url) }
 

data/spec/acceptance/shared.rb

@@ -11,7 +11,7 @@ RSpec.shared_examples "supporting calendar management" do
   end
 
   it "can create, find, update and delete calendars" do
-    identifier = SecureRandom.uuid
+    identifier = "calendav-test"
     time_zone = TZInfo::Timezone.get "UTC"
     ical_time_zone = time_zone.ical_timezone Time.now.utc
 
@@ -51,7 +51,7 @@ RSpec.shared_examples "supporting event management" do
   it "can create, find, update and delete events" do
     # Create an event
     event_url = subject.events.create(
-      calendar.url, event_identifier, ical_event("Brunch", 10, 30)
+      calendar.url, "calendav-event-1.ics", ical_event("Brunch", 10, 30)
     )
     expect(event_url).to include(URI.decode_www_form_component(calendar.url))
     event = subject.events.find(event_url)
@@ -79,7 +79,7 @@ RSpec.shared_examples "supporting event management" do
 
     # Create another event
     another_url = subject.events.create(
-      calendar.url, event_identifier, ical_event("Brunch", 10, 30)
+      calendar.url, "calendav-event-2.ics", ical_event("Brunch", 10, 30)
     )
 
     # Search for all events
@@ -93,7 +93,7 @@ RSpec.shared_examples "supporting event management" do
 
   it "respects etag conditions with updates" do
     event_url = subject.events.create(
-      calendar.url, event_identifier, ical_event("Brunch", 10, 30)
+      calendar.url, "calendav-event.ics", ical_event("Brunch", 10, 30)
     )
     event = subject.events.find(event_url)
 
@@ -122,7 +122,7 @@ RSpec.shared_examples "supporting event management" do
 
   it "handles synchronisation requests" do
     first_url = subject.events.create(
-      calendar.url, event_identifier, ical_event("Brunch", 10, 30)
+      calendar.url, "calendav-event-1.ics", ical_event("Brunch", 10, 30)
     )
     first = subject.events.find(first_url)
     token = subject.calendars.find(calendar.url, sync: true).sync_token
@@ -131,7 +131,7 @@ RSpec.shared_examples "supporting event management" do
     expect(events.length).to eq(1)
 
     second_url = subject.events.create(
-      calendar.url, event_identifier, ical_event("Brunch Again", 11, 30)
+      calendar.url, "calendav-event-2.ics", ical_event("Brunch Again", 11, 30)
     )
 
     subject.events.update(first_url, update_summary(first, "Coffee"))
@@ -163,7 +163,7 @@ end
 RSpec.shared_examples "supporting event deletion with etags" do
   it "respects etag conditions with deletions" do
     event_url = subject.events.create(
-      calendar.url, event_identifier, ical_event("Brunch", 10, 30)
+      calendar.url, "calendav-event.ics", ical_event("Brunch", 10, 30)
     )
     event = subject.events.find(event_url)
 

data/spec/spec_helper.rb

@@ -7,6 +7,7 @@ Dotenv.load
 
 require_relative "support/encoded_matchers"
 require_relative "support/event_helpers"
+require_relative "support/vcr"
 
 RSpec.configure do |config|
   config.disable_monkey_patching!

data/spec/support/event_helpers.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
 
+# require "active_support"
 require "icalendar"
 require "securerandom"
 
 module EventHelpers
-  def event_identifier
-    "#{SecureRandom.uuid}.ics"
-  end
-
   def ical_event(summary, hour, minute)
     start = time_at(hour, minute)
 

data/spec/support/vcr.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "timecop"
+require "webmock/rspec"
+require "vcr"
+require "vcr_assistant/rspec"
+
+VCR.configure do |config|
+  config.cassette_library_dir = File.expand_path(
+    File.join(__dir__, "../cassettes")
+  )
+  config.hook_into :webmock
+  config.ignore_hosts "127.0.0.1"
+end
+
+RSpec.configure do |config|
+  config.around(:each, :vcr) do |example|
+    assisted_cassette(example) do |_assistant|
+      Timecop.freeze(Time.gm(2022))
+
+      example.run
+
+      Timecop.return
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calendav
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Pat Allan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-07 00:00:00.000000000 Z
+date: 2022-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +164,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr_assistant
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - pat@freelancing-gods.com
@@ -199,6 +255,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/encoded_matchers.rb
 - spec/support/event_helpers.rb
+- spec/support/vcr.rb
 homepage: https://github.com/pat/calendav
 licenses:
 - Hippocratic-2.1
@@ -206,6 +263,7 @@ metadata:
   homepage_uri: https://github.com/pat/calendav
   source_code_uri: https://github.com/pat/calendav
   changelog_uri: https://github.com/pat/calendav/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -221,7 +279,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: CalDAV client
@@ -235,6 +293,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/encoded_matchers.rb
 - spec/support/event_helpers.rb
+- spec/support/vcr.rb
 - ".rspec"
 - Gemfile
 - Rakefile