ruby_odata 0.1.4 → 0.1.5

data/spec/fixtures/sample_service/result_select_categories_no_property.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8" standalone="yes"?>
+<error
+    xmlns="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
+    <code></code>
+    <message xml:lang="en-US">Type 'RubyODataService.Category' does not have a property named 'Price' or there is no type with 'Price' name.</message>
+</error>

data/spec/fixtures/sample_service/result_select_categories_travsing_no_expand.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8" standalone="yes"?>
+<error
+    xmlns="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
+    <code></code>
+    <message xml:lang="en-US">Only properties specified in $expand can be traversed in $select query options. Property .</message>
+</error>

data/spec/fixtures/sample_service/result_select_products_name_price.xml

@@ -0,0 +1,92 @@
+<?xml version="1.0" encoding="utf-8"?>
+<feed xml:base="http://win7dev:8989/SampleService/RubyOData.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://win7dev:8989/SampleService/RubyOdata.svc/Products</id>
+    <title type="text">Products</title>
+    <updated>2013-07-19T12:29:11Z</updated>
+    <link rel="self" title="Products" href="Products" />
+    <entry>
+        <id>http://win7dev:8989/SampleService/RubyOData.svc/Products(1)</id>
+        <category term="RubyODataService.Product" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
+        <link rel="edit" title="Product" href="Products(1)" />
+        <title />
+        <updated>2013-07-19T12:29:11Z</updated>
+        <author>
+            <name />
+        </author>
+        <content type="application/xml">
+            <m:properties>
+                <d:Name>Widget 0001</d:Name>
+                <d:Price m:type="Edm.Decimal">75.50</d:Price>
+            </m:properties>
+        </content>
+    </entry>
+    <entry>
+        <id>http://win7dev:8989/SampleService/RubyOData.svc/Products(2)</id>
+        <category term="RubyODataService.Product" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
+        <link rel="edit" title="Product" href="Products(2)" />
+        <title />
+        <updated>2013-07-19T12:29:11Z</updated>
+        <author>
+            <name />
+        </author>
+        <content type="application/xml">
+            <m:properties>
+                <d:Name>Widget 0002</d:Name>
+                <d:Price m:type="Edm.Decimal">100.00</d:Price>
+            </m:properties>
+        </content>
+    </entry>
+    <entry>
+        <id>http://win7dev:8989/SampleService/RubyOData.svc/Products(3)</id>
+        <category term="RubyODataService.Product" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
+        <link rel="edit" title="Product" href="Products(3)" />
+        <title />
+        <updated>2013-07-19T12:29:11Z</updated>
+        <author>
+            <name />
+        </author>
+        <content type="application/xml">
+            <m:properties>
+                <d:Name>Widget 0003</d:Name>
+                <d:Price m:type="Edm.Decimal">10.25</d:Price>
+            </m:properties>
+        </content>
+    </entry>
+    <entry>
+        <id>http://win7dev:8989/SampleService/RubyOData.svc/Products(4)</id>
+        <category term="RubyODataService.Product" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
+        <link rel="edit" title="Product" href="Products(4)" />
+        <title />
+        <updated>2013-07-19T12:29:11Z</updated>
+        <author>
+            <name />
+        </author>
+        <content type="application/xml">
+            <m:properties>
+                <d:Name>Widget 0004</d:Name>
+                <d:Price m:type="Edm.Decimal">100.00</d:Price>
+            </m:properties>
+        </content>
+    </entry>
+    <entry>
+        <id>http://win7dev:8989/SampleService/RubyOData.svc/Products(5)</id>
+        <category term="RubyODataService.Product" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
+        <link rel="edit" title="Product" href="Products(5)" />
+        <title />
+        <updated>2013-07-19T12:29:11Z</updated>
+        <author>
+            <name />
+        </author>
+        <content type="application/xml">
+            <m:properties>
+                <d:Name>Widget 0005</d:Name>
+                <d:Price m:type="Edm.Decimal">75.50</d:Price>
+            </m:properties>
+        </content>
+    </entry>
+</feed>

data/spec/property_metadata_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module OData
   describe PropertyMetadata do
     describe "#initialize" do
-      it "parses an EDMX property with the essentials (name, type, nullable, nav_prop)" do        
+      it "parses an EDMX property with the essentials (name, type, nullable, nav_prop)" do
         property_element = RSpecSupport::ElementHelpers.string_to_element('<Property Name="Id" Type="Edm.String" Nullable="false" />')
         property_metadata = PropertyMetadata.new property_element
         property_metadata.name.should eq "Id"
@@ -15,30 +15,30 @@ module OData
         property_element = RSpecSupport::ElementHelpers.string_to_element('<Property Name="Id" Type="Edm.String" Nullable="true" />')
         property_metadata = PropertyMetadata.new property_element
         property_metadata.nullable.should eq true
-      end      
-      it "parses an EDMX property with nil for missing attributes" do        
+      end
+      it "parses an EDMX property with nil for missing attributes" do
         property_element = RSpecSupport::ElementHelpers.string_to_element('<Property Name="Id" Type="Edm.String" Nullable="false" />')
         property_metadata = PropertyMetadata.new property_element
         property_metadata.fc_target_path.should be_nil
         property_metadata.fc_keep_in_content.should be_nil
       end
-      it "parses an EDMX property with false for missing Nullable attribute" do        
+      it "parses an EDMX property with false for missing Nullable attribute" do
         property_element = RSpecSupport::ElementHelpers.string_to_element('<Property Name="Id" Type="Edm.String" />')
         property_metadata = PropertyMetadata.new property_element
         property_metadata.nullable.should eq false
-      end      
-      it "parses an EDMX property with the fc_target_path and fc_keep_in_content attribute" do        
+      end
+      it "parses an EDMX property with the fc_target_path and fc_keep_in_content attribute" do
         property_element = RSpecSupport::ElementHelpers.string_to_element('<Property xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" Name="Title" Type="Edm.String" Nullable="true" m:FC_TargetPath="SyndicationTitle" m:FC_ContentKind="text" m:FC_KeepInContent="false" />')
         property_metadata = PropertyMetadata.new property_element
         property_metadata.fc_target_path.should eq "SyndicationTitle"
         property_metadata.fc_keep_in_content.should eq false
       end
-      it "parses an EDMX property where fc_keep_in_content is true" do        
+      it "parses an EDMX property where fc_keep_in_content is true" do
         property_element = RSpecSupport::ElementHelpers.string_to_element('<Property xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" Name="Title" Type="Edm.String" Nullable="true" m:FC_TargetPath="SyndicationTitle" m:FC_ContentKind="text" m:FC_KeepInContent="true" />')
         property_metadata = PropertyMetadata.new property_element
         property_metadata.fc_keep_in_content.should eq true
       end
-      it "parses an EDMX navigation property with the name and the nav_prop set to true" do        
+      it "parses an EDMX navigation property with the name and the nav_prop set to true" do
         property_element = RSpecSupport::ElementHelpers.string_to_element('<NavigationProperty Name="Category" Relationship="Model.CategoryProduct" FromRole="Product" ToRole="Category" />')
         property_metadata = PropertyMetadata.new property_element
         property_metadata.name.should eq "Category"

data/spec/query_builder_spec.rb

@@ -30,11 +30,16 @@ module OData
         builder.top(5)
         builder.query.should eq "Categories(1)/$links/Products?$top=5"
       end
-      it "should throw an execption if count was already called on the builder" do
+      it "should throw an exception if count was already called on the builder" do
         builder = QueryBuilder.new "Categories(1)"
         builder.count
         lambda { builder.links("Products") }.should raise_error(OData::NotSupportedError, "You cannot call both the `links` method and the `count` method in the same query.")
       end
+      it "should throw an exception if select was already called on the builder" do
+        builder = QueryBuilder.new "Products"
+        builder.select "Price"
+        lambda { builder.links("Products") }.should raise_error(OData::NotSupportedError, "You cannot call both the `links` method and the `select` method in the same query.")
+      end
     end
 
     describe "#count" do
@@ -53,11 +58,64 @@ module OData
         builder.count
         builder.query.should eq "Products/$count?$filter=Name+eq+%27Widget+1%27"
       end
-      it "should throw an execption if links was already called on the builder" do
+      it "should throw an exception if links was already called on the builder" do
         builder = QueryBuilder.new "Categories(1)"
         builder.links("Products")
         lambda { builder.count }.should raise_error(OData::NotSupportedError, "You cannot call both the `links` method and the `count` method in the same query.")
       end
+      it "should throw an exception if select was already called on the builder" do
+        builder = QueryBuilder.new "Products"
+        builder.select("Price")
+        lambda { builder.count }.should raise_error(OData::NotSupportedError, "You cannot call both the `select` method and the `count` method in the same query.")
+      end
+    end
+
+    describe "#select" do
+      it "should accept the select method" do
+        builder = QueryBuilder.new "Products"
+        lambda { builder.select }.should_not raise_error
+      end
+      it "should properly handle the select method" do
+        builder = QueryBuilder.new "Products"
+        builder.select "Price", "Rating"
+        builder.query.should eq "Products?$select=Price,Rating"
+      end
+      it "shouldn't add duplicate properties" do
+        builder = QueryBuilder.new "Products"
+        builder.select "Price", "Rating", "Price"
+        builder.query.should eq "Products?$select=Price,Rating"
+      end
+      it "should properly handle the select method with additional operators" do
+        builder = QueryBuilder.new "Products"
+        builder.filter("Name eq 'Widget 1'")
+        builder.select("Price", "Rating")
+        builder.query.should eq "Products?$select=Price,Rating&$filter=Name+eq+%27Widget+1%27"
+      end
+      it "should throw an exception if links was already called on the builder" do
+        builder = QueryBuilder.new "Categories(1)"
+        builder.links("Products")
+        lambda { builder.select("Price") }.should raise_error(OData::NotSupportedError, "You cannot call both the `links` method and the `select` method in the same query.")
+      end
+      it "should throw an exception if count was already called on the builder" do
+        builder = QueryBuilder.new "Products"
+        builder.count
+        lambda { builder.select("Price") }.should raise_error(OData::NotSupportedError, "You cannot call both the `count` method and the `select` method in the same query.")
+      end
+      it "should return itself" do
+        builder = QueryBuilder.new "Products"
+        result = builder.select("Price", "Rating")
+        result.should be_a(QueryBuilder)
+      end
+      it "should automatically add $expand for nested selects" do
+        builder = QueryBuilder.new "Categories"
+        result = builder.select "Name", "Products/Name"
+        result.query.should eq "Categories?$select=Name,Products/Name&$expand=Products"
+      end
+      it "should automatically add $expand for deeply nested selects" do
+        builder = QueryBuilder.new "Products"
+        result = builder.select "ProductName", "Order_Details/OrderID", "Order_Details/Order/Customer/CompanyName"
+        result.query.should eq "Products?$select=ProductName,Order_Details/OrderID,Order_Details/Order/Customer/CompanyName&$expand=Order_Details,Order_Details/Order/Customer"
+      end
     end
 
     describe "#navigate" do

data/spec/revised_service_spec.rb

@@ -10,7 +10,7 @@ module OData
       @cat_prod_service = OData::Service.new "http://test.com/test.svc"
     end
     subject { @cat_prod_service }
-    
+
     context "methods" do
       it { should respond_to :update_object }
       it { should respond_to :delete_object }
@@ -25,7 +25,7 @@ module OData
       it { should respond_to :collections }
       it { should respond_to :options }
       it { should respond_to :function_imports }
-    
+
       context "after parsing metadata" do
         it { should respond_to :Products }
         it { should respond_to :Categories }
@@ -43,7 +43,7 @@ module OData
       end
       it "should expose the local model type" do
         subject['Products'][:type].should eq Product
-        subject['Categories'][:type].should eq Category                
+        subject['Categories'][:type].should eq Category
       end
     end
     context "class metadata" do
@@ -51,6 +51,7 @@ module OData
       it { should_not be_empty}
       it { should have_key 'Product' }
       it { should have_key 'Category' }
+
       context "should have keys for each property" do
         subject { @cat_prod_service.class_metadata['Category'] }
         it { should have_key 'Id' }
@@ -69,6 +70,7 @@ module OData
           meta.fc_target_path.should be_nil
           meta.fc_keep_in_content.should be_nil
           meta.nav_prop.should eq false
+          meta.is_key.should eq true
         end
         it "should have correct PropertyMetadata for Category.Name" do
           meta = subject['Name']
@@ -78,6 +80,7 @@ module OData
           meta.fc_target_path.should be_nil
           meta.fc_keep_in_content.should be_nil
           meta.nav_prop.should eq false
+          meta.is_key.should eq false
         end
         it "should have correct PropertyMetadata for Category.Products" do
           meta = subject['Products']
@@ -88,6 +91,7 @@ module OData
           meta.fc_keep_in_content.should be_nil
           meta.nav_prop.should eq true
           meta.association.should_not be_nil
+          meta.is_key.should eq false
         end
       end
     end
@@ -115,7 +119,7 @@ module OData
         subject['EntityCategoryWebGet'][:parameters].should be_nil
         subject['EntitySingleCategoryWebGet'][:parameters].should be_a Hash
         subject['EntitySingleCategoryWebGet'][:parameters]['id'].should eq 'Edm.Int32'
-      end     
+      end
       context "after parsing function imports" do
         subject { @cat_prod_service }
         it { should respond_to :CleanDatabaseForTesting }
@@ -152,10 +156,10 @@ module OData
         subject { @cat_prod_service }
         before(:each) do
           stub_request(:post, "http://test.com/test.svc/CleanDatabaseForTesting").to_return(:status => 204)
-          
+
           stub_request(:get, "http://test.com/test.svc/EntityCategoryWebGet").
           to_return(:status => 200, :body => File.new(File.expand_path("../fixtures/sample_service/result_entity_category_web_get.xml", __FILE__)), :headers => {})
-          
+
           stub_request(:get, "http://test.com/test.svc/EntitySingleCategoryWebGet?id=1").
           to_return(:status => 200, :body => File.new(File.expand_path("../fixtures/sample_service/result_entity_single_category_web_get.xml", __FILE__)), :headers => {})
 
@@ -194,4 +198,89 @@ module OData
       end
     end
   end
+
+  describe Service do
+    describe "Collection with an int64 key Named 'id'" do
+
+      before(:all) do
+        stub_request(:get, "http://test.com/test.svc/$metadata").
+          with(:headers => {'Accept'=>'*/*; q=0.5, application/xml', 'Accept-Encoding'=>'gzip, deflate'}).
+          to_return(:status => 200, :body => File.new(File.expand_path("../fixtures/int64_ids/edmx_car_service.xml", __FILE__)), :headers => {})
+        @svc = OData::Service.new "http://test.com/test.svc/"
+      end
+
+      context "has the correct metadata" do
+        before(:all) do
+          @id_meta = @svc.class_metadata['Car']['id']
+        end
+
+        subject { @id_meta }
+
+        its(:name)                { should eq('id') }
+        its(:type)                { should eq('Edm.Int64') }
+        its(:nullable)            { should be_false }
+        its(:fc_target_path)      { should be_nil }
+        its(:fc_keep_in_content)  { should be_nil }
+      end
+
+      context "can parse Id correctly" do
+        before(:each) do
+          stub_request(:get, "http://test.com/test.svc/Cars(213L)").
+            with(:headers => {'Accept'=>'*/*; q=0.5, application/xml', 'Accept-Encoding'=>'gzip, deflate'}).
+            to_return(:status => 200, :body => File.new(File.expand_path("../fixtures/int64_ids/result_cars.xml", __FILE__)), :headers => {})
+
+          @svc.Cars(213)
+          results = @svc.execute
+          @car = results.first
+        end
+
+        subject { @car }
+
+        its(:id)      { should eq(213) }
+        its(:color)   { should eq('peach') }
+      end
+    end
+
+    describe "Collection with an int64 key named 'KeyId'" do
+
+      before(:all) do
+        stub_request(:get, "http://test.com/test.svc/$metadata").
+          with(:headers => {'Accept'=>'*/*; q=0.5, application/xml', 'Accept-Encoding'=>'gzip, deflate'}).
+          to_return(:status => 200, :body => File.new(File.expand_path("../fixtures/int64_ids/edmx_boat_service.xml", __FILE__)), :headers => {})
+        @svc = OData::Service.new "http://test.com/test.svc/"
+      end
+
+      context "has the correct metadata" do
+        before(:all) do
+          @id_meta = @svc.class_metadata['Boat']['KeyId']
+        end
+
+        subject { @id_meta }
+
+        its(:name)                { should eq('KeyId') }
+        its(:type)                { should eq('Edm.Int64') }
+        its(:nullable)            { should be_false }
+        its(:fc_target_path)      { should be_nil }
+        its(:fc_keep_in_content)  { should be_nil }
+      end
+
+      context "can parse Id correctly" do
+        before(:each) do
+          stub_request(:get, "http://test.com/test.svc/Boats(213L)").
+            with(:headers => {'Accept'=>'*/*; q=0.5, application/xml', 'Accept-Encoding'=>'gzip, deflate'}).
+            to_return(:status => 200, :body => File.new(File.expand_path("../fixtures/int64_ids/result_boats.xml", __FILE__)), :headers => {})
+
+          @svc.Boats(213)
+          results = @svc.execute
+          @boat = results.first
+        end
+
+        subject { @boat }
+
+        its(:id)      { should eq(213) }
+        its(:color)   { should eq('blue') }
+      end
+    end
+
+  end
 end

data/spec/service_spec.rb

@@ -770,7 +770,7 @@ module OData
         svc.VirtualMachines
         results = svc.execute
         @json = results.first.as_json
-      end      
+      end
 
       it "Should quote Edm.Int64 properties" do
         @json["PerfDiskBytesWrite"].should be_a(String)
@@ -808,7 +808,7 @@ module OData
         to_return(:status => 200, :body => File.new(File.expand_path("../fixtures/ms_system_center/vm_templates.xml", __FILE__)), :headers => {})
 
       end
-      
+
       it "should successfully parse null valued string properties" do
         svc = OData::Service.new "http://test.com/test.svc/", { :username => "blabla", :password=> "", :verify_ssl => false, :namespace => "VMM" }
         svc.VirtualMachines
@@ -905,8 +905,85 @@ module OData
         products.first.Category.Products.first.ProductName.should eq "Chai"
       end
     end
-  end
 
+    describe "handling of custom select queries" do
+
+      context "when results are found" do
+        before(:each) do
+          stub_request(:get, "http://test.com/test.svc/$metadata").
+          with(:headers => {'Accept'=>'*/*; q=0.5, application/xml', 'Accept-Encoding'=>'gzip, deflate'}).
+          to_return(:status => 200, :body => File.new(File.expand_path("../fixtures/sample_service/edmx_categories_products.xml", __FILE__)), :headers => {})
+
+          stub_request(:get, "http://test.com/test.svc/Products?$select=Name,Price").
+          with(:headers => {'Accept'=>'*/*; q=0.5, application/xml', 'Accept-Encoding'=>'gzip, deflate'}).
+          to_return(:status => 200, :body => File.new(File.expand_path("../fixtures/sample_service/result_select_products_name_price.xml", __FILE__)), :headers => {})
+        end
+
+        subject do
+          svc = OData::Service.new "http://test.com/test.svc/"
+          svc.Products.select "Name", "Price"
+          svc.execute
+        end
+
+        it { should be_an Array }
+        it { should_not be_empty }
+        its(:first) { should be_a Product }
+      end
+
+      context "when there isn't a property by the name specified" do
+        before(:each) do
+          stub_request(:get, "http://test.com/test.svc/$metadata").
+          with(:headers => {'Accept'=>'*/*; q=0.5, application/xml', 'Accept-Encoding'=>'gzip, deflate'}).
+          to_return(:status => 200, :body => File.new(File.expand_path("../fixtures/sample_service/edmx_categories_products.xml", __FILE__)), :headers => {})
+
+          stub_request(:get, "http://test.com/test.svc/Categories?$select=Price").
+          with(:headers => {'Accept'=>'*/*; q=0.5, application/xml', 'Accept-Encoding'=>'gzip, deflate'}).
+          to_return(:status => 400, :body => File.new(File.expand_path("../fixtures/sample_service/result_select_categories_no_property.xml", __FILE__)), :headers => {})
+        end
+
+        it "raises an exception" do
+          svc = OData::Service.new "http://test.com/test.svc/"
+          svc.Categories.select "Price"
+          expect { svc.execute }.to raise_error(OData::ServiceError) { |error|
+            error.http_code.should eq 400
+            error.message.should eq "Type 'RubyODataService.Category' does not have a property named 'Price' or there is no type with 'Price' name."
+          }
+        end
+      end
+
+      context "when a property requires $expand to traverse" do
+        before(:each) do
+          stub_request(:get, "http://test.com/test.svc/$metadata").
+          with(:headers => {'Accept'=>'*/*; q=0.5, application/xml', 'Accept-Encoding'=>'gzip, deflate'}).
+          to_return(:status => 200, :body => File.new(File.expand_path("../fixtures/sample_service/edmx_categories_products.xml", __FILE__)), :headers => {})
+
+          stub_request(:get, "http://test.com/test.svc/Categories?$select=Name,Products/Name").
+          with(:headers => {'Accept'=>'*/*; q=0.5, application/xml', 'Accept-Encoding'=>'gzip, deflate'}).
+          to_return(:status => 400, :body => File.new(File.expand_path("../fixtures/sample_service/result_select_categories_travsing_no_expand.xml", __FILE__)), :headers => {})
+
+          stub_request(:get, "http://test.com/test.svc/Categories?$select=Name,Products/Name&$expand=Products").
+          with(:headers => {'Accept'=>'*/*; q=0.5, application/xml', 'Accept-Encoding'=>'gzip, deflate'}).
+          to_return(:status => 200, :body => File.new(File.expand_path("../fixtures/sample_service/result_select_categories_expand.xml", __FILE__)), :headers => {})
+        end
+
+        it "doesn't error" do
+          svc = OData::Service.new "http://test.com/test.svc/"
+          svc.Categories.select "Name", "Products/Name"
+          expect { svc.execute }.to_not raise_error(OData::ServiceError)
+        end
+
+        it "returns the classes with the properties filled in" do
+          svc = OData::Service.new "http://test.com/test.svc/"
+          svc.Categories.select "Name", "Products/Name"
+          results = svc.execute
+          category = results.first
+          category.Name.should eq "Category 0001"
+          product = category.Products.first
+          product.Name.should eq "Widget 0001"
+        end
+      end
+    end
+  end
   describe_private OData::Service do
     describe "parse value" do
       before(:each) do