metaforce-beta 1.2.0

data/lib/metaforce/job/crud.rb

@@ -0,0 +1,13 @@
+module Metaforce
+  class Job::CRUD < Job
+    def initialize(client, method, args)
+      super(client)
+      @method, @args = method, args
+    end
+
+    def perform
+      @id = @client.send(@method, *@args).id
+      super
+    end
+  end
+end

data/lib/metaforce/job/deploy.rb

@@ -0,0 +1,87 @@
+module Metaforce
+  class Job::Deploy < Job
+
+    # Public: Instantiate a new deploy job.
+    #
+    # Examples
+    #
+    #   job = Metaforce::Job::Deploy.new(client, './path/to/deploy')
+    #   # => #<Metaforce::Job::Deploy @id=nil>
+    #
+    # Returns self.
+    def initialize(client, path, options={})
+      super(client)
+      @path, @options = path, options
+    end
+
+    # Public: Perform the job.
+    #
+    # Examples
+    #
+    #   job = Metaforce::Job::Deploy.new(client, './path/to/deploy')
+    #   job.perform
+    #   # => #<Metaforce::Job::Deploy @id='1234'>
+    #
+    # Returns self.
+    def perform
+      @id = client._deploy(payload, @options).id
+      super
+    end
+
+    # Public: Get the detailed status of the deploy.
+    #
+    # Examples
+    #
+    #   job.result
+    #   # => { :id => '1234', :success => true, ... }
+    #
+    # Returns the DeployResult (http://www.salesforce.com/us/developer/docs/api_meta/Content/meta_deployresult.htm).
+    def result
+      @result ||= client.status(id, :deploy)
+    end
+
+    # Public: Returns true if the deploy was successful.
+    #
+    # Examples
+    #
+    #   job.success?
+    #   # => true
+    # 
+    # Returns true or false based on the DeployResult.
+    def success?
+      result.success
+    end
+
+  private
+
+    # Internal: Base64 encodes the contents of the zip file.
+    #
+    # Examples
+    #
+    #   job.payload
+    #   # => '<lots of base64 encoded content>'
+    #
+    # Returns the content of the zip file encoded to base64.
+    def payload
+      Base64.encode64(File.open(file, 'rb').read)
+    end
+
+    # Internal: Returns the path to the zip file.
+    def file
+      File.file?(@path) ? @path : zip_file
+    end
+
+    # Internal: Creates a zip file with the contents of the directory.
+    def zip_file
+      path = Dir.mktmpdir
+      File.join(path, 'deploy.zip').tap do |path|
+        Zip::File.open(path, Zip::File::CREATE) do |zip|
+          Dir["#{@path}/**/**"].each do |file|
+            zip.add(file.sub("#{File.dirname(@path)}/", ''), file)
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/metaforce/job/retrieve.rb

@@ -0,0 +1,102 @@
+module Metaforce
+  class Job::Retrieve < Job
+
+    # Public: Instantiate a new retrieve job.
+    #
+    # Examples
+    #
+    #   job = Metaforce::Job::Retrieve.new(client)
+    #   # => #<Metaforce::Job::Retrieve @id=nil>
+    #
+    # Returns self.
+    def initialize(client, options={})
+      super(client)
+      @options = options
+    end
+
+    # Public: Perform the job.
+    #
+    # Examples
+    #
+    #   job = Metaforce::Job::Retrieve.new(client)
+    #   job.perform
+    #   # => #<Metaforce::Job::Retrieve @id='1234'>
+    #
+    # Returns self.
+    def perform
+      @id = client._retrieve(@options).id
+      super
+    end
+
+    # Public: Get the detailed status of the retrieve.
+    #
+    # Examples
+    #
+    #   job.result
+    #   # => { :id => '1234', :zip_file => '<base64 encoded content>', ... }
+    #
+    # Returns the RetrieveResult (http://www.salesforce.com/us/developer/docs/api_meta/Content/meta_retrieveresult.htm).
+    def result
+      @result ||= client.status(id, :retrieve)
+    end
+
+    # Public: Decodes the content of the returned zip file.
+    #
+    # Examples
+    #
+    #   job.zip_file
+    #   # => '<binary content>'
+    #
+    # Returns the decoded content.
+    def zip_file
+      Base64.decode64(result.zip_file)
+    end
+
+    # Public: Unzips the returned zip file to the location.
+    #
+    # destination - Path to extract the contents to.
+    #
+    # Examples
+    #
+    #   job.extract_to('./path')
+    #   # => #<Metaforce::Job::Retrieve @id='1234'>
+    #
+    # Returns self.
+    def extract_to(destination)
+      return on_complete { |job| job.extract_to(destination) } unless started?
+      with_tmp_zip_file do |file|
+        unzip(file, destination)
+      end
+      self
+    end
+
+  private
+
+    # Internal: Unzips source to destination.
+    def unzip(source, destination)
+      Zip::File.open(source) do |zip|
+        zip.each do |f|
+          path = File.join(destination, f.name)
+          FileUtils.mkdir_p(File.dirname(path))
+          zip.extract(f, path) { true }
+        end
+      end
+    end
+
+    # Internal: Writes the zip file content to a temporary location so it can
+    # be extracted.
+    def with_tmp_zip_file
+      file = Tempfile.new('retrieve')
+      begin
+        file.binmode
+        file.write(zip_file)
+        file.rewind
+        yield file
+      ensure
+        file.close
+        file.unlink
+      end
+    end
+
+  end
+end

data/lib/metaforce/login.rb

@@ -0,0 +1,39 @@
+module Metaforce
+  class Login
+    def initialize(username, password, security_token=nil)
+      @username, @password, @security_token = username, password, security_token
+    end
+
+    # Public: Perform the login request.
+    #
+    # Returns a hash with the session id and server urls.
+    def login
+      response = client.request(:login) do
+        soap.body = {
+          :username => username,
+          :password => password
+        }
+      end
+      response.body[:login_response][:result]
+    end
+
+  private
+
+    # Internal: Savon client.
+    def client
+      @client ||= Savon.client(Metaforce.configuration.partner_wsdl) do |wsdl|
+        wsdl.endpoint = Metaforce.configuration.endpoint
+      end.tap { |client| client.http.auth.ssl.verify_mode = :none }
+    end
+
+    # Internal: Usernamed passed in from options.
+    def username
+      @username
+    end
+
+    # Internal: Password + Security Token combined.
+    def password
+      [@password, @security_token].join('')
+    end
+  end
+end

data/lib/metaforce/manifest.rb

@@ -0,0 +1,106 @@
+require 'nokogiri'
+require 'active_support/core_ext'
+
+module Metaforce
+  class Manifest < Hash
+
+    # Public: Initializes a new instance of a manifest (package.xml) file.
+    #
+    # It can either take a hash:
+    #   {
+    #     :apex_class => [
+    #       "TestController",
+    #       "TestClass"
+    #     ],
+    #     :apex_component => [
+    #       "SiteLogin"
+    #     ]
+    #   }
+    #
+    # Or an xml string containing the contents of a packge.xml file:
+    #  <?xml version="1.0"?>
+    #  <Package xmlns="http://soap.sforce.com/2006/04/metadata">
+    #    <types>
+    #      <members>TestClass</members>
+    #      <members>AnotherClass</members>
+    #      <name>ApexClass</name>
+    #    </types>
+    #    <types>
+    #      <members>Component</members>
+    #      <name>ApexComponent</name>
+    #    </types>
+    #    <types>
+    #      <members>Assets</members>
+    #      <name>StaticResource</name>
+    #    </types>
+    #    <version>23.0</version>
+    #  </Package>
+    #
+    def initialize(components={})
+      self.replace Hash.new { |h,k| h[k] = [] }
+      if components.is_a?(Hash)
+        self.merge!(components)
+      elsif components.is_a?(String)
+        self.parse(components)
+      end
+    end
+
+    # Public: Returns a string containing a package.xml file
+    #
+    #  <?xml version="1.0"?>
+    #  <Package xmlns="http://soap.sforce.com/2006/04/metadata">
+    #    <types>
+    #      <members>TestClass</members>
+    #      <members>AnotherClass</members>
+    #      <name>ApexClass</name>
+    #    </types>
+    #    <types>
+    #      <members>Component</members>
+    #      <name>ApexComponent</name>
+    #    </types>
+    #    <types>
+    #      <members>Assets</members>
+    #      <name>StaticResource</name>
+    #    </types>
+    #    <version>23.0</version>
+    #  </Package>
+    def to_xml
+      xml_builder = Nokogiri::XML::Builder.new do |xml|
+        xml.Package('xmlns' => 'http://soap.sforce.com/2006/04/metadata') {
+          self.each do |key, members|
+            xml.types {
+              members.each do |member|
+                xml.members member
+              end
+              xml.name key.to_s.camelize
+            }
+          end
+          xml.version Metaforce.configuration.api_version
+        }
+      end
+      xml_builder.to_xml
+    end
+
+    # Public: Converts the manifest into a format that can be used by the
+    # metadata api.
+    def to_package
+      self.map do |type, members|
+        { :members => members, :name => type.to_s.camelize }
+      end
+    end
+
+    # Public: Parses a package.xml file
+    def parse(file)
+      document = Nokogiri::XML(file).remove_namespaces!
+      document.xpath('//types').each do |type|
+        name = type.xpath('name').first.content
+        key = name.underscore.to_sym
+        type.xpath('members').each do |member|
+          self[key] << member.content
+        end
+      end
+      self
+    end
+
+  end
+end

data/lib/metaforce/metadata/client.rb

@@ -0,0 +1,18 @@
+module Metaforce
+  module Metadata
+    class Client < Metaforce::AbstractClient
+      require 'metaforce/metadata/client/file'
+      require 'metaforce/metadata/client/crud'
+
+      include Metaforce::Metadata::Client::File
+      include Metaforce::Metadata::Client::CRUD
+
+      endpoint :metadata_server_url
+      wsdl Metaforce.configuration.metadata_wsdl
+
+      def inspect
+        "#<#{self.class} @options=#{@options.inspect}>"
+      end
+    end
+  end
+end

data/lib/metaforce/metadata/client/crud.rb

@@ -0,0 +1,86 @@
+module Metaforce
+  module Metadata
+    class Client
+      module CRUD
+
+        # Public: Create metadata
+        #
+        # Examples
+        #
+        #   client._create(:apex_page, :full_name => 'TestPage', label: 'Test page', :content => '<apex:page>foobar</apex:page>')
+        def _create(type, metadata={})
+          type = type.to_s.camelize
+          request :create do |soap|
+            soap.body = {
+              :metadata => prepare(metadata)
+            }.merge(attributes!(type))
+          end
+        end
+
+        # Public: Delete metadata
+        #
+        # Examples
+        #
+        #   client._delete(:apex_component, 'Component')
+        def _delete(type, *args)
+          type = type.to_s.camelize
+          metadata = args.map { |full_name| {:full_name => full_name} }
+          request :delete do |soap|
+            soap.body = {
+              :metadata => metadata
+            }.merge(attributes!(type))
+          end
+        end
+
+        # Public: Update metadata
+        #
+        # Examples
+        #
+        #   client._update(:apex_page, 'OldPage', :full_name => 'TestPage', :label => 'Test page', :content => '<apex:page>hello world</apex:page>')
+        def _update(type, current_name, metadata={})
+          type = type.to_s.camelize
+          request :update do |soap|
+            soap.body = {
+              :metadata => {
+                :current_name => current_name,
+                :metadata => prepare(metadata),
+                :attributes! => { :metadata => { 'xsi:type' => "ins0:#{type}" } }
+              }
+            }
+          end
+        end
+
+        def create(*args)
+          Job::CRUD.new(self, :_create, args)
+        end
+
+        def update(*args)
+          Job::CRUD.new(self, :_update, args)
+        end
+
+        def delete(*args)
+          Job::CRUD.new(self, :_delete, args)
+        end
+
+      private
+
+        def attributes!(type)
+          {:attributes! => { 'ins0:metadata' => { 'xsi:type' => "ins0:#{type}" } }}
+        end
+
+        # Internal: Prepare metadata by base64 encoding any content keys.
+        def prepare(metadata)
+          metadata = Array[metadata].compact.flatten
+          metadata.each { |m| encode_content(m) }
+          metadata
+        end
+
+        # Internal: Base64 encodes any :content keys.
+        def encode_content(metadata)
+          metadata[:content] = Base64.encode64(metadata[:content]) if metadata.has_key?(:content)
+        end
+        
+      end
+    end
+  end
+end