onvo 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23ad72e25804c989c6799a2f5ef6880eedd3800a2aaf5e3ac56e4fb282512134
-  data.tar.gz: 3db6519cfe76d919620d33aa6fc10c491139897fc9e118b16de1b15eb9ddb8f9
+  metadata.gz: 0a7a5c75c36304b627cecd1f2ec86178bc3027e829fcfc1c146b0da30a4fbb86
+  data.tar.gz: 5689e8bd4998ca276a24f60232ee91675c89f9ef2c101bbf31e8e31a4c6b8363
 SHA512:
-  metadata.gz: 112d841d43f7a965712d95addb47530f2207b7a7c5c42536438cd10f745dd0675f4c26f6ca2bef34eea69be9be49bf0e2eb12e21d0fb5e289825fea6f76775d2
-  data.tar.gz: eed16b5a32c784cfa285971177a7c152b3ec3718bc9b24723ceaaeda71b459fbb45d5afc5551dd7ff95b62ed3a2f09da61f17cc1d0f37c75e6f0d0286b4ae0fb
+  metadata.gz: e4e106aa86da954751fe9e97748c90e462c7bf4bd39622b44e4bbe659c9196e2e6a29c70a6621aad84fa80b09c14e3f4fc1e57a3376f315ed37ad086c1a362a1
+  data.tar.gz: 8fdd8b97d7cdd0f82013f48c2d4c0335e1a1d9c47808c95e35346d53f7c1e612aa6626ae19517bd9d43b74506fea9920220fc0a4523b16db6956f2cef52fd84e

data/lib/onvo/accounts.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative '../resource'
+
+# Account endpoints
+class Accounts < Resource
+  def list
+    base_get('/accounts')
+  end
+
+  def get(id)
+    base_get("/accounts/#{id}")
+  end
+end

data/lib/onvo/automations.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative '../resource'
+
+# Automation endpoints
+class Automations < Resource
+  def list
+    base_get('/automations')
+  end
+
+  def get(id)
+    base_get("/automations/#{id}")
+  end
+
+  def delete(id)
+    base_delete("/automations/#{id}")
+  end
+
+  def update(id, body)
+    base_post("/automations/#{id}", body)
+  end
+
+  def create(body)
+    base_put('/automations', body)
+  end
+end

data/lib/onvo/dashboard/dashboard_resource.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative '../../resource'
+
+# The default template for an Onvo Dashboard Resource
+class DashboardResource < Resource
+  include HTTParty
+
+  attr_accessor :dashboard_id
+
+  def initialize(dashboard_id, endpoint, api_key)
+    @dashboard_id = dashboard_id
+    @endpoint = endpoint
+    super(endpoint, api_key)
+  end
+end

data/lib/onvo/dashboard/datasources.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'uri'
+require_relative './dashboard_resource'
+
+# Dashboard Widget endpoints
+class DashboardDatasources < DashboardResource
+  def list
+    base_get("/dashboards/#{@dashboard_id}/datasources")
+  end
+
+  def link(datasource_id)
+    base_put("/dashboards/#{@dashboard_id}/datasources", datasourceId: datasource_id) #TODO: check if not "datasourceId"
+  end
+
+  def unlink(datasource_id)
+    base_delete("/dashboards/#{@dashboard_id}/datasources/#{datasource_id}")
+  end
+end

data/lib/onvo/dashboard/questions.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'uri'
+require_relative './dashboard_resource'
+
+# Dashboard Question endpoints
+class DashboardQuestions < DashboardResource
+  def list
+    base_get("/dashboards/#{@dashboard_id}/questions")
+  end
+
+  # TODO: ask?
+  def create(query)
+    processed_query = URI.encode_www_form_component(query)
+    base_put("/dashboards/#{@dashboard_id}/questions?query=#{processed_query}")
+  end
+end

data/lib/onvo/dashboard/sessions.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative './dashboard_resource'
+
+# Dashboard session endpoints
+class DashboardSessions < DashboardResource
+  def list
+    base_get("/dashboards/#{@dashboard_id}/sessions")
+  end
+
+  # TODO: check if rename to delete_all
+  def delete
+    base_delete("/dashboards/#{@dashboard_id}/sessions")
+  end
+
+  def upsert(user_id, parameters = {})
+    session_data = base_post(
+      "/dashboards/#{@dashboard_id}/sessions",
+      user: user_id,
+      parameters: parameters
+    )
+    session_data.merge({ 'url': "#{@endpoint}#{session_data['url']}" })
+  end
+end

data/lib/onvo/dashboard/widgets.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'uri'
+require_relative './dashboard_resource'
+
+# Dashboard Widget endpoints
+class DashboardWidgets < DashboardResource
+  def list
+    base_get("/dashboards/#{@dashboard_id}/widgets")
+  end
+
+  def get(widget_id)
+    base_get("/dashboards/#{@dashboard_id}/widgets/#{widget_id}")
+  end
+
+  def delete(widget_id)
+    base_delete("/dashboards/#{@dashboard_id}/widgets/#{widget_id}")
+  end
+
+  def update(widget_id, body)
+    base_post("/dashboards/#{@dashboard_id}/widgets/#{widget_id}", body)
+  end
+
+  def create(query)
+    processed_query = URI.encode_www_form_component(query)
+    base_put("/dashboards/#{@dashboard_id}/widgets?query=#{processed_query}")
+  end
+end

data/lib/onvo/dashboard.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative './dashboard/datasources'
+require_relative './dashboard/widgets'
+require_relative './dashboard/questions'
+require_relative './dashboard/sessions'
+
+# The Dashboard API
+class Dashboard
+  attr_accessor :datasources, :widgets, :questions, :sessions
+
+  def initialize(dashboard_id, endpoint, api_key)
+    params = [dashboard_id, endpoint, api_key]
+
+    @datasources = DashboardDatasources.new(*params)
+    @widgets = DashboardWidgets.new(*params)
+    @questions = DashboardQuestions.new(*params)
+    @sessions = DashboardSessions.new(*params)
+  end
+end

data/lib/onvo/dashboards.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative '../resource'
+
+# Dashboard endpoints
+class Dashboards < Resource
+  def list
+    base_get('/dashboards')
+  end
+
+  def get(id)
+    base_get("/dashboards/#{id}")
+  end
+
+  def delete(id)
+    base_delete("/dashboards/#{id}")
+  end
+
+  def update(id, body)
+    base_post("/dashboards/#{id}", body)
+  end
+
+  def create(body)
+    base_put('/dashboards', body)
+  end
+end

data/lib/onvo/datasources.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative '../resource'
+
+# Datasource endpoints
+class Datasources < Resource
+  def list
+    base_get('/datasources')
+  end
+
+  def get(id)
+    base_get("/datasources/#{id}")
+  end
+
+  def get_data(id)
+    base_get("/datasources/#{id}/data")
+  end
+
+  def fetch_column_descriptions(id)
+    base_post("/datasources/#{id}/populate-columns")
+  end
+
+  def delete(id)
+    base_delete("/datasources/#{id}")
+  end
+
+  def update(id, body)
+    base_post("/datasources/#{id}", body)
+  end
+
+  def create(body)
+    base_put('/datasources', body)
+  end
+end

data/lib/onvo/embed_users.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative '../resource'
+
+# Embed user endpoints
+class EmbedUsers < Resource
+  def list
+    base_get('/embed-users')
+  end
+
+  def get(id)
+    base_get("/embed-users/#{id}")
+  end
+
+  def delete(id)
+    base_delete("/embed-users/#{id}")
+  end
+
+  def upsert(id, name, email, metadata = {})
+    base_post(
+      '/embed-users',
+      {
+        'id': id,
+        'name': name,
+        'email': email,
+        'metadata': metadata
+      }
+    )
+  end
+
+  def get_access_token(id)
+    base_get("/embed-users/#{id}/token")
+  end
+end

data/lib/onvo/teams.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative '../resource'
+
+# Team endpoints
+class Teams < Resource
+  def list
+    base_get('/teams')
+  end
+
+  def get(id)
+    base_get("/teams/#{id}")
+  end
+end

data/lib/onvo.rb

@@ -1,7 +1,33 @@
 # frozen_string_literal: true
 
-class TestGem::Hello
-  def self.hello
-    puts "Hello world!"
+require_relative './onvo/accounts'
+require_relative './onvo/teams'
+require_relative './onvo/embed_users'
+require_relative './onvo/datasources'
+require_relative './onvo/automations'
+require_relative './onvo/dashboards'
+
+require_relative './onvo/dashboard'
+
+# The Onvo Ruby SDK
+class Onvo
+  attr_reader :accounts, :teams, :embed_users, :datasources, :automations, :dashboards
+  attr_accessor :endpoint, :api_key
+
+  def initialize(endpoint = ENV['ONVO_API_ENDPOINT'], api_key = ENV['ONVO_API_KEY'])
+    @endpoint = endpoint
+    @api_key = api_key
+    params = [@endpoint, @api_key]
+
+    @accounts = Accounts.new(*params)
+    @teams = Teams.new(*params)
+    @embed_users = EmbedUsers.new(*params)
+    @datasources = Datasources.new(*params)
+    @automations = Automations.new(*params)
+    @dashboards = Dashboards.new(*params)
+  end
+
+  def dashboard(dashboard_id)
+    Dashboard.new(dashboard_id, @endpoint, @api_key)
   end
-end
+end

data/lib/resource.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'json'
+require 'uri'
+
+# The default template for an Onvo Resource
+class Resource
+  include HTTParty
+
+  attr_accessor :options
+
+  def initialize(endpoint, api_key)
+    self.class.base_uri endpoint
+    @options = {
+      headers: {
+        'x-api-key': api_key,
+        'Content-Type': 'application/json'
+      }
+    }
+  end
+
+  def base_request
+    response = yield
+    body = JSON.parse(response.body)
+    # TODO: Replace Runtime w/ custom errors
+    raise "#{response.code} Error : #{body['message']}" if response.code >= 400
+
+    body
+  rescue JSON::ParserError, TypeError
+    response.body
+  end
+
+  def base_get(subdirectory)
+    base_request { self.class.get(subdirectory, options) }
+  end
+
+  def base_put(subdirectory, body = nil)
+    params = body ? options.merge({ body: body.to_json }) : options
+    base_request { self.class.put(subdirectory, params) }
+  end
+
+  def base_post(subdirectory, body = nil)
+    params = body ? options.merge({ body: body.to_json }) : options
+    base_request { self.class.post(subdirectory, params) }
+  end
+
+  def base_delete(subdirectory)
+    base_request { self.class.delete(subdirectory, options) }
+  end
+end

metadata

@@ -1,23 +1,66 @@
 --- !ruby/object:Gem::Specification
 name: onvo
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
-- Ronnel Davis
 - Bryan Davis
+- Ronnel Davis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-12 00:00:00.000000000 Z
-dependencies: []
-description:
+date: 2024-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+- !ruby/object:Gem::Dependency
+  name: minitest-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+description: A gem to provide utilities to seamlessly communicate with the Onvo platform,
+  allowing developers to integrate AI-powered dashboards into their products.
 email:
+- bryandavis999.dev@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/onvo.rb
+- lib/onvo/accounts.rb
+- lib/onvo/automations.rb
+- lib/onvo/dashboard.rb
+- lib/onvo/dashboard/dashboard_resource.rb
+- lib/onvo/dashboard/datasources.rb
+- lib/onvo/dashboard/questions.rb
+- lib/onvo/dashboard/sessions.rb
+- lib/onvo/dashboard/widgets.rb
+- lib/onvo/dashboards.rb
+- lib/onvo/datasources.rb
+- lib/onvo/embed_users.rb
+- lib/onvo/teams.rb
+- lib/resource.rb
 homepage:
 licenses: []
 metadata: {}
@@ -25,6 +68,7 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - lib
+- lib/onvo
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -39,6 +83,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: A gem to provide utilities to seamlessly communicate with the Onvo platform,
-  allowing developers to integrate AI-powered dashboards into their products.
+summary: Communicate with the Onvo platform.
 test_files: []