gooddata 0.6.10 → 0.6.11

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

@@ -13,7 +13,7 @@ GoodData::CLI.module_eval do
   command :project do |c|
     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|
         opts = options.merge(global_options)
         GoodData::Command::Project.jack_in(opts)
       end
@@ -44,7 +44,7 @@ GoodData::CLI.module_eval do
 
     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)
         client = GoodData.connect(opts)
@@ -66,7 +66,7 @@ GoodData::CLI.module_eval do
       clone.default_value true
       clone.switch [:d, :data]
 
-      clone.action do |global_options, options, args|
+      clone.action do |global_options, options, _args|
         opts = options.merge(global_options)
         id = global_options[:project_id]
         token = opts[:token]
@@ -103,7 +103,7 @@ GoodData::CLI.module_eval do
 
     c.desc 'List users'
     c.command :users do |list|
-      list.action do |global_options, options, args|
+      list.action do |global_options, options, _args|
         opts = options.merge(global_options)
         client = GoodData.connect(opts)
 
@@ -117,7 +117,7 @@ GoodData::CLI.module_eval do
 
     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)
         client = GoodData.connect(opts)
@@ -128,7 +128,7 @@ GoodData::CLI.module_eval do
 
     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|
+      show.action do |global_options, options, _args|
         opts = options.merge(global_options)
         client = GoodData.connect(opts)
         spec, _ = GoodData::Command::Project.get_spec_and_project_id('.')
@@ -139,7 +139,7 @@ GoodData::CLI.module_eval do
 
     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|
+      show.action do |global_options, options, _args|
 
         opts = options.merge(global_options)
         GoodData.connect(opts)
@@ -153,7 +153,7 @@ GoodData::CLI.module_eval do
 
     c.desc 'Shows roles in the project'
     c.command :roles do |roles|
-      roles.action do |global_options, options, args|
+      roles.action do |global_options, options, _args|
         project_id = global_options[:project_id]
         fail 'Project ID has to be provided' if project_id.nil? || project_id.empty?
 
@@ -167,7 +167,7 @@ GoodData::CLI.module_eval do
 
     c.desc 'You can run project validation which will check RI and other problems.'
     c.command :validate do |show|
-      show.action do |global_options, options, args|
+      show.action do |global_options, options, _args|
         opts = options.merge(global_options)
         client = GoodData.connect(opts)
         pp GoodData::Command::Project.validate(global_options[:project_id], opts.merge(client: client))

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

@@ -10,7 +10,7 @@ GoodData::CLI.module_eval do
 
     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)
         client = GoodData.connect(opts)
         list = GoodData::Command::Projects.list(client: client)

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

@@ -1,16 +1,23 @@
 # encoding: UTF-8
 
 require 'pp'
+require 'hashie'
 
 require_relative '../shared'
 require_relative '../../commands/process'
 require_relative '../../commands/runners'
 require_relative '../../client'
 
+# translate given params (with dots) to json-like params
+def load_undot(filename)
+  p = MultiJson.load(File.read(filename)).extend(Hashie::Extensions::DeepMerge)
+  p.undot
+end
+
 GoodData::CLI.module_eval do
 
   desc 'Run ruby bricks either locally or remotely deployed on our server. Currently private alpha.'
-# arg_name 'show'
+  # arg_name 'show'
   command :run_ruby do |c|
 
     c.desc 'Directory of the ruby brick'
@@ -21,10 +28,14 @@ GoodData::CLI.module_eval do
     c.default_value nil
     c.flag [:l, :logger]
 
-    c.desc 'Params file path. Inside should be hash of key values'
+    c.desc 'Params file path. Inside should be hash of key values. These params override any defaults given in bricks.'
     c.default_value nil
     c.flag [:params]
 
+    c.desc 'Remote system credentials file path. Inside should be hash of key values.'
+    c.default_value nil
+    c.flag [:credentials]
+
     c.desc 'Run on remote machine'
     c.switch [:r, :remote]
 
@@ -32,14 +43,21 @@ GoodData::CLI.module_eval do
     c.default_value nil
     c.flag [:n, :name]
 
-    c.action do |global_options, options, args|
+    c.action do |global_options, options, _args|
       verbose = global_options[:verbose]
       options[:expanded_params] = if options[:params]
-                                    MultiJson.load(File.read(options[:params]))
+                                    # load params and credentials if given
+                                    runtime_params = load_undot(options[:params])
+                                    if options[:credentials]
+                                      runtime_params = runtime_params.deep_merge(load_undot(options[:credentials]))
+                                    end
+                                    { 'config' => runtime_params }
                                   else
-                                    {}
+                                    { 'config' => {} }
                                   end
-
+      # if there are some GDC_* params in config, put them on the level above
+      gdc_params = options[:expanded_params]['config'].select { |k, _| k =~ /GDC_.*/ }
+      options[:expanded_params].merge!(gdc_params)
       opts = options.merge(global_options).merge(:type => 'RUBY')
       GoodData.connect(opts)
       if options[:remote]
@@ -53,5 +71,4 @@ GoodData::CLI.module_eval do
       puts HighLine.color('Running ruby brick - DONE', HighLine::GREEN) if verbose
     end
   end
-
 end

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

@@ -13,7 +13,7 @@ GoodData::CLI.module_eval do
 
     c.desc 'Scaffold a gooddata project blueprint'
     c.command :project do |project|
-      project.action do |global_options, options, args|
+      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)
@@ -23,7 +23,7 @@ GoodData::CLI.module_eval do
     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|
+      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)

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

@@ -11,7 +11,7 @@ GoodData::CLI.module_eval do
   command :user 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)
         client = GoodData.connect(opts)
         pp GoodData::Command::User.show(client: client)

data/lib/gooddata/cli/hooks.rb

@@ -6,7 +6,7 @@ require 'pp'
 require_relative '../helpers/auth_helpers'
 
 GoodData::CLI.module_eval do
-  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]
@@ -30,13 +30,13 @@ GoodData::CLI.module_eval do
     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
   end
 
-  on_error do |exception|
+  on_error do |_exception|
     # Error logic here
     # return false to skip default error handling
     # binding.pry

data/lib/gooddata/commands/datasets.rb

@@ -125,7 +125,7 @@ module GoodData
         connection_point_set = false
         question_fmt = 'Select data type of column #%i (%s)'
         guesser.headers.each_with_index do |header, i|
-          options = guess[header].map { |t| t.to_s }
+          options = guess[header].map(&:to_s)
           options = options.select { |t| t != :connection_point.to_s } if connection_point_set
           type = ask question_fmt % [i + 1, header], :answers => options
           model.push :title => header, :name => header, :type => type.upcase

data/lib/gooddata/commands/project.rb

@@ -108,7 +108,7 @@ module GoodData
         def jack_in(options)
           goodfile_path = GoodData::Helpers.find_goodfile(Pathname('.'))
 
-          spin_session = proc do |goodfile, blueprint|
+          spin_session = proc do |goodfile, _blueprint|
             project_id = options[:project_id] || goodfile[:project_id]
             message = '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".'\
@@ -125,7 +125,7 @@ module GoodData
 
                 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|
                               'project_live_sesion: '
                             end])
               end

data/lib/gooddata/commands/role.rb

@@ -6,7 +6,7 @@ module GoodData
   module Command
     class Role
       class << self
-        def list(pid, opts = { :client => GoodData.connection, :project => GoodData.project })
+        def list(_pid, opts = { :client => GoodData.connection, :project => GoodData.project })
           p = opts[:project]
           fail ArgumentError, 'No :project specified' if p.nil?
 

data/lib/gooddata/commands/runners.rb

@@ -13,8 +13,8 @@ module GoodData
 
         params = options[:expanded_params] || {}
 
-        GoodData.connection.connect!
-        sst = GoodData.connection.cookies[:cookies]['GDCAuthSST']
+        client = GoodData.connect(options[:username], options[:password])
+        sst = client.connection.sst_token
         pwd = Pathname.new(Dir.pwd)
 
         server_uri = URI(options[:server]) unless options[:server].nil?

data/lib/gooddata/connection.rb

@@ -35,8 +35,8 @@ module GoodData
       connection = connect(options, second_options, third_options)
       bl.call(connection)
     rescue Exception => e # rubocop:disable RescueException
-        puts e.message
-        raise e
+      puts e.message
+      raise e
     ensure
       disconnect
     end

data/lib/gooddata/core/nil_logger.rb

@@ -3,7 +3,7 @@
 module GoodData
   # Dummy implementation of logger
   class NilLogger
-    def debug(*args)
+    def debug(*_args)
     end
 
     alias_method :info, :debug

data/lib/gooddata/core/rest.rb

@@ -67,25 +67,29 @@ module GoodData
     def upload_to_user_webdav(file, options = {})
       u = URI(GoodData.project.links['uploads'])
       url = URI.join(u.to_s.chomp(u.path.to_s), '/uploads/')
+
       connection.upload(file, options.merge(
-        :directory => options[:directory],
         :staging_url => url
       ))
     end
 
-    def get_project_webdav_path(file, options = {})
+    def get_project_webdav_path(_file, _options = {})
       u = URI(GoodData.project.links['uploads'])
       URI.join(u.to_s.chomp(u.path.to_s), '/project-uploads/', "#{GoodData.project.pid}/")
     end
 
     def upload_to_project_webdav(file, options = {})
+      webdav_filename = File.basename(file)
+      url = get_project_webdav_path(webdav_filename, options)
+      connection.upload(file, options.merge(:staging_url => url))
+    end
+
+    def download_from_project_webdav(file, where, options = {})
       url = get_project_webdav_path(file, options)
-      connection.upload(file, options.merge(
-        :directory => options[:directory],
-        :staging_url => url))
+      connection.download(file, where, options.merge(:staging_url => url))
     end
 
-    def get_user_webdav_path(file, options = {})
+    def get_user_webdav_path(_file, _options = {})
       u = URI(GoodData.project.links['uploads'])
       URI.join(u.to_s.chomp(u.path.to_s), '/uploads/')
     end
@@ -110,7 +114,7 @@ module GoodData
       response = GoodData.get(link, :process => false)
       while response.code == code
         sleep sleep_interval
-        GoodData.connection.retryable(:tries => 3, :on => RestClient::InternalServerError) do
+        GoodData::Rest::Client.retryable(:tries => 3, :on => RestClient::InternalServerError) do
           sleep sleep_interval
           response = GoodData.get(link, :process => false)
         end
@@ -139,7 +143,7 @@ module GoodData
       response = get(link)
       while bl.call(response)
         sleep sleep_interval
-        client.retryable(:tries => 3, :on => RestClient::InternalServerError) do
+        GoodData::Rest::Client.retryable(:tries => 3, :on => RestClient::InternalServerError) do
           sleep sleep_interval
           response = get(link)
         end

data/lib/gooddata/data/guesser.rb

@@ -24,7 +24,7 @@ module GoodData
 
       def initialize(reader)
         @reader = reader
-        @headers = reader.shift.map! { |h| h.to_s } || fail('Empty data set')
+        @headers = reader.shift.map!(&:to_s) || fail('Empty data set')
         @pros = {}
         @cons = {}
         @seen = {}

data/lib/gooddata/exceptions/attr_element_not_found.rb

@@ -5,7 +5,7 @@ module GoodData
   class AttributeElementNotFound < RuntimeError
     DEFAULT_MSG = 'Attribute element "%s" was not found'
 
-    def initialize(value, msg = DEFAULT_MSG)
+    def initialize(value, _msg = DEFAULT_MSG)
       super(sprintf(DEFAULT_MSG, value))
     end
   end

data/lib/gooddata/extensions/enumerable.rb

@@ -22,6 +22,6 @@ module Enumerable
 
   def pselect(&block)
     intermediate = pmap(&block)
-    zip(intermediate).select { |x| x[1] }.map { |x| x.first }
+    zip(intermediate).select { |x| x[1] }.map(&:first)
   end
 end

data/lib/gooddata/extensions/hash.rb

@@ -1,6 +1,11 @@
 # encoding: UTF-8
+require 'hashie'
+
+require 'hashie/extensions/deep_merge'
 
 class Hash
+  include Hashie::Extensions::DeepMerge
+
   # Return a hash that includes everything but the given keys. This is useful for
   # limiting a set of parameters to everything but a few known toggles:
   #
@@ -22,4 +27,19 @@ class Hash
     keys.each { |key| delete(key) }
     self
   end
+
+  def undot
+    # for each key-value config given
+    hashes = map do |k, v|
+      # dot notation to hash
+      k.split('__').reverse.reduce(v) do |memo, obj|
+        { obj => memo }.extend(Hashie::Extensions::DeepMerge)
+      end
+    end
+
+    # merge back the keys as they came
+    hashes.reduce do |memo, obj|
+      memo.deep_merge(obj)
+    end
+  end
 end

data/lib/gooddata/helpers/csv_helper.rb

@@ -38,7 +38,7 @@ module GoodData
         # @option opts [String] :path File to write data to
         # @option opts [Array] :data Mandatory array of data to write
         # @option opts [String] :header Optional Header row
-        def write(opts, &block)
+        def write(opts, &_block)
           path = opts[:path]
           header = opts[:header]
           data = opts[:data]

data/lib/gooddata/helpers/global_helpers.rb

@@ -18,6 +18,57 @@ module GoodData
         RUBY_PLATFORM =~ /-darwin\d/
       end
 
+      ENCODED_PARAMS_KEY = :gd_encoded_params
+      ENCODED_HIDDEN_PARAMS_KEY = :gd_encoded_hidden_params
+
+      # Encodes parameters for passing them to GD execution platform.
+      # Core types are kept and complex types (arrays, structures, etc) are JSON encoded into key hash "gd_encoded_params" or "gd_encoded_hidden_params", depending on the 'hidden' method param.
+      # The two different keys are used because the params and hidden params are merged by the platform and if we use the same key, the param would be overwritten.
+      #
+      # Core types are following:
+      # - Boolean (true, false)
+      # - Fixnum
+      # - Float
+      # - Nil
+      # - String
+      #
+      # @param [Hash] params Parameters to be encoded
+      # @return [Hash] Encoded parameters
+      def encode_params(params, hidden = false)
+        res = {}
+        nested = {}
+        core_types = [FalseClass, Fixnum, Float, NilClass, TrueClass, String]
+        params.each do |k, v|
+          if core_types.include?(v.class)
+            res[k] = v
+          else
+            nested[k] = v
+          end
+        end
+        key = hidden ? ENCODED_PARAMS_KEY : ENCODED_HIDDEN_PARAMS_KEY
+        res[key] = nested.to_json unless nested.empty?
+        res
+      end
+
+      # Decodes params as they came from the platform
+      # The "data" key is supposed to be json and it's parsed - if this
+      def decode_params(params)
+        key = ENCODED_PARAMS_KEY.to_s
+        hidden_key = ENCODED_HIDDEN_PARAMS_KEY.to_s
+        data_params = params[key] || '{}'
+        hidden_data_params = params[hidden_key] || '{}'
+
+        begin
+          parsed_data_params = JSON.parse(data_params)
+          parsed_hidden_data_params = JSON.parse(hidden_data_params)
+        rescue JSON::ParserError => e
+          raise e.class, "Error reading json from '#{key}' or '#{hidden_key}' in params #{params}\n #{e.message}"
+        end
+        params.delete(key)
+        params.delete(hidden_key)
+        params.merge(parsed_data_params).merge(parsed_hidden_data_params)
+      end
+
       def error(msg)
         STDERR.puts(msg)
         exit 1
@@ -36,8 +87,15 @@ module GoodData
         nil
       end
 
+      def get_path(an_object, path = [])
+        return an_object if path.empty?
+        path.reduce(an_object) do |a, e|
+          a && a.key?(e) ? a[e] : nil
+        end
+      end
+
       def hash_dfs(thing, &block)
-        if !thing.is_a?(Hash) && !thing.is_a?(Array)
+        if !thing.is_a?(Hash) && !thing.is_a?(Array) # rubocop:disable Style/GuardClause
         elsif thing.is_a?(Array)
           thing.each do |child|
             hash_dfs(child, &block)

data/lib/gooddata/mixins/md_lock.rb

@@ -0,0 +1,83 @@
+# encoding: UTF-8
+
+module GoodData
+  module Mixin
+    module Lockable
+      # Locks an object. Locked object cannot be changed by certain users.
+      #
+      # @return [GoodData::Mixin::Lockable]
+      def lock
+        meta['locked'] = 1
+        self
+      end
+
+      # Sames as #lock. Locks an object and immediately saves it.
+      #
+      # @return [GoodData::Mixin::Lockable]
+      def lock!
+        lock
+        save
+      end
+
+      # Unlocks an object.
+      #
+      # @return [GoodData::Mixin::Lockable]
+      def unlock
+        meta.delete('locked')
+        self
+      end
+
+      # Same as #unlock. Unlocks an object and immediately saves it
+      #
+      # @return [GoodData::Mixin::Lockable]
+      def unlock!
+        unlock
+        save
+      end
+
+      # Locks an object with all used objects. The types of objects that are affected by locks
+      # are dashboards, reports and metrics. This means that if you lock a dashboard by this method
+      # all used reports and metrics are also locked. If you lock a report all used metrics are also
+      # locked. The current object is reloaded. This means that the #locked? will return true.
+      #
+      # @return [GoodData::Mixin::Lockable]
+      def lock_with_dependencies!
+        client.post("/gdc/internal/projects/#{project.pid}/objects/setPermissions",
+                    permissions: {
+                      lock: true,
+                      items: [uri]
+                    })
+        reload!
+      end
+
+      # Unlocks an object with all used objects. The types of objects that are affected by locks
+      # are dashboards, reports and metrics. This means that if you unlock a dashboard by this method
+      # all used reports and metrics are also unlocked. If you unlock a report all used metrics are also
+      # unlocked. The current object is unlocked as well. Beware that certain objects might be in use in
+      # multiple contexts. For example one metric can be used in several reports. This method performs no
+      # checks to determine if an object should stay locked or not.
+      #
+      # @return [GoodData::Mixin::Lockable]
+      def unlock_with_dependencies!
+        using('report').pmap { |link| project.reports(link['link']) }.select(&:locked?).pmap(&:unlock!)
+        using('metric').pmap { |link| project.metrics(link['link']) }.select(&:locked?).pmap(&:unlock!)
+        using('projectDashboard').pmap { |link| project.dashboards(link['link']) }.select(&:locked?).pmap(&:unlock!)
+        unlock!
+      end
+
+      # Returns true if an object is locked. False otherwise.
+      #
+      # @return [Boolean]
+      def locked?
+        meta['locked'] == 1
+      end
+
+      # Returns true if an object is unlocked. False otherwise.
+      #
+      # @return [Boolean]
+      def unlocked?
+        !locked?
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/md_object_indexer.rb

@@ -35,7 +35,7 @@ module GoodData
                 fail 'Unexpected object id format: expected numeric ID, identifier with no slashes or an URI starting with a slash'
               end
         # new(GoodData.get uri) unless uri.nil?
-        if uri
+        if uri # rubocop:disable Style/GuardClause
           raw = client.get(uri)
           client.create(self, raw, client: client, project: project)
         end

data/lib/gooddata/mixins/md_object_query.rb

@@ -8,7 +8,7 @@ module GoodData
       # @param options [Hash] the options hash
       # @option options [Boolean] :full if passed true the subclass can decide to pull in full objects. This is desirable from the usability POV but unfortunately has negative impact on performance so it is not the default
       # @return [Array<GoodData::MdObject> | Array<Hash>] Return the appropriate metadata objects or their representation
-      def all(options = { :client => GoodData.connection, :project => GoodData.project })
+      def all(_options = { :client => GoodData.connection, :project => GoodData.project })
         fail NotImplementedError, 'Method should be implemented in subclass. Currently there is no way how to get all metadata objects on API.'
       end
 

data/lib/gooddata/mixins/md_relations.rb

@@ -14,12 +14,6 @@ module GoodData
 
       # Returns which objects uses this MD resource
       def usedby(key = nil, opts = { :client => client, :project => project })
-        p = opts[:project]
-        fail ArgumentError, 'No :project specified' if p.nil?
-
-        project = GoodData::Project[p, opts]
-        fail ArgumentError, 'Wrong :project specified' if project.nil?
-
         dependency("#{project.md['usedby2']}/#{obj_id}", key, opts)
       end
 
@@ -27,9 +21,6 @@ module GoodData
 
       # Returns which objects this MD resource uses
       def using(key = nil, opts = { :client => client, :project => project })
-        project = opts[:project]
-        fail ArgumentError, 'Wrong :project specified' if project.nil?
-
         dependency("#{project.md['using2']}/#{obj_id}", key, opts)
       end
 

data/lib/gooddata/models/dashboard_builder.rb

@@ -18,7 +18,7 @@ module GoodData
       def to_hash
         {
           :name => @name,
-          :tabs => @tabs.map { |tab| tab.to_hash }
+          :tabs => @tabs.map(&:to_hash)
         }
       end
     end

data/lib/gooddata/models/domain.rb

@@ -43,9 +43,9 @@ module GoodData
         # Optional authentication modes
         tmp = opts[:authentication_modes]
         if tmp
-          if tmp.kind_of? Array
+          if tmp.is_a? Array
             data[:authenticationModes] = tmp
-          elsif tmp.kind_of? String
+          elsif tmp.is_a? String
             data[:authenticationModes] = [tmp]
           end
         end