tenderlove / hana

An implementation of JSON Patch and JSON Pointer for Ruby

hana

• http://github.com/tenderlove/hana

DESCRIPTION:

Implementation of JSON Patch and JSON Pointer RFC.

FEATURES/PROBLEMS:

Implements specs of the JSON Patch and JSON pointer RFCs:

This works against Ruby objects, so you should load the JSON to Ruby, process it, then emit as JSON again.

SYNOPSIS:

patch = Hana::Patch.new [
  { 'op' => 'add', 'path' => '/baz', 'value' => 'qux' }
]

patch.apply('foo' => 'bar') # => {'baz' => 'qux', 'foo' => 'bar'}

REQUIREMENTS:

• Ruby

INSTALL:

$ gem install hana

DEVELOPMENT:

hana runs tests from json-patch/json-patch-tests. Fetch the git submodule by running:

git submodule init
git submodule update

Install dependencies with:

bundle install

Then run the tests with:

rake test

hana's Issues

New release

Hi,

Since the latest release, both code and spec as evolved. It would be nice to release a new version.

New release?

Any chance we could get a new release of this gem? There has been at least one PR merged since the last release.

Myroom

• ``

Any way to add a nested object?

I'm trying to build up a JSON document hash starting from {}. I keep ending up here when I add a nested path. I see the problem -- you can't know whether applying the patch {"op": "add", "path": "/foo/0", "value": "bar"} to {} should yield

{"foo": {"0": "bar"}}

or

{"foo": ["bar"]}

However, for paths with all non-numeric segments there should be no confusion.

Is there a way to add a nested element with Hana that I can't see? Is it reasonable to think of adding support for this?

[Question] How to use JSON Patch with SSE in Rails Controller?

Hi @tenderlove ,

In the controller:

module Api::V1
  class TestController < ApiController
    include ActionController::Live

    def ticker
      response.headers['Content-Type'] = 'text/event-stream'
      sse = Ticker::SSE.new(response.stream)
      begin
        loop do
          test = Test.desc
          a = test.second.as_json(except: ["created_at", "updated_at", "_id"]) 
          b = test.first.as_json(except: ["created_at", "updated_at", "_id"])
          diff = JsonDiff.generate(a, b)
         patch = Hana::Patch.new [diff]
         #what to do then with `patch.apply` and `sse.write`?
          sse.write(json)
        end
      rescue IOError
        logger.info 'Client disconnects causes IOError on write'
      ensure
        sse.close
      end
    end
  end
end

In app/lib/ticker/sse.rb

module Ticker
  class SSE
    def initialize(io)
      @io = io
    end

    def write(object, options = {})
      options.each do |k,v|
        @io.write("#{k}: #{v}\n")
      end
      @io.write("data: #{JSON.dump(object)}\n\n")
    end

    def close
      @io.close
    end
  end
end

Many thanks,

MIssing gemspec & ruby minimal version

Heey,

I noticed that this gem does not set a ruby minimal required version, though does not work with ruby 2.2
Please set a minimal ruby version to make this visible, and also check in the gemspec in the git repository.

Hana::Pointer `#` does not match whole document

object = {}
pointer = Hana::Pointer.new("#")
pointer.eval(object) # => nil, should equal object

As said in Section 6 of the Pointer RFC, https://tools.ietf.org/html/rfc6901#section-6:

#            // the whole document

unable to use JSON Patch at {"link":{"self":{"href":"gmail.com"}},"name":"google"}

response = '{"link":{"self":{"href":"gmail.com"}},"name":"google"}';
#2 the response is the string value, we are parse string to JSON object by using JSON.parse()

Obj = JSON.parse(response);
#2 displaying Obj after parsing to JSON object.

puts Obj
#2 It displaying {"link"=>{"self"=>{"href"=>"gmail.com"}},"name"=>"google"}
#2 After that i am using hana and JSON Patch to update the name,

patch = Hana::Patch.new [
{ 'replace' => '/name', 'value' => 'gmail' }
]
Obj2 = patch.apply(Obj)
#2 displaying Obj2 after applying JSON Patch.

puts Obj2

Getting error "undefined method `strip' for nil:NilClass" when using patch.apply(Obj)
Please tell me what is the mistake here and give a solution to this problem !

Client error handling?

Per 6901, JSON pointer error handling is up to the implementation. I see that Pointer is used here primarily to implement Patch, but would it be possible to make it so that an error could be handled by the user of Hana?

Specifically, in cases where there's no value at (an intermediate) index there's a lot of room to do useful things like fill in empty objects.

Also, - to refer to "the next item of an array" raises an error, where a client implementation might want to handle that somehow. (And Patch might want to add at /list/-)

If so, I'll volunteer a PR.