quasar_rest_client 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4573f4ab0e743f401cfef70607fab0c1b1469eb5
-  data.tar.gz: 6f3304c930a010c41e4b186fd776a4841ae8f67f
+  metadata.gz: da105ccd0c72f3dc04e764b3426613e3c7e6dc6d
+  data.tar.gz: 469a399d6fc2f048170d497faefc84727196f5fe
 SHA512:
-  metadata.gz: 495f054a0495e55766ef1d9a64be452f65249ac0c76a2be1d23ce9de4c0e124434277448ba28482b17db7ffdec88c9f78ab850730afdf72d158ebee32e60d641
-  data.tar.gz: 006013b8135e66a0e2ce556244b38f607be403959cb34baa0ffaecdb57b79a98e9902109a4d76ce967e531f290cefb413d8a6f6c6ceb8a57fb2159cb97900e78
+  metadata.gz: 711a821b75a5d903da87b3642acb867121d86e02f156a6f0443b31dc477a712fb7667b7be638f67a8079366c44a6f42e66fb1bf0c2f67337296f3d976c515e6b
+  data.tar.gz: b98c29831f3ec5cd58127a6b507de54d1144e43549245d537f0e5927dcbad446eb9027dab59d6c7eabc649207874406f56df11c104eea9202d8b1b57d32962fe

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/live_spec/config/config.yml

data/README.md

@@ -105,6 +105,20 @@ install`. To release a new version, update the version number in
 create a git tag for the version, push git commits and tags, and push
 the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Live Testing
+
+To live test the client, you will need a working quasar server, and a
+working mongodb server with data in it.
+
+The `./live_spec` directory contains the spec tests for live testing,
+and depends up on the `./live_spec/config/config.yml` file to be set
+with the appropriate information to make the connection work. You can
+copy the `./live_spec/config/config.sample.yml` file and fill in the
+details.
+
+A rake task `live_spec` is also available to make running these tests
+simpler.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at

data/Rakefile

@@ -4,3 +4,8 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+RSpec::Core::RakeTask.new(:live_spec) do |c|
+  c.pattern = 'live_spec/**{,/*/**}/*_spec.rb'
+  c.rspec_opts = '-I live_spec'
+end

data/lib/quasar_rest_client.rb

@@ -71,4 +71,29 @@ module QuasarRestClient
     proxy.simple_query
   end
 
+  # @param [String] q - query string
+  # @param [String] dest - destination collection to create
+  # @param [Hash] opts - options
+  # @return [String] JSON reponse
+  def self.long_query(q='', dest='', opts={})
+    proxy = Proxy.new(q, opts)
+    proxy.long_query(destination: dest)
+  end
+
+  # @param [String] coll - collection to retrieve
+  # @param [Hash] opts - options
+  # @return [String] JSON reponse
+  def self.get_data(coll='', opts={})
+    proxy = Proxy.new(nil, opts)
+    proxy.get_data(collection: coll)
+  end
+
+  # @param [String] coll - collection to delete
+  # @param [Hash] opts - options
+  # @return [String] JSON reponse
+  def self.delete_data(coll='', opts={})
+    proxy = Proxy.new(nil, opts)
+    proxy.delete_data(collection: coll)
+  end
+
 end

data/lib/quasar_rest_client/mogrify_vars.rb

@@ -0,0 +1,41 @@
+require 'time'
+require 'date'
+
+# Include this module
+module QuasarRestClient
+  module MogrifyVars
+
+    def mogrify_vars(hash)
+      vars = hash[:var]&.map do |k, v|
+        new_key = "var.#{k}"
+
+        # This is hacky-hack, at best
+        # E.g. given var: { email: "yacht@mail.com"} =>
+        #            var.email: '"yacht@mail.com"'
+        # i.e. quasar requires the double quotes
+        # Note that the documentation says single quotes, but it is WRONG
+        new_val = case v
+                  when String
+                    v.inspect
+                  # NOTE: order is important: DateTime must precede Date
+                  when DateTime
+                    "TIMESTAMP '#{v.strftime("%F %T")}'"
+                  when Date
+                    "DATE '#{v.strftime("%F")}'"
+                  when Time
+                    "TIME '#{v.strftime("%T")}'"
+                  when Array
+                    v.inspect
+                  else
+                    v
+                  end
+
+        [new_key, new_val]
+      end.to_h
+
+      hash.delete(:var)
+      hash.merge(vars)
+    end
+
+  end
+end

data/lib/quasar_rest_client/proxy.rb

@@ -1,8 +1,10 @@
 require "httparty"
+require "quasar_rest_client/mogrify_vars"
 
 module QuasarRestClient
   class Proxy
     include HTTParty
+    include MogrifyVars
 
     # @!attribute query_hash
     #   @return [Hash] values to form the query string for the request
@@ -36,10 +38,10 @@ module QuasarRestClient
       self.query_hash.merge!(opts)
     end
 
-    # @return [String] JSON response from query
+    # @return [String] JSON response from get query
     def simple_query
       self.class.get(
-        path,
+        '/query/fs',
         query: request_query,
         headers: request_headers,
         logger: Base.config.logger,
@@ -47,17 +49,65 @@ module QuasarRestClient
         )
     end
 
+    # @param [String] destination collection name to create for later extraction
+    # @return [String] JSON response from post query
+    def long_query(destination:)
+      fail "must provide a destination: #{destination.inspect} #{destination.class}" unless (String === destination && destination.length > 0)
+      body = query_hash.delete(:q)
+      self.class.post(
+        '/query/fs',
+        query: request_query,
+        body: body,
+        headers: request_headers.merge({"destination" => destination}),
+        logger: Base.config.logger,
+        base_uri: Base.config.endpoint
+        )
+    end
+
+    # @param [String] collection name of the collection to retrieve
+    # @return [String] JSON response
+    def get_data(collection:)
+      fail "must provide a collection: #{collection.inspect} [#{collection.class}]" unless (String === collection && collection.length > 0)
+
+      unless collection[0] == ?/
+        collection = ?/ + collection
+      end
+
+      query_hash.delete(:q)
+      query_hash.delete(:var)
+
+      self.class.get(
+        '/data/fs' + collection,
+        query: request_query,
+        headers: request_headers,
+        logger: Base.config.logger,
+        base_uri: Base.config.endpoint
+        )
+    end
+
+    # @param [String] collection name of the collection to delete
+    # @return [String] JSON response
+    def delete_data(collection:)
+      fail "must provide a collection: #{collection.inspect} [#{collection.class}]" unless (String === collection && collection.length > 0)
+
+      unless collection[0] == ?/
+        collection = ?/ + collection
+      end
+
+      self.class.delete(
+        '/data/fs' + collection,
+        headers: request_headers,
+        logger: Base.config.logger,
+        base_uri: Base.config.endpoint
+        )
+    end
+
     private
 
     def endpoint
       Base.config.endpoint
     end
 
-    # TODO: return proper path based on query type for future expansion
-    def path
-      '/query/fs'
-    end
-
     def request_headers
       {
         "accept-encoding" => '',
@@ -66,7 +116,7 @@ module QuasarRestClient
     end
 
     def request_query
-      stringify_keys(query_hash)
+      stringify_keys(mogrify_vars(query_hash))
     end
 
     def stringify_keys(hash)

data/lib/quasar_rest_client/version.rb

@@ -1,3 +1,3 @@
 module QuasarRestClient
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/live_spec/config/config.sample.yml

@@ -0,0 +1,11 @@
+## Fill in with your live testing data
+
+endpoint_host: '-'
+endpoint_port: 0
+mount: '-'
+parent: '-'
+collection: '-'
+new_collection: '-'
+where_clause: '-'
+vars:
+  brand_key: '-'

data/live_spec/live_spec.rb

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+
+require "live_spec_helper"
+require "logger"
+require 'ostruct'
+require "erb"
+require "yaml"
+
+def read_config(file = File.join(File.dirname(__FILE__), 'config', 'config.yml'))
+  conf = YAML.load(ERB.new(File.read(file)).result)
+  OpenStruct.new(conf)
+end
+
+def show_response(resp)
+  "response code:      #{resp.code} \n" +
+    "response request:   #{resp.request.uri}"
+end
+
+RSpec.describe "Live Testing" do
+  let(:config) { read_config }
+  let!(:collection_path) { ["", config.mount, config.parent, config.collection].join('/') }
+  let!(:new_collection_path) { ["", config.mount, config.parent, config.new_collection].join('/') }
+  let!(:endpoint) { "http://#{config.endpoint_host}:#{config.endpoint_port}" }
+  let!(:sql_format) { "SELECT %s FROM `#{collection_path}` WHERE #{config.where_clause}" }
+  let!(:sql_count) { sql_format % "count(*)" }
+  let!(:sql_fetch) { sql_format % "*" }
+  let!(:logger) { nil }
+
+  before do
+    QuasarRestClient.config.endpoint = endpoint
+    QuasarRestClient.config.logger = logger
+  end
+
+  it "count_query" do
+    resp = QuasarRestClient.simple_query(sql_count, var: config.vars)
+    expect(resp.code).to(eq(200), show_response(resp))
+  end
+
+  it "fetch_query" do
+    resp  = QuasarRestClient.simple_query(sql_fetch, limit: 2, var: config.vars)
+    expect(resp.code).to(eq(200), show_response(resp))
+  end
+
+  it "long_query" do
+    resp   = QuasarRestClient.long_query(sql_fetch, new_collection_path, var: config.vars)
+    expect(resp.code).to(eq(200), show_response(resp))
+  end
+
+  it "get_data" do
+    QuasarRestClient.long_query(sql_fetch, new_collection_path, var: config.vars)
+    resp    = QuasarRestClient.get_data(new_collection_path, limit: 2)
+    expect(resp.code).to(eq(200), show_response(resp))
+  end
+
+  it "delete_data" do
+    QuasarRestClient.long_query(sql_fetch, new_collection_path, var: config.vars)
+    resp    = QuasarRestClient.delete_data(new_collection_path, limit: 2)
+    expect(resp.code).to(eq(204), show_response(resp))
+  end
+
+end

data/live_spec/live_spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'quasar_rest_client'
+
+RSpec.configure do |config|
+  config.before(:example) do
+    QuasarRestClient::Base.class_variable_set(:@@config, nil)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quasar_rest_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tamara Temple
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-10 00:00:00.000000000 Z
+date: 2016-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -134,8 +134,12 @@ files:
 - lib/quasar_rest_client.rb
 - lib/quasar_rest_client/base.rb
 - lib/quasar_rest_client/config.rb
+- lib/quasar_rest_client/mogrify_vars.rb
 - lib/quasar_rest_client/proxy.rb
 - lib/quasar_rest_client/version.rb
+- live_spec/config/config.sample.yml
+- live_spec/live_spec.rb
+- live_spec/live_spec_helper.rb
 - quasar_rest_client.gemspec
 homepage: https://github.com/riverock/quasar_rest_client
 licenses: []