olap-xmla 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c548c4eafca46ff15515fcf35c2ed909ecd1b48
-  data.tar.gz: c8170ff387aa70272e82fe657a4154998db5fa50
+  metadata.gz: dc2cd44de638b059ce1100815698d3f1e1d0962a
+  data.tar.gz: 3bbb73dddf0bf85a518bff8560125910cb1cd3f7
 SHA512:
-  metadata.gz: 7702dda5b69e66ab7ec2b9ded9ea69897e860be10c342f4ba3d65c97f67c94716a7f4b78bc298e99c132a5f09fe995fb0987e6c6eb8c453732b2aa9310711d41
-  data.tar.gz: 40a5c4f7cd9c8dcf04f67eff9a5568c1cb468f50ab8dae8d51b948e7356bcfc026bef34e2ad3a9575e5033949eb2d325b11ba50620a2835da52ee3334d2cb838
+  metadata.gz: 86b9440192918d7fb3d8928bbbb92f405b78663001e7c833dab1160a4690d8a06b98d656870394e1724f76401f8f7485f9a3d0bf13a5478d3d746b02e241a866
+  data.tar.gz: 7e1d9984e6df9ac4dce511589fb6289e92cc3e3adfcdc4135db3942d47bcb9eb77c37c9101e283b79847fd405670c9a474eca0aa6f20df6a086630ba72e5ce8e

data/README.md

@@ -78,7 +78,7 @@ This allows to store MDX queries in constants, while execute them with dynamic p
 Note, that you should never use these parameters directly from Rails request, as
 this may create security breach!
 
-### Using response on Query
+### Response
 
 
 You may use the response to render the results to user, or post-process it to analyse the data
@@ -99,9 +99,46 @@ response.column_values(column_num) # just one column of the response
 
 ```
 
+### Example: rendering a table on web page
+
+Typically, the request should be done in controller action, as simple as:
+
+OlapController.erb
+```ruby
+def index
+@response = Olap::Xmla.client.request 'WITH SET ... your mdx goes here';
+%>
+```
+
+and in the HTML Erb view you use iteration over the response as:
+
+index.html.erb
+```ruby
+<table>
+  <thead><tr>
+        <% for dim in @response.dimensions %><th><%= dim[:name] %></th><% end %>
+        <% for m in @response.measures %><th><%= m[:caption] %></th><% end %>
+    </tr></thead>
+  <tbody>
+    <% for row in @response.rows %>
+    <tr>
+       <% for label in row[:labels] %>
+        <td><%= label[:value] %></td>
+       <% end %>
+      <% for value in row[:values] %>
+          <td><%= value[:fmt_value] || value[:value] %></td>
+      <% end %>
+    </tr>
+    <% end %>
+  </tbody>
+</table>
+```
+
+Have fun!
+
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/olap-xmla/fork )
+1. Fork it ( https://github.com/Wondersoft/olap-xmla/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/olap/xmla.rb

@@ -38,6 +38,7 @@ module Olap
     #  * +:catalog+ - the name of catalog (required)
     #  * +:open_timeout+ - open timeout to connect to XMLA server, optional, default is 60 sec
     #  * +:read_timeout+ - open timeout to read data from XMLA server, optional, default is 300 sec
+    #  * +:verbose+ - if set to true, write MDX requests to console. Default is false
     #
     #
     def self.client connect_options = {}

data/lib/olap/xmla/client.rb

@@ -9,6 +9,7 @@ class Olap::Xmla::Client
 
     @catalog = catalog
     @data_source = data_source
+    @verbose = options[:verbose]
     @client = Savon.client do
       endpoint server
       namespace "urn:schemas-microsoft-com:xml-analysis"
@@ -44,6 +45,7 @@ class Olap::Xmla::Client
   def request mdx_request, parameters = {}
 
     mdx = mdx_request.clone
+    puts mdx if @verbose
 
     parameters.each{|k,v|
       mdx.gsub!(k,v)
@@ -62,7 +64,7 @@ class Olap::Xmla::Client
       raise "Error executing #{mdx} in #{catalog} #{data_source}: #{r.http_error} #{r.soap_fault}"
     end
 
-    Olap::Xmla::Response.new r.body[:execute_response][:return][:root]
+    Olap::Xmla::Response.new r.body[:execute_response][:return][:root], mdx
 
   end
 

data/lib/olap/xmla/response.rb

@@ -1,9 +1,10 @@
 class Olap::Xmla::Response
 
-  attr_reader :response
+  attr_reader :mdx, :response
 
-  def initialize response
+  def initialize response, mdx
     @response = response
+    @mdx = mdx
   end
 
   # Returns true if the response has any data

data/lib/olap/xmla/version.rb

@@ -1,5 +1,5 @@
 module Olap
   module Xmla
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/olap-xmla.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Olap::Xmla::VERSION
   spec.authors       = ["studnev"]
   spec.email         = ["aleksey@wondersoft.ru"]
-  spec.summary       = %q{Pure Ruby gem to make MDX queries on OLAP databases using XMLA connection}
-  spec.description   = %q{Can be used with any XMLA-compliant server, like Olaper or Mondrian.}
+  spec.summary       = %q{OLAP XMLA gem}
+  spec.description   = %q{Pure Ruby gem to make MDX queries on OLAP databases using XMLA connection. Can be used with any XMLA-compliant server, like Olaper or Mondrian.}
   spec.homepage      = "https://github.com/Wondersoft/olap-xmla"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: olap-xmla
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - studnev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-23 00:00:00.000000000 Z
+date: 2016-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,7 +66,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.5.1
-description: Can be used with any XMLA-compliant server, like Olaper or Mondrian.
+description: Pure Ruby gem to make MDX queries on OLAP databases using XMLA connection.
+  Can be used with any XMLA-compliant server, like Olaper or Mondrian.
 email:
 - aleksey@wondersoft.ru
 executables: []
@@ -108,7 +109,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Pure Ruby gem to make MDX queries on OLAP databases using XMLA connection
+summary: OLAP XMLA gem
 test_files:
 - spec/gem_spec.rb
 - spec/spec_helper.rb