calendav 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6564ba6fca723cd571c786aee0028dd36179fd90ee7bba76a7fbd3526a939b64
-  data.tar.gz: 670e804269e4f341fee602a5ffad34360ae2d8ae5c15e88167c354227848ce03
+  metadata.gz: 605ae687dccd58f74c2c2ec01b44bf27b2cc71de6f5453d26c398b7828325d40
+  data.tar.gz: '08c0253e9cc5479f1370a2acb5973901a4d9079078a9f51aba2ac28fccf75b9d'
 SHA512:
-  metadata.gz: 63cd2f961d63585f35c46f137b510b5d8378d699e94c54cb195d702961abb0a557d9bcc6a159cdd9d133318290c1cd71921c54f4fc8ed2d38763fe95ef193a06
-  data.tar.gz: 4fb05941471d086aa9c13aad6a3dca6349106e5d1d527f3b1fae1b7da02a6c8b993cfe55c718c0ddad7371f5db6c18228a4b8f850b1d3c13622f824bcf31c1fa
+  metadata.gz: 20d4fefd21bdf9d58a2c76e557b80be9a6f62c0a4c38667ab806f91e9081e34179941ad9238ca25007db41525a9ac21ec1fe2ce84ac311418e50458af55a413a
+  data.tar.gz: e3584378cea92199c918f81df44394ccac34b20b2f963abd72d2488d0356dd2108e06ec038ea68e511e2548f9ee48684b3584950cd737d431530479d57430ae2

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ...
 
+## 0.2.0 - 2021-07-07
+
+* Improve serialisation of Event and Calendar objects (easily converted to/from hashes).
+* Add `more?` to sync collection objects, indicating whether there are further changes available.
+
 ## 0.1.1 - 2021-06-28
 
 * Fix reports lists to just the relevant calendar.

data/lib/calendav/calendar.rb

@@ -5,27 +5,35 @@ require_relative "./parsers/calendar_xml"
 
 module Calendav
   class Calendar
-    attr_reader :url, :display_name, :description, :ctag, :etag, :time_zone,
-                :color, :components, :reports, :sync_token
+    ATTRIBUTES = %i[
+      url display_name description ctag etag time_zone color components reports
+      sync_token
+    ].freeze
 
     def self.from_xml(host, node)
       new(
-        ContextualURL.call(host, node.xpath("./dav:href").text),
-        Parsers::CalendarXML.call(node)
+        {
+          url: ContextualURL.call(host, node.xpath("./dav:href").text)
+        }.merge(
+          Parsers::CalendarXML.call(node)
+        )
       )
     end
 
-    def initialize(url, attributes = {})
-      @url = url
-      @display_name = attributes[:display_name]
-      @description = attributes[:description]
-      @ctag = attributes[:ctag]
-      @etag = attributes[:etag]
-      @time_zone = attributes[:time_zone]
-      @color = attributes[:color]
-      @components = attributes[:components]
-      @reports = attributes[:reports]
-      @sync_token = attributes[:sync_token]
+    def initialize(attributes = {})
+      @attributes = attributes
     end
+
+    ATTRIBUTES.each do |attribute|
+      define_method(attribute) { attributes[attribute] }
+    end
+
+    def to_h
+      attributes.dup
+    end
+
+    private
+
+    attr_reader :attributes
   end
 end

data/lib/calendav/clients/events_client.rb

@@ -30,7 +30,7 @@ module Calendav
         response = endpoint.get(url: event_url)
 
         Event.new(
-          event_url,
+          url: event_url,
           calendar_data: response.body.to_s,
           etag: response.headers["ETag"]
         )

data/lib/calendav/endpoint.rb

@@ -86,7 +86,7 @@ module Calendav
         HTTP.auth("Bearer #{credentials.password}")
       else
         raise "Unexpected authentication approach: " \
-          "#{credentials.authentication}"
+              "#{credentials.authentication}"
       end
     end
 

data/lib/calendav/event.rb

@@ -5,19 +5,28 @@ require_relative "./parsers/event_xml"
 
 module Calendav
   class Event
-    attr_reader :url, :calendar_data, :etag
+    ATTRIBUTES = %i[url calendar_data etag].freeze
 
     def self.from_xml(host, node)
       new(
-        ContextualURL.call(host, node.xpath("./dav:href").text),
-        Parsers::EventXML.call(node)
+        {
+          url: ContextualURL.call(host, node.xpath("./dav:href").text)
+        }.merge(
+          Parsers::EventXML.call(node)
+        )
       )
     end
 
-    def initialize(url, attributes = {})
-      @url = url
-      @calendar_data = attributes[:calendar_data]
-      @etag = attributes[:etag]
+    def initialize(attributes = {})
+      @attributes = attributes
+    end
+
+    ATTRIBUTES.each do |attribute|
+      define_method(attribute) { attributes[attribute] }
+    end
+
+    def to_h
+      attributes.dup
     end
 
     def summary
@@ -38,6 +47,8 @@ module Calendav
 
     private
 
+    attr_reader :attributes
+
     def inner_calendar
       Icalendar::Calendar.parse(calendar_data).first
     end

data/lib/calendav/parsers/sync_xml.rb

@@ -17,7 +17,7 @@ module Calendav
       end
 
       def call
-        SyncCollection.new(events, deleted_urls, token)
+        SyncCollection.new(events, deleted_urls, token, more?)
       end
 
       private
@@ -40,11 +40,23 @@ module Calendav
         @calendar_path ||= URI(calendar_url).path
       end
 
+      def calendar_response
+        multi_response
+          .detect { |node| node.xpath("./dav:href").text == calendar_path }
+      end
+
       def individual_responses
         multi_response
           .reject { |node| node.xpath("./dav:href").text == calendar_path }
       end
 
+      def more?
+        return false if calendar_response.nil?
+
+        status = calendar_response.xpath("./dav:propstat/dav:status").text
+        !status["507 Insufficient Storage"].nil?
+      end
+
       def token
         multi_response.xpath("/dav:multistatus/dav:sync-token").text
       end

data/lib/calendav/sync_collection.rb

@@ -2,12 +2,17 @@
 
 module Calendav
   class SyncCollection
-    attr_reader :changes, :deletions, :sync_token
+    attr_reader :changes, :deletions, :sync_token, :more
 
-    def initialize(changes, deletions, sync_token)
+    def initialize(changes, deletions, sync_token, more)
       @changes = changes
       @deletions = deletions
       @sync_token = sync_token
+      @more = more
+    end
+
+    def more?
+      more
     end
   end
 end

data/spec/acceptance/google_spec.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "google/apis/calendar_v3"
 require "googleauth"
 require "icalendar"
 require "securerandom"
@@ -12,20 +13,22 @@ RSpec.describe "Google" do
   let(:username) { ENV.fetch("GOOGLE_USERNAME") }
   let(:access_token) { @access_token }
   let(:credentials) { Calendav.credentials(provider, username, access_token) }
+  let(:google_auth) { @google_auth }
 
   subject { Calendav.client(credentials) }
 
   before :context do
+    @google_auth = Google::Auth::UserRefreshCredentials.new(
+      client_id: ENV.fetch("GOOGLE_CLIENT_ID"),
+      scope: [],
+      client_secret: ENV.fetch("GOOGLE_CLIENT_SECRET"),
+      refresh_token: ENV.fetch("GOOGLE_REFRESH_TOKEN"),
+      additional_parameters: { "access_type" => "offline" }
+    )
+
     @access_token = begin
-      credentials = Google::Auth::UserRefreshCredentials.new(
-        client_id: ENV.fetch("GOOGLE_CLIENT_ID"),
-        scope: [],
-        client_secret: ENV.fetch("GOOGLE_CLIENT_SECRET"),
-        refresh_token: ENV.fetch("GOOGLE_REFRESH_TOKEN"),
-        additional_parameters: { "access_type" => "offline" }
-      )
-      credentials.fetch_access_token!
-      credentials.access_token
+      @google_auth.fetch_access_token!
+      @google_auth.access_token
     end
   end
 
@@ -61,15 +64,20 @@ RSpec.describe "Google" do
 
   context "with a calendar" do
     let(:calendars) { subject.calendars.list }
-    let(:calendar) do
-      calendars.detect { |cal| cal.display_name == "Calendav Test" }
+    let(:calendar) { calendars.detect { |cal| cal.display_name == name } }
+    let(:name) { "Calendav Test #{Time.now.to_i}" }
+    let(:service) { Google::Apis::CalendarV3::CalendarService.new }
+    let(:entry) { Google::Apis::CalendarV3::Calendar.new(summary: name) }
+
+    before :each do
+      service.authorization = google_auth
+
+      result = service.insert_calendar entry
+      entry.update!(**result.to_h)
     end
 
     after :each do
-      subject
-        .events
-        .list(calendar.url)
-        .each { |event| subject.events.delete(event.url) }
+      service.delete_calendar entry.id
     end
 
     it_behaves_like "supporting event management"

data/spec/acceptance/shared.rb

@@ -105,6 +105,9 @@ RSpec.shared_examples "supporting event management" do
 
     expect(subject.events.find(event_url).summary).to eq("Coffee")
 
+    # Wait for server to catch up
+    sleep 1
+
     # Updating with the old etag should fail
     expect(
       subject.events.update(
@@ -139,6 +142,7 @@ RSpec.shared_examples "supporting event management" do
       .to match_encoded_urls([first_url, second_url])
 
     expect(collection.deletions).to be_empty
+    expect(collection.more?).to eq(false)
 
     subject.events.update(first_url, update_summary(first, "Brunch"))
     subject.events.delete(second_url)
@@ -150,6 +154,7 @@ RSpec.shared_examples "supporting event management" do
 
     expect(collection.deletions.length).to eq(1)
     expect(collection.deletions.first).to eq_encoded_url(second_url)
+    expect(collection.more?).to eq(false)
 
     subject.events.delete(first_url)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calendav
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Pat Allan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2021-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  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: googleauth
   requirement: !ruby/object:Gem::Requirement