crate_ruby 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d47fe15133585ee74801da1c280a14bf00fe6701b333d73a7510255402b52069
-  data.tar.gz: 07f33bb5146cfca6501f60ae97a7988ba2731164061b75147bc1a1b5bff4b4fc
+  metadata.gz: eb9fbd3574170da32b20d02c56f1666cf82334458b62809bb1d6d49f37684a8e
+  data.tar.gz: 632eeb1dca28f6a61c5be2efb6c60c97e0e31e12a0b1de4f9bed77efa7867695
 SHA512:
-  metadata.gz: f8b9c72c33cbdf281ad6bcf9ea20d763ef28f21e48678bd4cd02401e9e7fda10209926aa66f9e66d6e3a1b48014ef12a270bf2cf0ca3ba147e32da79c28b5344
-  data.tar.gz: ea217acc07d3eb78913b283b0acf04529dea2f4e3cb49f2a72d9ccdcaa6521acd69ee7264b37561a815aa81372887604afcb83d82c6139fdb92e7ab1572827f3
+  metadata.gz: dbaf409d34f4df0c2fc9b61ee568da033247e7e1b9faf7afea2fd4e676034847bbea949c63b85ba6ade9514427858af34e6772c069d9df86ebb56d91a6f3a9d5
+  data.tar.gz: cf3fb53674c6698c6ad620d3ba7e4377402809dff96de55f1d0f7ad9b1ab2cc52df9caf7b29d383f5911d4bee83db50b61f31a9a126644fd63cf33b455c5c31b

data/CHANGES.rst

@@ -0,0 +1,69 @@
+####################
+crate_ruby changelog
+####################
+
+
+unreleased
+==========
+
+0.2.2
+=====
+
+- CI: Validated on recent versions of Ruby up to 4.1-dev
+
+
+0.2.1
+=====
+
+- Prevent Base64 wrapping in basic auth headers, when the username/password for a
+  CrateDB cluster is particularly long. Thanks, @ahorner.
+
+- Drop support for EOL Ruby versions. Thanks, @hammerhead.
+
+- Add support for Ruby 3.1.
+
+
+0.2.0
+=====
+
+- Add SSL support
+
+
+0.1.0
+=====
+
+- HTTP Basic Authentication support that comes with 2.3.0
+
+
+0.0.9
+=====
+
+- Fix breaking changes that kept driver from working with crate > v2.0
+- Remove Ruby 1.9.3 from ``travis.yml``
+- Client now supports HTTP options
+- Update ``travis.yml`` and fix broken test
+
+
+0.0.8
+=====
+
+- Undocumented gem release
+
+
+0.0.7
+=====
+
+- Use prepared statements for insert
+
+
+0.0.6
+=====
+
+- Now officially supported by Crate Data and available under the
+  Apache 2.0 License
+
+
+0.0.5
+=====
+
+- ``#execute`` now supports parameter substitution

data/LICENSE

@@ -1,19 +1,3 @@
-CRATE Ruby
-Copyright 2013-2015 CRATE Technology GmbH ("Crate")
-
-
-Licensed to CRATE Technology GmbH (referred to in this notice as "Crate")
-under one or more contributor license agreements.  See the NOTICE file
-distributed with this work for additional information regarding copyright
-ownership.
-
-Crate licenses this software to you under the Apache License, Version 2.0.
-However, if you have executed another commercial license agreement with
-Crate these terms will supersede the license and you may use the software
-solely pursuant to the terms of the relevant commercial agreement.
-
-
-=========================================================================
 
 
                                  Apache License

data/NOTICE

@@ -1,11 +1,24 @@
-Crate Ruby
-Copyright 2013-2015 CRATE Technology GmbH ("Crate")
+CrateDB Ruby
+Copyright 2013-2022 Crate.IO GmbH ("Crate")
 
 
-=========================================================================
+Licensed to Crate.IO GmbH (referred to in this notice as "Crate") under one or
+more contributor license agreements.
 
-Copyright (2014) by Christoph Klocker (http://www.vedanova.com)
-Special thanks go to Christoph for launching and writing the
-main parts of this project.
+Unless otherwise stated, every component of the CrateDB Ruby is licensed under
+the Apache License, Version 2.0.
 
-=========================================================================
+Third-party components bundled with the CrateDB Ruby are listed in the LICENSE
+file along with their respective licenses. Any additional mandatory notices
+pertaining to those dependencies will be reproduced in this file.
+
+Crate provides pre-built releases for convenience, also known as convenience
+releases. Building the CrateDB Ruby from source pulls in a number of additional
+third-party dependencies. Hence, convenience releases will contain a mix of
+CrateDB Ruby source code and third-party build-time dependencies not listed in
+the LICENSE file or in this file.
+
+Crate is committed to only using permissively licensed third-party code.
+However, for the time being, if you make use of convenience releases, it is
+your responsibility to check the licensing status of the bundled third-party
+build-time dependencies.

data/README.rst

@@ -1,53 +1,69 @@
-===================
+###################
 CrateDB Ruby Client
-===================
+###################
+
+.. image:: https://github.com/crate/crate_ruby/workflows/Tests/badge.svg
+   :target: https://github.com/crate/crate_ruby/actions?workflow=Tests
+   :alt: Build Status
 
 .. image:: https://badge.fury.io/rb/crate_ruby.svg
-   :target: http://badge.fury.io/rb/crate_ruby
+   :target: https://rubygems.org/gems/crate_ruby
    :alt: Gem Version
 
-.. image:: https://travis-ci.org/crate/crate_ruby.svg?branch=master
-   :target: https://travis-ci.org/crate/crate_ruby
-   :alt: Build Status
+.. image:: https://badgen.net/rubygems/dt/crate_ruby
+   :target: https://rubygems.org/gems/crate_ruby
+   :alt: Total downloads
 
-.. image:: https://codeclimate.com/github/crate/crate_ruby.png
-   :target: https://codeclimate.com/github/crate/crate_ruby
-   :alt: Code Climate
 
 |
 
-A Ruby client library for CrateDB_.
+A Ruby client library for the CrateDB HTTP interface.
+
+- Query execution support.
+- DDL command and schema introspection shortcuts.
+- Support for BLOB tables.
+- Foundation for the `activerecord-crate-adapter`_.
+
 
+*************
 Prerequisites
-=============
+*************
 
 You will need Ruby 2.0 or greater.
 
+
+************
 Installation
-============
+************
 
-The CrateDB Ruby client is available as a Ruby gem_.
+The CrateDB Ruby client is available on RubyGems.org, see `crate_ruby on RubyGems.org`_.
 
-Add this line to your application's ``Gemfile``::
+To use it, add this line to your application's ``Gemfile``::
 
     gem 'crate_ruby'
 
-Or, install it manually, like so::
+Or install it manually::
+
+    gem install crate_ruby
+
 
-    $ gem install crate_ruby
+********
+Synopsis
+********
 
-Examples
-========
+Set up the client.
 
-Set up the client like so::
+.. code:: ruby
 
     require 'crate_ruby'
 
-    client = CrateRuby::Client.new
+    client = CrateRuby::Client.new()
 
-Execute SQL queries like so::
+Execute SQL queries.
 
-    result = client.execute("Select * from posts")
+.. code:: ruby
+
+    result = client.execute("SELECT * FROM posts")
      => #<CrateRuby::ResultSet:0x00000002a9c5e8 @rowcount=1, @duration=5>
 
     result.each do |row|
@@ -59,13 +75,19 @@ Execute SQL queries like so::
      => ["id", "my_column", "my_integer_col"]
 
 
-Perform parameter substitution like so::
+Perform parameter substitution.
+
+.. code:: ruby
 
      client.execute(
          "INSERT INTO posts (id, title, tags) VALUES (\$1, \$2, \$3)",
          [1, "My life with crate", ['awesome', 'cool']])
 
-Manipulate BLOBs like so::
+Manipulate BLOBs.
+
+.. code:: ruby
+
+    require 'digest'
 
     digest = Digest::SHA1.file(file_path).hexdigest
 
@@ -82,51 +104,61 @@ Manipulate BLOBs like so::
     # deletion
     client.blob_delete(table_name, digest)
 
-Schema support
+A default schema can be set by passing in the schema name.
+
+.. code:: ruby
+
+    CrateRuby::Client.new(['localhost:4200'], schema: 'my_schema')
+
+Authentication credentials can be passed to the client if needed.
 
-    A default schema can be set by passing in the schema name::
+.. code:: ruby
 
-    CrateRuby::Client.new(['localhost:44200'], schema: 'my_schema')
+    CrateRuby::Client.new(['localhost:4200'], username: 'foo', password: 'supersecret')
 
-Authentication
+SSL can be enabled.
 
-    Authentication credentials can be passed to the client if needed::
+.. code:: ruby
 
-    CrateRuby::Client.new(['localhost:44200'], username: 'foo', password: 'supersecret')
+    CrateRuby::Client.new(['localhost:4200'], ssl: true)
 
 
-Version matrix
-==============
-+--------------+------------+
-| Crate Ruby   | CrateDB    |
-+==============+============+
-| < 0.9        | < 0.57     |
-+--------------+------------+
-| 0.9          | >= 0.57    |
-+--------------+------------+
+*****
+Notes
+*****
 
+See also `CrateDB examples for Ruby`_ for a basic example program, which
+exercises both the `crate_ruby`_ driver, as well as Ruby's canonical `pg`_
+driver.
+
+
+************
 Contributing
-============
+************
 
-This project is primarily maintained by Crate.io_, but we welcome community
-contributions!
+This project is primarily maintained by `Crate.IO GmbH`_,
+but we welcome community contributions!
 
 See the `developer docs`_ and the `contribution docs`_ for more information.
 
+
+****
 Help
-====
+****
 
 Looking for more help?
 
-- Check `StackOverflow`_ for common problems
-- Chat with us on `Slack`_
-- Get `paid support`_
+- Check out our `support channels`_
+
 
+.. _activerecord-crate-adapter: https://github.com/crate/activerecord-crate-adapter
 .. _contribution docs: CONTRIBUTING.rst
-.. _Crate.io: https://crate.io
+.. _Crate.IO GmbH: https://crate.io
 .. _CrateDB: https://github.com/crate/crate
+.. _CrateDB examples for Ruby: https://github.com/crate/cratedb-examples/tree/main/by-language/ruby
+.. _crate_ruby: https://rubygems.org/gems/crate_ruby
+.. _crate_ruby on RubyGems.org: https://rubygems.org/gems/crate_ruby
 .. _developer docs: DEVELOP.rst
 .. _gem: https://rubygems.org/
-.. _paid support: https://crate.io/pricing/
-.. _Slack: https://crate.io/docs/support/slackin/
-.. _StackOverflow: https://stackoverflow.com/tags/crate
+.. _pg: https://rubygems.org/gems/pg
+.. _support channels: https://crate.io/support/

data/lib/crate_ruby/client.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 #
-# Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
+# Licensed to Crate.IO GmbH ("Crate") under one or more contributor
 # license agreements.  See the NOTICE file distributed with this work for
 # additional information regarding copyright ownership.  Crate licenses
 # this file to you under the Apache License, Version 2.0 (the "License");
@@ -25,8 +27,8 @@ require 'base64'
 module CrateRuby
   # Client to interact with Crate.io DB
   class Client
-    DEFAULT_HOST = '127.0.0.1'.freeze
-    DEFAULT_PORT = '4200'.freeze
+    DEFAULT_HOST = '127.0.0.1'
+    DEFAULT_PORT = '4200'
 
     attr_accessor :logger, :schema, :username, :password
 
@@ -198,7 +200,7 @@ module CrateRuby
 
     def insert(table_name, attributes)
       vals = attributes.values
-      identifiers = attributes.keys.map {|v| %{"#{v}"} }.join(', ')
+      identifiers = attributes.keys.map { |v| %("#{v}") }.join(', ')
       binds = vals.count.times.map { |i| "$#{i + 1}" }.join(',')
       stmt = %{INSERT INTO "#{table_name}" (#{identifiers}) VALUES(#{binds})}
       execute(stmt, vals)
@@ -223,7 +225,7 @@ module CrateRuby
       host, port = @servers.first.split(':')
       http = Net::HTTP.new(host, port)
       http.use_ssl = true if @ssl
-      return http
+      http
     end
 
     def request(req, http_options = {})
@@ -243,7 +245,7 @@ module CrateRuby
     end
 
     def encrypted_credentials
-      @encrypted_credentials ||= Base64.encode64 "#{username}:#{password}"
+      @encrypted_credentials ||= Base64.strict_encode64 "#{username}:#{password}"
     end
   end
 end

data/lib/crate_ruby/error.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 #
-# Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
+# Licensed to Crate.IO GmbH ("Crate") under one or more contributor
 # license agreements.  See the NOTICE file distributed with this work for
 # additional information regarding copyright ownership.  Crate licenses
 # this file to you under the Apache License, Version 2.0 (the "License");
@@ -21,5 +23,6 @@
 module CrateRuby
   # Base Error class
   class CrateError < StandardError; end
+
   class BlobExistsError < CrateError; end
 end

data/lib/crate_ruby/result_set.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 #
-# Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
+# Licensed to Crate.IO GmbH ("Crate") under one or more contributor
 # license agreements.  See the NOTICE file distributed with this work for
 # additional information regarding copyright ownership.  Crate licenses
 # this file to you under the Apache License, Version 2.0 (the "License");

data/lib/crate_ruby/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 #
-# Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
+# Licensed to Crate.IO GmbH ("Crate") under one or more contributor
 # license agreements.  See the NOTICE file distributed with this work for
 # additional information regarding copyright ownership.  Crate licenses
 # this file to you under the Apache License, Version 2.0 (the "License");
@@ -19,5 +21,5 @@
 # software solely pursuant to the terms of the relevant commercial agreement.
 
 module CrateRuby
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.2'
 end

data/lib/crate_ruby.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 #
-# Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
+# Licensed to Crate.IO GmbH ("Crate") under one or more contributor
 # license agreements.  See the NOTICE file distributed with this work for
 # additional information regarding copyright ownership.  Crate licenses
 # this file to you under the Apache License, Version 2.0 (the "License");
@@ -18,18 +20,16 @@
 # with Crate these terms will supersede the license and you may use the
 # software solely pursuant to the terms of the relevant commercial agreement.
 
-require 'crate_ruby/version'
-require 'crate_ruby/error'
-require 'crate_ruby/result_set'
-require 'crate_ruby/client'
-
-include CrateRuby
-
 module CrateRuby
+  require 'crate_ruby/version'
+  require 'crate_ruby/error'
+  require 'crate_ruby/result_set'
+  require 'crate_ruby/client'
+
   def self.logger
     @logger ||= begin
       require 'logger'
-      log = Logger.new(STDERR)
+      log = Logger.new($stderr)
       log.level = Logger::INFO
       log
     end

metadata

@@ -1,18 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: crate_ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Christoph Klocker
-- CRATE Technology GmbH
-autorequire: 
+- Crate.IO GmbH
 bindir: bin
 cert_chain: []
-date: 2018-04-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: os
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -31,77 +44,137 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.99'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.99'
-description: A Ruby interface for Crate.IO. Put your data to work. Simply.
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.40'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby library for the CrateDB HTTP interface with query support, DDL
+  command and schema introspection shortcuts, and support for BLOB tables.
 email:
 - office@crate.io
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- CHANGES.rst
+- LICENSE
+- NOTICE
+- README.rst
 files:
-- ".gitignore"
-- ".travis.yml"
-- CONTRIBUTING.rst
-- DEVELOP.rst
-- Gemfile
+- CHANGES.rst
 - LICENSE
 - NOTICE
 - README.rst
-- Rakefile
-- crate_ruby.gemspec
-- devtools/create_tag.sh
-- history.txt
 - lib/crate_ruby.rb
 - lib/crate_ruby/client.rb
 - lib/crate_ruby/error.rb
 - lib/crate_ruby/result_set.rb
 - lib/crate_ruby/version.rb
-- log/.keep
-- spec/bootstrap.rb
-- spec/crate_ruby/client_spec.rb
-- spec/crate_ruby/result_set_spec.rb
-- spec/spec_helper.rb
-- spec/support/test_cluster.rb
-- spec/uploads/get_logo-crate.png
-- spec/uploads/logo-crate.png
-- spec/uploads/text.txt
-homepage: http://crate.io
+homepage: https://crate.io
 licenses:
 - Apache-2.0
-metadata: {}
-post_install_message: 
-rdoc_options: []
+metadata:
+  bug_tracker_uri: https://github.com/crate/crate_ruby/issues
+  changelog_uri: https://github.com/crate/crate_ruby/blob/main/CHANGES.rst
+  documentation_uri: https://www.rubydoc.info/gems/crate_ruby
+  homepage_uri: https://crate.io
+  source_code_uri: https://github.com/crate/crate_ruby
+  rubygems_mfa_required: 'true'
+rdoc_options:
+- "--title"
+- CrateDB HTTP client library for Ruby
+- "--main"
+- README.rst
+- "--line-numbers"
+- "--inline-source"
+- "--quiet"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 4.0.2
 specification_version: 4
-summary: A simple interface for the Crate.IO database.
-test_files:
-- spec/bootstrap.rb
-- spec/crate_ruby/client_spec.rb
-- spec/crate_ruby/result_set_spec.rb
-- spec/spec_helper.rb
-- spec/support/test_cluster.rb
-- spec/uploads/get_logo-crate.png
-- spec/uploads/logo-crate.png
-- spec/uploads/text.txt
+summary: CrateDB HTTP client library for Ruby
+test_files: []