dbx-api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09cd7a1984478b2761fbe0dca4b69acd123d664c96ea7333997143fe4389aa3b'
-  data.tar.gz: 5e1093ab32b19c13eff195869d12dc159459f4418f3bc260df241e737cd5f78f
+  metadata.gz: 94d4b8f9d3d55224b5c93191aab3aefe280457e30ade7fba3b0f515cf0556991
+  data.tar.gz: ff70dbe1f9e6b1449449adb986616a77f6e682a150b21e07f4476c1f138b43d8
 SHA512:
-  metadata.gz: 407516bedbe4fa69d01ad765804aa2593966faebfa966eadac4ed08da44fb41fc7ea055b2be781194e762916784c4cb1d0bb0d4c44b9b3ad8ed23273415277f2
-  data.tar.gz: 569cdbc0465214559dd397e27d143cf3e56fbc96e1f1447c45bd18ba472ef444ec712cf16ae69837b6380de54135c3e42dd1af775f22221954b149c70f249a5c
+  metadata.gz: 90e01075d9a1bd9f5a138ee65709a55ec476f24d8f59ae4e4ff0570e381235fd04538df89cab93a3350fa9a6f449e4c6e7033ef518cf447ec23cd5bc772bce1d
+  data.tar.gz: 6463504efcf34b1024066249b0e0f558667df0e1448a8c5e5891b1f8f84b0006657e7b21a298880ad7d66d2ca4c0d8e1f38e3aab9ba4c57ec8bd4179b378f2fd

data/CHANGELOG.md

@@ -11,4 +11,12 @@
 - `DatabricksGateway::run_sql` now returns an object of type `DatabricksSQLResponse`
   - results can be accessed by `DatabricksSQLResponse::results`
   - query success can be accessed by `DatabricksSQLResponse::success?`
-- Added optional `sleep_timer` parameter to `DatabricksGateway`. This is the number of seconds to wait between checking the status of a query. Defaults to 5 seconds.
+- Added optional `sleep_timer` parameter to `DatabricksGateway`. This is the number of seconds to wait between checking the status of a query. Defaults to 5 seconds.
+
+## [0.2.1]
+- Added option to `DatabricksSQLResponse::results` to return symbolized keys
+
+## [0.3.0]
+- Update Readme
+- Remove `allowed_host` to allow pushing to multiple hosts
+- Update Gemfile to add dev and test groups

data/Gemfile

@@ -5,8 +5,15 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in dbx.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+group :development do
+  gem "rake", "~> 13.0"
+  gem "rubocop", "~> 1.21"
+end
 
-gem "rspec", "~> 3.0"
+group :test do
+  gem "rspec", "~> 3.0"
+end
 
-gem "rubocop", "~> 1.21"
+group :development, :test do
+  gem "pry"
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dbx-api (0.2.0)
+    dbx-api (0.3.0)
       dotenv (~> 2.0)
 
 GEM
@@ -9,14 +9,19 @@ GEM
   specs:
     ast (2.4.2)
     base64 (0.1.1)
+    coderay (1.1.3)
     diff-lcs (1.5.0)
     dotenv (2.8.1)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
+    method_source (1.1.0)
     parallel (1.23.0)
     parser (3.2.2.3)
       ast (~> 2.4.1)
       racc
+    pry (0.15.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
@@ -54,9 +59,11 @@ GEM
 
 PLATFORMS
   arm64-darwin-22
+  arm64-darwin-24
 
 DEPENDENCIES
   dbx-api!
+  pry
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)

data/README.md

@@ -6,7 +6,7 @@ This gem is designed to allow access to the DBX APIs (Jobs and SQL) from ruby ap
 ## Installation
 Add the following to your Gemfile to install
 ```ruby
-gem 'dbx-api', '~>0.2.0'
+gem 'dbx-api', '~>0.2.1'
 ```
 
 ## Usage
@@ -80,17 +80,38 @@ return res.results if res.success?
 puts "query failed: #{res.error_message}"
 ```
 
+The result of `DatabrucksSQLResponse.results` is always a an array of hashes with string keys. You can map over this array using whatever ruby code you like. For example:
+```ruby
+sql_response = sql_runnner.run_sql(my_query)
+
+# count the number of results
+sql_response.results.length
+```
+
+If you would prefer a symbolized hash, you can use the `symbolize_keys` option when calling `results`:
+```ruby
+sql_response.results(symbolize_keys: true)
+```
+
 Since `run_sql` returns an instance of `DatabricksSQLResponse`, you can also chain methods together:
 ```ruby
 sql_runner.run_sql("SELECT 1").results
 ```
 
+The `run_sql` method hanldes slow queries by pinging databricks at set time intervals (default 5 seconds) until the query either fails or succeeds. The default sleep_timer can be set to any desired time interval at initialization:
+```ruby
+# changing the default sleep timer to 1 second
+sql_runner = DatabricksGateway.new(sleep_timer: 1)
+```
+
 ## Development
 - After checking out the repo, run `bin/setup` to install dependencies. 
 - Set up your `.env` file as described above. 
 - Run `rake spec` to run the rspec tests.
 
 ## Build
-- Run `gem build dbx.gemspec ` to build the gem.
-- Run `gem push dbx-api-0.2.0.gem` to push the gem to rubygems.org
-  - Requires logging in to rubygems.org first via `gem login`
+- Run `gem build dbx.gemspec` to build the gem.
+- To push to RubyGems.org:
+  - Run `gem push dbx-api-[VERSION].gem` (requires logging in to rubygems.org first via `gem login`)
+- To push to Artifactory:
+  - Run `gem push dbx-api-[VERSION].gem --host https://artifactory.wu2.cloud.providence.org/artifactory/api/gems/mgl-ruby-virtual`

data/lib/dbx/databricks/sql_response.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "pry"
-
 # This class represents a response from the Databricks SQL API.
 # It is used by DatabricksSQL to handle http failures and parse the response body.
 class DatabricksSQLResponse
@@ -97,15 +95,16 @@ class DatabricksSQLResponse
     body.dig("result", "data_array") || body["data_array"] || []
   end
 
-  # Return the results of the query as an array of hashes.
+  # Return the results of the query as an array of hashes with string keys.
   # @return [Array<Hash>]
-  def results
+  def results(symbolize_keys: false)
     return [] if failed?
 
     data_array.map do |row|
       hash = {}
       columns.each do |column|
-        hash[column["name"]] = row[column["position"]]
+        key = symbolize_keys ? column["name"].to_sym : column["name"]
+        hash[key] = row[column["position"]]
       end
       hash
     end

data/lib/dbx/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: dbx-api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
-- cmmille
-autorequire:
+- Christopher Lockfeld
 bindir: exe
 cert_chain: []
-date: 2023-10-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -49,14 +48,14 @@ files:
 - lib/dbx/gateway.rb
 - lib/dbx/version.rb
 - sig/dbx.rbs
-homepage: https://github.com/pdxmolab/dbx-gem
+homepage: https://github.com/PSJH/mgl-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:
+  homepage_uri: https://github.com/PSJH/mgl-dbx-gem
+  source_code_uri: https://github.com/PSJH/mgl-dbx-gem
+  changelog_uri: https://github.com/PSJH/mgl-dbx-gem/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -71,8 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Access the Databricks API with ruby.
 test_files: []