odata4 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a49a6ff012ef0bb66a692514d673479303e198b
-  data.tar.gz: 99cd07d3a97e6a972d81917949a2f4344745a735
+  metadata.gz: e28c4147df950462c72f8824c2868601941872c5
+  data.tar.gz: 8044f114aaa10c09719c3d3e5743f5f5c96de9d7
 SHA512:
-  metadata.gz: f176202b1e8998dc076b21c33bcfde3ff95eb360cbff5fee4073aa9ba3d16334322c26801e3e3ed065101b7895b46bb418c4cddf21b3259f6663cff8f42c185c
-  data.tar.gz: b0a5b08aa206f1cf4baf90ecf7e2fe19002ae81bfae49b27d29523266ee13dde9ca01e7d1dfd3471572f4bdec61c9613d75f6b60ccfc6ccafab59647c49fd114
+  metadata.gz: c10b8c4859b7f2acdbf33d5258f12e43970d24061f558afac558be6212a955e4c5b5118720de78e74ae22231f7bf5479a137591082a0568aee13f5a325350788
+  data.tar.gz: 8d73fc1f5877df150a21a28ca10871582e58657f0419726fadb1d2c514c62d09517ff1f7eb2d1559bd49d6aea8fb50435e7280bedd60ed174a9528c26d926f05

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## 0.8.0
+
+* [New Feature] Support for multiple schemas
+* [Breaking] `Service#complex_types`, `Service#entity_types`,
+  `Service#enum_types` and `Service#entity_sets` now return fully qualified
+  type names
+* [New Feature] Optional lenient property validation
+* [Fixed] Incorrect URL representation for Decimal properties
+
 ## 0.7.0
 
 Major rewrite

data/README.md

@@ -18,7 +18,7 @@ If you need a gem to integration with OData Version 3, you can use James Thompso
 
 Add this line to your application's `Gemfile`:
 
-    gem 'odata4', git: 'https://github.com/wrstudios/odata4'
+    gem 'odata4'
 
 And then execute:
 
@@ -40,14 +40,14 @@ The nice thing about `OData4::Service` is that it automatically registers with t
 To create an `OData4::Service` simply provide the location of a service endpoint to it like this:
 
 ```ruby
-  OData4::Service.open('http://services.odata.org/V4/OData/OData.service')
+  OData4::Service.open('http://services.odata.org/V4/OData/OData.svc')
 ```
 
 You may also provide an options hash after the URL.
 It is suggested that you supply a name for the service via this hash like so:
 
 ```ruby
-  OData4::Service.open('http://services.odata.org/V4/OData/OData.service', name: 'ODataDemo')
+  OData4::Service.open('http://services.odata.org/V4/OData/OData.svc', name: 'ODataDemo')
 ```
 
 This one call will setup the service and allow for the discovery of everything the other parts of the OData4 gem need to function.
@@ -57,7 +57,7 @@ Both of these methods are available on instances and will allow for lookup in th
 Using either the service URL or the name provided as an option when creating an `OData4::Service` will allow for quick lookup in the `OData4::ServiceRegistry` like such:
 
 ```ruby
-  OData4::ServiceRegistry['http://services.odata.org/V4/OData/OData.service']
+  OData4::ServiceRegistry['http://services.odata.org/V4/OData/OData.svc']
   OData4::ServiceRegistry['ODataDemo']
 ```
 
@@ -65,6 +65,61 @@ Both of the above calls would retrieve the same service from the registry.
 At the moment there is no protection against name collisions provided in `OData4::ServiceRegistry`.
 So, looking up services by their service URL is the most exact method, but lookup by name is provided for convenience.
 
+### Exploring a Service
+
+Once instantiated, you can request various information about the service, such as the names and types of entity sets it exposes, or the names of the entity types (and custom datatypes) it defines.
+
+For example:
+
+Get a list of available entity types
+
+```ruby
+  service.entity_types
+  # => [
+  #   "ODataDemo.Product",
+  #   "ODataDemo.FeaturedProduct",
+  #   "ODataDemo.ProductDetail",
+  #   "ODataDemo.Category",
+  #   "ODataDemo.Supplier",
+  #   "ODataDemo.Person",
+  #   "ODataDemo.Customer",
+  #   "ODataDemo.Employee",
+  #   "ODataDemo.PersonDetail",
+  #   "ODataDemo.Advertisement"
+  # ]
+```
+
+Get a list of entity sets
+
+```ruby
+  service.entity_sets
+  # => {
+  #   "Products"       => "ODataDemo.Product",
+  #   "ProductDetails" => "ODataDemo.ProductDetail",
+  #   "Categories"     => "ODataDemo.Category",
+  #   "Suppliers"      => "ODataDemo.Supplier",
+  #   "Persons"        => "ODataDemo.Person",
+  #   "PersonDetails"  => "ODataDemo.PersonDetail",
+  #   "Advertisements" => "ODataDemo.Advertisement"
+  # }
+```
+
+Get a list of complex types
+
+```ruby
+  service.complex_types
+  # => ["ODataDemo.Address"]
+```
+
+Get a list of enum types
+
+```ruby
+  service.enum_types
+  # => ["ODataDemo.ProductStatus"]
+```
+
+For more examples, refer to [usage_example_specs.rb](spec/odata4/usage_example_specs.rb).
+
 ### Authentication
 
 When authenticating with your service you can set parameters to the Typhoeus gem which uses libcurl.
@@ -73,7 +128,7 @@ Use the **:typhoeus** option to set your authentication.
 For example using **ntlm** authentication:
 
 ```ruby
-  conn = OData4::Service.open('http://services.odata.org/V4/OData/OData.service', {
+  conn = OData4::Service.open('http://services.odata.org/V4/OData/OData.svc', {
     name: 'ODataDemo',
     typhoeus: {
       username: 'username',
@@ -95,7 +150,7 @@ You can speed your load time by forcing the service to load the metadata from a
 This is only recommended for testing purposes, as the metadata file can change.
 
 ```ruby
-  conn = OData4::Service.open('http://services.odata.org/V4/OData/OData.service', {
+  conn = OData4::Service.open('http://services.odata.org/V4/OData/OData.svc', {
       name: 'ODataDemo',
       metadata_file: "metadata.xml",
   })
@@ -106,7 +161,7 @@ This is only recommended for testing purposes, as the metadata file can change.
 You can set the headers with the **:typhoeus** param like so:
 
 ```ruby
-  conn = OData4::Service.open('http://services.odata.org/V4/OData/OData.service', {
+  conn = OData4::Service.open('http://services.odata.org/V4/OData/OData.svc', {
     name: 'ODataDemo',
     typhoeus: {
       headers: {
@@ -123,7 +178,7 @@ Under normal circumstances you should never need to worry about an `OData4::Enti
 For example, to get an `OData4::EntitySet` for the products in the ODataDemo service simply access the entity set through the service like this:
 
 ```ruby
-  service = OData4::Service.open('http://services.odata.org/V4/OData/OData.service')
+  service = OData4::Service.open('http://services.odata.org/V4/OData/OData.svc')
   products = service['ProductsSet'] # => OData4::EntitySet
 ```
 
@@ -172,7 +227,7 @@ The first entity object returns a single entity object.
 #### Find a certain Entity
 
 ```ruby
-  service['ProductsSet']['<guid of entity>']
+  service['ProductsSet']['<primary key of entity>']
 ```
 
 With certain navigation properties expanded (i.e. eagerly loaded):
@@ -239,6 +294,21 @@ or, you can get a hold of the property class instance using
 
 This will parse and instantiate the property if it hasn't done so yet.
 
+##### Lenient Property Validation
+
+By default, we use strict property validation, meaning that any property validation errors in the data will raise an exception.
+However, you may encounter OData implementations in the wild that break the specs in strange and surprising ways (shocking, I know!).
+
+Since it's often better to get *some* data instead of nothing at all, you can optionally make the property validation lenient.
+Simply add `strict: false` to the service constructor options.
+In this mode, any property validation error will log a warning instead of raising an exception. The corresponding property value will be `nil` (even if the property is declared as not allowing NULL values).
+
+```ruby
+  service = OData4::Service.open('http://services.odata.org/V4/OData/OData.svc', strict: false)
+  # -- alternatively, for an existing service instance --
+  service.options[:strict] = false
+```
+
 ### Queries
 
 `OData4::Query` instances form the base for finding specific entities within an `OData4::EntitySet`.
@@ -266,6 +336,17 @@ You should refer to the published RubyDocs for full details on the various capab
  * [OData4::Query](http://rubydoc.info/github/wrstudios/odata4/master/OData4/Query)
  * [OData4::Query::Criteria](http://rubydoc.info/github/wrstudios/odata4/master/OData4/Query/Criteria)
 
+## To Do
+
+[x] ~Lenient property validation~
+[ ] Write support (create/update/delete)
+[ ] Support for invoking [Operations][odata-ops] (Functions/Actions)
+[ ] [Property facets][odata-facets]
+[ ] Annotations
+
+[odata-facets]: http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part3-csdl/odata-v4.0-errata03-os-part3-csdl-complete.html#_Toc453752528
+[odata-ops]: http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html#_Toc453752307
+
 ## Contributing
 
 1. Fork it (`https://github.com/[my-github-username]/odata/fork`)

data/lib/odata4.rb

@@ -19,11 +19,13 @@ require 'odata4/navigation_property'
 require 'odata4/complex_type'
 require 'odata4/enum_type'
 require 'odata4/entity'
+require 'odata4/entity_container'
 require 'odata4/entity_set'
 require 'odata4/query/criteria'
 require 'odata4/query/result'
 require 'odata4/query/in_batches'
 require 'odata4/query'
+require 'odata4/schema'
 require 'odata4/service'
 require 'odata4/service_registry'
 

data/lib/odata4/complex_type.rb

@@ -9,10 +9,9 @@ module OData4
     # Creates a new ComplexType based on the supplied options.
     # @param type_xml [Nokogiri::XML::Element]
     # @param service [OData4::Service]
-    # @return [self]
-    def initialize(type_definition, service)
+    def initialize(type_definition, schema)
       @type_definition = type_definition
-      @service         = service
+      @schema          = schema
     end
 
     # The name of the ComplexType
@@ -58,8 +57,12 @@ module OData4
 
     private
 
+    def schema
+      @schema
+    end
+
     def service
-      @service
+      @schema.service
     end
 
     def type_definition
@@ -68,7 +71,7 @@ module OData4
 
     def collect_properties
       Hash[type_definition.xpath('./Property').map do |property_xml|
-        property_name, property = service.send(:process_property_from_xml,property_xml)
+        property_name, property = schema.send(:process_property_from_xml, property_xml)
         [property_name, property]
       end]
     end

data/lib/odata4/entity.rb

@@ -7,8 +7,6 @@ module OData4
   class Entity
     # The Entity type name
     attr_reader :type
-    # The OData4::Service's namespace
-    attr_reader :namespace
     # The OData4::Service's identifying name
     attr_reader :service_name
     # The entity set this entity belongs to
@@ -31,7 +29,6 @@ module OData4
     def initialize(options = {})
       @id = options[:id]
       @type = options[:type]
-      @namespace = options[:namespace]
       @service_name = options[:service_name]
       @entity_set = options[:entity_set]
       @context = options[:context]
@@ -39,10 +36,14 @@ module OData4
       @errors = []
     end
 
+    def namespace
+      @namespace ||= type.rpartition('.').first
+    end
+
     # Returns name of Entity from Service specified type.
     # @return [String]
     def name
-      @name ||= type.gsub(/#{namespace}\./, '')
+      @name ||= type.split('.').last
     end
 
     # Returns context URL for this entity
@@ -110,7 +111,7 @@ module OData4
     # Links to other OData4 entitites
     # @return [Hash]
     def links
-      @links ||= service.navigation_properties[name].map do |nav_name, details|
+      @links ||= schema.navigation_properties[name].map do |nav_name, details|
         [
           nav_name,
           { type: details.nav_type, href: "#{id}/#{nav_name}" }
@@ -125,7 +126,7 @@ module OData4
     def self.with_properties(new_properties = {}, options = {})
       entity = OData4::Entity.new(options)
       entity.instance_eval do
-        service.properties_for_entity(name).each do |property_name, instance|
+        service.properties_for_entity(type).each do |property_name, instance|
           set_property(property_name, instance)
         end
 
@@ -213,7 +214,7 @@ module OData4
     # Returns the primary key for the Entity.
     # @return [String]
     def primary_key
-      service.primary_key_for(name)
+      schema.primary_key_for(name)
     end
 
     def is_new?
@@ -228,16 +229,20 @@ module OData4
       @service ||= OData4::ServiceRegistry[service_name]
     end
 
+    def schema
+      @schema ||= service.schemas[namespace]
+    end
+
     private
 
     def instantiate_property(property_name, value_xml)
-      value_type = service.get_property_type(name, property_name)
+      value_type = schema.get_property_type(name, property_name)
       klass = ::OData4::PropertyRegistry[value_type]
 
       if klass.nil?
         raise RuntimeError, "Unknown property type: #{value_type}"
       else
-        klass.from_xml(value_xml)
+        klass.from_xml(value_xml, service: service)
       end
     end
 
@@ -280,7 +285,7 @@ module OData4
     def self.process_links(entity, xml_doc)
       entity.instance_eval do
         new_links = instance_variable_get(:@links) || {}
-        service.navigation_properties[name].each do |nav_name, details|
+        schema.navigation_properties[name].each do |nav_name, details|
           xml_doc.xpath("./link[@title='#{nav_name}']").each do |node|
             next if node.attributes['type'].nil?
             next unless node.attributes['type'].value =~ /^application\/atom\+xml;type=(feed|entry)$/i
@@ -304,7 +309,7 @@ module OData4
     def self.process_metadata(entity, metadata)
       entity.instance_eval do
         new_links = instance_variable_get(:@links) || {}
-        service.navigation_properties[name].each do |nav_name, details|
+        schema.navigation_properties[name].each do |nav_name, details|
           href = metadata["#{nav_name}@odata.navigationLink"]
           next if href.nil?
           new_links[nav_name] = {

data/lib/odata4/entity_container.rb

@@ -0,0 +1,75 @@
+module OData4
+  #
+  class EntityContainer
+    # The EntityContainer's parent service
+    attr_reader :service
+    # The EntityContainer's metadata
+    attr_reader :metadata
+
+    # Creates a new EntityContainer
+    # @param service [OData4::Service] The entity container's parent service
+    def initialize(service)
+      @metadata = service.metadata.xpath('//EntityContainer').first
+      @service  = service
+    end
+
+    # The EntityContainer's surrounding Schema
+    # @return [Nokogiri::XML]
+    def schema
+      @schema ||= metadata.ancestors('Schema').first
+    end
+
+    # Returns the EntityContainer's namespace.
+    # @return [String]
+    def namespace
+      @namespace ||= schema.attributes['Namespace'].value
+    end
+
+    # Returns the EntityContainer's name.
+    # @return [String]
+    def name
+      @name ||= metadata.attributes['Name'].value
+    end
+
+    # Returns a hash of EntitySet names and their respective EntityTypes.
+    # @return [Hash<String, String>]
+    def entity_sets
+      @entity_sets ||= metadata.xpath('//EntitySet').map do |entity|
+        [
+          entity.attributes['Name'].value,
+          entity.attributes['EntityType'].value
+        ]
+      end.to_h
+    end
+
+    # Retrieves the EntitySet associated with a specific EntityType by name
+    #
+    # @param entity_set_name [to_s] the name of the EntitySet desired
+    # @return [OData4::EntitySet] an OData4::EntitySet to query
+    def [](entity_set_name)
+      xpath_query = "//EntitySet[@Name='#{entity_set_name}']"
+      entity_set_node = metadata.xpath(xpath_query).first
+      raise ArgumentError, "Unknown Entity Set: #{entity_set_name}" if entity_set_node.nil?
+      entity_type = entity_set_node.attributes['EntityType'].value
+      OData4::EntitySet.new(
+        name: entity_set_name,
+        namespace: namespace,
+        type: entity_type,
+        service_name: service.name,
+        container: name
+      )
+    end
+
+    def singletons
+      # TODO return singletons exposed by this EntityContainer
+    end
+
+    def actions
+      # TODO return action imports exposed by this EntityContainer
+    end
+
+    def functions
+      # TODO return function imports exposed by this EntityContainer
+    end
+  end
+end

data/lib/odata4/entity_set.rb

@@ -115,7 +115,6 @@ module OData4
     # @api private
     def entity_options
       {
-        namespace:    namespace,
         service_name: service_name,
         type:         type,
         entity_set:   self

data/lib/odata4/enum_type.rb

@@ -8,9 +8,9 @@ module OData4
     # @param type_xml [Nokogiri::XML::Element]
     # @param service [OData4::Service]
     # @return [self]
-    def initialize(type_definition, service)
+    def initialize(type_definition, schema)
       @type_definition = type_definition
-      @service         = service
+      @schema          = schema
     end
 
     # The name of the EnumType
@@ -71,7 +71,7 @@ module OData4
     private
 
     def service
-      @service
+      @schema.service
     end
 
     def type_definition