calendly 0.1.1 → 0.4.0

data/lib/calendly/models/organization_invitation.rb

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
 
+require 'calendly/client'
+require 'calendly/models/model_utils'
+require 'calendly/models/organization'
+require 'calendly/models/user'
+
 module Calendly
   # Calendly's organization invitation model.
   class OrganizationInvitation
     include ModelUtils
     UUID_RE = %r{\A#{Client::API_HOST}/organizations/\w+/invitations/(\w+)\z}.freeze
     TIME_FIELDS = %i[created_at updated_at last_sent_at].freeze
-    ASSOCIATION = { user: User, organization: Organization }.freeze
+    ASSOCIATION = {user: User, organization: Organization}.freeze
 
     # @return [String]
     # unique id of the OrganizationInvitation object.

data/lib/calendly/models/organization_membership.rb

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
 
+require 'calendly/client'
+require 'calendly/models/model_utils'
+require 'calendly/models/organization'
+require 'calendly/models/user'
+
 module Calendly
   # Calendly's organization membership model.
   class OrganizationMembership
     include ModelUtils
     UUID_RE = %r{\A#{Client::API_HOST}/organization_memberships/(\w+)\z}.freeze
     TIME_FIELDS = %i[created_at updated_at].freeze
-    ASSOCIATION = { user: User, organization: Organization }.freeze
+    ASSOCIATION = {user: User, organization: Organization}.freeze
 
     # @return [String]
     # unique id of the OrganizationMembership object.
@@ -52,5 +57,50 @@ 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 = {})
+      return @cached_user_scope_webhooks if @cached_user_scope_webhooks
+
+      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 }
+      @cached_user_scope_webhooks = auto_pagination request_proc, opts
+    end
+
+    # @since 0.2.0
+    def user_scope_webhooks!(opts = {})
+      @cached_user_scope_webhooks = nil
+      user_scope_webhooks 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/user.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'calendly/client'
+require 'calendly/models/model_utils'
+
 module Calendly
   # Calendly's user model.
   # Primary account details of a specific user.
@@ -57,8 +60,16 @@ module Calendly
     # @raise [Calendly::Error] if the uri is empty.
     # @since 0.1.0
     def organization_membership
+      return @cached_organization_membership if @cached_organization_membership
+
       mems, = client.memberships_by_user uri
-      mems.first
+      @cached_organization_membership = mems.first
+    end
+
+    # @since 0.2.0
+    def organization_membership!
+      @cached_organization_membership = nil
+      organization_membership
     end
 
     #
@@ -67,14 +78,23 @@ module Calendly
     # @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 direction. Accepts comma-separated list of {field}:{direction} values.
+    # @option opts [String] :sort Order results by the specified field and direction.
+    # Accepts comma-separated list of {field}:{direction} values.
     # @return [Array<Calendly::EventType>]
     # @raise [Calendly::Error] if the uri is empty.
     # @raise [Calendly::ApiError] if the api returns error code.
     # @since 0.1.0
     def event_types(opts = {})
+      return @cached_event_types if @cached_event_types
+
       request_proc = proc { |options| client.event_types uri, options }
-      auto_pagination request_proc, opts
+      @cached_event_types = auto_pagination request_proc, opts
+    end
+
+    # @since 0.2.0
+    def event_types!(opts = {})
+      @cached_event_types = nil
+      event_types opts
     end
 
     #
@@ -83,18 +103,27 @@ module Calendly
     # @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] :max_start_time Upper bound (inclusive) for an event's start time to filter by.
+    # @option opts [String] :max_start_timeUpper 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] :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
     # @return [Array<Calendly::Event>]
     # @raise [Calendly::Error] if the uri is empty.
     # @raise [Calendly::ApiError] if the api returns error code.
     # @since 0.1.0
     def scheduled_events(opts = {})
+      return @cached_scheduled_events if @cached_scheduled_events
+
       request_proc = proc { |options| client.scheduled_events uri, options }
-      auto_pagination request_proc, opts
+      @cached_scheduled_events = auto_pagination request_proc, opts
+    end
+
+    # @since 0.2.0
+    def scheduled_events!(opts = {})
+      @cached_scheduled_events = nil
+      scheduled_events opts
     end
   end
 end

data/lib/calendly/models/webhook_subscription.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'calendly/client'
+require 'calendly/models/model_utils'
+require 'calendly/models/organization'
+require 'calendly/models/user'
+
+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.1'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calendly
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Kenji Koshikawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-27 00:00:00.000000000 Z
+date: 2020-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.4
-- !ruby/object:Gem::Dependency
-  name: zeitwerk
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -132,7 +118,7 @@ files:
 - ".github/workflows/gem-push.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
-- ".rubocom.yml"
+- ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -147,6 +133,7 @@ files:
 - lib/calendly/client.rb
 - lib/calendly/configuration.rb
 - lib/calendly/error.rb
+- lib/calendly/loggable.rb
 - lib/calendly/models/event.rb
 - lib/calendly/models/event_type.rb
 - lib/calendly/models/invitee.rb
@@ -158,6 +145,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:
@@ -166,7 +154,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.1
+  documentation_uri: https://www.rubydoc.info/gems/calendly/0.4.0
 post_install_message: 
 rdoc_options: []
 require_paths: