thrift-utf8_json 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e29a73f29d8dd1a398ef60a9fdc96fa72746350f
+  data.tar.gz: 2ad28e968450ac8a1187808256134247977e05ca
+SHA512:
+  metadata.gz: d9fb7bedf7ff932eae33b737a34c56e4f683e6d493b560d4db80cbeff1167c36b5ad9597a8353f8a163e8aef9437ea2987171f1daa960c0cabcb9f691b40c6b3
+  data.tar.gz: abd75a801da112034e8d072a11859189860929b3d3613dabe1d3a7c2149ed9db278b33c499f8cf7148decd5662de29f238e134e7298b30f0a633666d4fe87bbc

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in thrift-json.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 ahawkins
+
+MIT License
+
+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/Makefile

@@ -0,0 +1,13 @@
+THRIFT:=vendor/gen-rb/test_types.rb
+
+$(THRIFT): test.thrift
+	mkdir -p $(@D)
+	thrift -o vendor --gen rb test.thrift
+
+.PHONY: test
+test: $(THRIFT)
+	bundle exec rake test
+
+.PHONY:
+release:
+	bundle exec rake release

data/README.md

@@ -0,0 +1,54 @@
+# thrift-ut8\_json
+
+This gem contains patches for working with [thrift][] struts & JSON
+serialization/deserialization. Most importantly it contains a fix for
+encoding handling when using generated thrift JSON blobs inside other
+objects (e.g. persisting in a data store). This bug is documented in
+the [acceptance test][].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'thrift-utf8_json'
+```
+
+And then execute:
+
+	$ bundle
+
+Or install it yourself as:
+
+	$ gem install thrift-utf8_json
+
+## Usage
+
+`thrift-utf8_json` adds two classes to the `Thrift` module:
+`Thrift::JsonDerserializer` & `Thrift::JsonSerializer`. They mimic the
+interface of `Thirft::Deserializer` & `Thrift::Serializer` except they
+require no arguments to `initialize`. Here's an example:
+
+```ruby
+require 'thrift-utf8_json'
+
+struct = SomeThriftStruct.new
+
+json = Thrift::JsonSerializer.new.serialize(struct)
+deserialized = Thrift::JsonDeserializer.new.deserialize(SomeThriftStruct.new, json)
+```
+
+## Testing
+
+	$ make test
+
+## Contributing
+
+1. Fork it ( https://github.com/saltside/thrift-utf8_json-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+[thrift]: https://thrift.apache.org
+[acceptance test]: test/acceptance_test.rb

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.test_files = Rake::FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/lib/thrift-utf8_json.rb

@@ -0,0 +1 @@
+require 'thrift/utf8_json'

data/lib/thrift/utf8_json.rb

@@ -0,0 +1,32 @@
+require 'thrift/utf8_json/version'
+require 'thrift'
+
+module Thrift
+  class Utf8JsonProtocol < ::Thrift::JsonProtocol
+    def read_string
+      super.force_encoding('UTF-8')
+    end
+  end
+
+  class Utf8JsonProtocolFactory
+    def get_protocol(trans)
+      return Utf8JsonProtocol.new(trans)
+    end
+  end
+
+  class JsonSerializer < Serializer
+    def initialize
+      super Utf8JsonProtocolFactory.new
+    end
+
+    def serialize(base)
+      super.force_encoding('UTF-8')
+    end
+  end
+
+  class JsonDeserializer < Deserializer
+    def initialize
+      super Utf8JsonProtocolFactory.new
+    end
+  end
+end

data/lib/thrift/utf8_json/version.rb

@@ -0,0 +1,5 @@
+module Thrift
+  module Utf8Json
+    VERSION = "0.1.0"
+  end
+end

data/test.thrift

@@ -0,0 +1,3 @@
+struct SimpleStruct  {
+  1: required string message
+}

data/test/acceptance_test.rb

@@ -0,0 +1,71 @@
+require_relative 'test_helper'
+
+class AcceptanceTest < MiniTest::Unit::TestCase
+  def test_round_trips_itself_with_proper_encodings
+    struct = SimpleStruct.new message: utf8_string
+    assert_utf8 struct.message
+
+    json = Thrift::JsonSerializer.new.serialize(struct)
+    assert_utf8 json
+
+    deserialized = Thrift::JsonDeserializer.new.deserialize(SimpleStruct.new, json)
+    assert_equal struct.message, deserialized.message
+    assert_utf8 struct.message
+  end
+
+  def test_bug_exists
+    struct = SimpleStruct.new message: utf8_string
+    assert_utf8 struct.message
+
+    serializer = Thrift::Serializer.new Thrift::JsonProtocolFactory.new
+    json = serializer.serialize struct
+
+    # Thrift uses a binary encoding when generating the serialized string.
+    # Then resulting generated string is then in a different encoding.
+    assert_equal Encoding::ASCII_8BIT, json.encoding
+
+    # This causes problems for other things that require correct encodings.
+    # e.g. JSON.dump. The previously generated string contains bytes that
+    # are not represented in ASCII 8 bit.
+    assert_raises Encoding::UndefinedConversionError do
+      JSON.dump([json])
+    end
+  end
+
+  def test_bug_fix
+    struct = SimpleStruct.new message: utf8_string
+    assert_utf8 struct.message
+
+    serializer = Thrift::Serializer.new Thrift::JsonProtocolFactory.new
+    json = serializer.serialize struct
+
+    # This fixes the problem mentioned in the previous test. Previously
+    # unrecognized bytes will be propertly handled in UTF8
+    utf8_json = json.force_encoding('UTF-8')
+
+    # The correctly encoded JSON string should now work with encoding
+    # specific code
+    dumped = JSON.dump([ utf8_json ])
+
+    # Take the thrift JSON blob and load it. This blog should deserialize
+    # into the original thrift object with correct string encodings.
+    # The UTF8 protocol factory will read strings in json back in the correct
+    # encoding as well.
+    serialized = JSON.load(dumped).first
+    deserializer = Thrift::Deserializer.new Thrift::Utf8JsonProtocolFactory.new
+    deserialized = deserializer.deserialize(SimpleStruct.new, serialized)
+
+    assert_equal struct.message, deserialized.message
+    assert_utf8 deserialized.message
+  end
+
+  private
+
+  def assert_utf8(string)
+    assert_equal Encoding::UTF_8, string.encoding, 'Non UTF-8 string'
+  end
+
+  def utf8_string
+    "Hi, I'am a ☃ !!"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+
+root = File.expand_path '../..', __FILE__
+
+$LOAD_PATH << "#{root}/vendor/gen-rb"
+
+require 'thrift-utf8_json'
+
+Thrift.type_checking = true
+
+require 'json'
+
+require 'test_types'
+require 'minitest/autorun'

data/thrift-json.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'thrift/utf8_json/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "thrift-utf8_json"
+  spec.version       = Thrift::Utf8Json::VERSION
+  spec.authors       = ["ahawkins"]
+  spec.email         = ["adam@hawkins.io"]
+  spec.summary       = %q{Helpful patches for serializing/deserializing Thrift objeects}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/saltside/thrift-utf_8json-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thrift"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/vendor/gen-rb/test_constants.rb

@@ -0,0 +1,9 @@
+#
+# Autogenerated by Thrift Compiler (0.9.2)
+#
+# DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+#
+
+require 'thrift'
+require 'test_types'
+

data/vendor/gen-rb/test_types.rb

@@ -0,0 +1,25 @@
+#
+# Autogenerated by Thrift Compiler (0.9.2)
+#
+# DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+#
+
+require 'thrift'
+
+class SimpleStruct
+  include ::Thrift::Struct, ::Thrift::Struct_Union
+  MESSAGE = 1
+
+  FIELDS = {
+    MESSAGE => {:type => ::Thrift::Types::STRING, :name => 'message'}
+  }
+
+  def struct_fields; FIELDS; end
+
+  def validate
+    raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field message is unset!') unless @message
+  end
+
+  ::Thrift::Struct.generate_accessors self
+end
+

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: thrift-utf8_json
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ahawkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thrift
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: ''
+email:
+- adam@hawkins.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- lib/thrift-utf8_json.rb
+- lib/thrift/utf8_json.rb
+- lib/thrift/utf8_json/version.rb
+- test.thrift
+- test/acceptance_test.rb
+- test/test_helper.rb
+- thrift-json.gemspec
+- vendor/gen-rb/test_constants.rb
+- vendor/gen-rb/test_types.rb
+homepage: https://github.com/saltside/thrift-utf_8json-ruby
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Helpful patches for serializing/deserializing Thrift objeects
+test_files:
+- test/acceptance_test.rb
+- test/test_helper.rb