gooddata 0.5.12 → 0.5.13

data/README.rdoc

@@ -1,30 +1,93 @@
 = GoodData Ruby wrapper and CLI
 
-A convenient Ruby wrapper around the GoodData RESTful API.
+A convenient Ruby wrapper around the GoodData RESTful API. The gem comes in two flavors. It has a CLI client and it is a library whch you can integrate into your application.
 
-Use the Gooddata::Client class to integrate GoodData into your own application
-or use the CLI to work with GoodData directly from the command line.
-
-The best documentation for the API can be found using these resources:
+The best documentation for the GoodData API can be found using these resources:
+* http://docs.gooddata.apiary.io/
 * http://developer.gooddata.com/api
 * https://secure.gooddata.com/gdc
 
-== Usage
+== Install
+
+If you are using bundler. Add 
+
+  gem "gooddata"
+
+into Gemfile 
+
+and run 
+
+  bundle install
+
+If you are using gems just
+
+  gem install gooddata
+
+=== Library usage
+
+
+In its most simple form GoodData gem just cares about the logging in and juggling the tokens that are needed for you to retrive information. It provides you the usual HTTP methods that you are used to. Couple of examples.
+
+==== Authentiacation
+
+  GoodData.connect("login", "pass")
 
-Since this project is in its early stages, no gem have been released to rubygems.org yet.
-To install the gooddata gem, you instead have to first checkout this repository. Then install
-the gem using the rake task:
+  # Different server than the usual secure.gooddata.com
+  GoodData.connect("login", "pass", "https://different.server.gooddata.com")
 
-  rake install
+  # the last argument is passed to underlying RestClient so you can specify other useful stuff there
+  GoodData.connect("login", "pass", "https://different.server.gooddata.com", :timeout => 0)
 
-Now you are ready to use either the Ruby wrapper class or the CLI.
+==== Basic requests
 
-Alternatively you can run the source code directly. For details about this approach, see {the
-Development Wiki page}[http://github.com/gooddata/gooddata-ruby/wiki/Development].
+  GoodData.get("/gdc/md")
 
-=== Wrapper class usage
+  # This post will not actually work it is just for the illustration
+  GoodData.post("/gdc/md/#{project_id}", {:my_object => "some_date"})
 
-For details of how to use the Ruby wrapper class, see the Gooddata::Client RDoc.
+  # and the same goes for put delete
+  # By default the response is decoded for you as json but sometimes you do not want that png or other stuff.
+  # you will get the response object and you can query it further
+  response = GoodData.get("/gdc/md", :process => false)
+  response.code == 400
+  pp response.body
+
+==== Loading of data
+
+This library is able to load data but it is not used that much if at all. Since there is some data processing needed on the client side we rely on faster implementations in Java usually. Let us know if you would be interested. As the APIs improve we could bring it back.
+
+==== Other stuff
+The API is currently a little fragmented and we never had the guts to actually deal with all the ugliness and present nice object oriented API. Usually it is just better to deal with the ugly json as hashes. But there are couple of exceptions where we needed something better and we thought providing an abstraction is worth the hassle.
+
+==== Working with obj
+
+obj is a resource that is probably the oldest in all GoodData. Obj are all the objects that have something to do with the analytical engine (metrics, attributes, reports etc). You can find the docs here (Add link to apiary). There are coule of convenience methods to work with these
+
+  GoodData.connect("svarovsky@gooddata.com", "just_testing")
+  GoodData.project="fill_in_your_project_pid"
+
+  obj = GoodData::MdObject[obj_number]
+  # bunch of useful methods are defined on these
+  obj.title
+  obj.get_used_by
+  obj.get_using
+  obj.delete
+
+==== Working with reports
+Sometimes it is useful to compute reports outside of UI so there are couple of convenience methods for that.
+
+  require 'pp'
+
+  GoodData.connect("svarovsky@gooddata.com", "just_testing")
+  GoodData.project="fill_in_your_project_pid"
+
+  report = GoodData::Report[1231]
+  result = report.execute
+  pp result
+
+  File.open('png.png', 'w') do |f|
+  	f.write(report.export(:png))
+  end
 
 === CLI Usage
 
@@ -60,9 +123,9 @@ To get a list of projects available to your GoodData user account, run:
 
 The output from the above command will look similar to this:
 
-     521  Some project
-    3521  Some other project
-    3642  Some third project
+   521  Some project
+  3521  Some other project
+  3642  Some third project
 
 The first column contains the project-key. You need this if you wan't to either
 see more details about the project using the <tt>projects:show</tt> comamnd or
@@ -89,7 +152,9 @@ You will then be asked about the desired project name and summary before it's cr
 == Credits
 
 This project is developed and maintained by Pavel Kolesnikov [ mailto:pavel@gooddata.com
-/ {@koles}[http:/twitter.com/koles] ] and Thomas Watson Steen [ mailto:w@tson.dk /
+/ {@koles}[http:/twitter.com/koles] ] and Tomas Svarovsky [mailto:svarovsky.tomas@gmail.com]
+
+Special thanks to Thomas Watson Steen [ mailto:w@tson.dk /
 {@wa7son}[http://twitter.com/wa7son] ]
 
 == Copyright

data/lib/gooddata/models/dashboard.rb

@@ -0,0 +1,36 @@
+module GoodData
+  class Dashboard < GoodData::MdObject 
+
+    class << self
+      def [](id)
+        if id == :all
+          GoodData.get(GoodData.project.md['query'] + '/projectDashboard/')['query']['entries']
+        else 
+          super
+        end
+      end
+    end
+
+    def export(format, options={})
+      supported_formats = [:pdf]
+      fail "Wrong format provied \"#{format}\". Only supports formats #{supported_formats.join(', ')}" unless supported_formats.include?(format)
+      tab = options[:tab] || ""
+      x = GoodData.post("/gdc/projects/lbhjnmbwa07f9g46hnjp3l5c9hphnev9/clientexport", {"clientExport" => {"url" => "https://secure.gooddata.com/dashboard.html#project=#{GoodData.project.uri}&dashboard=#{uri}&tab=#{tab}&export=1", "name" => title}}, :process => false)
+      while (x.code == 202) do
+        sleep(1)
+        uri = JSON.parse(x.body)["asyncTask"]["link"]["poll"]
+        x = GoodData.get(uri, :process => false)
+      end
+      x
+    end
+
+    def tabs
+       content["tabs"]
+    end
+
+    def tabs_ids
+      tabs.map {|t| t["identifier"]}
+    end
+
+  end
+end

data/lib/gooddata/models/report.rb

@@ -54,15 +54,5 @@ module GoodData
       png
     end
 
-    def execute_report
-      result = GoodData.post '/gdc/xtab2/executor3', {"report_req" => {"report" => uri}}
-      data_result_uri = result["execResult"]["dataResult"]
-      result = GoodData.get data_result_uri
-      while result["taskState"] && result["taskState"]["status"] == "WAIT" do
-         sleep 10
-         result = GoodData.get data_result_uri
-       end
-       data_result_uri
-    end
   end
 end

data/lib/gooddata/version.rb

@@ -1,3 +1,3 @@
 module GoodData
-  VERSION = "0.5.12"
+  VERSION = "0.5.13"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gooddata
 version: !ruby/object:Gem::Version
-  version: 0.5.12
+  version: 0.5.13
   prerelease: 
 platform: ruby
 authors:
@@ -162,6 +162,7 @@ files:
 - lib/gooddata/extract.rb
 - lib/gooddata/helpers.rb
 - lib/gooddata/model.rb
+- lib/gooddata/models/dashboard.rb
 - lib/gooddata/models/data_result.rb
 - lib/gooddata/models/links.rb
 - lib/gooddata/models/metadata.rb