odata 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af6506e24673be2abb599e192b33de2a4aa79b4a
-  data.tar.gz: 38e3d857a460217b8c049ed1ab706d58ddeff55b
+  metadata.gz: 899ee301dd62dc8969c8a8d8191adc586b287527
+  data.tar.gz: 9d9122c36019cfa78a3e4567b9739e8353b07db3
 SHA512:
-  metadata.gz: a699dafcd979c7de7e360435aea0ffb5fc3025e9d006bd7e44e4dff2184eaca5f727281ef38fc3fef7c2cc4c59a4b0c8bab08adea2f5980d2814c1e99aae1861
-  data.tar.gz: f9df03eaebb7f3ab4177a3a2938e7a1ca23b9dc0de7bf7df3c9d4cc173643b6a83b79c1e0b55eafbe27639590a90bd05c94e7888ead8e759bcb8d9c9b0cd0d98
+  metadata.gz: 422c217129c1f82e13d3641d8468cc3ff6bc65224db8da0c17cc1e1c1c012d093e1b5e0f891c48224088f1ae01fa132b89e6bb5edc44b8c4c3b3663e88792023
+  data.tar.gz: 262866a54904f052099030cf1393359b2e9ba7dd06fc4bfbd56a18ea004ba6262fcc6994ea2383b175abe0d01225785661556e2dc24ec2c45695b5d91316f7f2

data/.travis.yml

@@ -11,9 +11,6 @@ jdk:
   - openjdk7
   - oraclejdk7
   - oraclejdk8
-env:
-  - REAL_HTTP=true
-  - REAL_HTTP=false
 branches:
   only:
     - master
@@ -25,40 +22,30 @@ matrix:
       jdk: oraclejdk7
     - rvm: 1.9.3
       jdk: oraclejdk8
-    - rvm: 1.9.3
-      env: REAL_HTTP=true
     - rvm: 2.0.0
       jdk: openjdk6
     - rvm: 2.0.0
       jdk: oraclejdk7
     - rvm: 2.0.0
       jdk: oraclejdk8
-    - rvm: 2.0.0
-      env: REAL_HTTP=true
     - rvm: 2.1.0
       jdk: openjdk6
     - rvm: 2.1.0
       jdk: oraclejdk7
     - rvm: 2.1.0
       jdk: oraclejdk8
-    - rvm: 2.1.0
-      env: REAL_HTTP=true
     - rvm: 2.1.1
       jdk: openjdk6
     - rvm: 2.1.1
       jdk: oraclejdk7
     - rvm: 2.1.1
       jdk: oraclejdk8
-    - rvm: 2.1.1
-      env: REAL_HTTP=true
     - rvm: 2.1.2
       jdk: openjdk6
     - rvm: 2.1.2
       jdk: oraclejdk7
     - rvm: 2.1.2
       jdk: oraclejdk8
-    - rvm: jruby
-      env: REAL_HTTP=true
 addons:
   code_climate:
     repo_token: 56e2763b5bfe138f566c5f2bf23c14deee4f8990324436dbde07ee2a34bb87f8

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.3.2
+
+* Refactored internals of the query interface.
+
 ## 0.3.1
 
 * Resolved issues causing failure on Ruby 1.9 and JRuby.

data/lib/odata.rb

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

data/lib/odata/entity.rb

@@ -1,16 +1,31 @@
 module OData
+  # An OData::Entity represents a single record returned by the service. All
+  # Entities have a type and belong to a specific namespace. They are written
+  # back to the service via the EntitySet they came from. OData::Entity
+  # instances should not be instantiated directly; instead, they should either
+  # be read or instantiated from their respective OData::EntitySet.
   class Entity
-    attr_reader :type, :namespace
+    # The Entity type name
+    attr_reader :type
+    # The OData::Service namespace
+    attr_reader :namespace
 
+    # Initializes a bare Entity
+    # @param options [Hash]
     def initialize(options = {})
       @type = options[:type]
       @namespace = options[:namespace]
     end
 
+    # Returns name of Entity from Service specified type.
+    # @return [String]
     def name
       @name ||= type.gsub(/#{namespace}\./, '')
     end
 
+    # Get property value
+    # @param property_name [to_s]
+    # @return [*]
     def [](property_name)
       begin
        properties[property_name.to_s].value
@@ -19,6 +34,9 @@ module OData
       end
     end
 
+    # Set property value
+    # @param property_name [to_s]
+    # @param value [*]
     def []=(property_name, value)
       begin
         properties[property_name.to_s].value = value
@@ -27,6 +45,10 @@ module OData
       end
     end
 
+    # Create Entity with provided properties and options.
+    # @param new_properties [Hash]
+    # @param options [Hash]
+    # @param [OData::Entity]
     def self.with_properties(new_properties = {}, options = {})
       entity = OData::Entity.new(options)
       entity.instance_eval do
@@ -35,52 +57,27 @@ module OData
         end
 
         new_properties.each do |property_name, property_value|
-          self[property_name] = property_value
+          self[property_name.to_s] = property_value
         end
       end
       entity
     end
 
+    # Create Entity from XML document with provided options.
+    # @param xml_doc [Nokogiri::XML]
+    # @param options [Hash]
+    # @return [OData::Entity]
     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|
-          property_name = property_xml.name
-          if property_xml.attributes['null'] &&
-              property_xml.attributes['null'].value == 'true'
-            value = nil
-            value_type = service.get_property_type(name, property_name)
-          else
-            value_type = property_xml.attributes['type'].value
-            value = property_xml.content
-          end
-          klass_name = value_type.gsub(/^Edm\./, '')
-          property = get_property_class(klass_name).new(property_name, value)
-          set_property(property_name, property)
-        end
-
-        begin
-          title_value = xml_doc.xpath('//title').first.content
-          property_name = service.get_title_property_name(name)
-          value_type = service.get_property_type(name, property_name)
-          klass_name = value_type.gsub(/^Edm\./, '')
-          property = get_property_class(klass_name).new(property_name, title_value)
-          set_property(property_name, property)
-        end
-
-        begin
-          summary_value = xml_doc.xpath('//summary').first.content
-          property_name = service.get_summary_property_name(name)
-          value_type = service.get_property_type(name, property_name)
-          klass_name = value_type.gsub(/^Edm\./, '')
-          property = get_property_class(klass_name).new(property_name, summary_value)
-          set_property(property_name, property)
-        end
-      end
+      process_properties(entity, xml_doc)
+      process_feed_property(entity, xml_doc, 'title')
+      process_feed_property(entity, xml_doc, 'summary')
       entity
     end
 
+    # Converts Entity to its XML representation.
+    # @return [String]
     def to_xml
       builder = Nokogiri::XML::Builder.new do |xml|
         xml.entry('xmlns'           => 'http://www.w3.org/2005/Atom',
@@ -97,16 +94,7 @@ module OData
             xml['metadata'].properties do
               properties.each do |name, property|
                 next if name == primary_key
-                attributes = {
-                  'metadata:type' => property.type,
-                }
-
-                if property.value.nil?
-                  attributes['metadata:null'] = 'true'
-                  xml['data'].send(name.to_sym, attributes)
-                else
-                  xml['data'].send(name.to_sym, attributes, property.xml_value)
-                end
+                property.to_xml(xml)
               end
             end
           end
@@ -115,13 +103,17 @@ module OData
       builder.to_xml
     end
 
+    # Returns the primary key for the Entity.
+    # @return [String]
     def primary_key
       service.primary_key_for(name)
     end
 
     private
 
-    def get_property_class(klass_name)
+    def get_property_class(property_name)
+      value_type = service.get_property_type(name, property_name)
+      klass_name = value_type.gsub(/^Edm\./, '')
       ::OData::Properties.const_get(klass_name)
     end
 
@@ -136,5 +128,30 @@ module OData
     def set_property(name, odata_property)
       properties[name.to_s] = odata_property.dup
     end
+
+    def self.process_properties(entity, xml_doc)
+      entity.instance_eval do
+        xml_doc.xpath('//content/properties/*').each do |property_xml|
+          property_name = property_xml.name
+          if property_xml.attributes['null'] &&
+              property_xml.attributes['null'].value == 'true'
+            value = nil
+          else
+            value = property_xml.content
+          end
+          property = get_property_class(property_name).new(property_name, value)
+          set_property(property_name, property)
+        end
+      end
+    end
+
+    def self.process_feed_property(entity, xml_doc, property_name)
+      entity.instance_eval do
+        property_value = xml_doc.xpath("//#{property_name}").first.content
+        property_name = service.send("get_#{property_name}_property_name", name)
+        property = get_property_class(property_name).new(property_name, property_value)
+        set_property(property_name, property)
+      end
+    end
   end
 end

data/lib/odata/entity_set.rb

@@ -10,7 +10,14 @@ module OData
   class EntitySet
     include Enumerable
 
-    attr_reader :name, :type, :namespace, :container
+    # The name of the EntitySet
+    attr_reader :name
+    # The Entity type for the EntitySet
+    attr_reader :type
+    # The OData::Service namespace
+    attr_reader :namespace
+    # The EntitySet's container name
+    attr_reader :container
 
     # Sets up the EntitySet to permit querying for the resources in the set.
     #
@@ -50,9 +57,7 @@ module OData
     # Return the first Entity for the set.
     # @return [OData::EntitySet]
     def first
-      query = OData::Query.new(name)
-      query << OData::Query::Criteria.new(operation: 'skip', argument: 0)
-      query << OData::Query::Criteria.new(operation: 'top', argument: 1)
+      query = OData::Query.new(self).limit(1)
       result = service.execute(query)
       entities = service.find_entities(result)
       OData::Entity.from_xml(entities[0], entity_options)
@@ -71,19 +76,13 @@ module OData
       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}")
+    # Returns a query targetted at the current EntitySet.
+    # @return [OData::Query]
+    def query
+      OData::Query.new(self)
+    end
 
-      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
@@ -107,7 +106,7 @@ module OData
           method: :post,
           body:   entity.to_xml.gsub(/\n\s+/, ''),
           headers: {
-              Accept: 'application/atom+xml',
+              'Accept'       => 'application/atom+xml',
               'Content-Type' => 'application/atom+xml'
           }
       }
@@ -138,10 +137,8 @@ module OData
     end
 
     def get_paginated_entities(per_page, 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)
+      query = OData::Query.new(self)
+      query.include_count.skip(per_page * page).limit(per_page)
       result = service.execute(query)
       entities = service.find_entities(result)
       total = service.find_node(result, 'count').content.to_i

data/lib/odata/properties/boolean.rb

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

data/lib/odata/properties/integer.rb

@@ -28,12 +28,16 @@ module OData
 
       private
 
+      def exponent_size
+        63
+      end
+
       def min_value
-        @min ||= -(2**63)
+        @min ||= -(2**exponent_size)
       end
 
       def max_value
-        @max ||= (2**63)-1
+        @max ||= (2**exponent_size)-1
       end
     end
 
@@ -46,12 +50,8 @@ module OData
 
       private
 
-      def min_value
-        @min ||= -(2**15)
-      end
-
-      def max_value
-        @max ||= (2**15)-1
+      def exponent_size
+        15
       end
     end
 
@@ -64,12 +64,8 @@ module OData
 
       private
 
-      def min_value
-        @min ||= -(2**31)
-      end
-
-      def max_value
-        @max ||= (2**31)-1
+      def exponent_size
+        31
       end
     end
 
@@ -85,12 +81,12 @@ module OData
 
       private
 
-      def min_value
-        0
+      def exponent_size
+        8
       end
 
-      def max_value
-        @max ||= (2**8)-1
+      def min_value
+        0
       end
     end
 
@@ -103,12 +99,8 @@ module OData
 
       private
 
-      def min_value
-        @min ||= -(2**7)
-      end
-
-      def max_value
-        @max ||= (2**7)-1
+      def exponent_size
+        7
       end
     end
   end