thrift-validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d1e1282790eab6d2034f8f05da9d4512102c59be
+  data.tar.gz: 50535756f602fcf6c60b4f2ef47222fc28e75e6d
+SHA512:
+  metadata.gz: f59768669a591b41eeb0c1802252ba2256f53800c18242cf21196496c9dc13b08535a52098ed7b9302a2499f97971dddd93e9a2146bf5380e6aa78c73a28c124
+  data.tar.gz: 96421ce8b108eb57fee36cfa5e1e18b0dd318c2081573110c796320438b0c3612054fd7a38d2066caa4236cb1c7deb66e9588731d5fedc45507c7724d68a91dc

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-validator.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,9 @@
+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

data/README.md

@@ -0,0 +1,84 @@
+# Thrift::Validator
+
+Recursive [thrift][] struct validator. The thrift library out of the
+box does not validated nested structs, this library fixes that
+problem. It does not monkey-patch the Thrift code. Instead this
+library includes a class to recursively validate objects.
+
+Here's an example from this libraries test. Take a look at this
+protocol:
+
+```thrift
+struct SimpleStruct  {
+  1: required string required_string
+  2: optional string optional_string
+}
+
+struct NestedExample {
+  1: required SimpleStruct required_struct
+  2: optional SimpleStruct optional_struct
+}
+```
+
+Then ran some ruby:
+
+```ruby
+struct = SimpleStruct.new
+nested = NestedStruct.new required_struct: struct
+
+# Method defined by the thrift library
+struct.validate # => Thrift::ProtocolException
+
+# Thrift only validate fields set as required on this instance.
+# so since required_struct is non-nil validation succeeds.
+# Also note that thrift does not validate the semantics of
+# the assigned objects, so also assigning and invalid struct will
+# pass its validation method.
+nested.validate # => true
+
+# With the validator
+validator = Thrift::Validator.new
+validator.validate nested # => Thrift::ProtocolException
+```
+
+## Semantics
+
+* Original thrift validation smenatics enforces
+* `optional` or `required` `struct` types pass validation
+* `optional` or `required` `list<struct>` items pass validation
+* `optional` or `required` `set<struct>` items pass validation
+* `optional` or `required` `map` type using a `struct` for key or
+  value pass validation
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'thrift-validator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install thrift-validator
+
+## Testing
+
+First install `thrift` compilier on your platform.
+
+	$ make test
+
+## Contributing
+
+1. Fork it ( https://github.com/saltside/thrift-validator/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/lib/thrift/validator/version.rb

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

data/lib/thrift/validator.rb

@@ -0,0 +1,36 @@
+require 'thrift/validator/version'
+require 'thrift'
+
+module Thrift
+  class Validator
+    def validate(source)
+      source.validate
+
+      source.struct_fields.each_pair do |_, field|
+        type, name = field.fetch(:type), field.fetch(:name)
+        case type
+        when Types::STRUCT
+          validate source.send(name)
+        when Types::LIST, Types::SET
+          Array(source.send(name)).each do |item|
+            validate item
+          end
+        when Types::MAP
+          key_field = field.fetch(:key)
+          if key_field[:class] && key_field[:class] < ::Thrift::Struct
+            Hash(source.send(name)).each_key do |key_value|
+              validate key_value
+            end
+          end
+
+          value_field = field.fetch(:value)
+          if value_field[:class] && value_field[:class] < ::Thrift::Struct
+            Hash(source.send(name)).each_value do |value_value|
+              validate value_value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/thrift-validator.rb

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

data/test/acceptance_test.rb

@@ -0,0 +1,122 @@
+require_relative 'test_helper'
+
+class AcceptanceTest < MiniTest::Unit::TestCase
+  def test_follows_thrift_semantics
+    struct = SimpleStruct.new required_string: nil, optional_string: nil
+    refute_valid struct
+  end
+
+  def test_fails_if_a_required_nested_struct_is_invalid
+    struct = NestedExample.new
+    struct.required_struct = SimpleStruct.new
+    refute_valid struct
+  end
+
+  def test_fails_if_an_optional_nested_struct_is_valid
+    struct = NestedExample.new
+    struct.required_struct = SimpleStruct.new required_string: 'foo'
+    struct.optional_struct = SimpleStruct.new
+    refute_valid struct
+  end
+
+  def test_passes_if_nested_structs_are_valid
+    struct = NestedExample.new
+    struct.required_struct = SimpleStruct.new required_string: 'foo'
+    struct.optional_struct = SimpleStruct.new required_string: 'bar'
+    assert_valid struct
+  end
+
+  def test_fails_if_a_nested_list_item_is_invalid
+    struct = ListExample.new
+    struct.required_list = [ SimpleStruct.new ]
+    refute_valid struct
+  end
+
+  def test_fails_if_a_nested_list_item_is_invalid
+    struct = ListExample.new
+    struct.required_list = [ SimpleStruct.new({ required_string: 'foo' }) ]
+    struct.optional_list = [ SimpleStruct.new ]
+    refute_valid struct
+  end
+
+  def test_passes_if_given_valid_list_items
+    struct = ListExample.new
+    struct.required_list = [ SimpleStruct.new({ required_string: 'foo' }) ]
+    struct.optional_list = [ SimpleStruct.new({ required_string: 'bar' }) ]
+    assert_valid struct
+  end
+
+  def test_fails_if_a_nested_set_item_is_invalid
+    struct = SetExample.new
+    struct.required_set = Set.new([ SimpleStruct.new ])
+    refute_valid struct
+  end
+
+  def test_fails_if_a_nested_set_item_is_invalid
+    struct = SetExample.new
+    struct.required_set = Set.new([ SimpleStruct.new({ required_string: 'foo' }) ])
+    struct.optional_set = Set.new([ SimpleStruct.new ])
+    refute_valid struct
+  end
+
+  def test_passes_if_given_valid_set_items
+    struct = SetExample.new
+    struct.required_set = Set.new([ SimpleStruct.new({ required_string: 'foo' }) ])
+    struct.optional_set = Set.new([ SimpleStruct.new({ required_string: 'bar' }) ])
+    assert_valid struct
+  end
+
+  def test_fails_if_nested_map_key_is_invalid
+    struct = MapKeyExample.new
+    struct.required_map = { SimpleStruct.new => 'foo' }
+    refute_valid struct
+  end
+
+  def test_fails_if_nested_map_key_is_invalid
+    struct = MapKeyExample.new
+    struct.required_map = { SimpleStruct.new({ required_string: 'foo' }) => 'foo' }
+    struct.optional_map = { SimpleStruct.new => 'foo' }
+    refute_valid struct
+  end
+
+  def test_passess_when_valid_map_keys_are_given
+    struct = MapKeyExample.new
+    struct.required_map = { SimpleStruct.new({ required_string: 'foo' }) => 'foo' }
+    struct.optional_map = { SimpleStruct.new({ required_string: 'bar' }) => 'bar' }
+    assert_valid struct
+  end
+
+  def test_fails_if_nested_map_value_is_invalid
+    struct = MapValueExample.new
+    struct.required_map = { 'foo' => SimpleStruct.new }
+    refute_valid struct
+  end
+
+  def test_fails_if_optional_nested_map_value_is_invalid
+    struct = MapValueExample.new
+    struct.required_map = { 'foo' => SimpleStruct.new({ required_string: 'foo' }) }
+    struct.required_map = { 'foo' => SimpleStruct.new }
+    refute_valid struct
+  end
+
+  def test_passes_if_optional_and_required_valid_map_values_are_given
+    struct = MapValueExample.new
+    struct.required_map = { 'foo' => SimpleStruct.new({ required_string: 'foo' }) }
+    struct.optional_map = { 'foo' => SimpleStruct.new({ required_string: 'bar' }) }
+    assert_valid struct
+  end
+
+  private
+
+  def refute_valid(struct)
+    assert_raises Thrift::ProtocolException, 'Incorrect validation' do
+      Thrift::Validator.new.validate(struct)
+    end
+  end
+
+  def assert_valid(struct)
+    Thrift::Validator.new.validate(struct)
+  rescue Thrift::ProtocolException => ex
+    flunk ex
+  end
+end

data/test/test_helper.rb

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

data/test.thrift

@@ -0,0 +1,29 @@
+struct SimpleStruct  {
+  1: required string required_string
+  2: optional string optional_string
+}
+
+struct NestedExample {
+  1: required SimpleStruct required_struct
+  2: optional SimpleStruct optional_struct
+}
+
+struct ListExample {
+  1: required list<SimpleStruct> required_list
+  2: optional list<SimpleStruct> optional_list
+}
+
+struct SetExample {
+  1: required set<SimpleStruct> required_set
+  2: optional set<SimpleStruct> optional_set
+}
+
+struct MapKeyExample {
+  1: required map<SimpleStruct, string> required_map
+  2: optional map<SimpleStruct, string> optional_map
+}
+
+struct MapValueExample {
+  1: required map<string, SimpleStruct> required_map
+  2: optional map<string, SimpleStruct> optional_map
+}

data/thrift-validator.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/validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "thrift-validator"
+  spec.version       = Thrift::Validator::VERSION
+  spec.authors       = ["ahawkins"]
+  spec.email         = ["adam@hawkins.io"]
+  spec.summary       = %q{Recursive thrift struct validator}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/saltside/thrift-validator-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,122 @@
+#
+# 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
+  REQUIRED_STRING = 1
+  OPTIONAL_STRING = 2
+
+  FIELDS = {
+    REQUIRED_STRING => {:type => ::Thrift::Types::STRING, :name => 'required_string'},
+    OPTIONAL_STRING => {:type => ::Thrift::Types::STRING, :name => 'optional_string', :optional => true}
+  }
+
+  def struct_fields; FIELDS; end
+
+  def validate
+    raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field required_string is unset!') unless @required_string
+  end
+
+  ::Thrift::Struct.generate_accessors self
+end
+
+class NestedExample
+  include ::Thrift::Struct, ::Thrift::Struct_Union
+  REQUIRED_STRUCT = 1
+  OPTIONAL_STRUCT = 2
+
+  FIELDS = {
+    REQUIRED_STRUCT => {:type => ::Thrift::Types::STRUCT, :name => 'required_struct', :class => ::SimpleStruct},
+    OPTIONAL_STRUCT => {:type => ::Thrift::Types::STRUCT, :name => 'optional_struct', :class => ::SimpleStruct, :optional => true}
+  }
+
+  def struct_fields; FIELDS; end
+
+  def validate
+    raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field required_struct is unset!') unless @required_struct
+  end
+
+  ::Thrift::Struct.generate_accessors self
+end
+
+class ListExample
+  include ::Thrift::Struct, ::Thrift::Struct_Union
+  REQUIRED_LIST = 1
+  OPTIONAL_LIST = 2
+
+  FIELDS = {
+    REQUIRED_LIST => {:type => ::Thrift::Types::LIST, :name => 'required_list', :element => {:type => ::Thrift::Types::STRUCT, :class => ::SimpleStruct}},
+    OPTIONAL_LIST => {:type => ::Thrift::Types::LIST, :name => 'optional_list', :element => {:type => ::Thrift::Types::STRUCT, :class => ::SimpleStruct}, :optional => true}
+  }
+
+  def struct_fields; FIELDS; end
+
+  def validate
+    raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field required_list is unset!') unless @required_list
+  end
+
+  ::Thrift::Struct.generate_accessors self
+end
+
+class SetExample
+  include ::Thrift::Struct, ::Thrift::Struct_Union
+  REQUIRED_SET = 1
+  OPTIONAL_SET = 2
+
+  FIELDS = {
+    REQUIRED_SET => {:type => ::Thrift::Types::SET, :name => 'required_set', :element => {:type => ::Thrift::Types::STRUCT, :class => ::SimpleStruct}},
+    OPTIONAL_SET => {:type => ::Thrift::Types::SET, :name => 'optional_set', :element => {:type => ::Thrift::Types::STRUCT, :class => ::SimpleStruct}, :optional => true}
+  }
+
+  def struct_fields; FIELDS; end
+
+  def validate
+    raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field required_set is unset!') unless @required_set
+  end
+
+  ::Thrift::Struct.generate_accessors self
+end
+
+class MapKeyExample
+  include ::Thrift::Struct, ::Thrift::Struct_Union
+  REQUIRED_MAP = 1
+  OPTIONAL_MAP = 2
+
+  FIELDS = {
+    REQUIRED_MAP => {:type => ::Thrift::Types::MAP, :name => 'required_map', :key => {:type => ::Thrift::Types::STRUCT, :class => ::SimpleStruct}, :value => {:type => ::Thrift::Types::STRING}},
+    OPTIONAL_MAP => {:type => ::Thrift::Types::MAP, :name => 'optional_map', :key => {:type => ::Thrift::Types::STRUCT, :class => ::SimpleStruct}, :value => {:type => ::Thrift::Types::STRING}, :optional => true}
+  }
+
+  def struct_fields; FIELDS; end
+
+  def validate
+    raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field required_map is unset!') unless @required_map
+  end
+
+  ::Thrift::Struct.generate_accessors self
+end
+
+class MapValueExample
+  include ::Thrift::Struct, ::Thrift::Struct_Union
+  REQUIRED_MAP = 1
+  OPTIONAL_MAP = 2
+
+  FIELDS = {
+    REQUIRED_MAP => {:type => ::Thrift::Types::MAP, :name => 'required_map', :key => {:type => ::Thrift::Types::STRING}, :value => {:type => ::Thrift::Types::STRUCT, :class => ::SimpleStruct}},
+    OPTIONAL_MAP => {:type => ::Thrift::Types::MAP, :name => 'optional_map', :key => {:type => ::Thrift::Types::STRING}, :value => {:type => ::Thrift::Types::STRUCT, :class => ::SimpleStruct}, :optional => true}
+  }
+
+  def struct_fields; FIELDS; end
+
+  def validate
+    raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field required_map is unset!') unless @required_map
+  end
+
+  ::Thrift::Struct.generate_accessors self
+end
+

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: thrift-validator
+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-validator.rb
+- lib/thrift/validator.rb
+- lib/thrift/validator/version.rb
+- test.thrift
+- test/acceptance_test.rb
+- test/test_helper.rb
+- thrift-validator.gemspec
+- vendor/gen-rb/test_constants.rb
+- vendor/gen-rb/test_types.rb
+homepage: https://github.com/saltside/thrift-validator-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: Recursive thrift struct validator
+test_files:
+- test/acceptance_test.rb
+- test/test_helper.rb