metaforce 0.3.2 → 0.3.3

data/README.md

@@ -75,6 +75,11 @@ feature on a new branch, then send me a pull request with a detailed
 description. Please provide applicable rspec specs.
 
 ## Version History
+**0.3.3** (February 9, 2012)
+
+* Added a logger for logging requests.
+* Allow api version to be set when calling `Metaforce::Metadata::Client.describe`.
+
 **0.3.2** (February 3, 2012)
 
 * Improved documentation.
@@ -83,7 +88,7 @@ description. Please provide applicable rspec specs.
 **0.3.1** (February 3, 2012)
 
 * Dynamically defined helper methods for .list (e.g. `client.list_apex_classes`, `client.list_custom_objects`).
-* The `describe` method now caches the results to minimize latency. `describe!`
+* The `Metaforce::Metadata::Client.describe` method now caches the results to minimize latency. `describe!`
   can be used to force a refresh.
 
 **0.3.0.alpha** (January 29, 2012)

data/lib/metaforce.rb

@@ -1,4 +1,5 @@
 require 'metaforce/version'
 require 'metaforce/config'
 require 'metaforce/manifest'
-require 'metaforce/api'
+require 'metaforce/services'
+require 'metaforce/metadata'

data/lib/metaforce/config.rb

@@ -1,5 +1,7 @@
 module Metaforce
   class << self
+    attr_writer :log
+
     # Returns the current Configuration
     #
     #    Metaforce.configuration.username = "username"
@@ -17,6 +19,15 @@ module Metaforce
     def configure
       yield configuration
     end
+
+    def log?
+      @log ||= false
+    end
+
+    def log(message)
+      return unless Metaforce.log?
+      Metaforce.configuration.logger.send :debug, message
+    end
   end
 
   class Configuration
@@ -28,13 +39,19 @@ module Metaforce
     attr_accessor :password
     # The security token to use during login.
     attr_accessor :security_token
-    # Set this to true if you're authentication with a Sandbox instance.
+    # Set this to true if you're authenticating with a Sandbox instance.
     # Defaults to false.
     attr_accessor :test
 
     def initialize
+      Savon.log    = false
+      HTTPI.log    = false
       @api_version = "23.0"
-      @test = false
+      @test        = false
+    end
+
+    def logger
+      @logger ||= ::Logger.new STDOUT
     end
   end
 end

data/lib/metaforce/metadata.rb

@@ -0,0 +1,2 @@
+require 'metaforce/metadata/transaction'
+require 'metaforce/metadata/client'

data/lib/metaforce/{api/metadata.rb → metadata/client.rb}

@@ -81,14 +81,15 @@ module Metaforce
       #   # List the names of all metedata types
       #   client.describe[:metadata_objects].collect { |t| t[:xml_name] }
       #   #=> ["CustomLabels", "StaticResource", "Scontrol", "ApexComponent", ... ]
-      def describe
-        @describe ||= describe!
+      def describe(version=nil)
+        @describe ||= describe!(version)
       end
 
       # See +describe+
-      def describe!
+      def describe!(version=nil)
         response = @client.request(:describe_metadata) do |soap|
           soap.header = @header
+          soap.body = { :api_version => version } unless version.nil?
         end
         @describe = response.body[:describe_metadata_response][:result]
       end
@@ -105,6 +106,8 @@ module Metaforce
         request = "check_#{type.to_s}_status" unless type.nil?
         ids = [ ids ] unless ids.is_a?(Array)
 
+        Metaforce.log("Polling server for status on #{ids.join(', ')}")
+
         response = @client.request(request.to_sym) do |soap|
           soap.header = @header
           soap.body = {
@@ -148,6 +151,8 @@ module Metaforce
           zip_contents = Base64.encode64(dir.read)
         end
 
+        Metaforce.log('Executing deploy')
+
         response = @client.request(:deploy) do |soap|
           soap.header = @header
           soap.body = {
@@ -164,6 +169,8 @@ module Metaforce
       # for a list of _retrieve_request_ options. Options should be convereted from
       # camelCase to an :underscored_symbol.
       def retrieve(retrieve_request={})
+        Metaforce.log('Executing retrieve')
+
         response = @client.request(:retrieve) do |soap|
           soap.header = @header
           soap.body = {

data/lib/metaforce/{api → metadata}/transaction.rb

@@ -9,9 +9,9 @@ module Metaforce
     # The type of transaction (e.g. _:deploy_, _:retrieve_)
     attr_reader :type
 
-    def initialize(client, id, type)
-      @id     = id
+    def initialize(client, id, type=nil)
       @client = client
+      @id     = id
       @type   = type
     end
 
@@ -40,7 +40,7 @@ module Metaforce
 
     # Returns the decoded content of the returned zip file.
     def zip_file
-      raise "Request was not a retrieve." if @type != :retrieve
+      raise "Request was not a retrieve." unless @type == :retrieve
       Base64.decode64(@result[:zip_file])
     end
 

data/lib/metaforce/services.rb

@@ -0,0 +1 @@
+require 'metaforce/services/client'

data/lib/metaforce/version.rb

@@ -1,3 +1,3 @@
 module Metaforce
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metaforce
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-03 00:00:00.000000000 Z
+date: 2012-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &8411610 !ruby/object:Gem::Requirement
+  requirement: &2164921800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *8411610
+  version_requirements: *2164921800
 - !ruby/object:Gem::Dependency
   name: savon
-  requirement: &8409890 !ruby/object:Gem::Requirement
+  requirement: &2164921300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.9.7
   type: :runtime
   prerelease: false
-  version_requirements: *8409890
+  version_requirements: *2164921300
 - !ruby/object:Gem::Dependency
   name: rubyzip
-  requirement: &8424970 !ruby/object:Gem::Requirement
+  requirement: &2164920840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.9.5
   type: :runtime
   prerelease: false
-  version_requirements: *8424970
+  version_requirements: *2164920840
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &8422930 !ruby/object:Gem::Requirement
+  requirement: &2164920460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *8422930
+  version_requirements: *2164920460
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &8422420 !ruby/object:Gem::Requirement
+  requirement: &2164920000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *8422420
+  version_requirements: *2164920000
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &8421570 !ruby/object:Gem::Requirement
+  requirement: &2164919580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *8421570
+  version_requirements: *2164919580
 - !ruby/object:Gem::Dependency
   name: savon_spec
-  requirement: &8420670 !ruby/object:Gem::Requirement
+  requirement: &2164919080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,7 +87,7 @@ dependencies:
         version: 0.1.6
   type: :development
   prerelease: false
-  version_requirements: *8420670
+  version_requirements: *2164919080
 description: A Ruby gem for interacting with the Salesforce Metadata API
 email:
 - eric@ejholmes.net
@@ -102,13 +102,14 @@ files:
 - README.md
 - Rakefile
 - lib/metaforce.rb
-- lib/metaforce/api.rb
-- lib/metaforce/api/metadata.rb
-- lib/metaforce/api/services.rb
-- lib/metaforce/api/transaction.rb
 - lib/metaforce/config.rb
 - lib/metaforce/dsl.rb
 - lib/metaforce/manifest.rb
+- lib/metaforce/metadata.rb
+- lib/metaforce/metadata/client.rb
+- lib/metaforce/metadata/transaction.rb
+- lib/metaforce/services.rb
+- lib/metaforce/services/client.rb
 - lib/metaforce/types.rb
 - lib/metaforce/version.rb
 - metaforce.gemspec
@@ -128,12 +129,12 @@ files:
 - spec/fixtures/sample/src/classes/TestClass.cls
 - spec/fixtures/sample/src/classes/TestClass.cls-meta.xml
 - spec/fixtures/sample/src/package.xml
-- spec/lib/api/metadata_spec.rb
-- spec/lib/api/services_spec.rb
-- spec/lib/api/transaction_spec.rb
 - spec/lib/config_spec.rb
 - spec/lib/dsl_spec.rb
 - spec/lib/manifest_spec.rb
+- spec/lib/metadata/metadata_spec.rb
+- spec/lib/metadata/transaction_spec.rb
+- spec/lib/services/services_spec.rb
 - spec/spec_helper.rb
 - wsdl/23.0/metadata.xml
 - wsdl/23.0/partner.xml
@@ -177,11 +178,11 @@ test_files:
 - spec/fixtures/sample/src/classes/TestClass.cls
 - spec/fixtures/sample/src/classes/TestClass.cls-meta.xml
 - spec/fixtures/sample/src/package.xml
-- spec/lib/api/metadata_spec.rb
-- spec/lib/api/services_spec.rb
-- spec/lib/api/transaction_spec.rb
 - spec/lib/config_spec.rb
 - spec/lib/dsl_spec.rb
 - spec/lib/manifest_spec.rb
+- spec/lib/metadata/metadata_spec.rb
+- spec/lib/metadata/transaction_spec.rb
+- spec/lib/services/services_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/lib/metaforce/api.rb

@@ -1,3 +0,0 @@
-require 'metaforce/api/services'
-require 'metaforce/api/metadata'
-require 'metaforce/api/transaction'