calendly 0.4.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06ba574d911ff7447d87b9dafe93105da126e1b78cc054d1e2d220e1403961e0
-  data.tar.gz: 7cd7c74bd6ad8679c0f83d8832fc3da0ef81013d677186a207890194116f69eb
+  metadata.gz: 7ba1370ffbfb35b34a37f514d94f48879a20a2ee5b33ebb1791969883a7303a7
+  data.tar.gz: 5deec005ae70cdbf6f864c7ed7eec03d8186ef3127452f4221e9c9e3863f7c8d
 SHA512:
-  metadata.gz: 0d95d23f7acfea8d1f5884930125f9f6489fb7ab7515090a39571712d994893b6de66a880bba72425cd090dae26a3cd07bb4a12266e8de48d347a8e334ce6604
-  data.tar.gz: b7b7902adf506e3498d32161794f7dc871e3797e6ed307aa72d35378cd8f1837feb8ea732e79d9f21d80adb45886c1e8611fcc33d8d244987a338bfca6dd5eae
+  metadata.gz: 9de051c920eb9480c7c337829c75d4a81ce8690fb95c30ba0e8a493677886de52581bbae1d4dc926274f1a6ccb0dfcecf6ea184770b358c3fccf948d64a8d459
+  data.tar.gz: a4f7068f0bbddf86699506133cebbeb1a8871a9f7523eac8e67e443a458367f1f5fc3de10b6d078801f8d502efe31bd20fb6c5d52fcbb0c588024b8ca1625fab

data/CHANGELOG.md

@@ -1,8 +1,69 @@
 # CHANGELOG
 
+## 0.7.0
+
+- supported a signing key parameter when creating webhooks. (#33)
+- changed `user_uri` argument to keyword argument on Client#create_webhook.
+
+## 0.6.0
+
+- supported 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
+  - Organization model
+    - (Add method) event_types
+    - (Add method) event_types!
+  - 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
+  - `POST /scheduling_links`
+
+## 0.5.1
+
+- added method EventType#fetch
+
+## 0.5.0
+
+- changed Calendly::Client#scheduled_events behavior (refs #21)
+  - previous version:
+    - getting events belonging to a specific USER
+  - current version:
+    - getting all events belonging to a specific ORGANIZATION
+- added Calendly::Client#scheduled_events_by_user method instead_of the before behavior
+
 ## 0.4.2
 
-- add new following fields to Invitee model (refs #21)
+- added new following fields to Invitee model (refs #21)
   - :rescheduled
   - :old_invitee
   - :new_invitee
@@ -11,20 +72,20 @@
 
 ## 0.4.1
 
-- support API
+- started to support a API
   - `GET /event_types/{uuid}`
 
 ## 0.4.0
 
-- fix changed Location fields such as `kind` to `type`. (refs #18)
+- fixed a changes for Location fields such as `kind` to `type`. (refs #18)
 
 ## 0.3.0
 
-- remove zeitwerk dependency. (refs #16)
+- removed zeitwerk dependency. (refs #16)
 
 ## 0.2.0
 
-- save fetched data in cache. (refs #14)
+- added caching features in object when fetching data. (refs #14)
 
 ## 0.1.3
 
@@ -36,59 +97,59 @@
 
 ## 0.1.2
 
-- fix rubocop warnings.
+- fixed rubocop warnings.
 
 ## 0.1.1
 
-- add tests to make coverage 100%.
+- added tests to make coverage 100%.
 
 ## 0.1.0
 
-- define methods to access associated resources with each model.
-- rename methods:
+- defined methods to access associated resources with each model.
+- renamed methods:
   - `Calendly::Client#events` to `Calendly::Client#scheduled_events`
 
 ## 0.0.7.alpha
 
-- support APIs
+- started to support APIs
   - `POST /organizations/{uuid}/invitations`
   - `DELETE /organizations/{org_uuid}/invitations/{invitation_uuid}`
   - `DELETE /organization_memberships/{uuid}`
 
 ## 0.0.6.alpha
 
-- support APIs
+- started to support APIs
   - `GET /organizations/{uuid}/invitations`
   - `GET /organizations/{organization_uuid}/invitations/{invitation_uuid}`
 
 ## 0.0.5.alpha
 
-- support APIs
+- started to support APIs
   - `GET /organization_memberships`
   - `GET /organization_memberships/{uuid}`
-- rename fields
+- renamed fields
   - Invitee#event to Invitee#event_uri
   - Event#event_type to Event#event_type_uri
 
 ## 0.0.4.alpha
 
-- support APIs
+- started to support APIs
   - `GET /scheduled_events/{event_uuid}/invitees`
   - `GET /scheduled_events/{event_uuid}/invitees/{invitee_uuid}`
 
 ## 0.0.3.alpha
 
-- support APIs
+- started to support APIs
   - `GET /scheduled_events`
   - `GET /scheduled_events/{uuid}`
 
 ## 0.0.2.alpha
 
-- support APIs
+- started to support APIs
   - `GET /event_types`
 
 ## 0.0.1.alpha
 
 - Initial release
-- support APIs
+- started to support a API
   - `GET /users/{uuid}`

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]
@@ -144,10 +171,42 @@ module Calendly
     end
 
     #
-    # Get List of User Events.
+    # Get List of scheduled events belonging to a specific 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] :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<Array<Calendly::Event>, Hash>]
+    #  - [Array<Calendly::Event>] events
+    #  - [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.5.0
+    def scheduled_events(org_uri, opts = {})
+      check_not_empty org_uri, 'org_uri'
+
+      opts_keys = %i[count invitee_email max_start_time min_start_time page_token sort status]
+      params = {organization: org_uri}
+      params = merge_options opts, opts_keys, params
+      body = request :get, 'scheduled_events', params: params
+
+      items = body[:collection] || []
+      evs = items.map { |item| Event.new item, self }
+      [evs, next_page_params(body)]
+    end
+
+    #
+    # Get List of scheduled events belonging to a specific user.
     #
     # @param [String] user_uri the specified user (user's uri).
     # @param [Hash] opts the optional request parameters.
+    # @option opts [String] :organization the specified organization (organization's uri).
     # @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.
@@ -161,10 +220,10 @@ module Calendly
     # @raise [Calendly::Error] if the user_uri arg is empty.
     # @raise [Calendly::ApiError] if the api returns error code.
     # @since 0.0.3
-    def scheduled_events(user_uri, opts = {})
+    def scheduled_events_by_user(user_uri, opts = {})
       check_not_empty user_uri, 'user_uri'
 
-      opts_keys = %i[count invitee_email max_start_time min_start_time page_token sort status]
+      opts_keys = %i[organization count invitee_email max_start_time min_start_time page_token sort status]
       params = {user: user_uri}
       params = merge_options opts, opts_keys, params
       body = request :get, 'scheduled_events', params: params
@@ -235,7 +294,7 @@ module Calendly
     end
 
     #
-    # Get List memberships of all users belonging to an organization.
+    # Get List of memberships belonging to specific an organization.
     #
     # @param [String] org_uri the specified organization (organization's uri).
     # @param [Hash] opts the optional request parameters.
@@ -262,7 +321,7 @@ module Calendly
     end
 
     #
-    # Get List memberships of all users belonging to an organization by user.
+    # Get List of memberships belonging to specific a user.
     #
     # @param [String] user_uri the specified user (user's uri).
     # @param [Hash] opts the optional request parameters.
@@ -461,26 +520,29 @@ module Calendly
     # @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
     # @param [String] org_uri The unique reference to the organization that the webhook will be tied to.
-    # @param [String] user_uri The unique reference to the user that the webhook will be tied to.
+    # @param [String] user_uri The unique reference to the user that the webhook will be tied to. Optional.
+    # @param [String] signing_key secret key shared between your application and Calendly. Optional.
     # @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 org_uri arg is empty.
     # @raise [Calendly::ApiError] if the api returns error code.
     # @since 0.1.3
-    def create_webhook(url, events, org_uri, user_uri = nil)
+    def create_webhook(url, events, org_uri, user_uri: nil, signing_key: nil) # rubocop:disable Metrics/ParameterLists
       check_not_empty url, 'url'
       check_not_empty events, 'events'
       check_not_empty org_uri, 'org_uri'
 
       params = {url: url, events: events, organization: org_uri}
+      params[:signing_key] = signing_key if signing_key
+
       if user_uri
         params[:scope] = 'user'
         params[:user] = user_uri
       else
         params[:scope] = 'organization'
       end
-      body = request(:post, 'webhook_subscriptions', body: params)
+      body = request :post, 'webhook_subscriptions', body: params
       WebhookSubscription.new body[:resource], self
     end
 
@@ -498,12 +560,43 @@ module Calendly
       true
     end
 
+    #
+    # Create a scheduling link.
+    #
+    # @param [String] uri A link to the resource that owns this scheduling Link.
+    # @param [String] max_event_count The max number of events that can be scheduled using this scheduling link.
+    # @param [String] resource_type Resource type.
+    # @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 arg is empty.
+    # @raise [Calendly::Error] if the max_event_count arg is empty.
+    # @raise [Calendly::Error] if the resource_type arg is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.5.2
+    def create_schedule_link(uri, max_event_count = 1, resource_type: 'EventType')
+      check_not_empty uri, 'uri'
+      check_not_empty max_event_count, 'max_event_count'
+      check_not_empty resource_type, 'resource_type'
+      params = {
+        max_event_count: max_event_count,
+        owner: uri,
+        owner_type: resource_type
+      }
+      body = request :post, 'scheduling_links', body: params
+      body[:resource]
+    end
+
   private
 
     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}"
+      res = access_token.request method, path, params: params, body: 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