google-calendar-apimatic-sdk 1.0.0

data/lib/calendar_api/configuration.rb

@@ -0,0 +1,177 @@
+# calendar_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CalendarApi
+  # An enum for SDK environments.
+  class Environment
+    # PRODUCTION: Google Calendar API v3
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Environment constant.
+    def self.from_value(value, default_value = PRODUCTION)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      DEFAULT = 'default'.freeze,
+      AUTH_SERVER = 'auth server'.freeze,
+      ACCESS_TOKEN_SERVER = 'access token server'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Server constant.
+    def self.from_value(value, default_value = DEFAULT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip.downcase
+      case str
+      when 'default' then DEFAULT
+      when 'auth_server' then AUTH_SERVER
+      when 'access_token_server' then ACCESS_TOKEN_SERVER
+
+      else
+        warn "[Server] Unknown server '#{value}', falling back to #{default_value} "
+        default_value
+      end
+    end
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    # The attribute readers for properties.
+    attr_reader :environment, :authorization_code_auth_credentials
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 30,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      authorization_code_auth_credentials: nil
+    )
+      super connection: connection, adapter: adapter, timeout: timeout,
+            max_retries: max_retries, retry_interval: retry_interval,
+            backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+            retry_methods: retry_methods, http_callback: http_callback,
+            proxy_settings: proxy_settings,
+            logging_configuration: logging_configuration
+
+      # Current API environment
+      @environment = String(environment)
+
+      # The object holding OAuth 2 Authorization Code Grant credentials
+      @authorization_code_auth_credentials = authorization_code_auth_credentials
+
+      # Initializing OAuth 2 Authorization Code Grant credentials with the provided auth parameters
+      @authorization_code_auth_credentials = authorization_code_auth_credentials
+
+      # The Http Client to use for making requests.
+      set_http_client CoreLibrary::FaradayClient.new(self)
+    end
+
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
+                   proxy_settings: nil, logging_configuration: nil,
+                   environment: nil, authorization_code_auth_credentials: nil)
+      connection ||= self.connection
+      adapter ||= self.adapter
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
+      http_callback ||= self.http_callback
+      proxy_settings ||= self.proxy_settings
+      logging_configuration ||= self.logging_configuration
+      environment ||= self.environment
+      authorization_code_auth_credentials ||= self.authorization_code_auth_credentials
+
+      Configuration.new(
+        connection: connection, adapter: adapter, timeout: timeout,
+        max_retries: max_retries, retry_interval: retry_interval,
+        backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+        retry_methods: retry_methods, http_callback: http_callback,
+        proxy_settings: proxy_settings,
+        logging_configuration: logging_configuration, environment: environment,
+        authorization_code_auth_credentials: authorization_code_auth_credentials
+      )
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://www.googleapis.com/calendar/v3',
+        Server::AUTH_SERVER => 'https://accounts.google.com/o/oauth2/v2',
+        Server::ACCESS_TOKEN_SERVER => 'https://oauth2.googleapis.com'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] server The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = Server::DEFAULT)
+      ENVIRONMENTS[environment][server].clone
+    end
+
+    # Builds a Configuration instance using environment variables.
+    def self.build_default_config_from_env
+      # === Core environment ===
+      environment = Environment.from_value(ENV.fetch('ENVIRONMENT', 'production'))
+      timeout = (ENV['TIMEOUT'] || 30).to_f
+      max_retries = (ENV['MAX_RETRIES'] || 0).to_i
+      retry_interval = (ENV['RETRY_INTERVAL'] || 1).to_f
+      backoff_factor = (ENV['BACKOFF_FACTOR'] || 2).to_f
+      retry_statuses = ENV.fetch('RETRY_STATUSES',
+                                 '[408, 413, 429, 500, 502, 503, 504, 521, 522, 524]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+      retry_methods = ENV.fetch('RETRY_METHODS', '%i[get put]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+
+      # === Authentication credentials ===
+      authorization_code_auth_credentials = AuthorizationCodeAuthCredentials.from_env
+
+      # === Proxy settings ===
+      proxy_settings = ProxySettings.from_env
+      # === Logging Configuration ===
+      logging_configuration = LoggingConfiguration.from_env if LoggingConfiguration.any_logging_configured?
+
+      Configuration.new(
+        environment: environment,
+        timeout: timeout,
+        max_retries: max_retries,
+        retry_interval: retry_interval,
+        backoff_factor: backoff_factor,
+        retry_statuses: retry_statuses,
+        retry_methods: retry_methods,
+        authorization_code_auth_credentials: authorization_code_auth_credentials,
+        proxy_settings: proxy_settings,
+        logging_configuration: logging_configuration
+      )
+    end
+  end
+end

data/lib/calendar_api/exceptions/api_exception.rb

@@ -0,0 +1,21 @@
+# calendar_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CalendarApi
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < CoreLibrary::ApiException
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code}, reason: #{@reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code.inspect}, reason: #{@reason.inspect}>"
+    end
+  end
+end

data/lib/calendar_api/exceptions/error_response_error1_exception.rb

@@ -0,0 +1,46 @@
+# calendar_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CalendarApi
+  # Standard Google API error response wrapper.
+  class ErrorResponseError1Exception < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Error details.
+    # @return [ErrorResponseError]
+    attr_accessor :error
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error = ErrorResponseError.from_hash(hash['error']) if hash['error']
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}>"
+    end
+  end
+end

data/lib/calendar_api/exceptions/oauth_provider_exception.rb

@@ -0,0 +1,64 @@
+# calendar_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CalendarApi
+  # OAuth 2 Authorization endpoint exception.
+  class OauthProviderException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Gets or sets error code.
+    # @return [OauthProviderError]
+    attr_accessor :error
+
+    # Gets or sets human-readable text providing additional information on
+    # error.
+    # Used to assist the client developer in understanding the error that
+    # occurred.
+    # @return [String]
+    attr_accessor :error_description
+
+    # Gets or sets a URI identifying a human-readable web page with information
+    # about the error, used to provide the client developer with additional
+    # information about the error.
+    # @return [String]
+    attr_accessor :error_uri
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error = hash.key?('error') ? hash['error'] : nil
+      @error_description =
+        hash.key?('error_description') ? hash['error_description'] : SKIP
+      @error_uri = hash.key?('error_uri') ? hash['error_uri'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}, error_description: #{@error_description}, error_uri:"\
+      " #{@error_uri}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}, error_description: #{@error_description.inspect},"\
+      " error_uri: #{@error_uri.inspect}>"
+    end
+  end
+end

data/lib/calendar_api/http/api_response.rb

@@ -0,0 +1,19 @@
+# calendar_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CalendarApi
+  # Http response received.
+  class ApiResponse < CoreLibrary::ApiResponse
+    # The constructor
+    # @param [HttpResponse] http_response The original, raw response from the api.
+    # @param [Object] data The data field specified for the response.
+    # @param [Array<String>] errors Any errors returned by the server.
+    def initialize(http_response,
+                   data: nil,
+                   errors: nil)
+      super
+    end
+  end
+end

data/lib/calendar_api/http/auth/oauth_2.rb

@@ -0,0 +1,162 @@
+# calendar_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CalendarApi
+  # Utility class for OAuth 2 authorization and token management.
+  class Oauth2 < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'AuthorizationCodeAuth: OAuthToken is undefined or expired.'
+    end
+
+    # Initialization constructor.
+    def initialize(authorization_code_auth_credentials, config)
+      auth_params = {}
+      @_oauth_client_id = authorization_code_auth_credentials.oauth_client_id unless
+        authorization_code_auth_credentials.nil? || authorization_code_auth_credentials.oauth_client_id.nil?
+      @_oauth_client_secret = authorization_code_auth_credentials.oauth_client_secret unless
+        authorization_code_auth_credentials.nil? || authorization_code_auth_credentials.oauth_client_secret.nil?
+      @_oauth_redirect_uri = authorization_code_auth_credentials.oauth_redirect_uri unless
+        authorization_code_auth_credentials.nil? || authorization_code_auth_credentials.oauth_redirect_uri.nil?
+      @_oauth_token = authorization_code_auth_credentials.oauth_token unless
+        authorization_code_auth_credentials.nil? || authorization_code_auth_credentials.oauth_token.nil?
+      @_oauth_scopes = authorization_code_auth_credentials.oauth_scopes unless
+        authorization_code_auth_credentials.nil? || authorization_code_auth_credentials.oauth_scopes.nil?
+      @_config = config
+      @_o_auth_api = OauthAuthorizationApi.new(config)
+      auth_params[:Authorization] = "Bearer #{@_oauth_token.access_token}" unless @_oauth_token.nil?
+
+      super auth_params
+    end
+
+    # Validates the oAuth token.
+    # @return [Boolean] true if the token is present and not expired.
+    def valid
+      !@_oauth_token.nil? && !token_expired?(@_oauth_token)
+    end
+
+    # Builds and returns an authorization URL.
+    # The user is expected to obtain an authorization code from this URL and then call the
+    # fetch token function with that authorization code.
+    # @param [String] state An opaque state string.
+    # @param [Hash] additional_params Any additional query parameters to be added to the URL.
+    # @return [String] The authorization URL.
+    def get_authorization_url(state: nil, additional_params: nil)
+      auth_url = @_config.get_base_uri_executor.call(Server::AUTH_SERVER)
+      auth_url += '/auth'
+      query_params = {
+        'response_type' => 'code',
+        'client_id' => @_oauth_client_id,
+        'redirect_uri' => @_oauth_redirect_uri
+      }
+      query_params['scope'] = Array(@_o_auth_scopes).compact.join(' ') if @_o_auth_scopes
+      query_params['state'] = state if state
+      query_params.merge!(additional_params) if additional_params
+      auth_url = APIHelper.append_url_with_query_parameters(auth_url,
+                                                            query_params)
+      APIHelper.clean_url(auth_url)
+    end
+
+    # Builds the basic auth header for endpoints in the OAuth Authorization Controller.
+    # @return [String] The value of the Authentication header.
+    def build_basic_auth_header
+      "Basic #{AuthHelper.get_base64_encoded_value(@_oauth_client_id, @_oauth_client_secret)}"
+    end
+
+    # Fetches the token.
+    # @param [String] auth_code The authentication code.
+    # @param [Hash] additional_params Any additional form parameters.
+    # @return [OAuthToken] The oAuth token instance.
+    def fetch_token(auth_code, additional_params: nil)
+      token = @_o_auth_api.request_token(
+        build_basic_auth_header,
+        auth_code,
+        @_oauth_redirect_uri,
+        _field_parameters: additional_params
+      ).data
+      if token.respond_to?('expires_in') && !token.expires_in.nil?
+        token.expiry = AuthHelper.get_token_expiry(token.expires_in, Time.now.utc.to_i)
+      end
+      token
+    end
+
+    # Checks if OAuth token has expired.
+    # @param [OAuthToken] token The oAuth token instance.
+    # @return [Boolean] true if the token is present and not expired.
+    def token_expired?(token)
+      token.respond_to?('expiry') && AuthHelper.token_expired?(token.expiry)
+    end
+
+    # Refreshes OAuth token.
+    # @param [Hash] additional_params Any additional form parameters.
+    # @return [OAuthToken] The oAuth token instance.
+    def refresh_token(additional_params: nil)
+      token = @_o_auth_api.refresh_token(
+        build_basic_auth_header,
+        @_oauth_token.refresh_token,
+        scope: !@_oauth_scopes.nil? ? Array(@_oauth_scopes).compact.join(' ') : nil,
+        _field_parameters: additional_params
+      ).data
+      if token.respond_to?('expires_in') && !token.expires_in.nil?
+        token.expiry = AuthHelper.get_token_expiry(token.expires_in, Time.now.utc.to_i)
+      end
+      token
+    end
+  end
+
+  # Data class for AuthorizationCodeAuthCredentials.
+  class AuthorizationCodeAuthCredentials
+    attr_reader :oauth_client_id, :oauth_client_secret, :oauth_redirect_uri,
+                :oauth_token, :oauth_scopes
+
+    def initialize(oauth_client_id:, oauth_client_secret:, oauth_redirect_uri:,
+                   oauth_token: nil, oauth_scopes: nil)
+      raise ArgumentError, 'oauth_client_id cannot be nil' if oauth_client_id.nil?
+      raise ArgumentError, 'oauth_client_secret cannot be nil' if oauth_client_secret.nil?
+      raise ArgumentError, 'oauth_redirect_uri cannot be nil' if oauth_redirect_uri.nil?
+
+      @oauth_client_id = oauth_client_id
+      @oauth_client_secret = oauth_client_secret
+      @oauth_redirect_uri = oauth_redirect_uri
+      @oauth_token = oauth_token
+      @oauth_scopes = oauth_scopes
+    end
+
+    def self.from_env
+      oauth_client_id = ENV['OAUTH_CLIENT_ID']
+      oauth_client_secret = ENV['OAUTH_CLIENT_SECRET']
+      oauth_redirect_uri = ENV['OAUTH_REDIRECT_URI']
+      oauth_scopes = ENV['OAUTH_SCOPES']
+      all_nil = [
+        oauth_client_id,
+        oauth_client_secret,
+        oauth_redirect_uri
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(oauth_client_id: oauth_client_id,
+          oauth_client_secret: oauth_client_secret,
+          oauth_redirect_uri: oauth_redirect_uri, oauth_scopes: oauth_scopes)
+    end
+
+    def clone_with(oauth_client_id: nil, oauth_client_secret: nil,
+                   oauth_redirect_uri: nil, oauth_token: nil, oauth_scopes: nil)
+      oauth_client_id ||= self.oauth_client_id
+      oauth_client_secret ||= self.oauth_client_secret
+      oauth_redirect_uri ||= self.oauth_redirect_uri
+      oauth_token ||= self.oauth_token
+      oauth_scopes ||= self.oauth_scopes
+
+      AuthorizationCodeAuthCredentials.new(
+        oauth_client_id: oauth_client_id,
+        oauth_client_secret: oauth_client_secret,
+        oauth_redirect_uri: oauth_redirect_uri, oauth_token: oauth_token,
+        oauth_scopes: oauth_scopes
+      )
+    end
+  end
+end

data/lib/calendar_api/http/http_call_back.rb

@@ -0,0 +1,10 @@
+# calendar_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CalendarApi
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack < CoreLibrary::HttpCallback
+  end
+end

data/lib/calendar_api/http/http_method_enum.rb

@@ -0,0 +1,10 @@
+# calendar_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CalendarApi
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum < CoreLibrary::HttpMethod
+  end
+end

data/lib/calendar_api/http/http_request.rb

@@ -0,0 +1,10 @@
+# calendar_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CalendarApi
+  # Represents a single Http Request.
+  class HttpRequest < CoreLibrary::HttpRequest
+  end
+end

data/lib/calendar_api/http/http_response.rb

@@ -0,0 +1,10 @@
+# calendar_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CalendarApi
+  # Http response received.
+  class HttpResponse < CoreLibrary::HttpResponse
+  end
+end

data/lib/calendar_api/http/proxy_settings.rb

@@ -0,0 +1,22 @@
+# calendar_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CalendarApi
+  ##
+  # ProxySettings encapsulates HTTP proxy configuration for Faraday,
+  # including optional basic authentication.
+  #
+  class ProxySettings < CoreLibrary::ProxySettings
+    def self.from_env
+      address = ENV['PROXY_ADDRESS']
+      port = ENV['PROXY_PORT']
+      username = ENV['PROXY_USERNAME']
+      password = ENV['PROXY_PASSWORD']
+      return nil if address.nil? || address.strip.empty?
+
+      new(address: address, port: port, username: username, password: password)
+    end
+  end
+end