metaforce 0.3.4 → 0.3.5

data/README.md

@@ -62,6 +62,8 @@ end
 This gem is far from being feature complete. Here's a list of things that still
 need to be done.
 
+* Implement command line utility that can watch the directory and deploy when a
+  file changes.
 * Implement CRUD based calls <http://www.salesforce.com/us/developer/docs/api_meta/Content/meta_crud_based_calls_intro.htm>.
 * Implement some helper methods for diffing metadata.
 * Ability to deploy directly from a git repository.
@@ -75,6 +77,10 @@ feature on a new branch, then send me a pull request with a detailed
 description. Please provide applicable rspec specs.
 
 ## Version History
+**0.3.5** (February 11, 2012)
+
+* Allow rake tasks to get credentials from a metaforce.yml file.
+
 **0.3.4** (February 9, 2012)
 
 * Add rake tasks.

data/lib/metaforce/config.rb

@@ -42,12 +42,16 @@ module Metaforce
     # Set this to true if you're authenticating with a Sandbox instance.
     # Defaults to false.
     attr_accessor :test
+    # Causes Metaforce::Transaction.result to loop until the transaction is
+    # complete. Defaults to false.
+    attr_accessor :wait_until_done
 
     def initialize
-      Savon.log    = false
-      HTTPI.log    = false
-      @api_version = "23.0"
-      @test        = false
+      Savon.log        = false
+      HTTPI.log        = false
+      @api_version     = "23.0"
+      @test            = false
+      @wait_until_done = false
     end
 
     def logger

data/lib/metaforce/metadata/transaction.rb

@@ -40,14 +40,14 @@ module Metaforce
 
     # Returns the decoded content of the returned zip file.
     def zip_file
-      raise "Request was not a retrieve." unless @type == :retrieve
+      raise 'Request was not a retrieve.' unless @type == :retrieve
       Base64.decode64(@result[:zip_file])
     end
 
     # Unzips the returned zip file to +destination+.
     def unzip(destination)
       zip = zip_file
-      file = Tempfile.new("retrieve")
+      file = Tempfile.new('retrieve')
       file.write(zip)
       path = file.path
       file.close
@@ -63,8 +63,8 @@ module Metaforce
     
     # Returns the deploy or retrieve result
     def result(options={})
-      self.wait_until_done if options[:wait_until_done]
-      raise "Request has not completed." unless @done
+      self.wait_until_done if (options[:wait_until_done] || Metaforce.configuration.wait_until_done)
+      raise 'Request has not completed.' unless @done
       @result = @client.status(@id, @type) if @result.nil?
       @result
     end

data/lib/metaforce/services/client.rb

@@ -11,6 +11,9 @@ module Metaforce
       # is nil, it will get the username, password and security token from the
       # configuration.
       def initialize(options=nil)
+        # Convert string keys to hashes
+        options.dup.each { |key, value| options[key.to_sym] = value } if options.is_a?(Hash)
+
         options = {
           :username => Metaforce.configuration.username,
           :password => Metaforce.configuration.password,

data/lib/metaforce/tasks/README.md

@@ -0,0 +1,57 @@
+# Metaforce Rake Tasks
+These are a set of default rake tasks that can be used for deploying/retrieving
+metadata using Rake and Metaforce. The following rake tasks are provided:
+
+* metaforce:deploy
+* metaforce:retrieve
+
+You can include the rake tasks by adding the following to your Rakefile:
+
+```ruby
+begin
+  require 'metaforce'
+  load 'metaforce/tasks/metaforce.rake'
+rescue LoadError
+  task :metaforce do
+    puts "Couldn't load metaforce tasks"
+  end
+end
+```
+
+## metaforce.yml
+Include a metaforce.yml file in the root if you'd rather not type in your
+username, password and security token everytime you deploy or retrieve.
+
+With one environment:
+
+```yaml
+---
+username: user
+password: password
+security_token: securitytoken
+test: true # defaults to false
+```
+
+With multiple environments:
+
+```yaml
+---
+production:
+    username: user
+    password: password
+    security_token: securitytoken
+sandbox:
+    username: user
+    password: password
+    security_token: securitytoken
+    test: true
+```
+
+This would deploy using the `sandbox` environment:
+
+`rake metaforce:deploy env="sandbox"`
+
+This would retrieve code using the `production` environment and would unzip the
+contents to "production\_code" rather than the default of "src".
+
+`rake metaforce:retrieve env="production" dir="production_code"`

data/lib/metaforce/tasks/metaforce.rake

@@ -1,14 +1,22 @@
 namespace :metaforce do
   Metaforce.log = true
 
-  task :require do
-    require 'metaforce'
-  end
-
   task :login do
-    print "username: "; username = STDIN.gets.chomp
-    print "password: "; password = STDIN.gets.chomp
-    print "security token: "; security_token = STDIN.gets.chomp
+    if File.exists?('metaforce.yml')
+      require 'yaml'
+      config = YAML.load_file('metaforce.yml')
+      env = ENV['env'] || 'default'
+      root = config.has_key?(env) ? config[env] : config
+      username       = root["username"]
+      password       = root["password"]
+      security_token = root["security_token"] || ''
+      test           = root["test"] || false
+      Metaforce.configuration.test = test
+    else
+      print "username: "; username = STDIN.gets.chomp
+      print "password: "; password = STDIN.gets.chomp
+      print "security token: "; security_token = STDIN.gets.chomp
+    end
     @client = Metaforce::Metadata::Client.new :username => username,
       :password => password,
       :security_token => security_token
@@ -27,10 +35,11 @@ namespace :metaforce do
 
   desc "Retrieve metadata from the organization to src directory"
   task :retrieve => :login do
+    dir = ENV['dir'] || 'src'
     retrieval = @client.retrieve_unpackaged(File.expand_path('src/package.xml'))
     result = retrieval.result(:wait_until_done => true)
-    retrieval.unzip(File.expand_path('src'))
-    puts "Successfully retrieved metadata."
+    retrieval.unzip(File.expand_path(dir))
+    puts "Successfully retrieved metadata to '#{dir}'."
   end
 
 end

data/lib/metaforce/version.rb

@@ -1,3 +1,3 @@
 module Metaforce
-  VERSION = "0.3.4"
+  VERSION = "0.3.5"
 end

data/spec/fixtures/sample/metaforce.yml

@@ -0,0 +1,13 @@
+---
+production: &production
+  username: user
+  password: password
+  security_token: aaaaaaaa
+
+sandbox: &sandbox
+  username: user
+  password: password
+  security_token: aaaaaaaa
+  test: true
+
+default: *production

data/spec/lib/services/services_spec.rb

@@ -20,5 +20,13 @@ describe Metaforce::Services::Client do
       end
 
     end
+    context "when given a hash with strings" do
+      it "works just like symbols" 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" })
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metaforce
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-10 00:00:00.000000000 Z
+date: 2012-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2156875440 !ruby/object:Gem::Requirement
+  requirement: &9127740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *2156875440
+  version_requirements: *9127740
 - !ruby/object:Gem::Dependency
   name: savon
-  requirement: &2156874780 !ruby/object:Gem::Requirement
+  requirement: &9127260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.9.7
   type: :runtime
   prerelease: false
-  version_requirements: *2156874780
+  version_requirements: *9127260
 - !ruby/object:Gem::Dependency
   name: rubyzip
-  requirement: &2156873820 !ruby/object:Gem::Requirement
+  requirement: &9126870 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.9.5
   type: :runtime
   prerelease: false
-  version_requirements: *2156873820
+  version_requirements: *9126870
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2156873440 !ruby/object:Gem::Requirement
+  requirement: &9126570 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156873440
+  version_requirements: *9126570
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156872960 !ruby/object:Gem::Requirement
+  requirement: &9126200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156872960
+  version_requirements: *9126200
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2156872380 !ruby/object:Gem::Requirement
+  requirement: &9125950 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156872380
+  version_requirements: *9125950
 - !ruby/object:Gem::Dependency
   name: savon_spec
-  requirement: &2156871580 !ruby/object:Gem::Requirement
+  requirement: &9125560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,7 +87,7 @@ dependencies:
         version: 0.1.6
   type: :development
   prerelease: false
-  version_requirements: *2156871580
+  version_requirements: *9125560
 description: A Ruby gem for interacting with the Salesforce Metadata API
 email:
 - eric@ejholmes.net
@@ -110,6 +110,7 @@ files:
 - lib/metaforce/metadata/transaction.rb
 - lib/metaforce/services.rb
 - lib/metaforce/services/client.rb
+- lib/metaforce/tasks/README.md
 - lib/metaforce/tasks/metaforce.rake
 - lib/metaforce/types.rb
 - lib/metaforce/version.rb
@@ -128,6 +129,7 @@ files:
 - spec/fixtures/requests/login/success.xml
 - spec/fixtures/requests/retrieve/in_progress.xml
 - spec/fixtures/sample/Rakefile
+- spec/fixtures/sample/metaforce.yml
 - spec/fixtures/sample/src/classes/TestClass.cls
 - spec/fixtures/sample/src/classes/TestClass.cls-meta.xml
 - spec/fixtures/sample/src/package.xml
@@ -178,6 +180,7 @@ test_files:
 - spec/fixtures/requests/login/success.xml
 - spec/fixtures/requests/retrieve/in_progress.xml
 - spec/fixtures/sample/Rakefile
+- spec/fixtures/sample/metaforce.yml
 - spec/fixtures/sample/src/classes/TestClass.cls
 - spec/fixtures/sample/src/classes/TestClass.cls-meta.xml
 - spec/fixtures/sample/src/package.xml