dynamics_crm 0.6.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2493af4ed2c1023379591be4833a321457200d8
-  data.tar.gz: 5d48de1485d16926dc2731db51bccd8ce8deeccb
+  metadata.gz: 511b29b2b863fee746767bb6bf4781d043f13969
+  data.tar.gz: 9bffa8007f6f12332be94fb81e447b05c43c88e8
 SHA512:
-  metadata.gz: 0cb157d1b9e89f0c64b6c8c19000728c8a977783434f31dc25af561826308a3deb532204ca6e96eb31fa9a6cd14523ec1c48f6b9586d47c18f8a2702ddf054ca
-  data.tar.gz: a8af9693d74028ed6b8b5e7889e69a60adfe5560ece554f1f82d22ab70d13ecf8ee09c63278bfaf025b428ed4e6cca7957a0be3446ec1d1fbf8b3ba6440983b7
+  metadata.gz: d093920089243f8f13e586cb5815c5b4ff2ddaffa504bd5e41e9de1f9c4e15a3356126e47887373bac5fe29d2b837432c299d97350c3afdd2b938fb3edf28499
+  data.tar.gz: 45c230a953e78736440accdea82c61d77c440b1c5efdd7779a40131d11e9ea91e025ea2a0092889de1dcf8f2b49ab24dbeea483a5fce455079177d075b35e156

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 rvm:
-  - 1.9.3
+  - 2.0.0
+  - 2.1.0
 notifications:
   email:
     recipients:

data/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.

data/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

data/lib/dynamics_crm.rb

@@ -11,6 +11,7 @@ require "dynamics_crm/xml/fetch_expression"
 require "dynamics_crm/xml/entity"
 require "dynamics_crm/xml/entity_reference"
 require "dynamics_crm/xml/entity_collection"
+require "dynamics_crm/xml/money"
 require "dynamics_crm/response/result"
 require "dynamics_crm/response/retrieve_result"
 require "dynamics_crm/response/retrieve_multiple_result"
@@ -22,9 +23,14 @@ require "dynamics_crm/metadata/one_to_many_relationship"
 require "dynamics_crm/metadata/relationship_metadata"
 require "dynamics_crm/metadata/entity_metadata"
 require "dynamics_crm/metadata/attribute_metadata"
+require "dynamics_crm/metadata/attribute_query_expression"
+require "dynamics_crm/metadata/filter_expression"
+require "dynamics_crm/metadata/properties_expression"
+require "dynamics_crm/metadata/entity_query_expression"
 require "dynamics_crm/metadata/retrieve_all_entities_response"
 require "dynamics_crm/metadata/retrieve_entity_response"
 require "dynamics_crm/metadata/retrieve_attribute_response"
+require "dynamics_crm/metadata/retrieve_metadata_changes_response"
 # Model
 require "dynamics_crm/model/entity"
 require "dynamics_crm/model/opportunity"
@@ -42,6 +48,7 @@ require 'mimemagic'
 require 'curl'
 require 'securerandom'
 require 'date'
+require 'cgi'
 
 module DynamicsCRM
 

data/lib/dynamics_crm/client.rb

@@ -18,11 +18,21 @@ module DynamicsCRM
     extend Forwardable
     include XML::MessageBuilder
 
-    attr_accessor :logger, :caller_id
+    attr_accessor :logger, :caller_id, :timeout
     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,7 +42,9 @@ module DynamicsCRM
       @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
 
       # The Login URL and Region are located in the client's Organization WSDL.
       # https://tinderboxdev.api.crm.dynamics.com/XRMServices/2011/Organization.svc?wsdl=wsdl0
@@ -82,7 +94,7 @@ module DynamicsCRM
         @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")
 
@@ -263,6 +275,13 @@ module DynamicsCRM
         Metadata::RetrieveAttributeResponse)
     end
 
+    def retrieve_metadata_changes(entity_query)
+      self.execute("RetrieveMetadataChanges", {
+        Query: entity_query
+      },
+      Metadata::RetrieveMetadataChangesResponse)
+    end
+
     def who_am_i
       self.execute('WhoAmI')
     end
@@ -296,16 +315,8 @@ module DynamicsCRM
     end
 
     def determine_region
-      case hostname
-      when /crm5\.dynamics\.com/
-        "urn:crmapac:dynamics.com"
-      when /crm4\.dynamics\.com/
-        "urn:crmemea: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)
@@ -315,10 +326,10 @@ module DynamicsCRM
         # Set up headers.
         http.headers["Connection"] = "Keep-Alive"
         http.headers["Content-type"] = "application/soap+xml; charset=UTF-8"
-        http.headers["Content-length"] = request.length
+        http.headers["Content-length"] = request.bytesize
 
         http.ssl_verify_peer = false
-        http.timeout = 120
+        http.timeout = timeout
         http.follow_location = true
         http.ssl_version = 1
         # http.verbose = 1

data/lib/dynamics_crm/fetch_xml/builder.rb

@@ -46,60 +46,45 @@ module DynamicsCRM
 
       def to_xml
         @builder = ::Builder::XmlMarkup.new(:indent=>2)
-
         # <fetch version="1.0" output-format="xml-platform" mapping="logical" distinct="false">
-        @builder.fetch(version: @version, :"output-format" => @output_format, mapping: @mapping, distinct: @distinct) {
+        builder.fetch(version: @version, :"output-format" => @output_format, mapping: @mapping, distinct: @distinct) {
           @entities.each do |e|
             # <entity name="opportunityproduct">
-            @builder.entity(name: e.logical_name) {
+            builder.entity(name: e.logical_name) {
               e.attributes.each do |field|
                 # <attribute name="productid" />
-                @builder.attribute(name: field)
+                builder.attribute(name: field)
               end
 
               if e.order_field
-                @builder.order(attribute: e.order_field, descending: e.order_desc)
+                builder.order(attribute: e.order_field, descending: e.order_desc)
               end
 
               add_link_entities(e)
 
-            if e.has_conditions?
-              # <filter type="and">
-              @builder.filter(type: 'and') {
-                e.conditions.each do |c|
-                  # <condition attribute="opportunityid" operator="eq" value="02dd7344-d04a-e411-a9d3-9cb654950300" />
-                  @builder.condition(attribute: c[:attribute], operator: c[:operator], value: c[:value])
-                end
-              }
-            end
+              add_filter_conditions(e) if e.has_conditions?
 
             # </entity>
             }
           end
         }
-        @builder.target!
+        builder.target!
       end
 
       protected
 
+      attr_accessor :builder
+
       def add_link_entities(e)
         e.link_entities.each do |le|
           # <link-entity name="product" from="productid" to="productid" alias="product" link-type="outer">
           # NOTE: Use outer join in case related elements do not exist.
-          @builder.tag!('link-entity', name: le.logical_name, from: le.from, to: le.to, :alias => le.alias, :"link-type" => le.link_type) {
+          builder.tag!('link-entity', name: le.logical_name, from: le.from, to: le.to, :alias => le.alias, :"link-type" => le.link_type) {
             le.attributes.each do |field|
               # <attribute name="name" />
-              @builder.attribute(name: field)
-            end
-            if le.has_conditions?
-              # <filter type="and">
-              @builder.filter(type: 'and') {
-                le.conditions.each do |c|
-                  # <condition attribute="opportunityid" operator="eq" value="02dd7344-d04a-e411-a9d3-9cb654950300" />
-                  @builder.condition(attribute: c[:attribute], operator: c[:operator], value: c[:value])
-                end
-              }
+              builder.attribute(name: field)
             end
+            add_filter_conditions(le) if le.has_conditions?
 
             # Support nested link-entity elements. Recursive.
             add_link_entities(le)
@@ -108,6 +93,20 @@ module DynamicsCRM
         end
       end
 
+      def add_filter_conditions(e)
+        builder.filter(type: 'and') {
+          e.conditions.each do |c|
+            if 'in' == c[:operator]
+              builder.condition(attribute: c[:attribute], operator: c[:operator]) do 
+                c[:value].each {|v| builder.value v }
+              end
+            else
+              builder.condition(attribute: c[:attribute], operator: c[:operator], value: c[:value])
+            end
+          end
+        }
+      end
+
     end
   end
-end
+end

data/lib/dynamics_crm/metadata/attribute_metadata.rb

@@ -36,7 +36,40 @@ module DynamicsCRM
         @picklist_options
       end
 
-    end
+      def type
+        return @type if @type
+
+        type_metadata = "./d:AttributeType"
+        @type = @document.get_text(type_metadata).to_s
+      end
+
+      def logical_name
+        return @logical_name if @logical_name
 
+        logical_name_metadata = "./d:LogicalName"
+        @logical_name = @document.get_text(logical_name_metadata).to_s
+      end
+
+      def display_name
+        return @display_name if @display_name
+
+        display_name_metadata = "./d:DisplayName/b:LocalizedLabels/b:LocalizedLabel/b:Label"
+        @display_name = @document.get_text(display_name_metadata).to_s
+      end
+
+      def attribute_of
+        return @attribute_of if @attribute_of
+
+        attribute_of_metadata = "./d:AttributeOf"
+        @attribute_of = @document.get_text(attribute_of_metadata).to_s
+      end
+
+      def required_level
+        return @required_level if @required_level
+
+        required_level_metadata = "./d:RequiredLevel/b:Value"
+        @required_level = @document.get_text(required_level_metadata).to_s
+      end
+    end
   end
-end
+end

data/lib/dynamics_crm/metadata/attribute_query_expression.rb

@@ -0,0 +1,25 @@
+module DynamicsCRM
+  module Metadata
+
+    class AttributeQueryExpression
+      attr_accessor :criteria, :properties
+
+      def initialize(criteria, properties)
+        @criteria = criteria
+        @properties = properties
+      end
+
+      def to_xml(options={})
+        namespace = options[:namespace] ? options[:namespace] : 'b'
+
+        xml = %Q{<#{namespace}:AttributeQuery>}
+        xml << @criteria.to_xml({namespace: namespace}) if @criteria
+        xml << @properties.to_xml({namespace: namespace}) if @properties
+        xml << %Q{</#{namespace}:AttributeQuery>}
+
+        return xml
+      end
+    end
+
+  end
+end

data/lib/dynamics_crm/metadata/entity_metadata.rb

@@ -14,7 +14,7 @@ module DynamicsCRM
       def attributes
         return if @attributes.is_a?(Array)
 
-        @attributes = document.get_elements("//d:Attributes/d:AttributeMetadata").collect do |attr_metadata|
+        @attributes = document.get_elements("d:Attributes/d:AttributeMetadata").collect do |attr_metadata|
           AttributeMetadata.new(attr_metadata)
         end
 

data/lib/dynamics_crm/metadata/entity_query_expression.rb

@@ -0,0 +1,29 @@
+module DynamicsCRM
+  module Metadata
+
+    class EntityQueryExpression
+
+      attr_accessor :criteria, :properties, :attribute_query
+
+      def initialize(options={})
+        @criteria = options[:criteria]
+        @properties = options[:properties]
+        @attribute_query = options[:attribute_query]
+      end
+
+      def to_xml(options={})
+        namespace = options[:namespace] ? options[:namespace] : "b"
+
+        xml = ""
+        xml << @criteria.to_xml({namespace: namespace}) if @criteria
+        xml << @properties.to_xml({namespace: namespace}) if @properties
+        xml << @attribute_query.to_xml({namespace: namespace}) if @attribute_query
+        xml << "<#{namespace}:ExtensionData i:nil='true' />"
+        xml << "<#{namespace}:LabelQuery  i:nil='true' />"
+        xml << "<#{namespace}:RelationshipQuery i:nil='true' />"
+        xml
+      end
+    end
+
+  end
+end

data/lib/dynamics_crm/metadata/filter_expression.rb

@@ -0,0 +1,47 @@
+module DynamicsCRM
+  module Metadata
+
+    class FilterExpression
+      attr_accessor :operator, :conditions
+
+      def initialize(operator, conditions=[])
+        @operator   = operator || 'And'
+        @conditions = conditions
+      end
+
+      def add_condition(condition)
+        @conditions << condition
+      end
+
+      def get_type(value)
+          type = value.class.to_s.downcase
+          type = "int" if type == "fixnum"
+          type = "boolean" if ["trueclass", "falseclass"].include?(type)
+          type
+      end
+
+      def to_xml(options={})
+        ns = options[:namespace] ? options[:namespace] : "a"
+
+        expressions = ""
+        @conditions.each do |condition|
+          attr_name, op, value = condition
+
+          expressions << %Q{
+            <#{ns}:MetadataConditionExpression>
+              <#{ns}:PropertyName>#{attr_name}</#{ns}:PropertyName>
+              <#{ns}:ConditionOperator>#{op}</#{ns}:ConditionOperator>
+              <#{ns}:Value i:type='e:#{get_type(value)}' xmlns:e='http://www.w3.org/2001/XMLSchema'>#{value}</#{ns}:Value>
+           </#{ns}:MetadataConditionExpression>}
+        end
+
+        %Q{<#{ns}:Criteria>
+            <#{ns}:Conditions>
+              #{expressions}
+            </#{ns}:Conditions>
+            <#{ns}:FilterOperator>#{@operator}</#{ns}:FilterOperator>
+        </#{ns}:Criteria>}
+      end
+    end
+  end
+end

data/lib/dynamics_crm/metadata/properties_expression.rb

@@ -0,0 +1,30 @@
+module DynamicsCRM
+  module Metadata
+
+    class PropertiesExpression
+      attr_accessor :properties
+
+      def initialize(properties=[])
+        @properties = properties
+      end
+
+      def to_xml(options={})
+        namespace = options[:namespace] ? options[:namespace] + ":" : ""
+
+        property_set = ''
+        if @properties.any?
+          property_set = %Q{<#{namespace}PropertyNames xmlns:e="http://schemas.microsoft.com/2003/10/Serialization/Arrays">}
+          @properties.each do |name|
+            property_set << "<e:string>#{name}</e:string>"
+          end
+          property_set << "</#{namespace}PropertyNames>"
+        end
+
+        %Q{<#{namespace}Properties>
+             <#{namespace}AllProperties>#{property_set.empty?}</#{namespace}AllProperties>
+             #{property_set}
+           </#{namespace}Properties>}
+      end
+    end
+  end
+end