calendly 0.4.2 → 0.7.0

data/lib/calendly/configuration.rb

@@ -7,19 +7,24 @@ module Calendly
   class Configuration
     # @return [String]
     attr_accessor :client_id
+
     # @return [String]
     attr_accessor :client_secret
+
     # @return [String]
     attr_accessor :token
+
     # @return [String]
     attr_accessor :refresh_token
+
     # @return [Integer]
     attr_accessor :token_expires_at
+
     # @return [Logger]
     attr_accessor :logger
 
     def initialize
-      @logger = Logger.new STDOUT
+      @logger = Logger.new $stdout
       @logger.level = :warn
     end
   end

data/lib/calendly/models/event.rb

@@ -3,37 +3,52 @@
 require 'calendly/client'
 require 'calendly/models/model_utils'
 require 'calendly/models/event_type'
+require 'calendly/models/guest'
+require 'calendly/models/invitees_counter'
+require 'calendly/models/location'
 
 module Calendly
   # Calendly's event model.
-  # A meeting that has been scheduled
+  # A meeting that has been scheduled.
   class Event
     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,
+      event_guests: Guest,
+      invitees_counter: InviteesCounter,
+      location: Location
+    }.freeze
 
     # @return [String]
     # unique id of the Event object.
     attr_accessor :uuid
+
     # @return [String]
     # Canonical resource reference.
     attr_accessor :uri
+
     # @return [String]
     # Name of the event.
     attr_accessor :name
+
     # @return [String]
     # Whether the event is active or canceled.
     attr_accessor :status
+
     # @return [Time]
     # Moment when event is (or was) scheduled to begin.
     attr_accessor :start_time
+
     # @return [Time]
     # Moment when event is (or was) scheduled to end.
     attr_accessor :end_time
+
     # @return [Time]
     # Moment when user record was first created.
     attr_accessor :created_at
+
     # @return [Time]
     # Moment when user record was last updated.
     attr_accessor :updated_at
@@ -46,15 +61,17 @@ module Calendly
     # location in this event.
     attr_accessor :location
 
-    # @return [Integer]
-    # number of total invitees in this event.
-    attr_accessor :invitees_counter_total
-    # @return [Integer]
-    # number of active invitees in this event.
-    attr_accessor :invitees_counter_active
-    # @return [Integer]
-    # max invitees in this event.
-    attr_accessor :invitees_counter_limit
+    # @return [InviteesCounter]
+    # invitees counter.
+    attr_accessor :invitees_counter
+
+    # @return [Array<User>]
+    # Event membership list.
+    attr_accessor :event_memberships
+
+    # @return [Array<Guest>]
+    # Additional people added to an event by an invitee.
+    attr_accessor :event_guests
 
     #
     # Get Scheduled Event associated with self.
@@ -83,7 +100,7 @@ module Calendly
     # @raise [Calendly::ApiError] if the api returns error code.
     # @since 0.1.0
     def invitees(opts = {})
-      return @cached_invitees if @cached_invitees
+      return @cached_invitees if defined?(@cached_invitees) && @cached_invitees
 
       request_proc = proc { |options| client.event_invitees uuid, options }
       @cached_invitees = auto_pagination request_proc, opts
@@ -99,16 +116,12 @@ module Calendly
 
     def after_set_attributes(attrs)
       super attrs
-      loc_params = attrs[:location]
-      @location = Location.new loc_params if loc_params&.is_a? Hash
-
-      inv_cnt_attrs = attrs[:invitees_counter]
-      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]
+      if event_memberships.is_a? Array # rubocop:disable Style/GuardClause
+        @event_memberships = event_memberships.map do |params|
+          uri = params[:user]
+          User.new({uri: uri}, @client)
+        end
+      end
     end
   end
 end

data/lib/calendly/models/event_type.rb

@@ -2,89 +2,144 @@
 
 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
+  # A configuration for a schedulable event.
   class EventType
     include ModelUtils
     UUID_RE = %r{\A#{Client::API_HOST}/event_types/(\w+)\z}.freeze
     TIME_FIELDS = %i[created_at updated_at].freeze
+    ASSOCIATION = {profile: EventTypeProfile, custom_questions: EventTypeCustomQuestion}.freeze
 
     # @return [String]
     # unique id of the EventType object.
     attr_accessor :uuid
+
     # @return [String]
     # Canonical resource reference.
     attr_accessor :uri
+
     # @return [Boolean]
     # Is this event type currently active?
     attr_accessor :active
+
     # @return [String]
     # The web page styling color for this event type,
     # expressed as a hexadecimal RGB value (e.g. #fa12e4).
     attr_accessor :color
+
     # @return [String]
     # Longer text description with HTML formatting.
     attr_accessor :description_html
+
     # @return [String]
     # Longer text description in plain text.
     attr_accessor :description_plain
+
     # @return [Integer]
     # Length of event type in minutes.
     attr_accessor :duration
+
     # @return [String]
     # Optional internal note on an event type.
     attr_accessor :internal_note
+
     # @return [String]
     # Whether the event type is “solo” or with a “group”.
     attr_accessor :kind
+
     # @return [String]
     # Human-readable name. Note: some Event Types don't have a name.
     attr_accessor :name
+
     # @return [String]
     # Whether the event type is "round_robin" or "collective".
     # This value is null if the event type does not pool team members' availability.
     attr_accessor :pooling_type
+
     # @return [String]
     # The full URL of the web page for this event type.
     attr_accessor :scheduling_url
+
     # @return [String]
     # Unique human-readable slug used in page URL.
     attr_accessor :slug
+
     # @return [String]
     # Whether the event type is a “StandardEventType” or an "AdhocEventType”.
     attr_accessor :type
+
+    # @return [Boolean]
+    # Indicates if the event type is hidden on the owner's main scheduling page.
+    attr_accessor :secret
+
     # @return [Time]
     # Moment when event type was eventually created.
     attr_accessor :created_at
+
     # @return [Time]
     # Moment when event type was last updated.
     attr_accessor :updated_at
 
-    # @return [String]
-    # uuid of User or Team object.
-    attr_accessor :owner_uuid
-    # @return [String]
-    # Reference to the profile owner.
-    attr_accessor :owner_uri
-    # @return [String]
-    # Human-readable name.
-    attr_accessor :owner_name
-    # @return [String]
-    # Whether the profile belongs to a “User” or a “Team”.
-    attr_accessor :owner_type
+    # @return [EventTypeProfile]
+    # The profile of the User that's associated with the Event Type.
+    attr_accessor :profile
 
-  private
+    # @return [Array<EventTypeCustomQuestion>]
+    # A collection of custom questions.
+    attr_accessor :custom_questions
+
+    # The owner user if the profile belongs to a "user" (individual).
+    # @return [User]
+    # @since 0.6.0
+    def owner_user
+      profile&.owner_user
+    end
 
-    def after_set_attributes(attrs)
-      super attrs
-      return unless attrs[:profile]
+    # The owner team if the profile belongs to a "team".
+    # @return [Team]
+    # @since 0.6.0
+    def owner_team
+      profile&.owner_team
+    end
+
+    #
+    # Get EventType associated with self.
+    #
+    # @return [Calendly::EventType]
+    # @raise [Calendly::Error] if the uuid is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.5.1
+    def fetch
+      client.event_type uuid
+    end
+
+    #
+    # Create an associated scheduling link.
+    #
+    # @param [String] max_event_count The max number of events that can be scheduled using this scheduling link.
+    # @return [Hash]
+    # e.g.
+    # {
+    #   booking_url: "https://calendly.com/s/FOO-BAR-SLUG",
+    #   owner: "https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2",
+    #   owner_type: "EventType"
+    # }
+    # @raise [Calendly::Error] if the uri is empty.
+    # @raise [Calendly::Error] if the max_event_count arg is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.5.2
+    def create_schedule_link(max_event_count = 1)
+      client.create_schedule_link uri, max_event_count, resource_type: 'EventType'
+    end
+
+  private
 
-      @owner_uri = attrs[:profile][:owner]
-      @owner_uuid = User.extract_uuid owner_uri
-      @owner_name = attrs[:profile][:name]
-      @owner_type = attrs[:profile][:type]
+    def inspect_attributes
+      super + %i[active kind scheduling_url]
     end
   end
 end

data/lib/calendly/models/event_type_custom_question.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'calendly/models/model_utils'
+
+module Calendly
+  # Calendly's custom question model.
+  class EventTypeCustomQuestion
+    include ModelUtils
+
+    # @return [String]
+    # The custom question that the host created for the event type.
+    attr_accessor :name
+
+    # @return [String]
+    # The type of response that the invitee provides to the custom question;
+    # can be one or multiple lines of text, a phone number, or single- or multiple-select.
+    attr_accessor :type
+
+    # @return [Integer]
+    # The numerical position of the question on the event booking page after the name and email address fields.
+    attr_accessor :position
+
+    # @return [Boolean]
+    # true if the question created by the host is turned ON and visible on the event booking page;
+    # false if turned OFF and invisible on the event booking page.
+    attr_accessor :enabled
+
+    # @return [Boolean]
+    # true if a response to the question created by the host is required for invitees to book the event type;
+    # false if not required.
+    attr_accessor :required
+
+    # @return [Array<String>]
+    # The invitee’s option(s) for single_select or multi_select type of responses.
+    attr_accessor :answer_choices
+
+    # @return [Boolean]
+    # true if the custom question lets invitees record a written response in addition to single-select or multiple-select type of responses;
+    # false if it doesn’t.
+    attr_accessor :include_other
+
+  private
+
+    def inspect_attributes
+      super + %i[enabled position]
+    end
+  end
+end

data/lib/calendly/models/event_type_profile.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'calendly/models/model_utils'
+
+module Calendly
+  # Calendly's event type profile model.
+  class EventTypeProfile
+    include ModelUtils
+
+    # @return [String]
+    # Indicates if the profile belongs to a "user" (individual) or "team"
+    attr_accessor :type
+
+    # @return [String]
+    # Human-readable name for the profile of the user that's associated with the event type
+    attr_accessor :name
+
+    # @return [String]
+    # The unique reference to the user associated with the profile
+    attr_accessor :owner
+
+    # @return [User]
+    # The owner user if the profile belongs to a "user" (individual).
+    attr_accessor :owner_user
+
+    # @return [Team]
+    # The owner team if the profile belongs to a "team".
+    attr_accessor :owner_team
+
+    # whether type is user or not.
+    # @return [Boolean]
+    # @since 0.6.0
+    def type_user?
+      type&.downcase == 'user'
+    end
+
+    # whether type is team or not.
+    # @return [Boolean]
+    # @since 0.6.0
+    def type_team?
+      type&.downcase == 'team'
+    end
+
+  private
+
+    def after_set_attributes(attrs)
+      super attrs
+      if owner # rubocop:disable Style/GuardClause
+        @owner_user = User.new({uri: owner}, @client) if type_user?
+        @owner_team = Team.new({uri: owner}, @client) if type_team?
+      end
+    end
+  end
+end

data/lib/calendly/models/guest.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'calendly/models/model_utils'
+
+module Calendly
+  # Calendly's guest model.
+  # Additional people added to an event by an invitee.
+  class Guest
+    include ModelUtils
+    TIME_FIELDS = %i[created_at updated_at].freeze
+
+    # @return [String]
+    attr_accessor :email
+
+    # @return [Time]
+    attr_accessor :created_at
+
+    # @return [Time]
+    attr_accessor :updated_at
+  end
+end

data/lib/calendly/models/invitee.rb

@@ -3,60 +3,99 @@
 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.
+  # 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/\w+/invitees/(\w+)\z}.freeze
     TIME_FIELDS = %i[created_at updated_at].freeze
-    ASSOCIATION = {event: Event}.freeze
+    ASSOCIATION = {
+      event: Event,
+      cancellation: InviteeCancellation,
+      payment: InviteePayment,
+      questions_and_answers: InviteeQuestionAndAnswer,
+      tracking: InviteeTracking
+    }.freeze
 
     # @return [String]
     # unique id of the Invitee object.
     attr_accessor :uuid
+
     # @return [String]
     # Canonical resource reference.
     attr_accessor :uri
+
     # @return [String]
     # The invitee's email address.
     attr_accessor :email
+
     # @return [String]
     # The invitee's human-readable name.
     attr_accessor :name
+
+    # @return [String]
+    # The first name of the invitee who booked the event when the event type is configured to use separate fields for
+    # first name and last name. Null when event type is configured to use a single field for name.
+    attr_accessor :first_name
+
+    # @return [String]
+    # The last name of the invitee who booked the event when the event type is configured to use separate fields
+    # for first name and last name. Null when event type is configured to use a single field for name.
+    attr_accessor :last_name
+
     # @return [String]
     # Whether the invitee has canceled or is still active.
     attr_accessor :status
+
     # @return [String]
     # Timezone offest to use when presenting time information to invitee.
     attr_accessor :timezone
+
     # @return [String]
     # Text (SMS) reminder phone number.
     attr_accessor :text_reminder_number
+
     # @return [Boolean]
     # Indicates if this invitee has rescheduled.
     # If true, a reference to the new Invitee instance is provided in the new_invitee field.
     attr_accessor :rescheduled
+
     # @return [String, nil]
     # Reference to old Invitee instance that got rescheduled.
     attr_accessor :old_invitee
+
     # @return [String, nil]
     # Link to new invitee, after reschedule.
     attr_accessor :new_invitee
+
     # @return [String]
     # Link to cancelling the event for the invitee.
     attr_accessor :cancel_url
+
     # @return [String]
     # Link to rescheduling the event for the invitee.
     attr_accessor :reschedule_url
+
     # @return [Time]
     # Moment when user record was first created.
     attr_accessor :created_at
+
     # @return [Time]
     # Moment when user record was last updated.
     attr_accessor :updated_at
 
+    # @return [InviteeCancellation] Provides data pertaining to the cancellation of the Invitee.
+    attr_accessor :cancellation
+
+    # @return [InviteePayment] Invitee payment.
+    attr_accessor :payment
+
     # @return [Event]
     # Reference to Event associated with this invitee.
     attr_accessor :event
@@ -80,16 +119,5 @@ module Calendly
       ev_uuid = event.uuid if event
       client.event_invitee ev_uuid, uuid
     end
-
-  private
-
-    def after_set_attributes(attrs)
-      super attrs
-      answers = attrs[:questions_and_answers]
-      @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
-    end
   end
 end