safrano 0.2.0 → 0.3.0

data/lib/sequel_join_by_paths.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative './sequel/plugins/join_by_paths.rb'
+
+Sequel::Model.plugin Sequel::Plugins::JoinByPaths

data/lib/service.rb

@@ -9,14 +9,15 @@ module OData
   # this module has all methods related to expand/defered output preparation
   # and will be included in Service class
   module ExpandHandler
+    PATH_SPLITTER = %r{\A(\w+)\/?(.*)\z}.freeze
     def get_deferred_odata_h(entity:, attrib:, uribase:)
       { '__deferred' => { 'uri' => "#{entity.uri(uribase)}/#{attrib}" } }
     end
 
-    def handle_entity_expand_one(entity:, exp_one:, nav_values_h:, nav_coll_h:,
-                                 uribase:)
+    # split expand argument into first and rest part
+    def split_entity_expand_arg(exp_one)
       if exp_one.include?('/')
-        m = %r{\A(\w+)\/?(.*)\z}.match(exp_one)
+        m = PATH_SPLITTER.match(exp_one)
         cur_exp = m[1].strip
         rest_exp = m[2]
         # TODO: check errorhandling
@@ -27,17 +28,24 @@ module OData
         k = exp_one.strip.to_sym
         rest_exp = nil
       end
+      yield k, rest_exp
+    end
+
+    # handle a single expand
+    def handle_entity_expand_one(entity:, exp_one:, nav_values_h:, nav_coll_h:,
+                                 uribase:)
 
-      if (enval = entity.nav_values[k])
-        nav_values_h[k.to_s] = get_entity_odata_h(entity: enval,
-                                                  expand: rest_exp,
-                                                  uribase: uribase)
-      elsif (encoll = entity.nav_coll[k])
-        # nav attributes that are a collection (x..n)
-        nav_coll_h[k.to_s] = encoll.map do |xe|
-          if xe
-            get_entity_odata_h(entity: xe, expand: rest_exp,
-                               uribase: uribase)
+      split_entity_expand_arg(exp_one) do |first, rest_exp|
+        if (enval = entity.nav_values[first])
+          nav_values_h[first.to_s] = get_entity_odata_h(entity: enval,
+                                                        expand: rest_exp,
+                                                        uribase: uribase)
+        elsif (encoll = entity.nav_coll[first])
+          # nav attributes that are a collection (x..n)
+          nav_coll_h[first.to_s] = encoll.map do |xe|
+            if xe
+              get_entity_odata_h(entity: xe, expand: rest_exp, uribase: uribase)
+            end
           end
         end
       end
@@ -83,7 +91,9 @@ module OData
     def get_entity_odata_h(entity:, expand: nil, uribase:)
       hres = {}
       hres['__metadata'] = entity.metadata_h(uribase: uribase)
-      hres.merge!(entity.values)
+
+      #      hres.merge!(entity.values)
+      hres.merge!(entity.casted_values)
 
       nav_values_h = {}
       nav_coll_h = {}
@@ -97,7 +107,6 @@ module OData
       end
 
       # handle not expanded (deferred) nav attributes
-      # TODO: better design/perf
       handle_entity_deferred_attribs(entity: entity,
                                      nav_values_h: nav_values_h,
                                      nav_coll_h: nav_coll_h,
@@ -176,6 +185,8 @@ module OData
     end
 
     DATASERVICEVERSION_RGX = /\A([1234])(?:\.0);*\w*\z/.freeze
+    TRAILING_SLASH = %r{/\z}.freeze
+
     # input is the       DataServiceVersion request header string, eg.
     # '2.0;blabla' ---> Version -> 2
     def self.parse_data_service_version(inp)
@@ -213,7 +224,7 @@ module OData
     end
 
     def path_prefix(path_pr)
-      @xpath_prefix = path_pr.sub(%r{/\z}, '')
+      @xpath_prefix = path_pr.sub(TRAILING_SLASH, '')
     end
     # end public API
 
@@ -339,6 +350,51 @@ module OData
       XML_PREAMBLE + doc.to_pretty_xml
     end
 
+    def add_metadata_xml_entity_type(schema)
+      @collections.each do |klass|
+        enty = klass.add_metadata_rexml(schema)
+        klass.add_metadata_navs_rexml(enty, @cmap, @relman, @xnamespace)
+      end
+    end
+
+    def add_metadata_xml_associations(schema)
+      @relman.each_rel do |rel|
+        rel.with_metadata_info(@xnamespace) do |name, bdinfo|
+          assoc = schema.add_element('Association', 'Name' => name)
+          bdinfo.each do |bdi|
+            assoend = { 'Type' => bdi[:type],
+                        'Role' => bdi[:role],
+                        'Multiplicity' => bdi[:multiplicity] }
+            assoc.add_element('End', assoend)
+          end
+        end
+      end
+    end
+
+    def add_metadata_xml_entity_container(schema)
+      ec = schema.add_element('EntityContainer',
+                              'Name' => @xname,
+                              'm:IsDefaultEntityContainer' => 'true')
+      @collections.each do |klass|
+        # 3.a Entity set's
+        ec.add_element('EntitySet',
+                       'Name' => klass.entity_set_name,
+                       'EntityType' => "#{@xnamespace}.#{klass.type_name}")
+      end
+      # 3.b Association set's
+      @relman.each_rel do |rel|
+        assoc = ec.add_element('AssociationSet',
+                               'Name' => rel.name,
+                               'Association' => "#{@xnamespace}.#{rel.name}")
+
+        rel.each_endobj do |eo|
+          clazz = Object.const_get(eo)
+          assoend = { 'EntitySet' => clazz.entity_set_name.to_s, 'Role' => eo }
+          assoc.add_element('End', assoend)
+        end
+      end
+    end
+
     def metadata_xml(_req)
       doc = REXML::Document.new
       doc.add_element('edmx:Edmx', 'Version' => '1.0')
@@ -370,101 +426,21 @@ module OData
       schema = serv.add_element('Schema',
                                 'Namespace' => @xnamespace,
                                 'xmlns' => XMLNS::MSFT_ADO_2009_EDM)
-      @collections.each do |klass|
-        # 1. all EntityType
-        enty = schema.add_element('EntityType', 'Name' => klass.to_s)
-        # with their properties
-        klass.db_schema.each do |pnam, prop|
-          if prop[:primary_key] == true
-            enty.add_element('Key').add_element('PropertyRef',
-                                                'Name' => pnam.to_s)
-          end
-          #  attrs = {'Name'=>pnam.to_s,
-          #           'Type'=>OData::TypeMap[ prop[:db_type] ]}
-          attrs = { 'Name' => pnam.to_s,
-                    'Type' => OData.get_edm_type(db_type: prop[:db_type]) }
-          attrs['Nullable'] = 'false' if prop[:allow_null] == false
-          enty.add_element('Property', attrs)
-        end
-        # and their Nav attributes == Sequel Model association
-        klass.associations.each do |assoc|
-          # associated objects need to be in the map...
-          next unless @cmap[assoc.to_s]
-
-          from = klass.type_name
-          to = @cmap[assoc.to_s].type_name
-
-          rel = @relman.get([from, to])
-
-          # use Sequel reflection to get multiplicity (will be used later
-          # in 2. Associations below)
-          reflect = klass.association_reflection(assoc)
-          case reflect[:type]
-          # TODO: use multiplicity 1 when needed instead of '0..1'
-          when :one_to_one
-            rel.set_multiplicity(from, '0..1')
-            rel.set_multiplicity(to, '0..1')
-          when :one_to_many
-            rel.set_multiplicity(from, '0..1')
-            rel.set_multiplicity(to, '*')
-          when :many_to_one
-            rel.set_multiplicity(from, '*')
-            rel.set_multiplicity(to, '0..1')
-          when :many_to_many
-            rel.set_multiplicity(from, '*')
-            rel.set_multiplicity(to, '*')
-          end
-          # <NavigationProperty Name="Supplier"
-          # Relationship="ODataDemo.Product_Supplier_Supplier_Products"
-          #         FromRole="Product_Supplier" ToRole="Supplier_Products"/>
-
-          nattrs = { 'Name' => to,
-                     'Relationship' => "#{@xnamespace}.#{rel.name}",
-                     'FromRole' => from,
-                     'ToRole' => to }
-          enty.add_element('NavigationProperty', nattrs)
-        end
-      end
-      # 2. Associations
-      @relman.each_rel do |rel|
-        assoc = schema.add_element('Association', 'Name' => rel.name)
-
-        rel.each_endobj do |eo|
-          assoend = { 'Type' => "#{@xnamespace}.#{eo}",
-                      'Role' => eo,
-                      'Multiplicity' => rel.multiplicity[eo] }
+      # 1. all EntityType
+      add_metadata_xml_entity_type(schema)
 
-          assoc.add_element('End', assoend)
-        end
-      end
+      # 2. Associations
+      add_metadata_xml_associations(schema)
 
       # 3. Enty container
-      ec = schema.add_element('EntityContainer',
-                              'Name' => @xname,
-                              'm:IsDefaultEntityContainer' => 'true')
-      @collections.each do |klass|
-        # 3.a Entity set's
-        ec.add_element('EntitySet',
-                       'Name' => klass.entity_set_name,
-                       'EntityType' => "#{@xnamespace}.#{klass.type_name}")
-      end
-      # 3.b Association set's
-      @relman.each_rel do |rel|
-        assoc = ec.add_element('AssociationSet',
-                               'Name' => rel.name,
-                               'Association' => "#{@xnamespace}.#{rel.name}")
+      add_metadata_xml_entity_container(schema)
 
-        rel.each_endobj do |eo|
-          clazz = Object.const_get(eo)
-          assoend = { 'EntitySet' => clazz.entity_set_name.to_s, 'Role' => eo }
-          assoc.add_element('End', assoend)
-        end
-      end
       XML_PREAMBLE + doc.to_pretty_xml
     end
 
     # methods related to transitions to next state (cf. walker)
     module Transitions
+      DOLLAR_ID_REGEXP = Regexp.new('\A\/\$').freeze
       def allowed_transitions
         @allowed_transitions = [
           Safrano::TransitionEnd,
@@ -485,8 +461,7 @@ module OData
       end
 
       def transition_content_id(match_result)
-        # TODO: a nicer way of extracting the content-id number?
-        [match_result[1].sub!(Regexp.new('\A\/\$'), ''), :run_with_content_id]
+        [match_result[2], :run_with_content_id]
       end
 
       def transition_metadata(_match_result)
@@ -501,16 +476,14 @@ module OData
     include Transitions
 
     def odata_get(req)
-      if req.accept?('application/xml')
+      if req.accept?(APPXML)
         #  app.headers  'Content-Type' => 'application/xml;charset=utf-8'
         # Doc: 2.2.3.7.1 Service Document  As per [RFC5023], AtomPub Service
         # Documents MUST be
         # identified with the "application/atomsvc+xml" media type (see
         # [RFC5023] section 8).
-        [200, { 'Content-Type' => 'application/atomsvc+xml;charset=utf-8' },
-         service_xml(req)]
+        [200, CT_ATOMXML, service_xml(req)]
       else
-        # TODO: other formats ?
         # this is returned by http://services.odata.org/V2/OData/OData.svc
         415
       end
@@ -583,10 +556,9 @@ module OData
     end
 
     def odata_get(req)
-      if req.accept?('application/xml')
-        [200, { 'Content-Type' => 'application/xml;charset=utf-8' },
-         @service.metadata_xml(req)]
-      else # TODO: other formats
+      if req.accept?(APPXML)
+        [200, CT_APPXML, @service.metadata_xml(req)]
+      else
         415
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safrano
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - D.M.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-15 00:00:00.000000000 Z
+date: 2019-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -108,7 +108,13 @@ files:
 - lib/odata/collection_order.rb
 - lib/odata/entity.rb
 - lib/odata/error.rb
+- lib/odata/filter/error.rb
+- lib/odata/filter/parse.rb
+- lib/odata/filter/sequel.rb
+- lib/odata/filter/token.rb
+- lib/odata/filter/tree.rb
 - lib/odata/relations.rb
+- lib/odata/url_parameters.rb
 - lib/odata/walker.rb
 - lib/odata_rack_builder.rb
 - lib/rack_app.rb
@@ -116,6 +122,8 @@ files:
 - lib/response.rb
 - lib/safrano.rb
 - lib/safrano_core.rb
+- lib/sequel/plugins/join_by_paths.rb
+- lib/sequel_join_by_paths.rb
 - lib/service.rb
 homepage: https://gitlab.com/dm0da/safrano
 licenses:
@@ -133,7 +141,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="