gooddata 0.6.0 → 0.6.2

data/lib/gooddata/models/project_metadata.rb

@@ -7,11 +7,14 @@ module GoodData
         ProjectMetadata[:all].keys
       end
 
-      def [](key)
+      def [](key, options = {})
         if key == :all
           uri = "/gdc/projects/#{GoodData.project.pid}/dataload/metadata"
           res = GoodData.get(uri)
-          res['metadataItems']['items'].reduce({}) { |memo, i| memo[i['metadataItem']['key']] = i['metadataItem']['value']; memo }
+          res['metadataItems']['items'].reduce({}) do |memo, i|
+            memo[i['metadataItem']['key']] = i['metadataItem']['value']
+            memo
+          end
         else
           uri = "/gdc/projects/#{GoodData.project.pid}/dataload/metadata/#{key}"
           res = GoodData.get(uri)
@@ -22,13 +25,11 @@ module GoodData
       alias_method :get, :[]
       alias_method :get_key, :[]
 
-      def has_key?(key)
-        begin
-          ProjectMetadata[key]
-          true
-        rescue RestClient::ResourceNotFound => e
-          false
-        end
+      def key?(key)
+        ProjectMetadata[key]
+        true
+      rescue RestClient::ResourceNotFound
+        false
       end
 
       def []=(key, val)
@@ -41,7 +42,7 @@ module GoodData
         uri = "/gdc/projects/#{GoodData.project.pid}/dataload/metadata/"
         update_uri = uri + key
 
-        if has_key?(key)
+        if key?(key)
           GoodData.put(update_uri, data)
         else
           GoodData.post(uri, data)

data/lib/gooddata/models/project_role.rb

@@ -0,0 +1,92 @@
+# encoding: UTF-8
+
+require_relative 'account_settings'
+
+module GoodData
+  class ProjectRole
+    def initialize(json)
+      @json = json
+    end
+
+    # Gets Project Role Identifier
+    #
+    # @return [string] Project Role
+    def identifier
+      @json['projectRole']['meta']['identifier']
+    end
+
+    # Gets Project Role Author
+    #
+    # @return [GoodData::AccountSettings] Project Role author
+    def author
+      url = @json['projectRole']['meta']['author']
+      tmp = GoodData.get url
+      GoodData::AccountSettings.new(tmp)
+    end
+
+    # Gets Project Role Contributor
+    #
+    # @return [GoodData::AccountSettings] Project Role Contributor
+    def contributor
+      url = @json['projectRole']['meta']['contributor']
+      tmp = GoodData.get url
+      GoodData::AccountSettings.new(tmp)
+    end
+
+    # Gets DateTime time when created
+    #
+    # @return [DateTime] Date time of creation
+    def created
+      DateTime.parse(@json['projectRole']['meta']['created'])
+    end
+
+    # Gets Project Role Permissions
+    #
+    # @return [string] Project Role
+    def permissions
+      @json['projectRole']['permissions']
+    end
+
+    # Gets Project Role Title
+    #
+    # @return [string] Project Role Title
+    def title
+      @json['projectRole']['meta']['title']
+    end
+
+    # Gets Project Role Summary
+    #
+    # @return [string] Project Role Summary
+    def summary
+      @json['projectRole']['meta']['summary']
+    end
+
+    # Gets DateTime time when updated
+    #
+    # @return [DateTime] Date time of last update
+    def updated
+      DateTime.parse(@json['projectRole']['meta']['updated'])
+    end
+
+    # Gets Users with this Role
+    #
+    # @return [Array<GoodData::AccountSettings>] List of users
+    def users
+      res = []
+      url = @json['projectRole']['links']['roleUsers']
+      tmp = GoodData.get url
+      tmp['associatedUsers']['users'].each do |user_url|
+        user = GoodData.get user_url
+        res << GoodData::AccountSettings.new(user)
+      end
+      res
+    end
+
+    # Gets Raw object URI
+    #
+    # @return [string] URI of this project role
+    def uri
+      @json['projectRole']['links']['roleUsers'].split('/')[0...-1].join('/')
+    end
+  end
+end

data/lib/gooddata/models/references/date_reference.rb

@@ -0,0 +1,44 @@
+# encoding: UTF-8
+
+require_relative '../columns/reference'
+
+module GoodData
+  module Model
+    ##
+    # Date as a reference to a date dimension
+    #
+    class DateReference < Reference
+      attr_accessor :format, :output_format, :urn
+
+      def initialize(column, schema)
+        super column, schema
+        @output_format = column['format'] || 'dd/MM/yyyy'
+        @format = @output_format.gsub('yyyy', '%Y').gsub('MM', '%m').gsub('dd', '%d')
+        @urn = column[:urn] || 'URN:GOODDATA:DATE'
+      end
+
+      def identifier
+        @identifier ||= "#{@schema_ref}.#{DATE_ATTRIBUTE}"
+      end
+
+      def to_manifest_part(mode)
+        {
+          'populates' => ["#{identifier}.#{DATE_ATTRIBUTE_DEFAULT_DISPLAY_FORM}"],
+          'mode' => mode,
+          'constraints' => { 'date' => output_format },
+          'columnName' => name,
+          'referenceKey' => 1
+        }
+      end
+
+      # def to_maql_create
+      #   # urn:chefs_warehouse_fiscal:date
+      #   super_maql = super
+      #   maql = ""
+      #   # maql = "# Include date dimensions\n"
+      #   # maql += "INCLUDE TEMPLATE \"#{urn}\" MODIFY (IDENTIFIER \"#{name}\", TITLE \"#{title || name}\");\n"
+      #   maql += super_maql
+      # end
+    end
+  end
+end

data/lib/gooddata/models/references/references.rb

@@ -0,0 +1,8 @@
+# encoding: UTF-8
+
+require 'pathname'
+
+base = Pathname(__FILE__).dirname.expand_path
+Dir.glob(base + '*.rb').each do |file|
+  require file
+end

data/lib/gooddata/models/references/time_reference.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+
+require_relative '../columns/reference'
+
+module GoodData
+  module Model
+    ##
+    # Time as a reference to a time-of-a-day dimension
+    #
+    class TimeReference < Reference
+    end
+  end
+end

data/lib/gooddata/models/report_data_result.rb

@@ -34,7 +34,7 @@ module GoodData
       to_table.each { |line| yield line }
     end
 
-    alias :each_row :each_line
+    alias_method :each_row, :each_line
 
     def each_column
       table.each { |line| yield line }
@@ -48,11 +48,11 @@ module GoodData
       table.transpose
     end
 
-    def [](index)
+    def [](index, options = {})
       to_table[index]
     end
 
-    alias :row :[]
+    alias_method :row, :[]
 
     def column(index)
       table[index]
@@ -66,13 +66,12 @@ module GoodData
       table.include?(row)
     end
 
-    def == (otherDataResult)
-      result = true
+    def ==(other)
       csv_table = to_table
       len = csv_table.length
-      table = otherDataResult.respond_to?(:to_table) ? otherDataResult.to_table : otherDataResult
+      table = other.respond_to?(:to_table) ? other.to_table : other
       return false if len != table.length
-      diff(otherDataResult).empty?() ? true : false
+      diff(other).empty? ? true : false
     end
 
     def diff(otherDataResult)
@@ -81,12 +80,13 @@ module GoodData
       differences = []
 
       csv_table.each do |row|
-        differences << row unless other_table.detect { |r| r == row }
+        differences << row unless other_table.find { |r| r == row }
       end
       differences
     end
 
     private
+
     def each_level(table, level, children, lookup)
       max_level = level + 1
       children.each do |kid|
@@ -101,8 +101,8 @@ module GoodData
             table[first + i][level] = lookup[level][kid['id'].to_s]
           end
         end
-        if (!kid['children'].empty?)
-          new_level = each_level(table, level+1, kid['children'], lookup)
+        unless kid['children'].empty?
+          new_level = each_level(table, level + 1, kid['children'], lookup)
           max_level = [max_level, new_level].max
         end
       end
@@ -136,7 +136,7 @@ module GoodData
       return headers, size # rubocop:disable RedundantReturn
     end
 
-    def assemble_table()
+    def assemble_table
       #    puts "=== COLUMNS === #{column_headers.size}x#{headers_height}"
       (column_headers.size).times do |i|
         (headers_height).times do |j|

data/lib/gooddata/models/schedule.rb

@@ -0,0 +1,284 @@
+# encoding: UTF-8
+
+module GoodData
+  class Schedule
+    attr_reader :dirty
+
+    class << self
+      # Looks for schedule
+      # @param id [String] URL, ID of schedule or :all
+      # @return [GoodData::Schedule|Array<GoodData::Schedule>] List of schedules
+      def [](id, options = {})
+        if id == :all
+          GoodData::Schedule.all
+        else
+          if id =~ %r{\/gdc\/projects\/[a-zA-Z\d]+\/schedules\/?[a-zA-Z\d]*}
+            url = id
+            tmp = GoodData.get url
+            return GoodData::Schedule.new(tmp)
+          end
+
+          tmp = GoodData.get "/gdc/projects/#{GoodData.project.pid}/schedules/#{id}"
+          GoodData::Schedule.new(tmp)
+        end
+      end
+
+      # Returns list of all schedules for active project
+      # @return [Array<GoodData::Schedule>] List of schedules
+      def all
+        tmp = GoodData.get "/gdc/projects/#{GoodData.project.pid}/schedules"
+        tmp['schedules']['items'].map { |schedule| GoodData::Schedule.new(schedule) }
+      end
+
+      # Creates new schedules from parameters passed
+      #
+      # @param process_id [String] Process ID
+      # @param cron [String] Cron Settings
+      # @param executable [String] Execution executable
+      # @param options [Hash] Optional options
+      # @return [GoodData::Schedule] New GoodData::Schedule instance
+      def create(process_id, cron, executable, options = {})
+        default_opts = {
+          :type => 'MSETL',
+          :timezone => 'UTC',
+          :cron => cron,
+          :params => {
+            :process_id => process_id,
+            :executable => executable
+          },
+          :hidden_params => {}
+        }
+
+        inject_schema = {
+          :hidden_params => 'hiddenParams'
+        }
+
+        inject_params = {
+          :process_id => 'PROCESS_ID',
+          :executable => 'EXECUTABLE'
+        }
+
+        default_params = default_opts[:params].reduce({}) do |new_hash, (k, v)|
+          key = inject_params[k] || k
+          new_hash[key] = v
+          new_hash
+        end
+
+        default = default_opts.reduce({}) do |new_hash, (k, v)|
+          key = inject_schema[k] || k
+          new_hash[key] = v
+          new_hash
+        end
+
+        default[:params] = default_params
+
+        json = {
+          'schedule' => default.merge(options)
+        }
+
+        tmp = json['schedule'][:params]['PROCESS_ID']
+        fail 'Process ID has to be provided' if tmp.nil? || tmp.empty?
+
+        tmp = json['schedule'][:params]['EXECUTABLE']
+        fail 'Executable has to be provided' if tmp.nil? || tmp.empty?
+
+        tmp = json['schedule'][:cron]
+        fail 'Cron schedule has to be provided' if tmp.nil? || tmp.empty?
+
+        tmp = json['schedule'][:timezone]
+        fail 'A timezone has to be provided' if tmp.nil? || tmp.empty?
+
+        tmp = json['schedule'][:type]
+        fail 'Schedule type has to be provided' if tmp.nil? || tmp.empty?
+
+        url = "/gdc/projects/#{GoodData.project.pid}/schedules"
+        res = GoodData.post url, json
+
+        fail 'Unable to create new schedule' if res.nil?
+
+        new_obj_json = GoodData.get res['schedule']['links']['self']
+        GoodData::Schedule.new(new_obj_json)
+      end
+    end
+
+    # Initializes object from raw json
+    #
+    # @param json [Object] Raw JSON
+    # @return [GoodData::Schedule] New GoodData::Schedule instance
+    def initialize(json)
+      @json = json
+    end
+
+    # Deletes schedule
+    def delete
+      GoodData.delete uri
+    end
+
+    # Executes schedule
+    #
+    # @return [Object] Raw Response
+    def execute
+      data = {
+        :execution => {}
+      }
+      GoodData.post execution_url, data
+    end
+
+    # Returns execution URL
+    #
+    # @return [String] Executions URL
+    def execution_url
+      @json['schedule']['links']['executions']
+    end
+
+    # Returns execution state
+    #
+    # @return [String] Execution state
+    def state
+      @json['schedule']['state']
+    end
+
+    # Returns execution timezone
+    #
+    # @return [String] Execution timezone
+    def timezone
+      @json['schedule']['timezone']
+    end
+
+    # Assigns execution timezone
+    #
+    # @param new_timezone [String] Timezone to be set
+    def timezone=(new_timezone)
+      @json['schedule']['timezone'] = new_timezone
+      @dirty = true
+    end
+
+    # Returns execution type
+    #
+    # @return [String] Execution type
+    def type
+      @json['schedule']['type']
+    end
+
+    # Assigns execution type
+    #
+    # @param new_type [String] Execution type to be set
+    def type=(new_type)
+      @json['schedule']['type'] = new_type
+      @dirty = true
+    end
+
+    # Returns execution cron settings
+    #
+    # @return [String] Cron settings
+    def cron
+      @json['schedule']['cron']
+    end
+
+    # Assigns execution cron settings
+    #
+    # @param new_cron [String] Cron settings to be set
+    def cron=(new_cron)
+      @json['schedule']['cron'] = new_cron
+      @dirty = true
+    end
+
+    # Returns execution process ID
+    #
+    # @return [String] Process ID
+    def process_id
+      @json['schedule']['params']['PROCESS_ID']
+    end
+
+    def process_id=(new_project_id)
+      @json['schedule']['params']['PROCESS_ID'] = new_project_id
+      @dirty = true
+    end
+
+    # Returns execution executable
+    #
+    # @return [String] Executable (graph) name
+    def executable
+      @json['schedule']['params']['EXECUTABLE']
+    end
+
+    # Assigns execution executable
+    #
+    # @param new_executable [String] Executable to be set.
+    def executable=(new_executable)
+      @json['schedule']['params']['EXECUTABLE'] = new_executable
+      @dirty = true
+    end
+
+    # Returns list of executions
+    #
+    # @return [Array] Raw Executions JSON
+    def executions
+      if @json
+        url = @json['schedule']['links']['executions']
+        res = GoodData.get url
+        res['executions']['items']
+      end
+    end
+
+    # Returns params as Hash
+    #
+    # @return [Hash] Parameters
+    def params
+      @json['schedule']['params']
+    end
+
+    # Assigns execution parameters
+    #
+    # @param params [String] Params to be set
+    def params=(new_param)
+      @json['schedule']['params'].merge!(new_param)
+      @dirty = true
+    end
+
+    # Returns hidden_params as Hash
+    #
+    # @return [Hash] Hidden Parameters
+    def hidden_params
+      @json['schedule']['hiddenParams'] || {}
+    end
+
+    # Assigns hidden parameters
+    #
+    # @param new_hidden_param [String] Hidden parameters to be set
+    def hidden_params=(new_hidden_param)
+      @json['schedule']['hiddenParams'] = hidden_params.merge(new_hidden_param)
+      @dirty = true
+    end
+
+    # Saves object if dirty
+    #
+    # @return [Boolean] True if saved
+    def save
+      if @dirty
+        update_json = {
+          'schedule' => {
+            'type' => @json['schedule']['type'],
+            'timezone' => @json['schedule']['timezone'],
+            'cron' => @json['schedule']['cron'],
+            'params' => @json['schedule']['params'],
+            'hiddenParams' => @json['schedule']['hiddenParams']
+          }
+        }
+        res = GoodData.put uri, update_json
+
+        @json = res
+        @dirty = false
+        return true
+      end
+      false
+    end
+
+    # Returns URL
+    #
+    # @return [String] Schedule URL
+    def uri
+      @json['schedule']['links']['self'] if @json && @json['schedule'] && @json['schedule']['links']
+    end
+  end
+end