gitlab-customer-support-operations_calendly 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 50a88e913a2facddb2e5812af8ba37d18d776ddfeb2c2aae1ae6d167ac4c9a1e
+  data.tar.gz: 623303e804f2939c5684e034d123c269a0631aa54fb69aaa94ffeee7d4c1c2ca
+SHA512:
+  metadata.gz: 42dad4e2bb5b17c11985f9f2802123e923fa63399207ed4e3a700d9e13a76416c0acb5dca1457f9ef7f177dad2a90d93c367ef9b4fe21a6834435431ffcf9f7d
+  data.tar.gz: 9fd7e013fb412ef6e5559f996731da75c61d9ac6c0d2387081141761200d93edb7ed4b8f6e6d83d91d4040abcf371ba5e2c2e7b1f767333243f7f1c0e655fc7b

data/lib/support_ops_calendly/calendly/base.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Calendly
+  module Calendly
+    ##
+    # Defines the class Base within the module {SupportOps::Calendly}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    class Base
+      class << self
+        def client
+          Configuration.config.client
+        end
+
+        def configure
+          yield Configuration.config
+        end
+
+        def define_attributes(*attrs)
+          @attributes = attrs
+          attrs.each do |attr|
+            attr_accessor attr
+          end
+        end
+
+        def attributes
+          @attributes || []
+        end
+  
+        def readonly_attributes(*attrs)
+          return @readonly_attributes || [] if attrs.empty?
+
+          @readonly_attributes = attrs
+        end
+      end
+  
+      def initialize(attributes = {}, client = nil)
+        @client = client
+        @original_attributes = {}
+        set_attributes(attributes)
+        store_original_attributes
+      end
+
+      def store_original_attributes
+        @original_attributes = {}
+        self.class.attributes.each do |attr|
+          @original_attributes[attr] = instance_variable_get("@#{attr}")
+        end
+      end
+
+      def uuid
+        uuid_record
+      end
+
+      def members
+        ensure_client_present!
+        members_record
+      end
+
+      def find
+        ensure_client_present!
+        set_attributes(get_record)
+        store_original_attributes
+        self
+      end
+
+      def find!
+        ensure_client_present!
+        attrs = get_record
+        if attrs == nil
+          raise "Unable to locate #{self.class.name.demodulize.singularize.downcase} '#{self.uri}'"
+        end
+        set_attributes(attrs)
+        store_original_attributes
+        self
+      end
+  
+      def save!
+        ensure_client_present!
+        new_data = if id.nil?
+                     create_record
+                   else
+                     update_record
+                   end
+        new_data.each do |key, value|
+          self.instance_variable_set("@#{key}", value) if self.respond_to?("#{key}=")
+        end
+        store_original_attributes
+        self
+      end
+
+      def delete!
+        ensure_client_present!
+        delete_record
+      end
+
+      def client=(new_client)
+        @client = new_client
+      end
+  
+      protected
+  
+      attr_reader :attributes, :original_attributes
+
+      def set_attributes(attributes)
+        return unless attributes
+
+        attrs = attributes.transform_keys(&:to_sym)
+        
+        self.class.attributes.each do |attr|
+          instance_variable_set("@#{attr}", attrs[attr])
+        end
+      end
+
+      def attributes_for_save
+        if send(:url) == nil
+          self.class.attributes
+            .reject { |attr| self.class.readonly_attributes.include?(attr) }
+            .each_with_object({}) do |attr, hash|
+              hash[attr] = send(attr)
+            end
+        else
+          self.class.attributes
+            .reject { |attr| self.class.readonly_attributes.include?(attr) }
+            .each_with_object({}) do |attr, hash|
+              current_value = send(attr)
+              original_value = @original_attributes[attr]
+
+              hash[attr] = current_value if attr == :url
+              if original_value != current_value
+                hash[attr] = current_value
+              end
+            end
+        end
+      end
+
+      def client
+        @client ||= self.class.client
+      end
+  
+      def ensure_client_present!
+        raise 'No client configured. Use SupportOps::Calendly.configure to set up the client.' unless client
+      end
+
+      def uuid_record
+        raise NotImplementedError
+      end
+
+      def get_record(**args)
+        raise NotImplementedError
+      end
+
+      def create_record
+        raise NotImplementedError
+      end
+  
+      def update_record
+        raise NotImplementedError
+      end
+
+      def members_record
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/support_ops_calendly/calendly/client.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Calendly
+  module Calendly
+    ##
+    # Defines the class Client within the module {SupportOps::Calendly}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    class Client
+      class Error < StandardError; end
+      class RequestError < Error; end
+      class ResourceNotFound < Error; end
+
+      attr_reader :connection
+
+      def initialize(config = SupportOps::Calendly::Configuration.new)
+        if config[:token].nil?
+          raise 'No authentication token provided'
+        end
+        @connection = generate_connection(config)
+      end
+
+      def retry_options(config)
+        {
+          max: config[:retry_max],
+          interval: config[:retry_interval],
+          interval_randomness: config[:retry_randomness],
+          backoff_factor: config[:retry_backoff],
+          exceptions: config[:retry_exceptions]
+        }
+      end
+
+      def generate_connection(config)
+        Faraday.new('https://api.calendly.com') do |c|
+          c.request :retry, retry_options(config)
+          c.adapter Faraday.default_adapter
+          c.headers['Content-Type'] = 'application/json'
+          c.headers['Authorization'] = "Bearer #{config[:token]}"
+        end
+      end
+    end
+  end
+end

data/lib/support_ops_calendly/calendly/configuration.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Calendly
+  module Calendly
+    ##
+    # Defines the module Configuration within the module {SupportOps::Calendly}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    module Configuration
+      ##
+      # Setup a Calendly client configuration
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload configure(key: value)
+      #   @param retry_backoff [Integer] See {Config#retry_backoff}
+      #   @param retry_exceptions [Array] See {Config#retry_exceptions}
+      #   @param retry_interval [Integer] See {Config#retry_interval}
+      #   @param retry_max [Integer] See {Config#retry_max}
+      #   @param retry_randomness [Integer] See {Config#retry_randomness}
+      #   @param token [String] See {Config#token}
+      # @example
+      #   require 'support_ops_calendly'
+      #
+      #   SupportOps::Calendly::Configuration.configure do |config|
+      #     config.token = 'abc123'
+      #   end
+      def self.configure
+        yield config
+      end
+
+      def self.config
+        @config ||= Config.new
+      end
+
+      def self.reset!
+        @config = Config.new
+      end
+
+      ##
+      # Defined the class Config within the module {SupportOps::Calendly::Configuration}
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @attr [Integer] retry_backoff  multiplier applied to the retry_interval after each retry attempt, causing exponential backoff. Defaults to 2
+      # @attr [Array] retry_exceptions Specifies which types of exceptions or errors should trigger the retry mechanism.
+      # @attr [Integer] retry_interval The base time interval (typically in seconds or milliseconds) between retry attempts. Defaults to 1
+      # @attr [Integer] retry_max The maximum number of retry attempts that will be made when an operation fails. Defaults to 5
+      # @attr [Float] retry_randomness Adds a random element to the retry interval to prevent "thundering herd" problems where many systems retry simultaneously. Defaults to 0.5
+      # @attr [String] token The token to use for authentication
+      class Config
+        attr_accessor :token, :retry_max, :retry_interval, :retry_randomness,
+                      :retry_backoff, :retry_exceptions,
+
+        def initialize
+          @retry_backoff = 2
+          @retry_exceptions = Faraday::Retry::Middleware::DEFAULT_EXCEPTIONS + [Faraday::ConnectionFailed]
+          @retry_interval = 1
+          @retry_max = 5
+          @retry_randomness = 0.5
+        end
+
+        def client
+          @client ||= Client.new(
+            retry_max: retry_max,
+            retry_interval: retry_interval,
+            retry_randomness: retry_randomness,
+            retry_backoff: retry_backoff,
+            retry_exceptions: retry_exceptions,
+            token: token
+          )
+        end
+      end
+    end
+  end
+end

data/lib/support_ops_calendly/calendly/groups.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Calendly
+  module Calendly
+    ##
+    # Defines the module Groups within the module {SupportOps::Calendly}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [String] created_at The moment when the Group record was created
+    # @attr [Integer] member_count The number of members in a group
+    # @attr [String] name The Group name (in human-readable format)
+    # @attr [String] organization A unique reference to the associated Organization object
+    # @attr [String] updated_at The moment when the Group record was last updated
+    # @attr [String] uri Canonical reference (unique identifier) for the Group resource
+    class Groups < SupportOps::Calendly::Base
+      # @!parse
+      #   # Returns the UUID of a group
+      #   # 
+      #   # @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
+      #   #
+      #   #   group = SupportOps::Calendly::Groups.get!('EEEEEEEEEEEEEEEE')
+      #   #   pp group.uuid
+      #   #   #=> "BBBBBBBBBBBBBBBB"
+      #   def uuid; end
+      define_attributes :created_at, :member_count, :name, :organization,
+                        :updated_at, :uri
+      readonly_attributes :created_at, :member_count, :name, :organization,
+                          :updated_at, :uri
+
+      ##
+      # Returns a list of groups
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload list(key: value)
+      #   @param organization [String required] The given organization URI that
+      #     owns the subscriptions being returned
+      # @see
+      #   https://developer.calendly.com/api-docs/6rb6dtdln74sy-list-groups
+      #   Calendly API > Groups > List Groups
+      # @example
+      #   require 'support_ops_calendly'
+      #
+      #   SupportOps::Calendly::Configuration.configure do |config|
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   groups = SupportOps::Calendly::Groups.list(
+      #     organization: 'https://api.calendly.com/organizations/BBBBBBBBBBBBBBBB',
+      #   )
+      #   pp groups.first.uri
+      #   #=> "https://api.calendly.com/webhook_subscriptions/FFFFFFFFFFFFFFFF"
+      #   pp groups.count
+      #   #=> 2
+      def self.list(**args)
+        args[:organization] = nil unless args[:organization]
+        raise 'You must provide an organization URI' if args[:organization].nil?
+
+        array = []
+        data = {
+          count: 100,
+          organization: args[:organization]
+        }
+        loop do
+          response = client.connection.get('groups', data)
+          body = Oj.load(response.body)
+          array += body['collection'].map { |g| Groups.new(g) }
+          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 > Groups > Get Group
+      # @example
+      #   require 'support_ops_calendly'
+      #
+      #   SupportOps::Calendly::Configuration.configure do |config|
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   groups = SupportOps::Calendly::Groups.get('FFFFFFFFFFFFFFFF')
+      #   pp group.uri
+      #   #=> "https://api.calendly.com/webhook_subscriptions/FFFFFFFFFFFFFFFF"
+      def self.get(object)
+        if object.is_a? Groups
+          Groups.new(uri: uri).find
+        else
+          Groups.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 > Groups > Get Group
+      # @example
+      #   require 'support_ops_calendly'
+      #
+      #   SupportOps::Calendly::Configuration.configure do |config|
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   groups = SupportOps::Calendly::Groups.get!('FFFFFFFFFFFFFFFF')
+      #   pp group.uri
+      #   #=> "https://api.calendly.com/webhook_subscriptions/FFFFFFFFFFFFFFFF"
+      def self.get!(object)
+        if object.is_a? Groups
+          Groups.new(uri: uri).find!
+        else
+          Groups.new(uri: object).find!
+        end
+      end
+
+      private
+
+      ##
+      # @private
+      def get_record
+        response = self.client.connection.get("groups/#{self.uuid}")
+        return nil if response.status != 200
+
+        Oj.load(response.body)['resource']
+      end
+
+      ##
+      # @private
+      def uuid_record
+        (uri =~ /^https/ ? uri.split('/').last : uri)
+      end
+    end
+  end
+end

data/lib/support_ops_calendly/calendly/organization_memberships.rb

@@ -0,0 +1,216 @@
+# 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 The moment when the membership record was created (e.g. "2020-01-02T03:04:05.678123Z")
+    # @attr [String] organization A unique reference to the organization
+    # @attr [String] role The user's role in the organization
+    # @attr [String] updated_at The moment when the membership record was last updated (e.g. "2020-01-02T03:04:05.678123Z")
+    # @attr [String] uri Canonical reference (unique identifier) for the membership
+    # @attr [Object] user An instance of {SupportOps::Calendly::Users}
+    class OrganizationMemberships < SupportOps::Calendly::Base
+      # @!parse
+      #   # Removes a membership from an organization
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @see
+      #   #   https://developer.calendly.com/api-docs/269e89d9f559f-remove-user-from-organization
+      #   #   Calendly API > Organizations > Remove User from Organization
+      #   # @note This is inherited from {SupportOps::Calendly::Base#delete!}
+      #   # @example
+      #   #   require 'support_ops_calendly'
+      #   #
+      #   #   SupportOps::Calendly::Configuration.configure do |config|
+      #   #     config.token = 'abc123'
+      #   #   end
+      #   #
+      #   #   org = SupportOps::Calendly::Organizations.current
+      #   #   members = SupportOps::Calendly::OrganizationMemberships.list('BBBBBBBBBBBBBBBB')
+      #   #   pp members.last.delete!
+      #   #   #=> "CCCCCCCCCCCCCCCC"
+      #   def delete!; end
+      # @!parse
+      #   # Returns the UUID of an organization membership
+      #   # 
+      #   # @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
+      #   #   members = SupportOps::Calendly::OrganizationMemberships.list('BBBBBBBBBBBBBBBB')
+      #   #   pp members.first.uuid
+      #   #   #=> "CCCCCCCCCCCCCCCC"
+      #   def uuid; end
+      define_attributes :created_at, :organization, :role, :updated_at, :uri,
+                        :user
+      readonly_attributes :created_at, :organization, :role, :updated_at, :uri,
+                          :user
+
+      ##
+      # Returns a list of Organization Memberships for a specified Organization
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.calendly.com/api-docs/eaed2e61a6bc3-list-organization-memberships
+      #   Calendly API > Organizations > List ORganization Memberships
+      # @example
+      #   require 'support_ops_calendly'
+      #
+      #   SupportOps::Calendly::Configuration.configure do |config|
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   org = SupportOps::Calendly::Organizations.get!('BBBBBBBBBBBBBBBB')
+      #   members = SupportOps::Calendly::OrganizationMemberships(org)
+      #   pp members.count
+      #   # => 27
+      #   pp members.first.user.uuid
+      #   # => "AAAAAAAAAAAAAAAA"
+      # @example
+      #   require 'support_ops_calendly'
+      #
+      #   SupportOps::Calendly::Configuration.configure do |config|
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   members = SupportOps::Calendly::OrganizationMemberships('https://api.calendly.com/organizations/BBBBBBBBBBBBBBBB')
+      #   pp members.count
+      #   # => 27
+      #   pp members.first.user.uuid
+      #   # => "AAAAAAAAAAAAAAAA"
+      # @example
+      #   require 'support_ops_calendly'
+      #
+      #   SupportOps::Calendly::Configuration.configure do |config|
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   members = SupportOps::Calendly::OrganizationMemberships('BBBBBBBBBBBBBBBB')
+      #   pp members.count
+      #   # => 27
+      #   pp members.first.user.uuid
+      #   # => "AAAAAAAAAAAAAAAA"
+      def self.list(object)
+        id = if object.is_a? Organizations
+               object.uri
+             elsif object =~ /^https/
+               object
+             else
+               "https://api.calendly.com/organizations/#{object}"
+             end
+        data = { organization: id, count: 100 }
+        array = []
+        loop do
+          response = client.connection.get('organization_memberships', data)
+          body = Oj.load(response.body)
+          body['collection'].each_with_index do |member, index|
+            body['collection'][index]['user'] = Users.new(member['user'])
+          end
+          array += body['collection'].map { |c| OrganizationMemberships.new(c) }
+          break if body['pagination']['next_page_token'].nil?
+
+          data = { organization: id, count: 100, page_token: body['pagination']['next_page_token'] }
+        end
+        array
+      end
+
+      ##
+      # Returns information about a specified Organization Membership
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.calendly.com/api-docs/8c3baa79a5883-get-organization-membership
+      #   Calendly API > Organizations > Get Organization Membership
+      # @example
+      #   require 'support_ops_calendly'
+      #
+      #   SupportOps::Calendly::Configuration.configure do |config|
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   member = SupportOps::Calendly::OrganizationMemberships.get('CCCCCCCCCCCCCCCC')
+      #   pp member.user.uuid
+      #   # => "AAAAAAAAAAAAAAAA"
+      def self.get(object)
+        if object.is_a? OrganizationMemberships
+          OrganizationMemberships.new(uri: uri).find
+        else
+          OrganizationMemberships.new(uri: object).find
+        end
+      end
+
+      ##
+      # Returns information about a specified Organization Membership
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.calendly.com/api-docs/8c3baa79a5883-get-organization-membership
+      #   Calendly API > Organizations > Get Organization Membership
+      # @example
+      #   require 'support_ops_calendly'
+      #
+      #   SupportOps::Calendly::Configuration.configure do |config|
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   member = SupportOps::Calendly::OrganizationMemberships.get!('CCCCCCCCCCCCCCCC')
+      #   pp member.user.uuid
+      #   # => "AAAAAAAAAAAAAAAA"
+      def self.get!(object)
+        if object.is_a? OrganizationMemberships
+          OrganizationMemberships.new(uri: uri).find!
+        else
+          OrganizationMemberships.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("organization_memberships/#{uuid}")
+        return nil if response.status != 200
+
+        body = Oj.load(response.body)['resource']
+        body['user'] = Users.new(body['user'])
+        body
+      end
+
+      ##
+      # @private
+      def delete_record
+        response = self.client.connection.delete("organization_memberships/#{self.uuid}")
+        body = Oj.load(response.body)
+        raise "Failed to remove user #{self.user.email} => #{body}" unless response.status == 204
+
+        true
+      end
+    end
+  end
+end
+