attio-ruby 0.1.0

data/docs/CODECOV_SETUP.md

@@ -0,0 +1,34 @@
+# Codecov Setup
+
+To enable code coverage reporting in CI:
+
+1. **Get a Codecov token**:
+   - Go to [codecov.io](https://codecov.io)
+   - Sign in with your GitHub account
+   - Add your repository
+   - Copy the repository token
+
+2. **Add the token to GitHub secrets**:
+   - Go to your repository on GitHub
+   - Navigate to Settings → Secrets and variables → Actions
+   - Click "New repository secret"
+   - Name: `CODECOV_TOKEN`
+   - Value: Paste your Codecov token
+   - Click "Add secret"
+
+3. **Coverage reports will be generated automatically**:
+   - The CI workflow runs tests with coverage enabled
+   - Coverage reports are uploaded to Codecov on push events
+   - Pull requests will show coverage information
+
+## Local Coverage
+
+To generate coverage reports locally:
+
+```bash
+COVERAGE=true bundle exec rspec
+```
+
+This will generate:
+- HTML report at `coverage/index.html`
+- XML report at `coverage/coverage.xml` (for Codecov)

data/examples/basic_usage.rb

@@ -0,0 +1,149 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "attio"
+require "dotenv/load"
+
+# Basic usage example for Attio Ruby gem
+
+# Configure the client
+Attio.configure do |config|
+  config.api_key = ENV.fetch("ATTIO_API_KEY", nil)
+  # Optional configurations
+  # config.api_base = "https://api.attio.com"
+  # config.timeout = 30
+  # config.debug = true
+end
+
+puts "=== Attio Ruby Gem Basic Usage Example ==="
+puts
+
+# 1. Working with Objects
+puts "1. Listing Objects:"
+objects = Attio::Object.list
+objects.each do |object|
+  puts "  - #{object.plural_noun} (#{object.api_slug})"
+end
+puts
+
+# 2. Working with Records (People)
+puts "2. Creating a Person:"
+person = Attio::Record.create(
+  values: {
+    name: [{
+      first_name: "John",
+      last_name: "Doe",
+      full_name: "John Doe"
+    }],
+    email_addresses: ["john@example.com"],
+    phone_numbers: [{
+      original_phone_number: "+1-555-0123",
+      country_code: "US"
+    }],
+    job_title: "Software Engineer"
+  },
+  object: "people"
+)
+puts "  Created: #{person[:name]} (ID: #{person.id})"
+puts
+
+# 3. Searching for Records
+puts "3. Searching for People:"
+people = Attio::Record.list(
+  {
+    q: "john",
+    limit: 5
+  },
+  object: "people"
+)
+puts "  Found #{people.count} people matching 'john'"
+people.each do |p|
+  puts "  - #{p[:name]} (#{p[:email_addresses]})"
+end
+puts
+
+# 4. Working with Companies
+puts "4. Creating a Company:"
+company = Attio::Record.create(
+  values: {
+    name: "Acme Corporation",
+    domains: ["acme.com"],
+    industry: "Technology",
+    company_size: "50-100"
+  },
+  object: "companies"
+)
+puts "  Created: #{company[:name]} (ID: #{company.id})"
+puts
+
+# 5. Updating Records
+puts "5. Updating a Record:"
+person[:job_title] = "Senior Software Engineer"
+person[:company] = [{target_object: "companies", target_record: company.id}]
+person.save
+puts "  Updated #{person[:name]}'s job title and company"
+puts
+
+# 6. Working with Lists
+puts "6. Creating and Managing Lists:"
+list = Attio::List.create(
+  name: "VIP Customers",
+  object: "people"
+)
+puts "  Created list: #{list.name}"
+
+# Add person to list
+list.add_record(person.id)
+puts "  Added #{person[:name]} to #{list.name}"
+puts
+
+# 7. Adding Notes
+puts "7. Adding a Note:"
+Attio::Note.create(
+  parent_object: "people",
+  parent_record_id: person.id,
+  content: "Had a great meeting about the new project. Very interested in our solution.",
+  format: "plaintext"
+)
+puts "  Added note to #{person[:name]}'s record"
+puts
+
+# 8. Working with Attributes
+puts "8. Listing Attributes for People:"
+attributes = Attio::Attribute.list(object: "people")
+puts "  People object has #{attributes.count} attributes:"
+attributes.first(5).each do |attr|
+  puts "  - #{attr.name} (#{attr.type})"
+end
+puts
+
+# 9. Working with Attributes
+puts "9. Searching Records:"
+# Search people by query
+search_results = Attio::Record.list(
+  object: "people",
+  params: {q: "Jane"}
+)
+puts "  Found #{search_results.count} people matching 'Jane'"
+puts
+
+# 10. Error Handling
+puts "10. Error Handling Example:"
+begin
+  # Try to create a record without required fields
+  Attio::Record.create(object: "invalid_object", values: {})
+rescue Attio::Errors::NotFoundError => e
+  puts "  Caught error: #{e.message}"
+  puts "  Request ID: #{e.request_id}" if e.request_id
+end
+puts
+
+puts "=== Example Complete ==="
+puts "This example demonstrated:"
+puts "- Configuring the client"
+puts "- Creating and updating records"
+puts "- Searching and filtering"
+puts "- Working with lists and notes"
+puts "- Working with attributes"
+puts "- Error handling"