Contents

# frozen_string_literal: true

module TogglAPI
  DEFAULT_WORKSPACE_ID = ENV["TOGGL_WORKSPACE_ID"]
  Error = Class.new(StandardError)

  # Superclass for API clients.
  class BaseClient
    DEFAULT_USER_AGENT = "TogglAPI"
    attr_reader :api_token, :logger

    # Returns a new instance of the client, configured with
    # the specified parameters.
    #
    # @param api_token [String] Toggl API token, for authentication
    # @param user_agent [String] defaults to "TogglCache"
    # @param logger [Logger] used to log messages (in particular fetch
    #   events). Defaults to nil.
    #
    def initialize(api_token: default_api_token, user_agent: default_user_agent, logger: nil)
      raise "Missing api_token" if api_token.nil? || api_token.empty?
      @api_token = api_token
      @user_agent = user_agent
      @logger = logger
    end

    def default_api_token
      ENV["TOGGL_API_TOKEN"]
    end

    def default_user_agent
      DEFAULT_USER_AGENT
    end

    def credentials
      {
        username: @api_token,
        password: "api_token"
      }
    end

    def default_headers
      {
        "Content-Type" => "application/json"
      }
    end

    def default_workspace_id
      DEFAULT_WORKSPACE_ID
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
toggl_cache-0.2.1	lib/toggl_api/base_client.rb
toggl_cache-0.2.0	lib/toggl_api/base_client.rb
toggl_cache-0.1.1	lib/toggl_api/base_client.rb
toggl_cache-0.1.0	lib/toggl_api/base_client.rb