spartera_api_sdk 1.0.58

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b6d65b4c64e6ac1a91252149df7bc5f7add045f68779b159da3c991b85d151b3
+  data.tar.gz: 4278e31c87be48c22ede9b646e7d1aa0cbbc83c6dd18f8dabb1949b600f3dcce
+SHA512:
+  metadata.gz: 26b5c022aac4399e2564602125befc3542066ce3ce1652a59b1d64ed54900dd7482a5387c84016e7d7b3ebec633fb9dbfee374e6aba86deed37501495cda2130
+  data.tar.gz: 301d140cc89222517b18f6876bd5ae8efb67e8306fd17efee5125f5849dccdb5a941e86b1b1b89b4fddbf80df1c7474c65e720a22dbdb41c13a212f6a40b4eef

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify the gemspec dependencies
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0'
+  gem 'rspec', '~> 3.0'
+  gem 'webmock', '~> 3.0'
+  gem 'vcr', '~> 6.0'
+end

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    spartera_api_sdk (1.0.58)
+      faraday (>= 1.0.1, < 3.0)
+      faraday-multipart (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    base64 (0.3.0)
+    bigdecimal (3.2.2)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    diff-lcs (1.6.2)
+    faraday (2.13.1)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-multipart (1.1.1)
+      multipart-post (~> 2.0)
+    faraday-net_http (3.4.1)
+      net-http (>= 0.5.0)
+    hashdiff (1.2.0)
+    json (2.12.2)
+    logger (1.7.0)
+    multipart-post (2.4.1)
+    net-http (0.6.0)
+      uri
+    public_suffix (6.0.2)
+    rake (13.3.0)
+    rexml (3.4.1)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.4)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.4)
+    uri (1.0.3)
+    vcr (6.3.1)
+      base64
+    webmock (3.25.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  spartera_api_sdk!
+  vcr (~> 6.0)
+  webmock (~> 3.0)
+
+BUNDLED WITH
+   2.6.9

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Spartera Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,360 @@
+# Ruby SDK Documentation
+
+## Overview
+The Ruby SDK for Spartera API provides a convenient way to interact with the Spartera platform from Ruby applications.
+
+**Install:** `gem install spartera_api_sdk`
+
+## Requirements
+- Ruby 2.7 or higher
+- Bundler
+
+## 🚀 Sell Your First Data Product in 4 API Calls
+
+Transform your data into revenue in under 5 minutes! Here's how to create and sell a data product on the Spartera marketplace:
+
+```ruby
+require 'spartera_api_sdk'
+require 'json'
+
+# Configure client
+SparteraApiSdk.configure do |config|
+  config.host = 'https://api.spartera.com'
+  config.api_key['X-API-Key'] = 'your-api-key-here'
+end
+
+COMPANY_ID = 'your-company-id'
+USER_ID = 'your-user-id'
+
+def sell_data_product
+  # Step 1: Discover available data platforms
+  puts '🔍 Step 1: Discovering available platforms...'
+  cloud_providers_api = SparteraApiSdk::CloudProvidersApi.new
+  
+  engines = cloud_providers_api.cloud_providers_get
+  bigquery_engine_id = 1  # BigQuery engine ID
+  puts "✅ Found #{engines.length} supported platforms"
+
+  # Step 2: Create a data connection (with credentials in one call!)
+  puts '🔗 Step 2: Creating BigQuery connection...'
+  connections_api = SparteraApiSdk::ConnectionsApi.new
+  
+  # Your BigQuery service account JSON (replace with your actual credentials)
+  service_account_json = {
+    type: 'service_account',
+    project_id: 'your-project-id',
+    private_key_id: 'key-id',
+    private_key: "-----BEGIN PRIVATE KEY-----\nYOUR_PRIVATE_KEY\n-----END PRIVATE KEY-----\n",
+    client_email: 'your-service@your-project.iam.gserviceaccount.com',
+    client_id: 'client-id',
+    auth_uri: 'https://accounts.google.com/o/oauth2/auth',
+    token_uri: 'https://oauth2.googleapis.com/token'
+  }
+
+  connection_data = SparteraApiSdk::Connection.new(
+    company_id: COMPANY_ID,
+    user_id: USER_ID,
+    engine_id: bigquery_engine_id,
+    name: 'My BigQuery Data Warehouse',
+    description: "Connection to our company's analytics data",
+    visibility: 'PRIVATE',
+    credential_type: 'SERVICE_ACCOUNT',
+    credentials: service_account_json.to_json,
+    verified_usage_ability: true  # Legal compliance - you have rights to this data
+  )
+
+  connection = connections_api.companies_company_id_connections_post(COMPANY_ID, connection_data)
+  connection_id = connection.connection_id
+  puts "✅ Created connection: #{connection_id}"
+
+  # Step 3: Create a marketplace asset
+  puts '📊 Step 3: Creating marketplace asset...'
+  assets_api = SparteraApiSdk::AssetsApi.new
+
+  asset_data = SparteraApiSdk::Asset.new(
+    name: 'Average Temperature Analytics',
+    description: 'Real-time weather temperature analytics from our IoT sensors across major cities',
+    company_id: COMPANY_ID,
+    connection_id: connection_id,
+    asset_type: 'CALCULATION',
+    sql_logic: 'SELECT AVERAGE(temperature) AS avg_temp, city, COUNT(*) AS readings FROM `your-project.weather.sensor_data` WHERE timestamp >= TIMESTAMP_SUB(CURRENT_TIMESTAMP(), INTERVAL 24 HOUR) GROUP BY city ORDER BY avg_temp DESC',
+    sell_in_marketplace: true,  # 🔥 This makes it available for purchase!
+    source: 'MANUAL',
+    visibility: 'PUBLIC'
+  )
+
+  asset = assets_api.companies_company_id_assets_post(COMPANY_ID, asset_data)
+  asset_id = asset.asset_id
+  puts "✅ Created marketplace asset: #{asset_id}"
+
+  # Step 4: Set your price and start earning!
+  puts '💰 Step 4: Setting price...'
+  pricing_api = SparteraApiSdk::AssetPriceHistoryApi.new
+
+  price_data = SparteraApiSdk::Assetpricehistory.new(
+    price_usd: 2.00  # $2.00 per analysis (credits calculated automatically)
+  )
+
+  price = pricing_api.companies_company_id_assets_asset_id_prices_post(COMPANY_ID, asset_id, price_data)
+  puts "✅ Price set: $#{price.price_usd} (≈#{price.price_credits} credits)"
+
+  puts "\n🎉 SUCCESS! Your data product is now live on the Spartera marketplace!"
+  puts "📈 Asset URL: https://marketplace.spartera.com/assets/#{asset_id}"
+  puts '💡 Customers can now discover and purchase your analytics!'
+rescue SparteraApiSdk::ApiError => e
+  puts "Error: #{e.message}"
+  raise e
+end
+
+# Run the function
+sell_data_product
+```
+
+**That's it!** You're now selling data analytics. Every time someone runs your analysis, you earn money! 
+
+### 🎯 What You Just Built
+- **Data Connection**: Secure link to your BigQuery warehouse
+- **Analytics Product**: Temperature analysis that buyers can purchase
+- **Marketplace Listing**: Your product is discoverable by thousands of potential customers
+- **Automated Pricing**: Credits are calculated automatically based on your USD price
+
+### 💰 Revenue Model
+- You set the price ($2.00 in this example)
+- Customers pay in credits (auto-converted)
+- You earn revenue each time someone uses your analytics
+- Spartera handles billing, payments, and customer support
+
+---
+
+## 📚 Detailed Documentation
+
+### Authentication
+
+Get your API key from the [Spartera Dashboard](https://app.spartera.com/settings/api-keys):
+
+```ruby
+require 'spartera_api_sdk'
+
+# Option 1: Direct configuration
+SparteraApiSdk.configure do |config|
+  config.host = 'https://api.spartera.com'
+  config.api_key['X-API-Key'] = 'your-api-key-here'
+end
+
+# Option 2: Environment variables (recommended)
+ENV['SPARTERA_API_KEY'] = 'your-api-key'
+ENV['SPARTERA_COMPANY_ID'] = 'your-company-id'
+
+SparteraApiSdk.configure do |config|
+  config.host = 'https://api.spartera.com'
+  config.api_key['X-API-Key'] = ENV['SPARTERA_API_KEY']
+end
+
+# Create API instances
+companies_api = SparteraApiSdk::CompaniesApi.new
+assets_api = SparteraApiSdk::AssetsApi.new
+```
+
+### Environment Variables
+
+```bash
+export SPARTERA_API_KEY="your-api-key"
+export SPARTERA_COMPANY_ID="your-company-id"
+export SPARTERA_API_BASE_URL="https://api.spartera.com"
+```
+
+### Connection Types
+
+Create connections to different data platforms:
+
+```ruby
+# BigQuery
+bigquery_credentials = {
+  type: 'service_account',
+  project_id: 'your-project',
+  # ... your service account JSON
+}
+
+# Snowflake
+snowflake_connection = SparteraApiSdk::Connection.new(
+  credential_type: 'USERNAME_PASSWORD',
+  username: 'your-username',
+  password: 'your-password'
+)
+
+# API Data Source
+api_connection = SparteraApiSdk::Connection.new(
+  credential_type: 'API_KEY',
+  api_endpoint: 'https://api.yourcompany.com/data',
+  api_key_param: 'x-api-key',
+  credentials: 'your-api-key-value'
+)
+```
+
+### Asset Types
+
+Create different types of marketplace products:
+
+```ruby
+# SQL-based Analytics
+calculation_asset = SparteraApiSdk::Asset.new(
+  asset_type: 'CALCULATION',
+  sql_logic: 'SELECT COUNT(*) as total_sales, AVG(amount) as avg_order FROM sales WHERE date >= CURRENT_DATE()'
+)
+
+# Visualization/Dashboard
+visualization_asset = SparteraApiSdk::Asset.new(
+  asset_type: 'VISUALIZATION',
+  viz_chart_type: 'BAR',
+  viz_dep_var_col_name: 'sales_amount',
+  viz_indep_var_col_name: 'month'
+)
+```
+
+### Pricing Strategies
+
+Set different pricing models:
+
+```ruby
+# Fixed price per analysis
+basic_pricing = SparteraApiSdk::Assetpricehistory.new(price_usd: 1.50)
+
+# Premium analytics
+premium_pricing = SparteraApiSdk::Assetpricehistory.new(price_usd: 10.00)
+
+# Bulk discount with sales
+sale_pricing = SparteraApiSdk::Assetpricehistory.new(
+  price_usd: 5.00,
+  discount_percentage: 20.0,
+  sale_start_date: '2024-01-01T00:00:00Z',
+  sale_end_date: '2024-01-31T23:59:59Z'
+)
+```
+
+### Marketplace Management
+
+Manage your products after launch:
+
+```ruby
+# Update asset details
+update_data = SparteraApiSdk::Asset.new(
+  description: 'Updated description with new features'
+)
+assets_api.companies_company_id_assets_asset_id_patch(COMPANY_ID, asset_id, update_data)
+
+# Change pricing
+new_price = SparteraApiSdk::Assetpricehistory.new(price_usd: 3.00)
+pricing_api.companies_company_id_assets_asset_id_prices_post(COMPANY_ID, asset_id, new_price)
+
+# Remove from marketplace (but keep private)
+marketplace_update = SparteraApiSdk::Asset.new(sell_in_marketplace: false)
+assets_api.companies_company_id_assets_asset_id_patch(COMPANY_ID, asset_id, marketplace_update)
+
+# Get sales analytics
+analytics = companies_api.companies_company_id_analytics_sales_get(COMPANY_ID)
+puts "Total revenue: $#{analytics.total_revenue}"
+```
+
+### Error Handling
+
+```ruby
+begin
+  asset = assets_api.companies_company_id_assets_post(COMPANY_ID, asset_data)
+rescue SparteraApiSdk::ApiError => e
+  puts "API Error: #{e.message}"
+  puts "Status: #{e.code}"
+  puts "Response: #{e.response_body}"
+  
+  # Handle specific errors
+  case e.code
+  when 400
+    puts 'Check your asset data format'
+  when 401
+    puts 'Check your API key'
+  when 403
+    puts 'Check your permissions'
+  when 404
+    puts 'Check your IDs'
+  else
+    puts "HTTP #{e.code}: #{e.message}"
+  end
+  
+  raise e
+end
+```
+
+### Advanced Features
+
+```ruby
+# Batch operations
+connection_ids = []
+%w[bigquery snowflake redshift].each do |platform|
+  conn = connections_api.companies_company_id_connections_post(COMPANY_ID, platform_config)
+  connection_ids << conn.connection_id
+end
+
+# Asset recommendations
+recommendations = assets_api.companies_company_id_assets_asset_id_recommendations_get(
+  COMPANY_ID, 
+  asset_id, 
+  { limit: 10 }
+)
+
+# Performance analytics
+performance = companies_api.companies_company_id_analytics_assets_get(
+  COMPANY_ID,
+  start_date: '2024-01-01',
+  end_date: '2024-12-31'
+)
+```
+
+### Rails Integration
+
+For Ruby on Rails applications:
+
+```ruby
+# Gemfile
+gem 'spartera_api_sdk'
+
+# config/initializers/spartera.rb
+SparteraApiSdk.configure do |config|
+  config.host = Rails.application.credentials.spartera[:api_url] || 'https://api.spartera.com'
+  config.api_key['X-API-Key'] = Rails.application.credentials.spartera[:api_key]
+end
+
+# app/services/spartera_service.rb
+class SparteraService
+  def self.companies_api
+    @companies_api ||= SparteraApiSdk::CompaniesApi.new
+  end
+  
+  def self.assets_api
+    @assets_api ||= SparteraApiSdk::AssetsApi.new
+  end
+  
+  def self.get_company(company_id)
+    companies_api.companies_company_id_get(company_id)
+  rescue SparteraApiSdk::ApiError => e
+    Rails.logger.error "Spartera API Error: #{e.message}"
+    nil
+  end
+end
+
+# Usage in controllers
+class AssetsController < ApplicationController
+  def show
+    @company = SparteraService.get_company(params[:company_id])
+    # ...
+  end
+end
+```
+
+## Package Manager
+- **Platform**: RubyGems
+- **Install**: `gem install spartera_api_sdk`
+- **Import**: `require 'spartera_api_sdk'`
+
+## Publishing
+1. Build: `gem build *.gemspec`
+2. Push: `gem push *.gem`
+3. Install: `gem install spartera_api_sdk`

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/config.json

@@ -0,0 +1,10 @@
+{
+    "gemName": "spartera_api_sdk",
+    "gemVersion": "1.0.58",
+    "gemDescription": "Official SDK for Spartera API - Interface to manage companies' accounts and process insights remotely",
+    "gemAuthor": "Tony D",
+    "gemAuthorEmail": "tony@spartera.com",
+    "gemHomepage": "https://github.com/spartera-com/spartera-ruby-sdk",
+    "moduleName": "SparteraApiSdk",
+    "gemLicense": "Apache-2.0"
+}