cubes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b724e61d4d283acafb582763008021ed39587c30
+  data.tar.gz: ee821dffaf098c5b6da1207651a602fa2fd0f325
+SHA512:
+  metadata.gz: f418215aade8affc24d7211f8319ed7bb5b7df16dc6aa75359bc29b5d99b7d254bba286836fa45bcf1e7d8add06d319e821080f9adbd2cd2a9731dc224a53249
+  data.tar.gz: 471dd091630673494157e07cda5151a3f3bf82d8e0aa5e9b64c9977aec93efedb26268fc5c77a8abc2e5e84ec5ef23eb1c43df952cba5a1ddcb8fa2144b8117d

data/.gitignore

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

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 David Guilherme
+
+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,78 @@
+# Cubes
+
+A wrapper for [Cubes OLAP Server](https://github.com/DataBrewery/cubes).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cubes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cubes
+
+## Configuration
+
+You can configure the Cubes::Client pass configuration options to the constructor.
+
+```ruby
+client = Cubes::Client.new(base_url: 'http://your-cubes-server:5000')
+```
+
+By default, the client uses: `base_url: 'http://localhost:5000'`.
+
+## Usage
+
+*List all cubes*
+
+```ruby
+client.cubes
+```
+
+*Fetching the model specification of a cube*
+
+```ruby
+cube = client.cube('sales')
+cube.model
+```
+
+*Aggregate the measures of a cube
+
+```ruby
+cube = client.cube('sales')
+cube.aggregate(cut: 'date:2016')
+cube.aggregate(cut: 'date:2016,5', drilldown: 'date')
+```
+
+*Generating reports*
+
+```ruby
+report = {
+  summary: {
+    query: :aggregate
+  },
+  by_year: {
+    query: :aggregate
+    drilldown: [:date],
+    rollup: :date
+  }
+}
+
+cube = client.cube('sales')
+cube.report(report_data, cut: 'date:2016')
+```
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ntxcode/cubes.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cubes"
+
+# 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/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cubes.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cubes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cubes'
+  spec.version       = Cubes::VERSION
+  spec.authors       = ['David Guilherme']
+  spec.email         = ['davidlguilherme@gmail.com']
+
+  spec.summary       = 'A Ruby wrapper for Cubes OLAP Server'
+  spec.license       = 'MIT'
+
+  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_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'byebug'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'net-http-persistent', '~> 2.9.4'
+end

data/lib/cubes.rb

@@ -0,0 +1,20 @@
+require_relative 'cubes/version'
+require_relative 'cubes/client'
+require_relative 'cubes/request'
+require_relative 'cubes/cube'
+require_relative 'cubes/error'
+require_relative 'cubes/middleware/raise_error'
+
+module Cubes
+  class << self
+    attr_writer :client
+
+    def client
+      @client ||= Cubes::Client.new
+    end
+
+    def cube(name)
+      @client.cube(name)
+    end
+  end
+end

data/lib/cubes/client.rb

@@ -0,0 +1,55 @@
+require 'faraday'
+
+module Cubes
+  class Client
+    DEFAULT_BASE_URL = 'http://localhost:5000'
+
+    # Initializes a new Client
+    #
+    # @param options [Hash]
+    # @return [Cubes::Client]
+    def initialize(options = {})
+      @base_url = options[:base_url] || DEFAULT_BASE_URL
+      @conn = Faraday.new(url: @base_url, headers: { 'Content-Type' => 'application/json' }) do |config|
+        config.use Cubes::Middleware::RaiseError
+        config.adapter :net_http_persistent
+      end
+    end
+
+    # Return server information
+    #
+    # @return [Hash]
+    def info
+      request.get('info')
+    end
+
+    # Return server version
+    #
+    # @return [Hash]
+    def version
+      request.get('version')
+    end
+
+    # List all cubes
+    #
+    # @return [Array]
+    def cubes
+      request.get('cubes')
+    end
+
+    # Instantiating a cube api
+    #
+    # @param name [String]
+    # @return [Cubes::Cube]
+    def cube(name)
+      Cubes::Cube.new(name, @conn)
+    end
+
+    private
+
+    # @return [Cubes::Request]
+    def request
+      Cubes::Request.new(@conn)
+    end
+  end
+end

data/lib/cubes/cube.rb

@@ -0,0 +1,41 @@
+module Cubes
+  class Cube
+    def initialize(name, conn)
+      @name = name
+      @conn = conn
+
+      # preload the model
+      model
+    end
+
+    def aggregate(params = {})
+      request.get('aggregate', params)
+    end
+
+    def model
+      @model ||= request.get('model')
+    end
+
+    def facts(params = {})
+      request.get('facts', params)
+    end
+
+    def fact(id)
+      request.get("fact/#{id}")
+    end
+
+    def members(dim, params = {})
+      request.get("members/#{dim}", params)
+    end
+
+    def report(data = {}, params = {})
+      request.post('report', { queries: data }, params)
+    end
+
+    private
+
+    def request
+      Cubes::Request.new(@conn, prefix: "/cube/#{@name}")
+    end
+  end
+end

data/lib/cubes/error.rb

@@ -0,0 +1,6 @@
+module Cubes
+  module Error
+    class ResourceNotFound < StandardError; end
+    class RouteNotFound < StandardError; end
+  end
+end

data/lib/cubes/middleware/raise_error.rb

@@ -0,0 +1,20 @@
+module Cubes
+  module Middleware
+    class RaiseError < Faraday::Response::Middleware
+      # Handle client errors
+      #
+      # @param env [Env]
+      def on_complete(env)
+        response = JSON.parse env.body
+
+        if response.is_a?(Hash) && response['error'] == 'not_found'
+          raise Cubes::Error::ResourceNotFound.new(response[:message])
+        end
+
+        if env[:status] == 404
+          raise Cubes::Error::RouteNotFound.new('Route not found.')
+        end
+      end
+    end
+  end
+end

data/lib/cubes/request.rb

@@ -0,0 +1,43 @@
+require 'json'
+
+module Cubes
+  class Request
+    # Initialize a Request
+    #
+    # @param conn [Faraday::Connection]
+    # @param options [Hash]
+    # @return [Cubes::Request]
+    def initialize(conn, options = {})
+      @conn = conn
+      @prefix = options.fetch(:prefix, '/')
+    end
+
+    # Send a get request
+    #
+    # @param path [String]
+    # @param params [Hash]
+    # @return [JSON]
+    def get(path, params = {})
+      path = File.join(@prefix, path)
+      JSON.parse @conn.get(path, params).body
+    end
+
+    # Send a post request
+    #
+    # @param path [String]
+    # @param data [Hash]
+    # @param params [Hash]
+    # @return [JSON]
+    def post(path, data = {}, params = {})
+      body = data.to_json
+      path = File.join(@prefix, path)
+
+      response = @conn.post(path, body) do |req|
+        req.params = params
+        req.headers['Content-Type'] = 'application/json'
+      end
+
+      JSON.parse response.body
+    end
+  end
+end

data/lib/cubes/version.rb

@@ -0,0 +1,3 @@
+module Cubes
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: cubes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Guilherme
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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: 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: faraday
+  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: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.4
+description: 
+email:
+- davidlguilherme@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cubes.gemspec
+- lib/cubes.rb
+- lib/cubes/client.rb
+- lib/cubes/cube.rb
+- lib/cubes/error.rb
+- lib/cubes/middleware/raise_error.rb
+- lib/cubes/request.rb
+- lib/cubes/version.rb
+homepage: 
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for Cubes OLAP Server
+test_files: []