dbx-api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6f72e4b53309594553a8616e66bd27008585029c0b61d78b4e749c697c964064
+  data.tar.gz: 8bdd6b0e7025486de43a2951a33a0726e94374f3299f9d6e8526d70d424888c7
+SHA512:
+  metadata.gz: 2ae01403a40e9688aea026bff939788e83615a017c8333e8c7b50c5e83b88c6f0b7fe0e8244186f07cb47f81757fc801d62980f6eb160e8c71059283c3b7879f
+  data.tar.gz: 131e3d2d072e05fcab4d456f767b87bc8871decea1abab8e11c15c92cfafe6afa5916c4637744553d3bef35eac3fb7b9395b12843bb8d6bdeeffe5e2509e9039

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-09-25
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at cmmiller.bio@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dbx.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    dbx-api (0.1.0)
+      dotenv (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    base64 (0.1.1)
+    diff-lcs (1.5.0)
+    dotenv (2.8.1)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.56.3)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  dbx-api!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 cmmille
+
+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,41 @@
+# Databricks Gem
+
+## Overview
+This gem is designed to allow access to the DBX APIs (Jobs and SQL) from ruby applications.
+
+## Installation
+TODO: write this section
+
+## Usage
+Set up your .env file (optional)
+```bash
+# .env
+DBX_HOST=DBX_CONNECTION_URL
+DBX_TOKEN=YOUR_TOKEN_HERE
+DBX_WAREHOUSE_ID=WAREHOUSE_ID_HERE
+```
+
+running sql from a ruby script
+```ruby
+require 'dbx'
+
+# If using a .env file
+sql_runner = DatabricksGateway.new
+# If not using .env file...
+sql_runner = DatabricksGateway.new(host: 'DBX_CONNECTION_STRING', token: 'DBX_ACCESS_TOKEN', warehouse: 'DBX_SQL_WAREHOUSE_ID')
+
+# Basic sql
+result = sql_runner.run_sql("SELECT 1")
+sql_runner.parse_result(result)
+# => [{"1"=>"1"}]
+
+# Dummy data in public DBX table
+result = sql_runner.run_sql("SELECT * FROM samples.nyctaxi.trips LIMIT 1")
+sql_runner.parse_result(result)
+# => [{"tpep_pickup_datetime"=>"2016-02-14T16:52:13.000Z",
+#   "tpep_dropoff_datetime"=>"2016-02-14T17:16:04.000Z",
+#   "trip_distance"=>"4.94",
+#   "fare_amount"=>"19.0",
+#   "pickup_zip"=>"10282",
+#   "dropoff_zip"=>"10171"}]
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/dbx/databricks/databricks.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "sql"
+require_relative "jobs"
+
+# This module is a convenience module to include all Databricks modules.
+module Databricks
+  # /api/2.0/sql/
+  include DatabricksSQL
+  # /api/2.0/jobs/
+  include DatabricksJobs
+end

data/lib/dbx/databricks/jobs.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require "json"
+
+# This module handles the execution of jobs/runs using the DBX API.
+# For more information about the DBX Jobs API,
+# see: https://learn.microsoft.com/en-us/azure/databricks/workflows/jobs/jobs-2.0-api
+module DatabricksJobs
+  def jobs_url
+    "#{@base_url}/api/2.0/jobs/"
+  end
+
+  # create job
+  # POST /api/2.0/jobs/create/
+  def create_job(job_json)
+    uri = URI("#{jobs_url}create")
+    request = Net::HTTP::Post.new(uri, request_headers)
+    request.body = job_json
+    response = http.request(request)
+    response.body
+  end
+
+  # list jobs
+  # GET /api/2.0/jobs/list/
+  def list_jobs
+    uri = URI("#{jobs_url}list")
+    request = Net::HTTP::Get.new(uri, request_headers)
+    response = http.request(request)
+    response.body
+  end
+
+  # delete job
+  # POST /api/2.0/jobs/delete/
+  def delete_job(job_id)
+    uri = URI("#{jobs_url}delete")
+    request = Net::HTTP::Post.new(uri, request_headers)
+    request.body = { "job_id" => job_id }.to_json
+    response = http.request(request)
+    response.body
+  end
+
+  # get information about a single job
+  # GET /api/2.0/jobs/get/
+  def job_info(job_id)
+    uri = URI("#{jobs_url}get")
+    request = Net::HTTP::Get.new(uri, request_headers)
+    request.body = { "job_id" => job_id }.to_json
+    response = http.request(request)
+    response.body
+  end
+
+  # run job
+  # POST /api/2.0/jobs/run-now
+  def run_now(job_id)
+    uri = URI("#{jobs_url}run-now")
+    request = Net::HTTP::Post.new(uri, request_headers)
+    request.body = { "job_id" => job_id }.to_json
+    response = http.request(request)
+    response.body
+  end
+
+  # submit a one-time run without directly creating a job
+  # POST /api/2.0/jobs/runs/submit
+  def submit_job(job_json)
+    uri = URI("#{jobs_url}runs/submit")
+    request = Net::HTTP::Post.new(uri, request_headers)
+    request.body = job_json
+    response = http.request(request)
+    response.body
+  end
+
+  # list runs
+  # GET /api/2.0/jobs/runs/list
+  def list_runs(active_only: false)
+    uri = URI("#{jobs_url}runs/list")
+    request = Net::HTTP::Get.new(uri, request_headers)
+    request.body = { "active_only" => active_only }.to_json
+    response = http.request(request)
+    response.body
+  end
+
+  # get run metadata
+  # GET /api/2.0/jobs/runs/get
+  def get_run(run_id)
+    uri = URI("#{jobs_url}runs/get")
+    request = Net::HTTP::Get.new(uri, request_headers)
+    request.body = { "run_id" => run_id }.to_json
+    response = http.request(request)
+    response.body
+  end
+
+  # export notebook run as HTML
+  # GET /api/2.0/jobs/runs/export
+  def export_run(run_id)
+    uri = URI("#{jobs_url}runs/export")
+    request = Net::HTTP::Get.new(uri, request_headers)
+    request.body = { "run_id" => run_id }.to_json
+    response = http.request(request)
+    response.body
+  end
+
+  # cancel a single run
+  # POST /api/2.0/jobs/runs/cancel
+  def cancel_run(run_id)
+    uri = URI("#{jobs_url}runs/cancel")
+    request = Net::HTTP::Post.new(uri, request_headers)
+    request.body = { "run_id" => run_id }.to_json
+    response = http.request(request)
+    response.body
+  end
+
+  # cancel all active runs of a job
+  # POST /api/2.0/jobs/runs/cancel-all
+  def cancel_all_runs(job_id)
+    uri = URI("#{jobs_url}runs/cancel-all")
+    request = Net::HTTP::Post.new(uri, request_headers)
+    request.body = { "job_id" => job_id }.to_json
+    response = http.request(request)
+    response.body
+  end
+
+  # get run output
+  # GET /api/2.0/jobs/runs/get-output
+  def get_run_output(run_id)
+    uri = URI("#{jobs_url}runs/get-output")
+    request = Net::HTTP::Get.new(uri, request_headers)
+    request.body = { "run_id" => run_id }.to_json
+    response = http.request(request)
+    response.body
+  end
+
+  # delete inactive run
+  # POST /api/2.0/jobs/runs/delete
+  def delete_run(run_id)
+    uri = URI("#{jobs_url}runs/delete")
+    request = Net::HTTP::Post.new(uri, request_headers)
+    request.body = { "run_id" => run_id }.to_json
+    response = http.request(request)
+    response.body
+  end
+end

data/lib/dbx/databricks/sql.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require "json"
+
+# This module handles the execution of SQL statements via the DBX API.
+# For more information about the DBX SQL API, see: https://docs.databricks.com/sql/admin/sql-execution-tutorial.html
+# Azure specific tutorial: https://learn.microsoft.com/en-us/azure/databricks/sql/api/sql-execution-tutorial
+module DatabricksSQL
+  def sql_url
+    "#{@base_url}/api/2.0/sql/statements/"
+  end
+
+  def sql_uri
+    URI(sql_url)
+  end
+
+  # POST request object
+  # POST /api/2.0/sql/statements
+  def sql_request(sql)
+    params = {
+      "statement" => sql,
+      "wait_timeout" => "0s",
+      "warehouse_id" => @warehouse
+    }
+    request = Net::HTTP::Post.new(sql_uri.request_uri, request_headers)
+    request.body = params.to_json
+    request
+  end
+
+  # POST SQL query to DBX
+  def post_sql_request(sql)
+    response = http.request(sql_request(sql))
+    response.body
+  end
+
+  # GET request object
+  # GET /api/2.0/sql/statements/{statement_id}
+  def sql_results_request(statement_id)
+    req_uri = "#{sql_uri.request_uri}#{statement_id}"
+    Net::HTTP::Get.new(req_uri, request_headers)
+  end
+
+  # GET results of SQL query from DBX.
+  def get_sql_results(http_response)
+    statement_id = JSON.parse(http_response)["statement_id"]
+    response = http.request(sql_results_request(statement_id))
+    puts "#{statement_id}: #{JSON.parse(response.body)["status"]["state"]}"
+    response.body
+  end
+
+  # GET SQL chunk from DBX by internal link
+  def get_sql_chunk(chunk_url)
+    request = Net::HTTP::Get.new(chunk_url, request_headers)
+    response = http.request(request)
+    response.body
+  end
+
+  # Load additional chunks of data from DBX.
+  # DBX returns data with maximum chunk size of 16mb.
+  def load_additional_chunks(results_hash)
+    next_chunk = results_hash["result"]["next_chunk_internal_link"]
+    while next_chunk
+      response = get_sql_chunk(next_chunk)
+      parsed_response = JSON.parse(response)
+      result = parsed_response["data_array"]
+      data = results_hash["result"]["data_array"]
+      results_hash["result"]["data_array"] = [*data, *result]
+      next_chunk = parsed_response["next_chunk_internal_link"]
+    end
+  end
+
+  # Wait for SQL query response from DBX.
+  # Returns a hash of the results of the SQL query.
+  def wait_for_sql_response(response)
+    result = get_sql_results(response)
+    status = JSON.parse(result)["status"]["state"]
+    # PENDING means the warehouse is starting up
+    # RUNNING means the query is still executing
+    while %w[PENDING RUNNING].include?(status)
+      sleep(5)
+      result = get_sql_results(response)
+      status = JSON.parse(result)["status"]["state"]
+    end
+    JSON.parse(result)
+  end
+
+  # Parse JSON response from DBX into array of hashes.
+  # Provides output c/w Big Query.
+  def parse_result(http_response)
+    keys = JSON.parse(http_response)["manifest"]["schema"]["columns"]
+    data_array = JSON.parse(http_response)["result"]["data_array"]
+
+    data_array.map do |row|
+      hash = {}
+      keys.each do |key|
+        hash[key["name"]] = row[key["position"]]
+      end
+      hash
+    end
+  end
+
+  # Submit SQL query to DBX and return results.
+  # returns a JSON string of the results of the SQL query
+  def run_sql(sql)
+    response = post_sql_request(sql)
+    results_hash = wait_for_sql_response(response)
+    load_additional_chunks(results_hash) if results_hash["manifest"]["total_chunk_count"] > 1
+    JSON.dump(results_hash)
+  end
+end

data/lib/dbx/gateway.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "net/http"
+require_relative "databricks/databricks"
+
+# This class is a gateway to the Databricks API.
+# https://docs.databricks.com/api-explorer/workspace/introduction
+class DatabricksGateway
+  def initialize(host: ENV.fetch("DBX_HOST", nil), token: ENV.fetch("DBX_TOKEN", nil), warehouse: ENV.fetch("DBX_WAREHOUSE_ID", nil))
+    @base_url = host
+    @uri = URI(@base_url)
+    @token = token
+    @warehouse = warehouse
+  end
+
+  # HTTP request headers
+  def request_headers
+    {
+      "Authorization" => "Bearer #{@token}",
+      "Content-Type" => "application/json",
+      "Accept" => "application/json"
+    }
+  end
+
+  # HTTP connection object
+  def http
+    http = Net::HTTP.new(@uri.host, @uri.port)
+    http.use_ssl = true
+    http
+  end
+
+  # include DatabricksSQL, DatabricksJobs
+  include Databricks
+end

data/lib/dbx/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Dbx
+  VERSION = "0.1.1"
+end

data/lib/dbx.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "dbx/version"
+require_relative "dbx/gateway"
+
+module Dbx
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/dbx.rbs

@@ -0,0 +1,4 @@
+module Dbx
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: dbx-api
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- cmmille
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Ruby wrapper for the Databricks API. Includes access to the Databricks
+  Jobs API and the SQL Execution API.
+email:
+- christopher.lockfeld@providence.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/dbx.rb
+- lib/dbx/databricks/databricks.rb
+- lib/dbx/databricks/jobs.rb
+- lib/dbx/databricks/sql.rb
+- lib/dbx/gateway.rb
+- lib/dbx/version.rb
+- sig/dbx.rbs
+homepage: https://github.com/pdxmolab/dbx-gem
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pdxmolab/dbx-gem
+  source_code_uri: https://github.com/pdxmolab/dbx-gem
+  changelog_uri: https://github.com/pdxmolab/dbx-gem/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Access the Databricks API with ruby.
+test_files: []