metrifox-sdk 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd2f3f03c15f2b2706851f83e95ddab68004fb5bf722201eae1301e2e5eb0ce9
-  data.tar.gz: 4cc5c6d239788de18628f4a929a2d6a328816ad74372afdf703e0f5993c87f78
+  metadata.gz: 1dff9fd808bc32d6349ca7a116713b9985ed31e1bd77bf49fd52d96d72ebedb3
+  data.tar.gz: 03364bfa5c26be341eee0ba665bef63913e1992ad82edd0d14123fdb1e21d607
 SHA512:
-  metadata.gz: d429ea4b6554d8da627f4b98687eadf40a02c6cc6a5b98cf8a528cb0f9eb171c16463a530dac6646d63927591080a77f40632ddf71c532cc664abcf5155694ea
-  data.tar.gz: 78b222b28144cfef43f03f26941764fd914bcbfa6d80f5423b6d107833700ab9d6dd55aecc2075e43d927261a5e470bab43bfb8d3c27a9290b1cc9e00b7aae06
+  metadata.gz: ffe66393b2b92925c2f3dc15cc699b7129ca06fa8baf7a06eb73fc635637d2c42a8c193a94ca17a1f2405aa7e119a6725c3de225ef779db58301ac05367cebaf
+  data.tar.gz: e271a28735a68ce97be07578c748fd8e01247bdbb633112fbcdd664a1a945c028adac9f549d776e7cc452fd4d68520df7292f3ee30595477d1266f58afbc070b

data/CHANGELOG.md

@@ -3,10 +3,11 @@
 All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
+- Update usage access and recording to call the meter service (`https://api-meter.metrifox.com`).
 
-## [1.0.0] - 2025-09-01
+## [1.0.3] - 2025-09-01
 - Initial release
 - Access control functionality
 - Usage tracking
 - Customer management
-- CSV upload support
+- CSV upload support

data/README.md

@@ -35,6 +35,7 @@ METRIFOX_SDK = MetrifoxSDK.init({ api_key: "your-api-key"})
 # Or set environment variable
 ENV["METRIFOX_API_KEY"] = "your-api-key"
 METRIFOX_SDK = MetrifoxSDK.init
+
 ```
 
 ### Access Control
@@ -46,7 +47,28 @@ response = METRIFOX_SDK.usages.check_access({
   customer_key: "customer_123"
 })
 
-puts response["can_access"] # true/false
+puts response["data"]["can_access"] # true/false
+```
+
+> Access checks are now served by the Metrifox Meter service (`https://api-meter.metrifox.com`).
+Example response payload:
+
+```json
+{
+  "data": {
+    "customer_key": "cust-mit7k5v8obzs",
+    "feature_key": "feature_seats",
+    "requested_quantity": 1,
+    "can_access": true,
+    "unlimited": false,
+    "balance": 4,
+    "used_quantity": 0,
+    "entitlement_active": true,
+    "prepaid": false,
+    "wallet_balance": 0,
+    "message": "Feature found"
+  }
+}
 ```
 
 ### Usage Tracking
@@ -56,17 +78,27 @@ puts response["can_access"] # true/false
 response = METRIFOX_SDK.usages.record_usage({
   customer_key: "customer_123",
   event_name: "api_call",
-  amount: 1
+  amount: 1,
+  event_id: "evt_12345", # required idempotency key
+  timestamp: (Time.now.to_f * 1000).to_i # recommended (milliseconds)
 })
+puts response["message"] # "Event received"
+puts response["data"]["quantity"] # 1
+```
+
+The usage event endpoint now returns a simple payload with the recorded `data` and a `message` confirming the event reception.
+
+> You can send either an `event_name` or a `feature_key` when recording usage events.
 
+```ruby
 # Advanced usage recording with additional fields
 response = METRIFOX_SDK.usages.record_usage({
   customer_key: "customer_123",
-  event_name: "api_call",
+  event_name: "api_call", # Or use feature_key
   amount: 1,
+  event_id: "event_uuid_123", # required idempotency key
   credit_used: 5,
-  event_id: "event_uuid_123",
-  timestamp: 1640995200,
+  timestamp: (Time.now.to_f * 1000).to_i,
   metadata: {
     source: "web_app",
     feature: "premium_search"
@@ -76,23 +108,36 @@ response = METRIFOX_SDK.usages.record_usage({
 # Using structured request object
 usage_request = MetrifoxSDK::Types::UsageEventRequest.new(
   customer_key: "customer_123",
-  event_name: "api_call",
+  feature_key: "feat_my_feat_234", # OR use event_name
   amount: 1,
   credit_used: 5,
   event_id: "event_uuid_123",
-  timestamp: Time.now.to_i,
+  timestamp: (Time.now.to_f * 1000).to_i,
   metadata: { source: "mobile_app" }
 )
 
 response = METRIFOX_SDK.usages.record_usage(usage_request)
 ```
 
+Sample response body:
+
+```json
+{
+  "data": {
+    "customer_key": "cust-mit7k5v8obzs",
+    "quantity": 1,
+    "feature_key": "feature_job_posts"
+  },
+  "message": "Event received"
+}
+```
+
 ### Customer Management
 
 ```ruby
-# Create customer
+# Create customer (customer_key is REQUIRED)
 customer_data = {
-  customer_key: "customer_123",
+  customer_key: "customer_123",  # Required - unique identifier for the customer
   customer_type: "BUSINESS",
   primary_email: "customer@example.com",
   legal_name: "Acme Corp",
@@ -101,10 +146,11 @@ customer_data = {
 
 response = METRIFOX_SDK.customers.create(customer_data)
 
-# Update customer
+# Update customer (customer_key cannot be changed and is passed as a parameter)
 update_data = {
   display_name: "ACME Corporation",
   website_url: "https://acme.com"
+  # Note: customer_key is NOT included here - it's immutable
 }
 
 response = METRIFOX_SDK.customers.update("customer_123", update_data)
@@ -115,6 +161,10 @@ response = METRIFOX_SDK.customers.get_customer({ customer_key: "customer_123" })
 # Get customer details
 response = METRIFOX_SDK.customers.get_details({ customer_key: "customer_123" })
 
+# Check for an active subscription
+has_active_subscription = MetrifoxSDK.customers.has_active_subscription?(customer_key: "customer_123")
+puts has_active_subscription # true or false
+
 # List customers
 response = METRIFOX_SDK.customers.list
 
@@ -194,26 +244,29 @@ response = METRIFOX_SDK.usages.check_access({
 
 ## Type Safety with Structs
 
-The SDK provides structured types for better type safety:
+The SDK exposes lightweight structs for the usage and checkout helpers when you want a bit more structure:
 
 ```ruby
-# Using structured request objects
-access_request = MetrifoxSDK::Types::AccessCheckRequest.new(
-  feature_key: "premium_feature",
-  customer_key: "customer_123"
+# Usage events (event_id required for idempotency)
+usage_request = MetrifoxSDK::Types::UsageEventRequest.new(
+  customer_key: "customer_123",
+  feature_key: "feature_seats",
+  amount: 1,
+  event_id: "event_uuid_123",
+  timestamp: (Time.now.to_f * 1000).to_i,
+  metadata: { source: "mobile_app" }
 )
 
-response = METRIFOX_SDK.usages.check_access(access_request)
+response = METRIFOX_SDK.usages.record_usage(usage_request)
 
-# Customer creation with structured data
-customer_request = MetrifoxSDK::Types::CustomerCreateRequest.new(
-  customer_key: "customer_123",
-  customer_type: MetrifoxSDK::Types::CustomerType::BUSINESS,
-  primary_email: "customer@example.com",
-  legal_name: "Acme Corp"
+# Checkout configuration
+checkout_config = MetrifoxSDK::Types::CheckoutConfig.new(
+  offering_key: "premium_plan",
+  billing_interval: "monthly",
+  customer_key: "customer_123"
 )
 
-response = METRIFOX_SDK.customers.create(customer_request)
+checkout_url = METRIFOX_SDK.checkout.url(checkout_config)
 ```
 
 ## Error Handling

data/lib/metrifox_sdk/checkout/api.rb

@@ -11,5 +11,13 @@ module MetrifoxSDK::Checkout
       data = parse_response(response, "Failed to get tenant checkout settings")
       data.dig("data", "checkout_username")
     end
+
+    def generate_checkout_url(base_url, api_key, query_params)
+      uri = URI.join(base_url, "products/offerings/generate-checkout-url")
+      uri.query = URI.encode_www_form(query_params)
+      response = make_request(uri, "GET", api_key)
+      data = parse_response(response, "Failed to generate checkout URL")
+      data.dig("data", "checkout_url")
+    end
   end
 end

data/lib/metrifox_sdk/checkout/module.rb

@@ -6,7 +6,7 @@ module MetrifoxSDK
     class Module < BaseModule
       def url(config)
         validate_api_key!
-        
+
         # Handle both hash and struct access patterns
         offering_key = get_value(config, :offering_key)
         billing_interval = get_value(config, :billing_interval)
@@ -14,20 +14,16 @@ module MetrifoxSDK
 
         raise ArgumentError, "offering_key is required" if offering_key.nil? || offering_key.empty?
 
-        checkout_key = get_checkout_key
-        raise StandardError, "Checkout Key could not be retrieved. Ensure the API key is valid" if checkout_key.nil? || checkout_key.empty?
-
-        url_string = "#{web_app_base_url}/#{checkout_key}/checkout/#{offering_key}"
-        uri = URI(url_string)
-        
-        # Add query parameters if provided
-        query_params = {}
-        query_params["billing_period"] = billing_interval if billing_interval && !billing_interval.empty?
-        query_params["customer"] = customer_key if customer_key && !customer_key.empty?
-        
-        uri.query = URI.encode_www_form(query_params) unless query_params.empty?
-        
-        uri.to_s
+        # Build query parameters
+        query_params = { offering_key: offering_key }
+        query_params[:billing_interval] = billing_interval if billing_interval && !billing_interval.empty?
+        query_params[:customer_key] = customer_key if customer_key && !customer_key.empty?
+
+        # Call API to generate checkout URL
+        checkout_url = api.generate_checkout_url(base_url, api_key, query_params)
+        raise StandardError, "Checkout URL could not be generated" if checkout_url.nil? || checkout_url.empty?
+
+        checkout_url
       end
 
       private

data/lib/metrifox_sdk/client.rb

@@ -4,13 +4,18 @@ module MetrifoxSDK
   class Client
     include MetrifoxSDK::UtilMethods
 
-    attr_reader :config, :api_key, :base_url, :web_app_base_url
+    DEFAULT_BASE_URL = "https://api.metrifox.com/api/v1/".freeze
+    DEFAULT_WEB_APP_BASE_URL = "https://app.metrifox.com".freeze
+    METER_SERVICE_BASE_URL = "https://api-meter.metrifox.com/".freeze
+
+    attr_reader :config, :api_key, :base_url, :web_app_base_url, :meter_service_base_url
 
     def initialize(config = {})
       @config = config
       @api_key = config[:api_key] || get_api_key_from_environment
-      @base_url = config[:base_url] || "https://api.metrifox.com/api/v1/"
-      @web_app_base_url = config[:web_app_base_url] || "https://app.metrifox.com"
+      @base_url = config[:base_url] || DEFAULT_BASE_URL
+      @web_app_base_url = config[:web_app_base_url] || DEFAULT_WEB_APP_BASE_URL
+      @meter_service_base_url = METER_SERVICE_BASE_URL
     end
 
     def customers

data/lib/metrifox_sdk/customers/api.rb

@@ -41,6 +41,12 @@ module MetrifoxSDK::Customers
       parse_response(response, "Failed to Fetch Customer Details")
     end
 
+    def customer_active_subscription_request(base_url, api_key, customer_key)
+      uri = URI.join(base_url, "customers/#{customer_key}/check-active-subscription")
+      response = make_request(uri, "GET", api_key)
+      parse_response(response, "Failed to Check Active Subscription")
+    end
+
     def customer_list_request(base_url, api_key, request_payload = {})
       uri = URI.join(base_url, "customers")
       
@@ -110,4 +116,4 @@ module MetrifoxSDK::Customers
       end
     end
   end
-end
+end

data/lib/metrifox_sdk/customers/module.rb

@@ -19,16 +19,31 @@ module MetrifoxSDK
         api.customer_get_request(base_url, api_key, request_payload)
       end
 
+      def get(request_payload)
+        get_customer(request_payload)
+      end
+
       def get_details(request_payload)
         validate_api_key!
         api.customer_details_get_request(base_url, api_key, request_payload)
       end
 
+      def has_active_subscription?(customer_key:)
+        validate_api_key!
+        result = api.customer_active_subscription_request(base_url, api_key, customer_key)
+        data = result["data"] || {}
+        data["has_active_subscription"]
+      end
+
       def delete_customer(request_payload)
         validate_api_key!
         api.customer_delete_request(base_url, api_key, request_payload)
       end
 
+      def delete(request_payload)
+        delete_customer(request_payload)
+      end
+
       def list(request_payload = {})
         validate_api_key!
         api.customer_list_request(base_url, api_key, request_payload)
@@ -46,4 +61,4 @@ module MetrifoxSDK
       end
     end
   end
-end
+end

data/lib/metrifox_sdk/types.rb

@@ -1,115 +1,14 @@
 module MetrifoxSDK
   module Types
-    # Enums
-    module TaxStatus
-      TAXABLE = "TAXABLE"
-      TAX_EXEMPT = "TAX_EXEMPT"
-      REVERSE_CHARGE = "REVERSE_CHARGE"
-    end
-
-    module CustomerType
-      BUSINESS = "BUSINESS"
-      INDIVIDUAL = "INDIVIDUAL"
-    end
-
-    # Value objects / Structs
-    EmailAddress = Struct.new(:email, :is_primary, keyword_init: true)
-    PhoneNumber = Struct.new(:phone_number, :country_code, :is_primary, keyword_init: true)
-
-    Address = Struct.new(
-      :country, :address_line_one, :address_line_two, :city,
-      :state, :zip_code, :phone_number, keyword_init: true
-    )
-
-    BillingConfig = Struct.new(
-      :preferred_payment_gateway, :preferred_payment_method, :billing_email,
-      :billing_address, :payment_reminder_days, keyword_init: true
-    )
-
-    TaxIdentification = Struct.new(:type, :number, :country, keyword_init: true)
-
-    ContactPerson = Struct.new(
-      :first_name, :last_name, :email_address, :designation,
-      :department, :is_primary, :phone_number, keyword_init: true
-    )
-
-    PaymentTerm = Struct.new(:type, :value, keyword_init: true)
-
-    # Request/Response objects
-    AccessCheckRequest = Struct.new(:feature_key, :customer_key, keyword_init: true)
-
-    AccessResponse = Struct.new(
-      :message, :can_access, :customer_id, :feature_key, :required_quantity,
-      :used_quantity, :included_usage, :next_reset_at, :quota, :unlimited,
-      :carryover_quantity, :balance, keyword_init: true
-    )
-
     UsageEventRequest = Struct.new(
-      :customer_key, :event_name, :amount, :credit_used, :event_id, :timestamp, :metadata,
+      :customer_key, :event_name, :feature_key, :amount, :credit_used, :event_id, :timestamp, :metadata,
       keyword_init: true
     ) do
-      def initialize(customer_key:, event_name:, amount: 1, credit_used: nil, event_id: nil, timestamp: nil, metadata: {})
+      def initialize(customer_key:, event_name: nil, feature_key: nil, amount: 1, credit_used: nil, event_id: nil, timestamp: nil, metadata: {})
         super
       end
     end
 
-    UsageEventResponse = Struct.new(:message, :event_name, :customer_key, keyword_init: true)
-
-    CustomerCreateRequest = Struct.new(
-      # Core fields
-      :customer_key, :customer_type, :primary_email, :primary_phone,
-      # Business fields
-      :legal_name, :display_name, :legal_number, :tax_identification_number,
-      :logo_url, :website_url, :account_manager,
-      # Individual fields
-      :first_name, :middle_name, :last_name, :date_of_birth, :billing_email,
-      # Preferences
-      :timezone, :language, :currency, :tax_status,
-      # Address fields
-      :address_line1, :address_line2, :city, :state, :country, :zip_code,
-      # Shipping address fields
-      :shipping_address_line1, :shipping_address_line2, :shipping_city,
-      :shipping_state, :shipping_country, :shipping_zip_code,
-      # Complex fields
-      :billing_configuration, :tax_identifications, :contact_people,
-      :payment_terms, :metadata, keyword_init: true
-    )
-
-    CustomerUpdateRequest = Struct.new(
-      # Core fields
-      :customer_key, :customer_type, :primary_email, :primary_phone, :billing_email,
-      # Business fields
-      :legal_name, :display_name, :legal_number, :tax_identification_number,
-      :logo_url, :website_url, :account_manager,
-      # Individual fields
-      :first_name, :middle_name, :last_name, :date_of_birth,
-      # Preferences
-      :timezone, :language, :currency, :tax_status,
-      # Address fields
-      :address_line1, :address_line2, :city, :state, :country, :zip_code,
-      # Shipping address fields
-      :shipping_address_line1, :shipping_address_line2, :shipping_city,
-      :shipping_state, :shipping_country, :shipping_zip_code,
-      # Complex fields
-      :billing_configuration, :tax_identifications, :contact_people,
-      :payment_terms, :metadata, :phone_numbers, :email_addresses, keyword_init: true
-    )
-
-    CustomerDeleteRequest = Struct.new(:customer_key, keyword_init: true)
-    CustomerGetRequest = Struct.new(:customer_key, keyword_init: true)
-
-    CustomerCSVSyncResponse = Struct.new(
-      :status_code, :message, :data, :errors, :meta, keyword_init: true
-    ) do
-      CSVSyncData = Struct.new(
-        :total_customers, :successful_upload_count, :failed_upload_count,
-        :customers_added, :customers_failed, keyword_init: true
-      )
-    end
-
-    APIResponse = Struct.new(:status_code, :message, :data, :errors, :meta, keyword_init: true)
-
-    EmbedConfig = Struct.new(:container, :product_key, keyword_init: true)
     CheckoutConfig = Struct.new(:offering_key, :billing_interval, :customer_key, keyword_init: true)
   end
-end
+end

data/lib/metrifox_sdk/usages/api.rb

@@ -22,7 +22,7 @@ module MetrifoxSDK::Usages
       parse_response(response, "Failed to check access")
     end
 
-    def fetch_usage(base_url, api_key, request_payload)
+    def record_usage(base_url, api_key, request_payload)
       uri = URI.join(base_url, "usage/events")
 
       # Handle both hash and struct access patterns
@@ -33,18 +33,20 @@ module MetrifoxSDK::Usages
       event_id = get_value(request_payload, :event_id)
       timestamp = get_value(request_payload, :timestamp)
       metadata = get_value(request_payload, :metadata) || {}
+      feature_key = get_value(request_payload, :feature_key)
 
       body = {
-        customer_key: customer_key,
-        event_name: event_name,
-        amount: amount
+        customer_key:,
+        amount:,
+        event_id:
       }
 
       # Add optional fields if present
       body[:credit_used] = credit_used if credit_used
-      body[:event_id] = event_id if event_id && !event_id.empty?
       body[:timestamp] = timestamp if timestamp
       body[:metadata] = metadata if metadata
+      body[:feature_key] = feature_key if feature_key
+      body[:event_name] = event_name if event_name
 
       response = make_request(uri, "POST", api_key, body)
       parse_response(response, "Failed to record usage")
@@ -77,4 +79,4 @@ module MetrifoxSDK::Usages
       end
     end
   end
-end
+end

data/lib/metrifox_sdk/usages/module.rb

@@ -6,12 +6,12 @@ module MetrifoxSDK
     class Module < BaseModule
       def check_access(request_payload)
         validate_api_key!
-        api.fetch_access(base_url, api_key, request_payload)
+        api.fetch_access(meter_service_base_url, api_key, request_payload)
       end
 
       def record_usage(request_payload)
         validate_api_key!
-        api.fetch_usage(base_url, api_key, request_payload)
+        api.record_usage(meter_service_base_url, api_key, request_payload)
       end
 
       def get_tenant_id
@@ -26,9 +26,13 @@ module MetrifoxSDK
 
       private
 
+      def meter_service_base_url
+        client.respond_to?(:meter_service_base_url) ? client.meter_service_base_url : base_url
+      end
+
       def api
         @api ||= API.new
       end
     end
   end
-end
+end

data/lib/metrifox_sdk/version.rb

@@ -1,3 +1,3 @@
 module MetrifoxSDK
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: metrifox-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Metrifox
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-10-03 00:00:00.000000000 Z
+date: 2025-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -138,7 +137,6 @@ metadata:
   homepage_uri: https://github.com/metrifox/metrifox-ruby
   source_code_uri: https://github.com/metrifox/metrifox-ruby
   changelog_uri: https://github.com/metrifox/metrifox-ruby/tree/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -153,8 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Ruby SDK for Metrifox API
 test_files: []