gooddata 0.6.24 → 0.6.25

data/lib/gooddata/exceptions/object_migration.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.
 
 module GoodData
   # Project Not Found

data/lib/gooddata/exceptions/segment_not_empty.rb

@@ -0,0 +1,18 @@
+# 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 'restclient/exceptions'
+
+module GoodData
+  # Project Not Found
+  class SegmentNotEmpty < RuntimeError
+    DEFAULT_MSG = 'Segment you are trying to delete is not empty. Either clean it up or use force: true to force cleanup of clients.'
+
+    def initialize(msg = DEFAULT_MSG)
+      super(msg)
+    end
+  end
+end

data/lib/gooddata/extensions/object.rb

@@ -5,6 +5,13 @@
 # LICENSE file in the root directory of this source tree.
 
 class Object
+  class << self
+    def set_const(name, val)
+      send(:remove_const, name) if const_defined?(name)
+      send(:const_set, name, val)
+    end
+  end
+
   def blank?
     respond_to?(:empty?) ? empty? : !self
   end
@@ -12,4 +19,9 @@ class Object
   def duplicable?
     true
   end
+
+  def set_const(name, val)
+    send(:remove_const, name) if const_defined?(name)
+    send(:const_set, name, val)
+  end
 end

data/lib/gooddata/goodzilla/goodzilla.rb

@@ -6,31 +6,46 @@
 
 module GoodData
   module SmallGoodZilla
-    PARSE_MAQL_OBJECT_REGEXP = /\[([^\]]+)\]/
-
     class << self
-      # Get IDs from MAQL string
+      # Scans the provided MAQL and returns Array pairs of [attribute, element] pairs for each element that is found in the definition
+      # @param maql Input MAQL string
+      # @return [Array<Array>] Pairs [attribute, attribute_element]
+      def extract_element_uri_pairs(maql)
+        arr = maql.scan(%r{\[([^\[\]]*)\/elements\?id=(\d+)\]}).flatten
+        evens = arr.select.each_with_index { |_, i| i.even? }
+        odds = arr.select.each_with_index { |_, i| i.odd? }.map(&:to_i)
+        evens.zip(odds)
+      end
+
+      # Scans the provided MAQL and returns Array of all the URIs included in the MAQL. This basically return anything that is enclosed in aquare brackets []
+      # @param maql Input MAQL string
+      # @return [Array<String>] Pairs of URIs
+      def get_uris(a_maql_string)
+        a_maql_string.scan(/\[([^\"\]]+)\]/).flatten.uniq
+      end
+
+      # Get IDs from extendedMAQL string
       # @param a_maql_string Input MAQL string
       # @return [Array<String>] List of IDS
       def get_ids(a_maql_string)
         a_maql_string.scan(/!\[([^\"\]]+)\]/).flatten.uniq
       end
 
-      # Get Facts from MAQL string
+      # Get Facts from extendedMAQL string
       # @param a_maql_string Input MAQL string
       # @return [Array<String>] List of Facts
       def get_facts(a_maql_string)
         a_maql_string.scan(/#\"([^\"]+)\"/).flatten
       end
 
-      # Get Attributes from MAQL string
+      # Get Attributes from extendedMAQL string
       # @param a_maql_string Input MAQL string
       # @return [Array<String>] List of Attributes
       def get_attributes(a_maql_string)
         a_maql_string.scan(/@\"([^\"]+)\"/).flatten
       end
 
-      # Get Metrics from MAQL string
+      # Get Metrics from extendedMAQL string
       # @param a_maql_string Input MAQL string
       # @return [Array<String>] List of Metrics
       def get_metrics(a_maql_string)
@@ -39,13 +54,46 @@ module GoodData
 
       alias_method :get_measures, :get_metrics
 
+      # Method takes a specification of the attribute filter (category filter) and returns it representation that is
+      # suitable for posting on the API. The spec is expected to be an array. First object can be an attribute (id, obj_id or
+      # directly an object). Alternativel it can be an attribute (again any representation should work). In case of attribute
+      # primary label is taken. The rest of the array are expected to be String represenation of values of particular label.
+      #
+      # For example it could look like
+      # ['label.states.name', 'California', 'New Jersey', 'Kansas']
+      #
+      # @param spec [Array<Object>] Input MAQL string
+      # @return [Array<Hash>] List of Metrics
+      def create_category_filter(spec, project)
+        item = project.objects(spec.first)
+        label = item.is_a?(GoodData::Attribute) ? item.primary_label : item
+        col = spec[1..-1].flat_map do |v|
+          case v
+          when Range
+            v.to_a
+          when Symbol
+            [v]
+          else
+            [v.to_s]
+          end
+        end
+        if col.first == :not
+          values = col[1..-1].map { |v| label.find_value_uri(v) }
+          elements = values.map { |v| "[#{v}]" }.join(', ')
+          { expression: "[#{label.attribute.uri}] NOT IN (#{elements})" }
+        else
+          values = col.map { |v| label.find_value_uri(v) }
+          elements = values.map { |v| "[#{v}]" }.join(', ')
+          { expression: "[#{label.attribute.uri}] IN (#{elements})" }
+        end
+      end
+
       # Pretty prints the MAQL expression. This basically means it finds out names of objects and elements and print their values instead of URIs
       # @param expression [String] Expression to be beautified
       # @return [String] Pretty printed MAQL expression
       def pretty_print(expression, opts = { client: GoodData.connection, project: GoodData.project })
         temp = expression.dup
-        pairs = expression.scan(PARSE_MAQL_OBJECT_REGEXP).pmap do |uri|
-          uri = uri.first
+        pairs = get_uris(expression).pmap do |uri|
           if uri =~ /elements/
             begin
               [uri, Attribute.find_element_value(uri, opts)]
@@ -56,7 +104,6 @@ module GoodData
             [uri, GoodData::MdObject[uri, opts].title]
           end
         end
-
         pairs.each do |el|
           uri = el[0]
           obj = el[1]

data/lib/gooddata/helpers/global_helpers.rb

@@ -4,8 +4,10 @@
 # This source code is licensed under the BSD-style license found in the
 # LICENSE file in the root directory of this source tree.
 
+require 'base64'
 require 'pathname'
 require 'hashie'
+require 'openssl'
 
 require_relative 'global_helpers_params'
 
@@ -34,6 +36,33 @@ module GoodData
         nil
       end
 
+      # It takes what should be mapped to what and creates a mapping that is suitable for other internal methods.
+      # This means looking up the objects and returning it as array of pairs.
+      # The input can be given in several ways
+      #
+      # 1. Hash. For example it could look like
+      # {'label.states.name' => 'label.state.id'}
+      #
+      # 2 Arrays. In such case the arrays are zipped together. First item will be swapped for the first item in the second array etc.
+      # ['label.states.name'], ['label.state.id']
+      #
+      # @param what [Hash | Array] List/Hash of objects to be swapped
+      # @param for_what [Array] List of objects to be swapped
+      # @return [Array<GoodData::MdObject>] List of pairs of objects
+      def prepare_mapping(what, for_what = nil, options = {})
+        project = options[:project] || (for_what.is_a?(Hash) && for_what[:project]) || fail('Project has to be provided')
+        mapping = if what.is_a?(Hash)
+                    whats = what.keys
+                    to_whats = what.values
+                    whats.zip(to_whats)
+                  elsif what.is_a?(Array) && for_what.is_a?(Array)
+                    whats.zip(to_whats)
+                  else
+                    [[what, for_what]]
+                  end
+        mapping.pmap { |f, t| [project.objects(f), project.objects(t)] }
+      end
+
       def get_path(an_object, path = [])
         return an_object if path.empty?
         path.reduce(an_object) do |a, e|
@@ -215,6 +244,10 @@ module GoodData
         end
       end
 
+      def parse_http_exception(e)
+        JSON.parse(e.response)
+      end
+
       # Creates a matrix with zeroes in all places. It is implemented as an Array of Arrays. First rows then columns.
       #
       # @param [Integer] m Number of rows
@@ -224,6 +257,65 @@ module GoodData
       def zeroes(m, n, val = 0)
         m.times.map { n.times.map { val } }
       end
+
+      # encrypts data with the given key. returns a binary data with the
+      # unhashed random iv in the first 16 bytes
+      def encrypt(data, key)
+        cipher = OpenSSL::Cipher::Cipher.new('aes-256-cbc')
+        cipher.encrypt
+        cipher.key = key = Digest::SHA256.digest(key)
+        random_iv = cipher.random_iv
+        cipher.iv = Digest::SHA256.digest(random_iv + key)[0..15]
+        encrypted = cipher.update(data)
+        encrypted << cipher.final
+        # add unhashed iv to front of encrypted data
+
+        Base64.encode64(random_iv + encrypted)
+      end
+
+      def decrypt(data_base_64, key)
+        return '' if key.nil? || key.empty?
+
+        data = Base64.decode64(data_base_64)
+
+        cipher = OpenSSL::Cipher::Cipher.new('aes-256-cbc')
+        cipher.decrypt
+        cipher.key = cipher_key = Digest::SHA256.digest(key)
+        random_iv = data[0..15] # extract iv from first 16 bytes
+        data = data[16..data.size - 1]
+        cipher.iv = Digest::SHA256.digest(random_iv + cipher_key)[0..15]
+        begin
+          decrypted = cipher.update(data)
+          decrypted << cipher.final
+        rescue
+          puts 'Error'
+          return nil
+        end
+
+        decrypted
+      end
+    end
+  end
+
+  class << self
+    def get_client(opts)
+      client = opts[:client]
+      fail ArgumentError, 'No :client specified' if client.nil?
+
+      client
+    end
+
+    def get_client_and_project(opts)
+      client = opts[:client]
+      fail ArgumentError, 'No :client specified' if client.nil?
+
+      p = opts[:project]
+      fail ArgumentError, 'No :project specified' if p.nil?
+
+      project = GoodData::Project[p, opts]
+      fail ArgumentError, 'Wrong :project specified' if project.nil?
+
+      [client, project]
     end
   end
 end

data/lib/gooddata/mixins/md_finders.rb

@@ -38,15 +38,9 @@ module GoodData
       end
 
       def find_by_tag(tag, opts = { :client => GoodData.connection, :project => GoodData.project })
-        c = client || opts[:client]
+        client, project = GoodData.get_client_and_project(opts)
 
-        p = opts[:project]
-        fail ArgumentError, 'No :project specified' if p.nil?
-
-        project = GoodData::Project[p, opts]
-        fail ArgumentError 'Wrong :project specified' if project.nil?
-
-        self[:all, client: c, project: project].select { |r| r.tags.split(',').include?(tag) }
+        self[:all, client: client, project: project].select { |r| r.tag_set.include?(tag) }
       end
 
       # Finds a specific type of the object by title. Returns first match. Returns full object.

data/lib/gooddata/mixins/md_grantees.rb

@@ -0,0 +1,42 @@
+# 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 Mixin
+    module MdGrantees
+      def grantees(opts = {})
+        permission = opts[:permission]
+        params = permission ? { permission: permission } : {}
+        client.get(uri + '/grantees', params: params)
+      end
+
+      def grant(opts = {})
+        change_permission(opts.merge(operation: :add))
+      end
+
+      def revoke(opts = {})
+        change_permission(opts.merge(operation: :remove))
+      end
+
+      def change_permission(opts)
+        permission = opts[:permission]
+        member = opts[:member]
+        op = opts[:operation]
+        klasses = [GoodData::Profile, GoodData::UserGroup, GoodData::Membership]
+        fail "Permission has to be set. Current value '#{permission}'" unless permission
+        fail 'Member has to be either user or group' unless klasses.any? { |c| member.is_a?(c) }
+        payload = {
+          granteeURIs: {
+            items: [
+              { aclEntryURI: { permission: permission, grantee: member.uri } }
+            ]
+          }
+        }
+        client.post(uri + '/grantees/' + op.to_s, payload)
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/md_id_to_uri.rb

@@ -11,14 +11,7 @@ module GoodData
 
       # TODO: Add test
       def identifier_to_uri(opts = { :client => GoodData.connection, :project => GoodData.project }, *ids)
-        client = opts[:client]
-        fail ArgumentError, 'No :client specified' if client.nil?
-
-        p = opts[:project]
-        fail ArgumentError, 'No :project specified' if p.nil?
-
-        project = GoodData::Project[p, opts]
-        fail ArgumentError, 'Wrong :project specified' if project.nil?
+        client, project = GoodData.get_client_and_project(opts)
 
         uri = project.md[IDENTIFIERS_CFG]
         response = client.post uri, 'identifierToUri' => ids

data/lib/gooddata/mixins/md_object_id.rb

@@ -7,7 +7,7 @@
 module GoodData
   module Mixin
     module MdObjId
-      def obj_id(uri)
+      def uri_obj_id(uri)
         GoodData::Helpers.last_uri_part(uri)
       end
     end

data/lib/gooddata/mixins/md_object_indexer.rb

@@ -16,14 +16,7 @@ module GoodData
       # @return [MdObject] if id is a String or number single object is returned
       # @return [Array] if :all was provided as an id, list of objects should be returned. Note that this is implemented only in the subclasses. MdObject does not support this since API has no means to return list of all types of objects
       def [](id, options = { :client => GoodData.connection, :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, :client => client]
-        fail ArgumentError, 'Wrong :project specified' if project.nil?
+        client, project = GoodData.get_client_and_project(options)
 
         fail "You have to provide an \"id\" to be searched for." unless id
         fail(NoProjectError, 'Connect to a project before searching for an object') unless project
@@ -51,8 +44,12 @@ module GoodData
             md_class = GoodData::Dashboard
           when 'report'
             md_class = GoodData::Report
+          when 'attributeDisplayForm'
+            md_class = GoodData::Label
           when 'reportDefinition'
             md_class = GoodData::ReportDefinition
+          when 'dataSet'
+            md_class = GoodData::Dataset
           else
             md_class = self
           end

data/lib/gooddata/mixins/md_object_query.rb

@@ -97,7 +97,7 @@ module GoodData
         project = GoodData::Project[p, opts]
         fail ArgumentError, 'No :project specified' if project.nil?
 
-        dependency("#{project.md['usedby2']}/#{obj_id(uri)}", key, opts)
+        dependency("#{project.md['usedby2']}/#{uri_obj_id(uri)}", key, opts)
       end
 
       alias_method :used_by, :usedby
@@ -110,7 +110,7 @@ module GoodData
         project = GoodData::Project[p, opts]
         fail ArgumentError, 'No :project specified' if project.nil?
 
-        dependency("#{project.md['using2']}/#{obj_id(uri)}", key, opts)
+        dependency("#{project.md['using2']}/#{uri_obj_id(uri)}", key, opts)
       end
 
       def usedby?(uri, target_uri, opts = { :client => GoodData.connection, :project => GoodData.project })

data/lib/gooddata/mixins/not_group.rb

@@ -0,0 +1,17 @@
+# 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 Mixin
+    module NotUserGroup
+      # Returns true if the object is a fact false otherwise
+      # @return [Boolean]
+      def user_group?
+        false
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/rest_getters.rb

@@ -10,8 +10,8 @@ require_relative 'meta_getter'
 module GoodData
   module Mixin
     module RestGetters
-      include GoodData::Mixin::MetaGetter
-      include GoodData::Mixin::DataGetter
+      include Mixin::MetaGetter
+      include Mixin::DataGetter
     end
   end
 end