equipoise 0.1.0

data/lib/equipoise.rb

@@ -0,0 +1,92 @@
+# =============================================================================
+# Equipoise (producer gem entrypoint)
+# =============================================================================
+#
+# Thin Ruby client for Equipoise's External CRM Sync API. A "producer" (AMP, a
+# Stripe importer, a spreadsheet job, …) uses it to upsert its people into an
+# Equipoise account's CRM as Contacts. ALL business logic lives server-side in
+# Crm::ContactSyncService — this gem is pure transport (auth header, JSON,
+# bounded retry/backoff, typed errors).
+#
+# api_key and base_url are read from EQUIPOISE_API_KEY / EQUIPOISE_API_URL
+# automatically (rotation-aware — see Configuration); configure just sets the
+# source and any overrides:
+#
+#   Equipoise.configure { |c| c.source = "AMP" }
+#
+#   Equipoise.client.contacts.sync(external_id: user.id, email: user.email, name: user.name, tags: ["AMP"])
+#
+# Contract: documentation/integrations/EXTERNAL_CRM_SYNC_API.openapi.yaml
+# Guide:    documentation/integrations/EXTERNAL_CRM_SYNC.md
+# =============================================================================
+
+require "json"
+require "net/http"
+require "openssl"
+require "uri"
+require "erb"
+require "digest"
+require "time"
+
+require "equipoise/version"
+require "equipoise/util"
+require "equipoise/errors"
+require "equipoise/configuration"
+require "equipoise/response"
+require "equipoise/batch_result"
+require "equipoise/client"
+require "equipoise/contacts"
+require "equipoise/custom_fields"
+
+module Equipoise
+  class << self
+    # — Claude (External CRM Sync, S12): the process-wide configuration. Built
+    # lazily from ENV so a bare `require "equipoise"` is side-effect-free.
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration) if block_given?
+      @client = nil # a re-configure invalidates the memoized client
+      configuration
+    end
+
+    # — Claude authored — memoized default client. Most callers use this; tests
+    # and multi-tenant producers build their own Client with an explicit config.
+    def client
+      @client ||= Client.new(configuration)
+    end
+
+    def configured?
+      !configuration.api_key.to_s.empty?
+    end
+
+    # — Claude authored (#5) — test-mode kill switch. Put `Equipoise.disable!` in
+    # a producer's rails_helper (or set test env) so no spec can make a live call
+    # even if EQUIPOISE_API_KEY leaks into the environment. Calls become no-ops
+    # returning a benign Response.
+    def disable!
+      configuration.enabled = false
+    end
+
+    def enable!
+      configuration.enabled = true
+    end
+
+    def disabled?
+      configuration.disabled?
+    end
+
+    # — Claude authored — reset global state (used by the test suite's before
+    # hook; also handy in a console).
+    def reset!
+      @configuration = nil
+      @client = nil
+    end
+  end
+end
+
+# The Rails add-on (Syncable concern + generator) is opt-in: require it only
+# where wanted so the core gem stays dependency-free.
+require "equipoise/railtie" if defined?(Rails::Railtie)

data/lib/generators/equipoise/install_generator.rb

@@ -0,0 +1,25 @@
+# =============================================================================
+# Equipoise::Generators::InstallGenerator
+# =============================================================================
+#
+# `rails g equipoise:install` — drops a config/initializers/equipoise.rb that
+# wires Equipoise.configure from the environment. Run once in a producer app.
+#
+# Used by: producer Rails apps (e.g. AMP)
+# =============================================================================
+
+require "rails/generators/base"
+
+module Equipoise
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Creates an Equipoise initializer at config/initializers/equipoise.rb"
+
+      def copy_initializer
+        template "equipoise.rb", "config/initializers/equipoise.rb"
+      end
+    end
+  end
+end

data/lib/generators/equipoise/templates/equipoise.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# =============================================================================
+# Equipoise External CRM Sync — producer configuration
+# =============================================================================
+#
+# Generated by `rails g equipoise:install`. Reads credentials from the
+# environment so secrets stay out of source control and key rotation needs no
+# redeploy. See documentation/integrations/EXTERNAL_CRM_SYNC.md.
+
+Equipoise.configure do |config|
+  # api_key and base_url are read from EQUIPOISE_API_KEY / EQUIPOISE_API_URL
+  # automatically and are rotation-aware — a rotated EQUIPOISE_API_KEY is picked
+  # up on the next request with no redeploy. Assign config.api_key here only to
+  # source the secret elsewhere (an explicit value is captured, not re-read).
+  config.source = "myapp" # this producer's source id (case-sensitive)
+
+  # config.base_url           = "https://app.equipoi.se/api/v1" # override only if needed
+  # config.logger             = Rails.logger                    # logs retries + failures
+  # config.max_retries        = 2
+  # config.allow_insecure_http = true                           # trusted internal HTTP endpoint
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: equipoise
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Equipoise
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: A thin, dependency-free transport for syncing a producer's people into
+  an Equipoise account's CRM as Contacts. All business logic lives server-side; this
+  gem handles auth, JSON, bounded retry/backoff, idempotency, and typed errors.
+email:
+- jay@mindtonic.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- NOTICE
+- README.md
+- lib/equipoise.rb
+- lib/equipoise/batch_result.rb
+- lib/equipoise/client.rb
+- lib/equipoise/configuration.rb
+- lib/equipoise/contacts.rb
+- lib/equipoise/custom_fields.rb
+- lib/equipoise/errors.rb
+- lib/equipoise/railtie.rb
+- lib/equipoise/response.rb
+- lib/equipoise/syncable.rb
+- lib/equipoise/util.rb
+- lib/equipoise/version.rb
+- lib/generators/equipoise/install_generator.rb
+- lib/generators/equipoise/templates/equipoise.rb
+homepage: https://app.equipoi.se
+licenses:
+- Apache-2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Ruby client for the Equipoise External CRM Sync API.
+test_files: []