calendly 0.1.3 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73fe04308ea6b80fec0d5141f3a848476d0b4dd0e818cc32019ab54f9ad02243
-  data.tar.gz: 2adaee2381b6631af1d19eb07d0fa122b1cd8d347c877c07808bac5cb3670d6e
+  metadata.gz: 06ba574d911ff7447d87b9dafe93105da126e1b78cc054d1e2d220e1403961e0
+  data.tar.gz: 7cd7c74bd6ad8679c0f83d8832fc3da0ef81013d677186a207890194116f69eb
 SHA512:
-  metadata.gz: 3a3b7a7dc8926ea80d87e9a3cc5b96a4c6816b78baebeac4d28773eba80ad6078c44ea379e01d0be87ecd47bc8f12eef4d64516a67b7e11adc2a5e843aacc9a7
-  data.tar.gz: bf1eb06ab1432c27b7d557cd4c703a6d157ce26f526942a89f3102b34c9d8ba6b3e123d78b5e7ca53348e49125be7e2e3423da7f68540c799745b7b2c35d8c3b
+  metadata.gz: 0d95d23f7acfea8d1f5884930125f9f6489fb7ab7515090a39571712d994893b6de66a880bba72425cd090dae26a3cd07bb4a12266e8de48d347a8e334ce6604
+  data.tar.gz: b7b7902adf506e3498d32161794f7dc871e3797e6ed307aa72d35378cd8f1837feb8ea732e79d9f21d80adb45886c1e8611fcc33d8d244987a338bfca6dd5eae

data/CHANGELOG.md

@@ -1,9 +1,34 @@
-
 # CHANGELOG
 
+## 0.4.2
+
+- add new following fields to Invitee model (refs #21)
+  - :rescheduled
+  - :old_invitee
+  - :new_invitee
+  - :cancel_url
+  - :reschedule_url
+
+## 0.4.1
+
+- support API
+  - `GET /event_types/{uuid}`
+
+## 0.4.0
+
+- fix changed Location fields such as `kind` to `type`. (refs #18)
+
+## 0.3.0
+
+- remove zeitwerk dependency. (refs #16)
+
+## 0.2.0
+
+- save fetched data in cache. (refs #14)
+
 ## 0.1.3
 
-- support webhook APIs
+- support webhook APIs (refs #9)
   - `GET /webhook_subscriptions`
   - `GET /webhook_subscriptions/{webhook_uuid}`
   - `POST /webhook_subscriptions`

data/README.md

@@ -5,40 +5,7 @@
 [![Gem Version](https://badge.fury.io/rb/calendly.svg)](http://badge.fury.io/rb/calendly)
 [![license](https://img.shields.io/github/license/koshilife/calendly-api-ruby-client)](https://github.com/koshilife/calendly-api-ruby-client/blob/master/LICENSE.txt)
 
-## About
-
-These client libraries are created for [Calendly v2 APIs](https://calendly.stoplight.io/docs/gh/calendly/api-docs).
-
-As of August 2020, Calendly v2 API is currently undergoing an upgrade.
-This library is trying to follow and support for the upgrade.
-
-As of now the supported statuses each Calendly API are as below.
-
-## Supported statuses each Calendly API
-
-- User
-  - [x] Get basic information about a user
-- EventType
-  - [ ] Get Event Type (This endpoint hasn't been released yet.)
-  - [x] User Event Types
-- Organization
-  - [x] Get Organization Invitation
-  - [x] Get Organization Invitations
-  - [x] Get Organization Membership
-  - [x] Get a list of Organization Memberships
-  - [x] Invite a person to Organization
-  - [x] Remove a User from an Organization
-  - [x] Revoke Organization Invitation
-- ScheduledEvent
-  - [x] Get Event
-  - [x] Get Invitee of an Event
-  - [x] Get List of Event Invitees
-  - [x] Get List of User Events
-- Webhook V2
-  - [x] Create Webhook Subscription
-  - [x] Delete Webhook Subscription
-  - [x] Get Webhook Subscription
-  - [x] List Webhook Subscriptions
+These client libraries are created for [Calendly v2 APIs](https://calendly.stoplight.io/).
 
 ## Installation
 
@@ -172,6 +139,8 @@ invitation = my_org.create_invitation('foobar@example.com')
 # D, [2020-08-10T10:48:16] DEBUG -- : Response status:201, body:{"resource":{"created_at":"2020-08-10T10:48:16.051159Z","email":"foobar@example.com","last_sent_at":"2020-08-10T10:48:16.096518Z","organization":"https://api.calendly.com/organizations/ORG001","status":"pending","updated_at":"2020-08-10T10:48:16.051159Z","uri":"https://api.calendly.com/organizations/ORG001/invitations/INV001"}}
 ```
 
+More in-depth method documentation can be found at [RubyDoc.info](https://www.rubydoc.info/gems/calendly/).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on [GitHub](https://github.com/koshilife/calendly-api-ruby-client). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/calendly.gemspec

@@ -29,7 +29,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'oauth2', '>= 1.4.4'
-  spec.add_runtime_dependency 'zeitwerk', '>= 2.3.0'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'codecov'

data/lib/calendly.rb

@@ -1,9 +1,17 @@
 # frozen_string_literal: true
 
-require 'zeitwerk'
-loader = Zeitwerk::Loader.for_gem
-loader.collapse('**/models')
-loader.setup
+Dir[
+  File.join(
+    File.dirname(__FILE__),
+    'calendly',
+    '**',
+    '*'
+  )
+].sort.each do |f|
+  next if File.directory? f
+
+  require f
+end
 
 # module for Calendly apis client
 module Calendly

data/lib/calendly/api_error.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require 'calendly/error'
+
 module Calendly
   # Calendly apis client error object.
-  class ApiError < Calendly::Error
+  class ApiError < Error
     # @return [Faraday::Response]
     attr_reader :response
     # @return [Integer]

data/lib/calendly/client.rb

@@ -59,11 +59,21 @@ module Calendly
     # @raise [Calendly::ApiError] if the api returns error code.
     # @since 0.0.1
     def current_user
-      user
+      return @cached_current_user if @cached_current_user
+
+      @cached_current_user = user
     end
 
     alias me current_user
 
+    # @since 0.2.0
+    def current_user!
+      @cached_current_user = nil
+      current_user
+    end
+
+    alias me! current_user!
+
     #
     # Get basic information about a user
     #
@@ -78,6 +88,20 @@ module Calendly
       User.new body[:resource], self
     end
 
+    #
+    # Returns a single Event Type by its UUID.
+    #
+    # @param [String] uuid the specified event type (event type's uuid).
+    # @return [Calendly::EventType]
+    # @raise [Calendly::Error] if the uuid arg is empty.
+    # @raise [Calendly::ApiError] if the api returns error code.
+    # @since 0.4.1
+    def event_type(uuid)
+      check_not_empty uuid, 'uuid'
+      body = request :get, "event_types/#{uuid}"
+      EventType.new body[:resource], self
+    end
+
     #
     # Returns all Event Types associated with a specified User.
     #
@@ -495,7 +519,7 @@ module Calendly
     end
 
     def check_not_empty(value, name)
-      raise Calendly::Error.new("#{name} is required.") if blank? value
+      raise Error.new("#{name} is required.") if blank? value
     end
 
     def blank?(value)

data/lib/calendly/error.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'calendly/loggable'
+
 module Calendly
   # calendly module's base error object
   class Error < StandardError

data/lib/calendly/loggable.rb

@@ -19,7 +19,7 @@ module Calendly
       log msg, :debug
     end
 
-    private
+  private
 
     def log(msg, level = :info)
       logger = Calendly.configuration.logger

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
@@ -79,8 +83,16 @@ module Calendly
     # @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
+
+    # @since 0.2.0
+    def invitees!(opts = {})
+      @cached_invitees = nil
+      invitees opts
     end
 
   private

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

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.
@@ -30,6 +34,22 @@ module Calendly
     # @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

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.

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
 
     #
@@ -44,8 +55,16 @@ module Calendly
     # @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
 
     #
@@ -74,8 +93,16 @@ module Calendly
     # @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 }
-      auto_pagination request_proc, opts
+      @cached_webhooks = auto_pagination request_proc, opts
+    end
+
+    # @since 0.2.0
+    def webhooks!(opts = {})
+      @cached_webhooks = nil
+      webhooks opts
     end
 
     #

data/lib/calendly/models/organization_invitation.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+require 'calendly/client'
+require 'calendly/models/model_utils'
+require 'calendly/models/organization'
+require 'calendly/models/user'
+
 module Calendly
   # Calendly's organization invitation model.
   class OrganizationInvitation

data/lib/calendly/models/organization_membership.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+require 'calendly/client'
+require 'calendly/models/model_utils'
+require 'calendly/models/organization'
+require 'calendly/models/user'
+
 module Calendly
   # Calendly's organization membership model.
   class OrganizationMembership
@@ -67,10 +72,18 @@ module Calendly
     # @raise [Calendly::ApiError] if the api returns error code.
     # @since 0.1.3
     def user_scope_webhooks(opts = {})
+      return @cached_user_scope_webhooks if @cached_user_scope_webhooks
+
       org_uri = organization.uri if organization
       user_uri = user.uri if user
       request_proc = proc { |options| client.user_scope_webhooks org_uri, user_uri, options }
-      auto_pagination request_proc, opts
+      @cached_user_scope_webhooks = auto_pagination request_proc, opts
+    end
+
+    # @since 0.2.0
+    def user_scope_webhooks!(opts = {})
+      @cached_user_scope_webhooks = nil
+      user_scope_webhooks opts
     end
 
     #

data/lib/calendly/models/user.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'calendly/client'
+require 'calendly/models/model_utils'
+
 module Calendly
   # Calendly's user model.
   # Primary account details of a specific user.
@@ -57,8 +60,16 @@ module Calendly
     # @raise [Calendly::Error] if the uri is empty.
     # @since 0.1.0
     def organization_membership
+      return @cached_organization_membership if @cached_organization_membership
+
       mems, = client.memberships_by_user uri
-      mems.first
+      @cached_organization_membership = mems.first
+    end
+
+    # @since 0.2.0
+    def organization_membership!
+      @cached_organization_membership = nil
+      organization_membership
     end
 
     #
@@ -74,8 +85,16 @@ module Calendly
     # @raise [Calendly::ApiError] if the api returns error code.
     # @since 0.1.0
     def event_types(opts = {})
+      return @cached_event_types if @cached_event_types
+
       request_proc = proc { |options| client.event_types uri, options }
-      auto_pagination request_proc, opts
+      @cached_event_types = auto_pagination request_proc, opts
+    end
+
+    # @since 0.2.0
+    def event_types!(opts = {})
+      @cached_event_types = nil
+      event_types opts
     end
 
     #
@@ -95,8 +114,16 @@ module Calendly
     # @raise [Calendly::ApiError] if the api returns error code.
     # @since 0.1.0
     def scheduled_events(opts = {})
+      return @cached_scheduled_events if @cached_scheduled_events
+
       request_proc = proc { |options| client.scheduled_events uri, options }
-      auto_pagination request_proc, opts
+      @cached_scheduled_events = auto_pagination request_proc, opts
+    end
+
+    # @since 0.2.0
+    def scheduled_events!(opts = {})
+      @cached_scheduled_events = nil
+      scheduled_events opts
     end
   end
 end

data/lib/calendly/models/webhook_subscription.rb

@@ -1,7 +1,10 @@
-# Get a webhook subscription matching the provided UUID for the webhook subscription
-
 # frozen_string_literal: true
 
+require 'calendly/client'
+require 'calendly/models/model_utils'
+require 'calendly/models/organization'
+require 'calendly/models/user'
+
 module Calendly
   # Calendly's webhook model.
   class WebhookSubscription

data/lib/calendly/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calendly
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.4.2
 platform: ruby
 authors:
 - Kenji Koshikawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-17 00:00:00.000000000 Z
+date: 2020-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.4
-- !ruby/object:Gem::Dependency
-  name: zeitwerk
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -168,7 +154,7 @@ metadata:
   homepage_uri: https://github.com/koshilife/calendly-api-ruby-client
   source_code_uri: https://github.com/koshilife/calendly-api-ruby-client
   changelog_uri: https://github.com/koshilife/calendly-api-ruby-client/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/calendly/0.1.3
+  documentation_uri: https://www.rubydoc.info/gems/calendly/0.4.2
 post_install_message: 
 rdoc_options: []
 require_paths: