odata4 0.7.0

data/lib/odata4/properties/binary.rb

@@ -0,0 +1,50 @@
+module OData4
+  module Properties
+    # Defines the Binary OData4 type.
+    class Binary < OData4::Property
+      # Returns the property value, properly typecast
+      # @return [Integer,nil]
+      def value
+        if (@value.nil? || @value.empty?) && allows_nil?
+          nil
+        else
+          @value.to_i
+        end
+      end
+
+      # Sets the property value
+      # @params new_value [0,1,Boolean]
+      def value=(new_value)
+        validate(new_value)
+        @value = parse_value(new_value)
+      end
+
+      # The OData4 type name
+      def type
+        'Edm.Binary'
+      end
+
+      # Value to be used in URLs.
+      # @return [String]
+      def url_value
+        "binary'#{value}'"
+      end
+
+      private
+
+      def parse_value(value)
+        if value == 0 || value == '0' || value == false
+          '0'
+        else
+          '1'
+        end
+      end
+
+      def validate(value)
+        unless [0,1,'0','1',true,false].include?(value)
+          raise ArgumentError, 'Value is outside accepted range: 0 or 1'
+        end
+      end
+    end
+  end
+end

data/lib/odata4/properties/boolean.rb

@@ -0,0 +1,37 @@
+module OData4
+  module Properties
+    # Defines the Boolean OData4 type.
+    class Boolean < OData4::Property
+      # Returns the property value, properly typecast
+      # @return [Boolean, nil]
+      def value
+        if (@value.nil? || @value.empty?) && allows_nil?
+          nil
+        else
+          (@value == 'true' || @value == '1')
+        end
+      end
+
+      # Sets the property value
+      # @params new_value [Boolean]
+      def value=(new_value)
+        validate(new_value)
+        @value = new_value.to_s
+      end
+
+      # The OData4 type name
+      def type
+        'Edm.Boolean'
+      end
+
+      private
+
+      def validate(value)
+        return if value.nil? && allows_nil?
+        unless [0,1,'0','1','true','false',true,false].include?(value)
+          raise ArgumentError, 'Value is outside accepted range: true or false'
+        end
+      end
+    end
+  end
+end

data/lib/odata4/properties/date.rb

@@ -0,0 +1,27 @@
+require 'odata4/properties/date_time'
+
+module OData4
+  module Properties
+    # Defines the Date OData4 type.
+    class Date < OData4::Properties::DateTime
+      # The OData4 type name
+      def type
+        'Edm.Date'
+      end
+
+      def url_value
+        @value
+      end
+
+      protected
+
+      def date_class
+        ::Date
+      end
+
+      def strptime_format
+        '%Y-%m-%d'
+      end
+    end
+  end
+end

data/lib/odata4/properties/date_time.rb

@@ -0,0 +1,83 @@
+module OData4
+  module Properties
+    # Defines the DateTime OData4 type.
+    class DateTime < OData4::Property
+      # Returns the property value, properly typecast
+      # @return [DateTime, nil]
+      def value
+        if (@value.nil? || @value.empty?) && allows_nil?
+          nil
+        else
+          begin
+            date_class.strptime(@value, strptime_format)
+          rescue ArgumentError
+            date_class.parse(@value)
+          end
+        end
+      end
+
+      # Sets the property value
+      # @params new_value [DateTime]
+      def value=(new_value)
+        validate(new_value)
+        @value = parse_value(new_value)
+      end
+
+      # The OData4 type name
+      def type
+        'Edm.DateTime'
+      end
+
+      # Value to be used in JSON.
+      # @return [String]
+      def xml_value
+        @value.andand.sub(/[\+\-]00:00$/, 'Z')
+      end
+
+      # Value to be used in JSON.
+      # @return [String]
+      def json_value
+        xml_value
+      end
+
+      # Value to be used in URLs.
+      # @return [String]
+      def url_value
+        xml_value
+      end
+
+      protected
+
+      # Specifies date/time implementation to use
+      def date_class
+        ::DateTime
+      end
+
+      # Specifies the date/time format string used for `strptime`
+      def strptime_format
+        #'%Y-%m-%dT%H:%M:%S.%L'
+        "%Y-%m-%dT%H:%M:%SZ"
+      end
+
+      def validate(value)
+        begin
+          return if value.nil? && allows_nil?
+          return if value.is_a?(date_class)
+          date_class.parse(value)
+        rescue
+          raise ArgumentError, "Value '#{value}' is not a date time format that can be parsed"
+        end
+      end
+
+      def parse_value(value)
+        return value if value.nil? && allows_nil?
+        if value.is_a?(date_class)
+          parsed_value = value
+        else
+          parsed_value = date_class.parse(value)
+        end
+        parsed_value.strftime(strptime_format)
+      end
+    end
+  end
+end

data/lib/odata4/properties/date_time_offset.rb

@@ -0,0 +1,17 @@
+module OData4
+  module Properties
+    # Defines the DateTimeOffset OData4 type.
+    class DateTimeOffset < OData4::Properties::DateTime
+      # The OData4 type name
+      def type
+        'Edm.DateTimeOffset'
+      end
+
+      protected
+
+      def strptime_format
+        '%Y-%m-%dT%H:%M:%S%:z'
+      end
+    end
+  end
+end

data/lib/odata4/properties/decimal.rb

@@ -0,0 +1,50 @@
+module OData4
+  module Properties
+    # Defines the Decimal OData4 type.
+    class Decimal < OData4::Property
+      # Returns the property value, properly typecast
+      # @return [BigDecimal,nil]
+      def value
+        if (@value.nil? || @value.empty?) && (strict? && allows_nil?)
+          nil
+        else
+          BigDecimal(@value)
+        end
+      end
+
+      # Sets the property value
+      # @params new_value something BigDecimal() can parse
+      def value=(new_value)
+        validate(BigDecimal(new_value.to_s))
+        @value = new_value.to_s
+      end
+
+      # The OData4 type name
+      def type
+        'Edm.Decimal'
+      end
+
+      # Value to be used in URLs.
+      # @return [String]
+      def url_value
+        "#{value.to_f}M"
+      end
+
+      private
+
+      def validate(value)
+        if value > max_value || value < min_value || value.precs.first > 29
+          raise ArgumentError, "Value is outside accepted range: #{min_value} to #{max_value}, or has more than 29 significant digits"
+        end
+      end
+
+      def min_value
+        @min ||= BigDecimal(-7.9 * (10**28), 2)
+      end
+
+      def max_value
+        @max ||= BigDecimal(7.9 * (10**28), 2)
+      end
+    end
+  end
+end

data/lib/odata4/properties/float.rb

@@ -0,0 +1,67 @@
+module OData4
+  module Properties
+    # Defines the Float OData4 type.
+    class Float < OData4::Property
+      include OData4::Properties::Number
+
+      # Returns the property value, properly typecast
+      # @return [Float,nil]
+      def value
+        if (@value.nil? || @value.empty?) && allows_nil?
+          nil
+        else
+          @value.to_f
+        end
+      end
+
+      # Sets the property value
+      # @params new_value [to_f]
+      def value=(new_value)
+        validate(new_value.to_f)
+        @value = new_value.to_f.to_s
+      end
+
+      # The OData4 type name
+      def type
+        'Edm.Double'
+      end
+
+      private
+
+      def min_value
+        @min ||= -(1.7 * (10**308))
+      end
+
+      def max_value
+        @max ||= (1.7 * (10**308))
+      end
+    end
+
+    # Defines the Double (Float) OData4 type.
+    class Double < OData4::Properties::Float; end
+
+    # Defines the Single (Float) OData4 type.
+    class Single < OData4::Properties::Float
+      # The OData4 type name
+      def type
+        'Edm.Single'
+      end
+
+      # Value to be used in URLs.
+      # @return [String]
+      def url_value
+        "#{value}F"
+      end
+
+      private
+
+      def min_value
+        @min ||= -(3.4 * (10**38))
+      end
+
+      def max_value
+        @max ||= (3.4 * (10**38))
+      end
+    end
+  end
+end

data/lib/odata4/properties/geography.rb

@@ -0,0 +1,13 @@
+require 'odata4/properties/geography/base'
+require 'odata4/properties/geography/point'
+require 'odata4/properties/geography/line_string'
+require 'odata4/properties/geography/polygon'
+
+OData4::Properties::Geography.constants.each do |property_name|
+  next if property_name =~ /Base$/
+  klass = OData4::Properties::Geography.const_get(property_name)
+  if klass.is_a?(Class)
+    property = klass.new('test', nil)
+    OData4::PropertyRegistry.add(property.type, property.class)
+  end
+end

data/lib/odata4/properties/geography/base.rb

@@ -0,0 +1,162 @@
+module OData4
+  module Properties
+    module Geography
+      class Base < OData4::Property
+        # The SRID (Spatial Reference ID) of this property.
+        attr_accessor :srid
+
+        # The default SRID (same as used by GPS)
+        DEFAULT_SRID = 4326
+
+        # Initializes a geography property.
+        #
+        # Special options available for geographic types:
+        #
+        # +srid+: the SRID (spatial reference ID) of the
+        #         coordinate system being used.
+        #         Defaults to 4326 (same as GPS).
+        #
+        # @param name [to_s]
+        # @param value [Hash|Array|to_s|nil]
+        # @param options [Hash]
+        def initialize(name, value, options = {})
+          super(name, value, options)
+          self.value = value
+          self.srid  = srid || options[:srid] || DEFAULT_SRID
+        end
+
+        # Sets the value of the property.
+        # @param value [Hash|Array|to_s|nil]
+        def value=(value)
+          if value.nil? && allows_nil?
+            @value = nil
+          elsif value.is_a?(Hash)
+            @value = value['coordinates']
+          elsif value.is_a?(Array)
+            @value = value
+          else
+            @value = parse_wkt(value.to_s)
+          end
+        end
+
+        # Value to be used in URLs.
+        # @return [String]
+        def url_value
+          "geography'SRID=#{srid};#{type_name}(#{coords_to_s})'"
+        end
+
+        # Value to be used in JSON.
+        # @return [Hash]
+        def json_value
+          {
+            type: type_name,
+            coordinates: value,
+            crs: crs
+          }
+        end
+
+        # The name of the SRS (Spatial Reference System) used.
+        # Basically, the SRID in URI/URL form.
+        # @return [String]
+        def srs_name
+          if srid == DEFAULT_SRID
+            "http://www.opengis.net/def/crs/EPSG/0/#{srid}"
+          else
+            raise NotImplementedError, "Unsupported SRID #{srid}"
+          end
+        end
+
+        # The name of the CRS (Coordinate Reference System) used.
+        # Used in GeoJSON representation
+        # @return [String]
+        def crs_name
+          if srid == DEFAULT_SRID
+            "EPSG:#{srid}"
+          else
+            raise NotImplementedError, "Unsupported SRID #{srid}"
+          end
+        end
+
+        # The full CRS representation as used by GeoJSON
+        # @return [Hash]
+        def crs
+          {
+            type: 'name',
+            properties: { name: crs_name }
+          }
+        end
+
+        # Returns the XML representation of the property to the supplied XML
+        # builder.
+        # @param xml_builder [Nokogiri::XML::Builder]
+        def to_xml(xml_builder)
+          attributes = { 'metadata:type' => type }
+          type_attrs = { 'gml:srsName' => srs_name }
+
+          xml_builder['data'].send(name.to_sym, attributes) do
+            xml_builder['gml'].send(type_name, type_attrs) do
+              value_to_xml(xml_value, xml_builder)
+            end
+          end
+        end
+
+        # Creates a new property instance from an XML element
+        # @param property_xml [Nokogiri::XML::Element]
+        # @param options [Hash]
+        # @return [OData4::Properties::Geography]
+        def self.from_xml(property_xml, options = {})
+          if property_xml.attributes['null'].andand.value == 'true'
+            content = nil
+          else
+            content = parse_xml(property_xml)
+            options.merge!(srid: srid_from_xml(property_xml))
+          end
+
+          new(property_xml.name, content, options)
+        end
+
+        protected
+
+        def type_name
+          self.class.name.split('::').last
+        end
+
+        def parse_wkt(value)
+          if value =~ /^geography'(SRID=(\d+);)+(\w+)\((.+)\)'$/
+            $3 == type_name or raise ArgumentError, "Invalid geography type '#{$3}'"
+            self.srid = $1 ? $2.to_i : DEFAULT_SRID
+            coords_from_s($4)
+          else
+            raise ArgumentError, "Invalid geography value '#{value}'"
+          end
+        end
+
+        # Recursively turn a JSON-like data structure into XML
+        def value_to_xml(value, xml_builder)
+          if value.is_a?(Hash)
+            value.each do |key, val|
+              xml_builder['gml'].send(key) do
+                value_to_xml(val, xml_builder)
+              end
+            end
+          elsif value.is_a?(Array)
+            value.each do |val|
+              value_to_xml(val, xml_builder)
+            end
+          else
+            xml_builder.text(value)
+          end
+        end
+
+        # Extract the SRID from a GML element's `srsName` attribute
+        def self.srid_from_xml(property_xml)
+          gml_elem = property_xml.element_children.first
+          srs_attr = gml_elem.attributes['srsName']
+          if srs_attr
+            srs_attr.value.split(/[\/:]/).last.to_i
+          end
+        end
+      end
+    end
+  end
+end