thrift-base64 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 90c0d60e32a5487e5b62c5b8a3b4444250d1e8a4
+  data.tar.gz: 5636b4ccb3c931c8ac51f8d230d668df1ab9f92a
+SHA512:
+  metadata.gz: 22d6158b32d9a19cdc56fa5399c969fcd6df0fac94478ab3214a2d00af82070834f14beadb380ce3edff8eca4ca6be3b459b32c8dcf781368342979aecb9b51a
+  data.tar.gz: 871a51715bb4c86d4b2706948c1e01d9b3832de89370cece4b37f1c3dc98eb266d0a5a847fb32e95030fac49b43118f968cb32f4101295abf09e68c9bf41e3ef

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,18 @@
+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
+
+.PHONY: benchmark
+benchmark: $(THRIFT)
+	ruby benchmark/serialization.rb
+	ruby benchmark/plaintext.rb

data/README.md

@@ -0,0 +1,128 @@
+# thrift-base64
+
+This gem contains helper classes for working with Base64 encoded
+Thrift objects. Eventually code will need to persist a serialized
+Thrift object. The binary protocols are the fastest ones.
+Unfortunately binary doesn't work well with plaintext protocols.
+Base64 solves this problem. It's also much faster than working with
+the provided `Thrift::JSON` protocol for interlop with plaintext
+protocols. Just check out the benchmarks below.
+
+## Benchmarks
+
+	ruby benchmark/serialization.rb
+	Calculating -------------------------------------
+					JSON   739.000  i/100ms
+				  Binary     4.532k i/100ms
+				 Compact     7.174k i/100ms
+		   Binary Base64     3.951k i/100ms
+		  Compact Base64     6.660k i/100ms
+	-------------------------------------------------
+					JSON      7.369k (±16.3%) i/s -    106.416k
+				  Binary     50.965k (± 9.8%) i/s -    756.844k
+				 Compact     87.953k (± 8.5%) i/s -      1.313M
+		   Binary Base64     43.881k (±10.2%) i/s -    651.915k
+		  Compact Base64     87.340k (± 9.3%) i/s -      1.299M
+
+	Comparison:
+				 Compact:    87953.3 i/s
+		  Compact Base64:    87340.1 i/s - 1.01x slower
+				  Binary:    50964.6 i/s - 1.73x slower
+		   Binary Base64:    43880.7 i/s - 2.00x slower
+					JSON:     7369.0 i/s - 11.94x slower
+
+	ruby benchmark/plaintext.rb
+	Calculating -------------------------------------
+		JSON/JSON String   690.000  i/100ms
+		JSON/JSON Object   651.000  i/100ms
+			 JSON/Binary     2.554k i/100ms
+			JSON/Compact     3.329k i/100ms
+		YAML/YAML String   355.000  i/100ms
+			 YAML/Binary   575.000  i/100ms
+			YAML/Compact   607.000  i/100ms
+	-------------------------------------------------
+		JSON/JSON String      7.093k (± 8.6%) i/s -    105.570k
+		JSON/JSON Object      6.834k (±10.0%) i/s -    101.556k
+			 JSON/Binary     28.120k (± 8.4%) i/s -    418.856k
+			JSON/Compact     36.468k (± 8.3%) i/s -    542.627k
+		YAML/YAML String      3.636k (±13.8%) i/s -     52.895k
+			 YAML/Binary      6.118k (± 9.5%) i/s -     90.850k
+			YAML/Compact      6.541k (±10.3%) i/s -     97.120k
+
+	Comparison:
+			JSON/Compact:    36468.5 i/s
+			 JSON/Binary:    28120.3 i/s - 1.30x slower
+		JSON/JSON String:     7093.4 i/s - 5.14x slower
+		JSON/JSON Object:     6834.5 i/s - 5.34x slower
+			YAML/Compact:     6540.9 i/s - 5.58x slower
+			 YAML/Binary:     6118.3 i/s - 5.96x slower
+		YAML/YAML String:     3636.5 i/s - 10.03x slower
+
+These benchmarks are included in [benchmark/][benchmark/].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'thrift-base64'
+```
+
+And then execute:
+
+	$ bundle
+
+Or install it yourself as:
+
+	$ gem install thrift-base64
+
+## Usage
+
+`thrift-base64` adds two classes to the `Thrift` module:
+`Thrift::Base64Derserializer` & `Thrift::Base64Serializer`. They mimic the
+interface of `Thirft::Deserializer` & `Thrift::Serializer` except they
+require no arguments to `initialize`. Here's an example:
+
+```ruby
+require 'thrift-base64'
+
+struct = SomeThriftStruct.new
+
+json = Thrift::Base64Serializer.new.serialize(struct)
+deserialized = Thrift::Base64Deserializer.new.deserialize(SomeThriftStruct.new, json)
+```
+
+Here's another example if you don't like the verbosity. Defaults to
+using `Thrift::BinaryProtocol`.
+
+```ruby
+require 'thrift-base64'
+
+struct = SomeThriftStruct.new
+SomeThriftStruct.from_base64(struct.to_base64)
+```
+
+Compact methods are available as well. They use
+`Thrift::CompactProtocol`.
+
+```
+require 'thrift-base64'
+
+struct = SomeThriftStruct.new
+SomeThriftStruct.from_compact_base64(struct.to_compact_base64)
+```
+
+## Testing
+
+	$ make test
+	$ make benchmark
+
+## Contributing
+
+1. Fork it ( https://github.com/saltside/thrift-base64-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

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/benchmark/plaintext.rb

@@ -0,0 +1,61 @@
+require 'bundler/setup'
+require 'thrift-base64'
+
+root = File.expand_path '../..', __FILE__
+
+$LOAD_PATH << "#{root}/vendor/gen-rb"
+
+Thrift.type_checking = true
+
+require 'test_types'
+require 'benchmark/ips'
+
+require 'json'
+require 'yaml'
+
+struct = SimpleStruct.new message: 'Benchmarking!!'
+
+json_serializer = Thrift::Serializer.new Thrift::JsonProtocolFactory.new
+json_deserializer = Thrift::Deserializer.new Thrift::JsonProtocolFactory.new
+
+binary_base64_serializer = Thrift::Base64Serializer.new Thrift::BinaryProtocolFactory.new
+binary_base64_deserializer = Thrift::Base64Deserializer.new Thrift::BinaryProtocolFactory.new
+
+compact_base64_serializer = Thrift::Base64Serializer.new Thrift::CompactProtocolFactory.new
+compact_base64_deserializer = Thrift::Base64Deserializer.new Thrift::CompactProtocolFactory.new
+
+# Cover the various blobs when used inside other plaintext protocols
+Benchmark.ips do |x|
+  x.warmup = 5
+  x.time = 15
+
+  x.report "JSON/JSON String" do
+    json_deserializer.deserialize(SimpleStruct.new, JSON.load(JSON.dump([ json_serializer.serialize(struct) ])).first)
+  end
+
+  x.report "JSON/JSON Object" do
+    json_deserializer.deserialize(SimpleStruct.new, JSON.load(JSON.dump({ blob: json_serializer.serialize(struct) })).fetch('blob'))
+  end
+
+  x.report "JSON/Binary" do
+    binary_base64_deserializer.deserialize(SimpleStruct.new, JSON.load(JSON.dump([ binary_base64_serializer.serialize(struct) ])).first)
+  end
+
+  x.report "JSON/Compact" do
+    compact_base64_deserializer.deserialize(SimpleStruct.new, JSON.load(JSON.dump([ compact_base64_serializer.serialize(struct) ])).first)
+  end
+
+  x.report "YAML/YAML String" do
+    json_deserializer.deserialize(SimpleStruct.new, YAML.load(YAML.dump([ json_serializer.serialize(struct) ])).first)
+  end
+
+  x.report "YAML/Binary" do
+    binary_base64_deserializer.deserialize(SimpleStruct.new, YAML.load(YAML.dump([ binary_base64_serializer.serialize(struct) ])).first)
+  end
+
+  x.report "YAML/Compact" do
+    compact_base64_deserializer.deserialize(SimpleStruct.new, YAML.load(YAML.dump([ compact_base64_serializer.serialize(struct) ])).first)
+  end
+
+  x.compare!
+end

data/benchmark/serialization.rb

@@ -0,0 +1,55 @@
+require 'bundler/setup'
+require 'thrift-base64'
+
+root = File.expand_path '../..', __FILE__
+
+$LOAD_PATH << "#{root}/vendor/gen-rb"
+
+Thrift.type_checking = true
+
+require 'test_types'
+require 'benchmark/ips'
+
+struct = SimpleStruct.new message: 'Benchmarking!!'
+
+json_serializer = Thrift::Serializer.new Thrift::JsonProtocolFactory.new
+json_deserializer = Thrift::Deserializer.new Thrift::JsonProtocolFactory.new
+
+binary_serializer = Thrift::Serializer.new Thrift::BinaryProtocolFactory.new
+binary_deserializer = Thrift::Deserializer.new Thrift::BinaryProtocolFactory.new
+
+compact_serializer = Thrift::Serializer.new Thrift::CompactProtocolFactory.new
+compact_deserializer = Thrift::Deserializer.new Thrift::CompactProtocolFactory.new
+
+binary_base64_serializer = Thrift::Base64Serializer.new Thrift::BinaryProtocolFactory.new
+binary_base64_deserializer = Thrift::Base64Deserializer.new Thrift::BinaryProtocolFactory.new
+
+compact_base64_serializer = Thrift::Base64Serializer.new Thrift::CompactProtocolFactory.new
+compact_base64_deserializer = Thrift::Base64Deserializer.new Thrift::CompactProtocolFactory.new
+
+Benchmark.ips do |x|
+  x.warmup = 5
+  x.time = 15
+
+  x.report "JSON" do
+    json_deserializer.deserialize(SimpleStruct.new, json_serializer.serialize(struct))
+  end
+
+  x.report "Binary" do
+    binary_deserializer.deserialize(SimpleStruct.new, binary_serializer.serialize(struct))
+  end
+
+  x.report "Compact" do
+    compact_deserializer.deserialize(SimpleStruct.new, compact_serializer.serialize(struct))
+  end
+
+  x.report "Binary Base64" do
+    binary_base64_deserializer.deserialize(SimpleStruct.new, binary_base64_serializer.serialize(struct))
+  end
+
+  x.report "Compact Base64" do
+    compact_deserializer.deserialize(SimpleStruct.new, compact_serializer.serialize(struct))
+  end
+
+  x.compare!
+end

data/lib/thrift/base64/version.rb

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

data/lib/thrift/base64.rb

@@ -0,0 +1,52 @@
+require 'thrift/base64/version'
+require 'thrift'
+require 'base64'
+
+module Thrift
+  class Base64Serializer < Serializer
+    def serialize(base)
+      ::Base64.encode64 super
+    end
+  end
+
+  class Base64Deserializer < Deserializer
+    def deserialize(object, blob)
+      super object, ::Base64.decode64(blob)
+    end
+  end
+
+  # NOTE: this module is a little workaround in off the chance
+  # another library has redefined Struct.included. So instead
+  # we prepend a module which then extends the original including
+  # class with the module containing from_base64.
+  module Base64Extension
+    module FromBase64
+      def from_base64(blob, protocol = BinaryProtocolFactory.new)
+        Base64Deserializer.new(protocol).deserialize(new, blob)
+      end
+
+      def from_compact_base64(blob)
+        from_base64 blob, CompactProtocolFactory.new
+      end
+    end
+
+    def included(base)
+      base.extend FromBase64
+      super
+    end
+  end
+
+  module Struct
+    class << self
+      prepend Base64Extension
+    end
+
+    def to_base64(protocol = BinaryProtocolFactory.new)
+      Base64Serializer.new(protocol).serialize self
+    end
+
+    def to_compact_base64
+      to_base64 CompactProtocolFactory.new
+    end
+  end
+end

data/lib/thrift-base64.rb

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

data/test/acceptance_test.rb

@@ -0,0 +1,64 @@
+require_relative 'test_helper'
+
+class AcceptanceTest < MiniTest::Unit::TestCase
+  attr_reader :struct
+
+  def setup
+    @struct = SimpleStruct.new message: utf8_string
+    assert_utf8 struct.message
+  end
+
+  def test_round_trips_itself_with_proper_encodings
+    base64 = Thrift::Base64Serializer.new.serialize(struct)
+
+    deserialized = Thrift::Base64Deserializer.new.deserialize(SimpleStruct.new, base64)
+    assert_equal struct.message, deserialized.message
+    assert_utf8 deserialized.message
+  end
+
+  def test_generated_strings_can_be_used_in_encoding_aware_code
+    base64 = Thrift::Base64Serializer.new.serialize(struct)
+    roundtripped = JSON.load(JSON.dump(blob: base64)).fetch('blob')
+
+    assert_equal base64, roundtripped
+
+    deserialized = Thrift::Base64Deserializer.new.deserialize(SimpleStruct.new, roundtripped)
+    assert_equal struct.message, deserialized.message
+    assert_utf8 deserialized.message
+  end
+
+  def test_roundtrips_via_to_from_base64
+    roundtripped = SimpleStruct.from_base64(struct.to_base64)
+    assert_equal struct.message, roundtripped.message
+  end
+
+  def test_to_from_methods_take_protocol_argument
+    compact_base64 = struct.to_base64 Thrift::CompactProtocolFactory.new
+    expected = Base64.encode64(Thrift::Serializer.new(Thrift::CompactProtocolFactory.new).serialize(struct))
+
+    assert expected == compact_base64, 'Protocol incorrect'
+
+    deserialized = SimpleStruct.from_base64(compact_base64, Thrift::CompactProtocolFactory.new)
+    assert_equal struct.message, deserialized.message
+  end
+
+  def test_to_from_compact_binary_with_base64_encoding
+    compact_base64 = struct.to_compact_base64
+    expected = Base64.encode64(Thrift::Serializer.new(Thrift::CompactProtocolFactory.new).serialize(struct))
+
+    assert expected == compact_base64, 'Protocol incorrect'
+
+    deserialized = SimpleStruct.from_compact_base64(compact_base64)
+    assert_equal struct.message, 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-base64'
+
+Thrift.type_checking = true
+
+require 'json'
+
+require 'test_types'
+require 'minitest/autorun'

data/test.thrift

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

data/thrift-base64.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'thrift/base64/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "thrift-base64"
+  spec.version       = Thrift::Base64::VERSION
+  spec.authors       = ["ahawkins"]
+  spec.email         = ["adam@hawkins.io"]
+  spec.summary       = %q{Thrift object serialization/deserialization with Base64}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/saltside/thrift-base64-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"
+  spec.add_development_dependency "benchmark-ips"
+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,119 @@
+--- !ruby/object:Gem::Specification
+name: thrift-base64
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ahawkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-15 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'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- adam@hawkins.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- benchmark/plaintext.rb
+- benchmark/serialization.rb
+- lib/thrift-base64.rb
+- lib/thrift/base64.rb
+- lib/thrift/base64/version.rb
+- test.thrift
+- test/acceptance_test.rb
+- test/test_helper.rb
+- thrift-base64.gemspec
+- vendor/gen-rb/test_constants.rb
+- vendor/gen-rb/test_types.rb
+homepage: https://github.com/saltside/thrift-base64-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: Thrift object serialization/deserialization with Base64
+test_files:
+- test/acceptance_test.rb
+- test/test_helper.rb