Extend 'Client' class with 'create_multiple' and 'bulk_delete' methods

.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.idea
 Gemfile.lock
 InstalledFiles
 _yardoc
@@ -16,3 +17,4 @@ test/tmp
 test/version_tmp
 tmp
 vendor
+

.travis.yml

@@ -1,9 +1,12 @@
 language: ruby
 rvm:
-  - 1.9.3
+  - 2.0.0
+  - 2.1.0
 notifications:
   email:
     recipients:
       - [email protected]
     on_success: never
     on_failure: always
+before_install:
+  - gem install bundler

CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.7.0 (March 4, 2016)
+* Add EntityCollection to xml attributes #24
+* Fix illegal XML characters #25
+* Dynamics optimize metadata queries #26
+* Add Money attribute #31
+* Use `request.bytesize` instead of `request.length` #32
+* Rexml sanitization on username and password for ocp request builder #33
+* Adding new regions to determine region set #34
+* Improve region determination #37
+
 ## 0.6.0 (December 30, 2014)
 
 * Adds support for Relationship Metadata.

dynamics_crm.gemspec

@@ -18,12 +18,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'curb', '~> 0.8', '>= 0.8.5'
-  spec.add_runtime_dependency 'mimemagic', '~> 0.2', '>= 0.2.1'
+  spec.add_runtime_dependency 'curb', '>= 0.8', '< 1.0.0'
+  spec.add_runtime_dependency 'mimemagic', '>= 0.2', '< 4.0.0'
   spec.add_runtime_dependency 'builder', '>= 3.0.0', '< 4.0.0'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler", ">= 1.3", "< 2.0"
   spec.add_development_dependency 'rake', '~> 10.1'
-  spec.add_development_dependency 'rspec', '~> 2.14'
-  spec.add_development_dependency 'simplecov', '~> 0.7'
+  spec.add_development_dependency 'rspec', '>= 2.14', "< 4.0"
+  spec.add_development_dependency 'simplecov', '>= 0.7', "< 1.0"
+  spec.add_development_dependency 'pry', '~> 0.10.3'
 end

lib/dynamics_crm.rb

@@ -17,6 +17,7 @@
 require "dynamics_crm/response/retrieve_multiple_result"
 require "dynamics_crm/response/create_result"
 require "dynamics_crm/response/execute_result"
+require "dynamics_crm/response/execute_multiple_result"
 # Metadata
 require "dynamics_crm/metadata/xml_document"
 require "dynamics_crm/metadata/one_to_many_relationship"

lib/dynamics_crm/client.rb

@@ -18,11 +18,21 @@ class Client
     extend Forwardable
     include XML::MessageBuilder
 
-    attr_accessor :logger, :caller_id, :timeout
+    attr_accessor :logger, :caller_id, :timeout, :security_token0, :security_token1, :key_identifier
     attr_reader :hostname, :region, :organization_endpoint, :login_url
 
     OCP_LOGIN_URL = 'https://login.microsoftonline.com/RST2.srf'
 
+    REGION = {
+      "crm9.dynamics.com" => "urn:crmgcc:dynamics.com",
+      "crm7.dynamics.com" => "urn:crmjpn:dynamics.com",
+      "crm6.dynamics.com" => "urn:crmoce:dynamics.com",
+      "crm5.dynamics.com" => "urn:crmapac:dynamics.com",
+      "crm4.dynamics.com" => "urn:crmemea:dynamics.com",
+      "crm2.dynamics.com" => "urn:crmsam:dynamics.com",
+      "crm.dynamics.com"  => "urn:crmna:dynamics.com",
+    }
+
     # Initializes Client instance.
     # Requires: organization_name
     # Optional: hostname
@@ -32,6 +42,7 @@ def initialize(config={organization_name: nil, hostname: nil, caller_id: nil, lo
       @organization_name = config[:organization_name]
       @hostname = config[:hostname] || "#{@organization_name}.api.crm.dynamics.com"
       @organization_endpoint = "https://#{@hostname}/XRMServices/2011/Organization.svc"
+      REGION.default = @organization_endpoint
       @caller_id = config[:caller_id]
       @timeout = config[:timeout] || 120
 
@@ -83,7 +94,7 @@ def authenticate(username, password)
         @timestamp = '<u:Timestamp xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" u:Id="_0"><u:Created>' + @header_current_time + '</u:Created><u:Expires>' + @header_expires_time + '</u:Expires></u:Timestamp>'
         @digest_value = Digest::SHA1.base64digest @timestamp
         @signature = '<SignedInfo xmlns="http://www.w3.org/2000/09/xmldsig#"><CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"></CanonicalizationMethod><SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#hmac-sha1"></SignatureMethod><Reference URI="#_0"><Transforms><Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"></Transform></Transforms><DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"></DigestMethod><DigestValue>' + @digest_value + '</DigestValue></Reference></SignedInfo>'
-        @signature_value = Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new('sha1'), Base64.decode64(@server_secret), @signature)).chomp
+        @signature_value = Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha1'), Base64.decode64(@server_secret), @signature)).chomp
       else
         cipher_values = document.get_elements("//CipherValue")
 
@@ -112,6 +123,20 @@ def create(entity_name, attributes)
       return Response::CreateResult.new(xml_response)
     end
 
+    def create_multiple(entity_name, attributesArray)
+
+      entities = []
+      attributesArray.each do |attributes|
+        entity = XML::Entity.new(entity_name)
+        entity.attributes = XML::Attributes.new(attributes)
+
+        entities << entity
+      end
+      xml_response = post(organization_endpoint, create_multiple_request(entities))
+
+      return Response::ExecuteMultipleResult.new(xml_response)
+    end
+
     # http://crmtroubleshoot.blogspot.com.au/2013/07/dynamics-crm-2011-php-and-soap-calls.html
     def retrieve(entity_name, guid, columns=[])
 
@@ -160,13 +185,69 @@ def update(entity_name, guid, attributes)
       return Response::UpdateResponse.new(xml_response)
     end
 
+    def update_multiple(entity_name, guids, attributesArray)
+      raise "Number of 'guids' to be updated should be equal to attributes array size" if guids.count != attributesArray.count
+
+      entities = []
+      attributesArray.each_with_index do |attributes, index|
+        entity = XML::Entity.new(entity_name)
+        entity.id = guids[index]
+        entity.attributes = XML::Attributes.new(attributes)
+
+        entities << entity
+      end
+      xml_response = post(organization_endpoint, update_multiple_request(entities))
+
+      return Response::ExecuteMultipleResult.new(xml_response)
+    end
+
     def delete(entity_name, guid)
       request = delete_request(entity_name, guid)
 
       xml_response = post(organization_endpoint, request)
       return Response::DeleteResponse.new(xml_response)
     end
 
+    def delete_multiple(entity_name, guids)
+      entities = []
+      guids.each do |guid|
+        entity = XML::EntityReference.new(entity_name, guid)
+        entity.logical_name = entity_name
+
+        entities << entity
+      end
+      request = delete_multiple_request(entities)
+      xml_response = post(organization_endpoint, request)
+
+      return Response::ExecuteMultipleResult.new(xml_response)
+    end
+
+    def bulk_delete(entity_name, emailToRecipientGuid, criteria=[], wait=false)
+
+      query = XML::Query.new(entity_name)
+      query.criteria = XML::Criteria.new(criteria)
+
+      request = bulk_delete_request(query, emailToRecipientGuid)
+      xml_response = post(organization_endpoint, request)
+
+      response = Response::ExecuteResult.new(xml_response)
+      jobId = response['JobId']
+      if wait && !jobId.nil?
+        while true
+          jobStatus = check_job_status(jobId)
+          if jobStatus != "Waiting For Resources" && jobStatus != "Waiting" && jobStatus != "In Progress"
+            break
+          end
+          sleep(2) # wait x seconds and check again
+        end
+
+        if jobStatus != 'Succeeded'
+          response['errorMessage'] = "The job has not completed with success. The response returned a status of #{jobStatus}. Please check your query/parameters and try again."
+        end
+      end
+      response
+    end
+
     def execute(action, parameters={}, response_class=nil)
       request = execute_request(action, parameters)
       xml_response = post(organization_endpoint, request)
@@ -304,24 +385,8 @@ def login_url
     end
 
     def determine_region
-      case hostname
-      when /crm9\.dynamics\.com/
-        "urn:crmgcc:dynamics.com"
-      when /crm7\.dynamics\.com/
-        "urn:crmjpn:dynamics.com"
-      when /crm6\.dynamics\.com/
-        "urn:crmoce:dynamics.com"
-      when /crm5\.dynamics\.com/
-        "urn:crmapac:dynamics.com"
-      when /crm4\.dynamics\.com/
-        "urn:crmemea:dynamics.com"
-      when /crm2\.dynamics\.com/
-        "urn:crmsam:dynamics.com"
-      when /\.dynamics\.com/
-        "urn:crmna:dynamics.com"
-      else
-        organization_endpoint
-      end
+      hostname.match(/(crm\d?\.dynamics.com)/)
+      REGION[$1]
     end
 
     def post(url, request)
@@ -369,6 +434,13 @@ def formatter
       @formatter
     end
 
+    def check_job_status(job_id)
+      jobStatusResult = self.retrieve_multiple('asyncoperation', [["asyncoperationid", "Equal", job_id]], ["statuscode"])
+      jobStatus = jobStatusResult.entities[0].formatted_values['statuscode'] if jobStatusResult.entities.count > 0
+
+      jobStatus
+    end
+
   end
 
 end

lib/dynamics_crm/response/execute_multiple_result.rb

@@ -0,0 +1,35 @@
+module DynamicsCRM
+  module Response
+    class ExecuteMultipleResult < Result
+
+      protected
+
+      # Returns base element of the response document to parse.
+      def response_element
+        class_name = 'ExecuteResult' if self.is_a?(ExecuteMultipleResult)
+      end
+
+      # Invoked by Result constructor
+      def parse_result_response(result)
+        h = {}
+        result.elements["b:Results"].each_element do |key_value_pair|
+          if key_value_pair.elements["c:key"].text == "Responses"
+            value_element = key_value_pair.elements["c:value"]
+            h[:entities] = []
+            value_element.each_element do |response_item|
+              itemResults = response_item.elements["d:Response"].elements["b:Results"]
+              if !itemResults.nil?
+                h[:entities] << XML::MessageParser.parse_key_value_pairs(itemResults)
+              end
+            end
+            break
+          end
+        end
+
+        h
+      end
+
+    end
+
+  end
+end

lib/dynamics_crm/response/result.rb

@@ -11,7 +11,9 @@ def initialize(xml)
         @document = REXML::Document.new(xml)
 
         fault_xml = @document.get_elements("//[local-name() = 'Fault']")
-        raise XML::Fault.new(fault_xml) if fault_xml.any?
+        code = fault_xml.first.get_elements("//[local-name() = 'Code']") if fault_xml.any?
+        code = fault_xml.first.get_elements("//[local-name() = 'ErrorCode']") if fault_xml.any? && code.blank?
+        raise XML::Fault.new(fault_xml) if fault_xml.any? && !code.empty?
 
         @result_response = @document.get_elements("//#{response_element}").first
 

lib/dynamics_crm/version.rb

@@ -1,3 +1,3 @@
 module DynamicsCRM
-  VERSION = "0.6.0"
+  VERSION = "0.7.1"
 end

lib/dynamics_crm/xml/attributes.rb

@@ -11,6 +11,8 @@ def initialize(attrs)
       def get_type(key, value)
         type = "string"
         case value
+          when ::Array
+            type = "ArrayOfEntity"
           when ::Fixnum
             type = "int"
           when ::BigDecimal, ::Float
@@ -77,7 +79,7 @@ def to_xml
           end
 
           # escape strings to avoid xml parsing errors
-          value = CGI.escapeHTML(value) if type == "string"
+          value = CGI.escapeHTML(value) if value.is_a?(String)
 
           xml << build_xml(key, value, type)
         end
@@ -111,6 +113,13 @@ def build_xml(key, value, type)
       def render_value_xml(type, value)
         xml = ""
         case type
+        when "ArrayOfEntity"
+          raise "We can only serialize Entities inside of ArrayOfEntity" unless value.all?{|a| a.is_a?(DynamicsCRM::XML::Entity)}
+          xml << %Q{
+          <c:value i:type="a:ArrayOfEntity">
+              #{value.map(&->(_) { _.to_xml({in_array: true}) }).join}
+          </c:value>
+        }
         when "EntityReference"
           xml << %Q{
             <c:value i:type="a:EntityReference">
@@ -131,7 +140,11 @@ def render_value_xml(type, value)
             s_namespace = "http://schemas.microsoft.com/xrm/2011/Metadata"
           end
 
-          if type == "guid"
+          if value.nil?
+            xml << %Q{
+              <c:value i:nil="true"></c:value>
+            }
+          elsif type == "guid"
             xml << %Q{
               <c:value xmlns:d="http://schemas.microsoft.com/2003/10/Serialization/" i:type="d:guid">#{value}</c:value>
             }
@@ -154,14 +167,14 @@ def render_value_xml(type, value)
       end
 
       def render_object_xml(type, value)
-          case type
-          when "EntityQueryExpression"
-            xml = %Q{<c:value i:type="d:#{type}" xmlns:d="http://schemas.microsoft.com/xrm/2011/Metadata/Query">} << value.to_xml({namespace: 'd'}) << "</c:value>"
-          else
-            xml = %Q{<c:value i:type="a:#{type}">} << value.to_xml({exclude_root: true, namespace: 'a'}) << "</c:value>"
-          end
+        case type
+        when "EntityQueryExpression"
+          xml = %Q{<c:value i:type="d:#{type}" xmlns:d="http://schemas.microsoft.com/xrm/2011/Metadata/Query">} << value.to_xml({namespace: 'd'}) << "</c:value>"
+        else
+          xml = %Q{<c:value i:type="a:#{type}">} << value.to_xml({exclude_root: true, namespace: 'a'}) << "</c:value>"
+        end
 
-          return xml
+        xml
       end
 
       def class_name

lib/dynamics_crm/xml/entity.rb

@@ -24,11 +24,19 @@ def to_xml(options={})
 
         return inner_xml if options[:exclude_root]
 
-        %Q{
-        <entity xmlns:a="http://schemas.microsoft.com/xrm/2011/Contracts">
-          #{inner_xml}
-        </entity>
-        }
+        if options[:in_array]
+          %Q{
+          <a:Entity>
+            #{inner_xml}
+          </a:Entity>
+          }
+        else
+          %Q{
+          <entity xmlns:a="http://schemas.microsoft.com/xrm/2011/Contracts">
+            #{inner_xml}
+          </entity>
+          }
+        end
       end
 
       def to_hash

lib/dynamics_crm/xml/fault.rb

@@ -13,8 +13,10 @@ def initialize(fault_xml)
         end
         # REXL::Element
         @code = fault_xml.get_text("//[local-name() = 'Code']/[local-name() = 'Value']")
+        @code = fault_xml.get_text("//[local-name() = 'ErrorCode']") if @code.nil? || @code.empty?
         @subcode = fault_xml.get_text("//[local-name() = 'Code']/[local-name() = 'Subcode']/[local-name() = 'Value']")
         @reason = fault_xml.get_text("//[local-name() = 'Reason']/[local-name() = 'Text']")
+        @reason = fault_xml.get_text("//[local-name() = 'Message']") if @reason.nil? || @reason.empty?
 
         @detail = {}
         detail_fragment = fault_xml.get_elements("//[local-name() = 'Detail']").first