gooddata 2.0.1-java → 2.1.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28bd0cc29052ece07bb8eb9abfa0e1034bfa78da004bfd439832274c662faecc
-  data.tar.gz: b383f1201f65f1e58aa94148a783481825b40fb093bf17bc17eaf4ae88df490b
+  metadata.gz: 0aeb4013ddeaeb9d85a24d510186f07d057d829ae1abbaca2a3fceda59160f56
+  data.tar.gz: a988ad2a37132e168cf562c64070bf1c951afc41a1f7aa2e6a6b4b43e6137041
 SHA512:
-  metadata.gz: 9fce66e49b9823b0e2301bd6c29453b47522ce7ebaf234fd34f48c4245e5aeeab8ba201a4e629628a2e9364f668345f91e1f348c64792d7b87f1494726b66614
-  data.tar.gz: 94a17567a2dea77d431abd89c7ce7cd1754f08bbe847f87621eb0a5eb838b08ce7021ea12ca7b1240ea71f53b025386aa6e3a9a5d8294c9c5dd3a9ed8c6c45c0
+  metadata.gz: 83249304bbb76555fe9c6eae3776fcda14464bd27bbc64c275ce0961917b494540c3dbedc60c14fb5ec001fe1e545a47a85d320a8ef80006194e47d8b944c74c
+  data.tar.gz: 38a3da28fc0d6df3529b7766b2140b5b4af2933347cab5b6011235831f5b26578041858b0f34353603e748944baf7c9c780ef735e7181dc4fc7534a1b2495d13

data/.travis.yml

@@ -9,6 +9,8 @@ stages:
   if: type IN (cron)
 - name: gem-release
   if: branch = master AND type = push
+- name: gem-smoke-test
+  if: branch = master AND type = push
 
 git:
   depth: false # this is needed for pronto
@@ -31,6 +33,7 @@ jobs:
     - 2.3
     - 2.4
     - 2.5
+    - 2.6
     - jruby-1.7.19
     - jruby-9.1.5
     - jruby-9.1.7
@@ -205,7 +208,7 @@ jobs:
       chmod 0600 ~/.gem/credentials
       bundle exec rake gem:release
   - &gem-smoke-test
-    stage: gem-release
+    stage: gem-smoke-test
     name: smoke test MRI gem
     rvm: 2.3
     script: |

data/CHANGELOG.md

@@ -1,4 +1,15 @@
 # GoodData Ruby SDK Changelog
+## 2.1.0
+- TMA-1401: print message and request id on http error
+- Add doc section to contributing.md
+- TMA-1400: Add docs for update_from_blueprint
+- TMA-1383 added ruby 2.6 to travis tests
+- TMA-1231: fix CL functionality
+- FEATURE: Make number format assignable for metrics
+- FEATURE: Run gem smoke test after release
+- FEATURE: Deploy jruby gem automatically
+- Fix certificate storage set_default_paths
+
 ## 2.0.1
  - Fix pronto branch
  - Fix requiring version.rb
@@ -342,7 +353,7 @@ This is a major version release because the method `.release_info` has been hard
  - TMA-604: can put metrics in folders
  - TMA-843: avoid abuse of obj resource in partial md import export
  - TMA-892: User filters brick dry run (#1156)
- - * TMA-892: User filters brick dry run
+ - * TMA-892: User filters brick dry run
  - TMA-761: add support for manual schedule execution
  - fix recovery from provision clients error
  - make sso backwards compatible

data/CONTRIBUTING.md

@@ -48,6 +48,16 @@ We use [Pronto](https://github.com/prontolabs/pronto) to detect code smells usin
 - [Reek](https://github.com/troessner/reek#editor-integrations)
 - [Flay](https://github.com/seattlerb/flay)
 
+## Documentation
+
+#### Yard
+
+We use `yard` to auto-generate [documentation from comments](https://www.rubydoc.info/gems/gooddata/). Document all new and modified public methods using [`yard` tags](https://www.rubydoc.info/gems/yard/file/docs/Tags.md). Run `./yard-server.sh` to see the result.
+
+#### Cookbook
+
+Usage examples can be found [here](https://sdk.gooddata.com/gooddata-ruby-doc). If your change deserves an example, make a PR to [this repo](https://github.com/gooddata/gooddata-ruby-doc).
+
 ## Acceptance criteria
 
 1. The change is as small as possible. It fixes one specific issue or implements
@@ -71,5 +81,6 @@ We use [Pronto](https://github.com/prontolabs/pronto) to detect code smells usin
 1. If the pull request adds any new libraries, they should be in line with our
    [license](/LICENSE).
 1. Use `GoodData.logger` for logging instead of `puts`.
+1. Public methods [are documented](#documentation) and examples are added to the [cookbook](#cookbook) when applicable.
 
 _Based on [GitLab's contribution guide](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md)._

data/SDK_VERSION

@@ -1 +1 @@
-2.0.1
+2.1.0

data/VERSION

@@ -1 +1 @@
-3.5.0
+3.6.0

data/bin/run_smoke_tests.sh

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
 
 export LCM_BRICKS_IMAGE_TAG=$GOODDATA_RUBY_COMMIT
+export GD_ENV=staging
 /bin/bash -l -c ". /usr/local/rvm/scripts/rvm && bundle exec rake -f lcm.rake test:smoke"

data/bin/test_projects_cleanup.rb

@@ -81,9 +81,14 @@ def clean_up!(client, force, days)
   delete_project_by_title(/Test MINOR project/, projects, days, force)
   delete_project_by_title(/^Test project$/, projects, days, force)
   delete_project_by_title(/userprov-e2e-testing/, projects, days, force)
+  delete_project_by_title(/load test service project/, projects, days, force)
+  delete_project_by_title(/LCM SPEC PROJECT/, projects, days, force)
+  delete_project_by_title(/LCM spec Client With Conflicting LDM Changes/, projects, days, force)
+  delete_project_by_title(/LCM spec master project/, projects, days, force)
+  delete_project_by_title(/users brick load test/, client, days, force)
   delete_ads_by_title(/Development ADS/, client, days, force)
   delete_ads_by_title(/Production ADS/, client, days, force)
-  delete_ads_by_title(/^users brick load test/, client, days, force)
+  delete_ads_by_title(/TEST ADS/, client, days, force)
 end
 
 def init_client(username, password, server)

data/gooddata.gemspec

@@ -74,4 +74,5 @@ Gem::Specification.new do |s|
   s.add_dependency 'terminal-table', '~> 1.7'
   s.add_dependency 'thread_safe'
   s.add_dependency 'backports'
+  s.add_dependency 'tty-spinner'
 end

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

@@ -0,0 +1,30 @@
+# Copyright (c) 2010-2019 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 '../shared'
+require_relative '../../commands/api'
+
+require 'json'
+require 'tty-spinner'
+
+module GoodData
+  module CLI
+    desc 'Make any requests to the gooddata api'
+    command :api do |c|
+      %i[get delete post].map do |http_method|
+        c.desc "Make a #{http_method} request"
+        c.command http_method do |method|
+          method.action do |global_options, options, args|
+            opts = options.merge(global_options)
+            spinner = TTY::Spinner.new ":spinner Calling GoodData API"
+            spinner.auto_spin
+            res = GoodData::Command::Api.send(http_method, args, opts)
+            spinner.stop
+            puts res.to_json
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -5,6 +5,7 @@
 # LICENSE file in the root directory of this source tree.
 
 require 'pathname'
+require 'tty-spinner'
 
 require_relative '../shared'
 require_relative '../../commands/domain'
@@ -19,7 +20,11 @@ module GoodData
       c.command :users do |users|
         users.action do |global_options, options, args|
           opts = options.merge(global_options)
-          GoodData::Command::Domain.list_users(args[0], opts)
+          spinner = TTY::Spinner.new ":spinner Fetching users from domain"
+          spinner.auto_spin
+          res = GoodData::Command::Domain.list_users(args[0], opts)
+          spinner.stop
+          res
         end
       end
     end

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

@@ -0,0 +1,52 @@
+# Copyright (c) 2010-2019 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 '../shared'
+require_relative '../../commands/api'
+
+require 'json'
+require 'tty-spinner'
+
+module GoodData
+  module CLI
+    desc 'Manage processes (ETLs, Ruby bricks..)'
+    command :process do |c|
+      c.desc 'Create a new process'
+      c.command :create do |s|
+        s.desc 'Create a new process from a webdav or gerrit appstore path'
+        s.command :from_path do |cs|
+          cs.action do |global_options, options, args|
+            opts = options.merge(global_options)
+            path = args.first
+            spinner = TTY::Spinner.new ":spinner Creating process"
+            spinner.auto_spin
+            client = GoodData.connect opts
+            project = client.projects(opts[:project_id])
+            res = GoodData::Process.deploy(path, project: project, client: client)
+            spinner.stop
+            puts res.to_json
+          end
+        end
+
+        s.desc 'Create a new process as a pluggable component'
+        s.command :as_component do |ac|
+          ac.action do |global_options, options, args|
+            opts = options.merge(global_options)
+            file = args.first
+            fail 'Deploying a component requires a JSON formatted payload as a parameter' unless file
+
+            payload = JSON.parse(File.read(file))
+            spinner = TTY::Spinner.new ":spinner Creating process"
+            spinner.auto_spin
+            client = GoodData.connect opts
+            project = client.projects(opts[:project_id])
+            res = GoodData::Process.deploy_component(payload, project: project, client: client)
+            spinner.stop
+            puts res.to_json
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -5,6 +5,8 @@
 # LICENSE file in the root directory of this source tree.
 
 require 'pathname'
+require 'json'
+require 'tty-spinner'
 
 require_relative '../shared'
 require_relative '../../commands/project'
@@ -19,7 +21,27 @@ module GoodData
       c.command :users do |users|
         users.action do |global_options, options, _args|
           opts = options.merge(global_options)
-          GoodData::Command::Project.list_users(opts)
+          spinner = TTY::Spinner.new ":spinner Listing users"
+          spinner.auto_spin
+          res = GoodData::Command::Project.list_users(opts)
+          spinner.stop
+          res
+        end
+      end
+
+      c.desc 'Create new project'
+      c.command :create do |create|
+        create.action do |global_options, options, _args|
+          opts = options.merge(global_options)
+          token = opts[:token]
+          title = opts[:title] || 'New project'
+          driver = opts[:driver] || 'Pg'
+          spinner = TTY::Spinner.new ":spinner Creating project"
+          spinner.auto_spin
+          client = GoodData.connect(opts)
+          res = GoodData::Command::Project.create(token: token, title: title, driver: driver, client: client)
+          spinner.stop
+          puts res.to_json
         end
       end
     end

data/lib/gooddata/cli/hooks.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 #
 # Copyright (c) 2010-2017 GoodData Corporation. All rights reserved.
 # This source code is licensed under the BSD-style license found in the
@@ -11,7 +10,8 @@ require_relative '../helpers/auth_helpers'
 GoodData::CLI.module_eval do
   pre do |global, _command, _options, _args|
     require 'logger'
-    GoodData.logger = Logger.new(STDOUT) if global[:l]
+    GoodData.logger = Logger.new(STDERR)
+    GoodData.logger.level = Logger::Severity::ERROR
     username = global[:username]
     password = global[:password]
     token = global[:token]
@@ -21,6 +21,7 @@ GoodData::CLI.module_eval do
     username = creds[:username] if username.nil?
     password = creds[:password] if password.nil?
     token = creds[:auth_token] || creds[:token] if token.nil?
+    GoodData.logger.error 'SSL verification is turned off. I hope you are not in production!' unless global[:verify_ssl]
 
     global[:token] = token if global[:token].nil?
     if global[:login].nil?

data/lib/gooddata/commands/api.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 #
 # Copyright (c) 2010-2017 GoodData Corporation. All rights reserved.
 # This source code is licensed under the BSD-style license found in the
@@ -37,26 +36,32 @@ module GoodData
 
         # Get resource
         # @param path Resource path
-        def get(path)
+        def get(args, opts)
+          path = args.first
           fail(GoodData::CommandFailed, 'Specify the path you want to GET.') if path.nil?
-          result = GoodData.get path
-          begin
-            result
-          rescue
-            puts result
-          end
+
+          client = GoodData.connect(opts)
+          client.get path
         end
 
         # Delete resource
         # @param path Resource path
-        def delete(path)
+        def delete(args, opts)
+          path = args.first
           fail(GoodData::CommandFailed, 'Specify the path you want to DELETE.') if path.nil?
-          result = GoodData.delete path
-          begin
-            result
-          rescue
-            puts result
-          end
+
+          client = GoodData.connect(opts)
+          client.delete path
+        end
+
+        def post(args, opts)
+          path = Array(args).shift
+          fail(GoodData::CommandFailed, 'Specify the path you want to POST to.') if path.nil?
+
+          payload = Array(args).shift
+          json = payload && File.exist?(payload) ? JSON.parse(File.read(payload)) : {}
+          client = GoodData.connect(opts)
+          client.post path, json
         end
       end
     end

data/lib/gooddata/commands/auth.rb

@@ -38,7 +38,7 @@ module GoodData
           end
 
           # Ask for token
-          auth_token = GoodData::CLI.terminal.ask('Authorization Token') do |q|
+          auth_token = GoodData::CLI.terminal.ask('Authorization (Project) Token') do |q|
             set_default_value(q, old_credentials[:auth_token])
           end
 
@@ -64,7 +64,7 @@ module GoodData
 
         # Ask for credentials and store them
         def store(credentials_file_path = Helpers::AuthHelper.credentials_file)
-          puts 'This will store credntials to GoodData in an enencrypted form to your harddrive to file ~/.gooddata.'
+          puts 'This will store credentials to GoodData in an UNencrypted form to your harddrive to file ~/.gooddata.'
           overwrite = GoodData::CLI.terminal.ask('Do you want to continue? (y/n)')
           return if overwrite != 'y'
 

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

@@ -16,7 +16,7 @@ module GoodData
     extend GoodData::Mixin::ContentPropertyReader
     extend GoodData::Mixin::ContentPropertyWriter
 
-    content_property_reader :folders, :expression
+    content_property_reader :folders, :expression, :format
     content_property_writer :folders, :expression
 
     class << self
@@ -44,11 +44,13 @@ module GoodData
           extended_notation = options[:extended_notation] || false
           title = options[:title]
           summary = options[:summary]
+          format = options[:format]
         else
           metric ||= options
           title = metric[:title] || options[:title]
           summary = metric[:summary] || options[:summary]
           expression = metric[:expression] || options[:expression] || fail('Metric has to have its expression defined')
+          format = metric[:format] || options[:format]
           extended_notation = metric[:extended_notation] || options[:extended_notation] || false
         end
 
@@ -76,7 +78,7 @@ module GoodData
         metric = {
           'metric' => {
             'content' => {
-              'format' => '#,##0',
+              'format' => format || '#,##0',
               'expression' => expression
             },
             'meta' => {

data/lib/gooddata/models/process.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 #
 # Copyright (c) 2010-2017 GoodData Corporation. All rights reserved.
 # This source code is licensed under the BSD-style license found in the
@@ -67,7 +66,7 @@ module GoodData
             begin
               res = GoodData::Process.deploy(dir, options.merge(:files_to_exclude => params))
               block.call(res)
-            rescue => e
+            rescue StandardError => e
               GoodData.logger.error(e.inspect)
             ensure
               res.delete if res
@@ -106,11 +105,13 @@ module GoodData
       def deploy_simple_process(path, options = { client: GoodData.client, project: GoodData.project })
         client, project = GoodData.get_client_and_project(options)
 
-        path = Pathname(path) || fail('Path is not specified')
+        fail 'Path is not specified' unless path
+
+        path = Pathname(path) || fail('Path is not a valid pathname')
         files_to_exclude = options[:files_to_exclude].nil? ? [] : options[:files_to_exclude].map { |pname| Pathname(pname) }
 
         type = options[:type] || 'GRAPH'
-        deploy_name = options[:name]
+        deploy_name = options[:name] || "Process of #{path} script"
         fail ArgumentError, 'options[:name] can not be nil or empty!' if deploy_name.nil? || deploy_name.empty?
 
         verbose = options[:verbose] || false
@@ -157,9 +158,7 @@ module GoodData
 
             full_brick_path = File.join(dir, 'app_store', brick_path)
 
-            unless File.exist?(full_brick_path)
-              fail "Invalid brick name specified - '#{brick_name}'"
-            end
+            fail "Invalid brick name specified - '#{brick_name}'" unless File.exist?(full_brick_path)
 
             return deploy(full_brick_path, opts)
           end
@@ -167,8 +166,7 @@ module GoodData
       end
 
       def deploy_from_appstore(path, options = { :client => GoodData.client, :project => GoodData.project })
-        deploy_name = options[:name]
-        fail ArgumentError, 'options[:name] can not be nil or empty!' if deploy_name.nil? || deploy_name.empty?
+        deploy_name = options[:name] || "Process of #{path}"
 
         verbose = options[:verbose] || false
         GoodData.logger.info("Deploying #{path}") if verbose
@@ -211,9 +209,7 @@ module GoodData
           else
             client.put("/gdc/projects/#{project.pid}/dataload/processes/#{process_id}", data)
           end
-        if res.keys.first == 'asyncTask'
-          res = JSON.parse(client.poll_on_code(res['asyncTask']['links']['poll'], options.merge(process: false)))
-        end
+        res = JSON.parse(client.poll_on_code(res['asyncTask']['links']['poll'], options.merge(process: false))) if res.keys.first == 'asyncTask'
 
         client.create(Process, res, project: project)
       end
@@ -242,7 +238,7 @@ module GoodData
           # this branch expects a zipped file. Since the filename on webdav is by default
           # equal to the filename of a local file. I happened often that the name clashed
           # if ran in parallel. Create a randomized name to mitigate that
-          randomized_filename = (0...16).map { (65 + rand(26)).chr }.join
+          randomized_filename = (0...16).map { (rand(65..90)).chr }.join
           client.upload_to_user_webdav(path, { filename: randomized_filename }.merge(opts))
           randomized_filename
         else
@@ -357,9 +353,7 @@ module GoodData
         raise(e)
       ensure
         result = client.get(result['executionTask']['links']['detail'])
-        if result['executionDetail']['status'] == 'ERROR'
-          fail "Runing process failed. You can look at a log here #{result['executionDetail']['logFileName']}"
-        end
+        fail "Runing process failed. You can look at a log here #{result['executionDetail']['logFileName']}" if result['executionDetail']['status'] == 'ERROR'
       end
       client.create(GoodData::ExecutionDetail, result, client: client, project: project)
     end

data/lib/gooddata/models/project.rb

@@ -1847,6 +1847,17 @@ module GoodData
       GoodData::Variable[id, options]
     end
 
+    # Applies blueprint to the project.
+    #
+    # @param [Hash] blueprint Blueprint to apply to the project.
+    # @option options [Hash] :update_preference (cascade_drops: false, preserve_data: true) Specifies how dropping LDM and data should be treated.
+    # @example Update with custom update preference.
+    #   GoodData.project.update_from_blueprint(
+    #     blueprint,
+    #     update_preference: {
+    #       cascade_drops: false, preserve_data: false
+    #     }
+    #   )
     def update_from_blueprint(blueprint, options = {})
       GoodData::Model::ProjectCreator.migrate(options.merge(spec: blueprint, token: options[:auth_token], client: client, project: self))
     end

data/lib/gooddata/rest/connection.rb

@@ -43,9 +43,13 @@ module GoodData
         :user_agent => GoodData.gem_version_string
       }
 
+      CERTIFICATE_STORE = OpenSSL::X509::Store.new.freeze
+      CERTIFICATE_STORE.set_default_paths
+
       DEFAULT_LOGIN_PAYLOAD = {
         :headers => DEFAULT_HEADERS,
-        :verify_ssl => true
+        :verify_ssl => true,
+        :ssl_cert_store => CERTIFICATE_STORE
       }
 
       RETRYABLE_ERRORS = [
@@ -462,6 +466,17 @@ module GoodData
         "#{@execution_id}:#{session_id}:#{call_id}"
       end
 
+      def enrich_error_message(exception)
+        begin
+          response = JSON.parse(exception.response.body, symbolize_names: true)
+          return exception unless exception.message && response[:error] && response[:error][:message] && response[:error][:requestId]
+
+          exception.message = exception.message + ': ' + response[:error][:message] % response[:error][:parameters] + ' request_id: ' + response[:error][:requestId]
+        rescue JSON::ParserError # rubocop:disable Lint/HandleExceptions
+        end
+        exception
+      end
+
       private
 
       def create_webdav_dir_if_needed(url)
@@ -561,8 +576,12 @@ ERR
         dont_reauth = options[:dont_reauth]
         options = options.reject { |k, _| [:process, :dont_reauth].include?(k) }
         opts = { tries: retries, refresh_token: proc { refresh_token unless dont_reauth } }.merge(options)
-        response = GoodData::Rest::Connection.retryable(opts) do
-          block.call
+        begin
+          response = GoodData::Rest::Connection.retryable(opts) do
+            block.call
+          end
+        rescue RestClient::Exception => e
+          fail enrich_error_message(e)
         end
         merge_headers! response.headers
         content_type = response.headers[:content_type]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gooddata
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: java
 authors:
 - Pavel Kolesnikov
@@ -14,7 +14,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-02-25 00:00:00.000000000 Z
+date: 2019-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -462,6 +462,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: tty-spinner
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 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.
 email: lcm@gooddata.com
@@ -470,7 +484,7 @@ executables:
 - gooddata
 - hello_world.sh
 - help.sh
-- provisioning.sh
+- provision.sh
 - release.sh
 - rollout.sh
 - run_brick.rb
@@ -518,7 +532,7 @@ files:
 - bin/gooddata
 - bin/hello_world.sh
 - bin/help.sh
-- bin/provisioning.sh
+- bin/provision.sh
 - bin/release.sh
 - bin/rollout.sh
 - bin/run_brick.rb
@@ -572,8 +586,10 @@ files:
 - lib/gooddata/bricks/users_brick.rb
 - lib/gooddata/bricks/utils.rb
 - lib/gooddata/cli/cli.rb
+- lib/gooddata/cli/commands/api_cmd.rb
 - lib/gooddata/cli/commands/auth_cmd.rb
 - lib/gooddata/cli/commands/domain_cmd.rb
+- lib/gooddata/cli/commands/process_cmd.rb
 - lib/gooddata/cli/commands/project_cmd.rb
 - lib/gooddata/cli/hooks.rb
 - lib/gooddata/cli/shared.rb