quasar_rest_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4573f4ab0e743f401cfef70607fab0c1b1469eb5
+  data.tar.gz: 6f3304c930a010c41e4b186fd776a4841ae8f67f
+SHA512:
+  metadata.gz: 495f054a0495e55766ef1d9a64be452f65249ac0c76a2be1d23ce9de4c0e124434277448ba28482b17db7ffdec88c9f78ab850730afdf72d158ebee32e60d641
+  data.tar.gz: 006013b8135e66a0e2ce556244b38f607be403959cb34baa0ffaecdb57b79a98e9902109a4d76ce967e531f290cefb413d8a6f6c6ceb8a57fb2159cb97900e78

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at tamouse@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in quasar_rest_client.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,25 @@
+
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Bluewater, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,116 @@
+# QuasarRestClient
+
+Wrap the [Quasar](http://quasar-analytics.org/ "Quasar NoSQL Analytics
+Engine")  [RESTful API](http://quasar-analytics.org/docs/restapi/
+"Quasar RESTful API Documentation") to drop into Ruby applications.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'quasar_rest_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install quasar_rest_client
+
+## Usage
+
+### Configuration
+
+#### Endpoint
+
+Stores the endpoint of the Quasar service:
+
+    QuasarRestClient.config.endpoint = 'http://example.com'
+
+#### Logger
+
+Stores an optional logger object implementing the `Logger` interface.
+
+    require 'logger'
+    QuasarRestClient.config.logger = Logger.new($stderr)
+
+#### Alternate configuration style
+
+You can also perform the configuration in block-style
+
+    require 'logger'
+    QuasarRestClient.configure do |config|
+	  config.endpoint = 'http://example.com'
+      config.logger = Logger.new($stderr)
+    end
+
+### Queries
+
+#### Simple Query
+
+##### REQUEST
+
+`QuasarRestClient.simple_query(query, options)`
+
+* Calls your quasar instance with a simple query as described in
+http://quasar-analytics.org/docs/restapi/#small-query
+
+* `query` [String] -- contains the SQL^2 query string, for example:
+
+        SELECT * from `/sample/data/SampleJSON` WHERE state="WA"
+
+  Note that the documentation is wrong about quoting. The source name
+  (and other database names) should be **backticked** (like in
+  Postgresql) and strings need to be surrounded with **double
+  quotes**, not single quotes.
+
+* `options` [Hash] -- a hash object with the following key:
+
+  * `limit` [Numeric Value] -- number of records to retrieve in this
+    query
+
+  * `offset` [Numeric Value] -- record to start retreival at
+    (zero-based)
+
+  * `var` [Hash] -- a hash of key-value pairs where the key
+    corresponds to a variable name used in the query string.
+
+##### RESPONSE
+
+The call responds with a JSON object with the result of the query,
+which could either be data or an error.
+
+## Exceptions
+
+There are no exceptions raised explicitly in the library, but
+underlying libraries may raise them, and as this is a networked
+utility, one could get errors because of the inherent instability of
+the network.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install
+dependencies. Then, run `rake test` to run the tests. You can also run
+`bin/console` for an interactive prompt that will allow you to
+experiment.
+
+To install this gem onto your local machine, run `bundle exec rake
+install`. To release a new version, update the version number in
+`version.rb`, and then run `bundle exec rake release`, which will
+create a git tag for the version, push git commits and tags, and push
+the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/riverock/quasar_rest_client.
+
+This project is intended to be a safe, welcoming space for
+collaboration, and contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of
+conduct.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/_guard-core

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application '_guard-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "_guard-core")

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "quasar_rest_client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/guard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "guard")

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+bundle binstub rake
+bundle binstub rspec-core
+bundle binstub guard

data/lib/quasar_rest_client/base.rb

@@ -0,0 +1,7 @@
+module QuasarRestClient
+  class Base
+    def self.config
+      return @@config ||= Config.new
+    end
+  end
+end

data/lib/quasar_rest_client/config.rb

@@ -0,0 +1,8 @@
+require "ostruct"
+
+module QuasarRestClient
+
+  class Config < OpenStruct
+  end
+
+end

data/lib/quasar_rest_client/proxy.rb

@@ -0,0 +1,78 @@
+require "httparty"
+
+module QuasarRestClient
+  class Proxy
+    include HTTParty
+
+    # @!attribute query_hash
+    #   @return [Hash] values to form the query string for the request
+    attr_accessor :query_hash
+
+    # Set up the proxy object
+    #
+    # @param [String] q -- the SQL^2 query string passed in WITHOUT encoding
+    # @param [Hash] opts -- options to pass along to the Quasar request
+    # @option opts [Integer] :limit -- limit to the number of records retrieved
+    # @option opts [Integer] :offset -- starting record
+    # @option opts [Hash] :var -- variable substitutions for parametric queries
+    #
+    # @example
+    # For the last option, `:var`, the hash keys match the variable name used in
+    # the query string. For example, given a query string of:
+    #
+    #     SELECT * WHERE pop < :cutoff
+    #
+    # @example
+    #
+    # The var hash should have:
+    #
+    #     { cutoff: 100 }
+    #
+    # To set the value of the cutoff.
+    #
+    def initialize(q='', opts={})
+      self.query_hash = Hash.new
+      self.query_hash[:q] = q
+      self.query_hash.merge!(opts)
+    end
+
+    # @return [String] JSON response from query
+    def simple_query
+      self.class.get(
+        path,
+        query: request_query,
+        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" => '',
+        "accept" => "application/json"
+      }
+    end
+
+    def request_query
+      stringify_keys(query_hash)
+    end
+
+    def stringify_keys(hash)
+      hash.map do |k,v|
+        [k.to_s, v]
+      end.to_h
+    end
+  end
+end

data/lib/quasar_rest_client/version.rb

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

data/lib/quasar_rest_client.rb

@@ -0,0 +1,74 @@
+# coding: utf-8
+require "quasar_rest_client/version"
+require "quasar_rest_client/base"
+require "quasar_rest_client/config"
+require "quasar_rest_client/proxy"
+
+# A small library to provide basic interaction with the
+# [Quasar Rest API](http://quasar-analytics.org/docs/restapi/).
+#
+# Copyright © 2016 Bluewater, LLC.
+#
+# MIT License
+#
+
+module QuasarRestClient
+
+  # Provide block-style configuration:
+  #
+  #     QuasarRestClient.configure do |config|
+  #       config.endpoint = 'http://example.com'
+  #     end
+  def self.configure
+    yield Base.config
+  end
+
+  # Access the configuration to set and retrieve information
+  #
+  #     QuasarRestClient.config.endpoint # => returns value
+  #     QuasarRestClient.config.endpoint = 'https://example.com' # => sets endpoint
+  #
+  def self.config
+    return Base.config
+  end
+
+  # Call Quasar with a simple query
+  #
+  # @param [String] q -- the SQL^2 query string passed in WITHOUT encoding
+  # @param [Hash] opts -- options to pass along to the Quasar request
+  # @option [Integer] :limit -- limit to the number of records retrieved
+  # @option [Integer] :offset -- starting record
+  # @option [Hash] :var -- variable substitutions for parametric queries
+  #
+  # For the last option, :var, the hash keys match the variable name used in
+  # the query string. For example, given a query string of:
+  #
+  #     SELECT * WHERE pop < :cutoff
+  #
+  # The var hash should have:
+  #
+  #     { cutoff: 100 }
+  #
+  # To set the value of the cutoff.
+  #
+  #
+  # Example:
+  # --------
+  #
+  #     QuasarRestClient.simple_query(
+  #       'SELECT * WHERE pop < :cutoff',
+  #       {
+  #         limit: 10,
+  #         offset: 20,
+  #         var: {
+  #           cutoff: 100
+  #         }
+  #       }
+  #     )
+  #
+  def self.simple_query(q='', opts={})
+    proxy = Proxy.new(q, opts)
+    proxy.simple_query
+  end
+
+end

data/quasar_rest_client.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'quasar_rest_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "quasar_rest_client"
+  spec.version       = QuasarRestClient::VERSION
+  spec.authors       = ["Tamara Temple"]
+  spec.email         = ["tamara.temple@bluewaterbrand.com"]
+
+  spec.summary       = %q{Wraps the Quasar RESTful API in a client library.}
+  spec.homepage      = "https://github.com/riverock/quasar_rest_client"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0.14"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: quasar_rest_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tamara Temple
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: guard
+  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: guard-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'
+description: 
+email:
+- tamara.temple@bluewaterbrand.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/_guard-core
+- bin/console
+- bin/guard
+- bin/rake
+- bin/rspec
+- bin/setup
+- lib/quasar_rest_client.rb
+- lib/quasar_rest_client/base.rb
+- lib/quasar_rest_client/config.rb
+- lib/quasar_rest_client/proxy.rb
+- lib/quasar_rest_client/version.rb
+- quasar_rest_client.gemspec
+homepage: https://github.com/riverock/quasar_rest_client
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Wraps the Quasar RESTful API in a client library.
+test_files: []