kuji-cube 1.5.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,53 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+*.un~
+
+*.swp
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--backtrace

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem "ruby-debug", :platforms => :mri_18
+  #for 1.9.3 
+  #bash < <(curl -L https://raw.github.com/gist/1333785)
+  gem 'linecache19',       '>= 0.5.13', :platforms => :mri_19
+  gem 'ruby-debug-base19', '>= 0.11.26', :platforms => :mri_19
+  gem 'ruby-debug19', :require => 'ruby-debug', :platforms => :mri_19
+  gem "vcr"
+  gem "rspec", "~> 2.8.0"
+  gem "bundler", ">= 1.0.0"
+end

data/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: .
+  specs:
+    cube (1.4.0)
+      savon
+      webmock
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.6)
+    akami (1.0.0)
+      gyoku (>= 0.4.0)
+    archive-tar-minitar (0.5.2)
+    builder (3.0.0)
+    columnize (0.3.6)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    gyoku (0.4.4)
+      builder (>= 2.1.2)
+    httpi (0.9.5)
+      rack
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
+    linecache19 (0.5.13)
+      ruby_core_source (>= 0.1.4)
+    nokogiri (1.5.0)
+    nokogiri (1.5.0-java)
+    nori (1.0.2)
+    rack (1.4.1)
+    rbx-require-relative (0.0.9)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    ruby-debug-base19 (0.11.26)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    savon (0.9.7)
+      akami (~> 1.0)
+      builder (>= 2.1.2)
+      gyoku (>= 0.4.0)
+      httpi (~> 0.9)
+      nokogiri (>= 1.4.0)
+      nori (~> 1.0)
+      wasabi (~> 2.0)
+    vcr (1.11.3)
+    wasabi (2.0.0)
+      nokogiri (>= 1.4.0)
+    webmock (1.7.10)
+      addressable (~> 2.2, > 2.2.5)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  cube!
+  linecache19 (>= 0.5.13)
+  rspec (~> 2.8.0)
+  ruby-debug
+  ruby-debug-base19 (>= 0.11.26)
+  ruby-debug19
+  vcr

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 drKreso
+
+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,69 @@
+Cube
+================
+
+Talk to the OLAP based backend via XMLA SOAP messages from Ruby.
+You can send (simple) MDX queries and get the result back in a human friendly from. 
+
+Installation
+------------
+Add to Gemfile
+
+```
+gem 'cube'
+```
+
+Configuration
+--------------
+Set up your catalog and endpoint
+
+```
+XMLA.configure do |c|
+ c.catalog = "OUTAGE"
+ c.endpoint = "http://localhost:8383/mondrian/xmla"
+end
+```
+
+Querying the OLAP
+-------
+```
+table = XMLA::Cube.execute <<-MDX
+    SELECT [Location].[City].children  on COLUMNS,
+           [Measures].[Count] on ROWS
+    FROM [OUTAGE]"
+MDX
+```
+Table has two attributes: header and rows.
+
+Scalar results
+-----------
+```
+average_mtbf = XMLA::Cube.execute_scalar <<-MDX
+   SELECT {Hierarchize({[Measures].[MTBF]})} ON COLUMNS
+   FROM [OUTAGE]
+   WHERE [Country].[Croatia]
+MDX
+```
+
+Limitations
+------------
+* No drill down (fails to even parse the result)
+* No multi named columns
+* Tested only with icCube and Mondrian XMLA, in theory works with every XMLA provider
+
+Contributing to cube
+-------------------------------
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+----------
+
+Copyright (c) 2012 drKreso. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+
+$:.push File.expand_path("../lib", __FILE__)
+require "cube/version"
+
+begin
+  Bundler::GemHelper.install_tasks
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = Cube::VERSION
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cube #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/kuji-cube.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require "cube/version"
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["drKreso", "stellard"]
+  gem.email         = ["kresimir.bojcic@gmail.com", "scott@kujilabs.com"]
+  gem.description = "Eases the pain I had to go through to get to the data out of XMLA based OLAP provider(Mondiran, Pentaho, icCube)"
+  gem.summary = "Get's the data from OLAP cube via XMLA(Mondiran, Pentaho, icCube)"
+  gem.homepage = "http://github.com/kujilabs/cube"
+  gem.date = "2012-05-16"
+
+
+  gem.licenses = ["MIT"]
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "kuji-cube"
+  gem.require_paths = ["lib"]
+  gem.version = Cube::VERSION
+
+
+  gem.add_dependency "savon", ">= 0"
+  gem.add_dependency "webmock", ">= 0"
+
+end
+

data/lib/cube/cube.rb

@@ -0,0 +1,154 @@
+require 'savon'
+require 'bigdecimal'
+require_relative 'olap_result'
+
+Savon.configure do |config|
+  config.soap_version = 1
+  config.log = false
+end
+
+HTTPI.log = false
+
+module XMLA
+
+  class Cube
+    attr_reader :query, :catalog
+
+    def Cube.execute(query, catalog = XMLA.catalog)
+      OlapResult.new(Cube.new(query, catalog).as_table)
+    end
+
+    def Cube.execute_members(query, catalog = XMLA.catalog)
+      Cube.new(query, catalog).axes
+    end
+
+    def Cube.execute_scalar(query, catalog = XMLA.catalog)
+      BigDecimal.new Cube.new(query, catalog).as_table[0]
+    end
+
+    def as_table 
+      return [table] if y_size == 0
+      clean_table(table, y_size).reduce([]) { |result, row| result << row.flatten }
+    end
+
+    def axes
+      axes = all_axes.select { |axe| axe[:@name] != "SlicerAxis" }
+      @axes ||= axes.reduce([]) do |result, axe|
+        result << tuple(axe).reduce([]) { |y, member|
+          data = (member[0] == :member) ? member[1] : member[:member]
+          if ( data.class == Hash || data.size == 1 )
+            y << [data[:caption].strip].flatten 
+          else
+            y << data.select { |item_data| item_data.class == Hash }.reduce([]) do |z,item_data| 
+              z << item_data[:caption].strip 
+            end
+          end
+        }
+      end
+    end
+
+    private
+
+    #header and rows
+    def table
+      if (header.size == 1 && y_size == 0)
+        cell_data[0]
+      else
+        (0...y_axe.size).reduce(header) do |result, j| 
+          result << ( y_axe[j] + (0...x_size).map { |i| "#{cell_data[i + j]}" })
+        end
+      end
+    end
+
+    def header
+      [ ( (0..y_size - 1).reduce([]) { |header| header << '' } << x_axe).flatten ]
+    end
+
+
+    def initialize(query, catalog)
+      @query = query
+      @catalog = catalog
+      @response = get_response
+      self
+    end
+
+    def get_response
+      client = Savon::Client.new do
+        wsdl.document = File.expand_path("../../wsdl/xmla.xml", __FILE__)
+        wsdl.endpoint = XMLA.endpoint
+      end
+
+      @response = client.request :execute,  xmlns:"urn:schemas-microsoft-com:xml-analysis" do
+        soap.body = Cube.request_body(query, catalog)
+      end
+    end
+
+    #cleanup table so items don't repeat (if they are same)
+    def clean_table(table, number_of_colums)
+      above_row = []
+      #filter if they are not last column, and they are same as the item on the row above
+      table.reduce([]) { |result, row|
+        result <<  row.each_with_index.map do |item,i|
+          if i == number_of_colums
+            item 
+          else
+            item == above_row[i] ? '' : item 
+          end
+        end
+        above_row = row
+        result
+      }
+    end
+
+    def cell_data
+      cell_data = @response.to_hash[:execute_response][:return][:root][:cell_data]
+      return [""] if cell_data.nil? 
+      @data ||= cell_data.reduce([]) do |data, cell|
+        cell[1].reduce(data) do |data, value|
+          data << (value.class == Hash ? (value[:fmt_value] || value[:value]) : value[1] )
+        end
+      end
+    end
+
+    def tuple axe 
+      axe[:tuples].nil? ? [] : axe[:tuples][:tuple]
+    end
+
+    def all_axes
+      @response.to_hash[:execute_response][:return][:root][:axes][:axis]
+    end
+
+    def x_axe 
+      @x_axe ||= axes[0] 
+    end
+
+    def y_axe
+      @y_axe ||= axes[1]
+    end
+
+    def y_size 
+      (y_axe.nil? || y_axe[0].nil?) ? 0 : y_axe[0].size
+    end
+
+    def x_size
+      x_axe.size
+    end
+
+    def Cube.request_body(query, catalog)
+      <<-REQUEST
+      <Command>
+      <Statement> <![CDATA[ #{query} ]]> </Statement> 
+        </Command>
+        <Properties>
+        <PropertyList> 
+        <Catalog>#{catalog}</Catalog>
+        <Format>Multidimensional</Format> 
+        <AxisFormat>TupleFormat</AxisFormat>
+        </PropertyList> 
+        </Properties>
+        REQUEST
+    end
+  end
+end
+
+

data/lib/cube/olap_result.rb

@@ -0,0 +1,13 @@
+class OlapResult 
+  attr_reader :header, :rows
+  def initialize(table)
+    @header = table[0]
+    table.delete_at(0)
+    @rows = table
+  end
+
+  def prepare_data
+    result = [] << [@header] << @rows
+    result.flatten(1)
+  end
+end

data/lib/cube/version.rb

@@ -0,0 +1,3 @@
+module Cube
+  VERSION = "1.5.0"
+end

data/lib/cube/xmla.rb

@@ -0,0 +1,9 @@
+module XMLA 
+  class << self
+    attr_accessor :endpoint, :catalog
+  end
+
+  def self.configure
+    yield self if block_given?
+  end
+end

data/lib/cube.rb

@@ -0,0 +1,2 @@
+require_relative 'cube/xmla.rb'
+require_relative 'cube/cube.rb'

data/lib/wsdl/xmla.xml

@@ -0,0 +1,104 @@
+<?xml version='1.0' encoding='UTF-8' ?> 
+ <!-- Generated 04/26/01 by Microsoft SOAP Toolkit WSDL File Generator, Version 1.00.623.0 --> 
+<definitions  name ='msxmla'   targetNamespace = 'http://tempuri.org/wsdl/'
+	 xmlns:wsdlns='http://tempuri.org/wsdl/' 
+	 xmlns:typens='http://tempuri.org/type' 
+	 xmlns:soap='http://schemas.xmlsoap.org/wsdl/soap/' 
+	 xmlns:xsd='http://www.w3.org/2001/XMLSchema' 
+	 xmlns:stk='http://schemas.microsoft.com/soap-toolkit/wsdl-extension'
+	 xmlns='http://schemas.xmlsoap.org/wsdl/'> 
+  <types>
+    <schema targetNamespace='http://tempuri.org/type'
+      xmlns='http://www.w3.org/2001/XMLSchema'
+      xmlns:SOAP-ENC='http://schemas.xmlsoap.org/soap/encoding/'
+      xmlns:wsdl='http://schemas.xmlsoap.org/wsdl/'
+      elementFormDefault='qualified'>
+      <complexType  name ='clsXMLAProx.Discover.Result'>
+        <sequence>
+          <any minOccurs='0' maxOccurs='unbounded' namespace='#any' processContents='skip'/>
+        </sequence>
+      </complexType>
+      <complexType  name ='clsXMLAProx.Discover.Restrictions'>
+        <sequence>
+          <any minOccurs='0' maxOccurs='unbounded' namespace='#any' processContents='skip'/>
+        </sequence>
+      </complexType>
+      <complexType  name ='clsXMLAProx.Discover.Properties'>
+        <sequence>
+          <any minOccurs='0' maxOccurs='unbounded' namespace='#any' processContents='skip'/>
+        </sequence>
+      </complexType>
+      <complexType  name ='clsXMLAProx.Execute.Result'>
+        <sequence>
+          <any minOccurs='0' maxOccurs='unbounded' namespace='#any' processContents='skip'/>
+        </sequence>
+      </complexType>
+      <complexType  name ='clsXMLAProx.Execute.Command'>
+        <sequence>
+          <any minOccurs='0' maxOccurs='unbounded' namespace='#any' processContents='skip'/>
+        </sequence>
+      </complexType>
+      <complexType  name ='clsXMLAProx.Execute.Properties'>
+        <sequence>
+          <any minOccurs='0' maxOccurs='unbounded' namespace='#any' processContents='skip'/>
+        </sequence>
+      </complexType>
+    </schema>
+  </types>
+  <message name='clsXMLAProx.Discover'>
+    <part name='RequestType' type='xsd:string'/>
+    <part name='Restrictions' type='typens:clsXMLAProx.Discover.Restrictions'/>
+    <part name='Properties' type='typens:clsXMLAProx.Discover.Properties'/>
+  </message>
+  <message name='clsXMLAProx.DiscoverResponse'>
+    <part name='Result' type='typens:clsXMLAProx.Discover.Result'/>
+  </message>
+  <message name='clsXMLAProx.Execute'>
+    <part name='Command' type='typens:clsXMLAProx.Execute.Command'/>
+    <part name='Properties' type='typens:clsXMLAProx.Execute.Properties'/>
+  </message>
+  <message name='clsXMLAProx.ExecuteResponse'>
+    <part name='Result' type='typens:clsXMLAProx.Execute.Result'/>
+  </message>
+  <portType name='clsXMLAProxSoapPort'>
+    <operation name='Discover' parameterOrder='RequestType Restrictions Properties'>
+      <input message='wsdlns:clsXMLAProx.Discover' />
+      <output message='wsdlns:clsXMLAProx.DiscoverResponse' />
+    </operation>
+    <operation name='Execute' parameterOrder='Command Properties'>
+      <input message='wsdlns:clsXMLAProx.Execute' />
+      <output message='wsdlns:clsXMLAProx.ExecuteResponse' />
+    </operation>
+  </portType>
+  <binding name='clsXMLAProxSoapBinding' type='wsdlns:clsXMLAProxSoapPort' >
+    <stk:binding preferredEncoding='UTF-8'/>
+    <soap:binding style='rpc' transport='http://schemas.xmlsoap.org/soap/http' />
+    <operation name='Discover' >
+      <soap:operation soapAction='urn:schemas-microsoft-com:xml-analysis:Discover' />
+      <input>
+        <soap:body use='encoded' namespace='urn:schemas-microsoft-com:xml-analysis'
+		  encodingStyle='http://schemas.xmlsoap.org/soap/encoding/' />
+      </input>
+      <output>
+        <soap:body use='encoded' namespace='urn:schemas-microsoft-com:xml-analysis'
+		  encodingStyle='http://schemas.xmlsoap.org/soap/encoding/' />
+      </output>
+    </operation>
+    <operation name='Execute' >
+      <soap:operation soapAction='urn:schemas-microsoft-com:xml-analysis:Execute' />
+      <input>
+        <soap:body use='encoded' namespace='urn:schemas-microsoft-com:xml-analysis'
+		  encodingStyle='http://schemas.xmlsoap.org/soap/encoding/' />
+      </input>
+      <output>
+        <soap:body use='encoded' namespace='urn:schemas-microsoft-com:xml-analysis'
+		  encodingStyle='http://schemas.xmlsoap.org/soap/encoding/' />
+      </output>
+    </operation>
+  </binding>
+  <service name='msxmla' >
+    <port name='clsXMLAProxSoapPort' binding='wsdlns:clsXMLAProxSoapBinding' >
+      <soap:address location='http://localhost/xmla/msxisapi.dll' />
+    </port>
+  </service>
+</definitions>

data/spec/cassettes/.yml

@@ -0,0 +1,40 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: http://localhost:8383/mondrian/xmla
+    body: ! "<?xml version=\"1.0\" encoding=\"UTF-8\"?><env:Envelope xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"
+      xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:wsdl=\"http://tempuri.org/wsdl/\"
+      xmlns:env=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:ins0=\"http://tempuri.org/type\"><env:Body><Execute
+      xmlns=\"urn:schemas-microsoft-com:xml-analysis\"><Command> <Statement> <![CDATA[
+      \ ]]> </Statement> </Command> <Properties> <PropertyList> <Catalog></Catalog>\n
+      \                    <Format>Multidimensional</Format> <AxisFormat>TupleFormat</AxisFormat>
+      </PropertyList> </Properties></Execute></env:Body></env:Envelope>"
+    headers:
+      soapaction:
+      - ! '"urn:schemas-microsoft-com:xml-analysis:Execute"'
+      content-type:
+      - text/xml;charset=UTF-8
+      content-length:
+      - '612'
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - Apache-Coyote/1.1
+      content-type:
+      - text/xml
+      transfer-encoding:
+      - chunked
+      date:
+      - Sat, 11 Feb 2012 23:02:52 GMT
+    body: ! "<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>\n<SOAP-ENV:Envelope xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\"
+      SOAP-ENV:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\" >\n<SOAP-ENV:Header>\n</SOAP-ENV:Header>\n<SOAP-ENV:Body>\n<SOAP-ENV:Fault>\n
+      \ <faultcode>SOAP-ENV:Server.00HSBB01</faultcode>\n  <faultstring>XMLA SOAP
+      Body processing error</faultstring>\n  <faultactor>Mondrian</faultactor>\n  <detail>\n
+      \   <XA:error xmlns:XA=\"http://mondrian.sourceforge.net\">\n      <code>00HSBB01</code>\n
+      \     <desc>The Mondrian XML: Mondrian Error:Internal error: Unknown catalog
+      &#39;&#39;</desc>\n    </XA:error>\n  </detail>\n</SOAP-ENV:Fault>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>\n"
+    http_version: '1.1'