gooddata 2.1.12 → 2.1.19

data/lib/gooddata/models/domain.rb

@@ -5,7 +5,6 @@
 # LICENSE file in the root directory of this source tree.
 
 require 'cgi'
-require 'active_support/core_ext/hash/compact'
 
 require_relative 'profile'
 require_relative '../extensions/enumerable'
@@ -457,10 +456,12 @@ Available values for setting language are: #{available_languages}."
     alias_method :add_clients_settings, :update_clients_settings
 
     def update_clients(data, options = {})
+      results = []
       data.group_by(&:data_product_id).each do |data_product_id, client_update_data|
         data_product = data_products(data_product_id)
-        data_product.update_clients(client_update_data, options)
+        results.concat data_product.update_clients(client_update_data, options)
       end
+      results
     end
 
     # Update user in domain

data/lib/gooddata/models/from_wire.rb

@@ -105,6 +105,7 @@ module GoodData
           d[:title] = date_dim['dateDimension']['title']
           d[:urn] = date_dim['dateDimension']['urn']
           d[:identifier_prefix] = date_dim['dateDimension']['identifierPrefix']
+          d[:identifier] = date_dim['dateDimension']['identifier'] if date_dim['dateDimension']['identifier']
           d[:columns] = parse_bridges(date_dim)
         end
       end

data/lib/gooddata/models/metadata/analytical_dashboard.rb

@@ -0,0 +1,49 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+#
+# Copyright (c) 2010-2021 GoodData Corporation. All rights reserved.
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+require_relative 'analytical_visualization_object'
+
+module GoodData
+  class AnalyticalDashboard < GoodData::AnalyticalVisualizationObject
+    EMPTY_OBJECT = {
+      'analyticalDashboard' => {
+        'content' => {
+          'filterContext' => '',
+          'layout' => {},
+          'widgets' => []
+        },
+        'meta' => {
+          'deprecated' => '0',
+          'summary' => '',
+          'title' => ''
+        }
+      }
+    }
+
+    ASSIGNABLE_MEMBERS = %i[filterContext layout widgets deprecated summary title]
+
+    class << self
+      # Method intended to get all AnalyticalDashboard objects in a specified project
+      #
+      # @param options [Hash] the options hash
+      # @option options [Boolean] :full with true value will pull in full objects. Default is false value
+      # @return [Array<GoodData::AnalyticalDashboard>] Return AnalyticalDashboard list
+      def all(options = { :client => GoodData.connection, :project => GoodData.project })
+        query('analyticalDashboard', AnalyticalDashboard, options)
+      end
+
+      # Create Analytical Dashboard in the specify project
+      #
+      # @param analytical_dashboard [Hash] the data of object will be created
+      # @param options [Hash] The project that the object will be created in
+      # @return GoodData::AnalyticalDashboard object
+      def create(analytical_dashboard = {}, options = { :client => GoodData.client, :project => GoodData.project })
+        GoodData::AnalyticalVisualizationObject.create(analytical_dashboard, AnalyticalDashboard, EMPTY_OBJECT, ASSIGNABLE_MEMBERS, options)
+      end
+    end
+  end
+end

data/lib/gooddata/models/metadata/analytical_visualization_object.rb

@@ -0,0 +1,30 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+#
+# Copyright (c) 2010-2021 GoodData Corporation. All rights reserved.
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+module GoodData
+  class AnalyticalVisualizationObject < GoodData::MdObject
+    class << self
+      # Create a specify object in the specify project
+      #
+      # @param object_data [Hash] the data of object will be created
+      # @param klass [Class] A class used for instantiating the returned data
+      # @param empty_data_object [Hash] the empty data of object will be created
+      # @param assignable_properties [Hash] the properties allow updating
+      # @param options [Hash] The project that the object will be created in
+      # @return klass object
+      def create(object_data, klass, empty_data_object = {}, assignable_properties = [], options = { :client => GoodData.client, :project => GoodData.project })
+        client, project = GoodData.get_client_and_project(GoodData::Helpers.symbolize_keys(options))
+
+        res = client.create(klass, GoodData::Helpers.deep_dup(GoodData::Helpers.stringify_keys(empty_data_object)), :project => project)
+        object_data.each do |k, v|
+          res.send("#{k}=", v) if assignable_properties.include? k
+        end
+        res
+      end
+    end
+  end
+end

data/lib/gooddata/models/metadata/scheduled_mail.rb

@@ -30,7 +30,7 @@ module GoodData
       :deprecated => 0,
 
       # Content When options
-      :recurrency => '0:0:0:12:0:0',
+      :recurrency => '0:0:0:1*12:0:0',
       :startDate => '2012-06-05',
       :timeZone => 'America/Los_Angeles',
 

data/lib/gooddata/models/metadata/visualization_object.rb

@@ -0,0 +1,50 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+#
+# Copyright (c) 2010-2021 GoodData Corporation. All rights reserved.
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+require_relative 'analytical_visualization_object'
+
+module GoodData
+  class VisualizationObject < GoodData::AnalyticalVisualizationObject
+    EMPTY_OBJECT = {
+      'visualizationObject' => {
+        'content' => {
+          'buckets' => [],
+          'properties' => '',
+          'visualizationClass' => {}
+        },
+        'links' => {},
+        'meta' => {
+          'deprecated' => '0',
+          'summary' => '',
+          'title' => ''
+        }
+      }
+    }
+
+    ASSIGNABLE_MEMBERS = %i[buckets properties visualizationClass deprecated summary title]
+
+    class << self
+      # Method intended to get all VisualizationObject objects in a specified project
+      #
+      # @param options [Hash] the options hash
+      # @option options [Boolean] :full with true value to pull full objects
+      # @return [Array<GoodData::VisualizationObject>] Return VisualizationObject list
+      def all(options = { :client => GoodData.connection, :project => GoodData.project })
+        query('visualizationObject', VisualizationObject, options)
+      end
+
+      # Create Visualization Object in the specify project
+      #
+      # @param visualization_object [Hash] the data of object will be created
+      # @param options [Hash] The project that the object will be created in
+      # @return GoodData::VisualizationObject object
+      def create(visualization_object = {}, options = { :client => GoodData.client, :project => GoodData.project })
+        GoodData::AnalyticalVisualizationObject.create(visualization_object, VisualizationObject, EMPTY_OBJECT, ASSIGNABLE_MEMBERS, options)
+      end
+    end
+  end
+end

data/lib/gooddata/models/process.rb

@@ -118,11 +118,13 @@ module GoodData
         GoodData.logger.info("Deploying #{path}") if verbose
 
         deployed_path = Process.upload_package(path, files_to_exclude, client: client, project: project)
+        data_sources = options[:data_sources] || []
         data = {
           :process => {
             :name => deploy_name,
             :path => "/uploads/#{File.basename(deployed_path)}",
-            :type => type
+            :type => type,
+            :dataSources => data_sources
           }
         }
 
@@ -171,10 +173,12 @@ module GoodData
         verbose = options[:verbose] || false
         GoodData.logger.info("Deploying #{path}") if verbose
 
+        data_sources = options[:data_sources] || []
         data = {
           process: {
             name: deploy_name,
             path: path,
+            dataSources: data_sources,
             type: 'RUBY'
           }
         }
@@ -185,7 +189,7 @@ module GoodData
       def deploy_component(data, options = { client: GoodData.client, project: GoodData.project })
         client, project = GoodData.get_client_and_project(options)
         data = { process: data } unless data[:process]
-        data[:process] = GoodData::Helpers.symbolize_keys(data[:process]).select { |k| %i[type name component].include? k }
+        data[:process] = GoodData::Helpers.symbolize_keys(data[:process]).select { |k| %i[type name component dataSources].include? k }
         data[:process][:component] = GoodData::Helpers.symbolize_keys(data[:process][:component]).select { |k| %i[name version configLocation config].include? k }
 
         save(data, options)
@@ -266,7 +270,7 @@ module GoodData
     # @option options [String] :name Readable name of the process
     # @option options [Boolean] :verbose (false) Switch on verbose mode for detailed logging
     def deploy(path, options = {})
-      Process.deploy(path, { client: client, process_id: process_id, :project => project, :name => name, :type => type }.merge(options))
+      Process.deploy(path, { client: client, process_id: process_id, :project => project, :name => name, :type => type, :data_sources => data_sources }.merge(options))
     end
 
     # Downloads the process from S3 in a zipped form.
@@ -326,6 +330,10 @@ module GoodData
       process['component']
     end
 
+    def data_sources
+      process['dataSources']
+    end
+
     # Determines whether the process is an ADDv2 component.
     # @return [Bool] True if the process is an ADDv2 component.
     def add_v2_component?

data/lib/gooddata/models/project.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 #
-# Copyright (c) 2010-2017 GoodData Corporation. All rights reserved.
+# Copyright (c) 2010-2021 GoodData Corporation. All rights reserved.
 # This source code is licensed under the BSD-style license found in the
 # LICENSE file in the root directory of this source tree.
 
@@ -13,7 +13,6 @@ require 'zip'
 require 'net/smtp'
 
 require 'active_support/core_ext/hash/except'
-require 'active_support/core_ext/hash/compact'
 require 'active_support/core_ext/hash/slice'
 
 require_relative '../exceptions/no_project_error'
@@ -38,7 +37,8 @@ require_relative 'metadata/scheduled_mail/report_attachment'
 
 module GoodData
   class Project < Rest::Resource
-    USERSPROJECTS_PATH = '/gdc/account/profile/%s/projects'
+    USER_ACCOUNT_PATH = '/gdc/account/profile/'
+    USERSPROJECTS_PATH = USER_ACCOUNT_PATH + '%s/projects'
     PROJECTS_PATH = '/gdc/projects'
     PROJECT_PATH = '/gdc/projects/%s'
     SLIS_PATH = '/ldm/singleloadinterface'
@@ -261,21 +261,26 @@ module GoodData
       # @option ads_output_stage_uri Uri of the source output stage. It must be in the same domain as the target project.
       def transfer_processes(from_project, to_project, options = {})
         options = GoodData::Helpers.symbolize_keys(options)
+        aliases = {}
         to_project_processes = to_project.processes
         additional_hidden_params = options[:additional_hidden_params] || {}
         result = from_project.processes.uniq(&:name).map do |process|
-          fail "The process name #{process.name} must be unique in transfered project #{to_project}" if to_project_processes.count { |p| p.name == process.name } > 1
+          fail "The process name #{process.name} must be unique in transferred project #{to_project}" if to_project_processes.count { |p| p.name == process.name } > 1
           next if process.type == :dataload || process.add_v2_component?
+          collect_process_aliases(process.data, from_project.client, aliases)
 
           to_process = to_project_processes.find { |p| p.name == process.name }
 
+          data_sources = GoodData::Helpers.symbolize_keys_recursively!(process.data_sources)
+          data_sources = replace_data_source_ids(data_sources, to_project.client, aliases)
           to_process = if process.path
                          to_process.delete if to_process
-                         GoodData::Process.deploy_from_appstore(process.path, name: process.name, client: to_project.client, project: to_project)
+                         Process.deploy_from_appstore(process.path, name: process.name, client: to_project.client, project: to_project, data_sources: data_sources)
                        elsif process.component
                          to_process.delete if to_process
                          process_hash = GoodData::Helpers::DeepMergeableHash[GoodData::Helpers.symbolize_keys(process.to_hash)].deep_merge(additional_hidden_params)
-                         GoodData::Process.deploy_component(process_hash, project: to_project, client: to_project.client)
+                         process_hash = replace_process_data_source_ids(process_hash, to_project.client, aliases)
+                         Process.deploy_component(process_hash, project: to_project, client: to_project.client)
                        else
                          Dir.mktmpdir('etl_transfer') do |dir|
                            dir = Pathname(dir)
@@ -283,11 +288,10 @@ module GoodData
                            File.open(filename, 'w') do |f|
                              f << process.download
                            end
-
                            if to_process
-                             to_process.deploy(filename, type: process.type, name: process.name)
+                             to_process.deploy(filename, type: process.type, name: process.name, data_sources: data_sources)
                            else
-                             to_project.deploy_process(filename, type: process.type, name: process.name)
+                             to_project.deploy_process(filename, type: process.type, name: process.name, data_sources: data_sources)
                            end
                          end
                        end
@@ -318,6 +322,78 @@ module GoodData
         result.compact
       end
 
+      def collect_process_aliases(process_data, client, aliases)
+        data_sources = process_data.dig('process', 'dataSources')
+        unless data_sources.blank?
+          data_sources.map do |data_source|
+            get_data_source_alias(data_source['id'], client, aliases)
+          end
+        end
+        component = process_data.dig('process', 'component')
+        get_data_source_alias(component['configLocation']['dataSourceConfig']['id'], client, aliases) if component&.dig('configLocation', 'dataSourceConfig')
+        aliases
+      end
+
+      def get_data_source_alias(data_source_id, client, aliases)
+        unless aliases[data_source_id]
+          data_source = GoodData::DataSource.from_id(data_source_id, client: client)
+          if data_source&.dig('dataSource', 'alias')
+            aliases[data_source_id] = {
+              :type => get_data_source_type(data_source),
+              :alias => data_source['dataSource']['alias']
+            }
+          end
+        end
+        aliases[data_source_id]
+      end
+
+      def get_data_source_type(data_source_data)
+        data_source_data&.dig('dataSource', 'connectionInfo') ? data_source_data['dataSource']['connectionInfo'].first[0].upcase : ""
+      end
+
+      def replace_process_data_source_ids(process_data, client, aliases)
+        component = process_data.dig(:process, :component)
+        if component&.dig(:configLocation, :dataSourceConfig)
+          the_alias = aliases[component[:configLocation][:dataSourceConfig][:id]]
+          process_data[:process][:component][:configLocation][:dataSourceConfig][:id] = verify_data_source_alias(the_alias, client)
+        end
+        process_data[:process][:dataSources] = replace_data_source_ids(process_data[:process][:dataSources], client, aliases)
+        process_data
+      end
+
+      def replace_data_source_ids(data_sources, client, aliases)
+        array_data_sources = []
+        if data_sources && !data_sources.empty?
+          data_sources.map do |data_source|
+            new_id = verify_data_source_alias(aliases[data_source[:id]], client)
+            array_data_sources.push(:id => new_id)
+          end
+        end
+        array_data_sources
+      end
+
+      # Verify whether the data source exists in the domain using its alias
+      #
+      # @param [String] ds_alias The data source's alias
+      # @param [Object] client The Rest Client object
+      # @return [String] Id of the data source or failed with the reason
+      def verify_data_source_alias(ds_alias, client)
+        domain = client.connection.server.url
+        fail "The data source alias is empty, check your data source configuration." unless ds_alias
+
+        uri = "/gdc/dataload/dataSources/internal/availableAlias?alias=#{ds_alias[:alias]}"
+        res = client.get(uri)
+        fail "Unable to get information about the Data Source '#{ds_alias[:alias]}' in the domain '#{domain}'" unless res
+        fail "Unable to find the #{ds_alias[:type]} Data Source '#{ds_alias[:alias]}' in the domain '#{domain}'" if res['availableAlias']['available']
+
+        ds_type = res['availableAlias']['existingDataSource']['type']
+        if ds_type && ds_type != ds_alias[:type]
+          fail "Wrong Data Source type - the '#{ds_type}' type is expected but the Data Source '#{ds_alias[:alias]}' in the domain '#{domain}' has the '#{ds_alias[:type]}' type"
+        else
+          res['availableAlias']['existingDataSource']['id']
+        end
+      end
+
       def transfer_user_groups(from_project, to_project)
         from_project.user_groups.map do |ug|
           # migrate groups
@@ -625,6 +701,7 @@ module GoodData
     def blueprint(options = {})
       options = { include_ca: true }.merge(options)
       result = client.get("/gdc/projects/#{pid}/model/view", params: { includeDeprecated: true, includeGrain: true, includeCA: options[:include_ca] })
+
       polling_url = result['asyncTask']['link']['poll']
       model = client.poll_on_code(polling_url, options)
       bp = GoodData::Model::FromWire.from_wire(model, options)
@@ -1661,7 +1738,7 @@ module GoodData
         end
       end
       diff_results = diff_results.map do |u|
-        u[:login_uri] = "/gdc/account/profile/" + u[:login]
+        u[:login_uri] = USER_ACCOUNT_PATH + u[:login]
         u
       end
       return diff_results if options[:dry_run]
@@ -1897,17 +1974,17 @@ module GoodData
 
     def resolve_roles(login, desired_roles, options = {})
       user = if login.is_a?(String) && login.include?('@')
-               '/gdc/account/profile/' + login
+               USER_ACCOUNT_PATH + login
              elsif login.is_a?(String)
                login
              elsif login.is_a?(Hash) && login[:login]
-               '/gdc/account/profile/' + login[:login]
+               USER_ACCOUNT_PATH + login[:login]
              elsif login.is_a?(Hash) && login[:uri]
                login[:uri]
              elsif login.respond_to?(:uri) && login.uri
                login.uri
              elsif login.respond_to?(:login) && login.login
-               '/gdc/account/profile/' + login.login
+               USER_ACCOUNT_PATH + login.login
              else
                fail "Unsupported user specification #{login}"
              end
@@ -1922,6 +1999,20 @@ module GoodData
       [user, roles]
     end
 
+    def upgrade_custom_v2(message, options = {})
+      uri = "/gdc/md/#{pid}/datedimension/upgrade"
+      poll_result = client&.post(uri, message)
+
+      return poll_result['wTaskStatus']['status'] if poll_result['wTaskStatus'] && poll_result['wTaskStatus']['status']
+
+      polling_uri = poll_result['asyncTask']['link']['poll']
+      result = client&.poll_on_response(polling_uri, options) do |body|
+        body && body['wTaskStatus'] && body['wTaskStatus']['status'] == 'RUNNING'
+      end
+
+      result['wTaskStatus']['status'] == 'OK' ? 'OK' : 'FAIL'
+    end
+
     def add
       @add ||= GoodData::AutomatedDataDistribution.new(self)
       @add

data/lib/gooddata/models/user_filters/user_filter_builder.rb

@@ -7,7 +7,6 @@
 require_relative '../project_log_formatter'
 
 require 'active_support/core_ext/hash/indifferent_access'
-require 'active_support/core_ext/hash/compact'
 
 require 'gooddata/extensions/true'
 require 'gooddata/extensions/false'

data/lib/gooddata/models/user_group.rb

@@ -13,7 +13,6 @@ require_relative '../mixins/rest_resource'
 require_relative '../mixins/uri_getter'
 
 require 'active_support/core_ext/hash/except'
-require 'active_support/core_ext/hash/compact'
 
 module GoodData
   # Representation of User Group