gooddata-edge 0.6.27.edge

data/lib/gooddata/models/execution.rb

@@ -0,0 +1,115 @@
+# 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 '../rest/resource'
+require_relative '../extensions/hash'
+
+module GoodData
+  class Execution < Rest::Resource
+    attr_reader :dirty, :json
+
+    alias_method :data, :json
+
+    # Initializes object instance from raw wire JSON
+    #
+    # @param json Json used for initialization
+    def initialize(json)
+      super
+      @json = json
+    end
+
+    # Timestamp when execution was created
+    def created
+      Time.parse(json['execution']['createdTime'])
+    end
+
+    # Data for execution
+    def data
+      @client.get(json['execution']['data'])
+    end
+
+    # Has execution failed?
+    def error?
+      status == :error
+    end
+
+    # Timestamp when execution was finished
+    def finished
+      json['execution']['endTime'] && Time.parse(json['execution']['endTime'])
+    end
+
+    # Log for execution
+    def log
+      @client.get(json['execution']['log'])
+    end
+
+    # Is execution ok?
+    def ok?
+      status == :ok
+    end
+
+    # Returns schedule URL
+    #
+    # @return [String] Schedule URL
+    def schedule_uri
+      uri = @json['execution']['links']['self'] if @json && @json['execution'] && @json['execution']['links']
+      uri.split('/')[0..-3].join('/')
+    end
+
+    # Is execution running?
+    def running?
+      status == :running
+    end
+
+    # Returns schedule
+    #
+    # @return [String] Schedule URL
+    def schedule
+      schedule_uri && project.schedules(schedule_uri)
+    end
+
+    # Timestamp when execution was started
+    def started
+      Time.parse(json['execution']['startTime'])
+    end
+
+    # Status of execution
+    def status
+      json['execution']['status'].downcase.to_sym
+    end
+
+    # Returns URL
+    #
+    # @return [String] Schedule URL
+    def uri
+      @json['execution']['links']['self'] if @json && @json['execution'] && @json['execution']['links']
+    end
+
+    # Wait for execution result, status different than RUNNING or SCHEDULED
+    #
+    # @return [GoodData::Execution] Execution result
+    def wait_for_result(options = {})
+      res = client.poll_on_response(uri, options) do |body|
+        body['execution'] && (body['execution']['status'] == 'RUNNING' || body['execution']['status'] == 'SCHEDULED')
+      end
+      @json = res
+      self
+    end
+
+    def duration
+      if running?
+        Time.now - started
+      else
+        finished && finished - started
+      end
+    end
+
+    # Compares two executions - based on their URI
+    def ==(other)
+      other.respond_to?(:uri) && other.uri == uri && other.respond_to?(:to_hash) && other.to_hash == to_hash
+    end
+  end
+end

data/lib/gooddata/models/execution_detail.rb

@@ -0,0 +1,81 @@
+# 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 '../rest/resource'
+require_relative '../extensions/hash'
+
+module GoodData
+  class ExecutionDetail < Rest::Resource
+    attr_reader :dirty, :json
+
+    alias_method :data, :json
+
+    # Initializes object instance from raw wire JSON
+    #
+    # @param json Json used for initialization
+    def initialize(json)
+      super
+      @json = json
+    end
+
+    # Timestamp when execution was created
+    def created
+      Time.parse(json['executionDetail']['created'])
+    end
+
+    # Has execution failed?
+    def error?
+      status == :error
+    end
+
+    # Timestamp when execution was finished
+    def finished
+      Time.parse(json['executionDetail']['finished'])
+    end
+
+    # Log for execution
+    def log
+      @client.get(json['executionDetail']['links']['log'])
+    end
+
+    # Filename of log
+    def log_filename
+      @client.get(json['executionDetail']['logFileName'])
+    end
+
+    # Is execution ok?
+    def ok?
+      status == :ok
+    end
+
+    # Timestamp when execution was started
+    def started
+      Time.parse(json['executionDetail']['started'])
+    end
+
+    # Status of execution
+    def status
+      json['executionDetail']['status'].downcase.to_sym
+    end
+
+    # Timestamp when execution was updated
+    def updated
+      Time.parse(json['executionDetail']['updated'])
+    end
+
+    # Returns URL
+    #
+    # @return [String] Schedule URL
+    def uri
+      @json['executionDetail']['links']['self'] if @json && @json['executionDetail'] && @json['executionDetail']['links']
+    end
+
+    # Compares two executions - based on their URI
+    def ==(other)
+      other.respond_to?(:uri) && other.uri == uri && other.respond_to?(:to_hash) && other.to_hash == to_hash
+    end
+  end
+end

data/lib/gooddata/models/from_wire.rb

@@ -0,0 +1,160 @@
+# 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
+  module Model
+    module FromWire
+      # Converts dataset from wire format into an internal blueprint representation
+      #
+      # @param dataset [Hash] Whatever comes from wire
+      # @return [Hash] Manifest for a particular reference
+      def self.dataset_from_wire(dataset)
+        {}.tap do |d|
+          id = dataset['dataset']['identifier']
+
+          d[:type] = :dataset
+          d[:title] = dataset['dataset']['title']
+          d[:id] = id
+          d[:columns] = (parse_anchor(dataset) + parse_attributes(dataset) + parse_facts(dataset) + parse_references(dataset))
+        end
+      end
+
+      # Entry method for converting information about project mode from wire
+      # format into an internal blueprint representation
+      #
+      # @param wire_model [Hash] Whatever comes from wire
+      # @return [GoodData::Model::ProjectBlueprint] Manifest for a particular reference
+      def self.from_wire(wire_model)
+        model = wire_model['projectModelView']['model']['projectModel']
+        datasets = model['datasets'] || []
+        dims = model['dateDimensions'] || []
+
+        ProjectBlueprint.new(
+          datasets: datasets.map { |ds| dataset_from_wire(ds) },
+          date_dimensions: dims.map { |dd| parse_date_dimensions(dd) }
+        )
+      end
+
+      # Converts attrbutes from wire format into an internal blueprint representation
+      #
+      # @param stuff [Hash] Whatever comes from wire
+      # @return [Hash] Manifest for a particular reference
+      def self.parse_attributes(stuff)
+        dataset = stuff['dataset']
+        attributes = dataset['attributes'] || []
+        attributes.mapcat do |a|
+          parse_attribute(a['attribute'])
+        end
+      end
+
+      # Converts anchor from wire format into an internal blueprint representation
+      #
+      # @param stuff [Hash] Whatever comes from wire
+      # @return [Hash] Manifest for a particular reference
+      def self.parse_anchor(stuff)
+        anchor = stuff['dataset']['anchor']['attribute']
+        parse_attribute(anchor, :anchor)
+      end
+
+      def self.parse_attribute(attribute, type = :attribute)
+        labels = attribute['labels'] || []
+        default_label_id = attribute['defaultLabel']
+        default_label = labels.find { |l| l['label']['identifier'] == default_label_id } || labels.first
+        regular_labels = labels - [default_label]
+        pl = default_label.nil? ? [] : [parse_label(attribute, default_label, :default_label)]
+        rl = regular_labels.map do |label|
+          parse_label(attribute, label, :label)
+        end
+        attribute = {}.tap do |a|
+          a[:type] = type
+          a[:id] = attribute['identifier']
+          a[:title] = attribute['title']
+          a[:description] = attribute['description']
+          a[:folder] = attribute['folder']
+          if attribute['grain']
+            a[:grain] = attribute['grain'].map do |g|
+              case g.keys.first.to_sym
+              when :dateDimension
+                { date: g.values.first }
+              else
+                Helpers.symbolize_keys(g)
+              end
+            end
+          end
+        end
+        [attribute] + pl + rl
+      end
+
+      # Converts date dimensions from wire format into an internal blueprint representation
+      #
+      # @param stuff [Hash] Whatever comes from wire
+      # @return [Hash] Manifest for a particular reference
+      def self.parse_date_dimensions(date_dim)
+        {}.tap do |d|
+          d[:type] = :date_dimension
+          d[:id] = date_dim['dateDimension']['name']
+          d[:title] = date_dim['dateDimension']['title']
+        end
+      end
+
+      # Converts facts from wire format into an internal blueprint representation
+      #
+      # @param stuff [Hash] Whatever comes from wire
+      # @return [Hash] Manifest for a particular reference
+      def self.parse_facts(stuff)
+        facts = stuff['dataset']['facts'] || []
+        facts.map do |fact|
+          {}.tap do |f|
+            f[:type] = fact['fact']['identifier'] =~ /^dt\./ ? :date_fact : :fact
+            f[:id] = fact['fact']['identifier']
+            f[:title] = fact['fact']['title']
+            f[:description] = fact['fact']['description'] if fact['fact']['description']
+            f[:folder] = fact['fact']['folder']
+            f[:gd_data_type] = fact['fact']['dataType'] || GoodData::Model::DEFAULT_FACT_DATATYPE
+          end
+        end
+      end
+
+      # Converts label from wire format into an internal blueprint representation
+      #
+      # @param stuff [Hash] Whatever comes from wire
+      # @return [Hash] Manifest for a particular reference
+      def self.parse_label(attribute, label, type)
+        {}.tap do |l|
+          l[:type] = :label
+          l[:id] = label['label']['identifier']
+          l[:reference] = attribute['identifier']
+          l[:title] = label['label']['title']
+          l[:gd_data_type] = label['label']['dataType'] || GoodData::Model::DEFAULT_ATTRIBUTE_DATATYPE
+          l[:gd_type] = label['label']['type'] || GoodData::Model::DEFAULT_TYPE
+          l[:default_label] = true if type == :default_label
+        end
+      end
+
+      # Converts label from wire format into an internal blueprint representation
+      #
+      # @param dataset [Hash] Whatever comes from wire
+      # @param anchor_hash [Hash] dataset id -> anchor id hash
+      # @return [Hash] Manifest for a particular reference
+      def self.parse_references(dataset)
+        references = dataset['dataset']['references'] || []
+        references.map do |ref|
+          if ref =~ /^dataset\./
+            {
+              :type => :reference,
+              :dataset => ref
+            }
+          else
+            {
+              :type => :date,
+              :dataset => ref
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gooddata/models/invitation.rb

@@ -0,0 +1,75 @@
+# 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 '../rest/rest'
+
+module GoodData
+  class Invitation < Rest::Resource
+    def initialize(json)
+      @json = json
+    end
+
+    def contributor
+      data = client.get @json['invitation']['meta']['contributor']
+      client.create GoodData::AccountSettings, data
+    end
+
+    def created
+      DateTime.parse(@json['invitation']['meta']['created'])
+    end
+
+    def email
+      @json['invitation']['content']['email']
+    end
+
+    def first_name
+      @json['invitation']['content']['firstname']
+    end
+
+    def phone
+      @json['invitation']['content']['phone']
+    end
+
+    def profile
+      data = client.get @json['invitation']['links']['profile']
+      client.create GoodData::AccountSettings, data
+    end
+
+    def project
+      data = client.get @json['invitation']['links']['project']
+      client.create GoodData::Project, data
+    end
+
+    def project_name
+      @json['invitation']['content']['projectname']
+    end
+
+    def role
+      # TODO: Return object instead
+      @json['invitation']['content']['role']
+    end
+
+    def status
+      @json['invitation']['content']['status']
+    end
+
+    def summary
+      @json['invitation']['content']['summary']
+    end
+
+    def title
+      @json['invitation']['content']['title']
+    end
+
+    def updated
+      DateTime.parse(@json['invitation']['meta']['updated'])
+    end
+
+    def uri
+      @json['invitation']['links']['self']
+    end
+  end
+end

data/lib/gooddata/models/links.rb

@@ -0,0 +1,50 @@
+# 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 '../rest/object'
+
+module GoodData
+  class Links < Rest::Resource
+    attr_reader :data
+
+    def initialize(items)
+      @data = {}
+      items.values[0]['links'].each do |item|
+        category = item['category']
+        if @data[category]
+          if @data[category]['category'] == category
+            @data[category] = { @data[category]['identifier'] => @data[category] }
+          end
+          @data[category][item['identifier']] = item
+        else
+          @data[category] = item
+        end
+      end
+    end
+
+    def links(category, identifier = nil)
+      return Links.new(client.get(self[category])) unless identifier
+      Links.new client.get(get(category, identifier))
+    end
+
+    def [](category)
+      return @data[category]['link'] if @data[category] && @data[category]['link']
+      @data[category]
+    end
+
+    def unique?(category)
+      @data[category]['link'].is_a? String
+    end
+
+    def ambiguous?(category)
+      !unique?(category)
+    end
+
+    def get(category, identifier)
+      self[category][identifier]
+    end
+  end
+end