calendly 0.1.1 → 0.4.0

data/lib/calendly/error.rb

@@ -1,23 +1,19 @@
 # frozen_string_literal: true
 
+require 'calendly/loggable'
+
 module Calendly
   # calendly module's base error object
   class Error < StandardError
+    include Loggable
+
     def initialize(message = nil)
       @logger = Calendly.configuration.logger
       msg = "#{self.class} occured."
       msg += " status:#{status}" if respond_to?(:status)
       msg += " message:#{message}"
-      log msg
+      warn_log msg
       super message
     end
-
-    private
-
-    def log(msg, level = :warn)
-      return if @logger.nil?
-
-      @logger.send level, msg
-    end
   end
 end

data/lib/calendly/loggable.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Calendly
+  # Calendly logger utility module.
+  module Loggable
+    def error_log(msg)
+      log msg, :error
+    end
+
+    def warn_log(msg)
+      log msg, :warn
+    end
+
+    def info_log(msg)
+      log msg, :info
+    end
+
+    def debug_log(msg)
+      log msg, :debug
+    end
+
+  private
+
+    def log(msg, level = :info)
+      logger = Calendly.configuration.logger
+      return unless logger
+      return unless logger.respond_to? level
+
+      logger.send level, msg
+    end
+  end
+end

data/lib/calendly/models/event.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+require 'calendly/client'
+require 'calendly/models/model_utils'
+require 'calendly/models/event_type'
+
 module Calendly
   # Calendly's event model.
   # A meeting that has been scheduled
@@ -7,7 +11,7 @@ module Calendly
     include ModelUtils
     UUID_RE = %r{\A#{Client::API_HOST}/scheduled_events/(\w+)\z}.freeze
     TIME_FIELDS = %i[start_time end_time created_at updated_at].freeze
-    ASSOCIATION = { event_type: EventType }.freeze
+    ASSOCIATION = {event_type: EventType}.freeze
 
     # @return [String]
     # unique id of the Event object.
@@ -69,19 +73,29 @@ module Calendly
     # @param [Hash] opts the optional request parameters.
     # @option opts [Integer] :count Number of rows to return.
     # @option opts [String] :email Filter by email.
-    # @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] :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.
     # @return [Array<Calendly::Invitee>]
     # @raise [Calendly::Error] if the uuid is empty.
     # @raise [Calendly::ApiError] if the api returns error code.
     # @since 0.1.0
     def invitees(opts = {})
+      return @cached_invitees if @cached_invitees
+
       request_proc = proc { |options| client.event_invitees uuid, options }
-      auto_pagination request_proc, opts
+      @cached_invitees = auto_pagination request_proc, opts
     end
 
-    private
+    # @since 0.2.0
+    def invitees!(opts = {})
+      @cached_invitees = nil
+      invitees opts
+    end
+
+  private
 
     def after_set_attributes(attrs)
       super attrs
@@ -89,11 +103,12 @@ module Calendly
       @location = Location.new loc_params if loc_params&.is_a? Hash
 
       inv_cnt_attrs = attrs[:invitees_counter]
-      if inv_cnt_attrs&.is_a? Hash
-        @invitees_counter_total = inv_cnt_attrs[:total]
-        @invitees_counter_active = inv_cnt_attrs[:active]
-        @invitees_counter_limit = inv_cnt_attrs[:limit]
-      end
+      return unless inv_cnt_attrs
+      return unless inv_cnt_attrs.is_a? Hash
+
+      @invitees_counter_total = inv_cnt_attrs[:total]
+      @invitees_counter_active = inv_cnt_attrs[:active]
+      @invitees_counter_limit = inv_cnt_attrs[:limit]
     end
   end
 end

data/lib/calendly/models/event_type.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'calendly/client'
+require 'calendly/models/model_utils'
+
 module Calendly
   # Calendly's event type model.
   # A configuration for a schedulable event
@@ -72,17 +75,16 @@ module Calendly
     # Whether the profile belongs to a “User” or a “Team”.
     attr_accessor :owner_type
 
-    private
+  private
 
     def after_set_attributes(attrs)
       super attrs
-      if attrs[:profile]
+      return unless attrs[:profile]
 
-        @owner_uri = attrs[:profile][:owner]
-        @owner_uuid = User.extract_uuid owner_uri
-        @owner_name = attrs[:profile][:name]
-        @owner_type = attrs[:profile][:type]
-      end
+      @owner_uri = attrs[:profile][:owner]
+      @owner_uuid = User.extract_uuid owner_uri
+      @owner_name = attrs[:profile][:name]
+      @owner_type = attrs[:profile][:type]
     end
   end
 end

data/lib/calendly/models/invitee.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+require 'calendly/client'
+require 'calendly/models/model_utils'
+require 'calendly/models/event'
+
 module Calendly
   # Calendly's Invitee model.
   # An individual who has been invited to meet with a Calendly member.
@@ -7,7 +11,7 @@ module Calendly
     include ModelUtils
     UUID_RE = %r{\A#{Client::API_HOST}/scheduled_events/\w+/invitees/(\w+)\z}.freeze
     TIME_FIELDS = %i[created_at updated_at].freeze
-    ASSOCIATION = { event: Event }.freeze
+    ASSOCIATION = {event: Event}.freeze
 
     # @return [String]
     # unique id of the Invitee object.
@@ -61,14 +65,12 @@ module Calendly
       client.event_invitee ev_uuid, uuid
     end
 
-    private
+  private
 
     def after_set_attributes(attrs)
       super attrs
       answers = attrs[:questions_and_answers]
-      if answers&.is_a? Array
-        @questions_and_answers = answers.map { |ans| InviteeQuestionAndAnswer.new ans }
-      end
+      @questions_and_answers = answers.map { |ans| InviteeQuestionAndAnswer.new ans } if answers&.is_a? Array
 
       trac_attrs = attrs[:tracking]
       @tracking = InviteeTracking.new trac_attrs if trac_attrs&.is_a? Hash

data/lib/calendly/models/invitee_question_and_answer.rb

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

data/lib/calendly/models/invitee_tracking.rb

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

data/lib/calendly/models/location.rb

@@ -1,52 +1,70 @@
 # frozen_string_literal: true
 
+require 'calendly/models/model_utils'
+
 module Calendly
   # Calendly's location model.
-  # Polymorphic base type for the various supported meeting locations.
+  # The polymorphic base type for an event location that Calendly supports
   class Location
     include ModelUtils
 
+    #
     # data patterns is below:
-    # - 1. A meeting at a pre-specified physical location
-    #  - [String] :kind
-    #  - [String] :location A physical location specified by the meeting publisher.
-    # - 2. Meeting publisher will call the invitee
-    #  - [String] :kind
-    # - 3. Invitee will call meeting publisher at the specified phone number.
-    #  - [String] :kind
-    #  - [String] :phone_number Phone number invitee should use to reach meeting publisher.
-    # - 4. Meeting will take place in a Google Meet / Hangout conference.
-    #  - [String] :kind
-    # - 5. Meeting will take place in a Zoom conference.
-    #  - [String] :kind
-    # - 6. Meeting will take place in a GotoMeeting conference.
-    #  - [String] :kind
-    #  - [String] :external_id Zoom-supplied conference id.
-    #  - [String] :state Current state of the conference in Zoom.
-    #  - [Hash] :data Arbitrary conference metadata supplied by Zoom.
-    # - 7. Arbitrary conference metadata supplied by GotoMeeting.
-    #  - [String] :kind
-    #  - [String] :external_id GotoMeeting-supplied conference id.
-    #  - [String] :state Current state of the conference in GotoMeeting.
-    #  - [String] :data Arbitrary conference metadata supplied by GotoMeeting.
-    # - 8. Meeting location does not fall in a standard category, and is as described by the meeting publisher.
-    #  - [String] :kind
-    #  - [String] :location Location description provided by meeting publisher.
-    # - 9. Meeting location was specified by invitee.
-    #  - [String] :kind
-    #  - [String] :location Meeting location was specified by invitee.
+    #
+    # 1. In-Person Meeting: Information about the physical (in-person) event location.
+    # @param [String] type Indicates that the event host (publisher) will call the invitee.
+    # @param [String] location The physical location specified by the event host (publisher).
+    #
+    # 2. Outbound Call: Meeting publisher will call the Invitee
+    # @param [String] type Indicates that the event host (publisher) will call the invitee.
+    # @param [String] location The phone number the event host (publisher) will use to call the invitee.
+    #
+    # 3. Inbound Call: Invitee will call meeting publisher at the specified phone number.
+    # @param [String] type Indicates that the invitee will call the event host.
+    # @param [String] location The phone number the invitee will use to call the event host (publisher).
+    #
+    # 4. Google Conference: Details about an Event that will take place using a Google Meet / Hangout conference.
+    # @param [String] type The event location is a Google Meet or Hangouts conference.
+    # @param [String] status Indicates the current status of the Google conference.
+    # @param [String] join_url Google conference meeting url.
+    #
+    # 5. Zoom Conference: Meeting will take place in a Zoom conference.
+    # @param [String] type The event location is a Zoom conference
+    # @param [String] status Indicates the current status of the Zoom conference.
+    # @param [String] join_url Zoom meeting url.
+    # @param [Hash] data The conference metadata supplied by Zoom.
+    #
+    # 6. GoToMeeting Conference: Details about an Event that will take place using a GotoMeeting conference
+    # @param [String] type The event location is a GoToMeeting conference.
+    # @param [String] status Indicates the current status of the GoToMeeting conference.
+    # @param [String] join_url GoToMeeting conference meeting url.
+    # @param [Hash] data The conference metadata supplied by GoToMeeting.
+    #
+    # 7. Microsoft Teams Conference:
+    # @param [String] type The event location is a Zoom conference.
+    # @param [String] status Indicates the current status of the Microsoft Teams conference.
+    # @param [String] join_url Microsoft Teams meeting url.
+    # @param [Hash] data The conference metadata supplied by Microsoft Teams.
+    #
+    # 8. Custom Location:
+    # Use this to describe an existing Calendly-supported event location.
+    # @param [String] type The event location doesn't fall into a standard category defined by the event host (publisher).
+    # @param [String] location The event location description provided by the invitee.
+    #
+    # 9. Invitee Specified Location:
+    # Information about an event location that’s specified by the invitee.
+    # @param [String] type The event location selected by the invitee.
+    # @param [String] location The event location description provided by the invitee.
     #
 
     # @return [String]
-    attr_accessor :kind
+    attr_accessor :type
     # @return [String]
     attr_accessor :location
     # @return [String]
-    attr_accessor :phone_number
-    # @return [String]
-    attr_accessor :external_id
+    attr_accessor :status
     # @return [String]
-    attr_accessor :state
+    attr_accessor :join_url
     # @return [Hash]
     attr_accessor :data
   end

data/lib/calendly/models/model_utils.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'time'
+require 'calendly/error'
 
 module Calendly
   # Calendly model utility.
@@ -19,7 +20,7 @@ module Calendly
     # @raise [Calendly::Error] if the client is nil.
     # @since 0.1.0
     def client
-      raise Error, '@client is not ready.' if !@client || !@client.is_a?(Client)
+      raise Error.new('@client is not ready.') if !@client || !@client.is_a?(Client)
 
       @client
     end
@@ -31,7 +32,7 @@ module Calendly
     # @raise [Calendly::Error] if uuid is not defined.
     # @since 0.1.0
     def id
-      raise Error, 'uuid is not defined.' unless defined? uuid
+      raise Error.new('uuid is not defined.') unless defined? uuid
 
       uuid
     end
@@ -58,9 +59,9 @@ module Calendly
       base.extend ClassMethods
     end
 
-    private
+  private
 
-    def set_attributes(attrs)
+    def set_attributes(attrs) # rubocop:disable all
       return if attrs.nil?
       return unless attrs.is_a? Hash
       return if attrs.empty?
@@ -68,10 +69,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)
-          associated_attrs = value.is_a?(Hash) ? value : { uri: value }
+        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

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'calendly/client'
+require 'calendly/models/model_utils'
+
 module Calendly
   # Calendly's organization model.
   class Organization
@@ -25,8 +28,16 @@ module Calendly
     # @raise [Calendly::ApiError] if the api returns error code.
     # @since 0.1.0
     def memberships(opts = {})
+      return @cached_memberships if @cached_memberships
+
       request_proc = proc { |options| client.memberships uri, options }
-      auto_pagination request_proc, opts
+      @cached_memberships = auto_pagination request_proc, opts
+    end
+
+    # @since 0.2.0
+    def memberships!(opts = {})
+      @cached_memberships = nil
+      memberships opts
     end
 
     #
@@ -36,15 +47,24 @@ module Calendly
     # @option opts [Integer] :count Number of rows to return.
     # @option opts [String] :email Filter by email.
     # @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 Filter by status.
     # @return [Array<Calendly::OrganizationInvitation>]
     # @raise [Calendly::Error] if the uuid is empty.
     # @raise [Calendly::ApiError] if the api returns error code.
     # @since 0.1.0
     def invitations(opts = {})
+      return @cached_invitations if @cached_invitations
+
       request_proc = proc { |options| client.invitations uuid, options }
-      auto_pagination request_proc, opts
+      @cached_invitations = auto_pagination request_proc, opts
+    end
+
+    # @since 0.2.0
+    def invitations!(opts = {})
+      @cached_invitations = nil
+      invitations opts
     end
 
     #
@@ -59,5 +79,45 @@ 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 = {})
+      return @cached_webhooks if @cached_webhooks
+
+      request_proc = proc { |options| client.webhooks uri, options }
+      @cached_webhooks = auto_pagination request_proc, opts
+    end
+
+    # @since 0.2.0
+    def webhooks!(opts = {})
+      @cached_webhooks = nil
+      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 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