mdata 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e3bbd437f56887d62ef25076a5b592e38adc217
-  data.tar.gz: fcd07349f0490723c12d3c50f383644d07d40914
+  metadata.gz: bb30d8e4bfb780f9646c13b55283838aec62116b
+  data.tar.gz: 131491a48e2859fdcb9fd6fe069258b987996542
 SHA512:
-  metadata.gz: 47797064e35bad49dd8b155eeb473c3be459c74cf8ba1f7b2104677c986889f6d0ca8029f7d775f32d68e8beb55f3b982c947114d8be7e3d2023208cfea86326
-  data.tar.gz: d2c9fc0697e1b24ae895493f5116a9a67c9fd9e7ad4430de9c969667caf2698784193e36b7766056c3fcdc542a19562e2fdd0165d879428e7d920c04918dd94a
+  metadata.gz: 1ba3b975c4f20280b21234a5ca2c447bb7c43350d0ca0752fe73306d5fb99e0da34d7b02d039242ba8306008182b56786eab68cf29132f840b5b7063955c2eae
+  data.tar.gz: 0bc5a2faf3395705495289ac1a9816ea8d19023d6c1a0ceb18b3af8ef00b83d13726bed29baa3d2e198eda559177ed2482c441332125ede84a69b35f73b15b4b

data/README.markdown

@@ -0,0 +1,55 @@
+# mdata
+
+`mdata` is a command line tool for interacting with Salesforce metadata XML files. To install, just use `gem install mdata`.
+
+You can get a list of options by running `mdata help`. By default, `mdata` looks in the right directory for the object. The general command format is:
+
+    mdata OBJECT PROPERTY:ACTION OPTIONS
+
+For example, running `mdata profile fieldPermissions:read --profile Admin` would look for a file named `./src/profiles/Admin.profile`. If you need to look in another directory, there is a global `--dir` option that you can set.
+
+Since these commands get long, there are also shortcuts. The two commands below are synonymous:
+
+    mdata profile fieldPermissions:read --profile Admin
+    mdata pr fp:r --profile Admin
+
+A full list of aliases is available by running `mdata help`.
+
+## Currently Supported Actions
+
+* Create a new profile
+* Read field permissions from a profile
+* Set field permissions for a field on a profile
+* Add field permissions to a field on a profile
+* Remove field permissions from a field on a profile
+* Copy field permissions from one field to another and/or one profile to another
+* Delete field permissions from a profile (e.g. field was deleted)
+
+## Contribute!
+
+Command you need isn't yet implemented? Add it!
+
+0. Top-level metadata object classes go in `lib/mdata/metadata`.
+0. Classes that encapsulate field types go in `lib/mdata/types`.
+0. Add your commands to the `bin/mdata` script using existing commands as an example.
+0. You may also want to add an alias down at the bottom of the script.
+0. Create unit tests in the `tests/` directory, and run `rake` to ensure they pass.
+
+## Making a release
+
+Making a release is not hard, but there are several steps. Perform these steps from the command line in the project directory.
+
+In this example, we will release version 0.0.0 of `mdata`. The version number should conform to semver standards.
+
+*Note: These are the ONLY changes that should be made in `master`, all others should be made in topic branches.*
+
+0. Create an entry in `CHANGELOG.markdown` for v0.0.0 and list the newly added features, fixed bugs, deprecated commands, etc.
+0. Make sure any newly-created files have been added to `mdata.gemspec` (if necessary)
+0. Run `rake`. **DO NOT PROCEED IF THERE ARE ERRORS/FAILURES.**
+0. Update the version to 0.0.0 in `bin/mdata`.
+0. Update the version to 0.0.0 in `mdata.gemspec`.
+0. `git add bin/mdata mdata.gemspec`
+0. `git commit -m "Bump version to 0.0.0"`
+0. `git tag -a v0.0.0 -m "Release version 0.0.0 to RubyGems"`
+0. `gem build mdata.gemspec`
+0. `gem push mdata-0.0.0.gem`

data/bin/mdata

@@ -5,7 +5,7 @@ require 'commander/import'
 require 'mdata/metadata'
 require 'terminal-table'
 
-program :version, '1.0.1'
+program :version, '1.1.0'
 program :description, 'Your Salesforce metadata navigator and manipulator'
 program :help, 'Author', 'Ben Burwell <ben.burwell@trifecta.com>'
 
@@ -244,9 +244,156 @@ command :'profile fieldPermissions:delete' do |c|
   end
 end
 
+# Profile - Class Access - Read
+command :'profile classAccess:read' do |c|
+	c.syntax = 'mdata profile classAccess:read --profile PROFILE [options]'
+	c.summary = 'View Apex class access for a profile'
+	c.option '--profile PROFILE', String, 'The profile to read'
+	c.option '--class CLASS', String, 'Optionally, a particular class 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.classAccesses.keep_if { |x| x.apexClass == opts.class } unless opts.class.nil?
+			profile.classAccesses.sort! { |a, b| a.apexClass <=> b.apexClass }
+			rows = []
+			profile.classAccesses.each do |cls|
+				rows << [ cls.apexClass, cls.enabled ]
+			end
+			table = Terminal::Table.new :rows => rows, :headings => ['Class', 'Enabled']
+			puts table
+    rescue ArgumentError => e
+    	puts "Error executing command: #{e.message}"
+    end
+  end
+end
+
+# Profile - Class Access - Grant
+command :'profile classAccess:grant' do |c|
+	c.syntax = 'mdata profile classAccess:grant --profile PROFILE --class CLASS [options]'
+	c.summary = 'Grant Apex class access for a profile'
+	c.option '--profile PROFILE', String, 'The profile to grant access on'
+	c.option '--class CLASS', String, 'The class to grant access to'
+	c.action do |args, opts|
+		begin
+			raise ArgumentError, 'no profile specified' if opts.profile.nil?
+			raise ArgumentError, 'no class specified' if opts.class.nil?
+			profile = Salesforce::Metadata::Profile.read opts.profile, opts.dir
+			idx = profile.classAccesses.find_index { |x| x.apexClass == opts.class }
+			if idx.nil?
+				ca = Salesforce::Types::ProfileApexClassAccess.new
+				ca.apexClass = opts.class
+				profile.classAccesses.push ca
+				idx = profile.classAccesses.count - 1
+			end
+			profile.classAccesses[idx].enabled = 'true'
+			profile.save
+		rescue ArgumentError => e
+			puts "Error executing command: #{e.message}"
+		end
+	end
+end
+
+# Profile - Class Access - Disable
+command :'profile classAccess:revoke' do |c|
+	c.syntax = 'mdata profile classAccess:revoke --profile PROFILE --class CLASS [options]'
+	c.summary = 'Revoke Apex class access for a profile'
+	c.option '--profile PROFILE', String, 'The profile to revoke access on'
+	c.option '--class CLASS', String, 'The class to revoke access to'
+	c.action do |args, opts|
+		begin
+			raise ArgumentError, 'no profile specified' if opts.profile.nil?
+			raise ArgumentError, 'no class specified' if opts.class.nil?
+			profile = Salesforce::Metadata::Profile.read opts.profile, opts.dir
+			idx = profile.classAccesses.find_index { |x| x.apexClass == opts.class }
+			if idx.nil?
+				ca = Salesforce::Types::ProfileApexClassAccess.new
+				ca.apexClass = opts.class
+				profile.classAccesses.push ca
+				idx = profile.classAccesses.count - 1
+			end
+			profile.classAccesses[idx].enabled = 'false'
+			profile.save
+		rescue ArgumentError => e
+			puts "Error executing command: #{e.message}"
+		end
+	end
+end
+
+# Profile - Class Access - Delete
+command :'profile classAccess:delete' do |c|
+	c.syntax = 'mdata profile classAccess:delete --profile PROFILE --class CLASS [options]'
+	c.summary = 'Delete Apex class access for a profile'
+	c.option '--profile PROFILE', String, 'The profile to delete access on'
+	c.option '--class CLASS', String, 'The class to delete access to'
+	c.action do |args, opts|
+		begin
+			raise ArgumentError, 'no profile specified' if opts.profile.nil?
+			raise ArgumentError, 'no class specified' if opts.class.nil?
+			profile = Salesforce::Metadata::Profile.read opts.profile, opts.dir
+			profile.classAccesses.delete_if { |x| x.apexClass == opts.class }
+			profile.save
+		rescue ArgumentError => e
+			puts "Error executing command: #{e.message}"
+		end
+	end
+end
+
+# Profile - Class Access - Copy
+command :'profile classAccess:copy' do |c|
+	c.syntax = 'mdata profile classAccess:copy [options]'
+	c.summary = 'Copy class access from one class to another or one profile to another.'
+	c.option '--fromProfile PROFILE', String, 'The profile to copy from'
+	c.option '--toProfile PROFILE', String, 'The profile to copy to'
+	c.option '--profile PROFILE', String, 'A shortcut for specifying the same source and destination profile'
+	c.option '--fromClass CLASS', String, 'The class to copy from'
+	c.option '--toClass CLASS', String, 'The class to copy to'
+	c.option '--class CLASS', String, 'A shortcut for specifying the same source and destination class'
+	c.action do |args, opts|
+		opts.fromProfile = opts.profile unless opts.profile.nil?
+		opts.toProfile = opts.profile unless opts.profile.nil?
+		opts.fromClass = opts.class unless opts.class.nil?
+		opts.toClass = opts.class unless opts.class.nil?
+
+		begin
+			raise ArgumentError, 'no source profile' if opts.fromProfile.nil?
+			raise ArgumentError, 'no destination profile' if opts.toProfile.nil?
+			raise ArgumentError, 'no source class' if opts.fromClass.nil?
+			raise ArgumentError, 'no destination class' if opts.toClass.nil?
+
+			from_profile = Salesforce::Metadata::Profile.read opts.fromProfile, opts.dir
+			src_idx = from_profile.classAccesses.find_index { |x| x.apexClass == opts.fromClass }
+			raise ArgumentError, 'source class not found in source profile' if src_idx.nil?
+
+			to_profile = Salesforce::Metadata::Profile.read opts.toProfile, opts.dir
+			dst_idx = to_profile.classAccesses.find_index { |x| x.apexClass == opts.toClass }
+
+			if dst_idx.nil?
+				ca = Salesforce::Types::ProfileApexClassAccess.new
+				ca.apexClass = opts.toClass
+				to_profile.classAccesses.push ca
+				dst_idx = to_profile.classAccesses.count - 1
+			end
+
+			val = from_profile.classAccesses[src_idx]
+			to_profile.classAccesses[dst_idx] = val
+
+			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'
 alias_command :'pr fp:v', :'profile fieldPermissions:revoke'
 alias_command :'pr fp:c', :'profile fieldPermissions:copy'
 alias_command :'pr fp:d', :'profile fieldPermissions:delete'
+
+alias_command :'pr ca:r', :'profile classAccess:read'
+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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mdata
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Ben Burwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-22 00:00:00.000000000 Z
+date: 2015-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -60,6 +60,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.markdown
 - lib/mdata.rb
 - lib/mdata/metadata.rb
 - lib/mdata/metadata/Profile.rb