gooddata 0.6.10 → 0.6.11

data/lib/gooddata/models/process.rb

@@ -1,9 +1,14 @@
 # encoding: UTF-8
 
 require 'pry'
+require 'zip'
 
+require_relative '../helpers/global_helpers'
 require_relative '../rest/resource'
 
+require_relative 'execution_detail'
+require_relative 'schedule'
+
 module GoodData
   class Process < GoodData::Rest::Object
     attr_reader :data
@@ -82,48 +87,7 @@ module GoodData
         project = GoodData::Project[p, opts]
         fail ArgumentError, 'Wrong :project specified' if project.nil?
 
-        if !path.directory? && (path.extname == '.grf' || path.extname == '.rb')
-          puts 'Creating package for upload'
-          Tempfile.open('deploy-graph-archive') do |temp|
-            Zip::OutputStream.open(temp.path) do |zio|
-              FileUtils.cd(path.parent) do
-                files_to_pack = [path.basename]
-                files_to_pack.each do |item|
-                  puts "including #{item}"
-                  unless File.directory?(item)
-                    zio.put_next_entry(item)
-                    zio.print IO.read(item)
-                  end
-                end
-              end
-            end
-
-            client.upload_to_user_webdav(temp.path, opts)
-            temp.path
-          end
-        elsif !path.directory?
-          client.upload_to_user_webdav(path, opts)
-          path
-        else
-          Tempfile.open('deploy-graph-archive') do |temp|
-            Zip::OutputStream.open(temp.path) do |zio|
-              FileUtils.cd(path) do
-
-                files_to_pack = Dir.glob('./**/*').reject { |f| files_to_exclude.include?(Pathname(path) + f) }
-                files_to_pack.each do |item|
-                  puts "including #{item}"
-                  unless File.directory?(item)
-                    zio.put_next_entry(item)
-                    zio.print IO.read(item)
-                  end
-                end
-              end
-            end
-
-            client.upload_to_user_webdav(temp.path, opts)
-            temp.path
-          end
-        end
+        zip_and_upload path, files_to_exclude, opts
       end
 
       # Deploy a new process or redeploy existing one.
@@ -134,7 +98,7 @@ module GoodData
       # @option options [String] :name Readable name of the process
       # @option options [String] :process_id ID of a process to be redeployed (do not set if you want to create a new process)
       # @option options [Boolean] :verbose (false) Switch on verbose mode for detailed logging
-      def deploy(path, options = {})
+      def deploy(path, options = { :client => GoodData.client, :project => GoodData.project })
         client = options[:client]
         fail ArgumentError, 'No :client specified' if client.nil?
 
@@ -174,6 +138,46 @@ module GoodData
         puts HighLine.color("Deploy DONE #{path}", HighLine::GREEN) if verbose
         process
       end
+
+      # ----------------------------- Private Stuff
+
+      private
+
+      def zip_and_upload(path, files_to_exclude, opts = {})
+        def with_zip(opts = {})
+          Tempfile.open('deploy-graph-archive') do |temp|
+            zip_filename = temp.path
+            File.open(zip_filename, 'w') do |zip|
+              Zip::File.open(zip.path, Zip::File::CREATE) do |zipfile|
+                yield zipfile
+              end
+            end
+            client.upload_to_user_webdav(temp.path, opts)
+            temp.path
+          end
+        end
+
+        puts 'Creating package for upload'
+        if !path.directory? && (path.extname == '.grf' || path.extname == '.rb')
+          with_zip(opts) do |zipfile|
+            zipfile.add(File.basename(path), path)
+          end
+
+        elsif !path.directory?
+          client.upload_to_user_webdav(path, opts)
+          path
+        else
+          with_zip(opts) do |zipfile|
+            Dir[File.join(path, '**', '**')].reject { |f| files_to_exclude.include?(Pathname(path) + f) }.each do |file|
+              file_pathname = Pathname.new(file)
+              puts "Including item #{file_pathname}"
+              file_relative_pathname = file_pathname.relative_path_from(Pathname.new(path))
+              zipfile.add(file_relative_pathname, file)
+            end
+          end
+        end
+      end
+      # -----------------------------
     end
 
     def initialize(data)
@@ -193,7 +197,15 @@ 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, options.merge(:process_id => process_id))
+      Process.deploy(path, options.merge(:process_id => process_id, :client => client, :project => project))
+    end
+
+    # Downloads the process from S3 in a zipped form.
+    #
+    # @return [IO] The stream of data that represents a zipped deployed process.
+    def download
+      link = links['source']
+      client.get(link, process: false) { |_, _, result| RestClient.get(result.to_hash['location'].first) }
     end
 
     def process
@@ -245,14 +257,7 @@ module GoodData
     end
 
     def execute(executable, options = {})
-      params = options[:params] || {}
-      hidden_params = options[:hidden_params] || {}
-      result = client.post(executions_link,
-                           :execution => {
-                             :graph => executable.to_s,
-                             :params => params,
-                             :hiddenParams => hidden_params
-                           })
+      result = start_execution(executable, options)
       begin
         client.poll_on_code(result['executionTask']['links']['poll'])
       rescue RestClient::RequestFailed => e
@@ -260,10 +265,21 @@ module GoodData
       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"]}"
+          fail "Runing process failed. You can look at a log here #{result['executionDetail']['logFileName']}"
         end
       end
-      result
+      client.create(GoodData::ExecutionDetail, result, client: client, project: project)
+    end
+
+    def start_execution(executable, options = {})
+      params = options[:params] || {}
+      hidden_params = options[:hidden_params] || {}
+      client.post(executions_link,
+                  :execution => {
+                    :graph => executable.to_s,
+                    :params => GoodData::Helpers.encode_params(params, false),
+                    :hiddenParams => GoodData::Helpers.encode_params(hidden_params, true)
+                  })
     end
   end
 end

data/lib/gooddata/models/profile.rb

@@ -43,7 +43,31 @@ module GoodData
       :timezone
     ]
 
+    PROFILE_PATH = '/gdc/account/profile/%s'
+
     class << self
+      # Get profile by ID or URI
+      #
+      # @param id ID or URI of user to be found
+      # @param [Hash] opts Additional optional options
+      # @option opts [GoodData::Rest::Client] :client Client used for communication with server
+      # @return GoodData::Profile User Profile
+      def [](id, opts = { client: GoodData.connection })
+        return id if id.instance_of?(GoodData::Profile) || id.respond_to?(:profile?) && id.profile?
+
+        if id.to_s !~ %r{^(\/gdc\/account\/profile\/)?[a-zA-Z\d]+$}
+          fail(ArgumentError, 'wrong type of argument. Should be either project ID or path')
+        end
+
+        id = id.match(/[a-zA-Z\d]+$/)[0] if id =~ /\//
+
+        c = client(opts)
+        fail ArgumentError, 'No :client specified' if c.nil?
+
+        response = c.get(PROFILE_PATH % id)
+        c.factory.create(Profile, response)
+      end
+
       # Apply changes to object.
       #
       # @param obj [GoodData::Profile] Object to be modified
@@ -110,13 +134,13 @@ module GoodData
             next
           end
 
-          if user_existing != user_new
-            diff = self.diff(user_existing, user_new)
-            res[:changed] << {
-              :user => user_existing,
-              :diff => diff
-            }
-          end
+          next if user_existing == user_new
+
+          diff = self.diff(user_existing, user_new)
+          res[:changed] << {
+            :user => user_existing,
+            :diff => diff
+          }
         end
 
         tmp = Hash[list2.map { |v| [v.email, v] }]
@@ -250,6 +274,15 @@ module GoodData
       @json['accountSetting']['firstName'] = val
     end
 
+    # Get full name
+    #
+    # @return String Full Name
+    def full_name
+      "#{first_name} #{last_name}"
+    end
+
+    alias_method :title, :full_name
+
     # Gets the last name
     #
     # @return [String] Last name
@@ -293,17 +326,21 @@ module GoodData
     #
     # @return [String] Phone
     def phone
-      @json['accountSetting']['phone'] || ''
+      @json['accountSetting']['phoneNumber'] || ''
     end
 
+    alias_method :phone_number, :phone
+
     # Set the phone
     #
     # @param val [String] Phone to be set
     def phone=(val)
       @dirty ||= phone != val
-      @json['accountSetting']['phone'] = val
+      @json['accountSetting']['phoneNumber'] = val
     end
 
+    alias_method :phone_number=, :phone=
+
     # Gets the position in company
     #
     # @return [String] Position in company
@@ -331,7 +368,7 @@ module GoodData
 
     # Saves object if dirty, clears dirty flag
     def save!
-      if @dirty
+      if @dirty # rubocop:disable Style/GuardClause
         raw = @json.dup
         raw['accountSetting'].delete('login')
 

data/lib/gooddata/models/project.rb

@@ -51,7 +51,7 @@ module GoodData
       #  - /gdc/projects/<id>
       #  - <id>
       #
-      def [](id, opts = {})
+      def [](id, opts = { client: GoodData.connection })
         return id if id.instance_of?(GoodData::Project) || id.respond_to?(:project?) && id.project?
 
         if id == :all
@@ -83,8 +83,8 @@ module GoodData
         c = client(opts)
         fail ArgumentError, 'No :client specified' if c.nil?
 
-        auth_token = opts[:auth_token] || GoodData.connection.auth_token
-        fail 'You have to provide your token for creating projects as :auth_token parameter' if auth_token.nil? || auth_token.empty?
+        auth_token = opts[:auth_token]
+        fail ArgumentError, 'You have to provide your token for creating projects as :auth_token parameter' if auth_token.nil? || auth_token.empty?
 
         json = {
           'project' =>
@@ -123,7 +123,7 @@ module GoodData
         project
       end
 
-      def find(opts = {}, client = GoodData::Rest::Client.client)
+      def find(_opts = {}, client = GoodData::Rest::Client.client)
         user = client.user
         user.projects['projects'].map do |project|
           client.create(GoodData::Project, project)
@@ -157,17 +157,34 @@ module GoodData
       if metric.is_a?(String)
         GoodData::Metric.xcreate(metric, options.merge(default))
       else
-        GoodData::Metric.xcreate(metric.merge(default))
+        GoodData::Metric.xcreate(options[:expression], metric.merge(options.merge(default)))
       end
     end
     alias_method :create_metric, :add_metric
 
+    # Creates new instance of report in context of project
+    #
+    # @param [options] Optional report options
+    # @return [GoodData::Report] Instance of new report
     def add_report(options = {})
       rep = GoodData::Report.create(options.merge(client: client, project: self))
       rep.save
     end
     alias_method :create_report, :add_report
 
+    # Creates new instance of report definition in context of project
+    # This report definition can be used for creating of GoodData::Report
+    #
+    # @param [json] Raw report definition json
+    # @return [GoodData::ReportDefinition] Instance of new report definition
+    def add_report_definition(json)
+      rd = GoodData::ReportDefinition.new(json)
+      rd.client = client
+      rd.project = self
+      rd.save
+    end
+    alias_method :create_report_definition, :add_report_definition
+
     # Returns an indication whether current user is admin in this project
     #
     # @return [Boolean] True if user has admin role in the project, false otherwise.
@@ -215,15 +232,38 @@ module GoodData
 
     # Clones project
     #
+    # @param options [Hash] Export options
+    # @option options [Boolean] :data Clone project with data
+    # @option options [Boolean] :users Clone project with users
+    # @option options [String] :authorized_users Comma separated logins of authorized users. Users that can use the export
     # @return [GoodData::Project] Newly created project
     def clone(options = {})
-      # TODO: Refactor so if export or import fails the new_project will be cleaned
-      with_data = options[:data].nil? ? true : options[:data]
-      with_users = options[:users].nil? ? false : options[:users]
       a_title = options[:title] || "Clone of #{title}"
 
-      # Create the project first so we know that it is passing. What most likely is wrong is the tokena and the export actaully takes majoiryt of the time
-      new_project = GoodData::Project.create(options.merge(:title => a_title, :client => client))
+      begin
+        # Create the project first so we know that it is passing.
+        # What most likely is wrong is the token and the export actaully takes majority of the time
+        new_project = GoodData::Project.create(options.merge(:title => a_title, :client => client))
+        export_token = export_clone(options)
+        new_project.import_clone(export_token)
+      rescue
+        new_project.delete if new_project
+        raise
+      end
+    end
+
+    # Export a clone from a project to be later imported.
+    # If you do not want to do anything special and you do not need fine grained
+    # controle use clone method which does all the heavy lifting for you.
+    #
+    # @param options [Hash] Export options
+    # @option options [Boolean] :data Clone project with data
+    # @option options [Boolean] :users Clone project with users
+    # @option options [String] :authorized_users Comma separated logins of authorized users. Users that can use the export
+    # @return [String] token of the export
+    def export_clone(options = {})
+      with_data = options[:data].nil? ? true : options[:data]
+      with_users = options[:users].nil? ? false : options[:users]
 
       export = {
         :exportProject => {
@@ -231,28 +271,34 @@ module GoodData
           :exportData => with_data ? 1 : 0
         }
       }
+      export[:exportProject][:authorizedUsers] = options[:authorized_users] if options[:authorized_users]
 
       result = client.post("/gdc/md/#{obj_id}/maintenance/export", export)
-      export_token = result['exportArtifact']['token']
-
       status_url = result['exportArtifact']['status']['uri']
       client.poll_on_response(status_url) do |body|
         body['taskState']['status'] == 'RUNNING'
       end
+      result['exportArtifact']['token']
+    end
 
+    # Imports a clone into current project. The project has to be freshly
+    # created.
+    #
+    # @param export_token [String] Export token of the package to be imported
+    # @return [Project] current project
+    def import_clone(export_token)
       import = {
         :importProject => {
           :token => export_token
         }
       }
 
-      result = client.post("/gdc/md/#{new_project.obj_id}/maintenance/import", import)
+      result = client.post("/gdc/md/#{obj_id}/maintenance/import", import)
       status_url = result['uri']
       client.poll_on_response(status_url) do |body|
         body['taskState']['status'] == 'RUNNING'
       end
-
-      new_project
+      self
     end
 
     def compute_report(spec = {})
@@ -298,7 +344,7 @@ module GoodData
 
     # Deletes dashboards for project
     def delete_dashboards
-      Dashboard.all.map { |data| Dashboard[data['link']] }.each { |d| d.delete }
+      Dashboard.all.map { |data| Dashboard[data['link']] }.each(&:delete)
     end
 
     def deploy_process(path, options = {})
@@ -400,10 +446,10 @@ module GoodData
       role_name.downcase!
       role_list.each do |role|
         return role if role.uri == role_name ||
-          role.identifier.downcase == role_name ||
-          role.identifier.downcase.gsub(/role$/, '') == role_name ||
-          role.title.downcase == role_name ||
-          role.summary.downcase == role_name
+                       role.identifier.downcase == role_name ||
+                       role.identifier.downcase.gsub(/role$/, '') == role_name ||
+                       role.title.downcase == role_name ||
+                       role.summary.downcase == role_name
       end
       nil
     end
@@ -419,14 +465,14 @@ module GoodData
       name.downcase!
       user_list.each do |user|
         return user if user.uri.downcase == name ||
-          user.login.downcase == name ||
-          user.email.downcase == name
+                       user.login.downcase == name ||
+                       user.email.downcase == name
       end
       nil
     end
 
     # Exports project users to file
-    def import_users(path, opts = { :header => true }, &block)
+    def import_users(path, opts = { :header => true }, &_block)
       opts[:path] = path
 
       ##########################
@@ -609,7 +655,7 @@ module GoodData
     # @return [GoodData::Fact | Array<GoodData::Fact>] fact instance or list
     def labels(id = :all, opts = {})
       if id == :all
-        attributes.pmapcat { |a| a.labels }.uniq
+        attributes.pmapcat(&:labels).uniq
       else
         GoodData::Label[id, opts.merge(project: self, client: client)]
       end
@@ -700,7 +746,7 @@ module GoodData
       objs = objs.pmap { |obj| objects(obj) }
       export_payload = {
         :partialMDExport => {
-          :uris => objs.map { |obj| obj.uri }
+          :uris => objs.map(&:uri)
         }
       }
       result = client.post("#{md['maintenance']}/partialmdexport", export_payload)
@@ -961,7 +1007,7 @@ module GoodData
       list = list.map do |user|
         {
           :user => user,
-          :roles => new_users_map[user.email].json['user']['content']['role'].split(' ').map { |r| r.downcase }.sort
+          :roles => new_users_map[user.email].json['user']['content']['role'].split(' ').map(&:downcase).sort
         }
       end
 
@@ -976,9 +1022,7 @@ module GoodData
     #
     # @param list List of users to be disabled
     def users_remove(list)
-      list.pmap do |user|
-        user.disable
-      end
+      list.pmap(&:disable)
     end
 
     # Update user
@@ -1022,7 +1066,7 @@ module GoodData
     #
     # @param list List of users to be updated
     # @param role_list Optional list of cached roles to prevent unnecessary server round-trips
-    def set_users_roles(list, role_list = roles)
+    def set_users_roles(list, _role_list = roles)
       list.pmap do |user_hash|
         user = user_hash[:user]
         roles = user_hash[:role] || user_hash[:roles]

data/lib/gooddata/models/project_blueprint.rb

@@ -353,16 +353,15 @@ module GoodData
       def lint(full = false)
         errors = []
         find_star_centers.each do |dataset|
-          if dataset.anchor?
-            errors << {
-              type: :anchor_on_fact_dataset,
-              dataset_name: dataset.name,
-              anchor_name: dataset.anchor[:name]
-            }
-          end
+          next unless dataset.anchor?
+          errors << {
+            type: :anchor_on_fact_dataset,
+            dataset_name: dataset.name,
+            anchor_name: dataset.anchor[:name]
+          }
         end
 
-        date_facts = datasets.mapcat { |d| d.date_facts }
+        date_facts = datasets.mapcat(&:date_facts)
         date_facts.each do |date_fact|
           errors << {
             type: :date_fact,
@@ -414,7 +413,7 @@ module GoodData
         when :stupid
           reports = suggest_metrics.reduce([]) do |a, e|
             star, metrics = e
-            metrics.each { |m| m.save }
+            metrics.each(&:save)
             reports_stubs = metrics.map do |m|
               breaks = can_break(star).map { |ds, aM| ds.identifier_for(aM) }
               # [breaks.sample((breaks.length/10.0).ceil), m]
@@ -443,7 +442,7 @@ module GoodData
       # @return [Array<Hash>]
       def suggest_metrics
         stars = find_star_centers
-        metrics = stars.map { |s| s.suggest_metrics }
+        metrics = stars.map(&:suggest_metrics)
         stars.zip(metrics)
       end
 

data/lib/gooddata/models/project_builder.rb

@@ -15,7 +15,7 @@ module GoodData
           pb
         end
 
-        def create(title, options = {}, &block)
+        def create(title, _options = {}, &block)
           pb = ProjectBuilder.new(title)
           block.call(pb)
           pb
@@ -104,7 +104,7 @@ module GoodData
         eliminate_empty = options[:eliminate_empty] || false
 
         if eliminate_empty
-          JSON.pretty_generate(to_hash.reject { |k, v| v.is_a?(Enumerable) && v.empty? })
+          JSON.pretty_generate(to_hash.reject { |_k, v| v.is_a?(Enumerable) && v.empty? })
         else
           JSON.pretty_generate(to_hash)
         end

data/lib/gooddata/models/project_creator.rb

@@ -66,7 +66,7 @@ module GoodData
           # pp response
           while response.code != 200
             sleep 1
-            client.retryable(:tries => 3, :on => RestClient::InternalServerError) do
+            GoodData::Rest::Client.retryable(:tries => 3, :on => RestClient::InternalServerError) do
               sleep 1
               response = client.get(link, :process => false)
               # pp response
@@ -106,7 +106,7 @@ module GoodData
           end
         end
 
-        def migrate_users(project, spec)
+        def migrate_users(_project, spec)
           spec.each do |user|
             puts "Would migrate user #{user}"
             # project.add_user(user)
@@ -114,7 +114,7 @@ module GoodData
         end
 
         def load(project, spec)
-          if spec.key?(:uploads)
+          if spec.key?(:uploads) # rubocop:disable Style/GuardClause
             spec[:uploads].each do |load|
               schema = GoodData::Model::Schema.new(spec[:datasets].find { |d| d[:name] == load[:dataset] })
               project.upload(load[:source], schema, load[:mode])
@@ -122,7 +122,7 @@ module GoodData
           end
         end
 
-        def execute_tests(project, spec)
+        def execute_tests(_project, spec)
           spec.each do |assert|
             result = GoodData::ReportDefinition.execute(assert[:report])
             fail "Test did not pass. Got #{result.table.inspect}, expected #{assert[:result].inspect}" if result.table != assert[:result]

data/lib/gooddata/models/report_data_result.rb

@@ -48,7 +48,7 @@ module GoodData
       table.transpose
     end
 
-    def [](index, options = {})
+    def [](index, _options = {})
       to_table[index]
     end