RubyGems - attio - Versions diffs - 0.1.1 - Mend

attio 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (89) hide show

checksums.yaml +7 -0
data/.codecov.yml +52 -0
data/.github/CODEOWNERS +28 -0
data/.github/ISSUE_TEMPLATE/bug_report.md +40 -0
data/.github/ISSUE_TEMPLATE/feature_request.md +28 -0
data/.github/dependabot.yml +54 -0
data/.github/pull_request_template.md +40 -0
data/.github/workflows/ci.yml +112 -0
data/.github/workflows/dependabot-auto-merge.yml +45 -0
data/.github/workflows/pr_checks.yml +145 -0
data/.github/workflows/release.yml +147 -0
data/.gitignore +10 -0
data/.rspec +4 -0
data/.rubocop.yml +133 -0
data/.yardopts +18 -0
data/CHANGELOG.md +34 -0
data/CODE_OF_CONDUCT.md +37 -0
data/CONTRIBUTING.md +280 -0
data/Gemfile +17 -0
data/Gemfile.lock +127 -0
data/LICENSE.txt +21 -0
data/README.md +292 -0
data/Rakefile +57 -0
data/SECURITY.md +59 -0
data/attio.gemspec +34 -0
data/bin/console +14 -0
data/bin/setup +8 -0
data/danger/Dangerfile +121 -0
data/docs/.nojekyll +0 -0
data/docs/Attio/AuthenticationError.html +152 -0
data/docs/Attio/Client.html +1373 -0
data/docs/Attio/ConnectionPool/TimeoutError.html +148 -0
data/docs/Attio/ConnectionPool.html +944 -0
data/docs/Attio/Error.html +152 -0
data/docs/Attio/HttpClient/ConnectionError.html +152 -0
data/docs/Attio/HttpClient/TimeoutError.html +152 -0
data/docs/Attio/HttpClient.html +1329 -0
data/docs/Attio/Logger.html +747 -0
data/docs/Attio/NotFoundError.html +152 -0
data/docs/Attio/RateLimitError.html +152 -0
data/docs/Attio/RequestLogger.html +780 -0
data/docs/Attio/Resources/Attributes.html +508 -0
data/docs/Attio/Resources/Base.html +624 -0
data/docs/Attio/Resources/Lists.html +1002 -0
data/docs/Attio/Resources/Objects.html +415 -0
data/docs/Attio/Resources/Records.html +1465 -0
data/docs/Attio/Resources/Users.html +415 -0
data/docs/Attio/Resources/Workspaces.html +324 -0
data/docs/Attio/Resources.html +141 -0
data/docs/Attio/RetryHandler.html +1023 -0
data/docs/Attio/ServerError.html +152 -0
data/docs/Attio/ValidationError.html +152 -0
data/docs/Attio.html +397 -0
data/docs/SETUP.md +117 -0
data/docs/_index.html +378 -0
data/docs/class_list.html +54 -0
data/docs/css/common.css +1 -0
data/docs/css/full_list.css +58 -0
data/docs/css/style.css +503 -0
data/docs/example.rb +119 -0
data/docs/file.CHANGELOG.html +124 -0
data/docs/file.README.html +371 -0
data/docs/file_list.html +64 -0
data/docs/frames.html +22 -0
data/docs/index.html +371 -0
data/docs/js/app.js +344 -0
data/docs/js/full_list.js +242 -0
data/docs/js/jquery.js +4 -0
data/docs/method_list.html +750 -0
data/docs/top-level-namespace.html +110 -0
data/lib/attio/client.rb +118 -0
data/lib/attio/connection_pool.rb +69 -0
data/lib/attio/errors.rb +9 -0
data/lib/attio/http_client.rb +100 -0
data/lib/attio/logger.rb +110 -0
data/lib/attio/resources/attributes.rb +26 -0
data/lib/attio/resources/base.rb +55 -0
data/lib/attio/resources/lists.rb +56 -0
data/lib/attio/resources/objects.rb +20 -0
data/lib/attio/resources/records.rb +158 -0
data/lib/attio/resources/users.rb +20 -0
data/lib/attio/resources/workspaces.rb +13 -0
data/lib/attio/retry_handler.rb +70 -0
data/lib/attio/version.rb +3 -0
data/lib/attio.rb +60 -0
data/run_tests.rb +52 -0
data/test_basic.rb +51 -0
data/test_typhoeus.rb +31 -0
metadata +160 -0

data/docs/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,110 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Top Level Namespace
+    &mdash; Attio Ruby Client Documentation
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
+<script type="text/javascript">
+  pathId = "";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Top Level Namespace
+</h1>
+<div class="box_info">
+</div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Attio.html" title="Attio (module)">Attio</a></span>
+</p>
+</div>
+      <div id="footer">
+  Generated on Mon Aug 11 11:26:43 2025 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.37 (ruby-3.4.5).
+</div>
+    </div>
+  </body>
+</html>

data/lib/attio/client.rb ADDED Viewed

@@ -0,0 +1,118 @@
+module Attio
+  # The main client class for interacting with the Attio API.
+  #
+  # This class provides access to all Attio API resources and handles
+  # authentication, connection management, and request routing.
+  #
+  # @example Basic client creation
+  #   client = Attio::Client.new(api_key: 'your-api-key')
+  #
+  # @example Custom timeout
+  #   client = Attio::Client.new(api_key: 'your-api-key', timeout: 60)
+  #
+  # @author Ernest Sim
+  # @since 1.0.0
+  class Client
+    # The base URL for the Attio API v2
+    API_BASE_URL = "https://api.attio.com/v2".freeze
+    # Default request timeout in seconds
+    DEFAULT_TIMEOUT = 30
+    # @return [String] The API key used for authentication
+    attr_reader :api_key
+    # @return [Integer] The request timeout in seconds
+    attr_reader :timeout
+    # Initialize a new Attio API client.
+    #
+    # @param api_key [String] Your Attio API key (required)
+    # @param timeout [Integer] Request timeout in seconds (default: 30)
+    # @raise [ArgumentError] if api_key is nil or empty
+    #
+    # @example
+    #   client = Attio::Client.new(api_key: 'sk-...your-key...')
+    def initialize(api_key:, timeout: DEFAULT_TIMEOUT)
+      raise ArgumentError, "API key is required" if api_key.nil? || api_key.empty?
+      @api_key = api_key
+      @timeout = timeout
+    end
+    # Returns the HTTP connection instance for making API requests.
+    #
+    # This method creates and configures the HTTP client with proper
+    # authentication headers and settings. The connection is cached
+    # for subsequent requests.
+    #
+    # @return [HttpClient] The configured HTTP client instance
+    # @api private
+    def connection
+      @connection ||= HttpClient.new(
+        base_url: API_BASE_URL,
+        headers: {
+          "Authorization" => "Bearer #{api_key}",
+          "Accept" => "application/json",
+          "Content-Type" => "application/json",
+          "User-Agent" => "Attio Ruby Client/#{VERSION}"
+        },
+        timeout: timeout
+      )
+    end
+    # Access to the Records API resource.
+    #
+    # @return [Resources::Records] Records resource instance
+    # @example
+    #   records = client.records.list(object: 'people')
+    def records
+      @records ||= Resources::Records.new(self)
+    end
+    # Access to the Objects API resource.
+    #
+    # @return [Resources::Objects] Objects resource instance
+    # @example
+    #   objects = client.objects.list
+    def objects
+      @objects ||= Resources::Objects.new(self)
+    end
+    # Access to the Lists API resource.
+    #
+    # @return [Resources::Lists] Lists resource instance
+    # @example
+    #   lists = client.lists.list
+    def lists
+      @lists ||= Resources::Lists.new(self)
+    end
+    # Access to the Workspaces API resource.
+    #
+    # @return [Resources::Workspaces] Workspaces resource instance
+    # @example
+    #   workspaces = client.workspaces.list
+    def workspaces
+      @workspaces ||= Resources::Workspaces.new(self)
+    end
+    # Access to the Attributes API resource.
+    #
+    # @return [Resources::Attributes] Attributes resource instance
+    # @example
+    #   attributes = client.attributes.list
+    def attributes
+      @attributes ||= Resources::Attributes.new(self)
+    end
+    # Access to the Users API resource.
+    #
+    # @return [Resources::Users] Users resource instance
+    # @example
+    #   users = client.users.list
+    def users
+      @users ||= Resources::Users.new(self)
+    end
+  end
+end

data/lib/attio/connection_pool.rb ADDED Viewed

@@ -0,0 +1,69 @@
+require 'thread'
+module Attio
+  class ConnectionPool
+    DEFAULT_POOL_SIZE = 5
+    DEFAULT_TIMEOUT = 5 # seconds to wait for connection
+    attr_reader :size, :timeout
+    def initialize(size: DEFAULT_POOL_SIZE, timeout: DEFAULT_TIMEOUT, &block)
+      @size = size
+      @timeout = timeout
+      @available = Queue.new
+      @key = :"#{object_id}_connection"
+      @block = block
+      @mutex = Mutex.new
+      size.times { @available << create_connection }
+    end
+    def with_connection
+      connection = checkout
+      begin
+        yield connection
+      ensure
+        checkin(connection)
+      end
+    end
+    def checkout
+      deadline = Time.now + timeout
+      loop do
+        return @available.pop(true) if @available.size > 0
+        if Time.now >= deadline
+          raise TimeoutError, "Couldn't acquire connection within #{timeout} seconds"
+        end
+        sleep(0.01)
+      end
+    rescue ThreadError
+      raise TimeoutError, "No connections available"
+    end
+    def checkin(connection)
+      @mutex.synchronize do
+        @available << connection if connection
+      end
+    end
+    def shutdown
+      @mutex.synchronize do
+        @available.close
+        while connection = @available.pop(true) rescue nil
+          connection.close if connection.respond_to?(:close)
+        end
+      end
+    end
+    private
+    def create_connection
+      @block.call
+    end
+    class TimeoutError < StandardError; end
+  end
+end

data/lib/attio/errors.rb ADDED Viewed

@@ -0,0 +1,9 @@
+module Attio
+  class Error < StandardError; end
+  class AuthenticationError < Error; end
+  class NotFoundError < Error; end
+  class ValidationError < Error; end
+  class RateLimitError < Error; end
+  class ServerError < Error; end
+end

data/lib/attio/http_client.rb ADDED Viewed

@@ -0,0 +1,100 @@
+require 'typhoeus'
+require 'json'
+module Attio
+  class HttpClient
+    DEFAULT_TIMEOUT = 30
+    attr_reader :base_url, :headers, :timeout
+    def initialize(base_url:, headers: {}, timeout: DEFAULT_TIMEOUT)
+      @base_url = base_url
+      @headers = headers
+      @timeout = timeout
+    end
+    def get(path, params = {})
+      execute_request(:get, path, params: params)
+    end
+    def post(path, body = {})
+      execute_request(:post, path, body: body.to_json)
+    end
+    def patch(path, body = {})
+      execute_request(:patch, path, body: body.to_json)
+    end
+    def put(path, body = {})
+      execute_request(:put, path, body: body.to_json)
+    end
+    def delete(path)
+      execute_request(:delete, path)
+    end
+    private
+    def execute_request(method, path, options = {})
+      url = "#{base_url}/#{path}"
+      request_options = {
+        method: method,
+        headers: headers.merge('Content-Type' => 'application/json'),
+        timeout: timeout,
+        connecttimeout: timeout
+      }.merge(options)
+      request = Typhoeus::Request.new(url, request_options)
+      response = request.run
+      handle_response(response)
+    end
+    def handle_response(response)
+      case response.code
+      when 0
+        # Timeout or connection error
+        if response.timed_out?
+          raise TimeoutError, "Request timed out"
+        else
+          raise ConnectionError, "Connection failed: #{response.return_message}"
+        end
+      when 200..299
+        parse_json(response.body)
+      when 401
+        raise AuthenticationError, parse_error_message(response)
+      when 404
+        raise NotFoundError, parse_error_message(response)
+      when 422
+        raise ValidationError, parse_error_message(response)
+      when 429
+        raise RateLimitError, parse_error_message(response)
+      when 500..599
+        raise ServerError, parse_error_message(response)
+      else
+        raise Error, "Request failed with status #{response.code}: #{parse_error_message(response)}"
+      end
+    end
+    def parse_json(body)
+      return {} if body.nil? || body.empty?
+      JSON.parse(body)
+    rescue JSON::ParserError => e
+      raise Error, "Invalid JSON response: #{e.message}"
+    end
+    def parse_error_message(response)
+      body = parse_json(response.body) rescue response.body
+      if body.is_a?(Hash)
+        body["error"] || body["message"] || body.to_s
+      else
+        body.to_s
+      end
+    end
+    class TimeoutError < Error; end
+    class ConnectionError < Error; end
+  end
+end

data/lib/attio/logger.rb ADDED Viewed

@@ -0,0 +1,110 @@
+require 'logger'
+require 'json'
+module Attio
+  class Logger < ::Logger
+    def initialize(logdev, level: ::Logger::INFO, formatter: nil)
+      super(logdev)
+      self.level = level
+      self.formatter = formatter || default_formatter
+    end
+    def debug(message, **context)
+      super(format_message(message, context))
+    end
+    def info(message, **context)
+      super(format_message(message, context))
+    end
+    def warn(message, **context)
+      super(format_message(message, context))
+    end
+    def error(message, **context)
+      super(format_message(message, context))
+    end
+    private
+    def format_message(message, context)
+      return message if context.empty?
+      {
+        message: message,
+        **context
+      }
+    end
+    def default_formatter
+      proc do |severity, datetime, progname, msg|
+        data = {
+          timestamp: datetime.iso8601,
+          level: severity,
+          progname: progname
+        }
+        if msg.is_a?(Hash)
+          data.merge!(msg)
+        else
+          data[:message] = msg
+        end
+        "#{JSON.generate(data)}\n"
+      end
+    end
+  end
+  class RequestLogger
+    attr_reader :logger, :log_level
+    def initialize(logger:, log_level: :debug)
+      @logger = logger
+      @log_level = log_level
+    end
+    def log_request(method, url, headers, body)
+      return unless logger
+      logger.send(log_level, "API Request",
+        method: method.to_s.upcase,
+        url: url,
+        headers: sanitize_headers(headers),
+        body: sanitize_body(body)
+      )
+    end
+    def log_response(response, duration)
+      return unless logger
+      logger.send(log_level, "API Response",
+        status: response.code,
+        duration_ms: (duration * 1000).round(2),
+        headers: response.headers,
+        body_size: response.body&.bytesize
+      )
+    end
+    private
+    def sanitize_headers(headers)
+      headers.transform_values do |value|
+        if value.include?('Bearer')
+          value.gsub(/Bearer\s+[\w\-]+/, 'Bearer [REDACTED]')
+        else
+          value
+        end
+      end
+    end
+    def sanitize_body(body)
+      return nil unless body
+      if body.is_a?(String) && body.length > 1000
+        "#{body[0..1000]}... (truncated)"
+      else
+        body
+      end
+    end
+  end
+end

data/lib/attio/resources/attributes.rb ADDED Viewed

@@ -0,0 +1,26 @@
+module Attio
+  module Resources
+    class Attributes < Base
+      def list(object:, **params)
+        validate_object!(object)
+        request(:get, "objects/#{object}/attributes", params)
+      end
+      def get(object:, id_or_slug:)
+        validate_object!(object)
+        validate_id_or_slug!(id_or_slug)
+        request(:get, "objects/#{object}/attributes/#{id_or_slug}")
+      end
+      private
+      def validate_object!(object)
+        raise ArgumentError, "Object type is required" if object.nil? || object.to_s.strip.empty?
+      end
+      def validate_id_or_slug!(id_or_slug)
+        raise ArgumentError, "Attribute ID or slug is required" if id_or_slug.nil? || id_or_slug.to_s.strip.empty?
+      end
+    end
+  end
+end

data/lib/attio/resources/base.rb ADDED Viewed

@@ -0,0 +1,55 @@
+module Attio
+  module Resources
+    # Base class for all API resource classes.
+    #
+    # This class provides common functionality and request handling
+    # for all Attio API resource implementations.
+    #
+    # @api private
+    # @author Ernest Sim
+    # @since 1.0.0
+    class Base
+      # @return [Client] The API client instance
+      attr_reader :client
+      # Initialize a new resource instance.
+      #
+      # @param client [Client] The API client instance
+      # @raise [ArgumentError] if client is nil
+      def initialize(client)
+        raise ArgumentError, "Client is required" unless client
+        @client = client
+      end
+      private
+      # Make an HTTP request to the API.
+      #
+      # @param method [Symbol] The HTTP method (:get, :post, :patch, :put, :delete)
+      # @param path [String] The API endpoint path
+      # @param params [Hash] Request parameters (default: {})
+      #
+      # @return [Hash] The API response
+      # @raise [ArgumentError] if method is unsupported
+      #
+      # @api private
+      def request(method, path, params = {})
+        case method
+        when :get
+          client.connection.get(path, params)
+        when :post
+          client.connection.post(path, params)
+        when :patch
+          client.connection.patch(path, params)
+        when :put
+          client.connection.put(path, params)
+        when :delete
+          client.connection.delete(path)
+        else
+          raise ArgumentError, "Unsupported HTTP method: #{method}"
+        end
+      end
+    end
+  end
+end

data/lib/attio/resources/lists.rb ADDED Viewed

@@ -0,0 +1,56 @@
+module Attio
+  module Resources
+    class Lists < Base
+      def list(**params)
+        request(:get, "lists", params)
+      end
+      def get(id:)
+        validate_id!(id)
+        request(:get, "lists/#{id}")
+      end
+      def entries(id:, **params)
+        validate_id!(id)
+        request(:get, "lists/#{id}/entries", params)
+      end
+      def create_entry(id:, data:)
+        validate_id!(id)
+        validate_data!(data)
+        request(:post, "lists/#{id}/entries", data)
+      end
+      def get_entry(list_id:, entry_id:)
+        validate_list_id!(list_id)
+        validate_entry_id!(entry_id)
+        request(:get, "lists/#{list_id}/entries/#{entry_id}")
+      end
+      def delete_entry(list_id:, entry_id:)
+        validate_list_id!(list_id)
+        validate_entry_id!(entry_id)
+        request(:delete, "lists/#{list_id}/entries/#{entry_id}")
+      end
+      private
+      def validate_id!(id)
+        raise ArgumentError, "List ID is required" if id.nil? || id.to_s.strip.empty?
+      end
+      def validate_list_id!(list_id)
+        raise ArgumentError, "List ID is required" if list_id.nil? || list_id.to_s.strip.empty?
+      end
+      def validate_entry_id!(entry_id)
+        raise ArgumentError, "Entry ID is required" if entry_id.nil? || entry_id.to_s.strip.empty?
+      end
+      def validate_data!(data)
+        raise ArgumentError, "Data is required" if data.nil?
+        raise ArgumentError, "Data must be a hash" unless data.is_a?(Hash)
+      end
+    end
+  end
+end

data/lib/attio/resources/objects.rb ADDED Viewed

@@ -0,0 +1,20 @@
+module Attio
+  module Resources
+    class Objects < Base
+      def list(**params)
+        request(:get, "objects", params)
+      end
+      def get(id_or_slug:)
+        validate_id_or_slug!(id_or_slug)
+        request(:get, "objects/#{id_or_slug}")
+      end
+      private
+      def validate_id_or_slug!(id_or_slug)
+        raise ArgumentError, "Object ID or slug is required" if id_or_slug.nil? || id_or_slug.to_s.strip.empty?
+      end
+    end
+  end
+end