odata 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a62f54f63a4c6c397d711b31eea1d31f41383e80
-  data.tar.gz: 8a4e945b39e401bfbaaaba43e2e52c884949318a
+  metadata.gz: f1ee4f9637afcfe8f3b9e088e14056e3bff1a90a
+  data.tar.gz: b1821379f53b957eb494930b0700ddaa99f20004
 SHA512:
-  metadata.gz: 591263ed5f45b8f12ef3ebf167bed9fff9e3e61c98de34b58601a5c3db2b89f18c4207feabbdccf08d9970a67c93f0f2d340747b7f767f64a615255c54769735
-  data.tar.gz: 4bc3b99da624d26e44d77ff8400c1ae5067d77aa56a8f435f739b37de0d50de3dc28967e8aae3fce004491e00808167fdd022133d2d25782347b28296d698cc3
+  metadata.gz: 1844be486c58326b07a7415c1e9dd0d98a92eb505459f678ff7adacfa5812331a488885989f6dc30b37aa2552103a4dec39a76091e6be3850d53809addf99f3b
+  data.tar.gz: 6a86353c36caf8aeb84aff2711b3967247c8c0d6a91fe2036c42a644b41114a3d8d53cc362a89633dfad31df9580d0395403f563708d0b31ffaee303472cb3dc

data/.travis.yml

@@ -61,4 +61,4 @@ matrix:
       env: REAL_HTTP=true
 addons:
   code_climate:
-    repo_token: 323644d852f6ba54213f25446d6f4276dbec0adb74fefce770b083cd3e83ea1e
+    repo_token: 56e2763b5bfe138f566c5f2bf23c14deee4f8990324436dbde07ee2a34bb87f8

data/lib/odata.rb

@@ -1,5 +1,6 @@
 require 'backports/2.1.0/enumerable/to_h'
 
+require 'uri'
 require 'date'
 require 'nokogiri'
 require 'typhoeus'
@@ -13,6 +14,7 @@ require 'odata/property'
 require 'odata/properties'
 require 'odata/entity'
 require 'odata/entity_set'
+require 'odata/query'
 require 'odata/service'
 require 'odata/service_registry'
 

data/lib/odata/entity.rb

@@ -30,7 +30,6 @@ module OData
     def self.with_properties(new_properties = {}, options = {})
       entity = OData::Entity.new(options)
       entity.instance_eval do
-        # TODO Define the properties
         service.properties_for(name).each do |name, instance|
           set_property(name, instance)
         end
@@ -43,6 +42,7 @@ module OData
     end
 
     def self.from_xml(xml_doc, options = {})
+      return nil if xml_doc.nil?
       entity = OData::Entity.new(options)
       entity.instance_eval do
         xml_doc.xpath('//content/properties/*').each do |property_xml|

data/lib/odata/entity_set.rb

@@ -47,21 +47,56 @@ module OData
       end
     end
 
+    # Return the first Entity for the set.
+    # @return [OData::EntitySet]
     def first
-      result = service.execute("#{name}?$skip=0&$top=1")
+      query = OData::Query.new(name)
+      query << OData::Query::Criteria.new(operation: 'skip', argument: 0)
+      query << OData::Query::Criteria.new(operation: 'top', argument: 1)
+      result = service.execute(query)
       entities = service.find_entities(result)
       OData::Entity.from_xml(entities[0], entity_options)
     end
 
-    # Returns the number of entities within the set
+    # Returns the number of entities within the set.
+    # @return [Integer]
     def count
       service.execute("#{name}/$count").body.to_i
     end
 
+    # Create a new Entity for this set with the given properties.
+    # @param properties [Hash] property name as key and it's initial value
+    # @return [OData::Entity]
     def new_entity(properties = {})
       OData::Entity.with_properties(properties, entity_options)
     end
 
+    # Find Entities with the supplied filter applied.
+    # @param filter [to_s] filter to apply
+    # @return [Array<OData::Entity>]
+    def filter(filter)
+      entities = []
+      result = service.execute("#{name}?$filter=#{filter}")
+
+      service.find_entities(result).each do |entity_xml|
+        entities << OData::Entity.from_xml(entity_xml, entity_options)
+      end
+
+      entities
+    end
+
+    # Find the Entity with the supplied key value.
+    # @param key [to_s] primary key to lookup
+    # @return [OData::Entity,nil]
+    def [](key)
+      result = service.execute("#{name}(#{key})")
+      entities = service.find_entities(result)
+      OData::Entity.from_xml(entities[0], entity_options)
+    end
+
+    # Write supplied entity back to the service.
+    # @param entity [OData::Entity] entity to save or update in the service
+    # @return [OData::Entity]
     def <<(entity)
       new_entity = entity[entity.primary_key].nil?
 
@@ -103,7 +138,11 @@ module OData
     end
 
     def get_paginated_entities(per_page, page)
-      result = service.execute("#{name}?$inlinecount=allpages&$skip=#{per_page * page}&$top=#{per_page}")
+      query = OData::Query.new(name)
+      query << OData::Query::Criteria.new(operation: 'inline_count', argument: 'allpages')
+      query << OData::Query::Criteria.new(operation: 'skip', argument: (per_page * page))
+      query << OData::Query::Criteria.new(operation: 'top', argument: per_page)
+      result = service.execute(query)
       entities = service.find_entities(result)
       total = service.find_node(result, 'count').content.to_i
       return total, entities

data/lib/odata/properties/binary.rb

@@ -1,6 +1,9 @@
 module OData
   module Properties
+    # Defines the Binary OData type.
     class Binary < OData::Property
+      # Returns the property value, properly typecast
+      # @return [Integer,nil]
       def value
         if @value.nil? && allows_nil?
           nil
@@ -9,11 +12,14 @@ module OData
         end
       end
 
+      # Sets the property value
+      # @params new_value [0,1,Boolean]
       def value=(new_value)
         validate(new_value)
         @value = parse_value(new_value)
       end
 
+      # The OData type name
       def type
         'Edm.Binary'
       end

data/lib/odata/properties/boolean.rb

@@ -1,5 +1,6 @@
 module OData
   module Properties
+    # Defines the Boolean OData type.
     class Boolean < OData::Property
       def value
         if @value.nil? && allows_nil?

data/lib/odata/properties/date_time.rb

@@ -1,6 +1,9 @@
 module OData
   module Properties
+    # Defines the DateTime OData type.
     class DateTime < OData::Property
+      # Returns the property value, properly typecast
+      # @return [DateTime, nil]
       def value
         if @value.nil? && allows_nil?
           nil
@@ -13,11 +16,14 @@ module OData
         end
       end
 
+      # Sets the property value
+      # @params new_value [DateTime]
       def value=(new_value)
         validate(new_value)
         @value = parse_value(new_value)
       end
 
+      # The OData type name
       def type
         'Edm.DateTime'
       end

data/lib/odata/properties/date_time_offset.rb

@@ -1,6 +1,9 @@
 module OData
   module Properties
+    # Defines the DateTimeOffset OData type.
     class DateTimeOffset < OData::Property
+      # Returns the property value, properly typecast
+      # @return [DateTime,nil]
       def value
         if @value.nil? && allow_nil?
           nil
@@ -9,11 +12,14 @@ module OData
         end
       end
 
+      # Sets the property value
+      # @params new_value [DateTime]
       def value=(new_value)
         validate(new_value)
         @value = parse_value(new_value)
       end
 
+      # The OData type name
       def type
         'Edm.DateTimeOffset'
       end

data/lib/odata/properties/decimal.rb

@@ -1,6 +1,9 @@
 module OData
   module Properties
+    # Defines the Decimal OData type.
     class Decimal < OData::Property
+      # Returns the property value, properly typecast
+      # @return [BigDecimal,nil]
       def value
         if @value.nil? && allows_nil?
           nil
@@ -9,11 +12,14 @@ module OData
         end
       end
 
+      # Sets the property value
+      # @params new_value something BigDecimal() can parse
       def value=(new_value)
         validate(BigDecimal(new_value))
         @value = new_value.to_s
       end
 
+      # The OData type name
       def type
         'Edm.Decimal'
       end

data/lib/odata/properties/float.rb

@@ -1,8 +1,11 @@
 module OData
   module Properties
+    # Defines the Float OData type.
     class Float < OData::Property
       include OData::Properties::Number
 
+      # Returns the property value, properly typecast
+      # @return [Float,nil]
       def value
         if @value.nil? && allows_nil?
           nil
@@ -11,11 +14,14 @@ module OData
         end
       end
 
+      # Sets the property value
+      # @params new_value [to_f]
       def value=(new_value)
         validate(new_value.to_f)
         @value = new_value.to_f.to_s
       end
 
+      # The OData type name
       def type
         'Edm.Double'
       end
@@ -31,9 +37,12 @@ module OData
       end
     end
 
+    # Defines the Double (Float) OData type.
     class Double < OData::Properties::Float; end
 
+    # Defines the Single (Float) OData type.
     class Single < OData::Properties::Float
+      # The OData type name
       def type
         'Edm.Single'
       end

data/lib/odata/properties/guid.rb

@@ -1,6 +1,8 @@
 module OData
   module Properties
+    # Defines the GUID OData type.
     class Guid < OData::Property
+      # The OData type name
       def type
         'Edm.Guid'
       end

data/lib/odata/properties/integer.rb

@@ -1,8 +1,11 @@
 module OData
   module Properties
+    # Defines the Integer OData type.
     class Integer < OData::Property
       include OData::Properties::Number
 
+      # Returns the property value, properly typecast
+      # @return [Integer,nil]
       def value
         if @value.nil? && allows_nil?
           nil
@@ -11,11 +14,14 @@ module OData
         end
       end
 
+      # Sets the property value
+      # @params new_value [to_i]
       def value=(new_value)
         validate(new_value.to_i)
         @value = new_value.to_i.to_s
       end
 
+      # The OData type name
       def type
         'Edm.Int64'
       end
@@ -31,7 +37,9 @@ module OData
       end
     end
 
+    # Defines the Integer (16 bit) OData type.
     class Int16 < Integer
+      # The OData type name
       def type
         'Edm.Int16'
       end
@@ -47,7 +55,9 @@ module OData
       end
     end
 
+    # Defines the Integer (32 bit) OData type.
     class Int32 < Integer
+      # The OData type name
       def type
         'Edm.Int32'
       end
@@ -63,9 +73,12 @@ module OData
       end
     end
 
+    # Defines the Integer (64 bit) OData type.
     class Int64 < Integer; end
 
+    # Defines the Byte OData type.
     class Byte < Integer
+      # The OData type name
       def type
         'Edm.Byte'
       end
@@ -81,7 +94,9 @@ module OData
       end
     end
 
+    # Defines the Signed Byte OData type.
     class SByte < Integer
+      # The OData type name
       def type
         'Edm.SByte'
       end

data/lib/odata/properties/number.rb

@@ -1,5 +1,6 @@
 module OData
   module Properties
+    # Defines common behavior for OData numeric types.
     module Number
       private
 

data/lib/odata/properties/string.rb

@@ -1,6 +1,9 @@
 module OData
   module Properties
+    # Defines the String OData type.
     class String < OData::Property
+      # Returns the property value, properly typecast
+      # @return [String,nil]
       def value
         if @value.nil? && allows_nil?
           nil
@@ -9,23 +12,29 @@ module OData
         end
       end
 
+      # Sets the property value
+      # @params new_value [to_s,nil]
       def value=(new_value)
         validate(new_value)
         @value = new_value.nil? ? nil : encode_value(new_value.to_s)
       end
 
+      # The OData type name
       def type
         'Edm.String'
       end
 
+      # Is the property value Unicode encoded
       def is_unicode?
         options[:unicode]
       end
 
+      # Does the property have a default value
       def has_default_value?
         not(options[:default_value].nil?)
       end
 
+      # The default value for the property
       def default_value
         options[:default_value]
       end

data/lib/odata/properties/time.rb

@@ -1,6 +1,9 @@
 module OData
   module Properties
+    # Defines the Time OData type.
     class Time < OData::Property
+      # Returns the property value, properly typecast
+      # @return [Time,nil]
       def value
         if @value.nil? && allow_nil?
           nil
@@ -9,11 +12,14 @@ module OData
         end
       end
 
+      # Sets the property value
+      # @params new_value [Time]
       def value=(new_value)
         validate(new_value)
         @value = parse_value(new_value)
       end
 
+      # The OData type name
       def type
         'Edm.Time'
       end

data/lib/odata/query.rb

@@ -0,0 +1,82 @@
+require 'odata/query/criteria'
+
+module OData
+  class Query
+    # Defines the operations the OData gem knows how to support.
+    SUPPORTED_OPERATIONS = [
+        :filter, :order_by, :skip, :top, :select, :expand, :inline_count
+    ]
+
+    def initialize(collection)
+      @collection = collection.to_s
+      setup_empty_criteria_set
+    end
+
+    def <<(criteria)
+      criteria_set[criteria.operation] << criteria.argument
+    end
+
+    def to_s
+      [collection,assemble_criteria].compact.join('?')
+    end
+
+    private
+
+    def collection
+      @collection
+    end
+
+    def criteria_set
+      @criteria_set
+    end
+
+    def setup_empty_criteria_set
+      criteria_set = SUPPORTED_OPERATIONS.map do |operation|
+        [operation, []]
+      end
+      @criteria_set = Hash[criteria_set]
+    end
+
+    def assemble_criteria
+      criteria = [
+        filter_criteria,
+        order_by_criteria,
+        expand_criteria,
+        select_criteria,
+        inline_count_criteria,
+        skip_criteria,
+        top_criteria
+      ].compact!
+
+      criteria.empty? ? nil : criteria.join('&')
+    end
+
+    def filter_criteria
+      criteria_set[:filter].empty? ? nil : "$filter=#{criteria_set[:filter].join(' and ')}"
+    end
+
+    def order_by_criteria
+      criteria_set[:order_by].empty? ? nil : "$orderby=#{criteria_set[:order_by].join(',')}"
+    end
+
+    def expand_criteria
+      criteria_set[:expand].empty? ? nil : "$expand=#{criteria_set[:expand].join(',')}"
+    end
+
+    def select_criteria
+      criteria_set[:select].empty? ? nil : "$select=#{criteria_set[:select].join(',')}"
+    end
+
+    def inline_count_criteria
+      criteria_set[:inline_count].empty? ? nil : "$inlinecount=#{criteria_set[:inline_count].last}"
+    end
+
+    def skip_criteria
+      criteria_set[:skip].empty? ? nil : "$skip=#{criteria_set[:skip].last}"
+    end
+
+    def top_criteria
+      criteria_set[:top].empty? ? nil : "$top=#{criteria_set[:top].last}"
+    end
+  end
+end

data/lib/odata/query/criteria.rb

@@ -0,0 +1,75 @@
+module OData
+  class Query
+    # Represents a discreet detail about an OData query. It also validates
+    # the criteria based on what the gem knows how to support.
+    class Criteria
+      # Defines the options required to create a new OData::Query::Criteria.
+      REQUIRED_OPTIONS = [:operation, :argument]
+
+      # Defines the operations the OData gem knows how to support.
+      SUPPORTED_OPERATIONS = [
+        :filter, :order_by, :skip, :top, :select, :expand, :inline_count
+      ]
+
+      # Creates a new OData::Query::Criteria with the supplied options.
+      # @param options [Hash]
+      def initialize(options = {})
+        @options = process_options(options)
+        validate_required_options
+        validate_supported_operation
+      end
+
+      # The query operation of a particular criteria.
+      # @return [Symbol]
+      def operation
+        options[:operation]
+      end
+
+      # The query argument of a particular criteria.
+      # @return [String]
+      def argument
+        options[:argument]
+      end
+
+      private
+
+      def options
+        @options
+      end
+
+      def process_options(passed_options)
+        new_options = passed_options.map do |key, value|
+          if key.to_sym == :operation
+            value = value.to_sym
+          end
+
+          [key.to_sym, value]
+        end
+
+        Hash[new_options]
+      end
+
+      def required_options
+        REQUIRED_OPTIONS
+      end
+
+      def supported_operations
+        SUPPORTED_OPERATIONS
+      end
+
+      def validate_required_options
+        required_options.each do |required_option|
+          unless options.key?(required_option)
+            raise ArgumentError, "Missing required option: #{required_option}"
+          end
+        end
+      end
+
+      def validate_supported_operation
+        unless supported_operations.include?(options[:operation])
+          raise ArgumentError, "Operation not supported: #{options[:operation]}"
+        end
+      end
+    end
+  end
+end

data/lib/odata/service.rb

@@ -84,7 +84,7 @@ module OData
     # @return [Typhoeus::Response]
     def execute(url_chunk, additional_options = {})
       request = ::Typhoeus::Request.new(
-          "#{service_url}/#{url_chunk}",
+          URI.escape("#{service_url}/#{url_chunk}"),
           options[:typhoeus].merge({
             method: :get
           }).merge(additional_options)
@@ -168,7 +168,7 @@ module OData
     def metadata
       @metadata ||= lambda {
         request = ::Typhoeus::Request.new(
-            "#{service_url}/$metadata",
+            URI.escape("#{service_url}/$metadata"),
             options[:typhoeus].merge({
               method: :get
             })

data/lib/odata/version.rb

@@ -1,3 +1,3 @@
 module OData
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/fixtures/sample_service/product_filter_many.xml

@@ -0,0 +1,234 @@
+<?xml version="1.0" encoding="utf-8"?>
+<feed xml:base="http://services.odata.org/OData/OData.svc/" xmlns="http://www.w3.org/2005/Atom"
+      xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"
+      xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"
+      xmlns:georss="http://www.georss.org/georss" xmlns:gml="http://www.opengis.net/gml">
+  <id>http://services.odata.org/OData/OData.svc/Products</id>
+  <title type="text">Products</title>
+  <updated>2014-07-11T19:22:18Z</updated>
+  <link rel="self" title="Products" href="Products"/>
+  <entry>
+    <id>http://services.odata.org/OData/OData.svc/Products(1)</id>
+    <category term="ODataDemo.Product" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme"/>
+    <link rel="edit" title="Product" href="Products(1)"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Categories"
+          type="application/atom+xml;type=feed" title="Categories" href="Products(1)/Categories"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Supplier"
+          type="application/atom+xml;type=entry" title="Supplier" href="Products(1)/Supplier"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/ProductDetail"
+          type="application/atom+xml;type=entry" title="ProductDetail" href="Products(1)/ProductDetail"/>
+    <title type="text">Milk</title>
+    <summary type="text">Low fat milk</summary>
+    <updated>2014-07-11T19:22:18Z</updated>
+    <author>
+      <name/>
+    </author>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/Categories" type="application/xml"
+          title="Categories" href="Products(1)/$links/Categories"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/Supplier" type="application/xml"
+          title="Supplier" href="Products(1)/$links/Supplier"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/ProductDetail" type="application/xml"
+          title="ProductDetail" href="Products(1)/$links/ProductDetail"/>
+    <content type="application/xml">
+      <m:properties>
+        <d:ID m:type="Edm.Int32">1</d:ID>
+        <d:ReleaseDate m:type="Edm.DateTime">1995-10-01T00:00:00</d:ReleaseDate>
+        <d:DiscontinuedDate m:null="true"/>
+        <d:Rating m:type="Edm.Int16">3</d:Rating>
+        <d:Price m:type="Edm.Double">3.5</d:Price>
+      </m:properties>
+    </content>
+  </entry>
+  <entry>
+    <id>http://services.odata.org/OData/OData.svc/Products(2)</id>
+    <category term="ODataDemo.Product" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme"/>
+    <link rel="edit" title="Product" href="Products(2)"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Categories"
+          type="application/atom+xml;type=feed" title="Categories" href="Products(2)/Categories"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Supplier"
+          type="application/atom+xml;type=entry" title="Supplier" href="Products(2)/Supplier"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/ProductDetail"
+          type="application/atom+xml;type=entry" title="ProductDetail" href="Products(2)/ProductDetail"/>
+    <title type="text">Vint soda</title>
+    <summary type="text">Americana Variety - Mix of 6 flavors</summary>
+    <updated>2014-07-11T19:22:18Z</updated>
+    <author>
+      <name/>
+    </author>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/Categories" type="application/xml"
+          title="Categories" href="Products(2)/$links/Categories"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/Supplier" type="application/xml"
+          title="Supplier" href="Products(2)/$links/Supplier"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/ProductDetail" type="application/xml"
+          title="ProductDetail" href="Products(2)/$links/ProductDetail"/>
+    <content type="application/xml">
+      <m:properties>
+        <d:ID m:type="Edm.Int32">2</d:ID>
+        <d:ReleaseDate m:type="Edm.DateTime">2000-10-01T00:00:00</d:ReleaseDate>
+        <d:DiscontinuedDate m:null="true"/>
+        <d:Rating m:type="Edm.Int16">3</d:Rating>
+        <d:Price m:type="Edm.Double">20.9</d:Price>
+      </m:properties>
+    </content>
+  </entry>
+  <entry>
+    <id>http://services.odata.org/OData/OData.svc/Products(3)</id>
+    <category term="ODataDemo.Product" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme"/>
+    <link rel="edit" title="Product" href="Products(3)"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Categories"
+          type="application/atom+xml;type=feed" title="Categories" href="Products(3)/Categories"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Supplier"
+          type="application/atom+xml;type=entry" title="Supplier" href="Products(3)/Supplier"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/ProductDetail"
+          type="application/atom+xml;type=entry" title="ProductDetail" href="Products(3)/ProductDetail"/>
+    <title type="text">Havina Cola</title>
+    <summary type="text">The Original Key Lime Cola</summary>
+    <updated>2014-07-11T19:22:18Z</updated>
+    <author>
+      <name/>
+    </author>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/Categories" type="application/xml"
+          title="Categories" href="Products(3)/$links/Categories"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/Supplier" type="application/xml"
+          title="Supplier" href="Products(3)/$links/Supplier"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/ProductDetail" type="application/xml"
+          title="ProductDetail" href="Products(3)/$links/ProductDetail"/>
+    <content type="application/xml">
+      <m:properties>
+        <d:ID m:type="Edm.Int32">3</d:ID>
+        <d:ReleaseDate m:type="Edm.DateTime">2005-10-01T00:00:00</d:ReleaseDate>
+        <d:DiscontinuedDate m:type="Edm.DateTime">2006-10-01T00:00:00</d:DiscontinuedDate>
+        <d:Rating m:type="Edm.Int16">3</d:Rating>
+        <d:Price m:type="Edm.Double">19.9</d:Price>
+      </m:properties>
+    </content>
+  </entry>
+  <entry>
+    <id>http://services.odata.org/OData/OData.svc/Products(4)</id>
+    <category term="ODataDemo.Product" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme"/>
+    <link rel="edit" title="Product" href="Products(4)"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Categories"
+          type="application/atom+xml;type=feed" title="Categories" href="Products(4)/Categories"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Supplier"
+          type="application/atom+xml;type=entry" title="Supplier" href="Products(4)/Supplier"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/ProductDetail"
+          type="application/atom+xml;type=entry" title="ProductDetail" href="Products(4)/ProductDetail"/>
+    <title type="text">Fruit Punch</title>
+    <summary type="text">Mango flavor, 8.3 Ounce Cans (Pack of 24)</summary>
+    <updated>2014-07-11T19:22:18Z</updated>
+    <author>
+      <name/>
+    </author>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/Categories" type="application/xml"
+          title="Categories" href="Products(4)/$links/Categories"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/Supplier" type="application/xml"
+          title="Supplier" href="Products(4)/$links/Supplier"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/ProductDetail" type="application/xml"
+          title="ProductDetail" href="Products(4)/$links/ProductDetail"/>
+    <content type="application/xml">
+      <m:properties>
+        <d:ID m:type="Edm.Int32">4</d:ID>
+        <d:ReleaseDate m:type="Edm.DateTime">2003-01-05T00:00:00</d:ReleaseDate>
+        <d:DiscontinuedDate m:null="true"/>
+        <d:Rating m:type="Edm.Int16">3</d:Rating>
+        <d:Price m:type="Edm.Double">22.99</d:Price>
+      </m:properties>
+    </content>
+  </entry>
+  <entry>
+    <id>http://services.odata.org/OData/OData.svc/Products(5)</id>
+    <category term="ODataDemo.Product" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme"/>
+    <link rel="edit" title="Product" href="Products(5)"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Categories"
+          type="application/atom+xml;type=feed" title="Categories" href="Products(5)/Categories"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Supplier"
+          type="application/atom+xml;type=entry" title="Supplier" href="Products(5)/Supplier"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/ProductDetail"
+          type="application/atom+xml;type=entry" title="ProductDetail" href="Products(5)/ProductDetail"/>
+    <title type="text">Cranberry Juice</title>
+    <summary type="text">16-Ounce Plastic Bottles (Pack of 12)</summary>
+    <updated>2014-07-11T19:22:18Z</updated>
+    <author>
+      <name/>
+    </author>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/Categories" type="application/xml"
+          title="Categories" href="Products(5)/$links/Categories"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/Supplier" type="application/xml"
+          title="Supplier" href="Products(5)/$links/Supplier"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/ProductDetail" type="application/xml"
+          title="ProductDetail" href="Products(5)/$links/ProductDetail"/>
+    <content type="application/xml">
+      <m:properties>
+        <d:ID m:type="Edm.Int32">5</d:ID>
+        <d:ReleaseDate m:type="Edm.DateTime">2006-08-04T00:00:00</d:ReleaseDate>
+        <d:DiscontinuedDate m:null="true"/>
+        <d:Rating m:type="Edm.Int16">3</d:Rating>
+        <d:Price m:type="Edm.Double">22.8</d:Price>
+      </m:properties>
+    </content>
+  </entry>
+  <entry>
+    <id>http://services.odata.org/OData/OData.svc/Products(6)</id>
+    <category term="ODataDemo.Product" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme"/>
+    <link rel="edit" title="Product" href="Products(6)"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Categories"
+          type="application/atom+xml;type=feed" title="Categories" href="Products(6)/Categories"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Supplier"
+          type="application/atom+xml;type=entry" title="Supplier" href="Products(6)/Supplier"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/ProductDetail"
+          type="application/atom+xml;type=entry" title="ProductDetail" href="Products(6)/ProductDetail"/>
+    <title type="text">Pink Lemonade</title>
+    <summary type="text">36 Ounce Cans (Pack of 3)</summary>
+    <updated>2014-07-11T19:22:18Z</updated>
+    <author>
+      <name/>
+    </author>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/Categories" type="application/xml"
+          title="Categories" href="Products(6)/$links/Categories"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/Supplier" type="application/xml"
+          title="Supplier" href="Products(6)/$links/Supplier"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/ProductDetail" type="application/xml"
+          title="ProductDetail" href="Products(6)/$links/ProductDetail"/>
+    <content type="application/xml">
+      <m:properties>
+        <d:ID m:type="Edm.Int32">6</d:ID>
+        <d:ReleaseDate m:type="Edm.DateTime">2006-11-05T00:00:00</d:ReleaseDate>
+        <d:DiscontinuedDate m:null="true"/>
+        <d:Rating m:type="Edm.Int16">3</d:Rating>
+        <d:Price m:type="Edm.Double">18.8</d:Price>
+      </m:properties>
+    </content>
+  </entry>
+  <entry>
+    <id>http://services.odata.org/OData/OData.svc/Products(8)</id>
+    <category term="ODataDemo.Product" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme"/>
+    <link rel="edit" title="Product" href="Products(8)"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Categories"
+          type="application/atom+xml;type=feed" title="Categories" href="Products(8)/Categories"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Supplier"
+          type="application/atom+xml;type=entry" title="Supplier" href="Products(8)/Supplier"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/ProductDetail"
+          type="application/atom+xml;type=entry" title="ProductDetail" href="Products(8)/ProductDetail"/>
+    <title type="text">LCD HDTV</title>
+    <summary type="text">42 inch 1080p LCD with Built-in Blu-ray Disc Player</summary>
+    <updated>2014-07-11T19:22:18Z</updated>
+    <author>
+      <name/>
+    </author>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/Categories" type="application/xml"
+          title="Categories" href="Products(8)/$links/Categories"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/Supplier" type="application/xml"
+          title="Supplier" href="Products(8)/$links/Supplier"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/ProductDetail" type="application/xml"
+          title="ProductDetail" href="Products(8)/$links/ProductDetail"/>
+    <content type="application/xml">
+      <m:properties>
+        <d:ID m:type="Edm.Int32">8</d:ID>
+        <d:ReleaseDate m:type="Edm.DateTime">2008-05-08T00:00:00</d:ReleaseDate>
+        <d:DiscontinuedDate m:null="true"/>
+        <d:Rating m:type="Edm.Int16">3</d:Rating>
+        <d:Price m:type="Edm.Double">1088.8</d:Price>
+      </m:properties>
+    </content>
+  </entry>
+</feed>

data/spec/fixtures/sample_service/product_filter_one.xml

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="utf-8"?>
+<feed xml:base="http://services.odata.org/OData/OData.svc/" xmlns="http://www.w3.org/2005/Atom"
+      xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"
+      xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"
+      xmlns:georss="http://www.georss.org/georss" xmlns:gml="http://www.opengis.net/gml">
+  <id>http://services.odata.org/OData/OData.svc/Products</id>
+  <title type="text">Products</title>
+  <updated>2014-07-11T19:20:06Z</updated>
+  <link rel="self" title="Products" href="Products"/>
+  <entry>
+    <id>http://services.odata.org/OData/OData.svc/Products(0)</id>
+    <category term="ODataDemo.Product" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme"/>
+    <link rel="edit" title="Product" href="Products(0)"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Categories"
+          type="application/atom+xml;type=feed" title="Categories" href="Products(0)/Categories"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Supplier"
+          type="application/atom+xml;type=entry" title="Supplier" href="Products(0)/Supplier"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/ProductDetail"
+          type="application/atom+xml;type=entry" title="ProductDetail" href="Products(0)/ProductDetail"/>
+    <title type="text">Bread</title>
+    <summary type="text">Whole grain bread</summary>
+    <updated>2014-07-11T19:20:06Z</updated>
+    <author>
+      <name/>
+    </author>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/Categories" type="application/xml"
+          title="Categories" href="Products(0)/$links/Categories"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/Supplier" type="application/xml"
+          title="Supplier" href="Products(0)/$links/Supplier"/>
+    <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/relatedlinks/ProductDetail" type="application/xml"
+          title="ProductDetail" href="Products(0)/$links/ProductDetail"/>
+    <content type="application/xml">
+      <m:properties>
+        <d:ID m:type="Edm.Int32">0</d:ID>
+        <d:ReleaseDate m:type="Edm.DateTime">1992-01-01T00:00:00</d:ReleaseDate>
+        <d:DiscontinuedDate m:null="true"/>
+        <d:Rating m:type="Edm.Int16">4</d:Rating>
+        <d:Price m:type="Edm.Double">2.5</d:Price>
+      </m:properties>
+    </content>
+  </entry>
+</feed>

data/spec/fixtures/sample_service/product_not_found.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<m:error xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
+  <m:code/>
+  <m:message xml:lang="en-US">Resource not found for the segment 'Products'.</m:message>
+</m:error>

data/spec/odata/entity_set_spec.rb

@@ -11,7 +11,14 @@ describe OData::EntitySet do
     OData::Service.open('http://services.odata.org/OData/OData.svc')
   end
 
-  it { expect(subject).to respond_to(:name, :type, :container, :namespace, :new_entity) }
+  it { expect(subject).to respond_to(:name) }
+  it { expect(subject).to respond_to(:type) }
+  it { expect(subject).to respond_to(:container) }
+  it { expect(subject).to respond_to(:namespace) }
+  it { expect(subject).to respond_to(:new_entity) }
+  it { expect(subject).to respond_to(:filter) }
+  it { expect(subject).to respond_to(:[]) }
+  it { expect(subject).to respond_to(:<<) }
 
   it { expect(subject.name).to eq('Products') }
   it { expect(subject.container).to eq('DemoService') }
@@ -58,6 +65,31 @@ describe OData::EntitySet do
     it { expect(new_entity['Price']).to eq(3.5) }
   end
 
+  describe '#filter' do
+    let(:one_entity) { "Name eq 'Bread'" }
+    let(:many_entities) { 'Rating eq 3' }
+
+    it { expect(subject.filter(one_entity)).to be_a(Array) }
+    it { expect(subject.filter(one_entity).first).to be_a(OData::Entity) }
+
+    it { expect(subject.filter(many_entities)).to be_a(Array) }
+    it do
+      subject.filter(one_entity).each do |entity|
+        expect(entity).to be_a(OData::Entity)
+      end
+    end
+  end
+
+  describe '#[]' do
+    let(:existing_entity) { subject[0] }
+    let(:nonexistant_entity) { subject[99] }
+
+    it { expect(existing_entity).to be_a(OData::Entity) }
+    it { expect(existing_entity['ID']).to eq(0) }
+
+    it { expect(nonexistant_entity).to be_nil }
+  end
+
   describe '#<<' do
     let(:new_entity) { subject.new_entity(properties) }
     let(:bad_entity) { subject.new_entity }
@@ -71,8 +103,6 @@ describe OData::EntitySet do
         Price:            3.5
     } }
 
-    it { expect(subject).to respond_to(:<<) }
-
     it 'with an existing entity' do
       WebMock.stub_request(:post, 'http://services.odata.org/OData/OData.svc/Products(0)').
           to_return(status: 200, body: File.open('spec/fixtures/sample_service/product_0.xml'))

data/spec/odata/query/criteria_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe OData::Query::Criteria do
+  let(:subject) { OData::Query::Criteria.new(operation: 'filter', argument: "Name eq 'Bread'") }
+  let(:valid_operations) { [:filter, :order_by, :skip, :top, :select, :expand, :inline_count] }
+
+  it { expect(subject).to respond_to(:operation) }
+  it { expect(subject).to respond_to(:argument) }
+
+  it { expect(subject.operation).to eq(:filter) }
+  it { expect(subject.argument).to eq("Name eq 'Bread'")}
+
+  it 'should require operation option' do
+    expect {
+      OData::Query::Criteria.new(argument: 'test')
+    }.to raise_error(ArgumentError, 'Missing required option: operation')
+  end
+
+  it 'should require argument option' do
+    expect {
+      OData::Query::Criteria.new(operation: 'filter')
+    }.to raise_error(ArgumentError, 'Missing required option: argument')
+  end
+
+  it 'should validate operation option' do
+    valid_operations.each do |operation|
+      expect {
+        OData::Query::Criteria.new(operation: operation, argument: 'test')
+      }.to_not raise_error
+    end
+
+    expect {
+      OData::Query::Criteria.new(operation: 'invalid', argument: 'test')
+    }.to raise_error(ArgumentError, 'Operation not supported: invalid')
+  end
+end

data/spec/odata/query_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe OData::Query do
+  let(:subject) { OData::Query.new('Products') }
+
+  it { expect(subject).to respond_to(:<<) }
+  it { expect(subject).to respond_to(:to_s) }
+
+  it { expect(subject.to_s).to eq('Products')}
+
+  it 'handles pagination operations' do
+    skip_criteria = OData::Query::Criteria.new(operation: 'skip', argument: 5)
+    top_criteria = OData::Query::Criteria.new(operation: 'top', argument: 5)
+    subject << top_criteria
+    subject << skip_criteria
+    expect(subject.to_s).to eq('Products?$skip=5&$top=5')
+  end
+
+  it 'handles inline_count operations' do
+    criteria = OData::Query::Criteria.new(operation: 'inline_count', argument: 'allpages')
+    subject << criteria
+    expect(subject.to_s).to eq('Products?$inlinecount=allpages')
+  end
+
+  it 'handles select operations' do
+    criteria1 = OData::Query::Criteria.new(operation: 'select', argument: 'Name')
+    criteria2 = OData::Query::Criteria.new(operation: 'select', argument: 'Rating')
+    criteria3 = OData::Query::Criteria.new(operation: 'select', argument: 'Price')
+    subject << criteria1
+    subject << criteria2
+    subject << criteria3
+    expect(subject.to_s).to eq('Products?$select=Name,Rating,Price')
+  end
+
+  it 'handles expand operations' do
+    criteria1 = OData::Query::Criteria.new(operation: 'expand', argument: 'Supplier')
+    criteria2 = OData::Query::Criteria.new(operation: 'expand', argument: 'ProductDetail')
+    subject << criteria1
+    subject << criteria2
+    expect(subject.to_s).to eq('Products?$expand=Supplier,ProductDetail')
+  end
+
+  it 'handles order_by operations' do
+    criteria1 = OData::Query::Criteria.new(operation: 'order_by', argument: 'Price')
+    criteria2 = OData::Query::Criteria.new(operation: 'order_by', argument: 'Rating desc')
+    subject << criteria1
+    subject << criteria2
+    expect(subject.to_s).to eq('Products?$orderby=Price,Rating desc')
+  end
+
+  it 'handles filter operations' do
+    criteria1 = OData::Query::Criteria.new(operation: 'filter', argument: 'Rating gt 2')
+    criteria2 = OData::Query::Criteria.new(operation: 'filter', argument: 'Price lt 15')
+    subject << criteria1
+    subject << criteria2
+    expect(subject.to_s).to eq('Products?$filter=Rating gt 2 and Price lt 15')
+  end
+end

data/spec/spec_helper.rb

@@ -62,6 +62,15 @@ RSpec.configure do |config|
 
       WebMock.stub_request(:get, 'http://services.odata.org/OData/OData.svc/Products(0)').
           to_return(status: 200, body: File.open('spec/fixtures/sample_service/product_0.xml'))
+
+      WebMock.stub_request(:get, 'http://services.odata.org/OData/OData.svc/Products(99)').
+          to_return(status: 404, body: File.open('spec/fixtures/sample_service/product_not_found.xml'))
+
+      WebMock.stub_request(:get, "http://services.odata.org/OData/OData.svc/Products?$filter=Name eq 'Bread'").
+          to_return(status: 200, body: File.open('spec/fixtures/sample_service/product_filter_one.xml'))
+
+      WebMock.stub_request(:get, 'http://services.odata.org/OData/OData.svc/Products?$filter=Rating%20eq%203').
+          to_return(status: 200, body: File.open('spec/fixtures/sample_service/product_filter_many.xml'))
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: odata
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - James Thompson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-07 00:00:00.000000000 Z
+date: 2014-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -196,6 +196,8 @@ files:
 - lib/odata/properties/string.rb
 - lib/odata/properties/time.rb
 - lib/odata/property.rb
+- lib/odata/query.rb
+- lib/odata/query/criteria.rb
 - lib/odata/railtie.rb
 - lib/odata/service.rb
 - lib/odata/service_registry.rb
@@ -205,6 +207,9 @@ files:
 - spec/fixtures/sample_service/metadata.xml
 - spec/fixtures/sample_service/product_0.xml
 - spec/fixtures/sample_service/product_9999.xml
+- spec/fixtures/sample_service/product_filter_many.xml
+- spec/fixtures/sample_service/product_filter_one.xml
+- spec/fixtures/sample_service/product_not_found.xml
 - spec/fixtures/sample_service/products.xml
 - spec/fixtures/sample_service/products_skip0_top5.xml
 - spec/fixtures/sample_service/products_skip10_top5.xml
@@ -222,6 +227,8 @@ files:
 - spec/odata/properties/string_spec.rb
 - spec/odata/properties/time_spec.rb
 - spec/odata/property_spec.rb
+- spec/odata/query/criteria_spec.rb
+- spec/odata/query_spec.rb
 - spec/odata/service_registry_spec.rb
 - spec/odata/service_spec.rb
 - spec/spec_helper.rb
@@ -254,6 +261,9 @@ test_files:
 - spec/fixtures/sample_service/metadata.xml
 - spec/fixtures/sample_service/product_0.xml
 - spec/fixtures/sample_service/product_9999.xml
+- spec/fixtures/sample_service/product_filter_many.xml
+- spec/fixtures/sample_service/product_filter_one.xml
+- spec/fixtures/sample_service/product_not_found.xml
 - spec/fixtures/sample_service/products.xml
 - spec/fixtures/sample_service/products_skip0_top5.xml
 - spec/fixtures/sample_service/products_skip10_top5.xml
@@ -271,6 +281,8 @@ test_files:
 - spec/odata/properties/string_spec.rb
 - spec/odata/properties/time_spec.rb
 - spec/odata/property_spec.rb
+- spec/odata/query/criteria_spec.rb
+- spec/odata/query_spec.rb
 - spec/odata/service_registry_spec.rb
 - spec/odata/service_spec.rb
 - spec/spec_helper.rb