gooddata 0.6.0.pre10 → 0.6.0.pre11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 143aa38816bd648dc9f03a63e2453432ccf2581f
+  data.tar.gz: 3e5d3940d94a67474d14400def5addfc0e91e92a
+SHA512:
+  metadata.gz: 793043d0ffccb3d565b6c5458b2a7a6358acd77995e4a3fb9302dea6c85ea2c6193f69487f0b63392caaafb501149203b754a4bf62a82c5db7231a092a97ee20
+  data.tar.gz: e2814af4b8916f9a1b25fe34938ac3955b43418385a8495fff639ccd436006a3a66042d668a1f51fb7b819d2c86eb28048cd9e0fc3feb9fdc290102e35284354

data/.autotest

@@ -0,0 +1,2 @@
+# Customize autotest behavior here
+

data/.gitignore

@@ -24,3 +24,6 @@ pkg
 
 ## PROJECT::SPECIFIC
 Gemfile.lock
+
+# YARD
+.yardoc/

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.0
+  - ruby-head
+
+script: rake test:unit

data/.yardopts

@@ -1,3 +1,5 @@
+--template-path doc/templates
+--plugin rspec
 --protected
 --no-private
 --verbose
@@ -10,10 +12,9 @@
 --hide-void-return
 --exclude LICENSE
 --output-dir doc/html
---template-path doc/templates
 lib/**/*.rb
 ext/**/*{.m,.c}
-spec/**/*.rb
+spec/**/*_spec.rb
 -
 README.md
 doc/pages/**/*.md

data/README.md

@@ -1,10 +1,11 @@
-# GoodData Ruby wrapper and CLI
+# GoodData API 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:
 
+ * sdk.gooddata.com/gooddata-ruby/
  * http://docs.gooddata.apiary.io/
  * http://developer.gooddata.com/api
  * https://secure.gooddata.com/gdc
@@ -14,16 +15,17 @@ The best documentation for the GoodData API can be found using these resources:
 [![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)
+[![Build Status](https://travis-ci.org/korczis/gooddata-ruby.png?branch=refactor)](https://travis-ci.org/korczis/gooddata-ruby)
 
 ## Install
 
-If you are using bundler. Add 
+If you are using bundler. Add
 
     gem "gooddata"
 
-into Gemfile 
+into Gemfile
 
-and run 
+and run
 
     bundle install
 
@@ -31,145 +33,6 @@ 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.
@@ -182,10 +45,10 @@ 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 Tomas Svarovsky <mailto:svarovsky.tomas@gmail.com>
+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> / [@fluke777](http://twitter.com/fluke777)]
 
 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.
+Copyright (c) 2010 - 2014 GoodData Corporation and Thomas Watson Steen. See LICENSE for details.

data/Rakefile

@@ -8,18 +8,35 @@ 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
+RSpec::Core::RakeTask.new(:test)
+
+namespace :test do
+  desc "Run unit tests"
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.pattern = 'spec/unit/**/*.rb'
+  end
+
+  desc "Run integration tests"
+  RSpec::Core::RakeTask.new(:integration) do |t|
+    t.pattern = 'spec/integration/**/*.rb'
+  end
+
+  # Rake::TestTask.new(:legacy) do |test|
+  #   test.libs << 'lib' << 'test'
+  #   test.pattern = 'test/**/test_*.rb'
+  #   test.verbose = true
+  # end
+
+  task :all => [:unit, :integration]
 end
 
+desc "Run all tests"
+task :test => 'test:all'
+
 YARD::Rake::YardocTask.new
 
 task :default => [:usage]

data/bin/gooddata

@@ -1,404 +1,7 @@
 #!/usr/bin/env ruby
 
-require 'gli'
-require 'gooddata'
-require 'highline/import'
-require 'gooddata/commands/projects'
-require 'gooddata/commands/auth'
-require 'gooddata/commands/scaffold'
-require 'gooddata/commands/process'
-require 'gooddata/commands/api'
-require 'gooddata/commands/profile'
-require 'pp'
+require "gooddata/cli/cli"
 
-include GLI::App
+res = GoodData::CLI.main(ARGV)
 
-program_desc 'GoodData Ruby gem - a wrapper over GoodData API and several useful abstractions to make your everyday usage of GoodData easier.'
-
-version GoodData::VERSION
-
-desc 'GoodData user name'
-default_value nil
-arg_name 'gooddata-login'
-flag [:U, :username, :login]
-
-desc 'GoodData password'
-default_value nil
-arg_name 'gooddata-password'
-flag [:P, :password]
-
-desc 'Project pid'
-default_value nil
-arg_name 'project-id'
-flag [:p, :project_id]
-
-desc 'Server'
-default_value nil
-arg_name 'server'
-flag [:s, :server]
-
-desc 'WEBDAV Server. Used for uploads of files'
-default_value nil
-arg_name 'web dav server'
-flag [:w, :webdav_server]
-
-desc 'Token for project creation'
-default_value nil
-arg_name 'token'
-flag [:t, :token]
-
-desc 'Verbose mode'
-arg_name 'verbose'
-switch [:v, :verbose]
-
-desc 'Http logger on stdout'
-arg_name 'logger'
-switch [:l, :logger]
-
-
-desc 'Work with deployed processes'
-arg_name 'Describe arguments to list here'
-command :process do |c|
-
-  c.desc 'Use when you need to redeploy a specific process'
-  c.default_value nil
-  c.flag :process_id
-
-  c.desc 'Specify directory for deployment'
-  c.default_value nil
-  c.flag :dir
-
-  c.desc 'Specify type of deployment'
-  c.default_value nil
-  c.flag :type
-
-  c.desc 'Specify name of deployed process'
-  c.default_value nil
-  c.flag :name
-
-  c.desc "Lists all user's processes deployed on the plaform"
-  c.command :list do |list|
-    list.action do |global_options, options, args|
-      opts = options.merge(global_options)
-      GoodData.connect(opts)
-      pp GoodData::Command::Process.list(options.merge(global_options))
-    end
-  end
-
-  c.desc "Gives you some basic info about the process"
-  c.command :get do |get|
-    get.action do |global_options, options, args|
-      opts = options.merge(global_options)
-      GoodData.connect(opts)
-      pp GoodData::Command::Process.get(options.merge(global_options))
-    end
-  end
-
-  c.desc "Deploys provided directory to the server"
-  c.command :deploy do |deploy|
-    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))
-    end
-  end
-
-end
-
-desc 'Some basic API stuff directly from CLI'
-arg_name 'info|test|get|delete'
-command :api do |c|
-
-  c.desc "Info about the API version etc"
-  c.command :info do |info|
-    info.action do |global_options, options, args|
-      opts = options.merge(global_options)
-      GoodData.connect(opts)
-      pp GoodData::Command::Api.info
-    end
-  end
-
-  c.desc "GET request on our API"
-  c.command :get do |get|
-    get.action do |global_options, options, args|
-      opts = options.merge(global_options)
-      GoodData.connect(opts)
-      pp GoodData::Command::Api.get(args[0])
-    end
-  end
-
-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|
-      opts = options.merge(global_options)
-      GoodData.connect(opts)
-      pp GoodData::Command::Profile.show()
-    end
-  end
-
-end
-
-desc 'Scaffold things'
-arg_name 'show'
-command :scaffold do |c|
-
-  c.desc "Scaffold a gooddata project blueprint"
-  c.command :project do |project|
-    project.action do |global_options, options, args|
-      name = args.first
-      fail "Name of the project has to be provided" if name.nil? || name.empty?
-      GoodData::Command::Scaffold.project(name)
-    end
-  end
-
-  c.desc "Scaffold a gooddata ruby brick. This is a piece of code that you can run on our platform"
-  c.command :brick do |brick|
-    # brick.arg_name 'name'
-    brick.action do |global_options, options, args|
-      name = args.first
-      fail "Name of the brick has to be provided" if name.nil? || name.empty?
-      GoodData::Command::Scaffold.brick(name)
-    end
-  end
-end
-
-desc 'Manage your projects'
-arg_name 'project_command'
-command :project do |c|
-
-  c.desc "Lists user's projects"
-  c.command :list do |list|
-    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(",") }
-    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|
-      goodfile_path = GoodData::Helpers.find_goodfile(Pathname('.'))
-
-      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?
-
-        opts = options.merge(global_options)
-        GoodData.connect(opts)
-
-        begin
-          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: "
-                        }])
-          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|
-      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
-                                                   })
-      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|
-      id = global_options[:project_id]
-      opts = options.merge(global_options)
-      GoodData.connect(opts)
-      GoodData::Command::Projects.delete(id)
-    end
-  end
-
-  c.desc "Clones a project. Useful for testing"
-  c.command :clone do |clone|
-    clone.desc 'Name of the new project'
-    clone.default_value nil
-    clone.arg_name 'cloned_project_name'
-    clone.flag [:n, :name]
-
-    clone.action do |global_options, options, args|
-      id = global_options[:project_id]
-      name = options[:name]
-      token = options[:token]
-      opts = options.merge(global_options)
-      GoodData.connect(opts)
-      GoodData::Command::Projects.clone(id, :name => name, :token => token)
-    end
-  end
-
-  c.desc "Shows basic info about a project"
-  c.command :show do |show|
-    show.action do |global_options, options, args|
-      id = global_options[:project_id]
-      opts = options.merge(global_options)
-      GoodData.connect(opts)
-      p = GoodData::Command::Projects.show(id)
-      pp p.data
-    end
-  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 :build do |show|
-    show.action do |global_options, options, args|
-      opts = options.merge(global_options)
-      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
-
-  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)
-      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
-
-end
-
-desc 'Work with your locally stored credentials'
-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|
-      GoodData::Command::Auth.store
-    end
-  end
-
-end
-
-desc 'Run ruby bricks either locally or remotely deployed on our server'
-# arg_name 'show'
-command :run_ruby do |c|
-
-  c.desc 'Directory of the ruby brick'
-  c.default_value nil
-  c.flag [:d, :dir]
-
-  c.desc 'Log file. If empty STDOUT will be used instead'
-  c.default_value nil
-  c.flag [:l, :logger]
-
-  c.desc 'Params file path. Inside should be hash of key values'
-  c.default_value nil
-  c.flag [:params]
-
-  c.desc 'Run on remote machine'
-  c.switch [:r, :remote]
-
-  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
-
-    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)
-    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|
-  require 'logger'
-  GoodData.logger = Logger.new(STDOUT) if global[:l]
-  username = global[:username]
-  password = global[:password]
-  token = global[:token]
-
-  creds = GoodData::Command::Auth.read_credentials
-
-  username = creds[:username] if username.nil?
-  password = creds[:password] if password.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?
-  # Pre logic here
-  # Return true to proceed; false to abort and not call the
-  # chosen command
-  # Use skips_pre before a command to skip this block
-  # on that command only
-  true
-end
-
-post do |global, command, options, args|
-  # Post logic here
-  # Use skips_post before a command to skip this
-  # block on that command only
-end
-
-on_error do |exception|
-  # Error logic here
-  # return false to skip default error handling
-  # binding.pry
-  pp exception.backtrace
-  pp exception
-  true
-end
-
-exit run(ARGV)
+exit(res)