hexspace 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e6fed1043e747b39d0f3cac055db4944d36f18bfaa9acdb4fc88660ade262667
+  data.tar.gz: a3355ff1add5cece58bc2b68914e34a2c5442f0c6f93e8f59612d0c327990b5f
+SHA512:
+  metadata.gz: 167a600cd3dd38e4659d1e6466ed0af80b3286571905777525355217c57fb3e6de1a837b38d2d6673b97758cf5c4a5b0d37fe760dc4ebd4cea4d69536758e9fc
+  data.tar.gz: 6727b019ce070e47f1fc0244ac372e37b18dd3a319f21db038d1800fc0129a5c43b023a276afe9de8446266d2526669888a281fd4da9c0222f009abf79e432eb

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 (2021-01-24)
+
+- First release

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,98 @@
+# Hexspace
+
+Ruby client for Apache Spark SQL and Apache Hive
+
+[![Build Status](https://github.com/ankane/hexspace/workflows/build/badge.svg?branch=master)](https://github.com/ankane/hexspace/actions)
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'hexspace'
+```
+
+## Getting Started
+
+Create a client
+
+```ruby
+client = Hexspace::Client.new
+```
+
+Execute queries
+
+```ruby
+client.execute("SELECT 'world' AS hello")
+```
+
+## Connection Options
+
+There are a number of connection options available.
+
+```ruby
+Hexspace::Client.new(
+  host: "localhost",
+  port: 10000,
+  username: "user",
+  password: "secret",
+  database: "default",
+  mode: :sasl,
+  timeout: 10
+)
+```
+
+Supported modes are `:sasl`, `:nosasl`, `:http`, and `:https`. Please create an issue if you need Kerberos.
+
+The timeout is in seconds and only applies to `:sasl` and `:nosasl`.
+
+## Spark SQL Setup
+
+Download [Apache Spark](https://spark.apache.org/downloads.html) and start the [Thift server](https://spark.apache.org/docs/latest/sql-distributed-sql-engine.html).
+
+```sh
+./sbin/start-thriftserver.sh
+```
+
+## Hive Setup
+
+Download [Apache Hive](https://hive.apache.org/downloads.html) and initialize the schema.
+
+```sh
+./bin/schematool -dbType derby -initSchema
+```
+
+Then start the [HiveServer2](https://cwiki.apache.org/confluence/display/Hive/Setting+Up+HiveServer2).
+
+```sh
+./bin/hiveserver2
+```
+
+It can take a minute or two to be ready. To debug, pass `--hiveconf hive.root.logger=DEBUG,console`.
+
+## History
+
+View the [changelog](https://github.com/ankane/hexspace/blob/master/CHANGELOG.md)
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/hexspace/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/hexspace/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/ankane/hexspace.git
+cd hexspace
+bundle install
+
+# create a database
+beeline -u jdbc:hive2://localhost:10000 -e 'CREATE DATABASE hexspace_test;'
+
+# run the tests
+bundle exec rake test
+```

data/lib/hexspace.rb

@@ -0,0 +1,16 @@
+# dependencies
+require "thrift"
+
+# thrift
+require "hexspace/tcli_service_constants"
+require "hexspace/tcli_service_types"
+require "hexspace/tcli_service"
+
+# modules
+require "hexspace/client"
+require "hexspace/sasl_transport"
+require "hexspace/version"
+
+module Hexspace
+  class Error < StandardError; end
+end

data/lib/hexspace/client.rb

@@ -0,0 +1,130 @@
+module Hexspace
+  class Client
+    attr_reader :client, :transport, :session
+
+    def initialize(host: "localhost", port: nil, username: nil, password: nil, database: nil, mode: :sasl, timeout: nil)
+      # could use current user in the future (like beeline)
+      username ||= "anonymous"
+      password ||= "anonymous"
+
+      # TODO support kerberos
+      # TODO support ssl for sockets
+      @transport =
+        case mode
+        when :sasl
+          socket = Thrift::Socket.new(host, port || 10000, timeout)
+          # TODO support authzid
+          SaslTransport.new(socket, username: username, password: password)
+        when :nosasl
+          socket = Thrift::Socket.new(host, port || 10000, timeout)
+          Thrift::BufferedTransport.new(socket)
+        when :http, :https
+          raise ArgumentError, "timeout not supported with #{mode}" if timeout
+
+          uri_class = mode == :http ? URI::HTTP : URI::HTTPS
+          uri = uri_class.build(host: host, port: port || 10001, path: "/cliservice")
+
+          t = Thrift::HTTPClientTransport.new(uri)
+          t.add_headers({"Authorization" => "Basic #{Base64.strict_encode64("#{username}:#{password}")}"})
+          t
+        else
+          raise ArgumentError, "Invalid mode: #{mode}"
+        end
+      @transport.open
+
+      protocol = Thrift::BinaryProtocol.new(@transport)
+      @client = TCLIService::Client.new(protocol)
+
+      req = TOpenSessionReq.new
+      if database
+        req.configuration = {"use:database" => database}
+      end
+      @session = @client.OpenSession(req)
+      check_status @session
+
+      ObjectSpace.define_finalizer(self, self.class.finalize(@transport, @client, @session))
+    end
+
+    def execute(statement, timeout: nil)
+      result = execute_statement(statement, timeout: timeout)
+      process_result(result)
+    end
+
+    # private
+    def self.finalize(transport, client, session)
+      proc do
+        req = TCloseSessionReq.new
+        req.sessionHandle = session.sessionHandle
+        client.CloseSession(req)
+        transport.close
+      end
+    end
+
+    private
+
+    def check_status(obj)
+      if obj.status.statusCode != TStatusCode::SUCCESS_STATUS
+        raise Error, obj.status.errorMessage
+      end
+    end
+
+    def execute_statement(statement, async: false, timeout: nil)
+      req = TExecuteStatementReq.new
+      req.sessionHandle = session.sessionHandle
+      req.statement = statement
+      req.runAsync = async
+      req.queryTimeout = timeout if timeout
+      result = client.ExecuteStatement(req)
+      check_status result
+      result
+    end
+
+    def process_result(stmt)
+      req = TGetResultSetMetadataReq.new
+      req.operationHandle = stmt.operationHandle
+      metadata = client.GetResultSetMetadata(req)
+      check_status metadata
+
+      rows = []
+      columns = metadata.schema.columns.map(&:columnName)
+
+      loop do
+        req = TFetchResultsReq.new
+        req.operationHandle = stmt.operationHandle
+        req.maxRows = 10_000
+        result = client.FetchResults(req)
+        check_status result
+
+        new_rows = 0
+        start_offset = result.results.startRowOffset
+
+        result.results.columns.each_with_index do |col, j|
+          name = columns[j]
+          value = col.get_value
+
+          if j == 0
+            new_rows = value.values.size
+            new_rows.times do
+              rows << {}
+            end
+          end
+
+          offset = start_offset
+          nulls = value.nulls.unpack1("b*")
+          value.values.each do |v|
+            rows[offset][name] = nulls[offset] == "1" ? nil : v
+            offset += 1
+          end
+        end
+
+        break if new_rows < req.maxRows && !result.hasMoreRows
+      end
+
+      req = TCloseOperationReq.new
+      req.operationHandle = stmt.operationHandle
+      check_status client.CloseOperation(req)
+
+      rows
+    end
+  end
+end