gooddata-edge 0.6.27.edge

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

@@ -0,0 +1,56 @@
+# 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 HeadlineItem < DashboardItem
+    EMPTY_OBJECT = {
+      'headlineItem' => {
+        'positionX' => 0,
+        'sizeY' => 200,
+        'sizeX' => 300,
+        'positionY' => 0
+      }
+    }
+
+    ASSIGNABLE_MEMBERS = DashboardItem::ASSIGNABLE_MEMBERS + [
+      :id,
+      :metric,
+      :linked_with_external_filter
+    ]
+
+    class << self
+      def create(tab, item)
+        res = GoodData::HeadlineItem.new(tab, GoodData::Helpers.deep_dup(GoodData::Helpers.deep_stringify_keys(EMPTY_OBJECT)))
+        item.each do |k, v|
+          res.send("#{k}=", v) if ASSIGNABLE_MEMBERS.include? k
+        end
+        res
+      end
+    end
+
+    def initialize(tab, json)
+      super
+    end
+
+    def metric
+      data['metric']
+    end
+
+    def metric=(new_metric)
+      data['metric'] = new_metric.respond_to?(:uri) ? new_metric.uri : new_metric
+    end
+
+    def linked_with_external_filter
+      data['linkedWithExternalFilter']
+    end
+
+    def linked_with_external_filter=(new_linked_with_external_filter)
+      data['linked_with_external_filter'] = new_linked_with_external_filter ? 1 : 0
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# 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 IframeItem < DashboardItem
+    EMPTY_OBJECT = {
+      'textItem' => {
+        'positionX' => 0,
+        'sizeY' => 200,
+        'sizeX' => 300,
+        'positionY' => 0
+      }
+    }
+
+    ASSIGNABLE_MEMBERS = DashboardItem::ASSIGNABLE_MEMBERS + [
+      :url
+    ]
+
+    class << self
+      def create(tab, item)
+        res = GoodData::IframeItem.new(tab, GoodData::Helpers.deep_dup(GoodData::Helpers.deep_stringify_keys(EMPTY_OBJECT)))
+        item.each do |k, v|
+          res.send("#{k}=", v) if ASSIGNABLE_MEMBERS.include? k
+        end
+        res
+      end
+    end
+
+    def initialize(tab, json)
+      super
+    end
+
+    def url
+      data['url']
+    end
+
+    def url=(new_url)
+      data['url'] = new_url
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+# 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'
+require_relative '../../../helpers/global_helpers'
+
+module GoodData
+  class ReportItem < DashboardItem
+    EMPTY_OBJECT = {
+      :reportItem => {
+        :obj => nil,
+        :sizeY => 200,
+        :sizeX => 300,
+        :style => {
+          :displayTitle => 1,
+          :background => {
+            :opacity => 0
+          }
+        },
+        :visualization => {
+          :grid => {
+            :columnWidths => []
+          },
+          :oneNumber => {
+            :labels => {}
+          }
+        },
+        :positionY => 0,
+        :filters => [],
+        :positionX => 0
+      }
+    }
+
+    ASSIGNABLE_MEMBERS = DashboardItem::ASSIGNABLE_MEMBERS + [
+      :filters,
+      :obj,
+      :report,
+      :style,
+      :visualization
+    ]
+
+    class << self
+      def obj_uri(obj)
+        obj.respond_to?(:uri) ? obj.uri : obj
+      end
+
+      def create(tab, item)
+        res = GoodData::ReportItem.new(tab, GoodData::Helpers.deep_dup(GoodData::Helpers.deep_stringify_keys(EMPTY_OBJECT)))
+        item.each do |k, v|
+          res.send("#{k}=", v) if ASSIGNABLE_MEMBERS.include? k
+        end
+        res
+      end
+    end
+
+    def initialize(tab, json)
+      super
+    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'] = ReportItem.obj_uri(new_obj)
+    end
+
+    alias_method :object=, :obj=
+    alias_method :report=, :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/text_item.rb

@@ -0,0 +1,55 @@
+# 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 TextItem < DashboardItem
+    EMPTY_OBJECT = {
+      'textItem' => {
+        'positionX' => 0,
+        'sizeY' => 200,
+        'sizeX' => 300,
+        'positionY' => 0
+      }
+    }
+
+    ASSIGNABLE_MEMBERS = DashboardItem::ASSIGNABLE_MEMBERS + [
+      :text,
+      :text_size
+    ]
+
+    class << self
+      def create(tab, item)
+        res = GoodData::TextItem.new(tab, GoodData::Helpers.deep_dup(GoodData::Helpers.deep_stringify_keys(EMPTY_OBJECT)))
+        item.each do |k, v|
+          res.send("#{k}=", v) if ASSIGNABLE_MEMBERS.include? k
+        end
+        res
+      end
+    end
+
+    def initialize(tab, json)
+      super
+    end
+
+    def text
+      data['text']
+    end
+
+    def text=(new_text)
+      data['text'] = new_text
+    end
+
+    def text_size
+      data['textSize']
+    end
+
+    def text_size=(new_text_size)
+      data['textSize'] = new_text_size
+    end
+  end
+end

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

@@ -0,0 +1,141 @@
+# 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 '../../helpers/global_helpers'
+require_relative '../metadata'
+require_relative 'metadata'
+require_relative 'report'
+
+require 'multi_json'
+
+require_relative 'dashboard/filter_item'
+require_relative 'dashboard/filter_apply_item'
+require_relative 'dashboard/geo_chart_item'
+require_relative 'dashboard/headline_item'
+require_relative 'dashboard/iframe_item'
+require_relative 'dashboard/report_item'
+require_relative 'dashboard/text_item'
+
+module GoodData
+  class DashboardTab
+    attr_reader :dashboard
+    attr_accessor :json
+
+    EMPTY_OBJECT = {
+      :title => '',
+      :items => []
+    }
+
+    ASSIGNABLE_MEMBERS = [
+      :title,
+      :items,
+      :identifier
+    ]
+
+    class << self
+      def create(dashboard, tab)
+        res = GoodData::DashboardTab.new(dashboard, GoodData::Helpers.deep_dup(GoodData::Helpers.deep_stringify_keys(EMPTY_OBJECT)))
+        tab.each do |k, v|
+          res.send("#{k}=", v) if ASSIGNABLE_MEMBERS.include? k
+        end
+        res
+      end
+    end
+
+    def initialize(dashboard, json)
+      @dashboard = dashboard
+      @json = json
+    end
+
+    def create_filter_item(item)
+      new_item = GoodData::FilterItem.create(self, item)
+      json['items'] << new_item.json
+      new_item
+    end
+
+    def create_filter_apply_item(item)
+      new_item = GoodData::FilterApplyItem.create(self, item)
+      json['items'] << new_item.json
+      new_item
+    end
+
+    def create_geo_chart_item(item)
+      new_item = GoodData::GeoChartItem.create(self, item)
+      json['items'] << new_item.json
+      new_item
+    end
+    alias_method :add_geo_chart_item, :create_geo_chart_item
+
+    def create_headline_item(item)
+      new_item = GoodData::HeadlineItem.create(self, item)
+      json['items'] << new_item.json
+      new_item
+    end
+    alias_method :add_headline_item, :create_headline_item
+
+    def create_iframe_item(item)
+      new_item = GoodData::IframeItem.create(self, item)
+      json['items'] << new_item.json
+      new_item
+    end
+    alias_method :add_iframe_item, :create_iframe_item
+
+    def create_report_item(item)
+      new_item = GoodData::ReportItem.create(self, item)
+      json['items'] << new_item.json
+      new_item
+    end
+    alias_method :add_report_item, :create_report_item
+
+    def create_text_item(item)
+      new_item = GoodData::TextItem.create(self, item)
+      json['items'] << new_item.json
+      new_item
+    end
+    alias_method :add_text_item, :create_text_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 'filterItem'
+          GoodData::FilterItem.new(self, item)
+        when 'filterApplyItem'
+          GoodData::FilterApplyItem.new(self, item)
+        when 'geoChartItem'
+          GoodData::GeoChartItem.new(self, item)
+        when 'headlineItem'
+          GoodData::HeadlineItem.new(self, item)
+        when 'iframeItem'
+          GoodData::IframeItem.new(self, item)
+        when 'reportItem'
+          GoodData::ReportItem.new(self, item)
+        when 'textItem'
+          GoodData::TextItem.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

@@ -0,0 +1,64 @@
+# 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'
+
+module GoodData
+  class Dataset < MdObject
+    class << self
+      # Method intended to get all objects of that type in a specified project
+      #
+      # @param options [Hash] the options hash
+      # @option options [Boolean] :full if passed true the subclass can decide to pull in full objects. This is desirable from the usability POV but unfortunately has negative impact on performance so it is not the default
+      # @return [Array<GoodData::MdObject> | Array<Hash>] Return the appropriate metadata objects or their representation
+      def all(options = { :client => GoodData.connection, :project => GoodData.project })
+        query('dataSet', Dataset, options)
+      end
+    end
+
+    # Gives you list of attributes on a dataset
+    #
+    # @return [Array<GoodData::Attribute>]
+    def attributes
+      attribute_uris.pmap { |a_uri| project.attributes(a_uri) }
+    end
+
+    # Gives you list of attribute uris on a dataset
+    #
+    # @return [Array<String>]
+    def attribute_uris
+      content['attributes']
+    end
+
+    # Gives you list of facts on a dataset
+    #
+    # @return [Array<GoodData::Fact>]
+    def facts
+      fact_uris.pmap { |a_uri| project.facts(a_uri) }
+    end
+
+    # Gives you list of fact uris on a dataset
+    #
+    # @return [Array<String>]
+    def fact_uris
+      content['facts']
+    end
+
+    # Tells you if a dataset is a date dimension. This is done by looking at
+    # the attributes and inspecting their identifiers.
+    #
+    # @return [Boolean]
+    def date_dimension?
+      attributes.all?(&:date_attribute?) && fact_uris.empty?
+    end
+
+    # Delete the data in a dataset
+    def synchronize
+      project.execute_maql("SYNCHRONIZE {#{identifier}}")
+    end
+    alias_method :delete_data, :synchronize
+  end
+end