gooddata 1.0.0-java

data/lib/gooddata/models/membership.rb

@@ -0,0 +1,441 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2017 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 'multi_json'
+require 'pmap'
+
+require_relative 'project'
+require_relative 'project_role'
+require_relative 'user_group'
+
+require_relative '../rest/object'
+
+module GoodData
+  class Membership < Rest::Resource
+    attr_reader :json
+
+    ASSIGNABLE_MEMBERS = [
+      :email,
+      :first_name,
+      :last_name,
+      :login,
+      :phone,
+      :status,
+      :title
+    ]
+
+    class << self
+      # Apply changes to object.
+      #
+      # @param obj [GoodData::User] Object to be modified
+      # @param changes [Hash] Hash with modifications
+      # @return [GoodData::User] Modified object
+      # def apply(obj, changes)
+      #   changes.each do |param, val|
+      #     next unless ASSIGNABLE_MEMBERS.include? param
+      #     obj.send("#{param}=", val)
+      #   end
+      #   obj
+      # end
+      def create(data, options = { client: GoodData.connection })
+        c = client(options)
+        json = {
+          'user' => {
+            'content' => {
+              'email' => data[:email] || data[:login],
+              'login' => data[:login],
+              'firstname' => data[:first_name],
+              'lastname' => data[:last_name],
+              'userRoles' => ['editor'],
+              'password' => data[:password],
+              'domain' => data[:domain],
+              # And following lines are even much more ugly hack
+              # 'authentication_modes' => ['sso', 'password']
+            },
+            'links' => {},
+            'meta' => {}
+          }
+        }
+        json['user']['links']['self'] = data[:uri] if data[:uri]
+        c.create(self, json)
+      end
+
+      def diff_list(list1, list2)
+        GoodData::Helpers.diff(list1, list2, key: :login)
+      end
+    end
+
+    def initialize(json)
+      @json = json
+    end
+
+    # Checks objects for equality
+    #
+    # @param right [GoodData::User] Project to compare with
+    # @return [Boolean] True if same else false
+    def ==(other)
+      return false unless other.respond_to?(:to_hash)
+      to_hash == other.to_hash
+      # res = true
+      # ASSIGNABLE_MEMBERS.each do |k|
+      #   l_val = send("#{k}")
+      #   r_val = other.send("#{k}")
+      #   res = false if l_val != r_val
+      # end
+      # res
+    end
+
+    # Checks objects for non-equality
+    #
+    # @param right [GoodData::User] Project to compare with
+    # @return [Boolean] True if different else false
+    def !=(other)
+      !(self == other)
+    end
+
+    # Apply changes to object.
+    #
+    # @param changes [Hash] Hash with modifications
+    # @return [GoodData::User] Modified object
+    # def apply(changes)
+    #   GoodData::User.apply(self, changes)
+    # end
+
+    # Gets the contributor
+    #
+    # @return [String] Contributor
+    def contributor
+      url = @json['user']['meta']['contributor']
+      data = client.get url
+      client.create(GoodData::Membership, data)
+    end
+
+    # Gets date when created
+    #
+    # @return [DateTime] Created date
+    def created
+      Time.parse(@json['user']['meta']['created'])
+    end
+
+    # Is the member deleted?
+    #
+    # @return [Boolean] true if he is deleted
+    def deleted?
+      !(login =~ /^deleted-/).nil?
+    end
+
+    # Gets hash representing diff of users
+    #
+    # @param user [GoodData::User] Another profile to compare with
+    # @return [Hash] Hash representing diff
+    def diff(user)
+      GoodData::User.diff(self, user)
+    end
+
+    # Gets the email
+    #
+    # @return [String] Email address
+    def email
+      @json['user']['content']['email'] || ''
+    end
+
+    # Sets the email
+    #
+    # @param new_email [String] New email to be assigned
+    def email=(new_email)
+      @json['user']['content']['email'] = new_email
+    end
+
+    # Gets the first name
+    #
+    # @return [String] First name
+    def first_name
+      @json['user']['content']['firstname'] || ''
+    end
+
+    # Sets the first name
+    #
+    # @param new_first_name [String] New first name to be assigned
+    def first_name=(new_first_name)
+      @json['user']['content']['firstname'] = new_first_name
+    end
+
+    # Get full name
+    #
+    # @return String Full Name
+    # NOTE: This can be tricky to implement correctly for i18n
+    def full_name
+      "#{first_name} #{last_name}"
+    end
+
+    # Gets the invitations
+    #
+    # @return [Array<GoodData::Invitation>] List of invitations
+    def invitations
+      res = []
+
+      tmp = client.get @json['user']['links']['invitations']
+      tmp['invitations'].each do |_invitation|
+        # TODO: Something is missing here
+      end
+
+      res
+    end
+
+    # Gets the last name
+    #
+    # @return [String] Last name
+    def last_name
+      @json['user']['content']['lastname'] || ''
+    end
+
+    # Sets the last name
+    #
+    # @param new_last_name [String] New last name to be assigned
+    def last_name=(new_last_name)
+      @json['user']['content']['lastname'] = new_last_name
+    end
+
+    # Gets the login
+    #
+    # @return [String] Login
+    def login
+      @json['user']['content']['login'] || ''
+    end
+
+    # Sets the last name
+    #
+    # @param new_login [String] New login to be assigned
+    def login=(new_login)
+      @json['user']['content']['login'] = new_login
+    end
+
+    # Gets user raw object ID
+    #
+    # @return [String] Raw Object ID
+    def obj_id
+      uri.split('/').last
+    end
+
+    # Gets the permissions
+    #
+    # @return [Hash] Hash with permissions
+    def permissions
+      res = {}
+
+      tmp = client.get @json['user']['links']['permissions']
+      tmp['associatedPermissions']['permissions'].each do |permission_name, permission_value|
+        res[permission_name] = permission_value
+      end
+
+      res
+    end
+
+    # Gets the phone number
+    #
+    # @return [String] Phone number
+    def phone
+      @json['user']['content']['phonenumber'] || ''
+    end
+
+    # Sets the phone number
+    #
+    # @param new_phone_number [String] New phone number to be assigned
+    def phone=(new_phone_number)
+      @json['user']['content']['phonenumber'] = new_phone_number
+    end
+
+    # Gets profile of this membership
+    def profile
+      raw = client.get @json['user']['links']['self']
+      client.create(GoodData::Profile, raw)
+    end
+
+    # Gets URL of profile membership
+    def profile_url
+      @json['user']['links']['self']
+    end
+
+    # # Gets project which this membership relates to
+    # def project
+    #   raw = client.get project_url
+    #   client.create(GoodData::Project, raw)
+    # end
+
+    # Gets project id
+    def project_id
+      @json['user']['links']['roles'].split('/')[3]
+    end
+
+    # Gets project url
+    def project_url
+      @json['user']['links']['roles'].split('/')[0..3].join('/')
+    end
+
+    # Gets the projects of user
+    #
+    # @return [Array<GoodData::Project>] Array of projets
+    def projects
+      tmp = client.get @json['user']['links']['projects']
+      tmp['projects'].map do |project_meta|
+        project_uri = project_meta['project']['links']['self']
+        project = client.get project_uri
+        client.create(GoodData::Project, project)
+      end
+    end
+
+    # Gets first role
+    #
+    # @return [GoodData::ProjectRole] Array of project roles
+    def role
+      roles && roles.first
+    end
+
+    # Gets the project roles of user
+    #
+    # @return [Array<GoodData::ProjectRole>] Array of project roles
+    def roles
+      # TODO: Implement getting roles in project and cache them there
+      # See: https://jira.intgdc.com/browse/TMA-112
+      roles_link = GoodData::Helpers.get_path(@json, %w(user links roles))
+      return unless roles_link
+      tmp = client.get roles_link
+      tmp['associatedRoles']['roles'].pmap do |role_uri|
+        role = client.get role_uri
+        client.create(GoodData::ProjectRole, role)
+      end
+    end
+
+    # Gets the status
+    #
+    # @return [String] Status
+    def status
+      @json['user']['content']['status'] || ''
+    end
+
+    # Gets the title
+    #
+    # @return [String] User title
+    def title
+      @json['user']['meta']['title'] || ''
+    end
+
+    # Sets the title
+    #
+    # @param new_title [String] New title to be assigned
+    def title=(new_title)
+      @json['user']['content']['title'] = new_title
+    end
+
+    # Gets the date when updated
+    #
+    # @return [DateTime] Date of last update
+    def updated
+      DateTime.parse(@json['user']['meta']['updated'])
+    end
+
+    # Gets the object URI
+    #
+    # @return [String] Object URI
+    def uri
+      links['self']
+    end
+
+    # Enables membership
+    #
+    # @return [GoodData::Membership] returns self
+    def enable
+      self.status = 'ENABLED'
+      self
+    end
+
+    # Is the member enabled?
+    #
+    # @return [Boolean] true if it is enabled
+    def enabled?
+      status == 'ENABLED'
+    end
+
+    # Disables membership
+    #
+    # @return [GoodData::Membership] returns self
+    def disable
+      self.status = 'DISABLED'
+      self
+    end
+
+    # Is the member enabled?
+    #
+    # @return [Boolean] true if it is disabled
+    def disabled?
+      !enabled?
+    end
+
+    def data
+      data = @json || {}
+      data['user'] || {}
+    end
+
+    def name
+      (first_name || '') + (last_name || '')
+    end
+
+    def meta
+      data['meta'] || {}
+    end
+
+    def links
+      data['links'] || {}
+    end
+
+    def content
+      data['content'] || {}
+    end
+
+    def to_hash
+      tmp = GoodData::Helpers.symbolize_keys(content.merge(meta).merge('uri' => uri))
+      [
+        [:userRoles, :role],
+        [:companyName, :company_name],
+        [:phoneNumber, :phone_number],
+        [:firstname, :first_name],
+        [:lastname, :last_name],
+        [:authenticationModes, :authentication_modes]
+      ].each do |vals|
+        wire, rb = vals
+        tmp[rb] = tmp[wire]
+        tmp.delete(wire)
+      end
+      tmp
+    end
+
+    def user_groups
+      project.user_groups(:all, user: obj_id)
+    end
+
+    private
+
+    # Sets status to 'ENABLED' or 'DISABLED'
+    def status=(new_status)
+      payload = {
+        'user' => {
+          'content' => {
+            'status' => new_status.to_s.upcase,
+            'userRoles' => @json['user']['content']['userRoles']
+          },
+          'links' => {
+            'self' => uri
+          }
+        }
+      }
+
+      res = client.post("/gdc/projects/#{project_id}/users", payload)
+      fail 'Update failed' unless res['projectUsersUpdateResult']['failed'].empty?
+      @json['user']['content']['status'] = new_status.to_s.upcase
+      self
+    end
+  end
+end

data/lib/gooddata/models/metadata.rb

@@ -0,0 +1,324 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2017 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 'multi_json'
+
+require_relative '../core/project'
+
+require_relative '../mixins/mixins'
+require_relative '../rest/object'
+
+module GoodData
+  class MdObject < Rest::Resource
+    MD_OBJ_CTG = 'obj'
+    IDENTIFIERS_CFG = 'instance-identifiers'
+
+    extend Mixin::MdIdToUri
+    extend Mixin::MdObjectIndexer
+    extend Mixin::MdObjectQuery
+
+    extend Mixin::MdFinders
+    extend Mixin::MdObjId
+
+    include Mixin::Links
+    include Mixin::ObjId
+    include Mixin::MdRelations
+    include Mixin::MdGrantees
+
+    class << self
+      # Method used for replacing objects like Attribute, Fact or Metric.
+      # It takes the object. Scans its JSON representation and returns
+      # a new one with object references changed according to mapping.
+      # The references an be found either in the object structure or in
+      # the MAQL in bracketed form. This implementation takes care only
+      # of those in bracketed form.
+      #
+      # @param obj [GoodData::MdObject] what Object that should be replaced
+      # @param mapping [Array[Array]] Array of mapping pairs.
+      # @return [GoodData::MdObject]
+      def replace_bracketed(obj, mapping)
+        replace(obj, mapping) { |e, a, b| e.gsub("[#{a}]", "[#{b}]") }
+      end
+
+      # Method used for replacing objects like Attribute, Fact or Metric.
+      # It takes the object. Scans its JSON representation and returns
+      # a new one with object references changed according to mapping.
+      # The references an be found either in the object structure or in the MAQL
+      # in bracketed form. This implementation takes care only of those
+      # in object structure where they are as a string in JSON.
+      #
+      # @param obj [GoodData::MdObject] Object that should be replaced
+      # @param mapping [Array[Array]] Array of mapping pairs.
+      # @return [GoodData::MdObject]
+      def replace_quoted(obj, mapping)
+        replace(obj, mapping) do |e, a, b|
+          e.gsub("\"#{a}\"", "\"#{b}\"")
+        end
+      end
+
+      # Helper method used for replacing objects like Attribute, Fact or Metric. It takes the object. Scans its JSON
+      # representation yields for a client to perform replacement for each mapping pair and returns a new one
+      # with object of the same type as obj.
+      #
+      # @param obj [GoodData::MdObject] Object that should be replaced
+      # @param mapping [Array[Array]] Array of mapping pairs.
+      # @param block [Proc] Block that receives the object state as a JSON string and mapping pair and expects a new object state as a JSON string back
+      # @return [GoodData::MdObject]
+      def replace(obj, mapping, &block)
+        json = mapping.reduce(obj.to_json) do |a, e|
+          obj_a, obj_b = e
+          uri_what = obj_a.respond_to?(:uri) ? obj_a.uri : obj_a
+          uri_for_what = obj_b.respond_to?(:uri) ? obj_b.uri : obj_b
+          block.call(a, uri_what, uri_for_what)
+        end
+        client = obj.client
+        client.create(obj.class, MultiJson.load(json), :project => obj.project)
+      end
+
+      # Helper method used for finding attribute elements that are interesting becuase they can be possibly
+      # replaced according to mapping specification. This walks through all the attribute elemets. Picks only those
+      # whose attribute is mentioned in the mapping. Walks through all the labels of that particular attribute and
+      # tries to find a value from one to be translated into a label in second. Obviously this is not guaranteed to
+      # find any results or in some cases can yield to incorrect results.
+      #
+      # @param obj [GoodData::MdObject] Object that should be replaced
+      # @param mapping [Array[Array]] Array of mapping pairs.
+      # @param block [Proc] Block that receives the object state as a JSON string and mapping pair and expects a new object state as a JSON string back
+      # @return [GoodData::MdObject]
+      def find_replaceable_values(obj, mapping)
+        values_to_replace = GoodData::SmallGoodZilla.extract_element_uri_pairs(MultiJson.dump(obj.to_json))
+        values_from_mapping = values_to_replace.select { |i| mapping.map { |a, _| a.uri }.include?(i.first) }
+        replaceable_vals = values_from_mapping.map do |a_uri, id|
+          from_attribute, to_attribute = mapping.find { |k, _| k.uri == a_uri }
+          vals = from_attribute.values_for(id)
+          labels = to_attribute.labels
+
+          result = nil
+          catch :found_value do
+            labels.each do |l|
+              vals.each do |v|
+                throw :found_value if result
+                result = begin
+                           l.find_value_uri(v)
+                         rescue
+                           nil
+                         end
+              end
+            end
+          end
+          fail "Unable to find replacement for #{a_uri}" unless result
+          [a_uri, id, result]
+        end
+        replaceable_vals.map { |a, id, r| ["#{a}/elements?id=#{id}", r] }
+      end
+    end
+
+    metadata_property_reader :uri, :identifier, :title, :summary, :tags, :category
+    metadata_property_writer :tags, :summary, :title, :identifier
+
+    def initialize(data)
+      @json = data.to_hash
+    end
+
+    def add_tag(a_tag)
+      self.tags = tag_set.add(a_tag).to_a.join(' ')
+      self
+    end
+
+    def delete
+      if saved? # rubocop:disable Style/GuardClause
+        client.delete(uri)
+        meta.delete('uri')
+      end
+    end
+
+    def reload!
+      @json = client.get(uri) if saved?
+      self
+    end
+
+    alias_method :refresh, :reload!
+
+    def browser_uri
+      client.connection.server_url + meta['uri']
+    end
+
+    def deprecated
+      meta['deprecated'] == '1' || get_flag?('deprecated')
+    end
+    alias_method :deprecated?, :deprecated
+
+    def deprecated=(flag)
+      if flag == '1' || flag == 1 || flag == true
+        meta['deprecated'] = '1'
+      elsif flag == '0' || flag == 0 || flag == false # rubocop:disable Style/NumericPredicate
+        meta['deprecated'] = '0'
+      else
+        fail 'You have to provide flag as either 1 or "1" or 0 or "0" or true/false'
+      end
+
+      set_flag('deprecated', flag)
+    end
+
+    def production
+      meta['isProduction'] == '1' || get_flag?('production')
+    end
+    alias_method :production?, :production
+
+    def production=(flag)
+      if flag
+        meta['isProduction'] = '1'
+      else
+        meta['isProduction'] == '0'
+      end
+
+      set_flag('production', flag)
+    end
+
+    def restricted
+      get_flag?('restricted')
+    end
+    alias_method :restricted?, :restricted
+
+    def restricted=(flag)
+      set_flag('restricted', flag)
+    end
+
+    def project
+      @project ||= Project[uri.gsub(%r{\/obj\/\d+$}, ''), :client => client]
+    end
+
+    # Method used for replacing objects like Attribute, Fact or Metric. Returns new object of the same type.
+    #
+    # @param [GoodData::MdObject] what Object that should be replaced
+    # @param [GoodData::MdObject] for_what Object it is replaced with
+    # @return [GoodData::Metric]
+    def replace(mapping)
+      GoodData::MdObject.replace_quoted(self, mapping)
+    end
+
+    # Method used for replacing objects like Attribute, Fact or Metric. Returns itself mutated.
+    # @param [GoodData::MdObject] what Object that should be replaced
+    # @param [GoodData::MdObject] for_what Object it is replaced with
+    # @return [GoodData::Metric]
+    def replace!(mapping)
+      x = replace(mapping)
+      @json = x.json
+      self
+    end
+
+    def remove_tag(a_tag)
+      self.tags = tag_set.delete(a_tag).to_a.join(' ')
+      self
+    end
+
+    def save
+      fail('Validation failed') unless validate
+
+      opts = {
+        :client => client,
+        :project => project
+      }
+
+      if saved?
+        client.put(uri, to_json)
+      else
+        explicit_identifier = meta['identifier']
+        # Pre-check to provide a user-friendly error rather than
+        # failing later
+        klass = self.class
+        if explicit_identifier && klass[explicit_identifier, opts]
+          fail "Identifier '#{explicit_identifier}' already in use"
+        end
+
+        req_uri = project.md['obj']
+        result = client.post(req_uri, to_json)
+        saved_object = self.class[result['uri'], opts]
+        # TODO: add test for explicitly provided identifier
+
+        @json = saved_object.json
+        if explicit_identifier
+          # Object creation API discards the identifier. If an identifier
+          # was explicitely provided in the origina object, we need to set
+          # it explicitly with an extra PUT call.
+          meta['identifier'] = explicit_identifier
+          begin
+            client.put(uri, to_json)
+          rescue => e
+            # Cannot change the identifier (perhaps because it's in use
+            # already?), cleaning up.
+            client.delete(uri)
+            raise e
+          end
+        end
+      end
+      self
+    end
+
+    # Saves an object with a different name
+    #
+    # @param new_title [String] New title. If not provided one is provided
+    # @return [GoodData::MdObject] MdObject that has been saved as
+    def save_as(new_title = nil)
+      new_title = "Clone of #{title}" if new_title.nil?
+      # rubocop:disable Security/MarshalLoad
+      dupped = Marshal.load(Marshal.dump(json))
+      # rubocop:enable Security/MarshalLoad
+      dupped[root_key]['meta'].delete('uri')
+      dupped[root_key]['meta'].delete('identifier')
+      dupped[root_key]['meta']['title'] = new_title
+      x = client.create(self.class, dupped, :project => project)
+      x.save
+    end
+
+    def tag_set
+      tags.split.to_set
+    end
+
+    def ==(other)
+      other.respond_to?(:uri) && other.uri == uri && other.respond_to?(:to_hash) && other.to_hash == to_hash
+    end
+
+    def listed?
+      !unlisted?
+    end
+
+    def unlisted
+      meta['unlisted'] == '1'
+    end
+    alias_method :unlisted?, :unlisted
+
+    def unlisted=(flag)
+      if flag == true
+        meta['unlisted'] = '1'
+      elsif flag == false
+        meta['unlisted'] = '0'
+      else
+        fail 'You have to provide flag as either true or false'
+      end
+    end
+
+    def validate
+      true
+    end
+
+    def get_flag?(flag)
+      meta['flags'] && meta['flags'].include?(flag)
+    end
+    alias_method :has_flag?, :get_flag?
+
+    def set_flag(flag, value)
+      meta['flags'] = [] unless meta['flags']
+
+      if (value == '1' || value == 1 || value == true) && !has_flag?(flag)
+        meta['flags'].push(flag)
+        meta['flags'].sort!
+      elsif !value && has_flag?(flag)
+        meta['flags'].delete(flag)
+      end
+    end
+  end
+end