gooddata-edge 0.6.27.edge

data/lib/gooddata/helpers/helpers.rb

@@ -0,0 +1,10 @@
+# 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.
+
+base = Pathname(__FILE__).dirname.expand_path
+Dir.glob(base + '*.rb').each do |file|
+  require_relative file
+end

data/lib/gooddata/mixins/author.rb

@@ -0,0 +1,26 @@
+# 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 Author
+      # Gets author of an object
+      #
+      # @return [GoodData::Profile] object author
+      def author
+        tmp = client.get(author_uri)
+        client.create(GoodData::Profile, tmp, project: project)
+      end
+
+      # Gets author URI of an object
+      #
+      # @return [String] object author URI
+      def author_uri
+        meta['author']
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/content_getter.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.
+
+module GoodData
+  module Mixin
+    module ContentGetter
+      def content
+        data && data['content']
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/content_property_reader.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 ContentPropertyReader
+      def content_property_reader(*props)
+        props.each do |prop|
+          define_method prop, proc { content[prop.to_s] }
+        end
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/content_property_writer.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 ContentPropertyWriter
+      def content_property_writer(*props)
+        props.each do |prop|
+          define_method "#{prop}=", proc { |val| content[prop.to_s] = val }
+        end
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/contributor.rb

@@ -0,0 +1,20 @@
+# 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 Contributor
+      # Gets Project Role Contributor
+      #
+      # @return [GoodData::Profile] Project Role Contributor
+      def contributor
+        url = meta['contributor']
+        tmp = client.get url
+        GoodData::Profile.new(tmp)
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/data_getter.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.
+
+module GoodData
+  module Mixin
+    module DataGetter
+      def data
+        json[root_key]
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/data_property_reader.rb

@@ -0,0 +1,19 @@
+# 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 'data_getter'
+
+module GoodData
+  module Mixin
+    module DataPropertyReader
+      def data_property_reader(*props)
+        props.each do |prop|
+          define_method prop, proc { data[prop.to_s] }
+        end
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/data_property_writer.rb

@@ -0,0 +1,19 @@
+# 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 'data_getter'
+
+module GoodData
+  module Mixin
+    module DataPropertyWriter
+      def data_property_writer(*props)
+        props.each do |prop|
+          define_method "#{prop}=", proc { |val| data[prop.to_s] = val }
+        end
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/inspector.rb

@@ -0,0 +1,53 @@
+# 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.
+
+# See https://gist.github.com/ubermajestix/3644301
+
+module GoodData
+  module Mixin
+    # When an RSpec test like this fails,
+    #
+    #   @my_array.should == [@some_model, @some_model2]
+    #
+    # RSpec will call inspect on each of the objects to "help" you figure out
+    # what went wrong. Well, inspect will usually dump a TON OF SHIT and make trying
+    # to figure out why `@my_array` is not made up of `@some_model` and `@some_model2`.
+    #
+    # This little module and technique helps get around that. It will redefine `inspect`
+    # if you include it in your model object.
+    #
+    # You can define a whitelist of methods that inspect will dump.
+    # It will always provide `object_id` at a minimum.
+    #
+    # To use it, drop it in spec/support/inspector.rb and class_eval the models to
+    # override `inspect`.
+    module Inspector
+      def inspect
+        string = "#<#{self.class.name}:#{object_id} "
+        fields = self.class.inspector_fields.map { |field| "#{field}: #{send(field)}" }
+        string << fields.join(', ') << '>'
+      end
+
+      def self.inspected
+        @inspected ||= []
+      end
+
+      def self.included(source)
+        # $stdout.puts "Overriding inspect on #{source}"
+        inspected << source
+        source.class_eval do
+          def self.inspector(*fields)
+            @inspector_fields = *fields
+          end
+
+          def self.inspector_fields
+            @inspector_fields ||= []
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/is_attribute.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 IsAttribute
+      # Returns true if the object is a attribute false otherwise
+      # @return [Boolean]
+      def attribute?
+        true
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/is_dimension.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 IsDimension
+      # Returns true if the object is a dimension false otherwise
+      # @return [Boolean]
+      def dimension?
+        true
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/is_fact.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 IsFact
+      # Returns true if the object is a fact false otherwise
+      # @return [Boolean]
+      def fact?
+        true
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/is_label.rb

@@ -0,0 +1,19 @@
+# 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 IsLabel
+      # Returns true if the object is a label false otherwise
+      # @return [Boolean]
+      def label?
+        true
+      end
+
+      alias_method :display_form?, :label?
+    end
+  end
+end

data/lib/gooddata/mixins/links.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.
+
+module GoodData
+  module Mixin
+    module Links
+      def links
+        data['links']
+      end
+    end
+  end
+end

data/lib/gooddata/mixins/md_finders.rb

@@ -0,0 +1,77 @@
+# 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 MdFinders
+      # Finds a specific type of the object by identifier. Returns first match. Returns full object.
+      #
+      # @param title [String] identifier that has to match exactly
+      # @param title [Regexp] regular expression that has to match
+      # @return [Array<GoodData::MdObject>] Array of MdObject
+      def find_first_by_identifier(identifier, options = { :client => GoodData.connection, :project => GoodData.project })
+        all = self[:all, options.merge(full: false)]
+        item = if identifier.is_a?(Regexp)
+                 all.find { |r| r.identifier =~ identifier }
+               else
+                 all.find { |r| r.identifier == identifier }
+               end
+        self[item.uri, options] unless item.nil?
+      end
+
+      # Finds a specific type of the object by identifier. Returns all matches. Returns full object.
+      #
+      # @param title [String] identifier that has to match exactly
+      # @param title [Regexp] regular expression that has to match
+      # @return [Array<GoodData::MdObject>] Array of MdObject
+      def find_by_identifier(identifier, options = { :client => GoodData.connection, :project => GoodData.project })
+        all = self[:all, options]
+        items = if identifier.is_a?(Regexp)
+                  all.select { |r| r.title =~ identifier }
+                else
+                  all.select { |r| r.title == identifier }
+                end
+        items.pmap { |item| self[item.uri, options] unless item.nil? }
+      end
+
+      def find_by_tag(tag, opts = { :client => GoodData.connection, :project => GoodData.project })
+        client, project = GoodData.get_client_and_project(opts)
+
+        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.
+      #
+      # @param title [String] title that has to match exactly
+      # @param title [Regexp] regular expression that has to match
+      # @return [Array<GoodData::MdObject>] Array of MdObject
+      def find_first_by_title(title, options = { :client => GoodData.connection, :project => GoodData.project })
+        all = self[:all, options]
+        item = if title.is_a?(Regexp)
+                 all.find { |r| r.title =~ title }
+               else
+                 all.find { |r| r.title == title }
+               end
+        self[item.uri, options] unless item.nil?
+      end
+
+      # Finds a specific type of the object by title. Returns all matches. Returns full object.
+      #
+      # @param title [String] title that has to match exactly
+      # @param title [Regexp] regular expression that has to match
+      # @return [Array<GoodData::MdObject>] Array of MdObject
+      def find_by_title(title, options = { :client => GoodData.connection, :project => GoodData.project })
+        all = self[:all, options]
+        items = if title.is_a?(Regexp)
+                  all.select { |r| r.title =~ title }
+                else
+                  all.select { |r| r.title == title }
+                end
+        items.pmap { |item| self[item.uri, options] unless item.nil? }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# 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 MdIdToUri
+      IDENTIFIERS_CFG = 'instance-identifiers'
+
+      # TODO: Add test
+      def identifier_to_uri(opts = { :client => GoodData.connection, :project => GoodData.project }, *ids)
+        client, project = GoodData.get_client_and_project(opts)
+
+        uri = project.md[IDENTIFIERS_CFG]
+        response = client.post uri, 'identifierToUri' => ids
+        if response['identifiers'].empty?
+          nil
+        else
+          identifiers = response['identifiers']
+          ids_lookup = identifiers.reduce({}) do |a, e|
+            a[e['identifier']] = e['uri']
+            a
+          end
+          uris = ids.map { |x| ids_lookup[x] }
+          uris.count == 1 ? uris.first : uris
+        end
+      end
+
+      alias_method :id_to_uri, :identifier_to_uri
+    end
+  end
+end