calendly 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f21bb676098bf2f9d6f6e3ea600f7c4017d48207834646b185dbd459a6a8a531
-  data.tar.gz: e5e2accd3cc7145d99b3457f7ed87d79223b3b9fc18e0d49abdeb3a6b75b094f
+  metadata.gz: 73fe04308ea6b80fec0d5141f3a848476d0b4dd0e818cc32019ab54f9ad02243
+  data.tar.gz: 2adaee2381b6631af1d19eb07d0fa122b1cd8d347c877c07808bac5cb3670d6e
 SHA512:
-  metadata.gz: ad14b69a614f2f3d39ff993f58b2b5c6f2e5c3a3d74a41b24ac5b17a9a6e915a84f0b99a7282695827d73009019d7ab9c6209a60c1ce8063609f5ab4a1cf5ba1
-  data.tar.gz: 5c5418b39536db9b1d88247e963e9277ae0964eaa64fdd7aabaef9edc29024aa6afed84e4df9b542fd93bf65fd0f311bdc467365bb7ac3097cc2a1a371dd5774
+  metadata.gz: 3a3b7a7dc8926ea80d87e9a3cc5b96a4c6816b78baebeac4d28773eba80ad6078c44ea379e01d0be87ecd47bc8f12eef4d64516a67b7e11adc2a5e843aacc9a7
+  data.tar.gz: bf1eb06ab1432c27b7d557cd4c703a6d157ce26f526942a89f3102b34c9d8ba6b3e123d78b5e7ca53348e49125be7e2e3423da7f68540c799745b7b2c35d8c3b

data/CHANGELOG.md

@@ -1,5 +1,14 @@
+
 # CHANGELOG
 
+## 0.1.3
+
+- support webhook APIs
+  - `GET /webhook_subscriptions`
+  - `GET /webhook_subscriptions/{webhook_uuid}`
+  - `POST /webhook_subscriptions`
+  - `DELETE /webhook_subscriptions/{webhook_uuid}`
+
 ## 0.1.2
 
 - fix rubocop warnings.

data/README.md

@@ -35,7 +35,10 @@ As of now the supported statuses each Calendly API are as below.
   - [x] Get List of Event Invitees
   - [x] Get List of User Events
 - Webhook V2
-  - These endpoints havn't been released yet.
+  - [x] Create Webhook Subscription
+  - [x] Delete Webhook Subscription
+  - [x] Get Webhook Subscription
+  - [x] List Webhook Subscriptions
 
 ## Installation
 
@@ -55,6 +58,8 @@ Or install it yourself as:
 
 ## Usage
 
+### Basic
+
 The APIs client needs access token.
 This client setup step is below.
 
@@ -116,7 +121,50 @@ invitation.status
 
 # cancel the invitation
 invitation.delete
+```
+
+### Webhook
+
+The webhook usage is below.
+
+```ruby
+events = ['invitee.created', 'invitee.canceled']
+own_member = client.me.organization_membership
+org = own_member.organization
+
+# create user scope webhook
+url = 'https://example.com/received_event'
+user_webhook = own_member.create_user_scope_webhook(url, events)
+# => #<Calendly::WebhookSubscription uuid:USER_WEBHOOK_001>
+
+# list of user scope webhooks
+own_member.user_scope_webhooks
+# => [#<Calendly::WebhookSubscription uuid:USER_WEBHOOK_001>]
+
+# delete the webhook
+user_webhook.delete
+# => true
 
+
+# create organization scope webhook
+url = 'https://example.com/received_event'
+org_webhook = org.create_webhook(url, events)
+# => #<Calendly::WebhookSubscription uuid:ORG_WEBHOOK_001>
+
+# list of organization scope webhooks
+org.webhooks
+# => [#<Calendly::WebhookSubscription uuid:ORG_WEBHOOK_001>]
+
+# delete the webhook
+org_webhook.delete
+# => true
+```
+
+### Logging
+
+This library supports a configurable logger.
+
+```ruby
 # if the log level set :debug, you can get the request/response information.
 Calendly.configuration.logger.level = :debug
 invitation = my_org.create_invitation('foobar@example.com')

data/lib/calendly/client.rb

@@ -125,12 +125,12 @@ module Calendly
     # @param [String] user_uri the specified user (user's uri).
     # @param [Hash] opts the optional request parameters.
     # @option opts [Integer] :count Number of rows to return.
-    # @option opts [String] :invitee_email Return events scheduled with the specified invitee email
+    # @option opts [String] :invitee_email Return events scheduled with the specified invitee email.
     # @option opts [String] :max_start_time Upper bound (inclusive) for an event's start time to filter by.
     # @option opts [String] :min_start_time Lower bound (inclusive) for an event's start time to filter by.
     # @option opts [String] :page_token Pass this to get the next portion of collection.
     # @option opts [String] :sort Order results by the specified field and directin. Accepts comma-separated list of {field}:{direction} values.
-    # @option opts [String] :status Whether the scheduled event is active or canceled
+    # @option opts [String] :status Whether the scheduled event is active or canceled.
     # @return [Array<Array<Calendly::Event>, Hash>]
     #  - [Array<Calendly::Event>] events
     #  - [Hash] next_params the parameters to get next data. if thre is no next it returns nil.
@@ -362,6 +362,118 @@ module Calendly
       true
     end
 
+    #
+    # Get a webhook subscription for an organization or user with a specified UUID.
+    #
+    # @param [String] uuid the specified webhook (webhook's uuid).
+    # @return [Calendly::WebhookSubscription]
+    # @raise [Calendly::Error] if the uuid arg is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.1.3
+    def webhook(uuid)
+      check_not_empty uuid, 'uuid'
+      body = request :get, "webhook_subscriptions/#{uuid}"
+      WebhookSubscription.new body[:resource], self
+    end
+
+    #
+    # Get List of organization scope Webhooks.
+    #
+    # @param [String] org_uri the specified organization (organization's uri).
+    # @param [Hash] opts the optional request parameters.
+    # @option opts [Integer] :count Number of rows to return.
+    # @option opts [String] :page_token Pass this to get the next portion of collection.
+    # @option opts [String] :sort Order results by the specified field and directin. Accepts comma-separated list of {field}:{direction} values.
+    # @return [Array<Array<Calendly::WebhookSubscription>, Hash>]
+    #  - [Array<Calendly::WebhookSubscription>] webhooks
+    #  - [Hash] next_params the parameters to get next data. if thre is no next it returns nil.
+    # @raise [Calendly::Error] if the org_uri arg is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.1.3
+    def webhooks(org_uri, opts = {})
+      check_not_empty org_uri, 'org_uri'
+
+      opts_keys = %i[count page_token sort]
+      params = {organization: org_uri, scope: 'organization'}
+      params = merge_options opts, opts_keys, params
+      body = request :get, 'webhook_subscriptions', params: params
+      items = body[:collection] || []
+      evs = items.map { |item| WebhookSubscription.new item, self }
+      [evs, next_page_params(body)]
+    end
+
+    #
+    # Get List of user scope Webhooks.
+    #
+    # @param [String] org_uri the specified organization (organization's uri).
+    # @param [String] user_uri the specified user (user's uri).
+    # @param [Hash] opts the optional request parameters.
+    # @option opts [Integer] :count Number of rows to return.
+    # @option opts [String] :page_token Pass this to get the next portion of collection.
+    # @option opts [String] :sort Order results by the specified field and directin. Accepts comma-separated list of {field}:{direction} values.
+    # @return [Array<Array<Calendly::WebhookSubscription>, Hash>]
+    #  - [Array<Calendly::WebhookSubscription>] webhooks
+    #  - [Hash] next_params the parameters to get next data. if thre is no next it returns nil.
+    # @raise [Calendly::Error] if the org_uri arg is empty.
+    # @raise [Calendly::Error] if the user_uri arg is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.1.3
+    def user_scope_webhooks(org_uri, user_uri, opts = {})
+      check_not_empty org_uri, 'org_uri'
+      check_not_empty user_uri, 'user_uri'
+
+      opts_keys = %i[count page_token sort]
+      params = {organization: org_uri, user: user_uri, scope: 'user'}
+      params = merge_options opts, opts_keys, params
+      body = request :get, 'webhook_subscriptions', params: params
+      items = body[:collection] || []
+      evs = items.map { |item| WebhookSubscription.new item, self }
+      [evs, next_page_params(body)]
+    end
+
+    #
+    # Create a webhook subscription for an organization or user.
+    #
+    # @param [String] url Canonical reference (unique identifier) for the resource.
+    # @param [Array<String>] events List of user events to subscribe to. options: invitee.created or invitee.canceled
+    # @param [String] org_uri The unique reference to the organization that the webhook will be tied to.
+    # @param [String] user_uri The unique reference to the user that the webhook will be tied to.
+    # @return [Calendly::WebhookSubscription]
+    # @raise [Calendly::Error] if the url arg is empty.
+    # @raise [Calendly::Error] if the events arg is empty.
+    # @raise [Calendly::Error] if the org_uri arg is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.1.3
+    def create_webhook(url, events, org_uri, user_uri = nil)
+      check_not_empty url, 'url'
+      check_not_empty events, 'events'
+      check_not_empty org_uri, 'org_uri'
+
+      params = {url: url, events: events, organization: org_uri}
+      if user_uri
+        params[:scope] = 'user'
+        params[:user] = user_uri
+      else
+        params[:scope] = 'organization'
+      end
+      body = request(:post, 'webhook_subscriptions', body: params)
+      WebhookSubscription.new body[:resource], self
+    end
+
+    #
+    # Delete a webhook subscription for an organization or user with a specified UUID.
+    #
+    # @param [String] uuid the specified webhook (webhook's uuid).
+    # @return [true]
+    # @raise [Calendly::Error] if the uuid arg is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.1.3
+    def delete_webhook(uuid)
+      check_not_empty uuid, 'uuid'
+      request :delete, "webhook_subscriptions/#{uuid}"
+      true
+    end
+
   private
 
     def request(method, path, params: nil, body: nil)
@@ -389,6 +501,7 @@ module Calendly
     def blank?(value)
       return true if value.nil?
       return true if value.to_s.empty?
+      return true if value.is_a?(Array) && value.empty?
 
       false
     end

data/lib/calendly/models/model_utils.rb

@@ -68,10 +68,10 @@ module Calendly
       attrs.each do |key, value|
         next unless respond_to? "#{key}=".to_sym
 
-        if defined?(self.class::ASSOCIATION) && self.class::ASSOCIATION.key?(key)
+        if value && defined?(self.class::ASSOCIATION) && self.class::ASSOCIATION.key?(key)
           associated_attrs = value.is_a?(Hash) ? value : {uri: value}
           value = self.class::ASSOCIATION[key].new associated_attrs, @client
-        elsif defined?(self.class::TIME_FIELDS) && self.class::TIME_FIELDS.include?(key)
+        elsif value && defined?(self.class::TIME_FIELDS) && self.class::TIME_FIELDS.include?(key)
           value = Time.parse value
         end
         instance_variable_set "@#{key}", value

data/lib/calendly/models/organization.rb

@@ -60,5 +60,37 @@ module Calendly
     def create_invitation(email)
       client.create_invitation uuid, email
     end
+
+    #
+    # Get List of organization scope Webhooks associated with self.
+    #
+    # @param [Hash] opts the optional request parameters.
+    # @option opts [Integer] :count Number of rows to return.
+    # @option opts [String] :page_token Pass this to get the next portion of collection.
+    # @option opts [String] :sort Order results by the specified field and directin. Accepts comma-separated list of {field}:{direction} values.
+    # Accepts comma-separated list of {field}:{direction} values.
+    # @return [Array<Calendly::WebhookSubscription>]
+    # @raise [Calendly::Error] if the uri is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.1.3
+    def webhooks(opts = {})
+      request_proc = proc { |options| client.webhooks uri, options }
+      auto_pagination request_proc, opts
+    end
+
+    #
+    # Create a user scope webhook associated with self.
+    #
+    # @param [String] url Canonical reference (unique identifier) for the resource.
+    # @param [Array<String>] events List of user events to subscribe to. options: invitee.created or invitee.canceled
+    # @return [Calendly::WebhookSubscription]
+    # @raise [Calendly::Error] if the url arg is empty.
+    # @raise [Calendly::Error] if the events arg is empty.
+    # @raise [Calendly::Error] if the uri is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.1.3
+    def create_webhook(url, events)
+      client.create_webhook url, events, uri
+    end
   end
 end

data/lib/calendly/models/organization_membership.rb

@@ -52,5 +52,42 @@ module Calendly
     def delete
       client.delete_membership uuid
     end
+
+    #
+    # Get List of user scope Webhooks associated with self.
+    #
+    # @param [Hash] opts the optional request parameters.
+    # @option opts [Integer] :count Number of rows to return.
+    # @option opts [String] :page_token Pass this to get the next portion of collection.
+    # @option opts [String] :sort Order results by the specified field and directin. Accepts comma-separated list of {field}:{direction} values.
+    # Accepts comma-separated list of {field}:{direction} values.
+    # @return [Array<Calendly::WebhookSubscription>]
+    # @raise [Calendly::Error] if the organization.uri is empty.
+    # @raise [Calendly::Error] if the user.uri is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.1.3
+    def user_scope_webhooks(opts = {})
+      org_uri = organization.uri if organization
+      user_uri = user.uri if user
+      request_proc = proc { |options| client.user_scope_webhooks org_uri, user_uri, options }
+      auto_pagination request_proc, opts
+    end
+
+    #
+    # Create a user scope webhook associated with self.
+    #
+    # @param [String] url Canonical reference (unique identifier) for the resource.
+    # @param [Array<String>] events List of user events to subscribe to. options: invitee.created or invitee.canceled
+    # @return [Calendly::WebhookSubscription]
+    # @raise [Calendly::Error] if the url arg is empty.
+    # @raise [Calendly::Error] if the events arg is empty.
+    # @raise [Calendly::Error] if the organization.uri is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.1.3
+    def create_user_scope_webhook(url, events)
+      org_uri = organization.uri if organization
+      user_uri = user.uri if user
+      client.create_webhook url, events, org_uri, user_uri
+    end
   end
 end

data/lib/calendly/models/webhook_subscription.rb

@@ -0,0 +1,72 @@
+# Get a webhook subscription matching the provided UUID for the webhook subscription
+
+# frozen_string_literal: true
+
+module Calendly
+  # Calendly's webhook model.
+  class WebhookSubscription
+    include ModelUtils
+    UUID_RE = %r{\A#{Client::API_HOST}/webhook_subscriptions/(\w+)\z}.freeze
+    TIME_FIELDS = %i[created_at updated_at retry_started_at].freeze
+    ASSOCIATION = {organization: Organization, user: User, creator: User}.freeze
+
+    # @return [String]
+    # unique id of the WebhookSubscription object.
+    attr_accessor :uuid
+    # @return [String]
+    # Canonical reference (unique identifier) for the webhook.
+    attr_accessor :uri
+    # @return [String]
+    # The callback URL to use when the event is triggered.
+    attr_accessor :callback_url
+    # @return [Time]
+    # The moment when the webhook subscription was created.
+    attr_accessor :created_at
+    # @return [Time]
+    # The moment when the webhook subscription was last updated.
+    attr_accessor :updated_at
+    # @return [Time]
+    # The date and time the webhook subscription is retried.
+    attr_accessor :retry_started_at
+    # @return [String]
+    # Indicates if the webhook subscription is "active" or "disabled".
+    attr_accessor :state
+    # @return [Array<String>]
+    # A list of events to which the webhook is subscribed.
+    attr_accessor :events
+    # @return [String]
+    # The scope of the webhook subscription.
+    attr_accessor :scope
+    # @return [Calendly::Organization]
+    # The organization that's associated with the webhook subscription.
+    attr_accessor :organization
+    # @return [Calendly::User]
+    # The user that's associated with the webhook subscription.
+    attr_accessor :user
+    # @return [Calendly::User]
+    # The user who created the webhook subscription.
+    attr_accessor :creator
+
+    #
+    # Get a webhook subscription associated with self.
+    #
+    # @return [Calendly::WebhookSubscription]
+    # @raise [Calendly::Error] if the uuid is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.1.3
+    def fetch
+      client.webhook uuid
+    end
+
+    #
+    # Delete a webhook subscription associated with self.
+    #
+    # @return [true]
+    # @raise [Calendly::Error] if the uuid is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.1.0
+    def delete
+      client.delete_webhook uuid
+    end
+  end
+end

data/lib/calendly/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Calendly
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calendly
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Kenji Koshikawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-03 00:00:00.000000000 Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -159,6 +159,7 @@ files:
 - lib/calendly/models/organization_invitation.rb
 - lib/calendly/models/organization_membership.rb
 - lib/calendly/models/user.rb
+- lib/calendly/models/webhook_subscription.rb
 - lib/calendly/version.rb
 homepage: https://github.com/koshilife/calendly-api-ruby-client
 licenses:
@@ -167,7 +168,7 @@ metadata:
   homepage_uri: https://github.com/koshilife/calendly-api-ruby-client
   source_code_uri: https://github.com/koshilife/calendly-api-ruby-client
   changelog_uri: https://github.com/koshilife/calendly-api-ruby-client/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/calendly/0.1.2
+  documentation_uri: https://www.rubydoc.info/gems/calendly/0.1.3
 post_install_message: 
 rdoc_options: []
 require_paths: