json-sequence 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0cb72c464c78dda06761851bfacc5b734bfd596ee58f30342253fcd7ea04d5d5
+  data.tar.gz: a6d0bbbd1c974b52bce2013379bfe027c0d43a11babc606b69f58b4ce270efa4
+SHA512:
+  metadata.gz: cb8d028614c4ca5a04d54c2dfa613974a3e6c1faaee2decaa735b104c21fc6776cb1eb3c817f0595a746521b58b03ff28b96cdb67472b5f47677f8023365113f
+  data.tar.gz: b4142272f541834a372a0d84aea77fae6bd87d9270863bd437d4bfb47debe4e99255b357376e03f32550f076ff32babc4ad765aa18fbdc1d752ee86bb0b98af6

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in json-sequence.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    json-sequence (0.1.2)
+      multi_json (~> 1.13)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    json (2.1.0)
+    json (2.1.0-java)
+    multi_json (1.13.1)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  json (~> 2.0)
+  json-sequence!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 GreenSync
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# JsonSequence
+
+A push parser for [RFC7464 JSON Text Sequences](https://tools.ietf.org/html/rfc7464)
+
+## Usage
+
+The parser is intended for use in scenarios where data is being streamed in
+chunks, either from the file system or from the network. As each new chuck of
+data is received it is pushed to the parser, which will yield the parsed values
+contained within.
+
+```ruby
+require 'net/http'
+require 'json_sequence'
+
+uri = URI('http://example.com/json_sequence')
+parser = JsonSequence::Parser.new
+
+Net::HTTP.start(uri.host, uri.port) do |http|
+  request = Net::HTTP::Get.new uri
+
+  http.request request do |response|
+    response.value # raises if not success
+
+    response.read_body do |chunk|
+      parser.parse(chunk) do |result|
+        case result
+        when JsonSequence::Result::Json
+          puts "received record: #{result.value.inspect}"
+        when JsonSequence::Result::MaybeTruncated
+          puts "received possibly truncated record: #{result.value.inspect}"
+        when JsonSequence::Result::ParseError
+          puts "stream contained invalid record: #{result.record}, caused by: #{result.error.message}"
+        end
+      end
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "json/sequence"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/json-sequence.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "json_sequence/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "json-sequence"
+  spec.version       = JsonSequence::VERSION
+  spec.authors       = ["Wesley Moore"]
+  spec.email         = ["wes.moore@greensync.com.au"]
+
+  spec.summary       = %q{Push parser for RFC7464 JSON Sequences}
+  spec.homepage      = "https://github.com/greensync/json-sequence"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    Dir.glob("{bin,lib}/**/*") + %w[README.md Gemfile Gemfile.lock Rakefile LICENSE.txt json-sequence.gemspec]
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "multi_json", "~> 1.13"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "json", "~> 2.0"
+end

data/lib/json_sequence.rb

@@ -0,0 +1 @@
+require 'json_sequence/parser'

data/lib/json_sequence/parser.rb

@@ -0,0 +1,61 @@
+require 'json_sequence/result'
+require 'multi_json'
+
+module JsonSequence
+  class Parser
+    RS = "\x1E".freeze
+
+    def initialize
+      @buffer = ''
+    end
+
+    def parse(chunk, &block)
+      @buffer = do_parse(@buffer + chunk, &block)
+    end
+
+    private
+
+    # Takes a String buffer to parse and returns String containing any
+    # text remaining to parse when more data is available.
+    def do_parse(buffer)
+      records = buffer.split(RS, -1) # -1 stops suppression of trailing null fields
+
+      records.each_with_index do |record, i|
+        # RFC7464 2.1 Multiple consecutive RS octets do not denote empty
+        # sequence elements between them and can be ignored.
+        next if record == ''
+
+        # Try to decode the record
+        begin
+          value = MultiJson.load(record)
+          result, remaining = handle_parsed(record, value, is_last_record: i == records.size - 1)
+        rescue MultiJson::ParseError => err
+          result, remaining = handle_err(record, err, is_last_record: i == records.size - 1)
+        end
+
+        return remaining if result.nil?
+        yield result
+      end
+
+      ''
+    end
+
+    def handle_parsed(record, value, is_last_record:)
+      case value
+      when Numeric, TrueClass, FalseClass, NilClass
+        # Check for truncation, if record was parsed but doesn't end in
+        # whitespace it may be truncated
+        if record !~ /\s$/
+          return is_last_record ? [nil, record] : [JsonSequence::Result::MaybeTruncated.new(value), '']
+        end
+      end
+
+      [JsonSequence::Result::Json.new(value), '']
+    end
+
+    def handle_err(record, err, is_last_record:)
+      # Last record, might be incomplete, stash for later
+      is_last_record ? [nil, record] : [JsonSequence::Result::ParseError.new(record, err), '']
+    end
+  end
+end

data/lib/json_sequence/result.rb

@@ -0,0 +1,42 @@
+module JsonSequence
+  module Result
+    class Json
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def ==(other)
+        return false unless other.is_a?(self.class)
+        other.value == value
+      end
+
+      alias eql? ==
+    end
+
+    class ParseError
+      attr_reader :record, :error
+
+      def initialize(record, error)
+        @record = record
+        @error = error
+      end
+    end
+
+    class MaybeTruncated
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def ==(other)
+        return false unless other.is_a?(self.class)
+        other.value == value
+      end
+
+      alias eql? ==
+    end
+  end
+end

data/lib/json_sequence/version.rb

@@ -0,0 +1,3 @@
+module JsonSequence
+  VERSION = "0.1.2"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: json-sequence
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Wesley Moore
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- wes.moore@greensync.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json-sequence.gemspec
+- lib/json_sequence.rb
+- lib/json_sequence/parser.rb
+- lib/json_sequence/result.rb
+- lib/json_sequence/version.rb
+homepage: https://github.com/greensync/json-sequence
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Push parser for RFC7464 JSON Sequences
+test_files: []