gitlab-customer-support-operations_calendly 1.0.0

data/lib/support_ops_calendly/calendly/organizations.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Calendly
+  module Calendly
+    ##
+    # Defines the module Organizations within the module {SupportOps::Calendly}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [String] created_at Timestamp of when the organization was created
+    # @attr [String] kind Indicates whether the organization is a single-user or multiple-user organization
+    # @attr [String] name The Organization name (in human-readable format)
+    # @attr [String] plan Active subscription plan or trial plan
+    # @attr [String] stage Current stage of organization
+    # @attr [String] updated_at Timestamp of when the organization was created or updated
+    # @attr [String] uri Canonical resource reference
+    class Organizations < SupportOps::Calendly::Base
+      # @!parse
+      #   # Returns the UUID of an organization
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [String] The UUID
+      #   # @note This is inherited from {SupportOps::Calendly::Base#uuid}
+      #   # @example
+      #   #   require 'support_ops_calendly'
+      #   #
+      #   #   SupportOps::Calendly::Configuration.configure do |config|
+      #   #     config.token = 'abc123'
+      #   #   end
+      #   #
+      #   #   org = SupportOps::Calendly::Organizations.current
+      #   #   pp org.uuid
+      #   #   #=> "BBBBBBBBBBBBBBBB"
+      #   def uuid; end
+      # @!parse
+      #   # Returns the organization memberships of an organization
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Array]
+      #   # @note This is inherited from {SupportOps::Calendly::Base#members}
+      #   # @example
+      #   #   require 'support_ops_calendly'
+      #   #
+      #   #   SupportOps::Calendly::Configuration.configure do |config|
+      #   #     config.token = 'abc123'
+      #   #   end
+      #   #
+      #   #   org = SupportOps::Calendly::Organizations.current
+      #   #   members = org.members
+      #   #   pp members.count
+      #   #   #=> 13
+      #   #   pp members.first.user.uuid
+      #   #   #=> "AAAAAAAAAAAAAAAA"
+      #   def members; end
+      define_attributes :created_at, :kind, :name, :plan, :stage, :updated_at,
+                        :uri
+      readonly_attributes :created_at, :kind, :name, :plan, :stage, :updated_at,
+                          :uri
+
+      ##
+      # Returns basic information about your user's current organization
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @example
+      #   require 'support_ops_calendly'
+      #
+      #   SupportOps::Calendly::Configuration.configure do |config|
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   org = SupportOps::Calendly::Organizations.current
+      #   pp org.name
+      #   # => "Sales Team"
+      def self.current
+        user = Users.current
+        Organizations.get!(user.current_organization.split('/').last)
+      end
+
+      ##
+      # Returns information about a specified Organization
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.calendly.com/api-docs/9738aea27ba80-get-organization
+      #   Calendly API > Organizations > Get Organization
+      # @example
+      #   require 'support_ops_calendly'
+      #
+      #   SupportOps::Calendly::Configuration.configure do |config|
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   org = SupportOps::Calendly::Organizations.get('BBBBBBBBBBBBBBBB')
+      #   pp org.name
+      #   # => "Sales Team"
+      def self.get(object)
+        if object.is_a? Organizations
+          Organizations.new(uri: uri).find
+        else
+          Organizations.new(uri: object).find
+        end
+      end
+
+      ##
+      # Returns information about a specified Organization
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.calendly.com/api-docs/9738aea27ba80-get-organization
+      #   Calendly API > Organizations > Get Organization
+      # @example
+      #   require 'support_ops_calendly'
+      #
+      #   SupportOps::Calendly::Configuration.configure do |config|
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   org = SupportOps::Calendly::Organizations.get!('BBBBBBBBBBBBBBBB')
+      #   pp org.name
+      #   # => "Sales Team"
+      def self.get!(object)
+        if object.is_a? Organizations
+          Organizations.new(uri: uri).find!
+        else
+          Organizations.new(uri: object).find!
+        end
+      end
+
+      private
+
+      ##
+      # @private
+      def uuid_record
+        (uri =~ /^https/ ? uri.split('/').last : uri)
+      end
+
+      ##
+      # @private
+      def get_record
+        response = self.client.connection.get("organizations/#{uuid}")
+        return nil if response.status != 200
+
+        Oj.load(response.body)['resource']
+      end
+
+      ##
+      # @private
+      def members_record
+        OrganizationMemberships.list(self.uri)
+      end
+    end
+  end
+end

data/lib/support_ops_calendly/calendly/users.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Calendly
+  module Calendly
+    ##
+    # Defines the module Users within the module {SupportOps::Calendly}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [String] avatar_url The URL of the user's avatar (image)
+    # @attr [String] created_at The moment when the user's record was created (e.g. "2020-01-02T03:04:05.678123Z")
+    # @attr [String] current_organization A unique reference to the user's current organization
+    # @attr [String] email The user's email address
+    # @attr [String] locale The user's language preference
+    # @attr [String] name The user's name (human-readable format)
+    # @attr [String] resource_type Resource type to support polymorphic associations.
+    # @attr [String] scheduling_url The URL of the user's Calendly landing page (that lists all the user's event types)
+    # @attr [String] slug The portion of URL for the user's scheduling page (where invitees book sessions), rendered in a human-readable format
+    # @attr [String] time_notation Time notation used by the user; accepts "12h" or "24h" as a value.
+    # @attr [String] timezone The time zone to use when presenting time to the user
+    # @attr [String] updated_at The moment when the user's record was last updated (e.g. "2020-01-02T03:04:05.678123Z")
+    # @attr [String] uri Canonical reference (unique identifier) for the user
+    class Users < SupportOps::Calendly::Base
+      # @!parse
+      #   # Returns the UUID of a user
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [String] The UUID
+      #   # @note This is inherited from {SupportOps::Calendly::Base#uuid}
+      #   # @example
+      #   #   require 'support_ops_calendly'
+      #   #
+      #   #   SupportOps::Calendly::Configuration.configure do |config|
+      #   #     config.token = 'abc123'
+      #   #   end
+      #   #
+      #   #   user = SupportOps::Calendly::Users.current
+      #   #   pp user.uuid
+      #   #   #=> "AAAAAAAAAAAAAAAA"
+      #   def uuid; end
+      define_attributes :avatar_url, :created_at, :current_organization, :email,
+                        :locale, :name, :resource_type, :scheduling_url, :slug,
+                        :time_notation, :timezone, :updated_at, :uri
+      readonly_attributes :avatar_url, :created_at, :current_organization,
+                          :email, :locale, :name, :resource_type,
+                          :scheduling_url, :slug, :time_notation, :timezone,
+                          :updated_at, :uri
+
+      ##
+      # Returns basic information about your user account.
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.calendly.com/api-docs/005832c83aeae-get-current-user
+      #   Calendly API > Users > Get current user
+      # @example
+      #   require 'support_ops_calendly'
+      #
+      #   SupportOps::Calendly::Configuration.configure do |config|
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   user = SupportOps::Calendly::Users.current
+      #   pp user.email
+      #   # => "admin@example.com"
+      def self.current
+        response = client.connection.get('users/me')
+        body = Oj.load(response.body)
+        Users.new(body['resource'])
+      end
+
+      ##
+      # Returns information about a specified User
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.calendly.com/api-docs/ff9832c5a6640-get-user
+      #   Calendly API > Users > Get user
+      # @example
+      #   require 'support_ops_calendly'
+      #
+      #   SupportOps::Calendly::Configuration.configure do |config|
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   user = SupportOps::Calendly::Users.get('AAAAAAAAAAAAAAAA')
+      #   pp user.email
+      #   # => "admin@example.com"
+      def self.get(object)
+        if object.is_a? Users
+          Users.new(uri: uri).find
+        else
+          Users.new(uri: object).find
+        end
+      end
+
+      ##
+      # Returns information about a specified User
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.calendly.com/api-docs/ff9832c5a6640-get-user
+      #   Calendly API > Users > Get user
+      # @example
+      #   require 'support_ops_calendly'
+      #
+      #   SupportOps::Calendly::Configuration.configure do |config|
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   user = SupportOps::Calendly::Users.get!('AAAAAAAAAAAAAAAA')
+      #   pp user.email
+      #   # => "admin@example.com"
+      def self.get!(object)
+        if object.is_a? Users
+          Users.new(uri: uri).find!
+        else
+          Users.new(uri: object).find!
+        end
+      end
+
+      private
+
+      ##
+      # @private
+      def uuid_record
+        (uri =~ /^https/ ? uri.split('/').last : uri)
+      end
+
+      ##
+      # @private
+      def get_record
+        response = self.client.connection.get("users/#{uuid}")
+        return nil if response.status != 200
+
+        Oj.load(response.body)['resource']
+      end
+    end
+  end
+end

data/lib/support_ops_calendly/calendly/webhooks.rb

@@ -0,0 +1,265 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Calendly
+  module Calendly
+    ##
+    # Defines the module Webhooks within the module {SupportOps::Calendly}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [String] callback_url The callback URL to use when the event is triggered
+    # @attr [String] created_at The moment when the webhook subscription was created (e.g. "2020-01-02T03:04:05.678123Z")
+    # @attr [String] creator The URI of the user who created the webhook subscription
+    # @attr [Array] events A list of events to which the webhook is subscribed
+    # @attr [String] group The URI of the group that's associated with the webhook subscription
+    # @attr [String] organization The URI of the organization that's associated with the webhook subscription
+    # @attr [String] retry_started_at The date and time the webhook subscription is retried
+    # @attr [String] scope The scope of the webhook subscription
+    # @attr [String] signing_key Optional secret key shared between your application and Calendly (creates only)
+    # @attr [String] state Indicates if the webhook subscription is "active" or "disabled"
+    # @attr [String] updated_at The moment when the webhook subscription was last updated (e.g. "2020-01-02T03:04:05.678123Z")
+    # @attr [String] uri Canonical reference (unique identifier) for the webhook
+    # @attr [String] url The URL where you want to receive POST requests for events you are subscribed to (creates only)
+    # @attr [String] user The URI of the user that's associated with the webhook subscription
+    # @todo Get sample webhook data => https://developer.calendly.com/api-docs/1da466e7fbc1b-get-sample-webhook-data
+    class Webhooks < SupportOps::Calendly::Base
+      # @!parse
+      #   # Create a Webhook Subscription for an Organization or User
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @see
+      #   #   https://developer.calendly.com/api-docs/c1ddc06ce1f1b-create-webhook-subscription
+      #   #   Calendly API > Webhooks > Create Webhook Subscription
+      #   # @note This is inherited from {SupportOps::Calendly::Base#save!}
+      #   # @example
+      #   #   require 'support_ops_calendly'
+      #   #
+      #   #   SupportOps::Calendly::Configuration.configure do |config|
+      #   #     config.token = 'abc123'
+      #   #   end
+      #   #
+      #   #   new_webhook = SupportOps::Calendly::Webhooks.new
+      #   #   new_webhook.events = ['invitee.created', 'invitee.canceled']
+      #   #   new_webhook.organization = https://api.calendly.com/organizations/BBBBBBBBBBBBBBBB'
+      #   #   new_webhook.scope = 'user'
+      #   #   new_webhook.url = 'https://blah.foo/bar'
+      #   #   new_webhook.user = 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA'
+      #   #   new_webhook.save!
+      #   #   pp new_webhook.uuid
+      #   #   #=> "DDDDDDDDDDDDDDDD"
+      #   def save!; end
+      # @!parse
+      #   # Delete a Webhook Subscription
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @see
+      #   #   https://developer.calendly.com/api-docs/565b97f62dafe-delete-webhook-subscription
+      #   #   Calendly API > Webhooks > Delete Webhook Subscription
+      #   # @note This is inherited from {SupportOps::Calendly::Base#delete!}
+      #   # @example
+      #   #   require 'support_ops_calendly'
+      #   #
+      #   #   SupportOps::Calendly::Configuration.configure do |config|
+      #   #     config.token = 'abc123'
+      #   #   end
+      #   #
+      #   #   webhook = SupportOps::Calendly::Webhooks.get!('DDDDDDDDDDDDDDDD')
+      #   #   webhook.delete!
+      #   def delete!; end
+      # @!parse
+      #   # Returns the UUID of a webhook
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [String] The UUID
+      #   # @note This is inherited from {SupportOps::Calendly::Base#uuid}
+      #   # @example
+      #   #   require 'support_ops_calendly'
+      #   #
+      #   #   SupportOps::Calendly::Configuration.configure do |config|
+      #   #     config.token = 'abc123'
+      #   #   end
+      #   #
+      #   #   webhooks = SupportOps::Calendly::Webhooks.list(
+      #   #     organization: 'BBBBBBBBBBBBBBBB',
+      #   #     scope: 'organization'
+      #   #   )
+      #   #   pp webhooks.first.uuid
+      #   #   #=> "DDDDDDDDDDDDDDDD"
+      #   def uuid; end
+      define_attributes :callback_url, :created_at, :creator, :events, :group,
+                        :organization, :retry_started_at, :scope, :signing_key,
+                        :state, :updated_at, :uri, :url, :user
+      readonly_attributes :callback_url, :created_at, :creator,
+                          :retry_started_at, :state, :updated_at, :uri
+
+      ##
+      # Get a list of Webhook Subscriptions for a specified Organization or User
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload list(key: value)
+      #   @param group [String optional] Indicates if the results should be
+      #     filtered by group URI
+      #   @param organization [String required] The given organization URI that
+      #     owns the subscriptions being returned
+      #   @param scope [String required] Filter the list by organization, user,
+      #     or group
+      #   @param sort [String optional] Order results by the specified field and
+      #     direction; accepts comma-separated list of {field}:{direction}
+      #     values; supported fields are: created_at; sort direction is
+      #     specified as: asc, desc
+      #   @param user [String optional] Indicates if the results should be
+      #     filtered by user URI
+      # @see
+      #   https://developer.calendly.com/api-docs/faac832d7c57d-list-webhook-subscriptions
+      #   Calendly API > Webhooks > List Webhook Subscriptions
+      # @example
+      #   require 'support_ops_calendly'
+      #
+      #   SupportOps::Calendly::Configuration.configure do |config|
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   webhooks = SupportOps::Calendly::Webhooks.list(
+      #     organization: 'https://api.calendly.com/organizations/BBBBBBBBBBBBBBBB',
+      #     scope: 'organization'
+      #   )
+      #   pp webhooks.first.uri
+      #   #=> "https://api.calendly.com/webhook_subscriptions/DDDDDDDDDDDDDDDD"
+      #   pp webhooks.count
+      #   #=> 3
+      def self.list(**args)
+        args[:organization] = nil unless args[:organization]
+        args[:scope] = nil unless args[:scope]
+        raise 'You must provide an organization URI' if args[:organization].nil?
+        raise 'You must provide a scope' if args[:scope].nil?
+        raise 'You must provide a valid scope (group, organization, user)' unless %w[organization user group].include? args[:scope]
+
+        args[:group] = nil unless args[:group]
+        args[:sort] = nil unless args[:sort]
+        args[:user] = nil unless args[:user]
+        raise 'You must provide a user URI when using the scope of user' if args[:scope] == 'user' && args[:user].nil?
+        raise 'You must provide a group URI when using the scope of group' if args[:scope] == 'group' && args[:group].nil?
+        array = []
+        data = { count: 100 }
+        data['group'] = args[:group] unless args[:group].nil?
+        data['organization'] = args[:organization] unless args[:organization].nil?
+        data['scope'] = args[:scope] unless args[:scope].nil?
+        data['sort'] = args[:sort] unless args[:sort].nil?
+        data['user'] = args[:user] unless args[:user].nil?
+        loop do
+          response = client.connection.get('webhook_subscriptions', data)
+          body = Oj.load(response.body)
+          array += body['collection'].map { |w| Webhooks.new(w) }
+          break if body['pagination']['next_page_token'].nil?
+
+          data['page_token'] = body['pagination']['next_page_token']
+        end
+        array
+      end
+
+      ##
+      # Get a specified Webhook Subscription
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.calendly.com/api-docs/4d800dc2cb119-get-webhook-subscription
+      #   Calendly API > Webhooks > Get Webhook Subscription
+      # @example
+      #   require 'support_ops_calendly'
+      #
+      #   SupportOps::Calendly::Configuration.configure do |config|
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   webhook = SupportOps::Calendly::Webhooks.get('DDDDDDDDDDDDDDDD')
+      #   pp webhook.uri
+      #   #=> "https://api.calendly.com/webhook_subscriptions/DDDDDDDDDDDDDDDD"
+      def self.get(object)
+        if object.is_a? Webhooks
+          Webhooks.new(uri: uri).find
+        else
+          Webhooks.new(uri: object).find
+        end
+      end
+
+      ##
+      # Get a specified Webhook Subscription
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.calendly.com/api-docs/4d800dc2cb119-get-webhook-subscription
+      #   Calendly API > Webhooks > Get Webhook Subscription
+      # @example
+      #   require 'support_ops_calendly'
+      #
+      #   SupportOps::Calendly::Configuration.configure do |config|
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   webhook = SupportOps::Calendly::Webhooks.get!('DDDDDDDDDDDDDDDD')
+      #   pp webhook.uri
+      #   #=> "https://api.calendly.com/webhook_subscriptions/DDDDDDDDDDDDDDDD"
+      def self.get!(object)
+        if object.is_a? Webhooks
+          Webhooks.new(uri: uri).find!
+        else
+          Webhooks.new(uri: object).find!
+        end
+      end
+
+      private
+
+      ##
+      # @private
+      def get_record
+        response = self.client.connection.get("webhook_subscriptions/#{self.uuid}")
+        return nil if response.status != 200
+
+        Oj.load(response.body)['resource']
+      end
+
+      ##
+      # @private
+      def create_record
+        data = {
+          events: self.events,
+          organization: self.organization,
+          scope: self.scope,
+          url: self.url
+        }
+        data[:group] = self.group unless self.group.nil?
+        data[:signing_key] = self.signing_key unless self.signing_key.nil?
+        data[:user] = self.user unless self.user.nil?
+        response = self.client.connection.post('webhook_subscriptions', data.to_json)
+        body = Oj.load(response.body)
+        raise "Unable to creation webhook => #{body}" unless response.status == 201
+
+        body
+      end
+
+      ##
+      # @private
+      def delete_record
+        response = self.client.connection.delete("webhook_subscriptions/#{self.uuid}")
+        body = Oj.load(response.body)
+        raise "Failed to remove webhook subscription #{self.uuid} => #{body}" unless response.status == 204
+
+        true
+      end
+
+      ##
+      # @private
+      def uuid_record
+        (uri =~ /^https/ ? uri.split('/').last : uri)
+      end
+    end
+  end
+end

data/lib/support_ops_calendly/calendly.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  ##
+  # Defines the module Calendly within the module {SupportOps}.
+  #
+  # @author Jason Colyer
+  # @since 1.0.0
+  module Calendly
+    # This one should always be first
+    require "#{__dir__}/calendly/base"
+    # Order does not matter here
+    require "#{__dir__}/calendly/client"
+    require "#{__dir__}/calendly/configuration"
+    require "#{__dir__}/calendly/groups"
+    require "#{__dir__}/calendly/organization_memberships"
+    require "#{__dir__}/calendly/organizations"
+    require "#{__dir__}/calendly/users"
+    require "#{__dir__}/calendly/webhooks"
+  end
+end

data/lib/support_ops_calendly.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+$VERBOSE = nil
+
+##
+# Defines the module SupportOps
+# @author Jason Colyer
+# @since 1.0.0
+module SupportOps; end
+
+require 'active_support'
+require 'active_support/time'
+require 'base64'
+require 'cgi'
+require 'digest'
+require 'erb'
+require 'faraday'
+require 'faraday/multipart'
+require 'faraday/retry'
+require 'json'
+require 'oj'
+require 'restforce'
+require 'yaml'
+
+# This one should always be first
+
+# Order does not matter here
+require "#{__dir__}/support_ops_calendly/calendly"