attio-rails 0.1.0

data/lib/attio/rails/configuration.rb

@@ -0,0 +1,55 @@
+module Attio
+  module Rails
+    class Configuration
+      attr_accessor :api_key, :default_workspace_id, :logger, :sync_enabled, :background_sync
+
+      def initialize
+        @api_key = ENV['ATTIO_API_KEY']
+        @default_workspace_id = nil
+        @logger = defined?(::Rails) ? ::Rails.logger : Logger.new(STDOUT)
+        @sync_enabled = true
+        @background_sync = true
+      end
+
+      def valid?
+        !api_key.nil? && !api_key.empty?
+      end
+    end
+
+    class << self
+      attr_writer :configuration
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def configure
+        yield(configuration)
+        reset_client!
+      end
+
+      def client
+        raise ConfigurationError, "Attio API key not configured" unless configuration.valid?
+        @client ||= ::Attio.client(api_key: configuration.api_key)
+      end
+
+      def reset_client!
+        @client = nil
+      end
+
+      def sync_enabled?
+        configuration.sync_enabled
+      end
+
+      def background_sync?
+        configuration.background_sync
+      end
+
+      def logger
+        configuration.logger
+      end
+    end
+
+    class ConfigurationError < StandardError; end
+  end
+end

data/lib/attio/rails/railtie.rb

@@ -0,0 +1,15 @@
+module Attio
+  module Rails
+    class Railtie < ::Rails::Railtie
+      initializer "attio.configure_rails_initialization" do
+        ActiveSupport.on_load(:active_record) do
+          require 'attio/rails/concerns/syncable'
+        end
+      end
+
+      generators do
+        require 'generators/attio/install/install_generator'
+      end
+    end
+  end
+end

data/lib/attio/rails/version.rb

@@ -0,0 +1,5 @@
+module Attio
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

data/lib/attio/rails.rb

@@ -0,0 +1,13 @@
+require "attio"
+require "rails"
+require "active_support"
+
+require "attio/rails/version"
+require "attio/rails/configuration"
+require "attio/rails/railtie"
+
+module Attio
+  module Rails
+    class Error < StandardError; end
+  end
+end

data/lib/generators/attio/install/install_generator.rb

@@ -0,0 +1,65 @@
+require 'rails/generators/base'
+
+module Attio
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+      
+      class_option :skip_job, type: :boolean, default: false, desc: "Skip creating the sync job"
+      class_option :skip_migration, type: :boolean, default: false, desc: "Skip creating the migration"
+
+      def check_requirements
+        unless defined?(ActiveJob)
+          say "Warning: ActiveJob is not available. Skipping job creation.", :yellow
+          @skip_job = true
+        end
+      end
+
+      def create_initializer
+        template 'attio.rb', 'config/initializers/attio.rb'
+      end
+
+      def create_migration
+        return if options[:skip_migration]
+        
+        if defined?(ActiveRecord)
+          migration_template 'migration.rb', 'db/migrate/add_attio_record_id_to_tables.rb'
+        else
+          say "ActiveRecord not detected. Skipping migration.", :yellow
+        end
+      end
+
+      def create_sync_job
+        return if options[:skip_job] || @skip_job
+        
+        template 'attio_sync_job.rb', 'app/jobs/attio_sync_job.rb'
+      end
+
+      def add_to_gemfile
+        gem_group :production do
+          gem 'attio-rails'
+        end unless gemfile_contains?('attio-rails')
+      end
+
+      def display_readme
+        readme 'README.md'
+      end
+
+      private
+
+      def gemfile_contains?(gem_name)
+        File.read('Gemfile').include?(gem_name)
+      rescue
+        false
+      end
+
+      def rails_version
+        Rails::VERSION::STRING
+      end
+
+      def migration_version
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+      end
+    end
+  end
+end

data/lib/generators/attio/install/templates/README.md

@@ -0,0 +1,39 @@
+# Attio Rails Setup
+
+The Attio Rails gem has been installed and configured!
+
+## Next Steps
+
+1. Set your Attio API key in your environment variables:
+   ```
+   ATTIO_API_KEY=your_api_key_here
+   ```
+
+2. Add the Syncable concern to models you want to sync with Attio:
+   ```ruby
+   class User < ApplicationRecord
+     include Attio::Rails::Concerns::Syncable
+     
+     syncs_with_attio 'users', {
+       email: :email,
+       name: :full_name,
+       company: -> (user) { user.company.name }
+     }
+   end
+   ```
+
+3. Run migrations to add the attio_record_id column to your models:
+   ```
+   rails db:migrate
+   ```
+
+4. Your models will now automatically sync to Attio on create, update, and destroy!
+
+## Manual Sync
+
+You can also manually trigger syncs:
+```ruby
+user.sync_to_attio
+```
+
+For more information, visit: https://github.com/your-username/attio-ruby

data/lib/generators/attio/install/templates/attio.rb

@@ -0,0 +1,7 @@
+Attio::Rails.configure do |config|
+  # Set your Attio API key
+  config.api_key = ENV['ATTIO_API_KEY']
+  
+  # Optional: Set a default workspace ID
+  # config.default_workspace_id = 'your-workspace-id'
+end

data/lib/generators/attio/install/templates/attio_sync_job.rb

@@ -0,0 +1,63 @@
+class AttioSyncJob < ApplicationJob
+  queue_as :low
+  
+  retry_on Attio::RateLimitError, wait: 1.minute, attempts: 3
+  retry_on Attio::ServerError, wait: :exponentially_longer, attempts: 5
+  discard_on ActiveJob::DeserializationError
+
+  def perform(model_name:, model_id:, action:, attio_record_id: nil)
+    return unless Attio::Rails.sync_enabled?
+    
+    model_class = model_name.constantize
+    
+    case action
+    when :sync
+      sync_record(model_class, model_id)
+    when :delete
+      delete_record(model_class, model_id, attio_record_id)
+    else
+      Attio::Rails.logger.error "Unknown Attio sync action: #{action}"
+    end
+  rescue Attio::AuthenticationError => e
+    Attio::Rails.logger.error "Attio authentication failed: #{e.message}"
+    raise # Re-raise to trigger job failure notifications
+  rescue Attio::ValidationError => e
+    Attio::Rails.logger.error "Attio validation error for #{model_name}##{model_id}: #{e.message}"
+    # Don't retry validation errors
+  rescue StandardError => e
+    Attio::Rails.logger.error "Attio sync failed for #{model_name}##{model_id}: #{e.message}"
+    Attio::Rails.logger.error e.backtrace.join("\n") if Rails.env.development?
+    raise e
+  end
+
+  private
+
+  def sync_record(model_class, model_id)
+    model = model_class.find_by(id: model_id)
+    return unless model
+    
+    # Check if model should still be synced
+    return unless model.should_sync_to_attio?
+    
+    model.sync_to_attio_now
+  end
+
+  def delete_record(model_class, model_id, attio_record_id)
+    return unless attio_record_id.present?
+
+    # Model might already be deleted, so we work with the class
+    object_type = model_class.attio_object_type
+    return unless object_type.present?
+
+    client = Attio::Rails.client
+    client.records.delete(
+      object: object_type,
+      id: attio_record_id
+    )
+    
+    Attio::Rails.logger.info "Deleted Attio record #{attio_record_id} for #{model_class.name}##{model_id}"
+  rescue Attio::NotFoundError
+    # Record already deleted in Attio, nothing to do
+    Attio::Rails.logger.info "Attio record #{attio_record_id} already deleted"
+  end
+end

data/lib/generators/attio/install/templates/migration.rb

@@ -0,0 +1,11 @@
+class AddAttioRecordIdToTables < ActiveRecord::Migration<%= migration_version %>
+  def change
+    # Add attio_record_id to each table that needs to sync with Attio
+    # Example:
+    # add_column :users, :attio_record_id, :string
+    # add_index :users, :attio_record_id
+    #
+    # add_column :companies, :attio_record_id, :string
+    # add_index :companies, :attio_record_id
+  end
+end

data/test_basic.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+# Test without loading external dependencies
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+$LOAD_PATH.unshift(File.expand_path('../../attio/lib', __FILE__))
+
+puts "Testing Attio Rails gem structure..."
+
+# Test version file
+require 'attio/rails/version'
+puts "✓ Version loaded: #{Attio::Rails::VERSION}"
+
+# Test that all files exist
+files_to_check = [
+  'lib/attio/rails.rb',
+  'lib/attio/rails/configuration.rb',
+  'lib/attio/rails/concerns/syncable.rb',
+  'lib/attio/rails/railtie.rb',
+  'lib/generators/attio/install/install_generator.rb',
+  'lib/generators/attio/install/templates/attio.rb',
+  'lib/generators/attio/install/templates/attio_sync_job.rb',
+  'lib/generators/attio/install/templates/migration.rb',
+  'lib/generators/attio/install/templates/README.md'
+]
+
+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!"

metadata

@@ -0,0 +1,229 @@
+--- !ruby/object:Gem::Specification
+name: attio-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ernest Sim
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: attio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  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'
+- !ruby/object:Gem::Dependency
+  name: danger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.4'
+description: Rails-specific features and integrations for the Attio Ruby client, including
+  model concerns and generators
+email:
+- ernest.codes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/docs.yml"
+- ".github/workflows/release.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".yardopts"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- SECURITY.md
+- attio-rails.gemspec
+- bin/console
+- bin/setup
+- docs/index.html
+- lib/attio/rails.rb
+- lib/attio/rails/concerns/syncable.rb
+- lib/attio/rails/configuration.rb
+- lib/attio/rails/railtie.rb
+- lib/attio/rails/version.rb
+- lib/generators/attio/install/install_generator.rb
+- lib/generators/attio/install/templates/README.md
+- lib/generators/attio/install/templates/attio.rb
+- lib/generators/attio/install/templates/attio_sync_job.rb
+- lib/generators/attio/install/templates/migration.rb
+- test_basic.rb
+homepage: https://github.com/idl3/attio-rails
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/idl3/attio-rails
+  source_code_uri: https://github.com/idl3/attio-rails
+  changelog_uri: https://github.com/idl3/attio-rails/blob/main/CHANGELOG.md
+  documentation_uri: https://idl3.github.io/attio-rails
+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: Rails integration for the Attio API client
+test_files: []