attio 0.1.1 → 0.2.0

data/Rakefile

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 begin
   require "yard"
   require "yard/rake/yardoc_task"
-  
+
   YARD::Rake::YardocTask.new do |t|
-    t.files = ['lib/**/*.rb']
-    t.options = ['--output-dir', 'docs']
+    t.files = ["lib/**/*.rb"]
+    t.options = ["--output-dir", "docs"]
   end
 rescue LoadError
   # YARD is not available
@@ -20,7 +22,7 @@ task default: :spec
 namespace :coverage do
   desc "Run tests with coverage report"
   task :report do
-    ENV['COVERAGE'] = 'true'
+    ENV["COVERAGE"] = "true"
     Rake::Task["spec"].execute
   end
 end
@@ -36,7 +38,7 @@ namespace :docs do
   end
 
   desc "Generate and open documentation"
-  task :open => :generate do
+  task open: :generate do
     if File.exist?("docs/index.html")
       system("open docs/index.html")
     else
@@ -46,7 +48,7 @@ namespace :docs do
 
   desc "Clean generated documentation"
   task :clean do
-    FileUtils.rm_rf("docs") if File.exist?("docs")
+    FileUtils.rm_rf("docs")
     puts "Documentation cleaned."
   end
 

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/examples/advanced_filtering.rb

@@ -0,0 +1,178 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "attio"
+require "json"
+
+# Example: Advanced Filtering and Querying
+#
+# This example demonstrates how to use advanced filtering and sorting
+# capabilities when querying records in Attio.
+
+# Initialize the client
+client = Attio.client(api_key: ENV.fetch("ATTIO_API_KEY"))
+
+puts "Attio Advanced Filtering Example"
+puts "=" * 40
+
+# 1. Query with simple filters
+puts "\n1. Finding people by email domain..."
+people_from_domain = client.records.list(
+  object: "people",
+  filters: {
+    email: { contains: "@example.com" },
+  },
+  limit: 10
+)
+puts "   Found #{people_from_domain['data']&.length || 0} people from example.com"
+
+# 2. Query with multiple filters (AND condition)
+puts "\n2. Finding high-value companies in technology sector..."
+high_value_tech = client.records.list(
+  object: "companies",
+  filters: {
+    industry: { equals: "Technology" },
+    annual_revenue: { greater_than: 1_000_000 },
+  },
+  sorts: [
+    { field: "annual_revenue", direction: "desc" },
+  ],
+  limit: 5
+)
+puts "   Found #{high_value_tech['data']&.length || 0} high-value tech companies"
+
+# 3. Query with date range filters
+puts "\n3. Finding recently created records..."
+recent_date = (Date.today - 30).iso8601
+recent_records = client.records.list(
+  object: "people",
+  filters: {
+    created_at: { greater_than: recent_date },
+  },
+  sorts: [
+    { field: "created_at", direction: "desc" },
+  ]
+)
+puts "   Found #{recent_records['data']&.length || 0} people created in last 30 days"
+
+# 4. Query with relationship filters
+puts "\n4. Finding people associated with specific companies..."
+# First, get a company
+companies = client.records.list(object: "companies", limit: 1)
+if companies.dig("data", 0)
+  company_id = companies.dig("data", 0, "id", "record_id")
+
+  people_at_company = client.records.list(
+    object: "people",
+    filters: {
+      company: {
+        target_object: "companies",
+        target_record_id: company_id,
+      },
+    }
+  )
+  puts "   Found #{people_at_company['data']&.length || 0} people at the company"
+else
+  puts "   No companies found for demo"
+end
+
+# 5. Query with null/not null filters
+puts "\n5. Finding records with missing data..."
+missing_email = client.records.list(
+  object: "people",
+  filters: {
+    email: { is_null: true },
+  },
+  limit: 10
+)
+puts "   Found #{missing_email['data']&.length || 0} people without email addresses"
+
+# 6. Complex sorting with multiple fields
+puts "\n6. Sorting by multiple criteria..."
+sorted_companies = client.records.list(
+  object: "companies",
+  sorts: [
+    { field: "industry", direction: "asc" },
+    { field: "annual_revenue", direction: "desc" },
+    { field: "name", direction: "asc" },
+  ],
+  limit: 20
+)
+puts "   Retrieved #{sorted_companies['data']&.length || 0} companies sorted by industry, revenue, and name"
+
+# 7. Pagination example
+puts "\n7. Paginating through results..."
+page_size = 5
+total_fetched = 0
+cursor = nil
+
+3.times do |page|
+  params = {
+    object: "people",
+    limit: page_size,
+  }
+  params[:cursor] = cursor if cursor
+
+  page_results = client.records.list(**params)
+  fetched = page_results["data"]&.length || 0
+  total_fetched += fetched
+
+  puts "   Page #{page + 1}: fetched #{fetched} records"
+
+  cursor = page_results.dig("pagination", "next_cursor")
+  break unless cursor
+end
+puts "   Total fetched across pages: #{total_fetched}"
+
+# 8. Query tasks with status filter
+puts "\n8. Finding pending tasks..."
+pending_tasks = client.tasks.list(
+  status: "pending",
+  limit: 10
+)
+puts "   Found #{pending_tasks['data']&.length || 0} pending tasks"
+
+# 9. Query with custom field filters
+puts "\n9. Filtering by custom fields..."
+# This assumes you have custom fields set up
+client.records.list(
+  object: "people",
+  filters: {
+    # Replace with your actual custom field API slug
+    # custom_field: { equals: "some_value" }
+  },
+  limit: 10
+)
+puts "   Custom field filtering available for your specific schema"
+
+# 10. Export query for analysis
+puts "\n10. Exporting query results..."
+export_data = client.records.list(
+  object: "companies",
+  filters: {
+    industry: { not_null: true },
+  },
+  limit: 100
+)
+
+if export_data["data"] && !export_data["data"].empty?
+  # Simple CSV-like export
+  puts "   Sample export (first 3 records):"
+  export_data["data"].take(3).each do |record|
+    name = record.dig("values", "name", 0, "value") || "N/A"
+    industry = record.dig("values", "industry", 0, "value") || "N/A"
+    puts "   - #{name}: #{industry}"
+  end
+end
+
+puts "\n#{'=' * 40}"
+puts "Example completed successfully!"
+puts "\nThis example demonstrated:"
+puts "  • Simple and complex filtering"
+puts "  • Multi-field sorting"
+puts "  • Date range queries"
+puts "  • Relationship filters"
+puts "  • Null/not-null checks"
+puts "  • Pagination"
+puts "  • Task filtering"
+puts "  • Custom field queries"

data/examples/basic_usage.rb

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "attio"
+
+# Basic usage example for the Attio Ruby gem
+#
+# This example demonstrates:
+# - Client initialization
+# - Working with records (people, companies)
+# - Creating relationships between records
+# - Error handling
+
+# Initialize the client with your API key
+# You can get your API key from: https://app.attio.com/settings/api-keys
+client = Attio.client(api_key: ENV.fetch("ATTIO_API_KEY"))
+
+puts "🚀 Attio Ruby Client - Basic Usage Example"
+puts "=" * 50
+
+begin
+  # List all available objects in your workspace
+  puts "\n📋 Available Objects:"
+  objects = client.objects.list
+  objects["data"].each do |object|
+    puts "  - #{object['name']} (#{object['id']})"
+  end
+
+  # Working with People records
+  puts "\n👥 Working with People:"
+
+  # List existing people (first 5)
+  people = client.records.list(object: "people", limit: 5)
+  puts "  Found #{people['data'].length} people records"
+
+  # Create a new person
+  new_person = client.records.create(
+    object: "people",
+    data: {
+      name: "John Doe",
+      email: "john.doe@example.com",
+      phone: "+1-555-0123",
+      title: "Software Engineer",
+    }
+  )
+  puts "  ✅ Created person: #{new_person['data']['name']} (ID: #{new_person['data']['id']})"
+
+  # Update the person
+  updated_person = client.records.update(
+    object: "people",
+    id: new_person["data"]["id"],
+    data: { title: "Senior Software Engineer" }
+  )
+  puts "  ✅ Updated title to: #{updated_person['data']['title']}"
+
+  # Working with Companies
+  puts "\n🏢 Working with Companies:"
+
+  # Create a company
+  new_company = client.records.create(
+    object: "companies",
+    data: {
+      name: "Acme Corp",
+      domain: "acme.com",
+      employee_count: 100,
+      description: "Leading provider of innovative solutions",
+    }
+  )
+  puts "  ✅ Created company: #{new_company['data']['name']}"
+
+  # Link person to company (create relationship)
+  # Note: This requires the person and company to have a relationship field configured
+  puts "\n🔗 Creating Relationships:"
+  # This would typically be done through a reference field
+  # The exact implementation depends on your Attio workspace configuration
+
+  # Working with Lists
+  puts "\n📝 Working with Lists:"
+  lists = client.lists.list(limit: 5)
+  if lists["data"].any?
+    first_list = lists["data"].first
+    puts "  Found list: #{first_list['name']}"
+
+    # Get entries in the list
+    entries = client.lists.entries(id: first_list["id"], limit: 5)
+    puts "  List has #{entries['data'].length} entries"
+  else
+    puts "  No lists found in workspace"
+  end
+
+  # Cleanup - Delete the test records
+  puts "\n🧹 Cleaning up test data:"
+  client.records.delete(object: "people", id: new_person["data"]["id"])
+  puts "  ✅ Deleted test person record"
+
+  client.records.delete(object: "companies", id: new_company["data"]["id"])
+  puts "  ✅ Deleted test company record"
+rescue Attio::AuthenticationError => e
+  puts "❌ Authentication failed: #{e.message}"
+  puts "   Please check your API key"
+rescue Attio::NotFoundError => e
+  puts "❌ Resource not found: #{e.message}"
+rescue Attio::ValidationError => e
+  puts "❌ Validation error: #{e.message}"
+rescue Attio::Error => e
+  puts "❌ API error: #{e.message}"
+end
+
+puts "\n✨ Example completed!"