Ruby SDK
The official Ruby SDK for Unified Commerce Platform. Idiomatic Ruby with Rails integration and ActiveRecord-like API.
Version: 1.6.4 | License: MIT | Ruby: 2.7+ | Gem: unified_commerce
Installation
Add to your Gemfile:
gem 'unified_commerce'
Or install directly:
gem install unified_commerce
Quick Start
require 'unified_commerce'
UnifiedCommerce.configure do |config|
config.api_key = ENV['UNIFIED_COMMERCE_API_KEY']
config.environment = 'production'
end
# List products
products = UnifiedCommerce::Product.list(
category: 'electronics',
limit: 10
)
products.each do |product|
puts "#{product.name}: $#{product.price}"
end
# Create an order
order = UnifiedCommerce::Order.create(
items: [
{ product_id: '123', quantity: 2 }
],
customer: {
email: 'customer@example.com'
}
)
Rails Integration
# config/initializers/unified_commerce.rb
UnifiedCommerce.configure do |config|
config.api_key = Rails.application.credentials.unified_commerce[:api_key]
config.environment = Rails.env.production? ? 'production' : 'sandbox'
end
# app/models/product.rb
class Product < ApplicationRecord
include UnifiedCommerce::Syncable
sync_with_unified_commerce mapping: {
name: :name,
price: :price,
sku: :sku
}
end
Documentation
Full documentation coming soon. For now, please refer to: