gooddata 0.6.0.pre9 → 0.6.0.pre10

data/.gitignore

@@ -13,6 +13,9 @@ tmtags
 ## VIM
 *.swp
 
+## IDEA
+.idea/
+
 ## PROJECT::GENERAL
 .bundle
 coverage

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/.yardopts

@@ -0,0 +1,19 @@
+--protected
+--no-private
+--verbose
+--markup markdown
+--markup-provider redcarpet
+--asset doc/css:css
+--asset doc/images:images
+--asset doc/js:js
+--readme doc/pages/HOMEPAGE.md
+--hide-void-return
+--exclude LICENSE
+--output-dir doc/html
+--template-path doc/templates
+lib/**/*.rb
+ext/**/*{.m,.c}
+spec/**/*.rb
+-
+README.md
+doc/pages/**/*.md

data/Gemfile

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

data/README.md

@@ -0,0 +1,191 @@
+# GoodData Ruby wrapper and CLI
+
+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 which you can integrate into your application.
+
+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
+
+## Status
+
+[![Gem Version](https://badge.fury.io/rb/gooddata.png)](http://badge.fury.io/rb/gooddata)
+[![Dependency Status](https://gemnasium.com/gooddata/gooddata-ruby.png)](https://gemnasium.com/gooddata/gooddata-ruby)
+[![Code Climate](https://codeclimate.com/github/gooddata/gooddata-ruby.png)](https://codeclimate.com/github/gooddata/gooddata-ruby)
+
+## 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")
+
+    # Different server than the usual secure.gooddata.com
+    GoodData.connect("login", "pass", "https://different.server.gooddata.com")
+
+    # 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)
+
+
+#### Basic requests
+
+    GoodData.get("/gdc/md")
+
+    # This post will not actually work it is just for the illustration
+    GoodData.post("/gdc/md/#{project_id}", {:my_object => "some_date"})
+
+    # 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"
+
+    # Access raw obj
+    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
+
+You can export even whole dashboards. Currently afaik reports can be exported either as xls and png and dashboards as pdf. Hopefully it will support more in the future.
+
+    dash = GoodData::Dashboard[33807]
+    File.open('dash.pdf', 'w') do |f|
+        f.write(dash.export(:pdf))
+    end
+
+You can specify which tab to export. By default it is the first
+
+    dash = GoodData::Dashboard[33807]
+    File.open('dash.pdf', 'w') do |f|
+        f.write(dash.export(:pdf, :tab => dash.tabs_ids.last))
+    end
+
+### CLI Usage
+
+After installing the gooddata gem, GoodData is available from your command line using
+the `gooddata` command. To get a complete overview of possible options type:
+
+    gooddata help
+
+The examples and descriptions below does not cover all the options available via the CLI.
+So remember to refer back to the `help` command.
+
+Before you do anything else, a good idea is to see if your account is set up correctly and 
+that you can log in. To do this, use the `api:test` command:
+
+    gooddata api:test
+
+#### Authentication
+
+As you saw if you ran the above test command <tt>gooddata</tt> will prompt you
+for your GoodData username and password. If you don't wish to write your
+credentials each time you connect to GoodData using <tt>gooddata</tt>, you can
+create a simple gooddata credentials file called <tt>.gooddata</tt> in the root
+of your home directory. To make it easy you can just run the credentials file
+generator command which will create the file for you:
+
+    gooddata auth:store
+
+#### List available projects
+
+To get a list of projects available to your GoodData user account, run:
+
+    gooddata projects
+
+The output from the above command will look similar to this:
+
+```
+   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 `projects:show` comamnd or
+if you wish to delete the project using the `projects:delete` command.
+
+#### Create a new project
+
+To create a new project under on the GoodData servers, run:
+
+    gooddata projects:create
+
+You will then be asked about the desired project name and summary before it's created.
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself we can ignore when we pull)
+* Send us a pull request. Bonus points for topic branches.
+
+## Credits
+
+This project is developed and maintained by Pavel Kolesnikov [ <mailto:pavel@gooddata.com> / [@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
+
+Copyright (c) 2010 - 2014 GoodData Corporation and Thomas Watson Steen. See LICENSE for details.

data/Rakefile

@@ -1,8 +1,25 @@
-require "bundler/gem_tasks"
+require 'rubygems'
+
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
 require 'rake/testtask'
+require 'rspec/core/rake_task'
+
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :usage do
+  puts "No rake task specified, use rake -T to list them"
+end
 
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
   test.pattern = 'test/**/test_*.rb'
   test.verbose = true
 end
+
+YARD::Rake::YardocTask.new
+
+task :default => [:usage]

data/bin/gooddata

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+
 require 'gli'
 require 'gooddata'
 require 'highline/import'
@@ -19,27 +20,27 @@ version GoodData::VERSION
 desc 'GoodData user name'
 default_value nil
 arg_name 'gooddata-login'
-flag [:U,:username, :login]
+flag [:U, :username, :login]
 
 desc 'GoodData password'
 default_value nil
 arg_name 'gooddata-password'
-flag [:P,:password]
+flag [:P, :password]
 
 desc 'Project pid'
 default_value nil
 arg_name 'project-id'
-flag [:p,:project_id]
+flag [:p, :project_id]
 
 desc 'Server'
 default_value nil
 arg_name 'server'
-flag [:s,:server]
+flag [:s, :server]
 
 desc 'WEBDAV Server. Used for uploads of files'
 default_value nil
 arg_name 'web dav server'
-flag [:w,:webdav_server]
+flag [:w, :webdav_server]
 
 desc 'Token for project creation'
 default_value nil
@@ -48,11 +49,11 @@ flag [:t, :token]
 
 desc 'Verbose mode'
 arg_name 'verbose'
-switch [:v,:verbose]
+switch [:v, :verbose]
 
 desc 'Http logger on stdout'
 arg_name 'logger'
-switch [:l,:logger]
+switch [:l, :logger]
 
 
 desc 'Work with deployed processes'
@@ -77,7 +78,7 @@ command :process do |c|
 
   c.desc "Lists all user's processes deployed on the plaform"
   c.command :list do |list|
-    list.action do |global_options,options,args|
+    list.action do |global_options, options, args|
       opts = options.merge(global_options)
       GoodData.connect(opts)
       pp GoodData::Command::Process.list(options.merge(global_options))
@@ -86,7 +87,7 @@ command :process do |c|
 
   c.desc "Gives you some basic info about the process"
   c.command :get do |get|
-    get.action do |global_options,options,args|
+    get.action do |global_options, options, args|
       opts = options.merge(global_options)
       GoodData.connect(opts)
       pp GoodData::Command::Process.get(options.merge(global_options))
@@ -95,7 +96,7 @@ command :process do |c|
 
   c.desc "Deploys provided directory to the server"
   c.command :deploy do |deploy|
-    deploy.action do |global_options,options,args|
+    deploy.action do |global_options, options, args|
       opts = options.merge(global_options)
       GoodData.connect(opts)
       pp GoodData::Command::Process.deploy(options[:dir], options.merge(global_options))
@@ -110,7 +111,7 @@ command :api do |c|
 
   c.desc "Info about the API version etc"
   c.command :info do |info|
-    info.action do |global_options,options,args|
+    info.action do |global_options, options, args|
       opts = options.merge(global_options)
       GoodData.connect(opts)
       pp GoodData::Command::Api.info
@@ -119,7 +120,7 @@ command :api do |c|
 
   c.desc "GET request on our API"
   c.command :get do |get|
-    get.action do |global_options,options,args|
+    get.action do |global_options, options, args|
       opts = options.merge(global_options)
       GoodData.connect(opts)
       pp GoodData::Command::Api.get(args[0])
@@ -132,16 +133,16 @@ end
 desc 'Describe add here'
 arg_name 'show'
 command :profile do |c|
-  
+
   c.desc "Show your profile"
   c.command :show do |show|
-    show.action do |global_options,options,args|
+    show.action do |global_options, options, args|
       opts = options.merge(global_options)
       GoodData.connect(opts)
       pp GoodData::Command::Profile.show()
     end
   end
-  
+
 end
 
 desc 'Scaffold things'
@@ -174,23 +175,20 @@ command :project do |c|
 
   c.desc "Lists user's projects"
   c.command :list do |list|
-    list.action do |global_options,options,args|
+    list.action do |global_options, options, args|
       opts = options.merge(global_options)
       GoodData.connect(opts)
       list = GoodData::Command::Projects.list()
-      puts list.map {|p| [p.uri, p.title].join(",")}
+      puts list.map { |p| [p.uri, p.title].join(",") }
     end
   end
 
   c.desc "If you are in a gooddata project blueprint or if you provide a project id it will start an interactive session inside that project"
   c.command :jack_in do |jack|
-    jack.action do |global_options,options,args|
+    jack.action do |global_options, options, args|
       goodfile_path = GoodData::Helpers.find_goodfile(Pathname('.'))
-      goodfile = JSON.parse(File.read(goodfile_path), :symbolize_names => true)
-      model_key = goodfile[:model]
-      blueprint = GoodData::Model::ProjectBlueprint.new(eval(File.read(model_key)).to_hash) if File.exist?(model_key) && !File.directory?(model_key)
-      FileUtils::cd(goodfile_path.dirname) do
 
+      spin_session = Proc.new do |goodfile, blueprint|
         project_id = global_options[:project_id] || goodfile[:project_id]
         fail "You have to provide 'project_id'. You can either provide it through -p flag or even better way is to fill it in in your Goodfile under key \"project_id\". If you just started a project you have to create it first. One way might be through \"gooddata project build\"" if project_id.nil? || project_id.empty?
 
@@ -201,40 +199,51 @@ command :project do |c|
           GoodData.with_project(project_id) do |project|
             puts "Use 'exit' to quit the live session. Use 'q' to jump out of displaying a large output."
             binding.pry(:quiet => true,
-              :prompt => [proc { |target_self, nest_level, pry|
-                 "project_live_sesion: "
-               }])
+                        :prompt => [proc { |target_self, nest_level, pry|
+                          "project_live_sesion: "
+                        }])
           end
         rescue GoodData::ProjectNotFound => e
           puts "Project with id \"#{project_id}\" could not be found. Make sure that the id you provided is correct."
         end
       end
+
+      if goodfile_path
+        goodfile = JSON.parse(File.read(goodfile_path), :symbolize_names => true)
+        model_key = goodfile[:model]
+        blueprint = GoodData::Model::ProjectBlueprint.new(eval(File.read(model_key)).to_hash) if File.exist?(model_key) && !File.directory?(model_key)
+        FileUtils::cd(goodfile_path.dirname) do
+          spin_session.call(goodfile, blueprint)
+        end
+      else
+        spin_session.call({}, nil)
+      end
     end
   end
 
   c.desc "Create a gooddata project"
   c.command :create do |create|
-    create.action do |global_options,options,args|
+    create.action do |global_options, options, args|
       title = ask "Project name"
       summary = ask("Project summary") { |q| q.default = "" }
       template = ask("Project template")
       token = ask("token")
-      
+
       opts = options.merge(global_options)
       GoodData.connect(opts)
       project = GoodData::Command::Projects.create({
-        :title => title,
-        :summary => summary,
-        :template => template,
-        :token => token
-      })
+                                                       :title => title,
+                                                       :summary => summary,
+                                                       :template => template,
+                                                       :token => token
+                                                   })
       puts "Project '#{project.title}' with id #{project.uri} created successfully!"
     end
   end
 
   c.desc "Delete a project. Be careful this is impossible to revert"
   c.command :delete do |delete|
-    delete.action do |global_options,options,args|
+    delete.action do |global_options, options, args|
       id = global_options[:project_id]
       opts = options.merge(global_options)
       GoodData.connect(opts)
@@ -249,7 +258,7 @@ command :project do |c|
     clone.arg_name 'cloned_project_name'
     clone.flag [:n, :name]
 
-    clone.action do |global_options,options,args|
+    clone.action do |global_options, options, args|
       id = global_options[:project_id]
       name = options[:name]
       token = options[:token]
@@ -261,7 +270,7 @@ command :project do |c|
 
   c.desc "Shows basic info about a project"
   c.command :show do |show|
-    show.action do |global_options,options,args|
+    show.action do |global_options, options, args|
       id = global_options[:project_id]
       opts = options.merge(global_options)
       GoodData.connect(opts)
@@ -272,23 +281,25 @@ command :project do |c|
 
   c.desc "If you are in a gooddata project blueprint it will apply the changes. If you do not provide a project id it will build it from scratch and create a project for you."
   c.command :build do |show|
-    show.action do |global_options,options,args|
-      goodfile = JSON.parse(File.read(GoodData::Helpers.find_goodfile(Pathname('.'))), :symbolize_names => true)
-      spec_path = goodfile[:model] || fail("You need to specify the path of the build spec")
-      fail "Model path provided in Goodfile \"#{spec_path}\" does not exist" unless File.exist?(spec_path) && !File.directory?(spec_path)
-
+    show.action do |global_options, options, args|
       opts = options.merge(global_options)
-      spec_path = Pathname(spec_path)
+      GoodData.connect(opts)
+      spec, project_id = GoodData::Command::Projects.get_spec_and_project_id(".")
+      new_project = GoodData::Command::Projects.build(opts.merge(:spec => spec))
+      puts "Project was created. New project PID is #{new_project.pid}, URI is #{new_project.uri}."
+    end
+  end
 
-      content = File.read(spec_path)
-      spec = if (spec_path.extname == ".rb")
-        eval(content)
-      elsif (spec_path.extname == ".json")
-        JSON.parse(spec_path, :symbolize_names => true)
-      end
+  c.desc "If you are in a gooddata project blueprint it will apply the changes. If you do not provide a project id it will build it from scratch and create a project for you."
+  c.command :update do |show|
+    show.action do |global_options, options, args|
+
+      opts = options.merge(global_options)
       GoodData.connect(opts)
-      new_project = GoodData::Model::ProjectCreator.migrate(opts.merge(:spec => spec))
-      puts "Migration was done. New project PID is #{new_project.uri}."
+      spec, project_id = GoodData::Command::Projects.get_spec_and_project_id(".")
+      project = GoodData::Command::Projects.update(opts.merge(:spec => spec, :project_id => global_options[:project_id] || project_id))
+      puts "Migration was done. Project PID is #{project.pid}, URI is #{project.uri}."
+
     end
   end
 
@@ -299,7 +310,7 @@ command :auth do |c|
 
   c.desc "Store your credentials to ~/.gooddata so client does not have to ask you every single time"
   c.command :store do |store|
-    store.action do |global_options,options,args|
+    store.action do |global_options, options, args|
       GoodData::Command::Auth.store
     end
   end
@@ -328,30 +339,30 @@ command :run_ruby do |c|
   c.desc 'Name of the deployed process'
   c.default_value nil
   c.flag [:n, :name]
-  
+
   c.action do |global_options, options, args|
+    verbose = global_options[:verbose]
     options[:expanded_params] = if (options[:params])
-      JSON.parse(File.read(options[:params]), :symbolize_names => true)
-    else
-      {}
-    end
-    
+                                  JSON.parse(File.read(options[:params]), :symbolize_names => true)
+                                else
+                                  {}
+                                end
+
     opts = options.merge(global_options).merge({:type => "RUBY"})
     GoodData.connect(opts)
     if options[:remote]
       fail "You have to specify name of the deploy when deploying remotely" if options[:name].nil? || options[:name].empty?
       require 'gooddata/commands/process'
-      GoodData::Command::Process.run(options[:dir], opts) do
-        puts "would run"
-      end
+      GoodData::Command::Process.run(options[:dir], opts)
     else
       require 'gooddata/commands/runners'
       GoodData::Command::Runners.run_ruby_locally(options[:dir], opts)
     end
+    puts HighLine::color("Running ruby brick - DONE", HighLine::GREEN) if verbose
   end
 end
 
-pre do |global,command,options,args|
+pre do |global, command, options, args|
   require 'logger'
   GoodData.logger = Logger.new(STDOUT) if global[:l]
   username = global[:username]
@@ -362,8 +373,8 @@ pre do |global,command,options,args|
 
   username = creds[:username] if username.nil?
   password = creds[:password] if password.nil?
-  token    = creds[:auth_token] if token.nil?
-  
+  token = creds[:auth_token] if token.nil?
+
   global[:token] = token if global[:token].nil?
   global[:login] = username if global[:login].nil?
   global[:password] = password if global[:password].nil?
@@ -375,7 +386,7 @@ pre do |global,command,options,args|
   true
 end
 
-post do |global,command,options,args|
+post do |global, command, options, args|
   # Post logic here
   # Use skips_post before a command to skip this
   # block on that command only