calendly 0.1.0

data/lib/calendly/models/invitee.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+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/\w+/invitees/(\w+)\z}.freeze
+    TIME_FIELDS = %i[created_at updated_at].freeze
+    ASSOCIATION = { event: Event }.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]
+    # 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 [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 [Event]
+    # Reference to Event associated with this invitee.
+    attr_accessor :event
+
+    # @return [Array<Calendly::InviteeQuestionAndAnswer>]
+    # A collection of form responses from the invitee.
+    attr_accessor :questions_and_answers
+
+    # @return [Calendly::InviteeTracking]
+    attr_accessor :tracking
+
+    #
+    # Get Event Invitee associated with self.
+    #
+    # @return [Calendly::Invitee]
+    # @raise [Calendly::Error] if the event.uuid is empty.
+    # @raise [Calendly::Error] if the uuid is empty.
+    # @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
+    end
+
+    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
+
+      trac_attrs = attrs[:tracking]
+      @tracking = InviteeTracking.new trac_attrs if trac_attrs&.is_a? Hash
+    end
+  end
+end

data/lib/calendly/models/invitee_question_and_answer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Calendly
+  # Calendly's InviteeQuestionAndAnswer model.
+  # An individual form question and response.
+  class InviteeQuestionAndAnswer
+    include ModelUtils
+
+    # @return [String]
+    # The question from the event booking confirmation form.
+    attr_accessor :question
+    # @return [String]
+    # The answer supplied by the invitee to this question.
+    attr_accessor :answer
+    # @return [Integer]
+    # The position of this question in the event booking confirmation form.
+    attr_accessor :position
+  end
+end

data/lib/calendly/models/invitee_tracking.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Calendly
+  # Calendly's InviteeTracking model.
+  # Object that represents UTM and Salesforce tracking parameters associated with the invitee.
+  class InviteeTracking
+    include ModelUtils
+
+    # @return [String]
+    # UTM campaign tracking parameter.
+    attr_accessor :utm_campaign
+    # @return [String]
+    # UTM source tracking parameter.
+    attr_accessor :utm_source
+    # @return [String]
+    # UTM medium tracking parameter.
+    attr_accessor :utm_medium
+    # @return [String]
+    # UTM content tracking parameter.
+    attr_accessor :utm_content
+    # @return [String]
+    # UTM term tracking parameter.
+    attr_accessor :utm_term
+    # @return [String]
+    # Salesforce Record ID.
+    attr_accessor :salesforce_uuid
+  end
+end

data/lib/calendly/models/location.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Calendly
+  # Calendly's location model.
+  # Polymorphic base type for the various supported meeting locations.
+  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.
+    #
+
+    # @return [String]
+    attr_accessor :kind
+    # @return [String]
+    attr_accessor :location
+    # @return [String]
+    attr_accessor :phone_number
+    # @return [String]
+    attr_accessor :external_id
+    # @return [String]
+    attr_accessor :state
+    # @return [Hash]
+    attr_accessor :data
+  end
+end

data/lib/calendly/models/model_utils.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'time'
+
+module Calendly
+  # Calendly model utility.
+  module ModelUtils
+    # @param [Hash] attrs the attributes of the model.
+    # @param [Calendly::Client] the api client.
+    def initialize(attrs = nil, client = nil)
+      @client = client
+      set_attributes attrs
+    end
+
+    #
+    # Returns api client.
+    #
+    # @return [Calendly::Client]
+    # @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)
+
+      @client
+    end
+
+    #
+    # alias of uuid.
+    #
+    # @return [String]
+    # @raise [Calendly::Error] if uuid is not defined.
+    # @since 0.1.0
+    def id
+      raise Error, 'uuid is not defined.' unless defined? uuid
+
+      uuid
+    end
+
+    def inspect
+      description = "uuid:#{uuid}" if respond_to? :uuid
+      "\#<#{self.class}:#{object_id} #{description}>"
+    end
+
+    module ClassMethods
+      def extract_uuid(str)
+        return unless defined? self::UUID_RE
+        return unless str
+        return if str.empty?
+
+        m = self::UUID_RE.match str
+        return if m.nil?
+
+        m[1]
+      end
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    private
+
+    def set_attributes(attrs)
+      return if attrs.nil?
+      return unless attrs.is_a? Hash
+      return if attrs.empty?
+
+      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 }
+          value = self.class::ASSOCIATION[key].new associated_attrs, @client
+        elsif defined?(self.class::TIME_FIELDS) && self.class::TIME_FIELDS.include?(key)
+          value = Time.parse value
+        end
+        instance_variable_set "@#{key}", value
+      end
+      after_set_attributes(attrs)
+    end
+
+    def after_set_attributes(attrs)
+      @uuid = self.class.extract_uuid(attrs[:uri]) if respond_to? :uuid=
+    end
+
+    #
+    # Get all collection from single page or plurality of pages.
+    #
+    # @param [Proc] request_proc the procedure of request portion of collection.
+    # @param [Hash] opts the optional request parameters for the procedure.
+    # @return [Array<Calendly::Model>]
+    # @since 0.1.0
+    def auto_pagination(request_proc, opts)
+      items = []
+      loop do
+        new_items, next_opts = request_proc.call opts
+        items = [*items, *new_items]
+        break unless next_opts
+
+        opts = next_opts
+      end
+      items
+    end
+  end
+end

data/lib/calendly/models/organization.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Calendly
+  # Calendly's organization model.
+  class Organization
+    include ModelUtils
+    UUID_RE = %r{\A#{Client::API_HOST}/organizations/(\w+)\z}.freeze
+
+    # @return [String]
+    # unique id of the Organization object.
+    attr_accessor :uuid
+    # @return [String]
+    # Canonical resource reference.
+    attr_accessor :uri
+
+    #
+    # Get List memberships of all users belonging to self.
+    #
+    # @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.
+    # @return [Array<Calendly::OrganizationMembership>]
+    # @raise [Calendly::Error] if the uri is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.1.0
+    def memberships(opts = {})
+      request_proc = proc { |options| client.memberships uri, options }
+      auto_pagination request_proc, opts
+    end
+
+    #
+    # Get Organization Invitations.
+    #
+    # @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] :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 = {})
+      request_proc = proc { |options| client.invitations uuid, options }
+      auto_pagination request_proc, opts
+    end
+
+    #
+    # Invite a person to an Organization.
+    #
+    # @param [String] email Email of the person being invited.
+    # @return [Calendly::OrganizationInvitation]
+    # @raise [Calendly::Error] if the uuid is empty.
+    # @raise [Calendly::Error] if the email is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.1.0
+    def create_invitation(email)
+      client.create_invitation uuid, email
+    end
+  end
+end

data/lib/calendly/models/organization_invitation.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+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
+
+    # @return [String]
+    # unique id of the OrganizationInvitation object.
+    attr_accessor :uuid
+    # @return [String]
+    # Canonical resource reference.
+    attr_accessor :uri
+    # @return [String]
+    # Invited person's email.
+    attr_accessor :email
+    # @return [String]
+    # Invitation status.
+    attr_accessor :status
+    # @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 [Time]
+    # Moment when the last invitation was sent.
+    attr_accessor :last_sent_at
+
+    # @return [Organization]
+    # Reference to Organization associated with this invitation.
+    attr_accessor :organization
+
+    # @return [User]
+    # If a person accepted the invitation, a reference to their User.
+    attr_accessor :user
+
+    #
+    # Get Organization Invitation associated with self.
+    #
+    # @return [Calendly::OrganizationInvitation]
+    # @raise [Calendly::Error] if the organization.uuid is empty.
+    # @raise [Calendly::Error] if the uuid is empty.
+    # @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
+    end
+
+    #
+    # Revoke self Invitation.
+    #
+    # @return [true]
+    # @raise [Calendly::Error] if the organization.uuid is empty.
+    # @raise [Calendly::Error] if the uuid is empty.
+    # @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
+    end
+  end
+end

data/lib/calendly/models/organization_membership.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+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
+
+    # @return [String]
+    # unique id of the OrganizationMembership object.
+    attr_accessor :uuid
+    # @return [String]
+    # Canonical resource reference.
+    attr_accessor :uri
+    # @return [String]
+    # User's role within the organization
+    attr_accessor :role
+    # @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 [Calendly::User]
+    # Primary account details of a specific user.
+    attr_accessor :user
+
+    # @return [Organization]
+    # Reference to Organization associated with this membership.
+    attr_accessor :organization
+
+    #
+    # Get Organization Membership associated with self.
+    #
+    # @return [Calendly::OrganizationMembership]
+    # @raise [Calendly::Error] if the uuid is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.1.0
+    def fetch
+      client.membership uuid
+    end
+
+    #
+    # Remove self from associated Organization.
+    #
+    # @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_membership uuid
+    end
+  end
+end

data/lib/calendly/models/user.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Calendly
+  # Calendly's user model.
+  # Primary account details of a specific user.
+  class User
+    include ModelUtils
+    UUID_RE = %r{\A#{Client::API_HOST}/users/(\w+)\z}.freeze
+    TIME_FIELDS = %i[created_at updated_at].freeze
+
+    # @return [String]
+    # unique id of the User object.
+    attr_accessor :uuid
+    # @return [String]
+    # Canonical resource reference.
+    attr_accessor :uri
+    # @return [String]
+    # User's human-readable name.
+    attr_accessor :name
+    # @return [String]
+    # Unique readable value used in page URL.
+    attr_accessor :slug
+    # @return [String]
+    # User's email address.
+    attr_accessor :email
+    # @return [String]
+    # URL of user's avatar image.
+    attr_accessor :avatar_url
+    # @return [String]
+    # URL of user's event page.
+    attr_accessor :scheduling_url
+    # @return [String]
+    # Timezone offest to use when presenting time information to user.
+    attr_accessor :timezone
+    # @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
+
+    #
+    # Get basic information associated with self.
+    #
+    # @return [Calendly::User]
+    # @raise [Calendly::Error] if the uuid is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.1.0
+    def fetch
+      client.user uuid
+    end
+
+    #
+    # Get an organization membership information associated with self.
+    #
+    # @return [Calendly::OrganizationMembership]
+    # @raise [Calendly::Error] if the uri is empty.
+    # @since 0.1.0
+    def organization_membership
+      mems, = client.memberships_by_user uri
+      mems.first
+    end
+
+    #
+    # Returns all Event Types 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 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 = {})
+      request_proc = proc { |options| client.event_types uri, options }
+      auto_pagination request_proc, opts
+    end
+
+    #
+    # Returns all Scheduled Events associated with self.
+    #
+    # @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] :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
+    # @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 = {})
+      request_proc = proc { |options| client.scheduled_events uri, options }
+      auto_pagination request_proc, opts
+    end
+  end
+end

data/lib/calendly/version.rb

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

data/lib/calendly.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'zeitwerk'
+loader = Zeitwerk::Loader.for_gem
+loader.collapse('**/models')
+loader.setup
+
+# module for Calendly apis client
+module Calendly
+  class << self
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+end