attio 0.1.1 → 0.1.3

data/attio.gemspec

@@ -1,4 +1,6 @@
-require_relative 'lib/attio/version'
+# frozen_string_literal: true
+
+require_relative "lib/attio/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "attio"
@@ -6,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Ernest Sim"]
   spec.email         = ["ernest.codes@gmail.com"]
 
-  spec.summary       = %q{Ruby client for the Attio API}
-  spec.description   = %q{A Ruby library for interacting with the Attio API, providing easy access to CRM functionality}
+  spec.summary       = "Ruby client for the Attio API"
+  spec.description   = "A Ruby library for interacting with the Attio API, providing easy access to CRM functionality"
   spec.homepage      = "https://github.com/idl3/attio"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
@@ -20,7 +22,7 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"
@@ -28,7 +30,4 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "typhoeus", "~> 1.4"
-
-  # Development dependencies
-  spec.add_development_dependency "yard", "~> 0.9"
 end

data/danger/Dangerfile

@@ -7,13 +7,11 @@ warn("PR is classed as Work in Progress") if github.pr_title.include? "WIP"
 warn("Big PR") if git.lines_of_code > 500
 
 # Don't let testing shortcuts get into main by accident
-fail("fdescribe left in tests") if `grep -r fdescribe spec/ `.length > 1
-fail("fit left in tests") if `grep -r fit spec/ `.length > 1
+raise("fdescribe left in tests") if `grep -r fdescribe spec/ `.length > 1
+raise("fit left in tests") if `grep -r fit spec/ `.length > 1
 
 # Ensure a clean commit history
-if git.commits.any? { |c| c.message =~ /^fixup!/ }
-  fail("Please squash fixup! commits before merging")
-end
+raise("Please squash fixup! commits before merging") if git.commits.any? { |c| c.message =~ /^fixup!/ }
 
 # Check for proper conventional commit format
 if github.pr_title !~ /^(feat|fix|docs|style|refactor|perf|test|chore|ci|build)(\(.+\))?: .+/
@@ -27,27 +25,21 @@ end
 
 # Check if package files have been updated
 package_updated = git.modified_files.include?("attio.gemspec") || git.modified_files.include?("Gemfile")
-if package_updated
-  message("📦 Package files have been updated")
-end
+message("📦 Package files have been updated") if package_updated
 
 # Encourage changelog updates for non-trivial changes
 has_app_changes = git.modified_files.any? { |file| file.start_with?("lib/") }
 has_changelog_changes = git.modified_files.include?("CHANGELOG.md")
 
-if has_app_changes && !has_changelog_changes
+if has_app_changes && !has_changelog_changes && github.pr_title !~ /^(chore|ci|docs|style|test):/
   # Skip for certain PR types
-  unless github.pr_title =~ /^(chore|ci|docs|style|test):/
-    warn("Consider updating CHANGELOG.md for this change")
-  end
+  warn("Consider updating CHANGELOG.md for this change")
 end
 
 # Check for TODO comments in the diff
 git.diff.each do |file|
   file.patch.lines.each_with_index do |line, index|
-    if line.start_with?("+") && line.include?("TODO")
-      warn("TODO comment added", file: file.path, line: index + 1)
-    end
+    warn("TODO comment added", file: file.path, line: index + 1) if line.start_with?("+") && line.include?("TODO")
   end
 end
 
@@ -55,9 +47,7 @@ end
 has_new_features = git.diff.any? { |file| file.patch.include?("+def ") && file.path.start_with?("lib/") }
 has_test_changes = git.modified_files.any? { |file| file.start_with?("spec/") }
 
-if has_new_features && !has_test_changes
-  warn("New features should include tests")
-end
+warn("New features should include tests") if has_new_features && !has_test_changes
 
 # Check for debugging code
 debugging_patterns = [
@@ -66,27 +56,25 @@ debugging_patterns = [
   "puts",
   "p ",
   "pp ",
-  "console.log"
+  "console.log",
 ]
 
 git.diff.each do |file|
   debugging_patterns.each do |pattern|
     if file.patch.include?("+") && file.patch.include?(pattern)
-      fail("Debugging code found: #{pattern} in #{file.path}")
+      raise("Debugging code found: #{pattern} in #{file.path}")
     end
   end
 end
 
 # Encourage documentation for public API changes
-public_api_changes = git.diff.any? do |file| 
-  file.path.start_with?("lib/") && 
-  file.patch.include?("+  def ") && 
-  !file.patch.include?("+  def self.")  # Skip private class methods
+public_api_changes = git.diff.any? do |file|
+  file.path.start_with?("lib/") &&
+    file.patch.include?("+  def ") &&
+    !file.patch.include?("+  def self.") # Skip private class methods
 end
 
-if public_api_changes
-  message("📝 Public API changes detected. Consider updating documentation.")
-end
+message("📝 Public API changes detected. Consider updating documentation.") if public_api_changes
 
 # Check for secrets or sensitive information
 sensitive_patterns = [
@@ -94,16 +82,16 @@ sensitive_patterns = [
   /secret/i,
   /password/i,
   /token/i,
-  /auth/i
+  /auth/i,
 ]
 
 git.diff.each do |file|
   file.patch.lines.each_with_index do |line, index|
-    if line.start_with?("+")
-      sensitive_patterns.each do |pattern|
-        if line.match?(pattern) && !line.include?("# ") # Not a comment
-          warn("Potential sensitive information detected", file: file.path, line: index + 1)
-        end
+    next unless line.start_with?("+")
+
+    sensitive_patterns.each do |pattern|
+      if line.match?(pattern) && !line.include?("# ") # Not a comment
+        warn("Potential sensitive information detected", file: file.path, line: index + 1)
       end
     end
   end
@@ -118,4 +106,4 @@ end
 # Remind about version bumping for releases
 if git.modified_files.include?("lib/attio/version.rb")
   message("🔖 Version file updated. Don't forget to update CHANGELOG.md and create a release tag.")
-end
+end

data/docs/example.rb

@@ -1,24 +1,25 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # Example usage of the Attio Ruby client
-# 
+#
 # This file demonstrates common use cases and serves as
 # additional documentation for YARD.
 
-require_relative '../lib/attio'
+require_relative "../lib/attio"
 
 # Initialize client with API key
 # In production, use environment variables or secure config
-client = Attio.client(api_key: ENV['ATTIO_API_KEY'] || 'your-api-key-here')
+client = Attio.client(api_key: ENV["ATTIO_API_KEY"] || "your-api-key-here")
 
 # Example 1: Working with People Records
 puts "=== Working with People Records ==="
 
 # List people with filters
 people = client.records.list(
-  object: 'people',
+  object: "people",
   filters: {
-    name: { contains: 'John' }
+    name: { contains: "John" },
   },
   limit: 10
 )
@@ -26,30 +27,30 @@ puts "Found #{people['data'].length} people matching filter"
 
 # Create a new person
 new_person = client.records.create(
-  object: 'people',
+  object: "people",
   data: {
-    name: 'Jane Doe',
-    email: 'jane.doe@example.com',
-    phone: '+1-555-0123',
-    notes: 'Created via Ruby client example'
+    name: "Jane Doe",
+    email: "jane.doe@example.com",
+    phone: "+1-555-0123",
+    notes: "Created via Ruby client example",
   }
 )
 puts "Created person: #{new_person['data']['name']} (ID: #{new_person['data']['id']})"
 
 # Get the person we just created
 person = client.records.get(
-  object: 'people',
-  id: new_person['data']['id']
+  object: "people",
+  id: new_person["data"]["id"]
 )
 puts "Retrieved person: #{person['data']['name']}"
 
 # Update the person
 updated_person = client.records.update(
-  object: 'people',
-  id: person['data']['id'],
+  object: "people",
+  id: person["data"]["id"],
   data: {
-    name: 'Jane Smith',
-    notes: 'Updated name after marriage'
+    name: "Jane Smith",
+    notes: "Updated name after marriage",
   }
 )
 puts "Updated person name to: #{updated_person['data']['name']}"
@@ -59,24 +60,24 @@ puts "\n=== Working with Company Records ==="
 
 # Create a company
 company = client.records.create(
-  object: 'companies',
+  object: "companies",
   data: {
-    name: 'Acme Corporation',
-    domain: 'acme.com',
-    industry: 'Technology'
+    name: "Acme Corporation",
+    domain: "acme.com",
+    industry: "Technology",
   }
 )
 puts "Created company: #{company['data']['name']}"
 
 # Link the person to the company
 client.records.update(
-  object: 'people',
-  id: person['data']['id'],
+  object: "people",
+  id: person["data"]["id"],
   data: {
     company: {
-      target_object: 'companies',
-      target_record_id: company['data']['id']
-    }
+      target_object: "companies",
+      target_record_id: company["data"]["id"],
+    },
   }
 )
 puts "Linked #{person['data']['name']} to #{company['data']['name']}"
@@ -101,7 +102,7 @@ puts "\n=== Error Handling Example ==="
 
 begin
   # Try to get a non-existent record
-  client.records.get(object: 'people', id: 'non-existent-id')
+  client.records.get(object: "people", id: "non-existent-id")
 rescue Attio::NotFoundError => e
   puts "Caught expected error: #{e.message}"
 rescue Attio::APIError => e
@@ -110,10 +111,10 @@ end
 
 # Clean up - delete the records we created
 puts "\n=== Cleanup ==="
-client.records.delete(object: 'people', id: person['data']['id'])
+client.records.delete(object: "people", id: person["data"]["id"])
 puts "Deleted person record"
 
-client.records.delete(object: 'companies', id: company['data']['id'])
+client.records.delete(object: "companies", id: company["data"]["id"])
 puts "Deleted company record"
 
-puts "\nExample completed successfully!"
+puts "\nExample completed successfully!"

data/lib/attio/client.rb

@@ -1,51 +1,53 @@
+# frozen_string_literal: true
+
+# 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
 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
-    
+    API_BASE_URL = "https://api.attio.com/v2"
+
     # 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
@@ -55,14 +57,14 @@ module Attio
           "Authorization" => "Bearer #{api_key}",
           "Accept" => "application/json",
           "Content-Type" => "application/json",
-          "User-Agent" => "Attio Ruby Client/#{VERSION}"
+          "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')
@@ -71,7 +73,7 @@ module Attio
     end
 
     # Access to the Objects API resource.
-    # 
+    #
     # @return [Resources::Objects] Objects resource instance
     # @example
     #   objects = client.objects.list
@@ -80,7 +82,7 @@ module Attio
     end
 
     # Access to the Lists API resource.
-    # 
+    #
     # @return [Resources::Lists] Lists resource instance
     # @example
     #   lists = client.lists.list
@@ -89,7 +91,7 @@ module Attio
     end
 
     # Access to the Workspaces API resource.
-    # 
+    #
     # @return [Resources::Workspaces] Workspaces resource instance
     # @example
     #   workspaces = client.workspaces.list
@@ -98,7 +100,7 @@ module Attio
     end
 
     # Access to the Attributes API resource.
-    # 
+    #
     # @return [Resources::Attributes] Attributes resource instance
     # @example
     #   attributes = client.attributes.list
@@ -107,7 +109,7 @@ module Attio
     end
 
     # Access to the Users API resource.
-    # 
+    #
     # @return [Resources::Users] Users resource instance
     # @example
     #   users = client.users.list
@@ -115,4 +117,4 @@ module Attio
       @users ||= Resources::Users.new(self)
     end
   end
-end
+end

data/lib/attio/connection_pool.rb

@@ -1,6 +1,18 @@
-require 'thread'
+# frozen_string_literal: true
 
 module Attio
+  # Thread-safe connection pool for managing HTTP connections
+  #
+  # This class provides a pool of connections that can be shared
+  # across threads for improved performance and resource management.
+  #
+  # @example Creating a connection pool
+  #   pool = ConnectionPool.new(size: 10) { HttpClient.new }
+  #
+  # @example Using a connection from the pool
+  #   pool.with_connection do |conn|
+  #     conn.get("/endpoint")
+  #   end
   class ConnectionPool
     DEFAULT_POOL_SIZE = 5
     DEFAULT_TIMEOUT = 5 # seconds to wait for connection
@@ -14,7 +26,7 @@ module Attio
       @key = :"#{object_id}_connection"
       @block = block
       @mutex = Mutex.new
-      
+
       size.times { @available << create_connection }
     end
 
@@ -29,14 +41,12 @@ module Attio
 
     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
-        
+        return @available.pop(true) if @available.size.positive?
+
+        raise TimeoutError, "Couldn't acquire connection within #{timeout} seconds" if Time.now >= deadline
+
         sleep(0.01)
       end
     rescue ThreadError
@@ -52,18 +62,20 @@ module Attio
     def shutdown
       @mutex.synchronize do
         @available.close
-        while connection = @available.pop(true) rescue nil
+        while (connection = begin
+          @available.pop(true)
+        rescue StandardError
+          nil
+        end)
           connection.close if connection.respond_to?(:close)
         end
       end
     end
 
-    private
-
-    def create_connection
+    private def create_connection
       @block.call
     end
 
     class TimeoutError < StandardError; end
   end
-end
+end

data/lib/attio/errors.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 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
+end

data/lib/attio/http_client.rb

@@ -1,7 +1,15 @@
-require 'typhoeus'
-require 'json'
+# frozen_string_literal: true
+
+require "typhoeus"
+require "json"
 
 module Attio
+  # HTTP client for making API requests to Attio
+  #
+  # This class handles the low-level HTTP communication with the Attio API,
+  # including request execution, response parsing, and error handling.
+  #
+  # @api private
   class HttpClient
     DEFAULT_TIMEOUT = 30
 
@@ -33,16 +41,14 @@ module Attio
       execute_request(:delete, path)
     end
 
-    private
-
-    def execute_request(method, path, options = {})
+    private def execute_request(method, path, options = {})
       url = "#{base_url}/#{path}"
-      
+
       request_options = {
         method: method,
-        headers: headers.merge('Content-Type' => 'application/json'),
+        headers: headers.merge("Content-Type" => "application/json"),
         timeout: timeout,
-        connecttimeout: timeout
+        connecttimeout: timeout,
       }.merge(options)
 
       request = Typhoeus::Request.new(url, request_options)
@@ -51,42 +57,57 @@ module Attio
       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
+    private def handle_response(response)
+      return handle_connection_error(response) if response.code == 0
+      return parse_json(response.body) if (200..299).cover?(response.code)
+
+      handle_error_response(response)
+    end
+
+    private def handle_connection_error(response)
+      raise TimeoutError, "Request timed out" if response.timed_out?
+
+      raise ConnectionError, "Connection failed: #{response.return_message}"
     end
 
-    def parse_json(body)
+    private def handle_error_response(response)
+      error_class = error_class_for_status(response.code)
+      message = parse_error_message(response)
+
+      # Add status code to message for generic errors
+      message = "Request failed with status #{response.code}: #{message}" if error_class == Error
+
+      raise error_class, message
+    end
+
+    private def error_class_for_status(status)
+      error_map = {
+        401 => AuthenticationError,
+        404 => NotFoundError,
+        422 => ValidationError,
+        429 => RateLimitError,
+      }
+      return error_map[status] if error_map.key?(status)
+      return ServerError if (500..599).cover?(status)
+
+      Error
+    end
+
+    private 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
-      
+    private def parse_error_message(response)
+      body = begin
+        parse_json(response.body)
+      rescue StandardError
+        response.body
+      end
+
       if body.is_a?(Hash)
         body["error"] || body["message"] || body.to_s
       else
@@ -97,4 +118,4 @@ module Attio
     class TimeoutError < Error; end
     class ConnectionError < Error; end
   end
-end
+end