metaforce 0.2.0.alpha

data/spec/fixtures/requests/login/success.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="urn:partner.soap.sforce.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <soapenv:Body>
+    <loginResponse>
+      <result>
+        <metadataServerUrl>https://na12-api.salesforce.com/services/Soap/m/23.0/00DU0000000Albh</metadataServerUrl>
+        <passwordExpired>false</passwordExpired>
+        <sandbox>false</sandbox>
+        <serverUrl>https://na12-api.salesforce.com/services/Soap/u/23.0/00DU0000000Ilbh</serverUrl>
+        <sessionId>00DU0000000Ilbh!AQoAQHVcube9Z6CRlbR9Eg8ZxpJlrJ6X8QDbnokfyVZItFKzJsLHIRGiqhzJkYsNYRkd3UVA9.s82sbjEbZGUqP3mG6TP_P8</sessionId>
+        <userId>005U0000000FGpcIAG</userId>
+        <userInfo>
+          <accessibilityMode>false</accessibilityMode>
+          <currencySymbol>$</currencySymbol>
+          <orgAttachmentFileSizeLimit>5242880</orgAttachmentFileSizeLimit>
+          <orgDefaultCurrencyIsoCode>USD</orgDefaultCurrencyIsoCode>
+          <orgDisallowHtmlAttachments>false</orgDisallowHtmlAttachments>
+          <orgHasPersonAccounts>false</orgHasPersonAccounts>
+          <organizationId>00DU0000000AlbhMAC</organizationId>
+          <organizationMultiCurrency>false</organizationMultiCurrency>
+          <organizationName>Foo Org</organizationName>
+          <profileId>00eU0000000LiuNIAQ</profileId>
+          <roleId>00EU0000000x4OtMAK</roleId>
+          <sessionSecondsValid>7200</sessionSecondsValid>
+          <userDefaultCurrencyIsoCode xsi:nil="true"/>
+          <userEmail>foo@bar.com</userEmail>
+          <userFullName>Foo Bar</userFullName>
+          <userId>005U0000000EApcIAG</userId>
+          <userLanguage>en_US</userLanguage>
+          <userLocale>en_US</userLocale>
+          <userName>foo@bar.com</userName>
+          <userTimeZone>America/Los_Angeles</userTimeZone>
+          <userType>Standard</userType>
+          <userUiSkin>Theme3</userUiSkin>
+        </userInfo>
+      </result>
+    </loginResponse>
+  </soapenv:Body>
+</soapenv:Envelope>

data/spec/fixtures/sample/src/classes/TestClass.cls

@@ -0,0 +1,2 @@
+public class TestClass {
+}

data/spec/fixtures/sample/src/classes/TestClass.cls-meta.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>23.0</apiVersion>
+    <status>Active</status>
+</ApexClass>

data/spec/fixtures/sample/src/package.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<Package xmlns="http://soap.sforce.com/2006/04/metadata">
+  <types>
+    <members>TestClass</members>
+    <name>ApexClass</name>
+  </types>
+  <version>23.0</version>
+</Package>

data/spec/lib/api/metadata_spec.rb

@@ -0,0 +1,139 @@
+require "spec_helper"
+require "tempfile"
+
+describe Metaforce::Metadata::Client do
+
+  before(:each) do
+    savon.expects(:login).with(:username => 'valid', :password => 'password').returns(:success)
+  end
+
+  let(:client) do
+    Metaforce::Metadata::Client.new(:username => 'valid', :password => 'password')
+  end
+  
+  describe ".list" do
+    context "when given valid information" do
+
+      it "returns an array" do
+        savon.expects(:list_metadata).with(:queries => [ :type => "ApexClass"]).returns(:objects)
+        client.list(:type => "ApexClass").should be_an(Array)
+      end
+
+    end
+  end
+
+  describe ".describe" do
+    context "when given valid information" do
+
+      it "returns a hash" do
+        savon.expects(:describe_metadata).returns(:success)
+        client.describe.should be_a(Hash)
+      end
+
+    end
+  end
+
+  describe ".status" do
+    context "when given an invalid id" do
+
+      it "raises an" do
+        expect { client.status("badId") }.to raise_error
+      end
+
+    end
+    context "when given an id of a result that has completed" do
+
+      it "returns a hash and the :done key contains true" do
+        savon.expects(:check_status).with(:ids => [ "04sU0000000WNWoIAO" ]).returns(:done)
+        status = client.status("04sU0000000WNWoIAO")
+        status.should be_a(Hash)
+        status[:done].should eq(true)
+      end
+
+    end
+    context "when given an id of a result that has not completed" do
+
+      it "returns a hash and the :done key contains false" do
+        savon.expects(:check_status).with(:ids => [ "04sU0000000WNWoIAo" ]).returns(:not_done)
+        status = client.status("04sU0000000WNWoIAo")
+        status.should be_a(Hash)
+        status[:done].should eq(false)
+      end
+
+    end
+    context "when given and id of a deploy that has completed" do
+
+      it "returns a hash" do
+        savon.expects(:check_deploy_status).with(:ids => [ "04sU0000000WNWoIAO" ]).returns(:done)
+        status = client.status("04sU0000000WNWoIAO", :deploy)
+        status.should be_a(Hash)
+      end
+
+    end
+  end
+
+  describe ".done?" do
+    context "when given an id of a result that has completed" do
+
+      it "returns true" do
+        savon.expects(:check_status).with(:ids => [ "04sU0000000WNWoIAO" ]).returns(:done)
+        client.done?("04sU0000000WNWoIAO").should eq(true)
+      end
+
+    end
+    context "when given an id of a result that has not completed" do
+
+      it "returns false" do
+        savon.expects(:check_status).with(:ids => [ "04sU0000000WNWoIAo" ]).returns(:not_done)
+        client.done?("04sU0000000WNWoIAo").should eq(false)
+      end
+
+    end
+  end
+
+  describe ".deploy" do
+
+    before(:each) do
+      Metaforce::Metadata::Client.any_instance.stubs(:create_deploy_file).returns('')
+    end
+    
+    context "when given a directory to deploy" do
+
+      it "deploys the directory and returns a transaction" do
+        savon.expects(:deploy).with(:zip_file => '', :deploy_options => {}).returns(:in_progress)
+        deployment = client.deploy(File.expand_path('../../../fixtures/sample', __FILE__))
+        deployment.should be_a(Metaforce::Transaction)
+        deployment.id.should eq("04sU0000000WNWoIAO")
+      end
+
+    end
+
+    # context "when given a file" do
+
+      # it "deploys the file and returns the id of the result" do
+        # path = Tempfile.new('zipfile').tap { |f| f.write('h'); f.close }.path
+        # savon.expects(:deploy).with(:zip_file => "aA==\n", :deploy_options => {}).returns(:in_progress)
+        # id = client.deploy(File.open(path))
+        # id.should eq("04sU0000000WNWoIAO")
+      # end
+
+    # end
+
+    it "allows deploy options to be configured via a hash" do
+      savon.expects(:deploy).with(:zip_file => '', :deploy_options => { :run_all_tests => true }).returns(:in_progress)
+      expect {
+        client.deploy('', { :run_all_tests => true })
+      }.to_not raise_error
+    end
+
+    it "allows deploy options to be configured via a block" do
+      savon.expects(:deploy).with(:zip_file => '', :deploy_options => { :run_all_tests => true }).returns(:in_progress)
+      expect {
+        client.deploy('') do |options|
+          options.run_all_tests = true
+        end
+      }.to_not raise_error
+    end
+    
+  end
+end

data/spec/lib/api/services_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+describe Metaforce::Services::Client do
+  describe ".login" do
+    context "when given invalid credentials" do
+
+      it "raises an error" do
+        savon.expects(:login).with(:username => 'invalid', :password => 'password').returns(:failure)
+        expect { Metaforce::Services::Client.new(:username => 'invalid', :password => 'password') }.to raise_error
+      end
+
+    end
+    context "when given valid credentials" do
+
+      it "returns a hash containing the session id and metadata server url" 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

data/spec/lib/api/transaction_spec.rb

@@ -0,0 +1,62 @@
+require "spec_helper"
+
+describe Metaforce::Transaction do
+
+  before(:each) do
+    savon.expects(:login).with(:username => 'valid', :password => 'password').returns(:success)
+    Metaforce::Metadata::Client.any_instance.stubs(:create_deploy_file).returns('')
+  end
+
+  let(:client) do
+    Metaforce::Metadata::Client.new(:username => 'valid', :password => 'password')
+  end
+
+  describe ".done?" do
+
+    it "allows you to check if the transaction has completed" do
+      savon.expects(:deploy).with(:zip_file => '', :deploy_options => {}).returns(:in_progress)
+      deployment = client.deploy(File.expand_path('../../../fixtures/sample', __FILE__))
+      savon.expects(:check_status).with(:ids => [ "04sU0000000WNWoIAO" ]).returns(:done)
+      deployment.done?.should eq(true)
+    end
+
+    it "doesn't send a request if it has already completed" do
+      savon.expects(:deploy).with(:zip_file => '', :deploy_options => {}).returns(:in_progress)
+      deployment = client.deploy(File.expand_path('../../../fixtures/sample', __FILE__))
+      savon.expects(:check_status).with(:ids => [ "04sU0000000WNWoIAO" ]).returns(:done)
+      deployment.done?.should eq(true)
+      expect { deployment.done?.should eq(true) }.to_not raise_error
+    end
+
+  end
+
+  describe ".result" do
+
+    it "raises an error if .done? hasn't been called" do
+      savon.expects(:deploy).with(:zip_file => '', :deploy_options => {}).returns(:in_progress)
+      deployment = client.deploy(File.expand_path('../../../fixtures/sample', __FILE__))
+      expect { deployment.result }.to raise_error
+    end
+
+    it "allows you to check the transaction result" do
+      savon.expects(:deploy).with(:zip_file => '', :deploy_options => {}).returns(:in_progress)
+      deployment = client.deploy(File.expand_path('../../../fixtures/sample', __FILE__))
+      savon.expects(:check_status).with(:ids => [ "04sU0000000WNWoIAO" ]).returns(:done)
+      deployment.done?.should eq(true)
+      savon.expects(:check_deploy_status).with(:ids => [ "04sU0000000WNWoIAO" ]).returns(:done)
+      deployment.result.should be_a(Hash)
+    end
+
+    it "doesn't send a request if it has already retrieved the result" do
+      savon.expects(:deploy).with(:zip_file => '', :deploy_options => {}).returns(:in_progress)
+      deployment = client.deploy(File.expand_path('../../../fixtures/sample', __FILE__))
+      savon.expects(:check_status).with(:ids => [ "04sU0000000WNWoIAO" ]).returns(:done)
+      deployment.done?.should eq(true)
+      savon.expects(:check_deploy_status).with(:ids => [ "04sU0000000WNWoIAO" ]).returns(:done)
+      deployment.result.should be_a(Hash)
+      expect { deployment.result }.to_not raise_error
+    end
+
+  end
+
+end

data/spec/lib/config_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+
+describe Metaforce do
+  describe ".configuration" do
+
+    it "sets the default api version to 23.0" do
+      Metaforce.configuration.api_version.should eq("23.0")
+    end
+
+    it "allows you to configure the api version" do
+      Metaforce.configuration.api_version = "21.0"
+      Metaforce.configuration.api_version.should eq("21.0")
+    end
+
+  end
+
+  describe ".configure" do
+
+    it "allows you to configure the api version" do
+      Metaforce.configure do |config|
+        config.api_version = "21.0"
+      end
+      Metaforce.configuration.api_version.should eq("21.0")
+    end
+
+    context "credentials" do
+
+      it "allows you to set the credentials via the configure block" do
+        Metaforce.configure do |config|
+          config.api_version = "23.0"
+          config.username = "valid"
+          config.password = "password"
+        end
+        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" })
+      end
+
+      it "allows you to set the credentials via the configure block" do
+        Metaforce.configure do |config|
+          config.api_version = "23.0"
+          config.username = "valid"
+          config.password = "password"
+        end
+        savon.expects(:login).with(:username => 'valid', :password => 'password').returns(:success)
+        expect { Metaforce::Metadata::Client.new }.to_not raise_error
+      end
+
+    end
+
+  end
+end

data/spec/lib/manifest_spec.rb

@@ -0,0 +1,181 @@
+require "spec_helper"
+
+describe Metaforce::Manifest do
+
+  before(:all) do
+    @package_xml = File.open(File.join(File.dirname(__FILE__), '../fixtures/package.xml'), 'r').read
+  end
+
+  before(:each) do
+    @package_hash = {
+      :apex_class => ['TestClass', 'AnotherClass'],
+      :apex_component => ['Component'],
+      :static_resource => ['Assets']
+    }
+  end
+
+  describe ".new" do
+    context "when given a hash" do
+      describe ".to_xml" do
+
+        it "returns a string containing xml" do
+          package = Metaforce::Manifest.new(@package_hash)
+          response = package.to_xml
+          response.should eq(@package_xml)
+        end
+
+      end
+    end
+    context "when given a string" do
+      describe ".to_hash" do
+
+        it "returns the xml content as a hash" do
+          package = Metaforce::Manifest.new(@package_xml)
+          response = package.to_hash
+          response.should eq(@package_hash)
+        end
+
+      end
+    end
+  end
+
+  describe ".add" do
+
+    it "can add additional components" do
+      package = Metaforce::Manifest.new(@package_hash)
+      package.add(:apex_class, 'AdditionalClass')
+      response = package.to_hash
+      @package_hash = {
+        :apex_class => ['TestClass', 'AnotherClass', 'AdditionalClass'],
+        :apex_component => ['Component'],
+        :static_resource => ['Assets']
+      }
+      response.should eq(@package_hash)
+    end
+
+    it "can add additional components from an array" do
+      package = Metaforce::Manifest.new(@package_hash)
+      package.add(:apex_class, ['class1', 'class2'])
+      response = package.to_hash
+      @package_hash = {
+        :apex_class => ['TestClass', 'AnotherClass', 'class1', 'class2'],
+        :apex_component => ['Component'],
+        :static_resource => ['Assets']
+      }
+      response.should eq(@package_hash)
+    end
+
+    it "strips directories and extensions" do
+      package = Metaforce::Manifest.new(@package_hash)
+      package.add(:apex_class, 'src/classes/AdditionalClass.cls')
+      response = package.to_hash
+      @package_hash = {
+        :apex_class => ['TestClass', 'AnotherClass', 'AdditionalClass'],
+        :apex_component => ['Component'],
+        :static_resource => ['Assets']
+      }
+      response.should eq(@package_hash)
+    end
+
+  end
+
+  describe ".remove" do
+
+    it "can remove components" do
+      package = Metaforce::Manifest.new(@package_hash)
+      package.remove(:apex_class, 'TestClass')
+      response = package.to_hash
+      @package_hash = {
+        :apex_class => ['AnotherClass'],
+        :apex_component => ['Component'],
+        :static_resource => ['Assets']
+      }
+      response.should eq(@package_hash)
+    end
+
+    it "can remove components in an array" do
+      package = Metaforce::Manifest.new(@package_hash)
+      package.remove(:apex_class, ['TestClass', 'AnotherClass'])
+      response = package.to_hash
+      @package_hash = {
+        :apex_component => ['Component'],
+        :static_resource => ['Assets']
+      }
+      response.should eq(@package_hash)
+    end
+
+    it "strips directories and extensions" do
+      package = Metaforce::Manifest.new(@package_hash)
+      package.remove(:apex_class, 'src/classes/TestClass.cls')
+      response = package.to_hash
+      @package_hash = {
+        :apex_class => ['AnotherClass'],
+        :apex_component => ['Component'],
+        :static_resource => ['Assets']
+      }
+      response.should eq(@package_hash)
+    end
+
+  end
+
+  describe ".only" do
+
+    it "filters the components based on a list of files" do
+      package = Metaforce::Manifest.new(@package_hash)
+      package.only(['classes/TestClass'])
+      response = package.to_hash
+      @package_hash = {
+        :apex_class => ['TestClass']
+      }
+      response.should eq(@package_hash)
+    end
+
+    it "ignores file extensions" do
+      package = Metaforce::Manifest.new(@package_hash)
+      package.only(['classes/TestClass.cls', 'components/Component.component'])
+      response = package.to_hash
+      @package_hash = {
+        :apex_class => ['TestClass'],
+        :apex_component => ['Component']
+      }
+      response.should eq(@package_hash)
+    end
+
+    it "strips any leading directories" do
+      package = Metaforce::Manifest.new(@package_hash)
+      package.only(['src/classes/TestClass.cls', 'src/components/Component.component'])
+      response = package.to_hash
+      @package_hash = {
+        :apex_class => ['TestClass'],
+        :apex_component => ['Component']
+      }
+      response.should eq(@package_hash)
+    end
+
+    it "ignores case of folder" do
+      package = Metaforce::Manifest.new(@package_hash)
+      package.only(['src/Classes/TestClass.cls', 'src/Components/Component.component'])
+      response = package.to_hash
+      @package_hash = {
+        :apex_class => ['TestClass'],
+        :apex_component => ['Component']
+      }
+      response.should eq(@package_hash)
+    end
+
+  end
+
+  describe ".to_package" do
+
+    it "returns a in package format" do
+        package = Metaforce::Manifest.new(@package_hash)
+        response = package.to_package
+        response.should eq([
+          { :members => ["TestClass", "AnotherClass"], :name => "ApexClass" },
+          { :members => ["Component"], :name => "ApexComponent" },
+          { :members => ["Assets"], :name => "StaticResource" }
+        ])
+    end
+
+  end
+end