influxdb 0.3.7 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de7cdbcf5a4222dcaa8d992605533a4b1961da0f
-  data.tar.gz: e449d025b563a796dde3412612713383a1a9f0ab
+  metadata.gz: 1338ae151de766b8f05c29b117133b19e4d993e0
+  data.tar.gz: e9f74096f0c73ca57877354f14919e02a81d5db6
 SHA512:
-  metadata.gz: 0959fc07ab3a1753edfef682273bfb5472e7b492098b8e0c466f4ebc9f24851818868bda53ef323efc5e903bb865e8f02095a46e9bac3784aae4cb271b094b3c
-  data.tar.gz: 506cd94546133b923bdb40b120364f48182124df319d1d5994be3b557679b2d52f5d2309d7530be6284e1cb5c60493844e08ecf2b9104e61ac0544d1a6437d78
+  metadata.gz: a18bb479c32e71163beb834f8141bdc4cf6ce4bb2f4e4f153ca0a0b28c820be8f765e1cc29a89d37868b7878fb6b9c9921f56347b5e9c4cf12802d9b8a7da66a
+  data.tar.gz: 2f008e1a615393c162cb1491317495f47b076484a275b6e9e01e42995b68835cd92523224d008dad24413a8b8739647cee82274e827359db5b20d75e8560dbf5

data/.rubocop.yml

@@ -22,3 +22,7 @@ Metrics/LineLength:
   Max: 100
   Exclude:
     - 'spec/**/*.rb'
+
+Metrics/ModuleLength:
+  CountComments: false  # count full line comments?
+  Max: 120

data/CHANGELOG.md

@@ -6,14 +6,18 @@ For the full commit log, [see here](https://github.com/influxdata/influxdb-ruby/
 
 - None.
 
+## v0.3.8, released 2016-08-31
+
+- Added support for named and positional query parameters (#160, @retorquere).
+
 ## v0.3.7, released 2016-08-14
 
-- Fixed `prefix` handling for `#ping` and `#version` (#157, @dimiii)
+- Fixed `prefix` handling for `#ping` and `#version` (#157, @dimiii).
 
 ## v0.3.6, released 2016-07-24
 
 - Added feature for JSON streaming response, via `"chunk_size"` parameter
-  (#155, @mhodson-qxbranch)
+  (#155, @mhodson-qxbranch).
 
 ## v0.3.5, released 2016-06-09
 
@@ -24,7 +28,7 @@ For the full commit log, [see here](https://github.com/influxdata/influxdb-ruby/
 
 - Added resample options to `Client#create_continuous_query` (#149).
 - Fixed resample options to be Ruby 1.9 compatible (#150, @SebastianCoetzee).
-- Mentioned in README, that 0.3.x series is the last one to support Ruby 1.9
+- Mentioned in README, that 0.3.x series is the last one to support Ruby 1.9.
 
 ## v0.3.3, released 2016-06-06 (yanked)
 

data/README.md

@@ -471,6 +471,23 @@ influxdb.query 'select * from time_series', epoch: 'ms'
 # [{"name"=>"time_series", "tags"=>{"region"=>"uk"}, "values"=>[{"time"=>1438411376000, "count"=>32, "value"=>0.9673}]}]
 ```
 
+Working with parameterized query strings works as expected:
+
+``` ruby
+influxdb = InfluxDB::Client.new database
+
+named_parameter_query = "select * from time_series_0 where time > %{min_time}"
+influxdb.query named_parameter_query, params: { min_time: 0 }
+# compiles to:
+#   select * from time_series_0 where time > 0
+
+positional_params_query = "select * from time_series_0 where f = %{1} and i < %{2}"
+influxdb.query positional_params_query, params: ["foobar", 42]
+# compiles to (note the automatic escaping):
+#   select * from time_series_0 where f = 'foobar' and i < 42
+```
+
+
 #### (De-) Normalization
 
 By default, InfluxDB::Client will denormalize points (received from InfluxDB as columns and rows), if you want to get _raw_ data add `denormalize: false` to initialization options or to query itself:

data/lib/influxdb/client/http.rb

@@ -4,7 +4,6 @@ require 'net/http'
 require 'net/https'
 
 module InfluxDB
-  # rubocop:disable Metrics/ModuleLength
   # rubocop:disable Metrics/MethodLength
   # rubocop:disable Metrics/AbcSize
   module HTTP # :nodoc:

data/lib/influxdb/query/builder.rb

@@ -0,0 +1,44 @@
+module InfluxDB
+  module Query # :nodoc: all
+    class Builder
+      def build(query, params)
+        case params
+        when Array    then params = params_from_array(params)
+        when Hash     then params = params_from_hash(params)
+        when NilClass then params = {}
+        else raise ArgumentError, "Unsupported #{params.class} params"
+        end
+
+        query % params
+
+      rescue KeyError => e
+        raise ArgumentError, e.message
+      end
+
+      def quote(param)
+        case param
+        when String, Symbol
+          "'" + param.to_s.gsub(/['"\\\x0]/, '\\\\\0') + "'"
+        when Integer, Float, TrueClass, FalseClass
+          param.to_s
+        else
+          raise ArgumentError, "Unexpected parameter type #{p.class} (#{p.inspect})"
+        end
+      end
+
+      private
+
+      def params_from_hash(params)
+        params.each_with_object({}) do |(k, v), hash|
+          hash[k.to_sym] = quote(v)
+        end
+      end
+
+      def params_from_array(params)
+        params.each_with_object({}).with_index do |(param, hash), i|
+          hash[(i + 1).to_s.to_sym] = quote(param)
+        end
+      end
+    end
+  end
+end

data/lib/influxdb/query/core.rb

@@ -1,7 +1,13 @@
+require_relative 'builder'
+
 module InfluxDB
   module Query # :nodoc: all
     # rubocop:disable Metrics/AbcSize
     module Core
+      def builder
+        @builder ||= Builder.new
+      end
+
       def ping
         url = URI::Generic.build(path: File.join(config.prefix, '/ping')).to_s
         get url
@@ -13,6 +19,7 @@ module InfluxDB
 
       # rubocop:disable Metrics/MethodLength
       def query(query, opts = {})
+        query = builder.build(query, opts[:params])
         denormalize = opts.fetch(:denormalize, config.denormalize)
         json_streaming = !opts.fetch(:chunk_size, config.chunk_size).nil?
 

data/lib/influxdb/version.rb

@@ -1,3 +1,3 @@
 module InfluxDB # :nodoc:
-  VERSION = "0.3.7".freeze
+  VERSION = "0.3.8".freeze
 end

data/spec/influxdb/cases/query_with_params_spec.rb

@@ -0,0 +1,69 @@
+require "spec_helper"
+
+describe InfluxDB::Client do
+  let(:subject) do
+    described_class.new "database", {
+      host: "influxdb.test",
+      port: 9999,
+      username: "username",
+      password: "password",
+      time_precision: "s"
+    }.merge(args)
+  end
+
+  let(:args) { {} }
+
+  describe "#query with parameters" do
+    let(:query) { "SELECT value FROM requests_per_minute WHERE time > %{start}" }
+    let(:query_params) { { start: 1_437_019_900 } }
+    let(:query_compiled) { "SELECT value FROM requests_per_minute WHERE time > 1437019900" }
+
+    let(:response) do
+      { "results" => [{ "series" => [{ "name" => "requests_per_minute",
+                                       "columns" => %w( time value ) }] }] }
+    end
+
+    before do
+      stub_request(:get, "http://influxdb.test:9999/query")
+        .with(query: { db: "database", precision: "s", u: "username", p: "password", q: query_compiled })
+        .to_return(body: JSON.generate(response), status: 200)
+    end
+
+    it "should handle responses with no values" do
+      # Some requests (such as trying to retrieve values from the future)
+      # return a result with no "values" key set.
+      expected_result = [{ "name" => "requests_per_minute", "tags" => nil, "values" => [] }]
+      expect(subject.query(query, params: query_params)).to eq(expected_result)
+    end
+  end
+
+  describe "#query_with_params" do
+    let(:query)           { "select * from foo where bar > %{param}" }
+    let(:compiled_query)  { subject.builder.build(query, query_params) }
+
+    context "with empty params hash" do
+      let(:query_params) { {} }
+      it { expect { compiled_query }.to raise_error ArgumentError }
+    end
+
+    context "with empty params array" do
+      let(:query_params) { [] }
+      it { expect { compiled_query }.to raise_error ArgumentError }
+    end
+
+    context "with empty params" do
+      let(:query_params) { nil }
+      it { expect { compiled_query }.to raise_error ArgumentError }
+    end
+
+    context "with simple params" do
+      let(:query_params) { { param: 42 } }
+      it { expect(compiled_query).to eq "select * from foo where bar > 42" }
+    end
+
+    context "string escaping" do
+      let(:query_params) { { param: "string" } }
+      it { expect(compiled_query).to eq "select * from foo where bar > 'string'" }
+    end
+  end
+end

data/spec/influxdb/query_builder_spec.rb

@@ -0,0 +1,61 @@
+require "spec_helper"
+
+RSpec.describe InfluxDB::Query::Builder do
+  let(:builder) { described_class.new }
+
+  describe "#quote" do
+    subject { builder }
+
+    it "should quote parameters properly" do
+      expect(subject.quote(3.14)).to eq "3.14"
+      expect(subject.quote(14)).to eq "14"
+
+      expect(subject.quote("3.14")).to eq "'3.14'"
+      expect(subject.quote("Ben Hur's Carriage")).to eq "'Ben Hur\\'s Carriage'"
+
+      expect(subject.quote(true)).to eq "true"
+      expect(subject.quote(false)).to eq "false"
+      expect(subject.quote(0 || 1)).to eq "0"
+
+      expect(subject.quote(:symbol)).to eq "'symbol'"
+    end
+  end
+
+  describe "#build" do
+    subject { builder.build(query, params) }
+
+    context "named parameters" do
+      let(:query)  { "SELECT value FROM rpm WHERE f = %{f_val} group by time(%{minutes}m)" }
+      let(:params) { { f_val: "value", minutes: 5 } }
+
+      it { is_expected.to eq "SELECT value FROM rpm WHERE f = 'value' group by time(5m)" }
+
+      context "with string keys" do
+        let(:params) { { "f_val" => "value", "minutes" => 5 } }
+
+        it { is_expected.to eq "SELECT value FROM rpm WHERE f = 'value' group by time(5m)" }
+      end
+    end
+
+    context "positional parameter" do
+      let(:query)  { "SELECT value FROM rpm WHERE time > %{1}" }
+      let(:params) { [1_437_019_900] }
+
+      it { is_expected.to eq "SELECT value FROM rpm WHERE time > 1437019900" }
+    end
+
+    context "missing parameters" do
+      let(:query)  { "SELECT value FROM rpm WHERE time > %{1}" }
+      let(:params) { [] }
+
+      it { expect { subject }.to raise_error(/key\{1\} not found/) }
+    end
+
+    context "extra parameters" do
+      let(:query)  { "SELECT value FROM rpm WHERE time > %{a}" }
+      let(:params) { { "a" => 0, "b" => 2 } }
+
+      it { is_expected.to eq "SELECT value FROM rpm WHERE time > 0" }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: influxdb
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.8
 platform: ruby
 authors:
 - Todd Persen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-14 00:00:00.000000000 Z
+date: 2016-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -132,6 +132,7 @@ files:
 - lib/influxdb/logging.rb
 - lib/influxdb/max_queue.rb
 - lib/influxdb/point_value.rb
+- lib/influxdb/query/builder.rb
 - lib/influxdb/query/cluster.rb
 - lib/influxdb/query/continuous_query.rb
 - lib/influxdb/query/core.rb
@@ -151,6 +152,7 @@ files:
 - spec/influxdb/cases/query_shard_space_spec.rb
 - spec/influxdb/cases/query_shard_spec.rb
 - spec/influxdb/cases/query_user_spec.rb
+- spec/influxdb/cases/query_with_params_spec.rb
 - spec/influxdb/cases/querying_issue_7000_spec.rb
 - spec/influxdb/cases/querying_spec.rb
 - spec/influxdb/cases/retry_requests_spec.rb
@@ -161,6 +163,7 @@ files:
 - spec/influxdb/logging_spec.rb
 - spec/influxdb/max_queue_spec.rb
 - spec/influxdb/point_value_spec.rb
+- spec/influxdb/query_builder_spec.rb
 - spec/influxdb/worker_spec.rb
 - spec/spec_helper.rb
 homepage: http://influxdb.org
@@ -198,6 +201,7 @@ test_files:
 - spec/influxdb/cases/query_shard_space_spec.rb
 - spec/influxdb/cases/query_shard_spec.rb
 - spec/influxdb/cases/query_user_spec.rb
+- spec/influxdb/cases/query_with_params_spec.rb
 - spec/influxdb/cases/querying_issue_7000_spec.rb
 - spec/influxdb/cases/querying_spec.rb
 - spec/influxdb/cases/retry_requests_spec.rb
@@ -208,5 +212,6 @@ test_files:
 - spec/influxdb/logging_spec.rb
 - spec/influxdb/max_queue_spec.rb
 - spec/influxdb/point_value_spec.rb
+- spec/influxdb/query_builder_spec.rb
 - spec/influxdb/worker_spec.rb
 - spec/spec_helper.rb