gooddata 0.6.20 → 0.6.22

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

@@ -1,4 +1,8 @@
 # encoding: UTF-8
+#
+# Copyright (c) 2010-2015 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 '../metadata'
 
@@ -100,6 +104,8 @@ module GoodData
       end
     end
 
+    alias_method :create_measure, :create_metric
+
     # For an element id find values (titles) for all display forms. Element id can be given as both number id or URI as a string beginning with /
     # @param [Object] element_id Element identifier either Number or a uri as a String
     # @return [Array] list of values for certain element. Returned in the same order as is the order of labels

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

@@ -1,4 +1,12 @@
 # encoding: UTF-8
+#
+# Copyright (c) 2010-2015 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 'dashboard_tab'
+require_relative 'dashboard/filter_item'
+require_relative 'dashboard/report_item'
 
 require_relative '../../core/core'
 require_relative '../metadata'
@@ -23,23 +31,23 @@ module GoodData
         query('projectDashboard', Dashboard, options)
       end
 
-      def create_report_tab(tab)
+      def create_report_tab(tab, options = { :client => GoodData.client, :project => GoodData.project })
         title = tab[:title]
         {
           :title => title,
-          :items => tab[:items].map { |i| GoodData::Dashboard.create_report_tab_item(i) }
+          :items => tab[:items].map { |i| GoodData::Dashboard.create_report_tab_item(i, options) }
         }
       end
 
-      def create_report_tab_item(options = {})
-        title = options[:title]
+      def create_report_tab_item(item, options = { :client => GoodData.client, :project => GoodData.project })
+        title = item[:title]
 
-        report = GoodData::Report.find_first_by_title(title)
+        report = GoodData::Report.find_first_by_title(title, options)
         {
           :reportItem => {
             :obj => report.uri,
-            :sizeY => options[:size_y] || 200,
-            :sizeX => options[:size_x] || 300,
+            :sizeY => item[:size_y] || 200,
+            :sizeX => item[:size_x] || 300,
             :style => {
               :displayTitle => 1,
               :background => {
@@ -54,31 +62,59 @@ module GoodData
                 :labels => {}
               }
             },
-            :positionY => options[:position_y] || 0,
+            :positionY => item[:position_y] || 0,
             :filters => [],
-            :positionX => options[:position_x] || 0
+            :positionX => item[:position_x] || 0
           }
         }
       end
 
-      def create(options = {})
+      def create(dashboard = { :tabs => [] }, options = { :client => GoodData.client, :project => GoodData.project })
+        client = options[:client]
+        fail ArgumentError, 'No :client specified' if client.nil?
+
+        p = options[:project]
+        fail ArgumentError, 'No :project specified' if p.nil?
+
+        project = GoodData::Project[p, options]
+        fail ArgumentError, 'Wrong :project specified' if project.nil?
+
+        tabs = dashboard[:tabs] || []
+
         stuff = {
           'projectDashboard' => {
             'content' => {
-              'tabs' => options[:tabs].map { |t| GoodData::Dashboard.create_report_tab(t) },
+              'tabs' => tabs.map { |t| GoodData::Dashboard.create_report_tab(t, options) },
               'filters' => []
             },
             'meta' => {
-              'tags' => options[:tags],
-              'summary' => options[:summary],
-              'title' => options[:title]
+              'tags' => dashboard[:tags],
+              'summary' => dashboard[:summary],
+              'title' => dashboard[:title]
             }
           }
         }
-        Dashboard.new(stuff)
+
+        client.create(Dashboard, stuff, :project => project)
       end
     end
 
+    def add_tab(tab)
+      title = tab[:title] || 'Default Tab Title'
+      items = tab[:items] || []
+
+      new_tab_json = {
+        :title => title,
+        :items => items.map { |i| GoodData::Dashboard.create_report_tab_item(i, options) }
+      }
+
+      new_tab = GoodData::DashboardTab.new(self, GoodData::Helpers.deep_stringify_keys(new_tab_json))
+      content['tabs'] << new_tab.json
+      new_tab
+    end
+
+    alias_method :create_tab, :add_tab
+
     def exportable?
       true
     end
@@ -94,7 +130,9 @@ module GoodData
     end
 
     def tabs
-      content['tabs']
+      content['tabs'].map do |tab|
+        GoodData::DashboardTab.new(self, tab)
+      end
     end
 
     def tabs_ids

data/lib/gooddata/models/metadata/dashboard/dashboard_item.rb

@@ -0,0 +1,60 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2015 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 DashboardItem
+    include GoodData::Mixin::RootKeyGetter
+    include GoodData::Mixin::DataGetter
+
+    attr_reader :tab
+    attr_accessor :json
+
+    def initialize(tab, json)
+      @tab = tab
+      @json = json
+    end
+
+    def position_x
+      data['positionX']
+    end
+
+    alias_method :pos_x, :position_x
+
+    def position_x=(new_position_x)
+      data['positionX'] = new_position_x
+    end
+
+    alias_method :pos_x=, :position_x=
+
+    def position_y
+      data['positionY']
+    end
+
+    alias_method :pos_y, :position_y
+
+    def position_y=(new_position_y)
+      data['positionY'] = new_position_y
+    end
+
+    alias_method :pos_y=, :position_y=
+
+    def size_x
+      data['sizeX']
+    end
+
+    def size_x=(new_size_x)
+      data['sizeX'] = new_size_x
+    end
+
+    def size_y
+      data['sizeY']
+    end
+
+    def size_y=(new_size_y)
+      data['sizeY'] = new_size_y
+    end
+  end
+end

data/lib/gooddata/models/metadata/dashboard/filter_item.rb

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2015 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 'dashboard_item'
+
+module GoodData
+  class FilterItem < DashboardItem
+    def initialize(tab, json)
+      super
+    end
+  end
+end

data/lib/gooddata/models/metadata/dashboard/report_item.rb

@@ -0,0 +1,51 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2015 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 'dashboard_item'
+
+module GoodData
+  class ReportItem < DashboardItem
+    def initialize(tab, json)
+      super
+    end
+
+    def filters
+      data['filters']
+    end
+
+    def filters=(new_filters)
+      data['filters'] = new_filters
+    end
+
+    def obj
+      GoodData::MdObject[data['obj'], :client => tab.dashboard.client, :project => tab.dashboard.project]
+    end
+
+    alias_method :object, :obj
+
+    def obj=(new_obj)
+      data['obj'] = new_obj.is_a?(String) ? new_obj : new_obj.uri
+    end
+
+    alias_method :object=, :obj=
+
+    def style
+      data['style']
+    end
+
+    def style=(new_style)
+      data['style'] = new_style
+    end
+
+    def visualization
+      data['visualization']
+    end
+
+    def visualization=(new_visualization)
+      data['visualization'] = new_visualization
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2015 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 '../../core/core'
+require_relative '../metadata'
+require_relative 'metadata'
+require_relative 'report'
+
+require 'multi_json'
+
+module GoodData
+  class DashboardTab
+    attr_reader :dashboard
+    attr_accessor :json
+
+    def initialize(dashboard, json)
+      @dashboard = dashboard
+      @json = json
+    end
+
+    def create_report_item(item)
+      report = item[:report]
+
+      new_item_json = {
+        :reportItem => {
+          :obj => report.uri,
+          :sizeY => item[:size_y] || 200,
+          :sizeX => item[:size_x] || 300,
+          :style => {
+            :displayTitle => 1,
+            :background => {
+              :opacity => 0
+            }
+          },
+          :visualization => {
+            :grid => {
+              :columnWidths => []
+            },
+            :oneNumber => {
+              :labels => {}
+            }
+          },
+          :positionY => item[:position_y] || 0,
+          :filters => [],
+          :positionX => item[:position_x] || 0
+        }
+      }
+
+      new_item = GoodData::DashboardItem.new(self, GoodData::Helpers.deep_stringify_keys(new_item_json))
+      json['items'] << new_item.json
+      new_item
+    end
+    alias_method :add_report_item, :create_report_item
+
+    def identifier
+      @json['identifier']
+    end
+
+    def identifier=(new_identifier)
+      @json['identifier'] = new_identifier
+    end
+
+    def items
+      @json['items'].map do |item|
+        type = item.keys.first
+        case type
+        when 'reportItem'
+          GoodData::ReportItem.new(self, item)
+        when 'filterItem'
+          GoodData::FilterItem.new(self, item)
+        else
+          GoodData::DashboardItem.new(self, item)
+        end
+      end
+    end
+
+    def title
+      @json['title']
+    end
+
+    def title=(new_title)
+      @json['title'] = new_title
+    end
+  end
+end

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

@@ -1,4 +1,8 @@
 # encoding: UTF-8
+#
+# Copyright (c) 2010-2015 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 '../metadata'
 

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

@@ -1,4 +1,8 @@
 # encoding: UTF-8
+#
+# Copyright (c) 2010-2015 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 '../metadata'
 require_relative '../../mixins/is_dimension'

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

@@ -1,4 +1,8 @@
 # encoding: UTF-8
+#
+# Copyright (c) 2010-2015 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 '../metadata'
 require_relative '../../core/rest'
@@ -36,5 +40,7 @@ module GoodData
       a_title = options[:title] || "#{a_type} of #{title}"
       project.create_metric("SELECT #{a_type.to_s.upcase}([#{uri}])", title: a_title, extended_notation: false)
     end
+
+    alias_method :create_measure, :create_metric
   end
 end

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

@@ -1,4 +1,8 @@
 # encoding: UTF-8
+#
+# Copyright (c) 2010-2015 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 '../metadata'
 require_relative '../../mixins/is_label'
@@ -60,6 +64,17 @@ module GoodData
         page_limit = options[:limit] || 100
         loop do
           results = client.post("#{uri}/validElements?limit=#{page_limit}&offset=#{offset}&order=asc", {})
+
+          # Implementation of polling is based on
+          # https://opengrok.intgdc.com/source/xref/gdc-backend/src/test/java/com/gooddata/service/dao/ValidElementsDaoTest.java
+          status_url = results['uri']
+          if status_url
+            results = client.poll_on_response(status_url) do |body|
+              status = body['taskState']['status']
+              status == 'RUNNING' || status == 'PREPARED'
+            end
+          end
+
           elements = results['validElements']
           elements['items'].map do |el|
             v = el['element']

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

@@ -1,4 +1,8 @@
 # encoding: UTF-8
+#
+# Copyright (c) 2010-2015 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 'pathname'
 

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

@@ -1,4 +1,8 @@
 # encoding: UTF-8
+#
+# Copyright (c) 2010-2015 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 '../../goodzilla/goodzilla'
 require_relative '../../mixins/mixins'
@@ -8,8 +12,6 @@ require_relative 'metadata'
 module GoodData
   # Metric representation
   class Metric < MdObject
-    attr_reader :json
-
     include GoodData::Mixin::Lockable
 
     alias_method :to_hash, :json
@@ -135,9 +137,8 @@ module GoodData
         :client => client,
         :project => project
       }
-
       res = GoodData::ReportDefinition.execute(opts.merge(:left => self))
-      res && res[0][0]
+      res.data[0][0] if res && !res.empty?
     end
 
     def expression