metaforce-beta 1.2.0

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

@@ -0,0 +1,113 @@
+module Metaforce
+  module Metadata
+    class Client
+      module File
+
+        # Public: Specify an array of component types to list.
+        #
+        # Examples
+        #
+        #   # Get a list of apex classes on the server and output the names of each
+        #   client.list_metadata('ApexClass').collect { |t| t.full_name }
+        #   #=> ["al__SObjectPaginatorListenerForTesting", "al__IndexOutOfBoundsException", ... ]
+        #
+        #   # Get a list of apex components and apex classes
+        #   client.list_metadata('CustomObject', 'ApexComponent')
+        #   #=> ["ContractContactRole", "Solution", "Invoice_Statements__c", ... ]
+        def list_metadata(*args)
+          queries = args.map(&:to_s).map(&:camelize).map { |t| {:type => t} }
+          request :list_metadata do |soap|
+            soap.body = { :queries => queries }
+          end
+        end
+
+        # Public: Describe the organization's metadata.
+        #
+        # version - API version (default: latest).
+        #
+        # Examples
+        #
+        #   # List the names of all metadata types
+        #   client.describe.metadata_objects.collect { |t| t.xml_name }
+        #   #=> ["CustomLabels", "StaticResource", "Scontrol", "ApexComponent", ... ]
+        def describe(version=nil)
+          request :describe_metadata do |soap|
+            soap.body = { :api_version => version } unless version.nil?
+          end
+        end
+
+        # Public: Checks the status of an async result.
+        #
+        # ids  - A list of ids to check.
+        # type - either :deploy or :retrieve
+        #
+        # Examples
+        # 
+        #   client.status('04sU0000000Wx6KIAS')
+        #   #=> {:done=>true, :id=>"04sU0000000Wx6KIAS", :state=>"Completed", ...}
+        def status(ids, type=nil)
+          method = :check_status
+          method = :"check_#{type}_status" if type
+          ids = [ids] unless ids.respond_to?(:each)
+          request method do |soap|
+            soap.body = { :ids => ids }
+          end
+        end
+
+        # Public: Deploy code to Salesforce.
+        #
+        # zip_file - The base64 encoded contents of the zip file.
+        # options  - Hash of DeployOptions.
+        # 
+        # Returns the AsyncResult
+        def _deploy(zip_file, options={})
+          request :deploy do |soap|
+            soap.body = { :zip_file => zip_file, :deploy_options => options }
+          end
+        end
+
+        # Public: Retrieve code from Salesforce.
+        #
+        # Returns the AsyncResult
+        def _retrieve(options={})
+          request :retrieve do |soap|
+            soap.body = { :retrieve_request => options }
+          end
+        end
+
+        # Public: Deploy code to Salesforce.
+        #
+        # path    - A path to a zip file, or a directory to deploy.
+        # options - Deploy options.
+        #
+        # Examples
+        #
+        #   client.deploy(File.expand_path('./src'))
+        def deploy(path, options={})
+          Job::Deploy.new(self, path, options)
+        end
+
+        def retrieve(options={})
+          Job::Retrieve.new(self, options)
+        end
+
+        # Public: Retrieves files specified in the manifest file (A package.xml
+        # file).
+        def retrieve_unpackaged(manifest, options={})
+          package = if manifest.is_a?(Metaforce::Manifest)
+            manifest
+          elsif manifest.is_a?(String)
+            Metaforce::Manifest.new(::File.open(manifest).read)
+          end
+          options = {
+            :api_version    => Metaforce.configuration.api_version,
+            :single_package => true,
+            :unpackaged     => { :types => package.to_package }
+          }.merge(options)
+          retrieve(options)
+        end
+
+      end
+    end
+  end
+end

data/lib/metaforce/reporters.rb

@@ -0,0 +1,2 @@
+require 'metaforce/reporters/deploy_reporter'
+require 'metaforce/reporters/retrieve_reporter'

data/lib/metaforce/reporters/base_reporter.rb

@@ -0,0 +1,56 @@
+require 'thor/shell/color'
+
+module Metaforce
+  module Reporters
+    class BaseReporter < Thor::Shell::Color
+      def initialize(results)
+        super()
+        @results = results
+      end
+
+      def report
+      end
+
+      def report_problems
+        return unless problems?
+        say
+        say "Problems:", :red
+        say
+        problems.each { |message| problem(message) }
+      end
+
+      def problem(message)
+        say "#{short_padding}#{message.file_name}:#{message.line_number}", :red
+        say "#{long_padding}#{message.problem}"
+        say
+      end
+
+      def short_padding
+        '  '
+      end
+
+      def long_padding
+        '     '
+      end
+
+      def problems?
+        problems.any?
+      end
+
+      def issues?
+        problems?
+      end
+
+    private
+
+      def messages
+        @messages ||= Array[@results.messages].compact.flatten
+      end
+
+      def problems
+        messages.select { |message| message.problem }
+      end
+
+    end
+  end
+end

data/lib/metaforce/reporters/deploy_reporter.rb

@@ -0,0 +1,69 @@
+require 'metaforce/reporters/base_reporter'
+
+module Metaforce
+  module Reporters
+    class DeployReporter < BaseReporter
+
+      def report
+        report_problems
+        report_failed_tests
+        report_test_results if report_test_results?
+      end
+
+      def report_failed_tests
+        return unless failures?
+        say
+        say "Failures:", :red
+        say
+        failures.each { |failure| failed(failure) }
+      end
+
+      def report_test_results
+        say
+        say "Finished in #{total_time} seconds"
+        say "#{num_tests} tests, #{num_failures} failures", failures? ? :red : :green
+      end
+
+      def failed(failure)
+        say "#{short_padding}#{failure.stack_trace}:", :red
+        say "#{long_padding}#{failure.message}"
+        say
+      end
+
+      def failures?
+        num_failures > 0
+      end
+
+      def issues?
+        problems? || failures?
+      end
+
+    private
+
+      def report_test_results?
+        @results.success && problems.empty?
+      end
+
+      def test_results
+        @results.run_test_result
+      end
+
+      def failures
+        @failures ||= Array[test_results.failures].compact.flatten
+      end
+
+      def total_time
+        test_results.total_time
+      end
+
+      def num_tests
+        test_results.num_tests_run.to_i
+      end
+
+      def num_failures
+        test_results.num_failures.to_i
+      end
+
+    end
+  end
+end

data/lib/metaforce/reporters/retrieve_reporter.rb

@@ -0,0 +1,11 @@
+require 'metaforce/reporters/base_reporter'
+
+module Metaforce
+  module Reporters
+    class RetrieveReporter < BaseReporter
+      def report
+        report_problems
+      end
+    end
+  end
+end

data/lib/metaforce/services/client.rb

@@ -0,0 +1,84 @@
+module Metaforce
+  module Services
+    class Client < Metaforce::AbstractClient
+      endpoint :server_url
+      wsdl Metaforce.configuration.partner_wsdl
+
+      # Public: Sends an email using Salesforce.
+      #
+      # options - Hash of email options (http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_sendemail.htm)
+      #
+      # Examples
+      #
+      #   client.send_email(
+      #     to_addresses: ['foo@bar.com'],
+      #     subject: 'Hello World',
+      #     plain_text_body: 'Hello World'
+      #   )
+      #
+      # Returns the result.
+      def send_email(options={})
+        request :send_email do |soap|
+          soap.body = {
+            :messages => options,
+            :attributes! => { 'ins0:messages' => { 'xsi:type' => 'ins0:SingleEmailMessage' } }
+          }
+        end
+      end
+
+      # Public: Retrieves layout information for the specified sobject.
+      #
+      # sobject        - String name of the sobject.
+      # record_type_id - String id of a record type to filter on.
+      #
+      # Examples
+      #
+      #  client.describe_layout('Account', '012000000000000AAA')
+      #
+      # Returns the layout metadata for the sobject.
+      def describe_layout(sobject, record_type_id=nil)
+        request :describe_layout do |soap|
+          soap.body = { 'sObjectType' => sobject }
+          soap.body.merge!('recordTypeID' => record_type_id) if record_type_id
+        end
+      end
+
+      # Public: Get active picklists for a record type.
+      #
+      # sobject        - String name of the sobject.
+      # record_type_id - String id of a record type to filter on.
+      # field          - String name of the field to get picklist values for.
+      #
+      # Examples
+      #
+      #   client.picklist_values('Account', '012000000000000AAA', 'Some_Field__c')
+      #   # => [['Label', 'Value']]
+      #
+      # Returns the picklist_values
+      def picklist_values(sobject, record_type_id, field)
+        describe_layout(sobject, record_type_id).record_type_mappings.picklists_for_record_type
+          .select { |p| p.picklist_name == field }.first.picklist_values
+          .select { |p| p.active }.collect { |p| [ p.label, p.value ] }
+      end
+
+      def inspect
+        "#<#{self.class} @options=#{@options.inspect}>"
+      end
+
+      # Public: Retrieves the current system timestamp 
+      #         (Coordinated Universal Time (UTC) time zone) from the API.
+      # 
+      # Example: client.services.send(:get_server_timestamp)
+      def get_server_timestamp
+        request :get_server_timestamp
+      end
+
+      # Public: Retrieves personal information for the user associated 
+      #         with the current session.
+      # Example: client.services.send(:get_user_info)
+      def get_user_info
+        request :get_user_info
+      end
+    end
+  end
+end

data/lib/metaforce/version.rb

@@ -0,0 +1,3 @@
+module Metaforce
+  VERSION = '1.2.0'
+end

data/metaforce.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'metaforce/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'metaforce-beta'
+  s.version     = Metaforce::VERSION
+  s.authors     = ['Tomoaki Abe', 'Masato Igarashi']
+  s.email       = ['abe@enzou.tokyo', 'm@igrs.jp']
+  s.homepage    = 'https://github.com/openlogi/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}
+
+  s.rubyforge_project = 'metaforce-beta'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'savon', '~> 1.2.0'
+  s.add_dependency 'rubyzip', '~> 1.3.0'
+  s.add_dependency 'activesupport', '~> 5.2.4'
+  s.add_dependency 'hashie', '~> 4.0.0'
+  s.add_dependency 'thor', '~> 1.0.1'
+  s.add_dependency 'nokogiri', '1.10.7'
+  s.add_dependency 'listen', '~> 3.2.1'
+
+  s.add_development_dependency 'rake', '~> 13.0.1'
+  s.add_development_dependency 'rspec', '~> 3.9.0'
+  s.add_development_dependency 'rspec-its', '~> 1.3.0'
+  s.add_development_dependency 'webmock', '~> 3.7.6'
+  s.add_development_dependency 'savon_spec', '~> 1.3.0'
+end

data/spec/fixtures/package.xml

@@ -0,0 +1,17 @@
+<?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>26.0</version>
+</Package>

data/spec/fixtures/requests/check_deploy_status/done.xml

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://soap.sforce.com/2006/04/metadata">
+  <soapenv:Body>
+    <checkDeployStatusResponse>
+      <result>
+        <id>04sU0000000WRCXIA4</id>
+        <messages>
+          <changed>true</changed>
+          <created>true</created>
+          <deleted>false</deleted>
+          <fileName>src/classes/TestClass.cls</fileName>
+          <fullName>TestClass</fullName>
+          <id>01pU0000000pDrtIAE</id>
+          <success>true</success>
+        </messages>
+        <messages>
+          <changed>true</changed>
+          <created>false</created>
+          <deleted>false</deleted>
+          <fileName>src/package.xml</fileName>
+          <fullName>package.xml</fullName>
+          <success>true</success>
+        </messages>
+        <runTestResult>
+          <numFailures>0</numFailures>
+          <numTestsRun>0</numTestsRun>
+          <totalTime>-1.0</totalTime>
+        </runTestResult>
+        <success>true</success>
+      </result>
+    </checkDeployStatusResponse>
+  </soapenv:Body>
+</soapenv:Envelope>

data/spec/fixtures/requests/check_deploy_status/error.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://soap.sforce.com/2006/04/metadata">
+  <soapenv:Body>
+    <checkDeployStatusResponse>
+      <result>
+        <id>04sU0000000WRBLIA4</id>
+        <messages>
+          <changed>false</changed>
+          <created>false</created>
+          <deleted>false</deleted>
+          <fileName>classes/package.xml</fileName>
+          <fullName>package.xml</fullName>
+          <problem>No package.xml found</problem>
+          <problemType>Error</problemType>
+          <success>false</success>
+        </messages>
+        <runTestResult>
+          <numFailures>0</numFailures>
+          <numTestsRun>0</numTestsRun>
+          <totalTime>0.0</totalTime>
+        </runTestResult>
+        <success>false</success>
+      </result>
+    </checkDeployStatusResponse>
+  </soapenv:Body>
+</soapenv:Envelope>