elasticfin 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7ae623a3e2be66ba717462a42e6c20d7234fd26ad40d6bc57f01371260ce1e1
-  data.tar.gz: e36d8a4452b4050026930d429288b974bfcb917932e9540a196c8ac5e7276452
+  metadata.gz: 6cf1202e392aa22187ef6aadf489a4c79ae1ebf595347e1f1b6f559f7e814acc
+  data.tar.gz: 8ada24734f3e69162cfb062f3309987c0d74e076be05e4f2e68dd51f8599aeae
 SHA512:
-  metadata.gz: e7dee0a2344cbf4a3acd7e6e93fe605d1b8ab58afb9776a2836b3bc3a34b72d75e852056aa5174f282eb3611e4a2e1115bc5bd3909fd45728cd09d2ed334c291
-  data.tar.gz: 3a749e9147315dd2ed6043519f71a44e46e1bb295c7b65106fdf2661d67c237752a482c51df30d7241569ffbfe89e96f312029304fc77f9c0b680edd2a0170d9
+  metadata.gz: 973de4dc109f63a9818bf4e0dbd876255b0e9f6a57f4c17a2efbd578547f88e5d8c4abbeff167a8982f69d7331bd1d3deaabddf214e8aec36c35e64f8b6646a0
+  data.tar.gz: 365489562e0b799b2b86b94b1a840f26cd20a3abd0b2592727b0acb7a3e2d139b392b0839f8335b297067a33887bb44a5b4351bccd3b9a8b95792f511f8766f6

data/README.md

@@ -1,8 +1,8 @@
 # Elasticfin
 
-Ruby wrapper for ElasticFin API
+Ruby gem for Elasticfin billing and subscription management.
 
-## Setup
+## Installation
 
 Add to Gemfile:
 
@@ -10,51 +10,98 @@ Add to Gemfile:
 gem 'elasticfin'
 ```
 
-Set your API key in env:
+Set your API key:
 
 ```
 ELASTICFIN_KEY=your_key_here
 ```
 
+## Setup
+
+Add to your customer model:
+
+```ruby
+class User < ApplicationRecord
+  elasticfin_billable
+end
+```
+
+By default uses `:id` for external_id and auto-detects `:email` or `:email_address`.
+
+**Options:**
+
+```ruby
+elasticfin_billable external_id: :uuid, email: :contact_email
+```
+
+**Auto-sync on create/update:**
+
+```ruby
+elasticfin_billable auto_sync: true
+```
+
+This automatically syncs customers to Elasticfin when created or when email/external_id changes.
+
 ## Usage
 
-### Check entitlements
+All methods are called on instances of your billable model:
+
+```ruby
+customer = User.find(1)
+customer.elasticfin_has_entitlement?("premium")
+
+# Or with Current attributes
+Current.user.elasticfin_checkout_url(price_id: "price_xxx")
+
+# Works with any model name (User, Team, Account, etc)
+team = Team.find(5)
+team.elasticfin_billing_portal_url(return_url: "/settings")
+```
+
+### Sync Customers
+
+Sync all customers to Elasticfin:
+
+```ruby
+Elasticfin.sync_customers
+```
+
+Sync a single customer:
 
 ```ruby
-Elasticfin.customer.has_entitlement?(team_id, "premium")
+user.elasticfin_sync
 ```
 
-### Create checkout
+### Check Entitlements
 
 ```ruby
-url = Elasticfin.checkout.create_session(team_id, email, price_id)
+user.elasticfin_has_entitlement?("premium")
 ```
 
-### Billing portal
+### Create Checkout
 
 ```ruby
-url = Elasticfin.billing.portal_url(team_id, return_url)
+checkout_url = user.elasticfin_checkout_url(price_id: "price_xxx")
 ```
 
-### Change plan
+### Billing Portal
 
 ```ruby
-url = Elasticfin.billing.change_plan_url(team_id, price_id, return_url)
+portal_url = user.elasticfin_billing_portal_url(return_url: "https://yourapp.com/settings")
 ```
 
-### Get customer info
+### Change Plan
 
 ```ruby
-provider = Elasticfin.customer.provider(team_id)
-interval = Elasticfin.customer.interval(team_id)
+change_url = user.elasticfin_change_plan_url(
+  price_id: "price_yyy",
+  return_url: "https://yourapp.com/settings"
+)
 ```
 
-### Import customers
+### Get Customer Info
 
 ```ruby
-result = Elasticfin.customer.import([
-  { external_id: "cust_1", email: "user1@example.com" },
-  { external_id: "cust_2", email: "user2@example.com" }
-])
-# Returns: { imported_count: 2, total_count: 2, errors: [] }
+provider = user.elasticfin_provider  # "stripe", etc
+interval = user.elasticfin_interval  # "month", "year", etc
 ```

data/lib/elasticfin/billable.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module Elasticfin
+  module Billable
+    def elasticfin_billable(external_id: :id, email: nil, auto_sync: false)
+      include InstanceMethods
+      extend ClassMethods
+
+      # Auto-detect email field if not provided
+      email_field = email || detect_email_field
+
+      # Store field configurations
+      class_variable_set(:@@elasticfin_external_id_field, external_id)
+      class_variable_set(:@@elasticfin_email_field, email_field)
+
+      # Register this model with Elasticfin
+      Elasticfin.register_billable_model(self)
+
+      # Add auto-sync callbacks if enabled
+      if auto_sync
+        after_create :elasticfin_sync
+        after_update :elasticfin_sync_if_changed
+      end
+    end
+
+    def self.detect_email_field
+      if column_names.include?("email")
+        :email
+      elsif column_names.include?("email_address")
+        :email_address
+      else
+        raise Elasticfin::Error, "No email field found. Specify email field with: elasticfin_billable email: :your_email_field"
+      end
+    end
+
+    module ClassMethods
+      def elasticfin_sync_all
+        Elasticfin.sync_customers
+      end
+
+      def elasticfin_external_id_field
+        class_variable_get(:@@elasticfin_external_id_field)
+      end
+
+      def elasticfin_email_field
+        class_variable_get(:@@elasticfin_email_field)
+      end
+
+      private
+
+      def detect_email_field
+        if column_names.include?("email")
+          :email
+        elsif column_names.include?("email_address")
+          :email_address
+        else
+          raise Elasticfin::Error, "No email field found. Specify email field with: elasticfin_billable email: :your_email_field"
+        end
+      end
+    end
+
+    module InstanceMethods
+      def elasticfin_external_id
+        send(self.class.elasticfin_external_id_field)
+      end
+
+      def elasticfin_email
+        send(self.class.elasticfin_email_field)
+      end
+
+      def elasticfin_sync
+        Elasticfin.sync_customer(self)
+      end
+
+      def elasticfin_sync_if_changed
+        id_field = self.class.elasticfin_external_id_field
+        email_field = self.class.elasticfin_email_field
+
+        if saved_change_to_attribute?(id_field) || saved_change_to_attribute?(email_field)
+          elasticfin_sync
+        end
+      end
+
+      # Checkout
+      def elasticfin_checkout_url(price_id:)
+        Elasticfin.checkout.create_session(
+          elasticfin_external_id.to_s,
+          elasticfin_email,
+          price_id
+        )
+      end
+
+      # Entitlements
+      def elasticfin_has_entitlement?(entitlement_name)
+        Elasticfin.customer.has_entitlement?(
+          elasticfin_external_id.to_s,
+          entitlement_name
+        )
+      end
+
+      # Billing
+      def elasticfin_billing_portal_url(return_url:)
+        Elasticfin.billing.portal_url(
+          elasticfin_external_id.to_s,
+          return_url
+        )
+      end
+
+      def elasticfin_change_plan_url(price_id:, return_url:)
+        Elasticfin.billing.change_plan_url(
+          elasticfin_external_id.to_s,
+          price_id,
+          return_url
+        )
+      end
+
+      # Customer info
+      def elasticfin_provider
+        Elasticfin.customer.provider(elasticfin_external_id.to_s)
+      end
+
+      def elasticfin_interval
+        Elasticfin.customer.interval(elasticfin_external_id.to_s)
+      end
+    end
+  end
+end

data/lib/elasticfin/configuration.rb

@@ -10,6 +10,8 @@ module Elasticfin
   end
 
   class << self
+    attr_accessor :billable_model
+
     def configuration
       @configuration ||= Configuration.new
     end
@@ -37,5 +39,34 @@ module Elasticfin
     def billing
       client.billing
     end
+
+    def register_billable_model(model)
+      if @billable_model && @billable_model != model
+        raise Error, "Billable model already registered as #{@billable_model.name}. Only one model can use elasticfin_billable."
+      end
+      @billable_model = model
+    end
+
+    def sync_customers
+      raise Error, "No billable model registered. Add elasticfin_billable to your model." unless billable_model
+
+      customers_data = billable_model.all.map do |record|
+        {
+          external_id: record.elasticfin_external_id.to_s,
+          email: record.elasticfin_email
+        }
+      end
+
+      customer.import(customers_data)
+    end
+
+    def sync_customer(record)
+      customer_data = [{
+        external_id: record.elasticfin_external_id.to_s,
+        email: record.elasticfin_email
+      }]
+
+      customer.import(customer_data)
+    end
   end
 end

data/lib/elasticfin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Elasticfin
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

data/lib/elasticfin.rb

@@ -6,7 +6,13 @@ require_relative "elasticfin/resources/customer"
 require_relative "elasticfin/resources/checkout"
 require_relative "elasticfin/resources/billing"
 require_relative "elasticfin/configuration"
+require_relative "elasticfin/billable"
 
 module Elasticfin
   class Error < StandardError; end
 end
+
+# Extend ActiveRecord::Base to make elasticfin_billable available on all models
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.extend Elasticfin::Billable
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticfin
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - elasticfin
@@ -20,6 +20,7 @@ files:
 - README.md
 - Rakefile
 - lib/elasticfin.rb
+- lib/elasticfin/billable.rb
 - lib/elasticfin/client.rb
 - lib/elasticfin/configuration.rb
 - lib/elasticfin/resources/billing.rb