odata 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0999c3b85269d2ad6c9855aa813ed5e6e10a24e
-  data.tar.gz: ee7cf848b1c47f15375c2e9cbd6e7cb5a2cbc89f
+  metadata.gz: bcb9a746bd19061bb07c0311b4bdc705c084ad5b
+  data.tar.gz: 1f2c9dae62cbec8852a2f65a29826f3ee5412a33
 SHA512:
-  metadata.gz: 516fa042cb00120bd214aeb52e9c12dbede85614562ccd760cbf4b41d1b6aed5571c82589949f795b42a3e9d4d61c687fb485db4f4bafc36d83c3666dfeb5921
-  data.tar.gz: 0654fbc52376a5446c86fb8303f6b5ca267b7eae694d87f3bcac4644cf824a953b3ed347a0f40864c022039947d312de4b9038a2775679a32140d4a1e1024186
+  metadata.gz: 28a93be11707fe9adcf4aa51af4a0c48d73bce1b680525ac293ceb89c9cb8b11e4045321da62d4a5e280158efb289fcd50325eaf20b1f2b5d6b5bf198ab3480e
+  data.tar.gz: 88b1a0bc6fb085880e20f102bebf8e16aad9a4313641cf1a5b6a5f75fde34caa47bc677ad886a473e843c4e82d04509bfea6351c5a504818e445a3eea130d3e4

data/README.md

@@ -4,6 +4,7 @@
 [![Code Climate](https://codeclimate.com/github/plainprogrammer/odata.png)](https://codeclimate.com/github/plainprogrammer/odata)
 [![Coverage](https://codeclimate.com/github/plainprogrammer/odata/coverage.png)](https://codeclimate.com/github/plainprogrammer/odata)
 [![Gem Version](https://badge.fury.io/rb/odata.svg)](http://badge.fury.io/rb/odata)
+[![Dependency Status](https://gemnasium.com/plainprogrammer/odata.svg)](https://gemnasium.com/plainprogrammer/odata)
 [![Documentation](http://inch-ci.org/github/plainprogrammer/odata.png?branch=master)](http://rubydoc.info/github/plainprogrammer/odata/master/frames)
 
 The OData gem provides a simple wrapper around the OData API protocol. It has
@@ -27,36 +28,75 @@ Or install it yourself as:
 
 ## Usage
 
+### Services & the Service Registry
+
 The OData gem provides a number of core classes, the two most basic ones are
-the OData::Service and the OData::ServiceRegistry. The only time you will need
-to worry about the OData::ServiceRegistry is when you have multiple OData
+the `OData::Service` and the `OData::ServiceRegistry`. The only time you will need
+to worry about the `OData::ServiceRegistry` is when you have multiple OData
 services you are interacting with that you want to keep straight easily. The
-nice thing about OData::Service is that it automatically registers with the
+nice thing about `OData::Service` is that it automatically registers with the
 registry on creation, so there is no manual interaction with the registry
 necessary.
 
-To create an OData::Service simply provide the location of a service endpoint
+To create an `OData::Service` simply provide the location of a service endpoint
 to it like this:
 
     OData::Service.open('http://services.odata.org/OData/OData.svc')
 
 This one call will setup the service and allow for the discovery of everything
 the other parts of the OData gem need to function. The two methods you will
-want to remember from OData::Service are `#service_url` and `#namespace`. Both
+want to remember from `OData::Service` are `#service_url` and `#namespace`. Both
 of these methods are available on instances and will allow for lookup in the
-OData::ServiceRegistry, should you need it.
+`OData::ServiceRegistry`, should you need it.
 
 Using either the service URL or the namespace provided by a service's CSDL
-schema will allow for quick lookup in the OData::ServiceRegistry like such:
+schema will allow for quick lookup in the `OData::ServiceRegistry` like such:
 
     OData::ServiceRegistry['http://services.odata.org/OData/OData.svc']
     OData::ServiceRegistry['ODataDemo']
 
 Both of the above calls would retrieve the same service from the registry. At
 the moment there is no protection against namespace collisions provided in
-OData::ServiceRegistry. So, looking up services by their service URL is the
+`OData::ServiceRegistry`. So, looking up services by their service URL is the
 most exact method, but lookup by namespace is provided for convenience.
 
+### Entity Sets
+
+When it comes to reading data from an OData service the most typical way will
+be via `OData::EntitySet` instances. Under normal circumstances you should
+never need to worry about an `OData::EntitySet` directly. For example, to get
+an `OData::EntitySet` for the products in the ODataDemo service simply access
+the entity set through the service like this:
+
+    svc = OData::Service.open('http://services.odata.org/OData/OData.svc')
+    products = svc['Products'] # => OData::EntitySet
+
+`OData::EntitySet` instances implement the `Enumerable` module, meaning you can
+work with them very naturally, like this:
+
+    products.each do |entity|
+      entity # => OData::Entity for type Product
+    end
+
+### Entities
+
+`OData::Entity` instances represent individual entities, or records, in a given
+service. They are returned primarily through interaction with instances of
+`OData::EntitySet`. You can access individual properties on an `OData::Entity`
+like so:
+
+    product = products.first # => OData::Entity
+    product['Name']  # => 'Bread'
+    product['Price'] # => 2.5 (Float)
+
+Individual properties on an `OData::Entity` are automatically typecast by the
+gem, so you don't have to worry about too much when working with entities. The
+way this is implemented internally guarantees that an `OData::Entity` is always
+ready to save back to the service or `OData::EntitySet`, which you do like so:
+
+    svc['Products'] << product # Write back to the service
+    products << product        # Write back to the Entity Set
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/odata/fork )

data/lib/odata/service.rb

@@ -83,12 +83,16 @@ module OData
     #
     # @param entity_type_name [to_s] the name of the EntityType you want the EntitySet of
     # @return [OData::EntitySet] an OData::EntitySet to query
-    def [](entity_type_name)
-      xpath_query = "//EntityContainer/EntitySet[@EntityType='#{namespace}.#{entity_type_name}']"
+    def [](entity_set_name)
+      xpath_query = "//EntityContainer/EntitySet[@Name='#{entity_set_name}']"
       entity_set_node = metadata.xpath(xpath_query).first
-      set_name = entity_set_node.attributes['Name'].value
+      raise ArgumentError, "Unknown Entity Set: #{entity_set_name}" if entity_set_node.nil?
       container_name = entity_set_node.parent.attributes['Name'].value
-      OData::EntitySet.new(name: set_name, namespace: namespace, type: entity_type_name.to_s, container: container_name)
+      entity_type_name = entity_set_node.attributes['EntityType'].value.gsub(/#{namespace}\./, '')
+      OData::EntitySet.new(name: entity_set_name,
+                           namespace: namespace,
+                           type: entity_type_name.to_s,
+                           container: container_name)
     end
 
     def execute(url_chunk, additional_options = {})

data/lib/odata/version.rb

@@ -1,3 +1,3 @@
 module OData
-  VERSION = '0.0.9'
+  VERSION = '0.0.10'
 end

data/spec/odata/service_spec.rb

@@ -81,6 +81,7 @@ describe OData::Service do
   end
 
   describe '#[]' do
-    it { expect(subject['Product']).to be_a(OData::EntitySet) }
+    it { expect(subject['Products']).to be_a(OData::EntitySet) }
+    it { expect {subject['Nonexistant']}.to raise_error(ArgumentError) }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: odata
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - James Thompson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-30 00:00:00.000000000 Z
+date: 2014-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler