athens 0.3.5 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0751e4a11947a14a576b1a2b251c53af99a90b7b88e15617f810767efb3cce9
-  data.tar.gz: a6dbc5ef43c672a80df58c68159614c02a25a4b377039111d68ac104d9712473
+  metadata.gz: 4bed77ded41e5ac8bcff35169ac9fec6ffe6f2b9732aefe05c8e1fb034a0afc5
+  data.tar.gz: 1b0c5f99c343e0179a81a92b115725542704bff8a1f50884a41b48d7fd557be3
 SHA512:
-  metadata.gz: 629cb6c7f875a261ee1285b6e92acf688e51f81efaecd7423fccc14f17bc8e14b54e433a2b02a03abf3bc5c9cc0ddb8c08f3771623340e2e9d16437e448b70ef
-  data.tar.gz: d38b3a46dc522de7de9cb66e457d6a7e10d0baaa77e432262a1ff3bb01104326a405c4341bce6a1d8d77fc24fdd6b51217c8bc93a364002db364e48bd5581cca
+  metadata.gz: 598d9114124c9f842ae708b11922762a3061711a674c29827f8e7c9fc37b0a2095bc510bc1ab5525e8e0131d6ac85447e518ef9e8a4a788f7a1ddb2a3e455b97
+  data.tar.gz: 993e073ab06cbbf688d86cbb9f6de10dd587a6bc548c5cb4d53d00af30106ffc89a221e2374a53872490b7b4095a160e0fe11ea18f2de9fb018ae42981043622

data/.gitignore

@@ -8,4 +8,5 @@
 /tmp/
 
 /.vagrant/
-/ubuntu-xenial-16.04-cloudimg-console.log
+/ubuntu-xenial-16.04-cloudimg-console.log
+/vendor/

data/CHANGELOG.md

@@ -1,3 +1,51 @@
+## 0.4.1 / 2022-06-16
+
+* Specifying minimum version of `aws-sdk-core` gem for `jmespath` security issue
+
+## 0.4.0 / 2021-12-03
+
+* Added automatic parsing of JSON columns (thanks [darkside](https://github.com/darkside))
+
+#### Potentially breaking change
+
+If you were previously querying JSON type data and parsing it from a string in your own code, you'll want to remove that before upgrading.
+
+For example, with previous versions you could do this (even though it would generate a warning):
+
+```ruby
+> query = conn.execute("SELECT JSON_PARSE('{\"a\": 1, \"b\": 2}');")
+> query.wait
+> JSON.parse(query.to_a(header_row: false).first[0])
+WARNING: Unsupported type: json, defaulting to string
+ => {"a"=>1, "b"=>2}
+```
+
+After upgrading, that same code will give you an error:
+```ruby
+> JSON.parse(query.to_a(header_row: false).first[0])
+Traceback (most recent call last):
+        5: from bin/console:14:in `<main>'
+        4: from (irb):12:in `<main>'
+        3: from /home/vagrant/.rvm/rubies/ruby-3.0.0/lib/ruby/3.0.0/json/common.rb:216:in `parse'
+        2: from /home/vagrant/.rvm/rubies/ruby-3.0.0/lib/ruby/3.0.0/json/common.rb:216:in `new'
+        1: from /home/vagrant/.rvm/rubies/ruby-3.0.0/lib/ruby/3.0.0/json/common.rb:216:in `initialize'
+TypeError (no implicit conversion of Hash into String)
+```
+
+Instead just remove your json parsing since Athens handles it now:
+```ruby
+> query = conn.execute("SELECT JSON_PARSE('{\"a\": 1, \"b\": 2}');")
+> query.wait
+> query.to_a(header_row: false).first[0]
+ => {:a=>1, :b=>2}
+```
+
+
+## 0.3.6 / 2021-11-16
+
+* Addition of :result_encryption as a configuration option to change encryption options for query results (https://github.com/getletterpress/athens/issues/12)
+* Bumped development gem versions to latest releases
+
 ## 0.3.5 / 2021-05-19
 
 * Addition of :aws_profile as a configuration option for credentials (thanks [oisin](https://github.com/oisin))

data/Gemfile.lock

@@ -1,26 +1,29 @@
 PATH
   remote: .
   specs:
-    athens (0.3.5)
+    athens (0.4.0)
       aws-sdk-athena (~> 1)
+      aws-sdk-core (~> 3.131.1)
+      multi_json (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    aws-eventstream (1.1.1)
-    aws-partitions (1.458.0)
-    aws-sdk-athena (1.37.0)
-      aws-sdk-core (~> 3, >= 3.112.0)
+    aws-eventstream (1.2.0)
+    aws-partitions (1.599.0)
+    aws-sdk-athena (1.53.0)
+      aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-core (3.114.0)
+    aws-sdk-core (3.131.1)
       aws-eventstream (~> 1, >= 1.0.2)
-      aws-partitions (~> 1, >= 1.239.0)
+      aws-partitions (~> 1, >= 1.525.0)
       aws-sigv4 (~> 1.1)
-      jmespath (~> 1.0)
-    aws-sigv4 (1.2.3)
+      jmespath (~> 1, >= 1.6.1)
+    aws-sigv4 (1.5.0)
       aws-eventstream (~> 1, >= 1.0.2)
-    jmespath (1.4.0)
-    rake (13.0.3)
+    jmespath (1.6.1)
+    multi_json (1.15.0)
+    rake (13.0.6)
     rexml (3.2.5)
 
 PLATFORMS

data/README.md

@@ -92,6 +92,7 @@ Athens.configure do |config|
   config.aws_profile         = 'myprofile'  # Optional
   config.aws_region          = 'us-east-1'  # Optional
   config.wait_polling_period = 0.25         # Optional - What period should we poll for the complete query?
+  config.result_encryption   = nil          # Optional, see below
 end
 ```
 
@@ -105,6 +106,14 @@ conn = Athens::Connection.new(aws_client_override: {})
 
 Take a look at the [AWS Athena SDK](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Athena/Client.html#initialize-instance_method) for a list of all the available options.
 
+The `result_encryption` option controls how the Athens results will be encrypted at the `output_location`.  By default it's set to use the Amazon SSE encryption if you don't set it at all:
+
+```ruby
+{ encryption_option: "SSE_S3" }
+```
+
+If you set it to `nil`, it'll default to the bucket encryption settings.  You can also use a customer kms key, see https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Athena/Types/EncryptionConfiguration.html for the correct format.
+
 ### Advanced Usage
 
 Providing a database name to the connection is optional, if you omit the name you'll have to specify it in your query:
@@ -161,6 +170,12 @@ After checking out the repo, run `bin/setup` to install dependencies. You can al
 
 If you want you can use Vagrant instead, there's already a `Vagrantfile` so a simple `vagrant up` should get you setup.
 
+If you want to use Docker, grab a ruby image and boot into the console.  Then install git and bash and you can run the `bin/setup` script from there:
+
+```
+docker run --rm -it -v $(pwd):/app -w /app ruby:2.7-alpine /bin/sh -c 'apk add bash git;/bin/bash'
+```
+
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing

data/Vagrantfile

@@ -4,13 +4,11 @@
 # Provisioning script
 $script = <<SCRIPT
   echo "*** Updating packages"
-
-  sudo DEBIAN_FRONTEND=noninteractive apt-get install -y aptitude
-  sudo DEBIAN_FRONTEND=noninteractive aptitude update
-  sudo DEBIAN_FRONTEND=noninteractive aptitude -y safe-upgrade
+  sudo DEBIAN_FRONTEND=noninteractive apt-get update
+  sudo DEBIAN_FRONTEND=noninteractive apt-get upgrade
 
   echo "*** Installing new packages"
-  sudo DEBIAN_FRONTEND=noninteractive aptitude install -y curl git-core vim
+  sudo DEBIAN_FRONTEND=noninteractive apt-get install -y curl git-core vim
 
   if rvm -v 2>/dev/null; then
     echo "*** rvm already installed, skipping"
@@ -30,7 +28,7 @@ SCRIPT
 
 
 Vagrant.configure('2') do |config|
-  config.vm.box      = "ubuntu/xenial64"
+  config.vm.box      = "ubuntu/focal64"
   config.vm.hostname = 'athens-dev'
 
   # Provision the machine with the shell script above

data/athens.gemspec

@@ -34,7 +34,9 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.4'
 
+  spec.add_dependency "aws-sdk-core", "~> 3.131.1"
   spec.add_dependency "aws-sdk-athena", "~> 1"
+  spec.add_dependency 'multi_json', '~> 1.0'
 
   spec.add_development_dependency "bundler", ">= 1.17"
   spec.add_development_dependency "rake", "~> 13.0"

data/bin/setup

@@ -3,6 +3,7 @@ set -euo pipefail
 IFS=$'\n\t'
 set -vx
 
+gem install bundler:`tail -1 Gemfile.lock | xargs`
 bundle install
 
 # Do any other automated setup that you need to do here

data/lib/athens/configuration.rb

@@ -5,7 +5,8 @@ module Athens
                   :aws_region,
                   :output_location,
                   :wait_polling_period,
-                  :aws_profile
+                  :aws_profile,
+                  :result_encryption
 
     def initialize
       @aws_access_key = nil
@@ -14,6 +15,7 @@ module Athens
       @output_location = nil
       @wait_polling_period = 0.25
       @aws_profile = nil
+      @result_encryption = { encryption_option: "SSE_S3" }
     end
   end
 end

data/lib/athens/connection.rb

@@ -48,9 +48,7 @@ module Athens
       def result_config
         Aws::Athena::Types::ResultConfiguration.new(
           output_location: Athens.configuration.output_location,
-          encryption_configuration: {
-            encryption_option: "SSE_S3"
-          }
+          encryption_configuration: Athens.configuration.result_encryption
         )
       end
 

data/lib/athens/query.rb

@@ -141,7 +141,7 @@ module Athens
         metadata.column_info.each_with_index do |col, index|
           data = row.data[index].var_char_value
           nullable = ["UNKNOWN", "NULLABLE"].include?(col.nullable)
-
+          
           if nullable && data.nil?
             mapped << data
           elsif !nullable && data.nil?
@@ -166,6 +166,8 @@ module Athens
               mapped << Date.parse(data)
             when 'boolean'
               mapped << (data == "true")
+            when 'json'
+              mapped << MultiJson.load(data, symbolize_keys: true)
             else
               puts "WARNING: Unsupported type: #{col.type}, defaulting to string"
               mapped << data

data/lib/athens/version.rb

@@ -1,3 +1,3 @@
 module Athens
-  VERSION = "0.3.5"
+  VERSION = "0.4.1"
 end

data/lib/athens.rb

@@ -5,6 +5,7 @@ require "athens/connection"
 require "athens/query"
 
 require 'aws-sdk-athena'
+require 'multi_json'
 
 module Athens
   class << self

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: athens
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.1
 platform: ruby
 authors:
 - Chris Schulte
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-19 00:00:00.000000000 Z
+date: 2022-06-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.131.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.131.1
 - !ruby/object:Gem::Dependency
   name: aws-sdk-athena
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -113,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Run simple SQL queries in AWS Athena