frodata 0.9.1

data/lib/frodata/service/response.rb

@@ -0,0 +1,162 @@
+require 'frodata/service/response/atom'
+require 'frodata/service/response/json'
+require 'frodata/service/response/plain'
+require 'frodata/service/response/xml'
+
+module FrOData
+  class Service
+    # The result of executing a FrOData::Service::Request.
+    class Response
+      include Enumerable
+
+      # The service that generated this response
+      attr_reader :service
+      # The underlying (raw) response
+      attr_reader :response
+      # The query that generated the response (optional)
+      attr_reader :query
+
+      # Create a new response given a service and a raw response.
+      # @param service [FrOData::Service] The executing service.
+      # @param query [FrOData::Query] The related query (optional).
+      # @param
+      def initialize(service, query = nil, &block)
+        @service  = service
+        @query    = query
+        @timed_out = false
+        execute(&block)
+      end
+
+      # Returns the HTTP status code.
+      def status
+        response.status
+      end
+
+      # Whether the request was successful.
+      def success?
+        200 <= status && status < 300
+      end
+
+      # Returns the content type of the resonse.
+      def content_type
+        response.headers['Content-Type'] || ''
+      end
+
+      def is_atom?
+        content_type =~ /#{Regexp.escape FrOData::Service::MIME_TYPES[:atom]}/
+      end
+
+      def is_json?
+        content_type =~ /#{Regexp.escape FrOData::Service::MIME_TYPES[:json]}/
+      end
+
+      def is_plain?
+        content_type =~ /#{Regexp.escape FrOData::Service::MIME_TYPES[:plain]}/
+      end
+
+      def is_xml?
+        content_type =~ /#{Regexp.escape FrOData::Service::MIME_TYPES[:xml]}/
+      end
+
+      # Whether the response contained any entities.
+      # @return [Boolean]
+      def empty?
+        @empty ||= find_entities.empty?
+      end
+
+      # Whether the response failed due to a timeout
+      def timed_out?
+        @timed_out
+      end
+
+      # Iterates over all entities in the response, using
+      # automatic paging if necessary.
+      # Provided for Enumerable functionality.
+      # @param block [block] a block to evaluate
+      # @return [FrOData::Entity] each entity in turn for the query result
+      def each(&block)
+        unless empty?
+          process_results(&block)
+          unless next_page.nil?
+            # ensure request gets executed with the same options
+            query.execute(URI.decode next_page_url).each(&block)
+          end
+        end
+      end
+
+      # Returns the response body.
+      def body
+        response.body
+      end
+
+      # Validates the response. Throws an exception with
+      # an appropriate message if a 4xx or 5xx status code
+      # occured.
+      #
+      # @return [self]
+      def validate_response!
+        if error = FrOData::Errors::ERROR_MAP[status]
+          raise error, response, error_message
+        end
+      end
+
+      private
+
+      def execute(&block)
+        @response = block.call
+        logger.debug <<-EOS
+          [FrOData: #{service.name}] Received response:
+            Headers: #{response.headers}
+            Body: #{response.body}
+        EOS
+        check_content_type
+        validate_response!
+      rescue Faraday::TimeoutError
+        logger.info "Request timed out."
+        @timed_out = true
+      end
+
+      def logger
+        service.logger
+      end
+
+      def check_content_type
+        # Dynamically extend instance with methods for
+        # processing the current result type
+        if is_atom?
+          extend FrOData::Service::Response::Atom
+        elsif is_json?
+          extend FrOData::Service::Response::JSON
+        elsif is_xml?
+          extend FrOData::Service::Response::XML
+        elsif is_plain?
+          extend FrOData::Service::Response::Plain
+        elsif response.body.empty?
+          # Some services (*cough* Microsoft *cough*) return
+          # an empty response with no `Content-Type` header set.
+          # We catch that here and bypass content type detection.
+          @empty = true
+        else
+          raise RequestError, response, "Invalid response type '#{content_type}'"
+        end
+      end
+
+      def entity_options
+        if query
+          query.entity_set.entity_options
+        else
+          {
+            service_name: service.name,
+          }
+        end
+      end
+
+      def process_results(&block)
+        find_entities.each do |entity_data|
+          entity = parse_entity(entity_data, entity_options)
+          block_given? ? block.call(entity) : yield(entity)
+        end
+      end
+    end
+  end
+end

data/lib/frodata/service/response/atom.rb

@@ -0,0 +1,40 @@
+module FrOData
+  class Service
+    class Response
+      module Atom
+        def parse_entity(entity_xml, entity_options)
+          FrOData::Entity.from_xml(entity_xml, entity_options)
+        end
+
+        def next_page
+          result_xml.xpath("/feed/link[@rel='next']").first
+        end
+
+        def next_page_url
+          next_page.attributes['href'].value.gsub(service.service_url, '')
+        end
+
+        def error_message
+          result_xml.xpath('//error/message').first.andand.text
+        end
+
+        def parsed_body
+          result_xml
+        end
+
+        private
+
+        def result_xml
+          @result_xml ||= ::Nokogiri::XML(response.body).remove_namespaces!
+        end
+
+        # Find entity entries in a result set
+        #
+        # @return [Nokogiri::XML::NodeSet]
+        def find_entities
+          result_xml.xpath('//entry')
+        end
+      end
+    end
+  end
+end

data/lib/frodata/service/response/json.rb

@@ -0,0 +1,41 @@
+module FrOData
+  class Service
+    class Response
+      module JSON
+        def parse_entity(entity_json, entity_options)
+          FrOData::Entity.from_json(entity_json, entity_options)
+        end
+
+        def next_page
+          result_json['@odata.nextLink']
+        end
+
+        def next_page_url
+          next_page.gsub(service.service_url, '')
+        end
+
+        def error_message
+          result_json['error'].andand['message']
+        end
+
+        def parsed_body
+          result_json
+        end
+
+        private
+
+        def result_json
+          @result_json ||= ::JSON.parse(response.body)
+        end
+
+        def single_entity?
+          result_json['@odata.context'] =~ /\$entity$/
+        end
+
+        def find_entities
+          single_entity? ? [result_json] : result_json['value']
+        end
+      end
+    end
+  end
+end

data/lib/frodata/service/response/plain.rb

@@ -0,0 +1,36 @@
+module FrOData
+  class Service
+    class Response
+      module Plain
+        def parse_entity(entity_data, entity_options)
+          raise NotImplementedError, 'Not Available'
+        end
+
+        def next_page
+          raise NotImplementedError, 'Not available'
+        end
+
+        def next_page_url
+          raise NotImplementedError, 'Not available'
+        end
+
+        def error_message
+          response.body
+        end
+
+        def parsed_body
+          response.body
+        end
+
+        private
+
+        # Find entity entries in a response set
+        #
+        # @return [Array]
+        def find_entities
+          []
+        end
+      end
+    end
+  end
+end

data/lib/frodata/service/response/xml.rb

@@ -0,0 +1,40 @@
+module FrOData
+  class Service
+    class Response
+      module XML
+        def parse_entity(entity_data, entity_options)
+          raise NotImplementedError, 'Not Available'
+        end
+
+        def next_page
+          raise NotImplementedError, 'Not Available'
+        end
+
+        def next_page_url
+          raise NotImplementedError, 'Not Available'
+        end
+
+        def error_message
+          response_xml.xpath('//error/message').first.andand.text
+        end
+
+        def parsed_body
+          response_xml
+        end
+
+        private
+
+        def response_xml
+          @response_xml ||= ::Nokogiri::XML(response.body).remove_namespaces!
+        end
+
+        # Find entity entries in a response set
+        #
+        # @return [Array]
+        def find_entities
+          []
+        end
+      end
+    end
+  end
+end

data/lib/frodata/service_registry.rb

@@ -0,0 +1,52 @@
+require 'singleton'
+
+module FrOData
+  # Provides a registry for keeping track of multiple FrOData::Service instances
+  class ServiceRegistry
+    include Singleton
+
+    # Add a service to the Registry
+    #
+    # @param service [FrOData::Service] service to add to the registry
+    def add(service)
+      initialize_instance_variables
+      @services << service if service.is_a?(FrOData::Service) && !@services.include?(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 name
+    #
+    # @param lookup_key [String] the URL or name to lookup
+    # @return [FrOData::Service, nil] the FrOData::Service or nil
+    def [](lookup_key)
+      initialize_instance_variables
+      index = @services_by_name[lookup_key] || @services_by_url[lookup_key]
+      index.nil? ? nil : @services[index]
+    end
+
+    # (see #add)
+    def self.add(service)
+      FrOData::ServiceRegistry.instance.add(service)
+    end
+
+    # (see #[])
+    def self.[](lookup_key)
+      FrOData::ServiceRegistry.instance[lookup_key]
+    end
+
+    private
+
+    def initialize_instance_variables
+      @services ||= []
+      @services_by_name ||= {}
+      @services_by_url ||= {}
+    end
+
+    def flush
+      @services = []
+      @services_by_name = {}
+      @services_by_url = {}
+    end
+  end
+end

data/lib/frodata/version.rb

@@ -0,0 +1,3 @@
+module FrOData
+  VERSION = '0.9.1'
+end

data/spec/fixtures/files/entity_to_xml.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<entry xmlns="http://www.w3.org/2005/Atom" xmlns:data="http://docs.oasis-open.org/odata/ns/data" xmlns:metadata="http://docs.oasis-open.org/odata/ns/metadata" xmlns:georss="http://www.georss.org/georss" xmlns:gml="http://www.opengis.net/gml" xml:base="http://services.odata.org/V4/OData/OData.svc">
+  <category term="ODataDemo.Product" scheme="http://docs.oasis-open.org/odata/ns/scheme"/>
+  <author>
+    <name/>
+  </author>
+  <content type="application/xml">
+    <metadata:properties>
+      <data:Name metadata:type="Edm.String">Bread</data:Name>
+      <data:Description metadata:type="Edm.String">Whole grain bread</data:Description>
+      <data:ReleaseDate metadata:type="Edm.DateTimeOffset">1992-01-01T00:00:00Z</data:ReleaseDate>
+      <data:DiscontinuedDate metadata:type="Edm.DateTimeOffset" metadata:null="true"/>
+      <data:Rating metadata:type="Edm.Int16">4</data:Rating>
+      <data:Price metadata:type="Edm.Double">2.5</data:Price>
+    </metadata:properties>
+  </content>
+</entry>

data/spec/fixtures/files/error.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<m:error xmlns:m="http://docs.oasis-open.org/odata/ns/metadata">
+    <m:code />
+    <m:message>Resource not found for the segment 'Products'.</m:message>
+</m:error>

data/spec/fixtures/files/metadata.xml

@@ -0,0 +1,150 @@
+<?xml version="1.0" encoding="utf-8"?>
+<edmx:Edmx Version="4.0" xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx">
+  <edmx:DataServices>
+    <Schema Namespace="ODataDemo" xmlns="http://docs.oasis-open.org/odata/ns/edm">
+      <EntityType Name="Product">
+        <Key>
+          <PropertyRef Name="ID" />
+        </Key>
+        <Property Name="ID" Type="Edm.Int32" Nullable="false" />
+        <Property Name="Name" Type="Edm.String" />
+        <Property Name="Description" Type="Edm.String" />
+        <Property Name="ReleaseDate" Type="Edm.DateTimeOffset" Nullable="false" />
+        <Property Name="DiscontinuedDate" Type="Edm.DateTimeOffset" />
+        <Property Name="Rating" Type="Edm.Int16" Nullable="false" />
+        <Property Name="Price" Type="Edm.Double" Nullable="false" />
+        <Property Name="ProductStatus" Type="ODataDemo.ProductStatus" Nullable="false" />
+        <NavigationProperty Name="Categories" Type="Collection(ODataDemo.Category)" Partner="Products" />
+        <NavigationProperty Name="Supplier" Type="ODataDemo.Supplier" Partner="Products" />
+        <NavigationProperty Name="ProductDetail" Type="ODataDemo.ProductDetail" Partner="Product" />
+      </EntityType>
+      <EnumType Name="ProductStatus" UnderlyingType="Edm.Byte">
+        <Member Name="Available" />
+        <Member Name="LowStock" />
+        <Member Name="Backordered" />
+        <Member Name="Discontinued" />
+      </EnumType>
+      <EntityType Name="FeaturedProduct" BaseType="ODataDemo.Product">
+        <NavigationProperty Name="Advertisement" Type="ODataDemo.Advertisement" Partner="FeaturedProduct" />
+      </EntityType>
+      <EntityType Name="ProductDetail">
+        <Key>
+          <PropertyRef Name="ProductID" />
+        </Key>
+        <Property Name="ProductID" Type="Edm.Int32" Nullable="false" />
+        <Property Name="Details" Type="Edm.String" />
+        <NavigationProperty Name="Product" Type="ODataDemo.Product" Partner="ProductDetail" />
+      </EntityType>
+      <EntityType Name="Category" OpenType="true">
+        <Key>
+          <PropertyRef Name="ID" />
+        </Key>
+        <Property Name="ID" Type="Edm.Int32" Nullable="false" />
+        <Property Name="Name" Type="Edm.String" />
+        <NavigationProperty Name="Products" Type="Collection(ODataDemo.Product)" Partner="Categories" />
+      </EntityType>
+      <EntityType Name="Supplier">
+        <Key>
+          <PropertyRef Name="ID" />
+        </Key>
+        <Property Name="ID" Type="Edm.Int32" Nullable="false" />
+        <Property Name="Name" Type="Edm.String" />
+        <Property Name="Address" Type="ODataDemo.Address" />
+        <Property Name="Location" Type="Edm.GeographyPoint" SRID="Variable" />
+        <Property Name="Concurrency" Type="Edm.Int32" ConcurrencyMode="Fixed" Nullable="false" />
+        <NavigationProperty Name="Products" Type="Collection(ODataDemo.Product)" Partner="Supplier" />
+      </EntityType>
+      <ComplexType Name="Address">
+        <Property Name="Street" Type="Edm.String" />
+        <Property Name="City" Type="Edm.String" />
+        <Property Name="State" Type="Edm.String" />
+        <Property Name="ZipCode" Type="Edm.String" />
+        <Property Name="Country" Type="Edm.String" />
+      </ComplexType>
+      <EntityType Name="Person">
+        <Key>
+          <PropertyRef Name="ID" />
+        </Key>
+        <Property Name="ID" Type="Edm.Int32" Nullable="false" />
+        <Property Name="Name" Type="Edm.String" />
+        <NavigationProperty Name="PersonDetail" Type="ODataDemo.PersonDetail" Partner="Person" />
+      </EntityType>
+      <EntityType Name="Customer" BaseType="ODataDemo.Person">
+        <Property Name="TotalExpense" Type="Edm.Decimal" Nullable="false" />
+      </EntityType>
+      <EntityType Name="Employee" BaseType="ODataDemo.Person">
+        <Property Name="EmployeeID" Type="Edm.Int64" Nullable="false" />
+        <Property Name="HireDate" Type="Edm.DateTimeOffset" Nullable="false" />
+        <Property Name="Salary" Type="Edm.Single" Nullable="false" />
+      </EntityType>
+      <EntityType Name="PersonDetail">
+        <Key>
+          <PropertyRef Name="PersonID" />
+        </Key>
+        <Property Name="PersonID" Type="Edm.Int32" Nullable="false" />
+        <Property Name="Age" Type="Edm.Byte" Nullable="false" />
+        <Property Name="Gender" Type="Edm.Boolean" Nullable="false" />
+        <Property Name="Phone" Type="Edm.String" />
+        <Property Name="Address" Type="ODataDemo.Address" />
+        <Property Name="Photo" Type="Edm.Stream" Nullable="false" />
+        <NavigationProperty Name="Person" Type="ODataDemo.Person" Partner="PersonDetail" />
+      </EntityType>
+      <EntityType Name="Advertisement" HasStream="true">
+        <Key>
+          <PropertyRef Name="ID" />
+        </Key>
+        <Property Name="ID" Type="Edm.Guid" Nullable="false" />
+        <Property Name="Name" Type="Edm.String" />
+        <Property Name="AirDate" Type="Edm.DateTimeOffset" Nullable="false" />
+        <NavigationProperty Name="FeaturedProduct" Type="ODataDemo.FeaturedProduct" Partner="Advertisement" />
+      </EntityType>
+      <EntityContainer Name="DemoService">
+        <EntitySet Name="Products" EntityType="ODataDemo.Product">
+          <NavigationPropertyBinding Path="ODataDemo.FeaturedProduct/Advertisement" Target="Advertisements" />
+          <NavigationPropertyBinding Path="Categories" Target="Categories" />
+          <NavigationPropertyBinding Path="Supplier" Target="Suppliers" />
+          <NavigationPropertyBinding Path="ProductDetail" Target="ProductDetails" />
+        </EntitySet>
+        <EntitySet Name="ProductDetails" EntityType="ODataDemo.ProductDetail">
+          <NavigationPropertyBinding Path="Product" Target="Products" />
+        </EntitySet>
+        <EntitySet Name="Categories" EntityType="ODataDemo.Category">
+          <NavigationPropertyBinding Path="Products" Target="Products" />
+        </EntitySet>
+        <EntitySet Name="Suppliers" EntityType="ODataDemo.Supplier">
+          <NavigationPropertyBinding Path="Products" Target="Products" />
+        </EntitySet>
+        <EntitySet Name="Persons" EntityType="ODataDemo.Person">
+          <NavigationPropertyBinding Path="PersonDetail" Target="PersonDetails" />
+        </EntitySet>
+        <EntitySet Name="PersonDetails" EntityType="ODataDemo.PersonDetail">
+          <NavigationPropertyBinding Path="Person" Target="Persons" />
+        </EntitySet>
+        <EntitySet Name="Advertisements" EntityType="ODataDemo.Advertisement">
+          <NavigationPropertyBinding Path="FeaturedProduct" Target="Products" />
+        </EntitySet>
+      </EntityContainer>
+      <Annotations Target="ODataDemo.DemoService">
+        <Annotation Term="Org.OData.Display.V1.Description" String="This is a sample OData service with vocabularies" />
+      </Annotations>
+      <Annotations Target="ODataDemo.Product">
+        <Annotation Term="Org.OData.Display.V1.Description" String="All Products available in the online store" />
+      </Annotations>
+      <Annotations Target="ODataDemo.Product/Name">
+        <Annotation Term="Org.OData.Display.V1.DisplayName" String="Product Name" />
+      </Annotations>
+      <Annotations Target="ODataDemo.DemoService/Suppliers">
+        <Annotation Term="Org.OData.Publication.V1.PublisherName" String="Microsoft Corp." />
+        <Annotation Term="Org.OData.Publication.V1.PublisherId" String="MSFT" />
+        <Annotation Term="Org.OData.Publication.V1.Keywords" String="Inventory, Supplier, Advertisers, Sales, Finance" />
+        <Annotation Term="Org.OData.Publication.V1.AttributionUrl" String="http://www.odata.org/" />
+        <Annotation Term="Org.OData.Publication.V1.AttributionDescription" String="All rights reserved" />
+        <Annotation Term="Org.OData.Publication.V1.DocumentationUrl " String="http://www.odata.org/" />
+        <Annotation Term="Org.OData.Publication.V1.TermsOfUseUrl" String="All rights reserved" />
+        <Annotation Term="Org.OData.Publication.V1.PrivacyPolicyUrl" String="http://www.odata.org/" />
+        <Annotation Term="Org.OData.Publication.V1.LastModified" String="4/2/2013" />
+        <Annotation Term="Org.OData.Publication.V1.ImageUrl " String="http://www.odata.org/" />
+      </Annotations>
+    </Schema>
+  </edmx:DataServices>
+</edmx:Edmx>