datavirtuality_rest 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4472c398087483906413dab58918157ccc11a430
+  data.tar.gz: fe5d4f9277c9fff790744d46ab9d1a60dcee324e
+SHA512:
+  metadata.gz: 3c8af863c25768a5cbac4402ed614cbbdf34c7970f1f0683f8c244cad550f6a474e5d450497fc1b64ccae24dceceedba75eab04b344d8ad0b749a3897d0df62b
+  data.tar.gz: 8b6b95b2775f908e9d34f0c53f38ef1210a66e58a0f19becddb6b114e1facebbe6206695a02b3f7b485624a2841694047ce07148c43ea8379aa4a1a0ec64b1ef

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Data Virtuality GmbH
+
+MIT License
+
+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,40 @@
+# DataVirtuaity REST Client
+
+Easy way to retrieve data from your DataVirtuality server via the REST API to consume data in any Ruby application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'datavirtuality_rest'
+
+And then execute:
+
+    $ bundle
+
+Or install it manually:
+
+    $ gem install datavirtuality_rest
+
+## Usage Examples
+
+First instantiate your client by specifying the server URL, username and password:
+
+    > client = DataVirtuality::Rest.new('http://127.0.0.1:8080', '<USER NAME>', '<PASSWORD>')
+
+Now you can retrieve data in two ways:
+
+1. Read a full table or view by specifying the full schema and path, separated by a slash:
+
+        > client.get('views/demo_view')
+        => [{:id=>"438256", :date=>"2017-04-01", :hits=>331}, {:id=>"438918", :date=>"2017-04-01", :hits=>314}]
+
+
+2. Specify a customer SQL query to gain full flexibility:
+
+        > client.query('SELECT * FROM views.demo_view')
+        => [{:id=>"438918", :date=>"2017-04-01", :hits=>886}, {:id=>"431936", :date=>"2017-02-02", :hits=>389}])
+
+## Contributing
+
+Are you using Ruby to access data from Data Virtuality? Do you have any feedback or are you missing additional functionality? Just let us know by creating an issue or pull request to get in touch with us.

data/lib/datavirtuality.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'datavirtuality/rest'
+require 'datavirtuality/rest_exception'
+
+# DataVirtuality client module
+module DataVirtuality
+end

data/lib/datavirtuality/rest.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'httpclient'
+require 'json'
+require 'json/ext'
+
+module DataVirtuality
+  # DataVirtuality REST client
+  class Rest
+    def initialize(host, username, password)
+      @host = host
+      @username = username
+      @password = password
+
+      @http_client = HTTPClient.new
+      @http_client.set_auth(host, username, password)
+    end
+
+    def status
+      json_response(http_get('status'))&.[](:status)&.downcase&.to_sym
+    end
+
+    def data_sources
+      json_response(http_get('source')).map { |h| h[:Name] }
+    end
+
+    def get(table)
+      json_response(http_get('source/' + table))
+    end
+
+    def query(sql)
+      json_response(http_post('query?array=false', sql: sql))
+    end
+
+    private
+
+    attr_reader :http_client, :host, :username, :password
+
+    def http_get(path)
+      response = http_client.get endpoint(path)
+
+      { status: response.status, body: response.body }
+    end
+
+    def http_post(path, body)
+      response = http_client.post(
+        endpoint(path),
+        body.to_json,
+        'Content-Type' => 'application/json'
+      )
+
+      { status: response.status, body: response.body }
+    end
+
+    def endpoint(path)
+      host + '/rest/api/' + path
+    end
+
+    def json_response(result)
+      if result[:status] != 200
+        error = begin
+          JSON.parse result[:body]
+        rescue => e
+          raise RestException, e.message
+        end
+
+        raise RestException, error['description'], error['hint']
+      end
+
+      JSON.parse result[:body], symbolize_names: true
+    end
+  end
+end

data/lib/datavirtuality/rest_exception.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module DataVirtuality
+  # Exception for errors returned from DataVirtuality REST API
+  class RestException < RuntimeError
+    def initialize(message, hint = nil)
+      super(message)
+      @hint = hint
+    end
+
+    attr_reader :hint
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: datavirtuality_rest
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- DataVirtuality GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: 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: vcr
+  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: webmock
+  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: rubocop
+  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: Enables easy access to DataVirtuality via its REST API
+email: support@datavirtuality.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/datavirtuality.rb
+- lib/datavirtuality/rest.rb
+- lib/datavirtuality/rest_exception.rb
+homepage: http://www.datavirtuality.com
+licenses:
+- MIT
+metadata: {}
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A REST client for DataVirtuality
+test_files: []