gooddata 0.6.4 → 0.6.5

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

@@ -148,11 +148,11 @@ module GoodData
         data_result_uri = result['execResult']['dataResult']
         result = GoodData.get data_result_uri
 
-        while result['taskState'] && result['taskState']['status'] == 'WAIT'
+        while result && result['taskState'] && result['taskState']['status'] == 'WAIT'
           sleep 10
           result = GoodData.get data_result_uri
         end
-
+        return nil unless result
         ReportDataResult.new(GoodData.get data_result_uri)
       end
 

data/lib/gooddata/models/model.rb

@@ -3,16 +3,10 @@
 require_relative '../core/connection'
 require_relative '../core/rest'
 
-require_relative 'attributes/attributes'
-require_relative 'columns/columns'
-require_relative 'facts/facts'
-require_relative 'folders/folders'
 require_relative 'metadata/metadata'
-require_relative 'references/references'
 
 require_relative 'links'
 require_relative 'module_constants'
-require_relative 'metadata/schema'
 
 require 'fileutils'
 require 'multi_json'
@@ -25,27 +19,65 @@ require 'zip'
 #
 module GoodData
   module Model
+    GD_TYPES = %w(GDC.link GDC.text GDC.geo GDC.time)
+    GD_DATA_TYPES = %w(INT VARCHAR DECIMAL)
+
+    DEFAULT_FACT_DATATYPE = 'INT'
+
     class << self
-      # def add_dataset(name, columns, project = nil)
-      #   Schema.new('columns' => columns, 'name' => name)
-      #   add_schema(schema, project)
-      # end
-
-      # def add_schema(schema, project = nil)
-      #   unless schema.respond_to?(:to_maql_create) || schema.is_a?(String)
-      #     fail(ArgumentError, "Schema object or schema file path expected, got '#{schema}'")
-      #   end
-      #   schema = Schema.load(schema) unless schema.respond_to?(:to_maql_create)
-      #   project = GoodData.project unless project
-      #   ldm_links = GoodData.get project.md[LDM_CTG]
-      #   ldm_uri = Links.new(ldm_links)[LDM_MANAGE_CTG]
-      #   GoodData.post ldm_uri, 'manage' => { 'maql' => schema.to_maql_create }
-      # end
+      def title(item)
+        item[:title] || item[:name].titleize
+      end
+
+      def identifier_for(dataset, column = nil, column2 = nil)
+        return "dataset.#{dataset[:name]}" if column.nil?
+        column = DatasetBlueprint.find_column_by_name(dataset, column) if column.is_a?(String)
+        case column[:type].to_sym
+        when :anchor_no_label
+          "attr.#{dataset[:name]}.factsof"
+        when :attribute
+          "attr.#{dataset[:name]}.#{column[:name]}"
+        when :anchor
+          "attr.#{dataset[:name]}.#{column[:name]}"
+        when :date_fact
+          "dt.#{dataset[:name]}.#{column[:name]}"
+        when :fact
+          "fact.#{dataset[:name]}.#{column[:name]}"
+        when :primary_label
+          "label.#{dataset[:name]}.#{column[:name]}"
+        when :label
+          "label.#{dataset[:name]}.#{column2[:name]}.#{column[:name]}"
+        when :date_ref
+          "#{dataset[:name]}.date.mdyy"
+        when :dataset
+          "dataset.#{dataset[:name]}"
+        else
+          fail "Unknown type #{column[:type].to_sym}"
+        end
+      end
+
+      def check_gd_datatype(value)
+        GD_TYPES.any? { |v| v == value }
+      end
 
       # Load given file into a data set described by the given schema
-      def upload_data(path, manifest, options = {})
+      def upload_data(path, project_blueprint, dataset, options = {})
+        # path = if path =~ URI.regexp
+        #   Tempfile.open('remote_file') do |temp|
+        #     temp << open(path).read
+        #     temp.flush
+        #     # GoodData::Model.upload_data(path, to_manifest(mode))
+        #   end
+        #
+        # else
+        #   # GoodData::Model.upload_data(path, to_manifest(mode))
+        #   # upload_data(path, mode)
+        # end
+
+        mode = options[:mode] || 'FULL'
+        manifest = GoodData::Model::ToManifest.dataset_to_manifest(project_blueprint, dataset, mode)
         project = options[:project] || GoodData.project
-        # mode = options[:mode] || "FULL"
+
         path = path.path if path.respond_to? :path
         inline_data = path.is_a?(String) ? false : true
 

data/lib/gooddata/models/models.rb

@@ -2,8 +2,6 @@
 
 require 'pathname'
 
-require_relative 'attributes/attributes'
-
 base = Pathname(__FILE__).dirname.expand_path
 Dir.glob(base + '*.rb').each do |file|
   require_relative file

data/lib/gooddata/models/module_constants.rb

@@ -23,7 +23,5 @@ module GoodData
     TIME_FACT_PREFIX = 'tm.dt'
     TIME_ATTRIBUTE_PREFIX = 'attr.time'
     FACT_FOLDER_PREFIX = 'ffld'
-
-    SKIP_FIELD = false
   end
 end

data/lib/gooddata/models/process.rb

@@ -125,7 +125,7 @@ module GoodData
     end
 
     def process
-      raw_data['process']
+      json['process']
     end
 
     def name

data/lib/gooddata/models/project.rb

@@ -6,6 +6,9 @@ require 'fileutils'
 
 require_relative 'process'
 require_relative '../exceptions/no_project_error'
+
+require_relative '../mixins/mixins'
+
 require_relative 'project_role'
 
 module GoodData
@@ -18,7 +21,19 @@ module GoodData
 
     attr_accessor :connection, :json
 
+    alias_method :to_json, :json
+    alias_method :raw_data, :json
+
+    include GoodData::Mixin::MetaGetter
+    include GoodData::Mixin::DataGetter
+
     class << self
+      include GoodData::Mixin::RootKeySetter
+
+      include GoodData::Mixin::MetaPropertyReader
+
+      include GoodData::Mixin::MetaPropertyWriter
+
       # Returns an array of all projects accessible by
       # current user
       def all
@@ -47,6 +62,14 @@ module GoodData
         end
       end
 
+      Project.root_key :project
+
+      include GoodData::Mixin::RootKeyGetter
+      include GoodData::Mixin::DataGetter
+      include GoodData::Mixin::Author
+      include GoodData::Mixin::Contributor
+      include GoodData::Mixin::Timestamps
+
       # Create a project from a given attributes
       # Expected keys:
       # - :title (mandatory)
@@ -77,7 +100,6 @@ module GoodData
         json['project']['meta']['projectTemplate'] = attributes[:template] if attributes[:template] && !attributes[:template].empty?
         project = Project.new json
         project.save
-
         # until it is enabled or deleted, recur. This should still end if there is a exception thrown out from RESTClient. This sometimes happens from WebApp when request is too long
         while project.state.to_s != 'enabled'
           if project.state.to_s == 'deleted'
@@ -115,26 +137,6 @@ module GoodData
       end
     end
 
-    # Creates a data set within the project
-    #
-    # == Usage
-    # p.add_dataset 'Test', [ { 'name' => 'a1', 'type' => 'ATTRIBUTE' ... } ... ]
-    # p.add_dataset 'title' => 'Test', 'columns' => [ { 'name' => 'a1', 'type' => 'ATTRIBUTE' ... } ... ]
-    #
-    def add_dataset(schema_def, columns = nil, &block)
-      schema = if block
-                 builder = block.call(Model::SchemaBuilder.new(schema_def))
-                 builder.to_schema
-               else
-                 sch = { :title => schema_def, :columns => columns } if columns
-                 sch = Model::Schema.new schema_def if schema_def.is_a? Hash
-                 sch = schema_def if schema_def.is_a?(Model::Schema)
-                 fail(ArgumentError, 'Required either schema object or title plus columns array') unless schema_def.is_a? Model::Schema
-                 sch
-               end
-      Model.add_schema(schema, self)
-    end
-
     def add_metric(options = {})
       options[:expression] || fail('Metric has to have its expression defined')
       m1 = GoodData::Metric.create(options)
@@ -146,12 +148,20 @@ module GoodData
       rep.save
     end
 
-    # Gets author of project
+    # Returns an indication whether current user is admin in this project
     #
-    # @return [String] Project author
-    def author
-      # TODO: Return object instead
-      @json['project']['meta']['author']
+    # @return [Boolean] True if user has admin role in the project, false otherwise.
+    def am_i_admin?
+      user_has_role?(GoodData.user, 'admin')
+    end
+
+    # Gets project blueprint from the server
+    #
+    # @return [GoodData::ProjectRole] Project role if found
+    def blueprint
+      result = GoodData.get("/gdc/projects/#{pid}/model/view")
+      model = GoodData.poll_on_root(result, 'asyncTask') { |r| r['asyncTask']['link']['poll'] }
+      GoodData::Model::FromWire.from_wire(model)
     end
 
     # Returns web interface URI of project
@@ -173,10 +183,10 @@ module GoodData
       # TODO: Refactor so if export or import fails the new_project will be cleaned
       with_data = options[:data] || true
       with_users = options[:users] || false
-      title = options[:title] || "Clone of #{title}"
+      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 => title))
+      new_project = GoodData::Project.create(options.merge(:title => a_title))
 
       export = {
         :exportProject => {
@@ -213,28 +223,8 @@ module GoodData
       new_project
     end
 
-    # Project contributor
-    #
-    # @return [String] Project contributor
-    # TODO: Return as object
-    def contributor
-      # TODO: Return object instead
-      @json['project']['meta']['contributor']
-    end
-
-    # Gets the date when created
-    #
-    # @return [DateTime] Date time when created
-    def created
-      DateTime.parse(@json['project']['meta']['created'])
-    end
-
-    # Gets ruby wrapped raw project JSON data
-    def data
-      raw_data['project']
-    end
-
     def datasets
+      blueprint.datasets
       datasets_uri = "#{md['data']}/sets"
       response = GoodData.get datasets_uri
       response['dataSetsInfo']['sets'].map do |ds|
@@ -260,6 +250,24 @@ module GoodData
       Dashboard.all.map { |data| Dashboard[data['link']] }.each { |d| d.delete }
     end
 
+    # Executes DML expression. See (https://developer.gooddata.com/article/deleting-records-from-datasets)
+    # for some examples and explanations
+    #
+    # @param dml [String] DML expression
+    def execute_dml(dml)
+      uri = "/gdc/md/#{pid}/dml/manage"
+      result = GoodData.post(uri,
+                             manage: {
+                               maql: dml
+                             })
+      polling_uri = result['uri']
+      result = GoodData.get(polling_uri)
+      while result['taskState'] && result['taskState']['status'] == 'WAIT'
+        sleep 10
+        result = GoodData.get polling_uri
+      end
+    end
+
     # Gets project role by its identifier
     #
     # @param [String] role_name Title of role to look for
@@ -320,6 +328,7 @@ module GoodData
     # @return [GoodDta::Membership] User
     def get_user(name, user_list = users)
       return name if name.instance_of?(GoodData::Membership)
+      return member(name) if name.instance_of?(GoodData::Profile)
       name.downcase!
       user_list.each do |user|
         return user if user.uri.downcase == name ||
@@ -329,6 +338,19 @@ module GoodData
       nil
     end
 
+    # Checks whether user has particular role in given proejct
+    #
+    # @param user [GoodData::Profile | GoodData::Membership | String] User in question. Can be passed by login (String), profile or membershi objects
+    # @param role_name [String || GoodData::ProjectRole] Project role cna be given by either string or GoodData::ProjectRole object
+    # @return [Boolean] Tru if user has role_name
+    def user_has_role?(user, role_name)
+      member = get_user(user)
+      role = get_role(role_name)
+      member.roles.include?(role)
+    rescue
+      false
+    end
+
     # Initializes object instance from raw wire JSON
     #
     # @param json Json used for initialization
@@ -395,6 +417,10 @@ module GoodData
       data['links']
     end
 
+    def lint
+      blueprint.lint
+    end
+
     def md
       @md ||= Links.new GoodData.get(data['links']['metadata'])
     end
@@ -478,6 +504,28 @@ module GoodData
       true
     end
 
+    def info
+      results = blueprint.datasets.map do |ds|
+        [ds, ds.count]
+      end
+      puts title
+      puts GoodData::Helpers.underline(title)
+      puts
+      puts "Datasets - #{results.count}"
+      puts
+      results.each do |x|
+        dataset, count = x
+        dataset.title.tap do |t|
+          puts t
+          puts GoodData::Helpers.underline(t)
+          puts "Size - #{count} rows"
+          puts "#{dataset.attributes_and_anchors.count} attributes, #{dataset.facts.count} facts, #{dataset.references.count} references"
+          puts
+        end
+      end
+      nil
+    end
+
     # Forces project to reload
     def reload!
       if saved?
@@ -501,11 +549,19 @@ module GoodData
 
     # Saves project
     def save
-      response = GoodData.post PROJECTS_PATH, raw_data
-      if uri.nil?
-        response = GoodData.get response['uri']
-        @json = response
-      end
+      data_to_send = raw_data.deep_dup
+      data_to_send['project']['content'].delete('cluster')
+      data_to_send['project']['content'].delete('isPublic')
+      data_to_send['project']['content'].delete('state')
+      response = if uri
+                   GoodData.post(PROJECT_PATH % pid, data_to_send)
+                   GoodData.get uri
+                 else
+                   result = GoodData.post(PROJECTS_PATH, data_to_send)
+                   GoodData.get result['uri']
+                 end
+      @json = response
+      self
     end
 
     # Checks if is project saved
@@ -534,7 +590,7 @@ module GoodData
     def slis
       link = "#{data['links']['metadata']}#{SLIS_PATH}"
 
-      # TODO: Review what to do with passed extra argument
+      # FIXME: Review what to do with passed extra argument
       Metadata.new GoodData.get(link)
     end
 
@@ -545,33 +601,21 @@ module GoodData
       data['content']['state'].downcase.to_sym if data['content'] && data['content']['state']
     end
 
-    # Gets project summary
-    #
-    # @return [String] Project summary
-    def summary
-      data['meta']['summary'] if data['meta']
-    end
+    Project.metadata_property_reader :summary, :title
 
     # Gets project title
     #
     # @return [String] Project title
-    def title
-      data['meta']['title'] if data['meta']
-    end
-
-    # Gets project update date
-    #
-    # @return [DateTime] Date time of last update
-    def updated
-      DateTime.parse(@json['project']['meta']['updated'])
+    def title=(a_title)
+      data['meta']['title'] = a_title if data['meta']
     end
 
     # Uploads file to project
     #
     # @param file File to be uploaded
     # @param schema Schema to be used
-    def upload(file, schema, mode = 'FULL')
-      schema.upload file, self, mode
+    def upload(file, dataset_blueprint, mode = 'FULL')
+      dataset_blueprint.upload file, self, mode
     end
 
     def uri
@@ -744,7 +788,7 @@ module GoodData
     # metric_filter - Checks metadata for inconsistent metric filters.
     # invalid_objects - Checks metadata for invalid/corrupted objects.
     # asyncTask response
-    def validate(filters = %w(ldm, pdm, metric_filter, invalid_objects))
+    def validate(filters = %w(ldm pdm metric_filter invalid_objects))
       response = GoodData.post "#{GoodData.project.md['validate-project']}", 'validateProject' => filters
       polling_link = response['asyncTask']['link']['poll']
       polling_result = GoodData.get(polling_link)
@@ -754,8 +798,5 @@ module GoodData
       end
       polling_result
     end
-
-    alias_method :to_json, :json
-    alias_method :raw_data, :json
   end
 end