gooddata 0.6.10 → 0.6.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 175e3df2f037ccb6001560d204998e8de3082422
-  data.tar.gz: 11fd46bd19cdf28cf062520df37958bca0074dc4
+  metadata.gz: 599d5759ccffd91b5e59aa9fde03eccee81c4138
+  data.tar.gz: 95ec2b6b381f940b686fe29c201c99ec1b1300c9
 SHA512:
-  metadata.gz: 8a0c62a95ae6631b5b94fc9af128e795debb4e892e216d58477565eb45e70fe678c024ad1893ec76db2a76bccc10d8658d57ac2dac819511f59e9854f6558b14
-  data.tar.gz: 3108128b8750a1ea5826e1d050419a08504e3b99da75ef29542333d2f3a32e879cd0f2fd8a9fe36fc661ae10493b2c334492d92ae97ab05c76938c9314576929
+  metadata.gz: b82f86ca736a3dbb5d6402c1085a3062c6d3213ff5f2f782f115496408d97d230779870be2923fcb5aa472615c539d65b08c52b022628b06467d2e6ad15816aa
+  data.tar.gz: 018ad7f05291a4f5ce238254d3f24ab3680d2dc0ab4a374990004db785bd1e9b15534cf553d88958ead9eb5bc5b82c8b94507cdc876955144d155283bc016bb7

data/.rubocop.yml

@@ -1,3 +1,6 @@
+AbcSize:
+  Enabled: false
+
 ClassLength:
   Enabled: false
 
@@ -7,6 +10,9 @@ CyclomaticComplexity:
 Documentation:
   Enabled: false
 
+EachWithObject:
+  Enabled: false
+  
 Eval:
   Enabled: false
 
@@ -21,3 +27,6 @@ LineLength:
 
 MethodLength:
   Enabled: false
+
+PerceivedComplexity:
+  Enabled: false

data/.travis.yml

@@ -1,5 +1,9 @@
 language: ruby
 
+os:
+  - linux
+  - osx
+
 branches:
   except:
     - gh-pages

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # GoodData Ruby SDK Changelog
 
+## 0.6.11
+- Ability to download deployed process
+- Added locking objects capabilities
+- Added removing color mapping form a report definition
+- Report defintions are deleted along with a report
+
 ## 0.6.10
 - Fixed client default missing in ProjectMetadata
 - Listing schedules on processes is working

data/README.md

@@ -10,6 +10,7 @@ The best documentation for the GoodData API can be found using these resources:
  * http://developer.gooddata.com/api
  * https://secure.gooddata.com/gdc
  * http://rubydoc.info/gems/gooddata/frames
+ * http://developer.gooddata.com/ruby-cookbook
 
 ## Status
 

data/gooddata.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib/", __FILE__)
-require "gooddata/version"
+require 'gooddata/version'
 
 Gem::Specification.new do |s|
   s.name = %q{gooddata}
@@ -9,54 +9,52 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [
-      "Pavel Kolesnikov",
-      "Thomas Watson Steen",
-      "Tomas Svarovsky",
-      "Tomas Korcak"
+      'Pavel Kolesnikov',
+      'Thomas Watson Steen',
+      'Tomas Svarovsky',
+      'Tomas Korcak'
   ]
 
   s.summary = %q{A convenient Ruby wrapper around the GoodData RESTful API}
   s.description = %q{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.}
   s.email = %q{pavel@gooddata.com}
-  s.executables = ["gooddata"]
-  s.extra_rdoc_files = [
-      "LICENSE",
-      "README.md"
-  ]
+  s.executables = ['gooddata']
+  s.extra_rdoc_files = %w(LICENSE README.md)
+
   s.files = `git ls-files`.split($/)
   s.homepage = %q{http://github.com/gooddata/gooddata-ruby}
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "debase" if RUBY_VERSION >= '2.1'
-  s.add_development_dependency "rake", "~> 10.3.1"
-  s.add_development_dependency "rake-notes", "~> 0.2.0"
-  s.add_development_dependency "redcarpet", "~> 3.1.1" if RUBY_PLATFORM != 'java'
-  s.add_development_dependency "rspec", "~> 2.14.1"
+  # s.add_development_dependency "debase" if RUBY_VERSION >= '2.1'
+  s.add_development_dependency 'rake', '~> 10.3', '>= 10.3.1'
+  s.add_development_dependency 'rake-notes', '~> 0.2', '>= 0.2.0'
+  s.add_development_dependency 'redcarpet', '~> 3.1', '>= 3.1.1' if RUBY_PLATFORM != 'java'
+  s.add_development_dependency 'rspec', '~> 2.14', '>= 2.14.1'
   # s.add_development_dependency "ruby-debug-base"
-  s.add_development_dependency "ruby-debug-ide" if RUBY_VERSION >= '2.1'
-  s.add_development_dependency "rubocop", "~> 0.20.1"
-  s.add_development_dependency "simplecov", "~> 0.8.2"
-  s.add_development_dependency "yard", "~> 0.8.7.3"
-  s.add_development_dependency "yard-rspec", "~> 0.1"
-  s.add_development_dependency "ZenTest", "~> 4.10.0"
-  s.add_development_dependency "coveralls", "~> 0.7.0"
+  # s.add_development_dependency "ruby-debug-ide" if RUBY_VERSION >= '2.1'
+  s.add_development_dependency 'rubocop', '~> 0.27', '>= 0.27.0'
+  s.add_development_dependency 'simplecov', '~> 0.9', '>= 0.9.1'
+  s.add_development_dependency 'yard', '~> 0.8.7.3'
+  s.add_development_dependency 'yard-rspec', '~> 0.1'
+  s.add_development_dependency 'ZenTest', '~> 4.10', '>= 4.11.0'
+  s.add_development_dependency 'coveralls', '~> 0.7', '>= 0.7.0'
 
-  s.add_dependency "activesupport", "~> 4.1.0"
-  s.add_dependency "bundler", ">= 1.6.1"
-  s.add_dependency 'docile', '~> 1.1.3'
-  s.add_dependency "erubis", "~> 2.7.0"
-  s.add_dependency "gli", "~> 2.10.0"
-  s.add_dependency "highline", "~> 1.6.21"
-  s.add_dependency "i18n", "~> 0.6.9"
-  s.add_dependency "json_pure", "~> 1.8.1"
-  s.add_dependency "multi_json", "~> 1.10.0"
-  s.add_dependency "parseconfig", "~> 1.0.4"
-  s.add_dependency 'pmap', '~> 1.0.1'
-  s.add_dependency "pry", "~> 0.9.12.6"
-  s.add_dependency "restforce", "~> 1.4.3"
-  s.add_dependency "rest-client", "~> 1.6.7"
-  s.add_dependency "rubyzip", "~> 1.1.0"
-  s.add_dependency "terminal-table", "~> 1.4.5"
-  s.add_dependency "salesforce_bulk_query", "~> 0.0"
-  s.add_dependency "aws-sdk", "~> 1.45"
+  s.add_dependency 'activesupport', '~> 4.1', '>= 4.1.0'
+  s.add_dependency 'bundler', '~> 1.7', '>= 1.7.3'
+  s.add_dependency 'docile', '~> 1.1', '>= 1.1.5'
+  s.add_dependency 'erubis', '~> 2.7', '>= 2.7.0'
+  s.add_dependency 'gli', '~> 2.12', '>= 2.12.2'
+  s.add_dependency 'highline', '~> 1.6', '>= 1.6.21'
+  s.add_dependency 'i18n', '~> 0.6', '>= 0.6.9'
+  s.add_dependency 'json_pure', '~> 1.8', '>= 1.8.1'
+  s.add_dependency 'multi_json', '~> 1.10', '>= 1.10.0'
+  s.add_dependency 'parseconfig', '~> 1.0', '>= 1.0.4'
+  s.add_dependency 'pmap', '~> 1.0', '>= 1.0.1'
+  s.add_dependency 'pry', '~> 0.9.12.6' # '~> 0.10', '>= 0.10.1'
+  s.add_dependency 'restforce', '~> 1.5', '>= 1.5.0'
+  s.add_dependency 'rest-client', '~> 1.7', '>= 1.7.2'
+  s.add_dependency 'rubyzip', '~> 1.1', '>= 1.1.0'
+  s.add_dependency 'terminal-table', '~> 1.4', '>= 1.4.5'
+  s.add_dependency 'salesforce_bulk_query', '~> 0.0'
+  s.add_dependency 'aws-sdk', '~> 1.45'
 end

data/lib/gooddata/bricks/base_downloader.rb

@@ -23,7 +23,7 @@ module GoodData
       def backup(meta)
         @logger.info 'would send a backup list of files to backup' if @logger
 
-        files = meta['objects'].map { |k, o| o }.reduce([]) do |a, e|
+        files = meta['objects'].map { |_k, o| o }.reduce([]) do |a, e|
           a + e['filenames']
         end
 

data/lib/gooddata/bricks/middleware/base_middleware.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+require 'hashie'
 
 module GoodData
   module Bricks
@@ -7,6 +8,41 @@ module GoodData
 
       include Bricks::Utils
 
+      # Loads defaults to params from a json file in @config.
+      #
+      # The idea is to have a set of parameter defaults
+      # for a middleware. The defaults are loaded from a json file.
+      # If a brick user wants to override a default, they can
+      # do that in runtime params which come to the method in 'params'.
+      #
+      # A deep merge is done on the params. Arrays and other
+      # non-hash types are overwritten (params win).
+      #
+      # ### Examples
+      #
+      # A brick developer develops a SalesforceDownloaderMiddleware
+      # with default preset 'gse' having a configuration preset
+      # {"entities": ["Acount", "Event", "OpportunityLineItem", "Opportunity", "User"]}
+      #
+      # The brick user only wants to use Opportunity, so he passes
+      # runtime parameter {"entities": ["Opportunity"]} which overrides
+      # the default.
+      # See spec/bricks/bricks_spec.rb for usage.
+      def load_defaults(params)
+        # if default params given, fill what's not given in runtime params
+        if @config
+          # load it from file and merge it
+          defaults = { 'config' => MultiJson.load(File.read(@config)) }
+          default_params = defaults.extend(Hashie::Extensions::DeepMerge)
+          params = default_params.deep_merge(params)
+        end
+        params
+      end
+
+      def call(params)
+        load_defaults(params)
+      end
+
       def initialize(options = {})
         @app = options[:app]
       end

data/lib/gooddata/bricks/middleware/bulk_salesforce_middleware.rb

@@ -9,53 +9,23 @@ module GoodData
     class BulkSalesforceMiddleware < Bricks::Middleware
       DEFAULT_VERSION = '29.0'
 
-      def call(params)
-        username = params['salesforce_username']
-        password = params['salesforce_password']
-        token = params['salesforce_token']
-        oauth_refresh_token = params['salesforce_oauth_refresh_token']
-
-        client_id = params['salesforce_client_id']
-        client_secret = params['salesforce_client_secret']
-        host = params['salesforce_host']
-        version = params['salesforce_api_version'] || DEFAULT_VERSION
-
-        app_info = {
-          :client_id => client_id,
-          :client_secret => client_secret
-        }
-        app_info[:host] = host unless host.nil?
+      def self.create_client(params)
         salesforce = nil
-        client_params = nil
-
-        if username && password && token
-          # use basic auth
-          client_params = {
-            :username => username,
-            :password => password,
-            :security_token => token
-          }.merge(app_info)
-
-        elsif oauth_refresh_token
-          # use oauth
-          client_params = {
-            :refresh_token => oauth_refresh_token
-          }.merge(app_info)
-        end
-
-        if client_params
-
-          client_params[:api_version] = version
+        if params['salesforce_client']
 
-          client = params['salesforce_client'] || Restforce.new(client_params)
+          client = params['salesforce_client']
           client.authenticate!
 
           salesforce = SalesforceBulkQuery::Api.new(client, :logger => params['GDC_LOGGER'])
           # SalesforceBulkQuery adds its own Restforce logging so turn it off
           Restforce.log = false if params['GDC_LOGGER']
         end
+        params.merge('salesforce_bulk_client' => salesforce)
+      end
 
-        @app.call(params.merge('salesforce_bulk_client' => salesforce))
+      def call(params)
+        params = self.class.create_client(params)
+        @app.call(params)
       end
     end
   end

data/lib/gooddata/bricks/middleware/decode_params_middleware.rb

@@ -0,0 +1,14 @@
+require_relative 'base_middleware'
+
+module GoodData
+  module Bricks
+    # Converts params from encoded hash to decoded hash
+    class DecodeParamsMiddleware < Bricks::Middleware
+      def call(params)
+        params = params.to_hash
+
+        @app.call(GoodData::Helpers.decode_params(params))
+      end
+    end
+  end
+end

data/lib/gooddata/bricks/middleware/fs_upload_middleware.rb

@@ -8,26 +8,27 @@ require_relative 'base_middleware'
 
 module GoodData
   module Bricks
-    class FsUploadMiddleware < Bricks::Middleware
+    class FsProjectUploadMiddleware < Bricks::Middleware
       def initialize(options = {})
         super
         @destination = options[:destination]
       end
 
       def call(params)
-        returning(@app.call(params)) do |result|
+        returning(@app.call(params)) do |_result|
           destination = @destination
           (params['gdc_files_to_upload'] || []).each do |f|
-            path = f[:path]
             case destination.to_s
             when 'staging'
-              url = GoodData.get_user_webdav_path(path)
-              GoodData.upload_to_user_webdav(path)
-              puts "Uploaded local file \"#{path}\" to url \"#{url + path}\""
+              GoodData.upload_to_project_webdav(f[:path], directory: f[:webdav_directory])
+              puts "Uploaded local file \"#{f[:path]}\" to webdav."
             end
           end
         end
       end
     end
+
+    # Alias to make it backwards compatible
+    FsUploadMiddleware = FsProjectUploadMiddleware
   end
 end

data/lib/gooddata/bricks/middleware/gooddata_middleware.rb

@@ -16,16 +16,18 @@ module GoodData
         project_id = params['GDC_PROJECT_ID']
 
         fail 'SST (SuperSecureToken) not present in params' if params[token_name].nil?
+
         server = if !params[protocol_name].empty? && !params[server_name].empty?
                    "#{params[protocol_name]}://#{params[server_name]}"
                  end
 
-        fail 'GoodData username is missing. Expected param :GDC_USERNAME' if params['GDC_USERNAME'].nil?
-        fail 'GoodData password is missing. Expected param :GDC_PASSWORD' if params['GDC_PASSWORD'].nil?
-
-        client = GoodData.connect(params['GDC_USERNAME'], params['GDC_PASSWORD'], :server => server)
+        client = if params['GDC_USERNAME'].nil? || params['GDC_PASSWORD'].nil?
+                   GoodData.connect(sst_token: params['GDC_SST'], server: server)
+                 else
+                   GoodData.connect(params['GDC_USERNAME'], params['GDC_PASSWORD'], server: server)
+                 end
         GoodData.logger = logger
-        GoodData.with_project(project_id, :client => client) do |p|
+        GoodData.with_project(project_id, :client => client) do |_p|
           @app.call(params)
         end
       end

data/lib/gooddata/bricks/middleware/logger_middleware.rb

@@ -10,7 +10,7 @@ module GoodData
       def call(params)
         logger = params['GDC_LOGGER'] = params[:GDC_LOGGER_FILE].nil? ? Logger.new(STDOUT) : Logger.new(params[:GDC_LOGGER_FILE])
         logger.info('Pipeline starts')
-        returning(@app.call(params)) do |result|
+        returning(@app.call(params)) do |_result|
           logger.info('Pipeline ending')
         end
       end

data/lib/gooddata/bricks/middleware/restforce_middleware.rb

@@ -10,15 +10,16 @@ module GoodData
     class RestForceMiddleware < Bricks::Middleware
       DEFAULT_VERSION = '29.0'
 
-      def call(params)
-        username = params['salesforce_username']
-        password = params['salesforce_password']
-        token = params['salesforce_token']
-        client_id = params['salesforce_client_id']
-        client_secret = params['salesforce_client_secret']
-        oauth_refresh_token = params['salesforce_oauth_refresh_token']
-        host = params['salesforce_host']
-        version = params['salesforce_api_version'] || DEFAULT_VERSION
+      def self.create_client(params)
+        downloader_config = params['config']['downloader']['salesforce']
+        username = downloader_config['username']
+        password = downloader_config['password']
+        token = downloader_config['token']
+        client_id = downloader_config['client_id']
+        client_secret = downloader_config['client_secret']
+        oauth_refresh_token = downloader_config['oauth_refresh_token']
+        host = downloader_config['host']
+        version = downloader_config['api_version'] || DEFAULT_VERSION
 
         credentials = if username && password && token
                         {
@@ -34,17 +35,22 @@ module GoodData
 
         client = if credentials
                    credentials.merge!(
-                                        :client_id => client_id,
-                                        :client_secret => client_secret
-                                      )
+                     :client_id => client_id,
+                     :client_secret => client_secret
+                   )
                    credentials[:host] = host unless host.nil?
                    credentials[:api_version] = version
 
-                   Restforce.log = true if params['salesforce_client_logger']
+                   Restforce.log = true if params['GDC_LOGGER']
 
                    Restforce.new(credentials)
                  end
-        @app.call(params.merge('salesforce_client' => client))
+        params.merge('salesforce_client' => client)
+      end
+
+      def call(params)
+        params = self.class.create_client(params)
+        @app.call(params)
       end
     end
   end

data/lib/gooddata/bricks/middleware/undot_params_middleware.rb

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+
+require_relative 'base_middleware'
+
+module GoodData
+  module Bricks
+    # Converts params from double underscore notation to nested hash under 'config'
+    # Parameters starting GDC_ are considered system params and aren't converted.
+    #
+    # This is useful because the executor platform can currently
+    # do just key-value parameters. Also it makes it easier for
+    # a user, as there aren't as much curly braces.
+    #
+    #
+    # ### Examples
+    # If you pass params in form:
+    # {"my__namespace__param": "value"}
+    #
+    # you'll get:
+    # {"my": {"namespace": {"param": value}}}
+    class UndotParamsMiddleware < Bricks::Middleware
+      def call(params)
+        params = params.to_hash
+        unless params['config']
+          # split the params to those starting with GDC and those that don't, put other params under config
+          gdc_params, other_params = params.partition { |k, _| k =~ /GDC_.*/ }.map { |h| Hash[h] }
+          params = gdc_params.merge('config' => other_params.undot)
+        end
+        @app.call(params)
+      end
+    end
+  end
+end

data/lib/gooddata/cli/commands/api_cmd.rb

@@ -12,7 +12,7 @@ GoodData::CLI.module_eval do
 
     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

data/lib/gooddata/cli/commands/auth_cmd.rb

@@ -10,7 +10,7 @@ GoodData::CLI.module_eval do
 
     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

data/lib/gooddata/cli/commands/console_cmd.rb

@@ -8,7 +8,7 @@ GoodData::CLI.module_eval do
   desc 'Interactive session with gooddata sdk loaded'
   command :console do |c|
 
-    c.action do |global_options, options, args|
+    c.action do |global_options, _options, _args|
       username = global_options[:username]
       fail ArgumentError, 'No username specified' if username.nil? || username.empty?
 
@@ -27,7 +27,7 @@ GoodData::CLI.module_eval do
 
         puts "Use 'exit' to quit the live session. Use 'q' to jump out of displaying a large output."
         binding.pry(:quiet => true,
-                    :prompt => [proc do |target_self, nest_level, pry|
+                    :prompt => [proc do |_target_self, _nest_level, _pry|
                       'sdk_live_sesion: '
                     end])
       end

data/lib/gooddata/cli/commands/process_cmd.rb

@@ -5,6 +5,16 @@ require 'pp'
 require_relative '../shared'
 require_relative '../../commands/process'
 
+def read_params_file(filename)
+  # read params from a file
+  # if filename nil, return empty hash
+  if filename
+    JSON.parse(IO.read(filename))
+  else
+    {}
+  end
+end
+
 GoodData::CLI.module_eval do
 
   desc 'Work with deployed processes'
@@ -31,6 +41,18 @@ GoodData::CLI.module_eval do
     c.default_value nil
     c.flag :executable
 
+    c.desc 'Specify parameters file to execute the process with'
+    c.default_value nil
+    c.flag :params
+
+    c.desc 'Specify hidden paremeters to execute the process with'
+    c.default_value nil
+    c.flag :hidden_params
+
+    c.desc 'Specify cron expression for the schedule'
+    c.default_value nil
+    c.flag :cron
+
     c.desc "Lists all user's processes deployed on the plaform"
     c.command :list do |list|
       list.action do |global_options, options, args|
@@ -46,7 +68,7 @@ GoodData::CLI.module_eval do
 
     c.desc 'Gives you some basic info about the process'
     c.command :show do |get|
-      get.action do |global_options, options, args|
+      get.action do |global_options, options, _args|
         opts = options.merge(global_options)
         client = GoodData.connect(opts)
         pp GoodData::Command::Process.get(opts.merge(client: client)).raw_data
@@ -55,7 +77,7 @@ GoodData::CLI.module_eval do
 
     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)
         dir = opts[:dir]
         name = opts[:name]
@@ -69,7 +91,7 @@ GoodData::CLI.module_eval do
 
     c.desc 'Delete specific process'
     c.command :delete do |deploy|
-      deploy.action do |global_options, options, args|
+      deploy.action do |global_options, options, _args|
         opts = options.merge(global_options)
         process_id = opts[:process_id]
         fail 'You have to provide a process id. Use --process_id param' if process_id.nil? || process_id.empty?
@@ -80,16 +102,41 @@ GoodData::CLI.module_eval do
     end
 
     c.desc 'Execute specific deployed process'
-    # TODO: Add params. HOW?
     c.command :execute do |deploy|
-      deploy.action do |global_options, options, args|
+      deploy.action do |global_options, options, _args|
         opts = options.merge(global_options)
         process_id = opts[:process_id]
         executable = opts[:executable]
+
+        fail 'You have to provide a process id. Use --process_id param' if process_id.nil? || process_id.empty?
+        fail 'You have to provide an executable for the process. Use --executable param' if executable.nil? || executable.empty?
+        client = GoodData.connect(options)
+        project = client.projects(options[:project_id])
+        process = project.processes(options[:process_id])
+        params = read_params_file(options[:params])
+        hidden_params = read_params_file(options[:hidden_params])
+        process.execute(options[:executable], params: params, hidden_params: hidden_params)
+      end
+    end
+
+    c.desc 'Schedule specific deployed process'
+    c.command :schedule do |schedule|
+      schedule.action do |global_options, command_options, _|
+        options = command_options.merge(global_options)
+        process_id = options[:process_id]
+        executable = options[:executable]
+        cron = options[:cron]
+
         fail 'You have to provide a process id. Use --process_id param' if process_id.nil? || process_id.empty?
         fail 'You have to provide an executable for the process. Use --executable param' if executable.nil? || executable.empty?
-        GoodData.connect(opts)
-        pp GoodData::Command::Process.execute_process(process_id, executable, opts)
+        fail 'You have to provide a cron expression for the schedule. Use --cron param' if cron.nil? || cron.empty?
+
+        client = GoodData.connect(options)
+        project = client.projects(options[:project_id])
+        process = project.processes(options[:process_id])
+        params = read_params_file(options[:params])
+        hidden_params = read_params_file(options[:hidden_params])
+        process.create_schedule(cron, options[:executable], params: params, hidden_params: hidden_params)
       end
     end
   end