calendly 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 987260a701999245159a34a38b587e873a80272a3391b5909339c7b6cd01994a
-  data.tar.gz: bb1b11aba44dcfca555b97887611cc989921a972263ea071e1ec144cac7d2bf6
+  metadata.gz: 5890f2e5488593ef1b1edcc4284abb1d50442fe66a782322aff7990d3a1d9424
+  data.tar.gz: de8d74e6d9b4b588cca90dc075b74d497ddb92f1cc4ca22db71e15f0da01d8ac
 SHA512:
-  metadata.gz: 62d40c515e6833f34ef591b8b2a2a8089970951f6eae3fb68190388de58919a67c16851426f11c0c7c2b06bbc89f9de5248223ed2bd0d4b45fe45c11c0e232d7
-  data.tar.gz: 58136d311993b7b3a1e352888eba6756c7235476078934f2b8e893f06a29af33e36cefd3bdb751d8540948953c1cfdd145c1e160779cad2d3c554eff3f1ccc31
+  metadata.gz: 91ed1a2beab52e4e92bc6b1c068323ad882cdef5bf7f74f538ef3919d1cae64139da374471e68200c644571b235a12e8c69ccb74086a1834113add6ebe93dd56
+  data.tar.gz: a3a596cfb67f401756b2f913598845003d3b17c861d292da9706f630ff0028c07e97b52e9b7b989b0853be16f09de9c33c4570c71c8c8bc28fd96fc26d4040d8

data/CHANGELOG.md

@@ -1,5 +1,40 @@
 # CHANGELOG
 
+## 0.6.0
+
+- supported to new features until April 2021. (#29)
+  - Client
+    - (Change) support organization options in `event_types` api.
+    - (Rename) `event_types` to `event_types_by_user`
+  - User model
+    - (Add field) current_organization
+    - (Add method) webhooks
+    - (Add method) webhooks!
+    - (Add method) create_webhook
+  - Event model
+    - (Remove field) invitees_counter_total
+    - (Remove field) invitees_counter_active
+    - (Remove field) invitees_counter_limit
+    - (Add field) invitees_counter
+    - (Add field) event_memberships
+    - (Add field) event_guests
+  - EventType model
+    - (Remove field) owner_uuid
+    - (Remove field) owner_uri
+    - (Remove field) owner_name
+    - (Add field) profile
+    - (Add field) secret
+    - (Add field) custom_questions
+    - (Add method) owner_user
+    - (Add method) owner_team
+  - Invitee model
+    - (Add field) first_name
+    - (Add field) last_name
+    - (Add field) cancellation
+    - (Add field) payment
+- fixed debug log encoding error. (#30)
+- improved inspect method to be more readable in CLI.
+
 ## 0.5.2
 
 - started to support a API

data/README.md

@@ -50,21 +50,28 @@ client = Calendly::Client.new '<ACCESS_TOKEN>'
 This client basic usage is below.
 
 ```ruby
+#
 # get a current user's information.
+#
 me = client.me
-# => <Calendly::User uuid:U001>
+# => #<Calendly::User uuid="U001", name="Foo Bar", slug="foobar", email="foobar@example.com", ..>
+
 me.scheduling_url
-# => "https://calendly.com/your_name"
+# => "https://calendly.com/foobar"
 
-# get all Event Types
+#
+# get all event types
+#
 event_types = me.event_types
-# => [#<Calendly::EventType uuid:ET001>, #<Calendly::EventType uuid:ET002>, #<Calendly::EventType uuid:ET003>]
+# => [#<Calendly::EventType uuid="ET001", name="15 Minute Meeting", type="StandardEventType", slug="15min", active=true, kind="solo", scheduling_url="https://calendly.com/foobar/15min", ..>, #<Calendly::EventType uuid="ET002", name="30 Minute Meeting", type="StandardEventType", slug="30min", active=true, kind="solo", scheduling_url="https://calendly.com/foobar/30min", ..>]
 event_types.first.scheduling_url
-# => "https://calendly.com/your_name/30min"
+# => "https://calendly.com/foobar/15min"
 
+#
 # get scheduled events
+#
 events = me.scheduled_events
-# => => [#<Calendly::Event uuid:EV001>, #<Calendly::Event uuid:EV002>, #<Calendly::Event uuid:EV003>]
+# => => [#<Calendly::Event uuid="EV001", name="FooBar Meeting", status="active", ..>, #<Calendly::Event uuid="EV002", name="Team Meeting", status="active", ..>]
 ev = events.first
 ev.name
 # => "FooBar Meeting"
@@ -73,21 +80,23 @@ ev.start_time
 ev.end_time
 # => 2020-07-22 02:00:00 UTC
 
-# get organization information
-own_member = me.organization_membership
-# => #<Calendly::OrganizationMembership uuid:MEM001>
-my_org = own_member.organization
-all_members = my_org.memberships
-# => [#<Calendly::OrganizationMembership uuid:MEM001>, #<Calendly::OrganizationMembership uuid:MEM002>]
+#
+# get a current organization's information
+#
+org = me.current_organization
+# => #<Calendly::Organization uuid="ORG001", ..>
+all_members = org.memberships
+# => [#<Calendly::OrganizationMembership uuid="MEM001", role="owner", ..>, #<Calendly::OrganizationMembership uuid="MEM002", role="user", ..>]
 
+#
 # create new invitation and send invitation email
-invitation = my_org.create_invitation('foobar@example.com')
-# => #<Calendly::OrganizationInvitation uuid:INV001>
-invitation.status
-# => "pending"
+#
+invitation = org.create_invitation('foobar@example.com')
+# => #<Calendly::OrganizationInvitation uuid="INV001", status="pending", email="foobar@example.com", ..>
 
 # cancel the invitation
 invitation.delete
+# => true
 ```
 
 ### Webhook
@@ -96,31 +105,33 @@ The webhook usage is below.
 
 ```ruby
 events = ['invitee.created', 'invitee.canceled']
-own_member = client.me.organization_membership
-org = own_member.organization
-
-# create user scope webhook
 url = 'https://example.com/received_event'
-user_webhook = own_member.create_user_scope_webhook(url, events)
-# => #<Calendly::WebhookSubscription uuid:USER_WEBHOOK_001>
+
+#
+# create a user scope webhook
+#
+me = client.me
+user_webhook = me.create_webhook(url, events)
+# => #<Calendly::WebhookSubscription uuid="USER_WEBHOOK_001", state="active", scope="user", events=["invitee.created", "invitee.canceled"], callback_url="https://example.com/received_event", ..>
 
 # list of user scope webhooks
-own_member.user_scope_webhooks
-# => [#<Calendly::WebhookSubscription uuid:USER_WEBHOOK_001>]
+me.webhooks
+# => [#<Calendly::WebhookSubscription uuid="USER_WEBHOOK_001", state="active", scope="user", events=["invitee.created", "invitee.canceled"], callback_url="https://example.com/received_event", ..>]
 
 # delete the webhook
 user_webhook.delete
 # => true
 
-
-# create organization scope webhook
-url = 'https://example.com/received_event'
+#
+# create an organization scope webhook
+#
+org = client.me.current_organization
 org_webhook = org.create_webhook(url, events)
-# => #<Calendly::WebhookSubscription uuid:ORG_WEBHOOK_001>
+# => #<Calendly::WebhookSubscription uuid="ORG_WEBHOOK_001", state="active", scope="organization", events=["invitee.created", "invitee.canceled"], callback_url="https://example.com/received_event", ..>
 
 # list of organization scope webhooks
 org.webhooks
-# => [#<Calendly::WebhookSubscription uuid:ORG_WEBHOOK_001>]
+# => [#<Calendly::WebhookSubscription uuid="ORG_WEBHOOK_001", state="active", scope="organization", events=["invitee.created", "invitee.canceled"], callback_url="https://example.com/received_event", ..>]
 
 # delete the webhook
 org_webhook.delete

data/lib/calendly/api_error.rb

@@ -7,10 +7,13 @@ module Calendly
   class ApiError < Error
     # @return [Faraday::Response]
     attr_reader :response
+
     # @return [Integer]
     attr_reader :status
+
     # @return [String]
     attr_reader :title
+
     # @return [OAuth2::Error, JSON::ParserError]
     attr_reader :cause_exception
 

data/lib/calendly/client.rb

@@ -25,7 +25,7 @@ module Calendly
     # @return [OAuth2::AccessToken]
     # @since 0.0.1
     def access_token
-      return @access_token if defined? @access_token
+      return @access_token if defined?(@access_token) && @access_token
 
       client = OAuth2::Client.new(@config.client_id,
                                   @config.client_secret, client_options)
@@ -59,7 +59,7 @@ module Calendly
     # @raise [Calendly::ApiError] if the api returns error code.
     # @since 0.0.1
     def current_user
-      return @cached_current_user if @cached_current_user
+      return @cached_current_user if defined?(@cached_current_user) && @cached_current_user
 
       @cached_current_user = user
     end
@@ -103,7 +103,34 @@ module Calendly
     end
 
     #
-    # Returns all Event Types associated with a specified User.
+    # Returns all Event Types associated with a specified organization.
+    #
+    # @param [String] org_uri the specified organization (organization's uri).
+    # @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<Array<Calendly::EventType>, Hash>]
+    #  - [Array<Calendly::EventType>] event_types
+    #  - [Hash] next_params the parameters to get next data. if thre is no next it returns nil.
+    # @raise [Calendly::Error] if the org_uri arg is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.6.0
+    def event_types(org_uri, opts = {})
+      check_not_empty org_uri, 'org_uri'
+
+      opts_keys = %i[count page_token sort]
+      params = {organization: org_uri}
+      params = merge_options opts, opts_keys, params
+      body = request :get, 'event_types', params: params
+
+      items = body[:collection] || []
+      ev_types = items.map { |item| EventType.new item, self }
+      [ev_types, next_page_params(body)]
+    end
+
+    #
+    # Returns all Event Types associated with a specified user.
     #
     # @param [String] user_uri the specified user (user's uri).
     # @param [Hash] opts the optional request parameters.
@@ -116,7 +143,7 @@ module Calendly
     # @raise [Calendly::Error] if the user_uri arg is empty.
     # @raise [Calendly::ApiError] if the api returns error code.
     # @since 0.0.2
-    def event_types(user_uri, opts = {})
+    def event_types_by_user(user_uri, opts = {})
       check_not_empty user_uri, 'user_uri'
 
       opts_keys = %i[count page_token sort]
@@ -566,7 +593,7 @@ module Calendly
     def request(method, path, params: nil, body: nil)
       debug_log "Request #{method.to_s.upcase} #{API_HOST}/#{path} params:#{params}, body:#{body}"
       res = access_token.request method, path, params: params, body: body
-      debug_log "Response status:#{res.status}, body:#{res.body}"
+      debug_log "Response status:#{res.status}, body:#{res.body.dup&.force_encoding(Encoding::UTF_8)}"
       parse_as_json res
     rescue OAuth2::Error => e
       res = e.response.response

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,78 +2,109 @@
 
 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
+
+    # @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
+
+    # 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.
@@ -107,14 +138,8 @@ module Calendly
 
   private
 
-    def after_set_attributes(attrs)
-      super attrs
-      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]
+    def inspect_attributes
+      super + %i[active kind scheduling_url]
     end
   end
 end