nori icon indicating copy to clipboard operation
nori copied to clipboard

Time and DateTime typecasting forcing UTC

Open cschiewek opened this issue 12 years ago • 11 comments

See rubiii/savon#110 for history.

Seems nori is forcing Time objects and DateTime objects to utc when doing typecasting. This causes goes against ISO8601 which clearly states that date and time representations that do not specify a timezone should be considered as being the local time zone.

cschiewek avatar Jul 25 '12 00:07 cschiewek

Closed the pull request as it does not fix the problem.

cschiewek avatar Jul 26 '12 18:07 cschiewek

it does not?

rubiii avatar Jul 27 '12 11:07 rubiii

I'm still seeing this problem too. Im using v 1.1.3 In my XML trace I see: <DateBegin>2012-09-11T17:30:00</DateBegin> In the hash: :date_begin=>Tue, 11 Sep 2012 17:30:00 +0000

joshco avatar Sep 11 '12 09:09 joshco

For any folks struggling with this, I put the following hack in my code:

  def tz_fix(datetime)

    offset=(Time.now.utc_offset/3600).to_s

    dt=datetime.change( :offset => (offset))

   end

Then on any objects I get back I do e[:date_start]=tz_fix(e[:date_start]

messy but it works

joshco avatar Sep 12 '12 07:09 joshco

Any update on this? I think the code in robuye/nori@505e68f03676cf82dd90a262015c21d2589979ab look pretty solid. Is/was it working for you @robuye?

Mange avatar Mar 31 '16 12:03 Mange

This hack worked for me in a Rails application. You can substitute with any other implementation. I'd prefer to have this a lot easier right out of the box (default_to_utc: false option, perhaps?).

config/initializers/nori_overrides.rb

# Make Nori (the XML parser used by wash_out for SOAP API) use Rails' TZ support
module NoriAdvancedTypecastingWithTimeZone
  def advanced_typecasting(value)
    if value.strip =~ Nori::XMLUtilityNode::XS_DATE_TIME
      try_to_convert(value) { |x| Time.zone.parse(x) }
    else
      super
    end
  end
end

class Nori::XMLUtilityNode
  typecasts["dateTime"] = ->(value) { Time.zone.parse(value) if value.present? }
  typecasts["datetime"] = typecasts["dateTime"]

  prepend NoriAdvancedTypecastingWithTimeZone
end

And tests, to make sure my monkey patch does not break / actually works:

  # Nori is used by wash_out to parse SOAP XML into Ruby hashes.
  # We have to patch in Rails' timezone support in an initializer.
  describe "parsing XML using Nori" do
    let(:nori) { Nori.new(advanced_typecasting: true) }

    describe "with type attributes" do
      it "parses dateTimes in the given zone" do
        Time.use_zone("Europe/Helsinki") do # +03:00 in the summer
          result = nori.parse('<time type="datetime">2016-07-07T12:00:10+02:00</time>')
          result["time"].should == Time.zone.parse("2016-07-07T12:00:10+02:00")
        end
      end

      it "defaults dateTimes to Time.zone if no TZ is given" do
        Time.use_zone("Europe/Helsinki") do  # +03:00 in the summer
          result = nori.parse('<time type="datetime">2016-07-07T12:00:10</time>')
          result["time"].should == Time.zone.parse("2016-07-07T12:00:10+03:00")
        end
      end
    end

    describe "without type attribute" do
      it "parses time-like strings in the given zone" do
        Time.use_zone("Europe/Helsinki") do  # +03:00 in the summer
          result = nori.parse("<time>  2016-07-07T12:00:10+02:00  </time>")
          result["time"].should == Time.zone.parse("2016-07-07T12:00:10+02:00")
        end
      end

      it "defaults time-like strings to Time.zone if no TZ is given" do
        Time.use_zone("Europe/Helsinki") do  # +03:00 in the summer
          result = nori.parse("<time>  2016-07-07T12:00:10   </time>")
          result["time"].should == Time.zone.parse("2016-07-07T12:00:10+03:00")
        end
      end
    end
  end

Mange avatar Mar 31 '16 13:03 Mange

Hi @Mange

I never had this problem myself, simply made a commit to address an existing issue, but I can't confirm if and how it behaves in production environment. I'm also long gone from the project we used Nori (tho afaik it's solid and still in use). I'm not sure I can be of any help here, sorry.

robuye avatar Mar 31 '16 13:03 robuye

Thank you for the update, @robuye.

Mange avatar Apr 01 '16 06:04 Mange

Thanks for the monkeypatch, @Mange, it works fine! I'm experiencing the same issues with an API that yields timestamps like '2014-01-03T01:00:00'.

I will be using this in production. Is there any chance this will be fixed, or should I create a swanky-nori fork instead?

moiristo avatar May 03 '19 13:05 moiristo

We've been using this in production since this PR was opened and it's worked well for us. You should fork your own copy since we're going to remove our fork shortly as we've been deprecating the SOAP API and are now ready to remove it.

Mange avatar May 08 '19 04:05 Mange

Alright, thanks!

moiristo avatar May 08 '19 05:05 moiristo