athens 0.3.0 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 901ae482186b3f1eeb424ee6bc4c09f5122aa7ba20028e7bc88015f0f8eff840
-  data.tar.gz: a42a0b004300dd61da4d1bf3fc96aace76c94fa0ba7760a8ca81a4a736cb77e2
+  metadata.gz: b0751e4a11947a14a576b1a2b251c53af99a90b7b88e15617f810767efb3cce9
+  data.tar.gz: a6dbc5ef43c672a80df58c68159614c02a25a4b377039111d68ac104d9712473
 SHA512:
-  metadata.gz: e89fc662abb5ee87ab4612ddc90cadfb2259f0e33e6e3d59a73f0b759dbf675239630ef9f8835d88746ad72726404eb9db5d451eb5d84ad0bdcb4c1ceffd23c5
-  data.tar.gz: c15ce346a50f27fd2f684928bf1761145b848b1d80b9503faad4b5ffcd3cf35b49aa8d3fe719bd6da0210e2a5094cc0ff3e7a38026e1361521f8404738d09fca
+  metadata.gz: 629cb6c7f875a261ee1285b6e92acf688e51f81efaecd7423fccc14f17bc8e14b54e433a2b02a03abf3bc5c9cc0ddb8c08f3771623340e2e9d16437e448b70ef
+  data.tar.gz: d38b3a46dc522de7de9cb66e457d6a7e10d0baaa77e432262a1ff3bb01104326a405c4341bce6a1d8d77fc24fdd6b51217c8bc93a364002db364e48bd5581cca

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+## 0.3.5 / 2021-05-19
+
+* Addition of :aws_profile as a configuration option for credentials (thanks [oisin](https://github.com/oisin))
+* Fix for BigDecimal in Ruby 3.x (thanks [mediafinger](https://github.com/mediafinger))
+* Bumped development gem versions to latest releases
+
+## 0.3.4 / 2021-03-02
+
+* Added configurable polling period (thanks [jesseproudman](https://github.com/jesseproudman))
+
+## 0.3.3 / 2021-01-12
+
+* Added support for Ruby 3.0 (thanks [blackjiro](https://github.com/blackjiro))
+
+## 0.3.2 / 2020-11-24
+
+* Added optional `request_token` and `work_group` parameters to the query execute method (thanks [mediafinger](https://github.com/mediafinger))
+
+## 0.3.1 / 2020-07-20
+
+* Bumped development rake version from 0.10 to 0.13 for security fixes
+* Fixed warning about string defaulting to string (#2)
+
 ## 0.3.0 / 2019-07-02
 
 * Added enumerator-based result access methods: `#rows` and `#records`

data/Gemfile.lock

@@ -1,33 +1,36 @@
 PATH
   remote: .
   specs:
-    athens (0.3.0)
+    athens (0.3.5)
       aws-sdk-athena (~> 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    aws-eventstream (1.0.1)
-    aws-partitions (1.136.0)
-    aws-sdk-athena (1.7.0)
-      aws-sdk-core (~> 3, >= 3.39.0)
-      aws-sigv4 (~> 1.0)
-    aws-sdk-core (3.46.0)
-      aws-eventstream (~> 1.0)
-      aws-partitions (~> 1.0)
-      aws-sigv4 (~> 1.0)
+    aws-eventstream (1.1.1)
+    aws-partitions (1.458.0)
+    aws-sdk-athena (1.37.0)
+      aws-sdk-core (~> 3, >= 3.112.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-core (3.114.0)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.239.0)
+      aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sigv4 (1.0.3)
+    aws-sigv4 (1.2.3)
+      aws-eventstream (~> 1, >= 1.0.2)
     jmespath (1.4.0)
-    rake (10.5.0)
+    rake (13.0.3)
+    rexml (3.2.5)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   athens!
-  bundler (~> 1.17)
-  rake (~> 10.0)
+  bundler (>= 1.17)
+  rake (~> 13.0)
+  rexml (~> 3.2)
 
 BUNDLED WITH
-   1.17.2
+   2.2.5

data/README.md

@@ -44,8 +44,8 @@ When your query is done, grab the results as an array:
 ```ruby
 results = query.to_a
 # [
-#   ['column_1', 'column_2', 'column_3'], 
-#   [15, 'data', true], 
+#   ['column_1', 'column_2', 'column_3'],
+#   [15, 'data', true],
 #   [20, 'foo', false],
 #   ...
 # ]
@@ -55,7 +55,7 @@ Or as a hash (which is really an array where each row is a hash):
 ```ruby
 results = query.to_h
 # [
-#   {'column_1': 15, 'column_2': 'data', 'column_3': true}, 
+#   {'column_1': 15, 'column_2': 'data', 'column_3': true},
 #   {'column_1': 20, 'column_2': 'foo', 'column_3': false},
 #   ...
 # ]
@@ -87,9 +87,11 @@ Configure your AWS settings in an `Athens.configure` block (in rails put this in
 ```ruby
 Athens.configure do |config|
   config.output_location = "s3://my-bucket/my-folder/athena/results/"  # Required
-  config.aws_access_key = 'access'     # Optional
-  config.aws_secret_key = 'secret'     # Optional
-  config.aws_region     = 'us-east-1'  # Optional
+  config.aws_access_key      = 'access'     # Optional
+  config.aws_secret_key      = 'secret'     # Optional
+  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?
 end
 ```
 
@@ -146,6 +148,13 @@ query.cancel   # Attempts to cancel an in-progress query, returns true or false
 query.to_a(header_row: false)  # If you want your query results returned without a header row of column names
 ```
 
+The execute method also optionally supports the `request_token` and `work_group` [parameters](https://docs.aws.amazon.com/athena/latest/APIReference/API_StartQueryExecution.html#API_StartQueryExecution_RequestSyntax):
+
+```ruby
+conn = Athens::Connection.new(database: 'sample')
+query = conn.execute("SELECT * FROM mytable", request_token: single_use_token, work_group: my_work_group)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -165,3 +174,4 @@ The gem is available as open source under the terms of the [WTFPL License](http:
 ## Code of Conduct
 
 Everyone interacting in the Athens project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/getletterpress/athens/blob/master/CODE_OF_CONDUCT.md).
+

data/Rakefile

@@ -1,2 +1 @@
 require "bundler/gem_tasks"
-task :default => :spec

data/athens.gemspec

@@ -32,10 +32,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '~> 2.4'
+  spec.required_ruby_version = '>= 2.4'
 
   spec.add_dependency "aws-sdk-athena", "~> 1"
 
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", ">= 1.17"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rexml", "~> 3.2"
 end

data/lib/athens/configuration.rb

@@ -1,15 +1,19 @@
 module Athens
   class Configuration
-    attr_accessor :aws_access_key, 
+    attr_accessor :aws_access_key,
                   :aws_secret_key,
                   :aws_region,
-                  :output_location
+                  :output_location,
+                  :wait_polling_period,
+                  :aws_profile
 
     def initialize
       @aws_access_key = nil
       @aws_secret_key = nil
       @aws_region = nil
       @output_location = nil
+      @wait_polling_period = 0.25
+      @aws_profile = nil
     end
   end
-end
+end

data/lib/athens/connection.rb

@@ -8,10 +8,11 @@ module Athens
     def initialize(database: nil, aws_client_override: {})
       @database_name = database
 
-      client_config = { 
+      client_config = {
         access_key_id: Athens.configuration.aws_access_key,
         secret_access_key: Athens.configuration.aws_secret_key,
-        region: Athens.configuration.aws_region
+        region: Athens.configuration.aws_region,
+        profile: Athens.configuration.aws_profile
       }.merge(aws_client_override).compact
 
       @client = Aws::Athena::Client.new(client_config)
@@ -19,26 +20,28 @@ module Athens
 
     # Runs a query against Athena, returning an Athens::Query object
     # that you can use to wait for it to finish or get the results
-    def execute(query)
+    def execute(query, request_token: nil, work_group: nil)
       if @database_name
         resp = @client.start_query_execution(
           query_string: query,
           query_execution_context: context,
-          result_configuration: result_config
+          result_configuration: result_config,
+          client_request_token: request_token,
+          work_group: work_group
         )
       else
         resp = @client.start_query_execution(
           query_string: query,
           result_configuration: result_config
         )
-      end        
+      end
 
       return Athens::Query.new(self, resp.query_execution_id)
     end
 
     private
 
-      def context 
+      def context
         Aws::Athena::Types::QueryExecutionContext.new(database: @database_name)
       end
 

data/lib/athens/query.rb

@@ -14,6 +14,7 @@ module Athens
 
       version = RUBY_VERSION.split('.').map {|v| v.to_i}
       @decimal_without_new = (version[0] >= 2 && version[1] >= 5)
+      @decimal_without_new = (version[0] == 2 && version[1] >= 5) || (version[0] >= 3)
     end
 
     def state
@@ -49,7 +50,7 @@ module Athens
         end
 
         # Wait a bit and check again
-        sleep(0.25)
+        sleep(Athens.configuration.wait_polling_period.to_f)
       end
     end
 
@@ -151,7 +152,7 @@ module Athens
               mapped << data.to_i
             when 'timestamp'
               mapped << Time.parse(data)
-            when 'varchar'
+            when 'varchar', 'string'
               mapped << data
             when 'float', 'double'
               mapped << data.to_f
@@ -173,9 +174,8 @@ module Athens
         end
 
         return mapped
-      end    
+      end
 
 
   end
 end
-

data/lib/athens/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: athens
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.5
 platform: ruby
 authors:
 - Chris Schulte
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-07-02 00:00:00.000000000 Z
+date: 2021-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-athena
@@ -28,14 +28,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.17'
 - !ruby/object:Gem::Dependency
@@ -44,14 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.2'
 description: Allows you to easily access AWS Athena databases and run queries
 email:
 - chris@oceanbreezesoftware.com
@@ -84,13 +98,13 @@ metadata:
   homepage_uri: https://github.com/getletterpress/athens
   source_code_uri: https://github.com/getletterpress/athens
   changelog_uri: https://github.com/getletterpress/athens/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -99,9 +113,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: Run simple SQL queries in AWS Athena
 test_files: []