attio 0.1.1

data/lib/attio/resources/records.rb

@@ -0,0 +1,158 @@
+module Attio
+  module Resources
+    # Handles all record-related API operations.
+    # 
+    # Records are the main data entities in Attio, representing things like
+    # people, companies, deals, etc. This class provides methods to create,
+    # read, update, delete, and query records.
+    # 
+    # @example List records
+    #   records = client.records.list(object: 'people', filters: { name: 'John' })
+    # 
+    # @example Create a record
+    #   record = client.records.create(
+    #     object: 'people',
+    #     data: { name: 'Jane Doe', email: 'jane@example.com' }
+    #   )
+    # 
+    # @author Ernest Sim
+    # @since 1.0.0
+    class Records < Base
+      # Query and list records for a specific object type.
+      # 
+      # This method allows you to retrieve records with optional filtering,
+      # sorting, and pagination parameters.
+      # 
+      # @param object [String] The object type to query (e.g., 'people', 'companies')
+      # @param params [Hash] Query parameters including filters, sorts, and pagination
+      # @option params [Hash] :filters Filtering criteria
+      # @option params [Array] :sorts Sorting options
+      # @option params [Integer] :limit Number of records to return
+      # @option params [String] :cursor Pagination cursor for next page
+      # 
+      # @return [Hash] API response containing records and pagination info
+      # @raise [ArgumentError] if object is nil or empty
+      # 
+      # @example Basic listing
+      #   records = client.records.list(object: 'people')
+      # 
+      # @example With filters
+      #   records = client.records.list(
+      #     object: 'people',
+      #     filters: { name: { contains: 'John' } },
+      #     limit: 50
+      #   )
+      def list(object:, **params)
+        validate_object!(object)
+        request(:post, "objects/#{object}/records/query", params)
+      end
+
+      # Retrieve a specific record by ID.
+      # 
+      # @param object [String] The object type (e.g., 'people', 'companies')
+      # @param id [String] The record ID
+      # 
+      # @return [Hash] The record data
+      # @raise [ArgumentError] if object or id is nil or empty
+      # 
+      # @example
+      #   record = client.records.get(object: 'people', id: 'abc123')
+      def get(object:, id:)
+        validate_object!(object)
+        validate_id!(id)
+        request(:get, "objects/#{object}/records/#{id}")
+      end
+
+      # Create a new record.
+      # 
+      # @param object [String] The object type to create the record in
+      # @param data [Hash] The record data to create
+      # 
+      # @return [Hash] The created record data
+      # @raise [ArgumentError] if object is nil/empty or data is invalid
+      # 
+      # @example Create a person
+      #   record = client.records.create(
+      #     object: 'people',
+      #     data: {
+      #       name: 'Jane Doe',
+      #       email: 'jane@example.com',
+      #       company: { target_object: 'companies', target_record_id: 'company123' }
+      #     }
+      #   )
+      def create(object:, data:)
+        validate_object!(object)
+        validate_data!(data)
+        request(:post, "objects/#{object}/records", data)
+      end
+
+      # Update an existing record.
+      # 
+      # @param object [String] The object type
+      # @param id [String] The record ID to update
+      # @param data [Hash] The updated record data
+      # 
+      # @return [Hash] The updated record data
+      # @raise [ArgumentError] if object, id, or data is invalid
+      # 
+      # @example Update a person's name
+      #   record = client.records.update(
+      #     object: 'people',
+      #     id: 'abc123',
+      #     data: { name: 'Jane Smith' }
+      #   )
+      def update(object:, id:, data:)
+        validate_object!(object)
+        validate_id!(id)
+        validate_data!(data)
+        request(:patch, "objects/#{object}/records/#{id}", data)
+      end
+
+      # Delete a record.
+      # 
+      # @param object [String] The object type
+      # @param id [String] The record ID to delete
+      # 
+      # @return [Hash] Deletion confirmation
+      # @raise [ArgumentError] if object or id is nil or empty
+      # 
+      # @example
+      #   client.records.delete(object: 'people', id: 'abc123')
+      def delete(object:, id:)
+        validate_object!(object)
+        validate_id!(id)
+        request(:delete, "objects/#{object}/records/#{id}")
+      end
+
+      private
+
+      # Validates that the object parameter is present and not empty.
+      # 
+      # @param object [String, nil] The object type to validate
+      # @raise [ArgumentError] if object is nil or empty
+      # @api private
+      def validate_object!(object)
+        raise ArgumentError, "Object type is required" if object.nil? || object.to_s.strip.empty?
+      end
+
+      # Validates that the ID parameter is present and not empty.
+      # 
+      # @param id [String, nil] The record ID to validate
+      # @raise [ArgumentError] if id is nil or empty
+      # @api private
+      def validate_id!(id)
+        raise ArgumentError, "Record ID is required" if id.nil? || id.to_s.strip.empty?
+      end
+
+      # Validates that the data parameter is present and is a hash.
+      # 
+      # @param data [Hash, nil] The data to validate
+      # @raise [ArgumentError] if data is nil or not a hash
+      # @api private
+      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/users.rb

@@ -0,0 +1,20 @@
+module Attio
+  module Resources
+    class Users < Base
+      def list(**params)
+        request(:get, "users", params)
+      end
+
+      def get(id:)
+        validate_id!(id)
+        request(:get, "users/#{id}")
+      end
+
+      private
+
+      def validate_id!(id)
+        raise ArgumentError, "User ID is required" if id.nil? || id.to_s.strip.empty?
+      end
+    end
+  end
+end

data/lib/attio/resources/workspaces.rb

@@ -0,0 +1,13 @@
+module Attio
+  module Resources
+    class Workspaces < Base
+      def get
+        request(:get, "workspace")
+      end
+
+      def members(**params)
+        request(:get, "workspace/members", params)
+      end
+    end
+  end
+end

data/lib/attio/retry_handler.rb

@@ -0,0 +1,70 @@
+module Attio
+  class RetryHandler
+    DEFAULT_MAX_RETRIES = 3
+    DEFAULT_RETRY_DELAY = 1 # seconds
+    DEFAULT_BACKOFF_FACTOR = 2
+    RETRIABLE_ERRORS = [
+      HttpClient::TimeoutError,
+      HttpClient::ConnectionError,
+      ServerError,
+      RateLimitError
+    ].freeze
+
+    attr_reader :max_retries, :retry_delay, :backoff_factor, :logger
+
+    def initialize(max_retries: DEFAULT_MAX_RETRIES, 
+                   retry_delay: DEFAULT_RETRY_DELAY,
+                   backoff_factor: DEFAULT_BACKOFF_FACTOR,
+                   logger: nil)
+      @max_retries = max_retries
+      @retry_delay = retry_delay
+      @backoff_factor = backoff_factor
+      @logger = logger
+    end
+
+    def with_retry(&block)
+      retries = 0
+      delay = retry_delay
+
+      begin
+        yield
+      rescue *RETRIABLE_ERRORS => e
+        retries += 1
+        
+        if retries <= max_retries
+          log_retry(e, retries, delay)
+          sleep(delay)
+          delay *= backoff_factor
+          retry
+        else
+          log_failure(e, retries)
+          raise
+        end
+      end
+    end
+
+    private
+
+    def log_retry(error, attempt, delay)
+      return unless logger
+      
+      logger.warn(
+        "Retry attempt #{attempt}/#{max_retries}",
+        error: error.class.name,
+        message: error.message,
+        delay: delay
+      )
+    end
+
+    def log_failure(error, attempts)
+      return unless logger
+      
+      logger.error(
+        "Max retries exceeded",
+        error: error.class.name,
+        message: error.message,
+        attempts: attempts
+      )
+    end
+  end
+end

data/lib/attio/version.rb

@@ -0,0 +1,3 @@
+module Attio
+  VERSION = "0.1.1"
+end

data/lib/attio.rb

@@ -0,0 +1,60 @@
+require "typhoeus"
+
+require "attio/version"
+require "attio/errors"
+require "attio/http_client"
+require "attio/client"
+
+require "attio/resources/base"
+require "attio/resources/records"
+require "attio/resources/objects"
+require "attio/resources/lists"
+require "attio/resources/workspaces"
+require "attio/resources/attributes"
+require "attio/resources/users"
+
+# The main Attio module provides access to the Attio API client.
+# 
+# This is the primary entry point for interacting with the Attio API.
+# 
+# @example Basic usage
+#   client = Attio.client(api_key: 'your-api-key')
+#   
+# @example Working with records
+#   # List records for a specific object type
+#   records = client.records.list(object: 'people', filters: { name: 'John' })
+#   
+#   # Create a new record
+#   new_record = client.records.create(
+#     object: 'people',
+#     data: { name: 'Jane Doe', email: 'jane@example.com' }
+#   )
+#   
+#   # Get a specific record
+#   record = client.records.get(object: 'people', id: 'record-id')
+#   
+#   # Update a record
+#   updated = client.records.update(
+#     object: 'people',
+#     id: 'record-id',
+#     data: { name: 'Jane Smith' }
+#   )
+#   
+#   # Delete a record
+#   client.records.delete(object: 'people', id: 'record-id')
+#
+# @author Ernest Sim
+# @since 1.0.0
+module Attio
+  # Creates a new Attio API client instance.
+  # 
+  # @param api_key [String] Your Attio API key
+  # @return [Client] A new client instance configured with the provided API key
+  # @raise [ArgumentError] if api_key is nil or empty
+  # 
+  # @example Create a client
+  #   client = Attio.client(api_key: 'your-api-key-here')
+  def self.client(api_key:)
+    Client.new(api_key: api_key)
+  end
+end

data/run_tests.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+# Add lib to load path
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+
+# Load the gem
+require 'attio'
+
+# Basic smoke test
+begin
+  puts "Testing Attio gem..."
+  puts "Version: #{Attio::VERSION}"
+  
+  # Test client initialization
+  begin
+    Attio::Client.new(api_key: nil)
+    puts "ERROR: Should have raised error for nil API key"
+  rescue ArgumentError => e
+    puts "✓ Client validation works: #{e.message}"
+  end
+  
+  # Test client creation
+  client = Attio::Client.new(api_key: "test_key")
+  puts "✓ Client created successfully"
+  
+  # Test resource access
+  puts "✓ Records resource available: #{client.records.class}"
+  puts "✓ Objects resource available: #{client.objects.class}"
+  puts "✓ Lists resource available: #{client.lists.class}"
+  puts "✓ Workspaces resource available: #{client.workspaces.class}"
+  puts "✓ Attributes resource available: #{client.attributes.class}"
+  puts "✓ Users resource available: #{client.users.class}"
+  
+  # Test error classes
+  [
+    Attio::Error,
+    Attio::AuthenticationError,
+    Attio::NotFoundError,
+    Attio::ValidationError,
+    Attio::RateLimitError,
+    Attio::ServerError
+  ].each do |error_class|
+    puts "✓ #{error_class} is defined"
+  end
+  
+  puts "\nAll basic tests passed!"
+  
+rescue StandardError => e
+  puts "ERROR: #{e.message}"
+  puts e.backtrace
+  exit 1
+end

data/test_basic.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+# Test without loading external dependencies
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+
+puts "Testing Attio gem structure..."
+
+# Test version file
+require 'attio/version'
+puts "✓ Version loaded: #{Attio::VERSION}"
+
+# Test error definitions
+require 'attio/errors'
+[
+  Attio::Error,
+  Attio::AuthenticationError,
+  Attio::NotFoundError,
+  Attio::ValidationError,
+  Attio::RateLimitError,
+  Attio::ServerError
+].each do |error_class|
+  puts "✓ #{error_class} is defined"
+end
+
+# Test that all files exist
+files_to_check = [
+  'lib/attio.rb',
+  'lib/attio/client.rb',
+  'lib/attio/resources/base.rb',
+  'lib/attio/resources/records.rb',
+  'lib/attio/resources/objects.rb',
+  'lib/attio/resources/lists.rb',
+  'lib/attio/resources/workspaces.rb',
+  'lib/attio/resources/attributes.rb',
+  'lib/attio/resources/users.rb'
+]
+
+files_to_check.each do |file|
+  if File.exist?(file)
+    puts "✓ #{file} exists"
+  else
+    puts "✗ #{file} is missing!"
+  end
+end
+
+# Test spec files exist
+spec_files = Dir.glob('spec/**/*_spec.rb')
+puts "\nFound #{spec_files.length} spec files:"
+spec_files.each { |f| puts "  - #{f}" }
+
+puts "\nBasic structure test completed!"

data/test_typhoeus.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require_relative 'lib/attio'
+
+# Test the gem with Typhoeus
+puts "=== Testing Attio Ruby Gem with Typhoeus ==="
+puts "Version: #{Attio::VERSION}"
+
+# Initialize client
+API_KEY = '5472096a0d3ad936523a7a9101807bb3155616a3e04a7649ad41cd5a0261dddd'
+client = Attio.client(api_key: API_KEY)
+puts "✓ Client initialized"
+
+# Test listing people
+puts "\nListing people..."
+begin
+  result = client.records.list(object: "people", sorts: [], limit: 5)
+  records = result["data"]
+  puts "✓ Found #{records.length} records"
+  
+  records.each do |record|
+    name = record["values"]["name"][0]["full_name"] rescue "Unknown"
+    email = record["values"]["email_addresses"][0]["email_address"] rescue "No email"
+    puts "  - #{name} (#{email})"
+  end
+rescue => e
+  puts "✗ Failed to list records: #{e.message}"
+  puts e.backtrace
+end
+
+puts "\n✨ Test complete!"

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: attio
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ernest Sim
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: A Ruby library for interacting with the Attio API, providing easy access
+  to CRM functionality
+email:
+- ernest.codes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codecov.yml"
+- ".github/CODEOWNERS"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/dependabot.yml"
+- ".github/pull_request_template.md"
+- ".github/workflows/ci.yml"
+- ".github/workflows/dependabot-auto-merge.yml"
+- ".github/workflows/pr_checks.yml"
+- ".github/workflows/release.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".yardopts"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- SECURITY.md
+- attio.gemspec
+- bin/console
+- bin/setup
+- danger/Dangerfile
+- docs/.nojekyll
+- docs/Attio.html
+- docs/Attio/AuthenticationError.html
+- docs/Attio/Client.html
+- docs/Attio/ConnectionPool.html
+- docs/Attio/ConnectionPool/TimeoutError.html
+- docs/Attio/Error.html
+- docs/Attio/HttpClient.html
+- docs/Attio/HttpClient/ConnectionError.html
+- docs/Attio/HttpClient/TimeoutError.html
+- docs/Attio/Logger.html
+- docs/Attio/NotFoundError.html
+- docs/Attio/RateLimitError.html
+- docs/Attio/RequestLogger.html
+- docs/Attio/Resources.html
+- docs/Attio/Resources/Attributes.html
+- docs/Attio/Resources/Base.html
+- docs/Attio/Resources/Lists.html
+- docs/Attio/Resources/Objects.html
+- docs/Attio/Resources/Records.html
+- docs/Attio/Resources/Users.html
+- docs/Attio/Resources/Workspaces.html
+- docs/Attio/RetryHandler.html
+- docs/Attio/ServerError.html
+- docs/Attio/ValidationError.html
+- docs/SETUP.md
+- docs/_index.html
+- docs/class_list.html
+- docs/css/common.css
+- docs/css/full_list.css
+- docs/css/style.css
+- docs/example.rb
+- docs/file.CHANGELOG.html
+- docs/file.README.html
+- docs/file_list.html
+- docs/frames.html
+- docs/index.html
+- docs/js/app.js
+- docs/js/full_list.js
+- docs/js/jquery.js
+- docs/method_list.html
+- docs/top-level-namespace.html
+- lib/attio.rb
+- lib/attio/client.rb
+- lib/attio/connection_pool.rb
+- lib/attio/errors.rb
+- lib/attio/http_client.rb
+- lib/attio/logger.rb
+- lib/attio/resources/attributes.rb
+- lib/attio/resources/base.rb
+- lib/attio/resources/lists.rb
+- lib/attio/resources/objects.rb
+- lib/attio/resources/records.rb
+- lib/attio/resources/users.rb
+- lib/attio/resources/workspaces.rb
+- lib/attio/retry_handler.rb
+- lib/attio/version.rb
+- run_tests.rb
+- test_basic.rb
+- test_typhoeus.rb
+homepage: https://github.com/idl3/attio
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/idl3/attio
+  source_code_uri: https://github.com/idl3/attio
+  changelog_uri: https://github.com/idl3/attio/blob/master/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Ruby client for the Attio API
+test_files: []