metaforce 0.5.0 → 0.5.1

data/Gemfile

@@ -1,4 +1,6 @@
 source "http://rubygems.org"
+gem 'highline'
+gem 'thor'
 
 # Specify your gem's dependencies in metaforce.gemspec
 gemspec

data/README.md

@@ -61,6 +61,10 @@ feature on a new branch, then send me a pull request with a detailed
 description. Please provide applicable rspec specs.
 
 ## Version History
+**HEAD**
+
+* Add thor integration.
+
 **0.5.0** (March 23, 2012)
 
 * Implemented CRUD calls.

data/bin/metaforce

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require './lib/metaforce/thor/metaforce'
+
+MetaForce.new :shell => Thor::Shell::Color.new
+MetaForce.start

data/lib/metaforce.rb

@@ -5,3 +5,5 @@ require 'metaforce/error'
 require 'metaforce/manifest'
 require 'metaforce/services'
 require 'metaforce/metadata'
+require 'metaforce/custom_actions'
+require 'metaforce/login_details'

data/lib/metaforce/core_extensions/string.rb

@@ -2,6 +2,13 @@ module Metaforce
   module CoreExtensions
     module String
 
+      def camelcase
+        str = dup
+        str.gsub!(/^[a-z]|_[a-z]/) { |a| a.upcase }
+        str.gsub!('_', '')
+        str
+      end unless method_defined?(:camelcase)
+
       def lower_camelcase
         str = dup
         str.gsub!(/_[a-z]/) { |a| a.upcase }

data/lib/metaforce/custom_actions.rb

@@ -0,0 +1,29 @@
+class Thor
+	module Actions
+		module CustomActions
+			require 'highline'
+
+			def masked_ask(question)
+				password = HighLine.new.ask(question) { |q| q.echo = '*' }
+			end
+
+			def spinner(&block)
+				return unless block_given?
+				chars = %w{ | / - \\ }
+
+				t = Thread.new { yield if block_given? }
+				while t.alive?
+					print chars[0]
+					sleep 0.1
+					print "\b"
+
+					chars.push chars.shift
+				end
+
+				t.join
+				t.value
+			end
+
+		end
+	end
+end

data/lib/metaforce/login_details.rb

@@ -0,0 +1,28 @@
+class LoginDetails 
+	require 'yaml'
+
+	attr_accessor :username, :password, :security_token, :sandbox, :log
+	STORAGE_LOCATION = "#{Dir.pwd}/.git/force.com.config"
+
+	def initialize(user, pass, security_token, sandbox, log = nil)
+		@username 		= user
+		@password 		= pass
+		@security_token = security_token
+		@sandbox 		= sandbox
+		@log 			= log
+	end
+
+	def save!
+		File.open(STORAGE_LOCATION, "w+") do |file|
+			file.print Marshal::dump(self)
+		end
+	end
+
+	def self.load
+		$/="---_---" #record separator
+		File.open(STORAGE_LOCATION, "r") do |object|
+			return Marshal::load(object)
+		end
+	end
+
+end

data/lib/metaforce/metadata/client.rb

@@ -178,7 +178,7 @@ module Metaforce
             :retrieve_request => options[:options] || {}
           }
         end
-        Transaction.retrieval self, response[:retrieve_response][:result][:id]
+        Transaction.retrieval(self, response[:retrieve_response][:result][:id])
       end
 
       # Retrieves files specified in the manifest file (package.xml). Specificy any extra options in +options[:options]+.

data/lib/metaforce/services/client.rb

@@ -20,25 +20,66 @@ module Metaforce
           :security_token => Metaforce.configuration.security_token
         } if options.nil?
         @session = self.login(options[:username], options[:password], options[:security_token])
+
+        @client = Savon::Client.new File.expand_path("../../../../wsdl/#{Metaforce.configuration.api_version}/partner.xml", __FILE__) do |wsdl|
+          wsdl.endpoint = @session[:services_url]
+        end
+        @client.http.auth.ssl.verify_mode = :none
+        @header = {
+            "ins0:SessionHeader" => {
+              "ins0:sessionId" => @session[:session_id]
+            }
+        }
       end
 
       # Performs a login and sets @session
       def login(username, password, security_token=nil)
         password = "#{password}#{security_token}" unless security_token.nil?
-        client = Savon::Client.new File.expand_path("../../../../wsdl/#{Metaforce.configuration.api_version}/partner.xml", __FILE__) do |wsdl|
+        @client = Savon::Client.new File.expand_path("../../../../wsdl/#{Metaforce.configuration.api_version}/partner.xml", __FILE__) do |wsdl|
           wsdl.endpoint = wsdl.endpoint.to_s.sub(/login/, 'test') if Metaforce.configuration.test
           Metaforce.log("Logging in via #{wsdl.endpoint.to_s}")
         end
-        client.http.auth.ssl.verify_mode = :none
+        @client.http.auth.ssl.verify_mode = :none
 
-        response = client.request(:login) do
+        response = @client.request(:login) do
           soap.body = {
             :username => username,
             :password => password
           }
         end
         { :session_id => response.body[:login_response][:result][:session_id],
-          :metadata_server_url =>  response.body[:login_response][:result][:metadata_server_url] }
+          :metadata_server_url =>  response.body[:login_response][:result][:metadata_server_url],
+          :services_url => response.body[:login_response][:result][:server_url] }
+      end
+
+      # Returns the layout metadata for the sobject.
+      # If a +record_type_id+ is passed in, it will only return the layout for
+      # that record type.
+      #
+      # This method is really useful finding out picklist values that are
+      # available for a certain record type
+      #
+      # == Examples
+      #
+      #   @picklists_for_record_type = client.describe_layout('Account', '0123000000100Rn')[:record_type_mappings][:picklists_for_record_type]
+      #
+      #   def picklist_values_for(field)
+      #     picklist_values = @picklists_for_record_type.select { |f| f[:picklist_name] == field }.first[:picklist_values]
+      #     picklist_values.select { |p| p[:active] }.collect { |p| [ p[:label], p[:value] ] }
+      #   end
+      #
+      #   picklist_values_for('some_field__c')
+      #   # => [ ['label1', 'value1'], ['label2', 'value2'] ] 
+      def describe_layout(sobject, record_type_id=nil)
+        body = {
+          'sObjectType' => sobject
+        }
+        body['recordTypeID'] = record_type_id if record_type_id
+        response = @client.request(:describe_layout) do |soap|
+          soap.header = @header
+          soap.body = body
+        end
+        response.body[:describe_layout_response][:result]
       end
     end
   end

data/lib/metaforce/thor/metaforce.rb

@@ -0,0 +1,117 @@
+require 'thor' #should probably be in say, lib/metaforce.rb, but I don't want to make that decision alone.
+
+class MetaForce < Thor
+	include Thor::Actions
+	require './lib/metaforce/custom_actions'
+	require './lib/metaforce/login_details'
+	require './lib/metaforce'
+	include Thor::Actions::CustomActions
+
+	######## Tasks ############################################################
+	desc "login", "accepts login parameters and completes a soap call to salesforce via the partner api."
+	method_option :reset, :type => :boolean, :aliases => "-r", :required => false, :banner => " Reset stored login information"
+	def login
+		if ((File.exists? LoginDetails::STORAGE_LOCATION) && (options[:reset].nil?))
+			say "Using stored login information"
+			@login_details = LoginDetails.load
+		else
+			login_email 			= ask "Login Email address: "
+			sandbox					= yes? "Is this a sandbox org login: "
+			login_pass  			= masked_ask "Login Password: "
+			login_security_token	= masked_ask "Security Token: "
+			say "If you'd like I can save this login information to this directories .git/config/force.com.config"
+			say "----- PLEASE NOTE, HOWEVER, THAT SAVING THIS INFORMATION IS INSECURE AND IS IN NO WAY ENCRYPTED"
+			save 					= yes? "Should I save this Login information? (y/n) "
+
+			if save
+				@login_details = LoginDetails.new(login_email, login_pass, login_security_token, sandbox)
+				@login_details.save!
+			else
+				@login_details = LoginDetails.new(login_email, login_pass, login_security_token, sandbox)
+			end
+		end
+
+		raise "Failed to find viable login information!" if @login_details.nil?
+		Metaforce.log = @login_details.log
+		Metaforce.configuration.test = @login_details.sandbox
+		@client = Metaforce::Metadata::Client.new :username => @login_details.username,
+		:password => @login_details.password,
+		:security_token => @login_details.security_token
+	end	
+	
+	######## Deploy ###########################################################
+	desc "deploy", "deploys the current working directory's src folder to salesforce"
+	method_option :dir, :type => :string, :aliases => "-d", :required => true, :default => "src", :banner => "Specify the directory to deploy"
+	method_option :reset, :type => :boolean, :aliases => "-r", :required => false, :banner => " Reset stored login information"
+	def deploy
+		login unless @client
+		login unless options[:reset].nil?
+		raise "failed to create connection!" unless @client
+		deploy_results = @client.deploy(options[:dir]).result
+		say "Deploy Successful!", color = Thor::Shell::Color::GREEN if deploy_results[:success]
+	end
+
+	######## RunTests #########################################################
+	desc "test", "runs _all_ salesforce unit tests!"
+	method_option :dir, :type => :string, :aliases => "-d", :required => true, :default => "src", :banner => "Specify the directory to execute tests"
+	method_option :reset, :type => :boolean, :aliases => "-r", :required => false, :banner => " Reset stored login information"
+	def test
+		login unless @client
+		login unless options[:reset].nil?
+		raise "failed to create connection!" unless @client
+		result = spinner {
+			result = @client.deploy(options[:dir], :options => { :run_all_tests => true }).result
+		}
+		failures = result[:run_test_result][:failures]
+		if failures
+			failures = [failures] unless failures.responds_to? :each
+			say "--- FAILURES: ", color = Thor::Shell::Color::RED
+			failures.each_with_index do |f,i|
+				say "#{"-" * 80}", color = Thor::Shell::Color::YELLOW
+				say ""
+				say "\t(#{index +1}) #{failure[:method_name]}"
+				say "\t\t#{failure[:message]}", color = Thor::Shell::Color::RED
+				say ""
+				say "\t\t#{failure[:stack_trace]}", color => Thor::Shell::Color::MAGENTA
+				say ""
+			end
+		end
+
+		color = (failures) ? Thor::Shell::Color::RED : Thor::Shell::Color::GREEN
+		say "Finished in #{Float(result[:run_test_result][:total_time]) / 100} seconds"
+		say "#{result[:run_test_result][:num_tests_run]} tests, #{result[:run_test_result][:num_failures]} failures", color = color
+	end
+
+	######## Pull #############################################################
+	desc "pull", "Pull all MetaData objects specified in the package.xml file"
+	method_option :reset, :type => :boolean, :aliases => "-r", :required => false, :banner => " Reset stored login information"
+	method_option :manifest, :type => :string, :aliases => "-m", :required => true, :banner => " Path to Manifest.xml", :default => "src/package.xml"
+	method_option :dir, :type => :string, :aliases => "-d", :required => false, :banner => " Download to directory", :default => "retrieved"
+	def pull
+		login unless @client
+		login unless options[:reset].nil?
+		raise "failed to create connection!" unless @client
+		result = spinner {
+			@client.retrieve_unpackaged(options[:manifest]).to(options[:dir])
+		}
+        say "Files retrieved sucessfully to #{@directory}", color = Thor::Shell::Color::GREEN
+	end
+
+	######## Clone ############################################################
+	desc "clone", "Pull all MetaData objects from the current org"
+	method_option :reset, :type => :boolean, :aliases => "-r", :required => false, :banner => " Reset stored login information"
+	method_option :dir, :type => :string, :aliases => "-d", :required => true, :banner => " Download to directory", :default => "retrieved"
+	def clone
+		login unless @client
+		login unless options[:reset].nil?
+		raise "failed to create connection!" unless @client
+		result = spinner {
+			metadata_objects = Hash.new
+			@client.metadata_objects.collect { |t| metadata_objects[t[:xml_name].underscore.to_sym] = ["*"] }
+			md = Metaforce::Manifest.new(metadata_objects)
+			@client.retrieve_unpackaged(md).to(options[:dir])
+		}
+    say "Files retrieved sucessfully to #{options[:dir]}", color = Thor::Shell::Color::GREEN
+	end
+
+end

data/lib/metaforce/types.rb

@@ -32,10 +32,10 @@ module Metaforce
           :folder => "objects",
           :plural => :action_overrides
         },
-        :analytics_snapshot => {
+        :analytic_snapshot => {
           :name => "AnalyticsSnapshot",
           :folder => "analyticsnapshots",
-          :plural => :analytics_snapshots
+          :plural => :analytic_snapshots
         },
         :apex_class => {
           :name => "ApexClass",
@@ -142,6 +142,11 @@ module Metaforce
           :folder => "homePageComponents",
           :plural => :home_page_components
         },
+        :home_page_layout => {
+          :name => "HomePageLayout",
+          :folder => "HomePageLayouts",
+          :plural => :home_page_layouts
+        }, 
         :layout => {
           :name => "Layout",
           :folder => "layouts",
@@ -197,10 +202,10 @@ module Metaforce
           :folder => "reportTypes",
           :plural => :report_types
         },
-        :scontroler => {
-          :name => "Scontroler",
+        :scontrol => {
+          :name => "scontrol",
           :folder => "scontrols",
-          :plural => :scontrolers
+          :plural => :scontrols
         },
         :sharing_reason => {
           :name => "SharingReason",

data/lib/metaforce/version.rb

@@ -1,3 +1,3 @@
 module Metaforce
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/metaforce.gemspec

@@ -5,8 +5,8 @@ require "metaforce/version"
 Gem::Specification.new do |s|
   s.name        = "metaforce"
   s.version     = Metaforce::VERSION
-  s.authors     = ["Eric J. Holmes"]
-  s.email       = ["eric@ejholmes.net"]
+  s.authors     = ["Eric J. Holmes", "Kevin J. Poorman"]
+  s.email       = ["eric@ejholmes.net", "Kevinp@madronasg.com"]
   s.homepage    = "https://github.com/ejholmes/metaforce"
   s.summary     = %q{A Ruby gem for interacting with the Salesforce Metadata API}
   s.description = %q{A Ruby gem for interacting with the Salesforce Metadata API}

data/spec/lib/config_spec.rb

@@ -34,7 +34,8 @@ describe Metaforce do
         savon.expects(:login).with(:username => 'valid', :password => 'password').returns(:success)
         session = Metaforce::Services::Client.new.session
         session.should eq({ :session_id => "00DU0000000Ilbh!AQoAQHVcube9Z6CRlbR9Eg8ZxpJlrJ6X8QDbnokfyVZItFKzJsLHIRGiqhzJkYsNYRkd3UVA9.s82sbjEbZGUqP3mG6TP_P8",
-                            :metadata_server_url => "https://na12-api.salesforce.com/services/Soap/m/23.0/00DU0000000Albh" })
+                            :metadata_server_url => "https://na12-api.salesforce.com/services/Soap/m/23.0/00DU0000000Albh",
+                            :services_url => "https://na12-api.salesforce.com/services/Soap/u/23.0/00DU0000000Ilbh" })
       end
 
       it "allows you to set the credentials via the configure block" do

data/spec/lib/services/client_spec.rb

@@ -16,7 +16,8 @@ describe Metaforce::Services::Client do
         savon.expects(:login).with(:username => 'valid', :password => 'password').returns(:success)
         session = Metaforce::Services::Client.new(:username => 'valid', :password => 'password').session
         session.should eq({ :session_id => "00DU0000000Ilbh!AQoAQHVcube9Z6CRlbR9Eg8ZxpJlrJ6X8QDbnokfyVZItFKzJsLHIRGiqhzJkYsNYRkd3UVA9.s82sbjEbZGUqP3mG6TP_P8",
-                            :metadata_server_url => "https://na12-api.salesforce.com/services/Soap/m/23.0/00DU0000000Albh" })
+                            :metadata_server_url => "https://na12-api.salesforce.com/services/Soap/m/23.0/00DU0000000Albh",
+                            :services_url=>"https://na12-api.salesforce.com/services/Soap/u/23.0/00DU0000000Ilbh" })
       end
 
     end
@@ -25,7 +26,8 @@ describe Metaforce::Services::Client do
         savon.expects(:login).with(:username => 'valid', :password => 'password').returns(:success)
         session = Metaforce::Services::Client.new("username" => 'valid', "password" => 'password').session
         session.should eq({ :session_id => "00DU0000000Ilbh!AQoAQHVcube9Z6CRlbR9Eg8ZxpJlrJ6X8QDbnokfyVZItFKzJsLHIRGiqhzJkYsNYRkd3UVA9.s82sbjEbZGUqP3mG6TP_P8",
-                            :metadata_server_url => "https://na12-api.salesforce.com/services/Soap/m/23.0/00DU0000000Albh" })
+                            :metadata_server_url => "https://na12-api.salesforce.com/services/Soap/m/23.0/00DU0000000Albh",
+                            :services_url=>"https://na12-api.salesforce.com/services/Soap/u/23.0/00DU0000000Ilbh" })
       end
     end
   end

metadata

@@ -1,19 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: metaforce
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
 - Eric J. Holmes
+- Kevin J. Poorman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-23 00:00:00.000000000 Z
+date: 2012-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70320535767740 !ruby/object:Gem::Requirement
+  requirement: &70207844341860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +22,10 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70320535767740
+  version_requirements: *70207844341860
 - !ruby/object:Gem::Dependency
   name: savon
-  requirement: &70320535767240 !ruby/object:Gem::Requirement
+  requirement: &70207844341360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +33,10 @@ dependencies:
         version: 0.9.7
   type: :runtime
   prerelease: false
-  version_requirements: *70320535767240
+  version_requirements: *70207844341360
 - !ruby/object:Gem::Dependency
   name: rubyzip
-  requirement: &70320535744500 !ruby/object:Gem::Requirement
+  requirement: &70207844340900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +44,10 @@ dependencies:
         version: 0.9.5
   type: :runtime
   prerelease: false
-  version_requirements: *70320535744500
+  version_requirements: *70207844340900
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
-  requirement: &70320535744120 !ruby/object:Gem::Requirement
+  requirement: &70207844340520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +55,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70320535744120
+  version_requirements: *70207844340520
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70320535743580 !ruby/object:Gem::Requirement
+  requirement: &70207844340060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70320535743580
+  version_requirements: *70207844340060
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70320535743020 !ruby/object:Gem::Requirement
+  requirement: &70207708128940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70320535743020
+  version_requirements: *70207708128940
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70320535742560 !ruby/object:Gem::Requirement
+  requirement: &70207708128520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +88,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70320535742560
+  version_requirements: *70207708128520
 - !ruby/object:Gem::Dependency
   name: savon_spec
-  requirement: &70320535742000 !ruby/object:Gem::Requirement
+  requirement: &70207708128020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,11 +99,13 @@ dependencies:
         version: 0.1.6
   type: :development
   prerelease: false
-  version_requirements: *70320535742000
+  version_requirements: *70207708128020
 description: A Ruby gem for interacting with the Salesforce Metadata API
 email:
 - eric@ejholmes.net
-executables: []
+- Kevinp@madronasg.com
+executables:
+- metaforce
 extensions: []
 extra_rdoc_files: []
 files:
@@ -112,11 +115,14 @@ files:
 - Guardfile
 - README.md
 - Rakefile
+- bin/metaforce
 - lib/metaforce.rb
 - lib/metaforce/config.rb
 - lib/metaforce/core_extensions.rb
 - lib/metaforce/core_extensions/string.rb
+- lib/metaforce/custom_actions.rb
 - lib/metaforce/error.rb
+- lib/metaforce/login_details.rb
 - lib/metaforce/manifest.rb
 - lib/metaforce/metadata.rb
 - lib/metaforce/metadata/client.rb
@@ -131,6 +137,7 @@ files:
 - lib/metaforce/services/client.rb
 - lib/metaforce/tasks/README.md
 - lib/metaforce/tasks/metaforce.rake
+- lib/metaforce/thor/metaforce.rb
 - lib/metaforce/types.rb
 - lib/metaforce/version.rb
 - metaforce.gemspec