calendly 0.8.3 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 706fe58387318797ed3fed0c46c629a52eaa9b3ef2b22ed160bbbb203e8b7ad8
-  data.tar.gz: 1329d04a6eeeb29da76a83b0b36e716368df61766055ea11684552d337526617
+  metadata.gz: e963f8454cbbe7258a4d48a39903e48dfeade06599a5b7082b1539f96683be3a
+  data.tar.gz: 65e386995a0f23f6f860e031855d30198c654959b54ff8820e8dbf0524f570da
 SHA512:
-  metadata.gz: 6b14cc3eb57722550794456b53405bdad576b426218beca539b8c92949e060ec75c9374d17b5fa3aea2835d863c57483bcf0a51bbe9c931ed35b1c61e259c709
-  data.tar.gz: 9a526d1719c5eca1f8bf43823b95e22307f650e5b5a833cf93caffb40c1d2b7094f9c9e452dc3e0dc3164e2fba645b4489027d5f6a0b20a52bc01af7c9541af7
+  metadata.gz: f62928cf0d2381f92c18f203e830df716b07608e973dab83c716f471ab14b10b631de844e06fa24df634df35b64cb42efb37a1011de897c235c7eb0aed90069d
+  data.tar.gz: 533661d0e183c24efbd53124dcfabce96812d3e6aa794afb25a9716bfb0d093d1a89e81c2cac4b968e8404c260cebd5b22c7e946204fcde0b1bff0bf575348f4

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # CHANGELOG
 
+## 0.9.0 - 2022-04-14
+
+- supported no show APIs. (#45)
+  - `GET /invitee_no_shows/{no_show_uuid}`
+  - `POST /invitee_no_shows`
+  - `DELETE /invitee_no_shows/{no_show_uuid}`
+  - changed files:
+    - Client
+      - (Add method) invitee_no_show
+      - (Add method) create_invitee_no_show
+      - (Add method) delete_invitee_no_show
+    - Invitee model
+      - (Add field) no_show
+      - (Add method) mark_no_show
+      - (Add method) unmark_no_show
+    - (New) InviteeNoShow model
+- To simplify `require` statements changed `Model::ASSOCIATION` constant to class methods and removed unused lines.
+
 ## 0.8.3 - 2022-03-08
 
 - support for filtering Event Types by 'active' or 'inactive' status. (#43)

data/calendly.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'codecov'
   spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'webmock'
 end

data/lib/calendly/client.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'oauth2'
+require 'calendly/loggable'
 
 module Calendly
   # Calendly apis client.
@@ -281,6 +282,55 @@ module Calendly
       [evs, next_page_params(body)]
     end
 
+    #
+    # Get Invitee No Show
+    # Returns information about a specified Invitee No Show.
+    #
+    # @param [String] uuid the specified no show.
+    # @return [Calendly::InviteeNoShow]
+    # @raise [Calendly::Error] if the uuid arg is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.9.0
+    def invitee_no_show(uuid)
+      check_not_empty uuid, 'uuid'
+      body = request :get, "invitee_no_shows/#{uuid}"
+      InviteeNoShow.new body[:resource], self
+    end
+
+    #
+    # Create Invitee No Show
+    # Marks an Invitee as a No Show.
+    #
+    # @param [String] invitee_uri the specified invitee's uri.
+    # @return [Calendly::InviteeNoShow]
+    # @raise [Calendly::Error] if the invitee_uri arg is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.9.0
+    def create_invitee_no_show(invitee_uri)
+      check_not_empty invitee_uri, 'invitee_uri'
+      body = request(
+        :post,
+        'invitee_no_shows',
+        body: {invitee: invitee_uri}
+      )
+      InviteeNoShow.new body[:resource], self
+    end
+
+    #
+    # Delete Invitee No Show
+    # Undoes marking an Invitee as a No Show.
+    #
+    # @param [String] uuid the specified no show.
+    # @return [true]
+    # @raise [Calendly::Error] if the uuid arg is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.9.0
+    def delete_invitee_no_show(uuid)
+      check_not_empty uuid, 'uuid'
+      request :delete, "invitee_no_shows/#{uuid}"
+      true
+    end
+
     #
     # Returns information about a user's organization membership
     #

data/lib/calendly/models/event.rb

@@ -1,13 +1,5 @@
 # frozen_string_literal: true
 
-require 'calendly/client'
-require 'calendly/models/model_utils'
-require 'calendly/models/event_type'
-require 'calendly/models/guest'
-require 'calendly/models/invitee_cancellation'
-require 'calendly/models/invitees_counter'
-require 'calendly/models/location'
-
 module Calendly
   # Calendly's event model.
   # A meeting that has been scheduled.
@@ -15,13 +7,16 @@ module Calendly
     include ModelUtils
     UUID_RE = %r{\A#{Client::API_HOST}/scheduled_events/(#{UUID_FORMAT})\z}.freeze
     TIME_FIELDS = %i[start_time end_time created_at updated_at].freeze
-    ASSOCIATION = {
-      event_type: EventType,
-      event_guests: Guest,
-      cancellation: InviteeCancellation,
-      invitees_counter: InviteesCounter,
-      location: Location
-    }.freeze
+
+    def self.association
+      {
+        event_type: EventType,
+        event_guests: Guest,
+        cancellation: InviteeCancellation,
+        invitees_counter: InviteesCounter,
+        location: Location
+      }
+    end
 
     # @return [String]
     # unique id of the Event object.

data/lib/calendly/models/event_type.rb

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-require 'calendly/client'
-require 'calendly/models/model_utils'
-require 'calendly/models/event_type_profile'
-require 'calendly/models/event_type_custom_question'
-
 module Calendly
   # Calendly's event type model.
   # A configuration for a schedulable event.
@@ -12,7 +7,13 @@ module Calendly
     include ModelUtils
     UUID_RE = %r{\A#{Client::API_HOST}/event_types/(#{UUID_FORMAT})\z}.freeze
     TIME_FIELDS = %i[created_at updated_at].freeze
-    ASSOCIATION = {profile: EventTypeProfile, custom_questions: EventTypeCustomQuestion}.freeze
+
+    def self.association
+      {
+        profile: EventTypeProfile,
+        custom_questions: EventTypeCustomQuestion
+      }
+    end
 
     # @return [String]
     # unique id of the EventType object.

data/lib/calendly/models/event_type_custom_question.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'calendly/models/model_utils'
-
 module Calendly
   # Calendly's custom question model.
   class EventTypeCustomQuestion

data/lib/calendly/models/event_type_profile.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'calendly/models/model_utils'
-
 module Calendly
   # Calendly's event type profile model.
   class EventTypeProfile

data/lib/calendly/models/guest.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'calendly/models/model_utils'
-
 module Calendly
   # Calendly's guest model.
   # Additional people added to an event by an invitee.

data/lib/calendly/models/invitee.rb

@@ -1,27 +1,31 @@
 # frozen_string_literal: true
 
-require 'calendly/client'
-require 'calendly/models/model_utils'
-require 'calendly/models/event'
-require 'calendly/models/invitee_cancellation'
-require 'calendly/models/invitee_payment'
-require 'calendly/models/invitee_question_and_answer'
-require 'calendly/models/invitee_tracking'
-
 module Calendly
   # Calendly's invitee model.
   # An individual who has been invited to meet with a Calendly member.
   class Invitee
     include ModelUtils
-    UUID_RE = %r{\A#{Client::API_HOST}/scheduled_events/#{UUID_FORMAT}/invitees/(#{UUID_FORMAT})\z}.freeze
+    UUID_RE = %r{\A#{Client::API_HOST}/scheduled_events/(#{UUID_FORMAT})/invitees/(#{UUID_FORMAT})\z}.freeze
+    UUID_RE_INDEX = 2
     TIME_FIELDS = %i[created_at updated_at].freeze
-    ASSOCIATION = {
-      event: Event,
-      cancellation: InviteeCancellation,
-      payment: InviteePayment,
-      questions_and_answers: InviteeQuestionAndAnswer,
-      tracking: InviteeTracking
-    }.freeze
+
+    def self.association
+      {
+        event: Event,
+        cancellation: InviteeCancellation,
+        payment: InviteePayment,
+        no_show: InviteeNoShow,
+        questions_and_answers: InviteeQuestionAndAnswer,
+        tracking: InviteeTracking
+      }
+    end
+
+    def self.extract_event_uuid(str)
+      m = extract_uuid_match str
+      return unless m
+
+      m[1]
+    end
 
     # @return [String]
     # unique id of the Invitee object.
@@ -96,6 +100,10 @@ module Calendly
     # @return [InviteePayment] Invitee payment.
     attr_accessor :payment
 
+    # @return [InviteeNoShow, nil]
+    # Provides data pertaining to the associated no show for the Invitee.
+    attr_accessor :no_show
+
     # @return [Event]
     # Reference to Event associated with this invitee.
     attr_accessor :event
@@ -116,8 +124,47 @@ module Calendly
     # @raise [Calendly::ApiError] if the api returns error code.
     # @since 0.1.0
     def fetch
-      ev_uuid = event.uuid if event
-      client.event_invitee ev_uuid, uuid
+      client.event_invitee event&.uuid, uuid
+    end
+
+    #
+    # Marks as a No Show.
+    # If already marked as a No Show, do nothing.
+    #
+    # @return [Calendly::InviteeNoShow]
+    # @raise [Calendly::Error] if the uri is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.9.0
+    def mark_no_show
+      return no_show if no_show
+
+      @no_show = client.create_invitee_no_show uri
+    end
+
+    #
+    # Unmarks as a No Show.
+    # If already unmarked as a No Show, do nothing.
+    #
+    # @return [true, nil]
+    # @raise [Calendly::Error] if the no_show.uuid is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.9.0
+    def unmark_no_show
+      return unless no_show
+
+      no_show.delete
+      @no_show = nil
+      true
+    end
+
+  private
+
+    def after_set_attributes(attrs)
+      super attrs
+      if event.nil? && attrs[:uri]
+        event_uuid = Invitee.extract_event_uuid attrs[:uri]
+        @event = Event.new({uuid: event_uuid}, @client) if event_uuid
+      end
     end
   end
 end

data/lib/calendly/models/invitee_cancellation.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'calendly/models/model_utils'
-
 module Calendly
   # Calendly's invitee cancellation model.
   # Provides data pertaining to the cancellation of the Invitee.

data/lib/calendly/models/invitee_no_show.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Calendly
+  # Calendly's invitee no show model.
+  class InviteeNoShow
+    include ModelUtils
+    UUID_RE = %r{\A#{Client::API_HOST}/invitee_no_shows/(#{UUID_FORMAT})\z}.freeze
+    TIME_FIELDS = %i[created_at].freeze
+
+    def self.association
+      {
+        invitee: Invitee
+      }
+    end
+
+    # @return [String]
+    # unique id of the InviteeNoShow object.
+    attr_accessor :uuid
+
+    # @return [String]
+    # Canonical reference (unique identifier) for the no show.
+    attr_accessor :uri
+
+    # @return [Time]
+    # The moment when the no show was created.
+    attr_accessor :created_at
+
+    # @return [Invitee, nil]
+    # The associated Invitee.
+    attr_accessor :invitee
+
+    #
+    # Get Invitee No Show associated with self.
+    #
+    # @return [Calendly::InviteeNoShow]
+    # @raise [Calendly::Error] if the uuid is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.9.0
+    def fetch
+      client.invitee_no_show uuid
+    end
+
+    #
+    # Unmarks as a No Show.
+    #
+    # @return [true]
+    # @raise [Calendly::Error] if the uuid is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.9.0
+    def delete
+      client.delete_invitee_no_show uuid
+    end
+  end
+end

data/lib/calendly/models/invitee_payment.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'calendly/models/model_utils'
-
 module Calendly
   # Calendly's invitee payment model.
   class InviteePayment

data/lib/calendly/models/invitee_question_and_answer.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'calendly/models/model_utils'
-
 module Calendly
   # Calendly's question and answer model.
   # An individual form question and response.

data/lib/calendly/models/invitee_tracking.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'calendly/models/model_utils'
-
 module Calendly
   # Calendly's invitee tracking model.
   # Object that represents UTM and Salesforce tracking parameters associated with the invitee.

data/lib/calendly/models/invitees_counter.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'calendly/models/model_utils'
-
 module Calendly
   # Calendly's invitees counter model.
   class InviteesCounter

data/lib/calendly/models/location.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'calendly/models/model_utils'
-
 module Calendly
   # Calendly's location model.
   # The polymorphic base type for an event location that Calendly supports

data/lib/calendly/models/model_utils.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'time'
-require 'calendly/error'
 
 module Calendly
   # Calendly model utility.
@@ -58,15 +57,19 @@ module Calendly
     end
 
     module ClassMethods
-      def extract_uuid(str)
+      def extract_uuid_match(str)
         return unless defined? self::UUID_RE
         return unless str
         return if str.empty?
 
-        m = self::UUID_RE.match str
-        return if m.nil?
+        self::UUID_RE.match str
+      end
 
-        m[1]
+      def extract_uuid(str)
+        m = extract_uuid_match str
+        return unless m
+
+        defined?(self::UUID_RE_INDEX) ? m[self::UUID_RE_INDEX] : m[1]
       end
     end
 
@@ -84,8 +87,8 @@ module Calendly
       attrs.each do |key, value|
         next unless respond_to? "#{key}=".to_sym
 
-        if value && defined?(self.class::ASSOCIATION) && self.class::ASSOCIATION.key?(key)
-          klass = self.class::ASSOCIATION[key]
+        if value && defined?(self.class.association) && self.class.association.key?(key)
+          klass = self.class.association[key]
           if value.is_a? String # rubocop:disable Style/CaseLikeIf
             value = klass.new({uri: value}, @client)
           elsif value.is_a? Hash
@@ -102,7 +105,10 @@ module Calendly
     end
 
     def after_set_attributes(attrs)
-      @uuid = self.class.extract_uuid(attrs[:uri]) if respond_to? :uuid=
+      return unless respond_to? :uuid=
+      return unless attrs[:uri]
+
+      @uuid = self.class.extract_uuid(attrs[:uri])
     end
 
     #

data/lib/calendly/models/organization.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'calendly/client'
-require 'calendly/models/model_utils'
-
 module Calendly
   # Calendly's organization model.
   class Organization

data/lib/calendly/models/organization_invitation.rb

@@ -1,17 +1,18 @@
 # 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/#{UUID_FORMAT}/invitations/(#{UUID_FORMAT})\z}.freeze
     TIME_FIELDS = %i[created_at updated_at last_sent_at].freeze
-    ASSOCIATION = {user: User, organization: Organization}.freeze
+
+    def self.association
+      {
+        user: User,
+        organization: Organization
+      }
+    end
 
     # @return [String]
     # unique id of the OrganizationInvitation object.
@@ -58,8 +59,7 @@ module Calendly
     # @raise [Calendly::ApiError] if the api returns error code.
     # @since 0.1.0
     def fetch
-      org_uuid = organization.uuid if organization
-      client.invitation org_uuid, uuid
+      client.invitation organization&.uuid, uuid
     end
 
     #
@@ -71,8 +71,7 @@ module Calendly
     # @raise [Calendly::ApiError] if the api returns error code.
     # @since 0.1.0
     def delete
-      org_uuid = organization.uuid if organization
-      client.delete_invitation org_uuid, uuid
+      client.delete_invitation organization&.uuid, uuid
     end
   end
 end

data/lib/calendly/models/organization_membership.rb

@@ -1,17 +1,18 @@
 # 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/(#{UUID_FORMAT})\z}.freeze
     TIME_FIELDS = %i[created_at updated_at].freeze
-    ASSOCIATION = {user: User, organization: Organization}.freeze
+
+    def self.association
+      {
+        user: User,
+        organization: Organization
+      }
+    end
 
     # @return [String]
     # unique id of the OrganizationMembership object.

data/lib/calendly/models/team.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'calendly/client'
-require 'calendly/models/model_utils'
-
 module Calendly
   # Calendly's team model.
   class Team

data/lib/calendly/models/user.rb

@@ -1,8 +1,5 @@
 # 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.
@@ -10,7 +7,12 @@ module Calendly
     include ModelUtils
     UUID_RE = %r{\A#{Client::API_HOST}/users/(#{UUID_FORMAT})\z}.freeze
     TIME_FIELDS = %i[created_at updated_at].freeze
-    ASSOCIATION = {current_organization: Organization}.freeze
+
+    def self.association
+      {
+        current_organization: Organization
+      }
+    end
 
     # @return [String]
     # unique id of the User object.

data/lib/calendly/models/webhook_subscription.rb

@@ -1,17 +1,19 @@
 # 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/(#{UUID_FORMAT})\z}.freeze
     TIME_FIELDS = %i[created_at updated_at retry_started_at].freeze
-    ASSOCIATION = {organization: Organization, user: User, creator: User}.freeze
+
+    def self.association
+      {
+        organization: Organization,
+        user: User,
+        creator: User
+      }
+    end
 
     # @return [String]
     # unique id of the WebhookSubscription object.

data/lib/calendly/version.rb

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

data/lib/calendly.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'calendly/client'
+require 'calendly/models/model_utils'
 Dir[
   File.join(
     File.dirname(__FILE__),

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calendly
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.9.0
 platform: ruby
 authors:
 - Kenji Koshikawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-08 00:00:00.000000000 Z
+date: 2022-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -141,6 +155,7 @@ files:
 - lib/calendly/models/guest.rb
 - lib/calendly/models/invitee.rb
 - lib/calendly/models/invitee_cancellation.rb
+- lib/calendly/models/invitee_no_show.rb
 - lib/calendly/models/invitee_payment.rb
 - lib/calendly/models/invitee_question_and_answer.rb
 - lib/calendly/models/invitee_tracking.rb
@@ -161,7 +176,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.8.3
+  documentation_uri: https://www.rubydoc.info/gems/calendly/0.9.0
 post_install_message: 
 rdoc_options: []
 require_paths: