odata4 0.7.0

data/lib/odata4/property_registry.rb

@@ -0,0 +1,41 @@
+require 'singleton'
+
+module OData4
+  # Provides a registry for keeping track of various property types used by
+  # OData4.
+  class PropertyRegistry
+    include Singleton
+
+    # Add a property type to the registry
+    #
+    # @param type_name [String] property type name to register
+    # @param klass [Class] Ruby class to use for the specified type
+    def add(type_name, klass)
+      properties[type_name] = klass
+    end
+
+    # Lookup a property by name and get the Ruby class to use for its instances
+    #
+    # @param type_name [String] the type name to lookup
+    # @return [Class, nil] the proper class or nil
+    def [](type_name)
+      properties[type_name]
+    end
+
+    # (see #add)
+    def self.add(type_name, klass)
+      OData4::PropertyRegistry.instance.add(type_name, klass)
+    end
+
+    # (see #[])
+    def self.[](type_name)
+      OData4::PropertyRegistry.instance[type_name]
+    end
+
+    private
+
+    def properties
+      @properties ||= {}
+    end
+  end
+end

data/lib/odata4/query.rb

@@ -0,0 +1,231 @@
+module OData4
+  # OData4::Query provides the query interface for requesting Entities matching
+  # specific criteria from an OData4::EntitySet. This class should not be
+  # instantiated directly, but can be. Normally you will access a Query by
+  # first asking for one from the OData4::EntitySet you want to query.
+  class Query
+    attr_reader :options
+
+    include InBatches
+
+    # Create a new Query for the provided EntitySet
+    # @param entity_set [OData4::EntitySet]
+    # @param options [Hash] Query options
+    def initialize(entity_set, options = {})
+      @entity_set = entity_set
+      @options    = options
+      setup_empty_criteria_set
+    end
+
+    # Instantiates an OData4::Query::Criteria for the named property.
+    # @param property [to_s]
+    def [](property)
+      property_instance = @entity_set.new_entity.get_property(property)
+      property_instance = property if property_instance.nil?
+      OData4::Query::Criteria.new(property: property_instance)
+    end
+
+    # Find the Entity with the supplied key value.
+    # @param key [to_s] primary key to lookup
+    # @return [OData4::Entity,nil]
+    def find(key)
+      entity = @entity_set.new_entity
+      key_property = entity.get_property(entity.primary_key)
+      key_property.value = key
+
+      pathname = "#{entity_set.name}(#{key_property.url_value})"
+      query = [pathname, assemble_criteria].compact.join('?')
+      execute(query).first
+    end
+
+    # Adds a filter criteria to the query.
+    # For filter syntax see https://msdn.microsoft.com/en-us/library/gg309461.aspx
+    # Syntax:
+    #   Property Operator Value
+    #
+    # For example:
+    #   Name eq 'Customer Service'
+    #
+    # Operators:
+    # eq, ne, gt, ge, lt, le, and, or, not
+    #
+    # Value
+    #  can be 'null', can use single quotes
+    # @param criteria
+    def where(criteria)
+      criteria_set[:filter] << criteria
+      self
+    end
+
+    # Adds a fulltext search term to the query
+    # NOTE: May not be implemented by the service
+    # @param term [String]
+    def search(term)
+      criteria_set[:search] << term
+      self
+    end
+
+    # Adds a filter criteria to the query with 'and' logical operator.
+    # @param criteria
+    #def and(criteria)
+    #
+    #end
+
+    # Adds a filter criteria to the query with 'or' logical operator.
+    # @param criteria
+    #def or(criteria)
+    #
+    #end
+
+    # Specify properties to order the result by.
+    # Can use 'desc' like 'Name desc'
+    # @param properties [Array<Symbol>]
+    # @return [self]
+    def order_by(*properties)
+      criteria_set[:orderby] += properties
+      self
+    end
+
+    # Specify associations to expand in the result.
+    # @param associations [Array<Symbol>]
+    # @return [self]
+    def expand(*associations)
+      criteria_set[:expand] += associations
+      self
+    end
+
+    # Specify properties to select within the result.
+    # @param properties [Array<Symbol>]
+    # @return [self]
+    def select(*properties)
+      criteria_set[:select] += properties
+      self
+    end
+
+    # Add skip criteria to query.
+    # @param value [to_i]
+    # @return [self]
+    def skip(value)
+      criteria_set[:skip] = value.to_i
+      self
+    end
+
+    # Add limit criteria to query.
+    # @param value [to_i]
+    # @return [self]
+    def limit(value)
+      criteria_set[:top] = value.to_i
+      self
+    end
+
+    # Add inline count criteria to query.
+    # Not Supported in CRM2011
+    # @return [self]
+    def include_count
+      criteria_set[:inline_count] = true
+      self
+    end
+
+    # Convert Query to string.
+    # @return [String]
+    def to_s
+      [entity_set.name, assemble_criteria].compact.join('?')
+    end
+
+    # Execute the query.
+    # @return [OData4::Query::Result]
+    def execute(query = self.to_s)
+      response = service.execute(query, options)
+      OData4::Query::Result.new(self, response)
+    end
+
+    # Executes the query to get a count of entities.
+    # @return [Integer]
+    def count
+      url_chunk = ["#{entity_set.name}/$count", assemble_criteria].compact.join('?')
+      response = service.execute(url_chunk)
+      # Some servers (*cough* Microsoft *cough*) seem to
+      # return extraneous characters in the response.
+      response.body.scan(/\d+/).first.to_i
+    end
+
+    # Checks whether a query will return any results by calling #count
+    # @return [Boolean]
+    def empty?
+      self.count == 0
+    end
+
+    # The EntitySet for this query.
+    # @return [OData4::EntitySet]
+    # @api private
+    def entity_set
+      @entity_set
+    end
+
+    # The service for this query
+    # @return [OData4::Service]
+    # @api private
+    def service
+      @service ||= entity_set.service
+    end
+
+    private
+
+    def criteria_set
+      @criteria_set
+    end
+
+    def setup_empty_criteria_set
+      @criteria_set = {
+        filter:       [],
+        search:       [],
+        select:       [],
+        expand:       [],
+        orderby:      [],
+        skip:         0,
+        top:          0,
+        inline_count: false
+      }
+    end
+
+    def assemble_criteria
+      criteria = [
+        filter_criteria,
+        search_criteria,
+        list_criteria(:orderby),
+        list_criteria(:expand),
+        list_criteria(:select),
+        inline_count_criteria,
+        paging_criteria(:skip),
+        paging_criteria(:top)
+      ].compact!
+
+      criteria.empty? ? nil : criteria.join('&')
+    end
+
+    def filter_criteria
+      return nil if criteria_set[:filter].empty?
+      filters = criteria_set[:filter].collect(&:to_s)
+      "$filter=#{filters.join(' and ')}"
+    end
+
+    def search_criteria
+      return nil if criteria_set[:search].empty?
+      filters = criteria_set[:search].collect(&:to_s)
+      "$search=#{filters.join(' AND ')}"
+    end
+
+    def list_criteria(name)
+      criteria_set[name].empty? ? nil : "$#{name}=#{criteria_set[name].join(',')}"
+    end
+
+    # inlinecount not supported by Microsoft CRM 2011
+    def inline_count_criteria
+      criteria_set[:inline_count] ? '$count=true' : nil
+    end
+
+    def paging_criteria(name)
+      criteria_set[name] == 0 ? nil : "$#{name}=#{criteria_set[name]}"
+    end
+  end
+end

data/lib/odata4/query/criteria.rb

@@ -0,0 +1,92 @@
+require 'odata4/query/criteria/comparison_operators'
+require 'odata4/query/criteria/string_functions'
+require 'odata4/query/criteria/date_functions'
+require 'odata4/query/criteria/geography_functions'
+require 'odata4/query/criteria/lambda_operators'
+
+module OData4
+  class Query
+    # Represents a discreet criteria within an OData4::Query. Should not,
+    # normally, be instantiated directly.
+    class Criteria
+      # The property name that is the target of the criteria.
+      attr_reader :property
+      # The operator of the criteria.
+      attr_reader :operator
+      # The value of the criteria.
+      attr_reader :value
+      # A function to apply to the property.
+      attr_reader :function
+      # An optional argument to the function.
+      attr_reader :argument
+
+      # Initializes a new criteria with provided options.
+      # @param options [Hash]
+      def initialize(options = {})
+        @property = options[:property]
+        @operator = options[:operator]
+        @function = options[:function]
+        @argument = options[:argument]
+        @value    = options[:value]
+      end
+
+      include ComparisonOperators
+      include StringFunctions
+      include DateFunctions
+      include GeographyFunctions
+      include LambdaOperators
+
+      # Returns criteria as query-ready string.
+      def to_s
+        query = function ? function_expression : property_name
+
+        if operator && !lambda_operator?
+          "#{query} #{operator} #{url_value(value)}"
+        else
+          query
+        end
+      end
+
+      private
+
+      def property_name
+        property.name
+      rescue NoMethodError
+        property.to_s
+      end
+
+      def function_expression
+        return lambda_expression if lambda_operator?
+
+        if argument
+          "#{function}(#{property_name},#{url_value(argument)})"
+        else
+          "#{function}(#{property_name})"
+        end
+      end
+
+      def lambda_expression
+        "#{property_name}/#{function}(d:d/#{argument} #{operator} #{url_value(value)})"
+      end
+
+      def url_value(value)
+        property.value = value
+        property.url_value
+      rescue
+        value
+      end
+
+      def set_operator_and_value(operator, value)
+        @operator = operator
+        @value = value
+        self
+      end
+
+      def set_function_and_argument(function, argument)
+        @function = function
+        @argument = argument
+        self
+      end
+    end
+  end
+end

data/lib/odata4/query/criteria/comparison_operators.rb

@@ -0,0 +1,49 @@
+module OData4
+  class Query
+    class Criteria
+      module ComparisonOperators
+        # Sets up equality operator.
+        # @param value [to_s]
+        # @return [self]
+        def eq(value)
+          set_operator_and_value(:eq, value)
+        end
+
+        # Sets up non-equality operator.
+        # @param value [to_s]
+        # @return [self]
+        def ne(value)
+          set_operator_and_value(:ne, value)
+        end
+
+        # Sets up greater-than operator.
+        # @param value [to_s]
+        # @return [self]
+        def gt(value)
+          set_operator_and_value(:gt, value)
+        end
+
+        # Sets up greater-than-or-equal operator.
+        # @param value [to_s]
+        # @return [self]
+        def ge(value)
+          set_operator_and_value(:ge, value)
+        end
+
+        # Sets up less-than operator.
+        # @param value [to_s]
+        # @return [self]
+        def lt(value)
+          set_operator_and_value(:lt, value)
+        end
+
+        # Sets up less-than-or-equal operator.
+        # @param value [to_s]
+        # @return [self]
+        def le(value)
+          set_operator_and_value(:le, value)
+        end
+      end
+    end
+  end
+end

data/lib/odata4/query/criteria/date_functions.rb

@@ -0,0 +1,61 @@
+module OData4
+  class Query
+    class Criteria
+      module DateFunctions
+        # Applies the `year` function.
+        # @return [self]
+        def year
+          set_function_and_argument(:year, nil)
+        end
+
+        # Applies the `month` function.
+        # @return [self]
+        def month
+          set_function_and_argument(:month, nil)
+        end
+
+        # Applies the `day` function.
+        # @return [self]
+        def day
+          set_function_and_argument(:day, nil)
+        end
+
+        # Applies the `hour` function.
+        # @return [self]
+        def hour
+          set_function_and_argument(:hour, nil)
+        end
+
+        # Applies the `minute` function.
+        # @return [self]
+        def minute
+          set_function_and_argument(:minute, nil)
+        end
+
+        # Applies the `second` function.
+        # @return [self]
+        def second
+          set_function_and_argument(:second, nil)
+        end
+
+        # Applies the `fractionalseconds` function.
+        # @return [self]
+        def fractionalseconds
+          set_function_and_argument(:fractionalseconds, nil)
+        end
+
+        # Applies the `date` function.
+        # @return [self]
+        def date
+          set_function_and_argument(:date, nil)
+        end
+
+        # Applies the `time` function.
+        # @return [self]
+        def time
+          set_function_and_argument(:time, nil)
+        end
+      end
+    end
+  end
+end