odata 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfcfb15f804fca66b30e664860a33a1b7f3cf4ac
-  data.tar.gz: 1d91e95f9b75f8c0b463dca6fd2a1067a1b35064
+  metadata.gz: 44a27c048ec4706996d0eccc9aff655a5c60be94
+  data.tar.gz: de691ae9f3cb75ab544642f9826521cfc3bb09e5
 SHA512:
-  metadata.gz: e9b7873e447d44334dc0d9aaa69cc9be08e4d216de3ced58d4ed161417e8c3ebb932084ff68c303569d766216ce12024dd12094e20fa8d59f00dadc446647c72
-  data.tar.gz: 3f0c963f4f24887243ecc79442dfd868f9b71954b1ebd6c53a0ffd3aa9f7957a2e5035b1f108b7ab6553a73c2e094bf682836bcba5041c15aa1515a65ff1ff9b
+  metadata.gz: cdaae668ecb311bbb45f7abd54b116c9576d6c158c86968379405890aafad70bd14b0deda585c8f7e0cdbe9cb50e258d2590ccec2e3f78561ea851e58cc7a096
+  data.tar.gz: 84222c7cf63702ccc0f6073962a3ce3317cfb32507560dc49ada9c6ac6fb676cf66061a264fba8fa72849638448739d03c2a47bccdd684097499e1cf473a3cc2

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 0.5.0
+
+* Stopped using namespace from OData service as unique identifier in favor of
+  a supplied name option when opening a service.
+
 ## 0.4.0
 
 * Added OData::Query#execute to run query and return a result.

data/README.md

@@ -43,22 +43,28 @@ to it like this:
 
     OData::Service.open('http://services.odata.org/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:
+
+    OData::Service.open('http://services.odata.org/OData/OData.svc', name: 'ODataDemo')
+
 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 `#name`. Both
 of these methods are available on instances and will allow for lookup in the
 `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:
+Using either the service URL or the name provided as an option when creating an
+`OData::Service` 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
+the moment there is no protection against name collisions provided in
 `OData::ServiceRegistry`. So, looking up services by their service URL is the
-most exact method, but lookup by namespace is provided for convenience.
+most exact method, but lookup by name is provided for convenience.
 
 ### Entity Sets
 

data/lib/odata/entity.rb

@@ -7,14 +7,17 @@ module OData
   class Entity
     # The Entity type name
     attr_reader :type
-    # The OData::Service namespace
+    # The OData::Service's namespace
     attr_reader :namespace
+    # The OData::Service's identifying name
+    attr_reader :service_name
 
     # Initializes a bare Entity
     # @param options [Hash]
     def initialize(options = {})
       @type = options[:type]
       @namespace = options[:namespace]
+      @service_name = options[:service_name]
     end
 
     # Returns name of Entity from Service specified type.

data/lib/odata/entity_set.rb

@@ -14,8 +14,10 @@ module OData
     attr_reader :name
     # The Entity type for the EntitySet
     attr_reader :type
-    # The OData::Service namespace
+    # The OData::Service's namespace
     attr_reader :namespace
+    # The OData::Service's identifiable name
+    attr_reader :service_name
     # The EntitySet's container name
     attr_reader :container
 
@@ -24,11 +26,11 @@ module OData
     # @param options [Hash] the options to setup the EntitySet
     # @return [OData::EntitySet] an instance of the EntitySet
     def initialize(options = {})
-      @name = options[:name]
-      @type = options[:type]
-      @namespace = options[:namespace]
-      @container = options[:container]
-      self
+      @name         = options[:name]
+      @type         = options[:type]
+      @namespace    = options[:namespace]
+      @service_name = options[:service_name]
+      @container    = options[:container]
     end
 
     # Provided for Enumerable functionality
@@ -108,7 +110,7 @@ module OData
     # @return [OData::Service]
     # @api private
     def service
-      @service ||= OData::ServiceRegistry[namespace]
+      @service ||= OData::ServiceRegistry[service_name]
     end
 
     # Options used for instantiating a new OData::Entity for this set.
@@ -116,8 +118,9 @@ module OData
     # @api private
     def entity_options
       {
-          namespace:  namespace,
-          type:       type
+          namespace:    namespace,
+          service_name: service_name,
+          type:         type
       }
     end
 

data/lib/odata/service.rb

@@ -4,7 +4,6 @@ module OData
   class Service
     # The OData Service's URL
     attr_reader :service_url
-
     # Options to pass around
     attr_reader :options
 
@@ -31,6 +30,12 @@ module OData
       Service.new(service_url, options)
     end
 
+    # Returns user supplied name for service, or its URL
+    # @return [String]
+    def name
+      @name ||= options[:name] || service_url
+    end
+
     # Returns a list of entities exposed by the service
     def entity_types
       @entity_types ||= metadata.xpath('//EntityType').collect {|entity| entity.attributes['Name'].value}
@@ -58,7 +63,7 @@ module OData
 
     # Returns a more compact inspection of the service object
     def inspect
-      "#<#{self.class.name}:#{self.object_id} namespace='#{self.namespace}' service_url='#{self.service_url}'>"
+      "#<#{self.class.name}:#{self.object_id} name='#{name}' service_url='#{self.service_url}'>"
     end
 
     # Retrieves the EntitySet associated with a specific EntityType by name
@@ -74,6 +79,7 @@ module OData
       OData::EntitySet.new(name: entity_set_name,
                            namespace: namespace,
                            type: entity_type_name.to_s,
+                           service_name: name,
                            container: container_name)
     end
 

data/lib/odata/service_registry.rb

@@ -11,17 +11,17 @@ module OData
     def add(service)
       initialize_instance_variables
       @services << service if service.is_a?(OData::Service) && !@services.include?(service)
-      @services_by_namespace[service.namespace] = @services.find_index(service)
+      @services_by_name[service.name] = @services.find_index(service)
       @services_by_url[service.service_url] = @services.find_index(service)
     end
 
-    # Lookup a service by URL or namespace
+    # Lookup a service by URL or name
     #
-    # @param lookup_key [String] the URL or namespace to lookup
+    # @param lookup_key [String] the URL or name to lookup
     # @return [OData::Service, nil] the OData::Service or nil
     def [](lookup_key)
       initialize_instance_variables
-      index = @services_by_namespace[lookup_key] || @services_by_url[lookup_key]
+      index = @services_by_name[lookup_key] || @services_by_url[lookup_key]
       index.nil? ? nil : @services[index]
     end
 
@@ -39,13 +39,13 @@ module OData
 
     def initialize_instance_variables
       @services ||= []
-      @services_by_namespace ||= {}
+      @services_by_name ||= {}
       @services_by_url ||= {}
     end
 
     def flush
       @services = []
-      @services_by_namespace = {}
+      @services_by_name = {}
       @services_by_url = {}
     end
   end

data/lib/odata/version.rb

@@ -1,3 +1,3 @@
 module OData
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/spec/fixtures/vcr_cassettes/service_registry_specs.yml

@@ -41,7 +41,7 @@ http_interactions:
       Set-Cookie:
       - ARRAffinity=a9aad020fb0149d28d0efdb1e8bab24ad3481a904c8fb94abced8813c01ee265;Path=/;Domain=services.odata.org
       Date:
-      - Sat, 19 Jul 2014 02:59:51 GMT
+      - Mon, 21 Jul 2014 17:13:14 GMT
     body:
       encoding: UTF-8
       string: <?xml version="1.0" encoding="utf-8"?><edmx:Edmx Version="1.0" xmlns:edmx="http://schemas.microsoft.com/ado/2007/06/edmx"><edmx:DataServices
@@ -160,5 +160,5 @@ http_interactions:
     http_version: '1.1'
     adapter_metadata:
       effective_url: http://services.odata.org/OData/OData.svc/$metadata
-  recorded_at: Sat, 19 Jul 2014 02:59:52 GMT
+  recorded_at: Mon, 21 Jul 2014 17:13:14 GMT
 recorded_with: VCR 2.9.2

data/spec/odata/entity_set_spec.rb

@@ -2,19 +2,20 @@ require 'spec_helper'
 
 describe OData::EntitySet, vcr: {cassette_name: 'entity_set_specs'} do
   before(:example) do
-    OData::Service.open('http://services.odata.org/OData/OData.svc')
+    OData::Service.open('http://services.odata.org/OData/OData.svc', name: 'ODataDemo')
   end
 
   let(:subject) { OData::EntitySet.new(options) }
   let(:options) { {
       container: 'DemoService', namespace: 'ODataDemo', name: 'Products',
-      type: 'Product'
+      type: 'Product', service_name: 'ODataDemo'
   } }
 
   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(:service_name) }
   it { expect(subject).to respond_to(:new_entity) }
   it { expect(subject).to respond_to(:[]) }
   it { expect(subject).to respond_to(:<<) }
@@ -22,6 +23,7 @@ describe OData::EntitySet, vcr: {cassette_name: 'entity_set_specs'} do
   it { expect(subject.name).to eq('Products') }
   it { expect(subject.container).to eq('DemoService') }
   it { expect(subject.namespace).to eq('ODataDemo') }
+  it { expect(subject.service_name).to eq('ODataDemo') }
   it { expect(subject.type).to eq('Product') }
 
   describe '#each' do

data/spec/odata/entity_spec.rb

@@ -2,20 +2,22 @@ require 'spec_helper'
 
 describe OData::Entity, vcr: {cassette_name: 'entity_specs'} do
   before(:example) do
-    OData::Service.open('http://services.odata.org/OData/OData.svc')
+    OData::Service.open('http://services.odata.org/OData/OData.svc', name: 'ODataDemo')
   end
 
   let(:subject) { OData::Entity.new(options) }
   let(:options) { {
-      type:       'ODataDemo.Product',
-      namespace:  'ODataDemo'
+      type:         'ODataDemo.Product',
+      namespace:    'ODataDemo',
+      service_name: 'ODataDemo'
   } }
 
-  it { expect(subject).to respond_to(:name, :type, :namespace) }
+  it { expect(subject).to respond_to(:name, :type, :namespace, :service_name) }
 
   it { expect(subject.name).to eq('Product') }
   it { expect(subject.type).to eq('ODataDemo.Product') }
   it { expect(subject.namespace).to eq('ODataDemo') }
+  it { expect(subject.service_name).to eq('ODataDemo') }
 
   describe '.from_xml' do
     let(:subject) { OData::Entity.from_xml(product_xml, options) }
@@ -31,6 +33,7 @@ describe OData::Entity, vcr: {cassette_name: 'entity_specs'} do
     it { expect(subject.name).to eq('Product') }
     it { expect(subject.type).to eq('ODataDemo.Product') }
     it { expect(subject.namespace).to eq('ODataDemo') }
+    it { expect(subject.service_name).to eq('ODataDemo') }
 
     it { expect(subject['ID']).to eq(0) }
     it { expect(subject['Name']).to eq('Bread') }

data/spec/odata/query/result_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe OData::Query::Result, vcr: {cassette_name: 'query/result_specs'} do
   before(:example) do
-    OData::Service.open('http://services.odata.org/OData/OData.svc')
+    OData::Service.open('http://services.odata.org/OData/OData.svc', name: 'ODataDemo')
   end
 
   let(:subject) { query.execute }

data/spec/odata/query_spec.rb

@@ -1,17 +1,17 @@
 require 'spec_helper'
 
 describe OData::Query, vcr: {cassette_name: 'query_specs'} do
+  before(:example) do
+    OData::Service.open('http://services.odata.org/OData/OData.svc', name: 'ODataDemo')
+  end
+
   let(:subject) { OData::Query.new(entity_set) }
   let(:entity_set) { OData::EntitySet.new(options) }
   let(:options) { {
       container: 'DemoService', namespace: 'ODataDemo', name: 'Products',
-      type: 'Product'
+      service_name: 'ODataDemo', type: 'Product'
   } }
 
-  before(:example) do
-    OData::Service.open('http://services.odata.org/OData/OData.svc')
-  end
-
   it { expect(subject).to respond_to(:to_s) }
   it { expect(subject.to_s).to eq('Products')}
 

data/spec/odata/service_registry_spec.rb

@@ -2,17 +2,17 @@ require 'spec_helper'
 
 describe OData::ServiceRegistry, vcr: {cassette_name: 'service_registry_specs'} do
   let(:subject) { OData::ServiceRegistry }
-  let(:sample_service) { OData::Service.open('http://services.odata.org/OData/OData.svc') }
+  let(:sample_service) { OData::Service.open('http://services.odata.org/OData/OData.svc', name: 'demoService') }
 
   it { expect(subject).to respond_to(:add) }
   it { expect(subject).to respond_to(:[]) }
 
   describe '#add' do
-    before :each do
+    before(:example) do
       subject.add(sample_service)
     end
 
-    it { expect(subject[sample_service.namespace]).to eq(sample_service) }
-    it { expect(subject[sample_service.service_url]).to eq(sample_service) }
+    it { expect(subject['demoService']).to eq(sample_service) }
+    it { expect(subject['http://services.odata.org/OData/OData.svc']).to eq(sample_service) }
   end
 end

data/spec/odata/service_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe OData::Service, vcr: {cassette_name: 'service_specs'} do
-  let(:subject) { OData::Service.open('http://services.odata.org/OData/OData.svc') }
+  let(:subject) { OData::Service.open('http://services.odata.org/OData/OData.svc', name: 'ODataDemo') }
   let(:entity_types) { %w{Product FeaturedProduct ProductDetail Category Supplier Person Customer Employee PersonDetail Advertisement} }
   let(:entity_sets) { %w{Products ProductDetails Categories Suppliers Persons PersonDetails Advertisements} }
   let(:entity_set_types) { %w{Product ProductDetail Category Supplier Person PersonDetail Advertisement} }
@@ -15,7 +15,7 @@ describe OData::Service, vcr: {cassette_name: 'service_specs'} do
     expect(OData::ServiceRegistry['ODataDemo']).to be_nil
     expect(OData::ServiceRegistry['http://services.odata.org/OData/OData.svc']).to be_nil
 
-    service = OData::Service.open('http://services.odata.org/OData/OData.svc')
+    service = OData::Service.open('http://services.odata.org/OData/OData.svc', name: 'ODataDemo')
 
     expect(OData::ServiceRegistry['ODataDemo']).to eq(service)
     expect(OData::ServiceRegistry['http://services.odata.org/OData/OData.svc']).to eq(service)

data/spec/spec_helper.rb

@@ -17,7 +17,8 @@ require 'vcr'
 VCR.configure do |c|
   c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
   c.hook_into :typhoeus
-  c.default_cassette_options = { record: :new_episodes, erb: true }
+  c.default_cassette_options = { record: :new_episodes }
+  c.debug_logger = File.open(ENV['VCR_LOG'], 'w') if ENV['VCR_LOG']
   c.configure_rspec_metadata!
 end
 

metadata

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