dynamics_crm 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e726f9c76ea10016d1fcc9de700cc4126c5894c1
-  data.tar.gz: 9693bc3f8691b6195c180e97adb21fbe2029b186
+  metadata.gz: cdf1c64a56314592ae09085cc30e1247305464bd
+  data.tar.gz: 00888ab3d1d5a161d9d3cd84c47d85cb93292f92
 SHA512:
-  metadata.gz: 39593d695f63ca92ee16d6b353de089af278bcec8126be15a80172cd238dfa63b491f72ed2137db91d99a6b205c92fa708a61f814d9c2b6cd053f2bef25548d7
-  data.tar.gz: a17258a4d2893e5c399b49f3fae697c8647ca912da234201b5219f95bc67d5a8793ab3e73fe18682852f9387be4fe9b1ef3bfde9e6cd75559cb8a127721534d5
+  metadata.gz: 24296b01888a6fbda086b4859afbaf469e90d8bab700611b9ffe2e0bff6af0dfe9c25f86227f344404ad2d95958b4edc833095a6283b3f0cb8fa2822c04b6135
+  data.tar.gz: 673a47e6a007d99ca77224402a9c43af449f2fd264629d4ecbfa66c05f5709f99b14b7e042f163cf5e72d3e72d0ef0f133f18ee839fce46b0c1627fe9ef7af78

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.4.0 (October 11, 2014)
+
+* Adds FetchXml module (Builder, Entity, LinkEntity) for building Xml document. (New dependency on builder)
+* Merge PR #15 - Adds EntityCollection object used by Client#fetch response.
+
 ## 0.3.0 (October 11, 2014)
 
 * Merge PR #12 - Adds support for Entity FormattedValues

data/README.md

@@ -45,6 +45,25 @@ client.retrieve_multiple('account', [["name", "Equal", "Test Account"], ["Name,
 # => [#<DynamicsCRM::XML::Entity ... >]
 ```
 
+### fetch (FetchXml)
+
+```ruby
+xml = %Q{<fetch version="1.0" output-format="xml-platform" mapping="logical" distinct="false">
+  <entity name="opportunityproduct">
+    <attribute name="opportunityproductid" />
+    <attribute name="productid" />
+    <attribute name="productdescription" />
+    <attribute name="priceperunit" />
+    <attribute name="quantity" />
+    <order attribute="productid" descending="false" />
+  </entity>
+</fetch>}
+
+result = client.fetch(xml)
+# => #<DynamicsCRM::XML::EntityCollection>
+# result.entity_name => 'opportunityproduct'
+# result.entities => [DynamicsCRM::XML::Entity, ...]
+```
 
 ### create
 

data/dynamics_crm.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'curb', '~> 0.8', '>= 0.8.5'
   spec.add_runtime_dependency 'mimemagic', '~> 0.2', '>= 0.2.1'
+  spec.add_runtime_dependency 'builder', '~> 3.2.2', '>= 3.2.2'
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency 'rake', '~> 10.1'

data/lib/dynamics_crm/client.rb

@@ -115,6 +115,7 @@ module DynamicsCRM
       response = self.execute("RetrieveMultiple", {
         Query: XML::FetchExpression.new(fetchxml)
       })
+      response['EntityCollection']
     end
 
     # Update entity attributes

data/lib/dynamics_crm/fetch_xml/builder.rb

@@ -0,0 +1,101 @@
+require 'builder'
+
+# <fetch version="1.0" output-format="xml-platform" mapping="logical" distinct="false">
+#   <entity name="opportunityproduct">
+#     <attribute name="productid" />
+#     <attribute name="productdescription" />
+#     <attribute name="priceperunit" />
+#     <attribute name="quantity" />
+#     <attribute name="extendedamount" />
+#     <attribute name="opportunityproductid" />
+#     <order attribute="productid" descending="false" />
+#     <link-entity name="product" from="productid" to="productid" alias="product">
+#       <attribute name="name" />
+#       <attribute name="producttypecode" />
+#       <attribute name="price" />
+#       <attribute name="standardcost" />
+#       <attribute name="currentcost" />
+#     </link-entity>
+#     <link-entity name="opportunity" from="opportunityid" to="opportunityid" alias="opportunity">
+#       <filter type="and">
+#           <condition attribute="opportunityid" operator="eq" value="02dd7344-d04a-e411-a9d3-9cb654950300" />
+#       </filter>
+#     </link-entity>
+#   </entity>
+# </fetch>
+module DynamicsCRM
+  module FetchXml
+
+    class Builder
+      attr_accessor :version, :output_format, :mapping, :distinct
+
+      def initialize(options={})
+        @builder = ::Builder::XmlMarkup.new(:indent=>2)
+        @entities = []
+        @link_entities = []
+
+        @version = options[:version] || '1.0'
+        @output_format = options[:output_format] || 'xml-platform'
+        @mapping = options[:mapping] || 'logical'
+        @distinct = options[:distinct] || false
+      end
+
+      def entity(logical_name)
+        @entities << Entity.new(logical_name)
+        @entities.last
+      end
+
+      def to_xml
+        # <fetch version="1.0" output-format="xml-platform" mapping="logical" distinct="false">
+        @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) {
+              e.attributes.each do |field|
+                # <attribute name="productid" />
+                @builder.attribute(name: field)
+              end
+
+              if e.order_field
+                @builder.order(attribute: e.order_field, descending: e.order_desc)
+              end
+
+              add_link_entities(e)
+
+            # </entity>
+            }
+          end
+        }
+        @builder.target!
+      end
+
+      protected
+
+      def add_link_entities(e)
+        e.link_entities.each do |le|
+          # <link-entity name="product" from="productid" to="productid" alias="product">
+          @builder.tag!('link-entity', name: le.logical_name, from: le.from, to: le.to, :alias => le.alias) {
+            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
+              }
+            end
+
+            # Support nested link-entity elements. Recursive.
+            add_link_entities(le)
+          }
+          # </link-entity>
+        end
+      end
+
+    end
+  end
+end

data/lib/dynamics_crm/fetch_xml/entity.rb

@@ -0,0 +1,34 @@
+module DynamicsCRM
+  module FetchXml
+    class Entity
+      attr_reader :logical_name, :attributes
+      attr_reader :order_field, :order_desc
+      attr_reader :link_entities
+
+      def initialize(logical_name, options={})
+        # options used by LinkEntity subclass
+        @logical_name = logical_name
+        @attributes = []
+        @link_entities = []
+      end
+
+      def add_attributes(field_names=nil)
+        @attributes = field_names
+        self
+      end
+
+      # <order attribute="productid" descending="false" />
+      def order(field_name, descending=false)
+        @order_field = field_name
+        @order_desc = descending
+        self
+      end
+
+      def link_entity(logical_name, attributes={})
+        @link_entities << LinkEntity.new(logical_name, attributes)
+        @link_entities.last
+      end
+
+    end
+  end
+end

data/lib/dynamics_crm/fetch_xml/link_entity.rb

@@ -0,0 +1,28 @@
+module DynamicsCRM
+  module FetchXml
+    class LinkEntity < FetchXml::Entity
+      attr_accessor :from, :to, :alias, :conditions
+
+      def initialize(logical_name, options={})
+          super
+          @from = options[:from]|| "#{logical_name}id"
+          @to = options[:to] || "#{logical_name}id"
+          @alias = options[:alias] || logical_name
+          @conditions = []
+      end
+
+      def add_condition(attribute, operator, value)
+        @conditions << {
+          attribute: attribute,
+          operator: operator,
+          value: value
+        }
+        self
+      end
+
+      def has_conditions?
+        @conditions.any?
+      end
+    end
+  end
+end

data/lib/dynamics_crm/response/retrieve_multiple_result.rb

@@ -13,15 +13,7 @@ module DynamicsCRM
           next if el.name == "Entities"
 
           # Convert text to actual data types.
-          value = el.text
-          if value == "true" || value == "false"
-            value = (value == "true")
-          elsif value =~ /^[-?]\d+$/
-            value = value.to_i
-          elsif value =~ /^[-?]\d+\.\d+$/
-            value = value.to_f
-          end
-          h[el.name] = value
+          h[el.name] = ::DynamicsCRM::StringUtil.valueOf(el.text)
         end
 
         h[:entities] = []

data/lib/dynamics_crm/version.rb

@@ -1,3 +1,3 @@
 module DynamicsCRM
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/dynamics_crm/xml/entity_collection.rb

@@ -0,0 +1,43 @@
+module DynamicsCRM
+  module XML
+
+    class EntityCollection
+
+      attr_accessor :entity_name, :min_active_row_version, :more_records, :paging_cookie,
+        :total_record_count, :total_record_count_limit_exceeded, :entities
+
+      def initialize(xml_document)
+        @entities = []
+
+        if xml_document
+          xml_document.each_element do |node|
+            attr_name = ::DynamicsCRM::StringUtil.underscore(node.name).to_sym
+            if node.name == "Entities"
+              node.elements.each do |entity_xml|
+                @entities << XML::Entity.from_xml(entity_xml)
+              end
+            elsif self.respond_to?(attr_name)
+              value = node.text ? ::DynamicsCRM::StringUtil.valueOf(node.text.strip) : nil
+              self.send("#{attr_name}=", value)
+            end
+          end
+        end
+
+      end
+
+      def to_hash
+        {
+          :entity_name => entity_name,
+          :min_active_row_version => min_active_row_version,
+          :more_records => more_records,
+          :paging_cookie => paging_cookie,
+          :total_record_count => total_record_count,
+          :total_record_count_limit_exceeded => total_record_count_limit_exceeded,
+          :entities => entities
+        }
+      end
+
+    end
+    # EntityCollection
+  end
+end

data/lib/dynamics_crm/xml/fetch_expression.rb

@@ -1,5 +1,5 @@
 module DynamicsCRM
-  module XML    
+  module XML
     class FetchExpression
 
       def initialize(fetch_xml)

data/lib/dynamics_crm/xml/message_parser.rb

@@ -34,11 +34,7 @@ module DynamicsCRM
               end
               value = entity_ref
             when "b:EntityCollection"
-              collection = []
-              value_element.elements["b:Entities"].elements.each  do |entity_xml|
-                collection << XML::Entity.from_xml(entity_xml)
-              end
-              value = collection
+              value = XML::EntityCollection.new(value_element)
             when "d:EntityMetadata", /^d:\w*AttributeMetadata$/
               value = value_element
             when "d:ArrayOfEntityMetadata"

data/lib/dynamics_crm.rb

@@ -10,6 +10,7 @@ require "dynamics_crm/xml/query"
 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/response/result"
 require "dynamics_crm/response/retrieve_result"
 require "dynamics_crm/response/retrieve_multiple_result"
@@ -25,6 +26,10 @@ require "dynamics_crm/metadata/retrieve_attribute_response"
 # Model
 require "dynamics_crm/model/entity"
 require "dynamics_crm/model/opportunity"
+# Fetch XML
+require "dynamics_crm/fetch_xml/entity"
+require 'dynamics_crm/fetch_xml/link_entity'
+require "dynamics_crm/fetch_xml/builder"
 # Client
 require "dynamics_crm/client"
 
@@ -36,7 +41,7 @@ require 'curl'
 require 'securerandom'
 require 'date'
 
-module DynamicsCRM 
+module DynamicsCRM
 
   class StringUtil
     def self.underscore(str)
@@ -46,6 +51,20 @@ module DynamicsCRM
         tr("-", "_").
         downcase
     end
+
+    def self.valueOf(text)
+      # Convert text to actual data types.
+      value = text
+      if value == "true" || value == "false"
+        value = (value == "true")
+      elsif value =~ /^[-?]\d+$/
+        value = value.to_i
+      elsif value =~ /^[-?]\d+\.\d+$/
+        value = value.to_f
+      else
+        value
+      end
+    end
   end
 
 end

data/spec/lib/client_spec.rb

@@ -70,6 +70,14 @@ describe DynamicsCRM::Client do
       result = subject.retrieve_multiple("account", ["name", "Equal", "Test Account"], columns=[])
 
       result.should be_a(DynamicsCRM::Response::RetrieveMultipleResult)
+
+      expect(result['EntityName']).to eq('account')
+      expect(result['MinActiveRowVersion']).to eq(-1)
+      expect(result['MoreRecords']).to eq(false)
+      expect(result['PagingCookie']).not_to be_empty
+      expect(result['TotalRecordCount']).to eq(-1)
+      expect(result['TotalRecordCountLimitExceeded']).to eq(false)
+
       result.entities.size.should == 3
       entities = result.entities
 
@@ -112,13 +120,19 @@ describe DynamicsCRM::Client do
         </fetch>
       }
 
-      result = subject.fetch(xml)
+      entity_collection = subject.fetch(xml)
+      entity_collection.should be_a(DynamicsCRM::XML::EntityCollection)
 
-      result.should be_a(DynamicsCRM::Response::ExecuteResult)
+      expect(entity_collection.entity_name).to eq('new_tinderboxdocument')
+      expect(entity_collection.min_active_row_version).to eq(-1)
+      expect(entity_collection.more_records).to eq(false)
+      expect(entity_collection.paging_cookie).not_to be_empty
+      expect(entity_collection.total_record_count).to eq(-1)
+      expect(entity_collection.total_record_count_limit_exceeded).to eq(false)
 
-      result["EntityCollection"].size.should == 3
+      expect(entity_collection.entities.size).to eq(3)
 
-      entity = result["EntityCollection"].first
+      entity = entity_collection.entities.first
       entity.id.should == "9c27cf91-ada3-e311-b64f-6c3be5a87df0"
       entity.logical_name.should == "new_tinderboxdocument"
       entity.attributes["new_tinderboxdocumentid"].should == entity.id

data/spec/lib/fetch_xml/builder_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe DynamicsCRM::FetchXml::Builder do
+
+  describe 'xml' do
+    let(:opportunity_product_fields) {
+      ['productid', 'productdescription', 'priceperunit', 'quantity', 'extendedamount', 'opportunityproductid']
+    }
+    let(:product_fields) {
+      ['name', 'producttypecode', 'price', 'standardcost', 'currentcost']
+    }
+
+    context "entity" do
+      it "builds a single entity" do
+        subject.entity('opportunityproduct').add_attributes(opportunity_product_fields)
+        expect(subject.to_xml).to eq %Q{<fetch version="1.0" output-format="xml-platform" mapping="logical" distinct="false">
+  <entity name="opportunityproduct">
+    <attribute name="productid"/>
+    <attribute name="productdescription"/>
+    <attribute name="priceperunit"/>
+    <attribute name="quantity"/>
+    <attribute name="extendedamount"/>
+    <attribute name="opportunityproductid"/>
+  </entity>
+</fetch>
+}
+      end
+
+      it "builds a single entity with order" do
+        subject.entity('opportunityproduct').add_attributes(opportunity_product_fields).order('productid')
+        expect(subject.to_xml).to eq %Q{<fetch version="1.0" output-format="xml-platform" mapping="logical" distinct="false">
+  <entity name="opportunityproduct">
+    <attribute name="productid"/>
+    <attribute name="productdescription"/>
+    <attribute name="priceperunit"/>
+    <attribute name="quantity"/>
+    <attribute name="extendedamount"/>
+    <attribute name="opportunityproductid"/>
+    <order attribute="productid" descending="false"/>
+  </entity>
+</fetch>
+}
+      end
+
+    end
+
+    context "link_entity" do
+      it "builds entity with link_entity" do
+        entity = subject.entity('opportunityproduct').add_attributes(opportunity_product_fields).order('productid')
+        entity.link_entity('product', to: 'productid', from: 'productid', :alias => 'prod').add_attributes(product_fields)
+        expect(subject.to_xml).to eq %Q{<fetch version="1.0" output-format="xml-platform" mapping="logical" distinct="false">
+  <entity name="opportunityproduct">
+    <attribute name="productid"/>
+    <attribute name="productdescription"/>
+    <attribute name="priceperunit"/>
+    <attribute name="quantity"/>
+    <attribute name="extendedamount"/>
+    <attribute name="opportunityproductid"/>
+    <order attribute="productid" descending="false"/>
+    <link-entity name="product" from="productid" to="productid" alias="prod">
+      <attribute name="name"/>
+      <attribute name="producttypecode"/>
+      <attribute name="price"/>
+      <attribute name="standardcost"/>
+      <attribute name="currentcost"/>
+    </link-entity>
+  </entity>
+</fetch>
+}
+      end
+    end
+
+    context "link_entity condition" do
+      it "builds entity with two link_entity and condition" do
+        entity = subject.entity('opportunityproduct').add_attributes(opportunity_product_fields).order('productid')
+        entity.link_entity('product', to: 'productid', from: 'productid', :alias => 'prod').add_attributes(product_fields)
+        entity.link_entity('opportunity', :alias => 'oppty').
+          add_condition('opportunityid', 'eq', '02dd7344-d04a-e411-a9d3-9cb654950300')
+        expect(subject.to_xml).to eq %Q{<fetch version="1.0" output-format="xml-platform" mapping="logical" distinct="false">
+  <entity name="opportunityproduct">
+    <attribute name="productid"/>
+    <attribute name="productdescription"/>
+    <attribute name="priceperunit"/>
+    <attribute name="quantity"/>
+    <attribute name="extendedamount"/>
+    <attribute name="opportunityproductid"/>
+    <order attribute="productid" descending="false"/>
+    <link-entity name="product" from="productid" to="productid" alias="prod">
+      <attribute name="name"/>
+      <attribute name="producttypecode"/>
+      <attribute name="price"/>
+      <attribute name="standardcost"/>
+      <attribute name="currentcost"/>
+    </link-entity>
+    <link-entity name="opportunity" from="opportunityid" to="opportunityid" alias="oppty">
+      <filter type="and">
+        <condition attribute="opportunityid" operator="eq" value="02dd7344-d04a-e411-a9d3-9cb654950300"/>
+      </filter>
+    </link-entity>
+  </entity>
+</fetch>
+}
+      end
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynamics_crm
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Joe Heth
@@ -50,6 +50,26 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -124,6 +144,9 @@ files:
 - dynamics_crm.gemspec
 - lib/dynamics_crm.rb
 - lib/dynamics_crm/client.rb
+- lib/dynamics_crm/fetch_xml/builder.rb
+- lib/dynamics_crm/fetch_xml/entity.rb
+- lib/dynamics_crm/fetch_xml/link_entity.rb
 - lib/dynamics_crm/metadata/attribute_metadata.rb
 - lib/dynamics_crm/metadata/entity_metadata.rb
 - lib/dynamics_crm/metadata/retrieve_all_entities_response.rb
@@ -142,6 +165,7 @@ files:
 - lib/dynamics_crm/xml/column_set.rb
 - lib/dynamics_crm/xml/criteria.rb
 - lib/dynamics_crm/xml/entity.rb
+- lib/dynamics_crm/xml/entity_collection.rb
 - lib/dynamics_crm/xml/entity_reference.rb
 - lib/dynamics_crm/xml/fault.rb
 - lib/dynamics_crm/xml/fetch_expression.rb
@@ -170,6 +194,7 @@ files:
 - spec/fixtures/who_am_i_result.xml
 - spec/fixtures/win_opportunity_response.xml
 - spec/lib/client_spec.rb
+- spec/lib/fetch_xml/builder_spec.rb
 - spec/lib/metadata/entity_metadata_spec.rb
 - spec/lib/metadata/retrieve_all_entities_response_spec.rb
 - spec/lib/metadata/retrieve_attribute_response_spec.rb
@@ -232,6 +257,7 @@ test_files:
 - spec/fixtures/who_am_i_result.xml
 - spec/fixtures/win_opportunity_response.xml
 - spec/lib/client_spec.rb
+- spec/lib/fetch_xml/builder_spec.rb
 - spec/lib/metadata/entity_metadata_spec.rb
 - spec/lib/metadata/retrieve_all_entities_response_spec.rb
 - spec/lib/metadata/retrieve_attribute_response_spec.rb