Class: GoodData::LCM2::CollectClients

Inherits:
BaseAction show all
Defined in:
lib/gooddata/lcm/actions/collect_clients.rb

Constant Summary collapse

DESCRIPTION = 
'Collect Clients'
PARAMS = 
define_params(self) do
  description 'Client Used for Connecting to GD'
  param :gdc_gd_client, instance_of(Type::GdClientType), required: true

  description 'Segments to manage'
  param :segments, array_of(instance_of(Type::SegmentType)), required: true

  description 'Client Id Column'
  param :client_id_column, instance_of(Type::StringType), required: false

  description 'Segment Id Column'
  param :segment_id_column, instance_of(Type::StringType), required: false

  description 'Project Id Column'
  param :project_id_column, instance_of(Type::StringType), required: false

  description 'Client Project Title Column'
  param :project_title_column, instance_of(Type::StringType), required: false

  description 'Client Project Token Column'
  param :project_token_column, instance_of(Type::StringType), required: false

  description 'Input Source'
  param :input_source, instance_of(Type::HashType), required: true
end
RESULT_HEADER = 
[
  :client,
  :segment_id,
  :title
]

Constants inherited from BaseAction

BaseAction::FAILED_CLIENTS, BaseAction::FAILED_PROJECTS, BaseAction::FAILED_SEGMENTS, BaseAction::SYNC_FAILED_LIST

Constants included from Dsl::Dsl

Dsl::Dsl::DEFAULT_OPTS, Dsl::Dsl::TYPES

Class Method Summary collapse

Methods inherited from BaseAction

add_failed_client, add_failed_project, add_failed_segment, add_new_clients_to_project_client_mapping, check_params, collect_synced_status, continue_on_error, print_result, process_failed_project, process_failed_projects, sync_failed_client, sync_failed_project, sync_failed_segment, without_check

Methods included from Dsl::Dsl

#define_params, #define_type, #process

Class Method Details

.call(params) ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/gooddata/lcm/actions/collect_clients.rb', line 47

def call(params)
  segment_names = params.segments.map(&:segment_id)

  clients, errors = collect_clients(params, segment_names)
  fail "These are errors while collecting clients from input data:\n#{errors.join("\n")}" unless errors.empty?

  results = clients.map do |client|
    {
      client: client[:id],
      segment_id: client[:segment],
      title: client[:project_title]
    }
  end

  {
    results: results,
    params: {
      clients: clients
    }
  }
end

.collect_clients(params, segment_names = nil) ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/gooddata/lcm/actions/collect_clients.rb', line 69

def collect_clients(params, segment_names = nil)
  client_id_column = params.client_id_column&.downcase || 'client_id'
  segment_id_column = params.segment_id_column&.downcase || 'segment_id'
  project_id_column = params.project_id_column&.downcase || 'project_id'
  project_title_column = params.project_title_column&.downcase || 'project_title'
  project_token_column = params.project_token_column&.downcase || 'project_token'
  client = params.gdc_gd_client

  clients = []
  errors = []
  data_source = GoodData::Helpers::DataSource.new(params.input_source)
  input_data = without_check(PARAMS, params) do
    File.open(data_source.realize(params), 'r:UTF-8')
  end
  GoodData.logger.debug("Input data: #{input_data.read}")
  GoodData.logger.debug("Segment names: #{segment_names}")
  CSV.foreach(input_data, :headers => true, :return_headers => false, :header_converters => :downcase, :encoding => 'utf-8') do |row|
    GoodData.logger.debug("Processing row: #{row}")
    segment_name = row[segment_id_column]
    GoodData.logger.debug("Segment name: #{segment_name}")
    if segment_names.nil? || segment_names.include?(segment_name)
      client_id = row[client_id_column]
      pid = row[project_id_column]

      if pid
        begin
          errors << "Project #{pid} of client #{client_id} is deleted." if client.projects(pid).deleted?
        rescue
          errors << "Seems like you (user executing the script - #{client.user.}) \
          do not have access to project \"#{pid}\" of client \"#{client_id}\""
        end
      end

      clients << {
        id: client_id,
        segment: segment_name,
        project: pid,
        settings: [
          {
            name: 'lcm.token',
            value: row[project_token_column]
          },
          {
            name: 'lcm.title',
            value: row[project_title_column]
          }
        ]
      }.compact
    end
  end

  if clients.empty?
    errors << "No segments or clients qualify for provisioning. \
    Please check the input source data, platform segments, and the SEGMENTS_FILTER parameter. \
    The intersection of these three elements is empty set."
  end
  [clients, errors]
end