attio 0.1.1

data/README.md

@@ -0,0 +1,292 @@
+# Attio Ruby Client
+
+[![Documentation](https://img.shields.io/badge/docs-yard-blue.svg)](https://idl3.github.io/attio)
+[![Gem Version](https://badge.fury.io/rb/attio.svg)](https://badge.fury.io/rb/attio)
+
+Ruby client for the [Attio CRM API](https://developers.attio.com/). This library provides easy access to the Attio API, allowing you to manage records, objects, lists, and more.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'attio'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install attio
+
+## Quick Start
+
+```ruby
+require 'attio'
+
+# Initialize the client with your API key
+client = Attio.client(api_key: 'your-api-key-here')
+
+# List people records
+people = client.records.list(object: 'people', limit: 10)
+
+# Create a new person
+person = client.records.create(
+  object: 'people',
+  data: {
+    name: 'Jane Doe',
+    email: 'jane@example.com',
+    phone: '+1-555-0123'
+  }
+)
+
+# Get a specific person
+person = client.records.get(object: 'people', id: person['id'])
+
+# Update a person
+updated_person = client.records.update(
+  object: 'people',
+  id: person['id'],
+  data: { name: 'Jane Smith' }
+)
+
+# Delete a person
+client.records.delete(object: 'people', id: person['id'])
+```
+
+## Usage
+
+### Client Configuration
+
+```ruby
+# Basic client with default timeout (30 seconds)
+client = Attio.client(api_key: 'your-api-key')
+
+# Client with custom timeout
+client = Attio::Client.new(api_key: 'your-api-key', timeout: 60)
+```
+
+### Working with Records
+
+#### Listing Records
+
+```ruby
+# List all people
+people = client.records.list(object: 'people')
+
+# List with filters
+filtered_people = client.records.list(
+  object: 'people',
+  filters: {
+    name: { contains: 'John' },
+    company: { target_object: 'companies', target_record_id: 'company-123' }
+  },
+  limit: 50
+)
+
+# List with sorting
+sorted_people = client.records.list(
+  object: 'people',
+  sorts: [{ field: 'created_at', direction: 'desc' }],
+  limit: 25
+)
+```
+
+#### Creating Records
+
+```ruby
+# Create a person
+person = client.records.create(
+  object: 'people',
+  data: {
+    name: 'John Doe',
+    email: 'john@example.com',
+    phone: '+1-555-0123',
+    company: {
+      target_object: 'companies',
+      target_record_id: 'company-123'
+    }
+  }
+)
+
+# Create a company
+company = client.records.create(
+  object: 'companies',
+  data: {
+    name: 'Acme Corp',
+    domain: 'acme.com',
+    industry: 'Technology'
+  }
+)
+```
+
+#### Updating Records
+
+```ruby
+# Update a person's email
+client.records.update(
+  object: 'people',
+  id: 'person-123',
+  data: { email: 'newemail@example.com' }
+)
+
+# Update multiple fields
+client.records.update(
+  object: 'people',
+  id: 'person-123',
+  data: {
+    name: 'John Smith',
+    phone: '+1-555-9999',
+    notes: 'Updated contact information'
+  }
+)
+```
+
+### Working with Other Resources
+
+#### Objects
+
+```ruby
+# List all object types
+objects = client.objects.list
+
+# Get a specific object schema
+people_object = client.objects.get(id: 'people')
+```
+
+#### Lists
+
+```ruby
+# List all lists
+lists = client.lists.list
+
+# Get entries from a specific list
+entries = client.lists.entries(id: 'list-123')
+```
+
+#### Workspaces
+
+```ruby
+# List workspaces
+workspaces = client.workspaces.list
+
+# Get current workspace
+workspace = client.workspaces.get
+```
+
+#### Attributes
+
+```ruby
+# List attributes for an object
+attributes = client.attributes.list(object: 'people')
+
+# Create a custom attribute
+attribute = client.attributes.create(
+  object: 'people',
+  data: {
+    title: 'Custom Field',
+    api_slug: 'custom_field',
+    type: 'text'
+  }
+)
+```
+
+#### Users
+
+```ruby
+# List workspace users
+users = client.users.list
+
+# Get current user
+user = client.users.me
+```
+
+### Error Handling
+
+The client will raise appropriate exceptions for different error conditions:
+
+```ruby
+begin
+  client.records.get(object: 'people', id: 'invalid-id')
+rescue Attio::NotFoundError => e
+  puts "Record not found: #{e.message}"
+rescue Attio::AuthenticationError => e
+  puts "Authentication failed: #{e.message}"
+rescue Attio::RateLimitError => e
+  puts "Rate limit exceeded. Retry after: #{e.retry_after}"
+rescue Attio::APIError => e
+  puts "API error: #{e.message}"
+end
+```
+
+## Configuration Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `api_key` | String | Required | Your Attio API key |
+| `timeout` | Integer | 30 | Request timeout in seconds |
+
+## API Coverage
+
+This client supports all major Attio API endpoints:
+
+- ✅ Records (CRUD operations, querying)
+- ✅ Objects (list, get schema)
+- ✅ Lists (list, get entries)
+- ✅ Workspaces (list, get current)
+- ✅ Attributes (list, create, update)
+- ✅ Users (list, get current user)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+### Running Tests
+
+```bash
+bundle exec rspec
+```
+
+### Generating Documentation
+
+```bash
+# Generate YARD documentation
+bundle exec rake docs:generate
+
+# Open documentation in browser
+bundle exec rake docs:open
+
+# Serve documentation locally
+bundle exec rake docs:serve
+```
+
+### Code Coverage
+
+```bash
+bundle exec rake coverage:report
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/idl3/attio.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Make your changes and add tests
+4. Ensure all tests pass (`bundle exec rspec`)
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Support
+
+- 📖 [API Documentation](https://developers.attio.com/)
+- 🐛 [Issues](https://github.com/idl3/attio/issues)
+- 💬 [Discussions](https://github.com/idl3/attio/discussions)
+

data/Rakefile

@@ -0,0 +1,57 @@
+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']
+  end
+rescue LoadError
+  # YARD is not available
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+namespace :coverage do
+  desc "Run tests with coverage report"
+  task :report do
+    ENV['COVERAGE'] = 'true'
+    Rake::Task["spec"].execute
+  end
+end
+
+namespace :docs do
+  desc "Generate YARD documentation"
+  task :generate do
+    if defined?(YARD)
+      Rake::Task["yard"].execute
+    else
+      puts "YARD is not available. Please install it with: gem install yard"
+    end
+  end
+
+  desc "Generate and open documentation"
+  task :open => :generate do
+    if File.exist?("docs/index.html")
+      system("open docs/index.html")
+    else
+      puts "Documentation not found. Run 'rake docs:generate' first."
+    end
+  end
+
+  desc "Clean generated documentation"
+  task :clean do
+    FileUtils.rm_rf("docs") if File.exist?("docs")
+    puts "Documentation cleaned."
+  end
+
+  desc "Serve documentation locally (requires 'gem install yard')"
+  task :serve do
+    system("yard server --reload")
+  end
+end

data/SECURITY.md

@@ -0,0 +1,59 @@
+# Security Policy
+
+## Supported Versions
+
+We release patches for security vulnerabilities. Which versions are eligible for receiving such patches depends on the CVSS v3.0 Rating:
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.x.x   | :white_check_mark: |
+| < 1.0   | :x:                |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability within this project, please follow these steps:
+
+1. **Do NOT** create a public GitHub issue
+2. Send details to the maintainers through GitHub Security Advisories
+3. Include the following in your report:
+   - Description of the vulnerability
+   - Steps to reproduce
+   - Possible impact
+   - Suggested fix (if any)
+
+### What to expect
+
+- Acknowledgment of your report within 48 hours
+- Regular updates on our progress
+- Credit for responsible disclosure (unless you prefer to remain anonymous)
+
+## Security Best Practices
+
+When using this gem:
+
+1. **API Key Management**
+   - Never commit API keys to version control
+   - Use environment variables or secure credential management
+   - Rotate API keys regularly
+
+2. **Dependencies**
+   - Keep the gem updated to the latest version
+   - Monitor security advisories
+   - Use `bundle audit` to check for vulnerable dependencies
+
+3. **Data Handling**
+   - Be cautious with sensitive data in logs
+   - Use HTTPS for all API communications
+   - Implement proper error handling to avoid information leakage
+
+## Security Features
+
+This gem includes:
+- Automatic API key masking in logs
+- SSL/TLS verification by default
+- Rate limiting protection
+- Input validation and sanitization
+
+## Contact
+
+For security concerns, please use GitHub Security Advisories or contact the maintainers directly through GitHub.

data/attio.gemspec

@@ -0,0 +1,34 @@
+require_relative 'lib/attio/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "attio"
+  spec.version       = Attio::VERSION
+  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.homepage      = "https://github.com/idl3/attio"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  # 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
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "typhoeus", "~> 1.4"
+
+  # Development dependencies
+  spec.add_development_dependency "yard", "~> 0.9"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "attio"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/danger/Dangerfile

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+# Make it more obvious that a PR is a work in progress and shouldn't be merged yet
+warn("PR is classed as Work in Progress") if github.pr_title.include? "WIP"
+
+# Warn when there is a big PR
+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
+
+# Ensure a clean commit history
+if git.commits.any? { |c| c.message =~ /^fixup!/ }
+  fail("Please squash fixup! commits before merging")
+end
+
+# Check for proper conventional commit format
+if github.pr_title !~ /^(feat|fix|docs|style|refactor|perf|test|chore|ci|build)(\(.+\))?: .+/
+  warn("PR title doesn't follow conventional commit format. Please use format: 'type(scope): description'")
+end
+
+# Ensure description is present for non-trivial changes
+if github.pr_body.length < 10 && git.lines_of_code > 20
+  warn("Please provide a more detailed PR description for changes of this size")
+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
+
+# 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
+  # Skip for certain PR types
+  unless github.pr_title =~ /^(chore|ci|docs|style|test):/
+    warn("Consider updating CHANGELOG.md for this change")
+  end
+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
+  end
+end
+
+# Encourage tests for new features
+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
+
+# Check for debugging code
+debugging_patterns = [
+  "binding.pry",
+  "debugger",
+  "puts",
+  "p ",
+  "pp ",
+  "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}")
+    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
+end
+
+if public_api_changes
+  message("📝 Public API changes detected. Consider updating documentation.")
+end
+
+# Check for secrets or sensitive information
+sensitive_patterns = [
+  /api[_-]?key/i,
+  /secret/i,
+  /password/i,
+  /token/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
+      end
+    end
+  end
+end
+
+# Performance reminders for certain file types
+performance_sensitive_files = git.modified_files.select { |file| file.include?("client") || file.include?("http") }
+if performance_sensitive_files.any?
+  message("⚡ Performance-sensitive files modified. Consider impact on API call efficiency.")
+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