mobiscroll-connect 1.2.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b31a5377ff60ec4d4e5601e084d736e26bad0250ffb3c57f21e9763cbe32ce1f
-  data.tar.gz: ecaf0a97ba89509bd0ce3eba1f33d37024d0a3cdac5ff2e6cfbe85ec9bdd0395
+  metadata.gz: a5b667cc604c98500160cd034837d4ef9b097ef5a08e50ff9ab75ec451f41d5f
+  data.tar.gz: b3d758a7b2cc387d570526a6ddae75ce216d12082ee156b341343942362e4f3c
 SHA512:
-  metadata.gz: f98b8378045037ee79e53b5b5394beeb42b1ea92a0641cf0412e0598ec9bf92296568ebf8c46d625d260967e397e891110c204bd5fe6e69ae60e8d7e95cfccc2
-  data.tar.gz: 9a92b7c19a5dada68228e6d2533b996352e74b104089f3cac3676db05e9d877b08eaedc207e268067710ca81b9ea6ce85f6952086f156c047ffe59b5852a5c8b
+  metadata.gz: debeb4453999f74a080e45b5e1c1ea6ade00a6a3f370c665be12c2ce1e994244c7256738734ac00fa893cb754dd132a620aa63dc292fcb722f66b348e16cb455
+  data.tar.gz: 20c2e49dec99acc7fe35b4cf42b2a7a084a00d23ea86f802cd7714d5fbcf5a82c35c09cf57997d99ca688b3e6e16b5e8dace0ade00e64b16feaaa25eb32828f7

data/CHANGELOG.md

@@ -0,0 +1,49 @@
+# Changelog
+
+All notable changes to the Mobiscroll Connect Ruby SDK (RubyGems: `mobiscroll-connect`) are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this SDK follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html). SDKs in this monorepo version independently, so this file covers the Ruby SDK only.
+
+## [1.5.1] — 2026-09-22
+
+### Changed
+
+- Updated package metadata. No code or public API changes.
+
+## [1.5.0] — 2026-09-21
+
+### Added
+
+- `webhooks` resource with `subscribe_webhook()` and `unsubscribe_webhook()` for calendar change notifications.
+- `sync_state` and `sync_state_updated_at` on `ConnectedAccount`.
+
+## [1.2.0] — 2026-08-27
+
+### Added
+
+- Granted OAuth scopes are reported on the connection status, and a missing scope now raises `CalendarPermissionError`.
+
+## [1.1.0] — 2026-06-03
+
+### Added
+
+- Optional `lng` parameter on the authorization URL, for Connect's localized consent screens.
+
+## [1.0.2] — 2026-05-26
+
+### Added
+
+- First published release: `auth`, `calendars` and `events` resources over Google Calendar, Microsoft Outlook, Apple Calendar and CalDAV.
+- Automatic token refresh on 401 with an `on_tokens_refreshed` callback.
+- Typed error hierarchy rooted at `Mobiscroll::Connect::Error`.
+- Sinatra reference application under `minimal-app/`.
+
+### Changed
+
+- Minimum supported Ruby raised to 3.2.
+
+[1.5.1]: https://github.com/acidb/mobiscroll-connect-sdks/releases/tag/ruby-v1.5.1
+[1.5.0]: https://github.com/acidb/mobiscroll-connect-sdks/releases/tag/ruby-v1.5.0
+[1.2.0]: https://github.com/acidb/mobiscroll-connect-sdks/releases/tag/ruby-v1.2.0
+[1.1.0]: https://github.com/acidb/mobiscroll-connect-sdks/releases/tag/ruby-v1.1.0
+[1.0.2]: https://github.com/acidb/mobiscroll-connect-sdks/releases/tag/ruby-v1.0.2

data/README.md

@@ -1,6 +1,10 @@
 # Mobiscroll Connect Ruby SDK
 
-Official Ruby client for the [Mobiscroll Connect API](https://connect.mobiscroll.com). Sync calendar events across Google Calendar, Microsoft Outlook, Apple Calendar, and CalDAV.
+Ruby client for [Mobiscroll Connect](https://mobiscroll.com/connect), the calendar connectivity layer for scheduling products — Google Calendar, Microsoft Outlook, Apple Calendar and CalDAV through one API. Backend only — works with your own UI.
+
+[![RubyGems](https://img.shields.io/gem/v/mobiscroll-connect?label=RubyGems)](https://rubygems.org/gems/mobiscroll-connect)
+
+**[RubyGems](https://rubygems.org/gems/mobiscroll-connect)** · **[Documentation](https://mobiscroll.com/docs/connect/ruby-sdk)** · **[Changelog](CHANGELOG.md)** · **[Source](https://github.com/acidb/mobiscroll-connect-sdks/tree/main/sdks/ruby)**
 
 ## Installation
 
@@ -170,6 +174,29 @@ client.events.delete(
 )
 ```
 
+## Webhooks
+
+### Subscribe to calendar change notifications
+
+```ruby
+result = client.webhooks.subscribe_webhook(
+  provider:    Mobiscroll::Connect::Provider::GOOGLE,
+  calendar_id: 'primary'
+)
+puts result.channel_id
+puts result.server_webhook_url
+```
+
+### Unsubscribe
+
+```ruby
+client.webhooks.unsubscribe_webhook(
+  provider:    'google',
+  channel_id:  result.channel_id,
+  resource_id: result.subscription.resource_id
+)
+```
+
 ## Error handling
 
 All errors are subclasses of `Mobiscroll::Connect::Error`:

data/lib/mobiscroll/connect/client.rb

@@ -3,7 +3,7 @@
 module Mobiscroll
   module Connect
     class Client
-      attr_reader :auth, :calendars, :events
+      attr_reader :auth, :calendars, :events, :webhooks
 
       def initialize(client_id:, client_secret:, redirect_uri:,
                      base_url: DEFAULT_BASE_URL, timeout: DEFAULT_TIMEOUT,
@@ -20,6 +20,7 @@ module Mobiscroll
         @auth = Resources::Auth.new(@config, @api_client)
         @calendars = Resources::Calendars.new(@config, @api_client)
         @events = Resources::Events.new(@config, @api_client)
+        @webhooks = Resources::Webhooks.new(@config, @api_client)
       end
 
       def set_credentials(tokens)

data/lib/mobiscroll/connect/models.rb

@@ -57,7 +57,15 @@ module Mobiscroll
     # no calendars can be read from them until the user reconnects and allows access. It
     # is nil when the question does not apply (Apple and CalDav authenticate with a
     # username and app password) or no scopes were recorded for the account.
-    ConnectedAccount = Struct.new(:id, :display, :granted_scopes, :calendar_permission_granted, keyword_init: true) do
+    # `sync_state` reports whether the stored credentials still work: 'active', or
+    # 'reauth_required' once the provider has rejected them. It answers a different question
+    # from `calendar_permission_granted`, which records what was agreed at consent time and
+    # never changes afterwards. An account with no observed failure is 'active'. Recovery is
+    # the same reconnect — it cannot be repaired server-side.
+    ConnectedAccount = Struct.new(
+      :id, :display, :granted_scopes, :calendar_permission_granted, :sync_state, :sync_state_updated_at,
+      keyword_init: true
+    ) do
       def self.from_h(hash)
         return nil if hash.nil?
 
@@ -67,7 +75,9 @@ module Mobiscroll
           id: hash['id'] || hash[:id],
           display: hash['display'] || hash[:display],
           granted_scopes: Array(hash['grantedScopes'] || hash[:grantedScopes]),
-          calendar_permission_granted: granted
+          calendar_permission_granted: granted,
+          sync_state: hash['syncState'] || hash[:syncState] || 'active',
+          sync_state_updated_at: hash['syncStateUpdatedAt'] || hash[:syncStateUpdatedAt]
         )
       end
     end
@@ -200,5 +210,47 @@ module Mobiscroll
         )
       end
     end
+
+    # The channel details returned by Webhooks#subscribe_webhook. `resource_id` is
+    # present for Google; `expiration` is an ISO date string, present for some providers.
+    WebhookSubscription = Struct.new(:channel_id, :resource_id, :expiration, keyword_init: true) do
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          channel_id: hash['channelId'] || hash[:channelId],
+          resource_id: hash['resourceId'] || hash[:resourceId],
+          expiration: hash['expiration'] || hash[:expiration]
+        )
+      end
+    end
+
+    # Response from Webhooks#subscribe_webhook.
+    SubscribeWebhookResponse = Struct.new(
+      :success, :provider, :subscription, :server_webhook_url, :channel_id, keyword_init: true
+    ) do
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          success: hash['success'] || hash[:success],
+          provider: hash['provider'] || hash[:provider],
+          subscription: WebhookSubscription.from_h(hash['subscription'] || hash[:subscription]),
+          server_webhook_url: hash['serverWebhookUrl'] || hash[:serverWebhookUrl],
+          channel_id: hash['channelId'] || hash[:channelId]
+        )
+      end
+    end
+
+    # Response from Webhooks#unsubscribe_webhook. `success` is true whenever the local
+    # mapping was removed, even if the provider-side unsubscribe itself failed — `message`
+    # explains what happened in that case.
+    UnsubscribeWebhookResponse = Struct.new(:success, :message, keyword_init: true) do
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(success: hash['success'] || hash[:success], message: hash['message'] || hash[:message])
+      end
+    end
   end
 end

data/lib/mobiscroll/connect/resources/webhooks.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Mobiscroll
+  module Connect
+    module Resources
+      class Webhooks
+        def initialize(_config, api_client)
+          @api_client = api_client
+        end
+
+        # Subscribes to push notifications for changes on a calendar.
+        #
+        # `channel_id` is auto-generated server-side when omitted. `expiration` is a
+        # provider-specific timestamp (ms epoch) the caller can suggest.
+        def subscribe_webhook(provider:, calendar_id:, channel_id: nil, expiration: nil)
+          body = { 'provider' => provider, 'calendarId' => calendar_id }
+          body['channelId'] = channel_id if channel_id
+          body['expiration'] = expiration if expiration
+
+          parsed = @api_client.post('/subscribe-webhook', body: JSON.generate(body))
+          SubscribeWebhookResponse.from_h(parsed)
+        end
+
+        # Unsubscribes a previously created webhook channel. `resource_id` is required by
+        # some providers (e.g. Google) to fully unsubscribe.
+        #
+        # The backend treats a 200 response as final even when the provider-side
+        # unsubscribe itself failed (e.g. an already-expired subscription) — the local
+        # mapping is removed either way, and `message` explains what happened.
+        def unsubscribe_webhook(provider:, channel_id:, resource_id: nil)
+          body = { 'provider' => provider, 'channelId' => channel_id }
+          body['resourceId'] = resource_id if resource_id
+
+          parsed = @api_client.post('/unsubscribe-webhook', body: JSON.generate(body))
+          UnsubscribeWebhookResponse.from_h(parsed)
+        end
+      end
+    end
+  end
+end

data/lib/mobiscroll/connect/version.rb

@@ -2,6 +2,6 @@
 
 module Mobiscroll
   module Connect
-    VERSION = '1.2.0'
+    VERSION = '1.5.1'
   end
 end

data/lib/mobiscroll/connect.rb

@@ -9,6 +9,7 @@ require_relative 'connect/api_client'
 require_relative 'connect/resources/auth'
 require_relative 'connect/resources/calendars'
 require_relative 'connect/resources/events'
+require_relative 'connect/resources/webhooks'
 require_relative 'connect/client'
 
 module Mobiscroll

data/mobiscroll-connect.gemspec

@@ -8,10 +8,13 @@ Gem::Specification.new do |spec|
   spec.authors     = ['Mobiscroll']
   spec.email       = ['support@mobiscroll.com']
 
-  spec.summary     = 'Official Ruby SDK for the Mobiscroll Connect API.'
-  spec.description = 'Ruby client for the Mobiscroll Connect API. Unified ' \
-                     'OAuth, calendars, and events across Google Calendar, ' \
-                     'Microsoft Outlook, Apple Calendar, and CalDAV.'
+  spec.summary     = 'Ruby client for Mobiscroll Connect — Google Calendar, ' \
+                     'Microsoft Outlook, Apple Calendar and CalDAV through one API.'
+  spec.description = 'Ruby client for Mobiscroll Connect, the calendar ' \
+                     'connectivity layer for scheduling products. Google ' \
+                     'Calendar, Microsoft Outlook, Apple Calendar and CalDAV ' \
+                     'through one API, with OAuth 2.0 and webhooks. Backend ' \
+                     'only — works with your own UI.'
   spec.homepage    = 'https://mobiscroll.com/connect'
   spec.license     = 'MIT'
 
@@ -20,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.metadata = {
     'homepage_uri' => spec.homepage,
     'source_code_uri' => 'https://github.com/acidb/mobiscroll-connect-sdks',
+    'documentation_uri' => 'https://mobiscroll.com/docs/connect/ruby-sdk',
     'bug_tracker_uri' => 'https://github.com/acidb/mobiscroll-connect-sdks/issues',
     'changelog_uri' => 'https://github.com/acidb/mobiscroll-connect-sdks/blob/main/sdks/ruby/CHANGELOG.md',
     'rubygems_mfa_required' => 'true'
@@ -28,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.files = Dir[
     'lib/**/*.rb',
     'README.md',
+    'CHANGELOG.md',
     'LICENSE',
     'mobiscroll-connect.gemspec'
   ]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mobiscroll-connect
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Mobiscroll
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-27 00:00:00.000000000 Z
+date: 2026-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -80,14 +80,17 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.23'
-description: Ruby client for the Mobiscroll Connect API. Unified OAuth, calendars,
-  and events across Google Calendar, Microsoft Outlook, Apple Calendar, and CalDAV.
+description: Ruby client for Mobiscroll Connect, the calendar connectivity layer for
+  scheduling products. Google Calendar, Microsoft Outlook, Apple Calendar and CalDAV
+  through one API, with OAuth 2.0 and webhooks. Backend only — works with your own
+  UI.
 email:
 - support@mobiscroll.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 - lib/mobiscroll-connect.rb
@@ -101,6 +104,7 @@ files:
 - lib/mobiscroll/connect/resources/auth.rb
 - lib/mobiscroll/connect/resources/calendars.rb
 - lib/mobiscroll/connect/resources/events.rb
+- lib/mobiscroll/connect/resources/webhooks.rb
 - lib/mobiscroll/connect/version.rb
 - mobiscroll-connect.gemspec
 homepage: https://mobiscroll.com/connect
@@ -109,6 +113,7 @@ licenses:
 metadata:
   homepage_uri: https://mobiscroll.com/connect
   source_code_uri: https://github.com/acidb/mobiscroll-connect-sdks
+  documentation_uri: https://mobiscroll.com/docs/connect/ruby-sdk
   bug_tracker_uri: https://github.com/acidb/mobiscroll-connect-sdks/issues
   changelog_uri: https://github.com/acidb/mobiscroll-connect-sdks/blob/main/sdks/ruby/CHANGELOG.md
   rubygems_mfa_required: 'true'
@@ -130,5 +135,6 @@ requirements: []
 rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
-summary: Official Ruby SDK for the Mobiscroll Connect API.
+summary: Ruby client for Mobiscroll Connect — Google Calendar, Microsoft Outlook,
+  Apple Calendar and CalDAV through one API.
 test_files: []