mdata 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb30d8e4bfb780f9646c13b55283838aec62116b
-  data.tar.gz: 131491a48e2859fdcb9fd6fe069258b987996542
+  metadata.gz: faff685b0e5287c5c54d944f31011ca28d113241
+  data.tar.gz: 12e1cfd3508ba85da9372d305202c1af962c7a7c
 SHA512:
-  metadata.gz: 1ba3b975c4f20280b21234a5ca2c447bb7c43350d0ca0752fe73306d5fb99e0da34d7b02d039242ba8306008182b56786eab68cf29132f840b5b7063955c2eae
-  data.tar.gz: 0bc5a2faf3395705495289ac1a9816ea8d19023d6c1a0ceb18b3af8ef00b83d13726bed29baa3d2e198eda559177ed2482c441332125ede84a69b35f73b15b4b
+  metadata.gz: 0ef8902458d53e2c807f321417cf88d0cfe167602c248fe22efc26e534015688b36805f9f85204109cb5377eb1dbec58d5292d5d151e6387db0e03fc125a2446
+  data.tar.gz: 4b63b2a5e5dc49d42946ae6d2a1cc2cce2cdf22929d977c51fb762d952c64b13845c1d9a4ecae4c9f6a0b07c1bbbce362f8f0a82ce165b0a9fd4cce782264699

data/bin/mdata

@@ -5,7 +5,7 @@ require 'commander/import'
 require 'mdata/metadata'
 require 'terminal-table'
 
-program :version, '1.1.0'
+program :version, '1.2.0'
 program :description, 'Your Salesforce metadata navigator and manipulator'
 program :help, 'Author', 'Ben Burwell <ben.burwell@trifecta.com>'
 
@@ -385,6 +385,274 @@ command :'profile classAccess:copy' do |c|
 	end
 end
 
+command :'profile objectPermissions:read' do |c|
+	c.syntax = 'mdata profile objectPermissions:read --profile PROFILE [options]'
+	c.summary = 'Read object permissions from a profile'
+	c.option '--profile PROFILE', String, 'The profile to examine'
+	c.option '--object OBJECT', String, 'Optionally, an object to look for'
+	c.action do |args, opts|
+		begin
+			raise ArgumentError, 'no profile specified' if opts.profile.nil?
+			profile = Salesforce::Metadata::Profile.read opts.profile, opts.dir
+			profile.objectPermissions.keep_if { |x| x.object == opts.object } unless opts.object.nil?
+			profile.objectPermissions.sort! { |a, b| a.object <=> b.object }
+			rows = []
+			profile.objectPermissions.each do |fp|
+				rows << [ fp.object, fp.to_flag_style ]
+			end
+			table = Terminal::Table.new :rows => rows, :headings => ['Object', 'Permissions']
+			puts table
+		rescue ArgumentError => e
+			puts "Error executing command: #{e.message}"
+		end
+	end
+end
+
+# Profile - Object Permissions - Set
+command :'profile objectPermissions:set' do |c|
+  c.syntax = 'mdata profile objectPermissions:set --profile PROFILE --object OBJECT [options]'
+  c.summary = 'Overwrites any existing permissions for the object on the profile with the ones specified'
+  c.option '--profile PROFILE', String, 'The profile to configure'
+  c.option '--object OBJECT', String, 'The object to assign permissions for'
+  c.option '--allowCreate', 'Set the allowCreate permission'
+  c.option '--allowEdit', 'Set the allowEdit permission'
+  c.option '--allowRead', 'Set the allowRead permission'
+  c.option '--allowDelete', 'Set the allowDelete permission'
+  c.option '--modifyAllRecords', 'Set the modifyAllRecords permission'
+  c.option '--viewAllRecords', 'Set the viewAllRecords permission'
+  c.action do |args, opts|
+  	begin
+      raise ArgumentError, 'no profile specified' if opts.profile.nil?
+			raise ArgumentError, 'no object specified' if opts.object.nil?
+			profile = Salesforce::Metadata::Profile.read opts.profile, opts.dir
+			idx = profile.objectPermissions.find_index { |x| x.object == opts.object }
+			
+			if idx.nil?
+				op = Salesforce::Types::ProfileObjectPermissions.new
+				op.object = opts.object
+				profile.objectPermissions.push op
+				idx = profile.objectPermissions.count - 1
+			end
+
+			profile.objectPermissions[idx].allowCreate = case opts.allowCreate
+				when nil then 'false'
+				else 'true'
+			end
+			profile.objectPermissions[idx].allowEdit = case opts.allowEdit
+				when nil then 'false'
+				else 'true'
+			end
+			profile.objectPermissions[idx].allowRead = case opts.allowRead
+				when nil then 'false'
+				else 'true'
+			end
+			profile.objectPermissions[idx].allowDelete = case opts.allowDelete
+				when nil then 'false'
+				else 'true'
+			end
+			profile.objectPermissions[idx].modifyAllRecords = case opts.modifyAllRecords
+				when nil then 'false'
+				else 'true'
+			end
+			profile.objectPermissions[idx].viewAllRecords = case opts.viewAllRecords
+				when nil then 'false'
+				else 'true'
+			end
+			profile.save
+    rescue ArgumentError => e
+    	puts "Error executing command: #{e.message}"
+    end
+  end
+end
+
+# Profile - Object Permissions - Grant
+command :'profile objectPermissions:grant' do |c|
+  c.syntax = 'mdata profile objectPermissions:grant --profile PROFILE --object OBJECT [options]'
+  c.summary = 'Grant permissions on an object to a profile'
+  c.option '--profile PROFILE', String, 'The profile to configure'
+  c.option '--object OBJECT', String, 'The object to assign permissions for'
+  c.option '--allowCreate', 'Grant the allowCreate permission'
+  c.option '--allowEdit', 'Grant the allowEdit permission'
+  c.option '--allowRead', 'Grant the allowRead permission'
+  c.option '--allowDelete', 'Grant the allowDelete permission'
+  c.option '--modifyAllRecords', 'Grant the modifyAllRecords permission'
+  c.option '--viewAllRecords', 'Grant the viewAllRecords permission'
+  c.action do |args, opts|
+  	begin
+      raise ArgumentError, 'no profile specified' if opts.profile.nil?
+			raise ArgumentError, 'no object specified' if opts.object.nil?
+			profile = Salesforce::Metadata::Profile.read opts.profile, opts.dir
+			idx = profile.objectPermissions.find_index { |x| x.object == opts.object }
+			
+			if idx.nil?
+				op = Salesforce::Types::ProfileObjectPermissions.new
+				op.object = opts.object
+				profile.objectPermissions.push op
+				idx = profile.objectPermissions.count - 1
+			end
+
+			profile.objectPermissions[idx].allowCreate = 'true' unless opts.allowCreate.nil?
+			profile.objectPermissions[idx].allowEdit = 'true' unless opts.allowEdit.nil?
+			profile.objectPermissions[idx].allowRead = 'true' unless opts.allowRead.nil?
+			profile.objectPermissions[idx].allowDelete = 'true' unless opts.allowDelete.nil?
+			profile.objectPermissions[idx].modifyAllRecords = 'true' unless opts.modifyAllRecords.nil?
+			profile.objectPermissions[idx].viewAllRecords = 'true' unless opts.viewAllRecords.nil?
+			profile.save
+    rescue ArgumentError => e
+    	puts "Error executing command: #{e.message}"
+    end
+  end
+end
+
+# Profile - Object Permissions - Revoke
+command :'profile objectPermissions:revoke' do |c|
+  c.syntax = 'mdata profile objectPermissions:revoke --profile PROFILE --object OBJECT [options]'
+  c.summary = 'Revoke permissions on an object from a profile'
+  c.option '--profile PROFILE', String, 'The profile to configure'
+  c.option '--object OBJECT', String, 'The object to assign permissions for'
+  c.option '--allowCreate', 'Revoke the allowCreate permission'
+  c.option '--allowEdit', 'Revoke the allowEdit permission'
+  c.option '--allowRead', 'Revoke the allowRead permission'
+  c.option '--allowDelete', 'Revoke the allowDelete permission'
+  c.option '--modifyAllRecords', 'Revoke the modifyAllRecords permission'
+  c.option '--viewAllRecords', 'Revoke the viewAllRecords permission'
+  c.action do |args, opts|
+  	begin
+      raise ArgumentError, 'no profile specified' if opts.profile.nil?
+			raise ArgumentError, 'no object specified' if opts.object.nil?
+			profile = Salesforce::Metadata::Profile.read opts.profile, opts.dir
+			idx = profile.objectPermissions.find_index { |x| x.object == opts.object }
+			
+			if idx.nil?
+				op = Salesforce::Types::ProfileObjectPermissions.new
+				op.object = opts.object
+				profile.objectPermissions.push op
+				idx = profile.objectPermissions.count - 1
+			end
+
+			profile.objectPermissions[idx].allowCreate = 'false' unless opts.allowCreate.nil?
+			profile.objectPermissions[idx].allowEdit = 'false' unless opts.allowEdit.nil?
+			profile.objectPermissions[idx].allowRead = 'false' unless opts.allowRead.nil?
+			profile.objectPermissions[idx].allowDelete = 'false' unless opts.allowDelete.nil?
+			profile.objectPermissions[idx].modifyAllRecords = 'false' unless opts.modifyAllRecords.nil?
+			profile.objectPermissions[idx].viewAllRecords = 'false' unless opts.viewAllRecords.nil?
+			profile.save
+    rescue ArgumentError => e
+    	puts "Error executing command: #{e.message}"
+    end
+  end
+end
+
+# Profile - Object Permissions - Delete
+command :'profile objectPermissions:delete' do |c|
+  c.syntax = 'mdata profile objectPermissions:delete --profile PROFILE --object OBJECT'
+  c.summary = 'Completely removes the permissions for a particular object. Useful if an object is deleted.'
+  c.option '--profile PROFILE', String, 'The profile to configure'
+  c.option '--object OBJECT', String, 'The object to delete permissions for'
+  c.action do |args, opts|
+  	begin
+      raise ArgumentError, 'no profile specified' if opts.profile.nil?
+			raise ArgumentError, 'no object specified' if opts.object.nil?
+			profile = Salesforce::Metadata::Profile.read opts.profile, opts.dir
+			profile.objectPermissions.delete_if { |x| x.object == opts.object }
+			profile.save
+    rescue ArgumentError => e
+    	puts "Error executing command: #{e.message}"
+    end
+  end
+end
+
+# Profile - Object Permissions - Copy
+command :'profile objectPermissions:copy' do |c|
+  c.syntax = 'mdata profile objectPermissions:copy --fromProfile PROFILE --toProfile PROFILE --fromObject OBJECT --toObject OBJECT [options]'
+  c.summary = 'Copies the specified permissions for an object from one profile to another'
+  c.description = [
+  	'Copies the permissions on fromProfile for the object fromObject to toObject on toProfile.',
+  	'',
+  	'If you are copying the permissions from one object to another on the same profile, you can use',
+  	'the --profile option rather than specifying the same --fromProfile and --toProfile.',
+  	'',
+  	'Likewise, if you are copying the permissions for an object from one profile to another, you can',
+  	'specify an --object rather than a --fromObject and --toObject.'
+  ].join("\n")
+  c.option '--fromProfile PROFILE', String, 'The source profile'
+  c.option '--toProfile PROFILE', String, 'The destination profile'
+  c.option '--profile PROFILE', String, 'A profile to use as the source and destination'
+  c.option '--fromObject OBJECT', String, 'The source object'
+  c.option '--toObject OBJECT', String, 'The destination object'
+  c.option '--object OBJECT', String, 'An object to use as the source and destination'
+  c.option '--all', 'Copy all permissions'
+  c.option '--allowCreate', 'Copy the allowCreate permission'
+  c.option '--allowEdit', 'Copy the allowEdit permission'
+  c.option '--allowRead', 'Copy the allowRead permission'
+  c.option '--allowDelete', 'Copy the allowDelete permission'
+  c.option '--modifyAllRecords', 'Copy the modifyAllRecords permission'
+  c.option '--viewAllRecords', 'Copy the viewAllRecords permission'
+  c.action do |args, opts|
+  	# Override options for helper options
+		opts.fromProfile = opts.profile if opts.profile
+		opts.toProfile = opts.profile if opts.profile
+		opts.fromObject = opts.object if opts.object
+		opts.toObject = opts.object if opts.object
+		opts.allowCreate = true if opts.all
+		opts.allowEdit = true if opts.all
+		opts.allowRead = true if opts.all
+		opts.allowDelete = true if opts.all
+		opts.modifyAllRecords = true if opts.all
+		opts.viewAllRecords = true if opts.all
+  	
+  	begin
+  		raise ArgumentError, 'no source profile specified' if opts.fromProfile.nil?
+  		raise ArgumentError, 'no destination profile specified' if opts.toProfile.nil?
+			raise ArgumentError, 'no source object specified' if opts.fromObject.nil?
+			raise ArgumentError, 'no destination object specified' if opts.toObject.nil?
+			
+			from_profile = Salesforce::Metadata::Profile.read opts.fromProfile, opts.dir
+			src_idx = from_profile.objectPermissions.find_index { |x| x.object == opts.fromObject }
+			raise ArgumentError, 'source object not found in source profile' if src_idx.nil?
+
+			to_profile = Salesforce::Metadata::Profile.read opts.toProfile, opts.dir
+			dst_idx = to_profile.objectPermissions.find_index { |x| x.object == opts.toObject }
+
+			if dst_idx.nil?
+				op = Salesforce::Types::ProfileObjectPermissions.new
+				op.object = opts.toObject
+				to_profile.objectPermissions.push op
+				dst_idx = to_profile.objectPermissions.count - 1
+			end
+
+			unless opts.allowCreate.nil?
+				val = from_profile.objectPermissions[src_idx].allowCreate
+				to_profile.objectPermissions[dst_idx].allowCreate = val
+			end
+			unless opts.allowEdit.nil?
+				val = from_profile.objectPermissions[src_idx].allowEdit
+				to_profile.objectPermissions[dst_idx].allowEdit = val
+			end
+			unless opts.allowRead.nil?
+				val = from_profile.objectPermissions[src_idx].allowRead
+				to_profile.objectPermissions[dst_idx].allowRead = val
+			end
+			unless opts.allowDelete.nil?
+				val = from_profile.objectPermissions[src_idx].allowDelete
+				to_profile.objectPermissions[dst_idx].allowDelete = val
+			end
+			unless opts.modifyAllRecords.nil?
+				val = from_profile.objectPermissions[src_idx].modifyAllRecords
+				to_profile.objectPermissions[dst_idx].modifyAllRecords = val
+			end
+			unless opts.viewAllRecords.nil?
+				val = from_profile.objectPermissions[src_idx].viewAllRecords
+				to_profile.objectPermissions[dst_idx].viewAllRecords = val
+			end
+
+			to_profile.save
+  	rescue ArgumentError => e
+    	puts "Error executing command: #{e.message}"
+    end
+  end
+end
+
 alias_command :'pr fp:r', :'profile fieldPermissions:read'
 alias_command :'pr fp:s', :'profile fieldPermissions:set'
 alias_command :'pr fp:g', :'profile fieldPermissions:grant'
@@ -397,3 +665,10 @@ alias_command :'pr ca:g', :'profile classAccess:grant'
 alias_command :'pr ca:v', :'profile classAccess:revoke'
 alias_command :'pr ca:d', :'profile classAccess:delete'
 alias_command :'pr ca:c', :'profile classAccess:copy'
+
+alias_command :'pr op:r', :'profile objectPermissions:read'
+alias_command :'pr op:s', :'profile objectPermissions:set'
+alias_command :'pr op:g', :'profile objectPermissions:grant'
+alias_command :'pr op:v', :'profile objectPermissions:revoke'
+alias_command :'pr op:c', :'profile objectPermissions:copy'
+alias_command :'pr op:d', :'profile objectPermissions:delete'

data/lib/mdata/types/ObjectPermissions.rb

@@ -16,6 +16,67 @@ module Salesforce
 			xml_accessor :modifyAllRecords
 			xml_accessor :object
 			xml_accessor :viewAllRecords
+
+			# Get an array of granted permissions
+			#
+			# @return [Array] an array of strings, like ['allowCreate', 'allowRead']
+			def get_permissions
+				permissions = []
+				permissions.push 'allowCreate' if @allowCreate == 'true'
+				permissions.push 'allowDelete' if @allowDelete == 'true'
+				permissions.push 'allowEdit' if @allowEdit == 'true'
+				permissions.push 'allowRead' if @allowRead == 'true'
+				permissions.push 'modifyAllRecords' if @modifyAllRecords == 'true'
+				permissions.push 'viewAllRecords' if @viewAllRecords == 'true'
+				permissions
+			end
+
+			# A Unix flag style representation of the permissions, suitable for
+			# printing in a table
+			#
+			# @return [String] the granted permissions
+			def to_flag_style
+				permissions = ''
+
+				if @allowCreate
+					permissions += 'allowCreate '
+				else
+					permissions += '            '
+				end
+
+				if @allowDelete
+					permissions += 'allowDelete '
+				else
+					permissions += '            '
+				end
+
+				if @allowEdit
+					permissions += 'allowEdit '
+				else
+					permissions += '          '
+				end
+
+				if @allowRead
+					permissions += 'allowRead '
+				else
+					permissions += '          '
+				end
+
+				if @modifyAllRecords
+					permissions += 'modifyAllRecords '
+				else
+					permissions += '                 '
+				end
+
+				if @viewAllRecords
+					permissions += 'viewAllRecords'
+				else
+					permissions += '              '
+				end
+
+				permissions
+			end
+
 		end
 
 		# See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profile.htm#profileobjectpermissions_title

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mdata
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Ben Burwell