thrift-local_type_checking 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9772b1b6974910c8f5c15b94179fe86b3cd14faf
+  data.tar.gz: 1a7aa6a10d187b27edc0691d1697f890c4388796
+SHA512:
+  metadata.gz: a47d81c474861b9400c9397750ec06cc9b4747a9026335ffc39a0df2ac6ecbc7e3a060983da2aba2e8f6548f9b286a9e20ff747fb4ee747b0427be66b10bf398
+  data.tar.gz: b566f8ea4fa8ef8bcc1826943cbad275bfdfb54a963b2e0760c09f281ac4fb8d9058358e6077458d68552af43367186ba3cfc7e25b2bd4b7d42f98f21405f570

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.1.4

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Vicente Reig Rincon de Arellano
+
+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/README.md

@@ -0,0 +1,64 @@
+# Thrift::LocalTypeChecking
+
+[![Circle CI](https://circleci.com/gh/vicentereig/thrift-local_type_checking.svg?style=svg)](https://circleci.com/gh/vicentereig/thrift-local_type_checking)
+
+Enables local type checking per client, as opposed to `Thrift.type_checking = true` flag
+which affects every client running on the client application.
+
+It also recursively validates structs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'thrift-local_type_checking'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install thrift-local_type_checking
+
+## Usage
+
+```thrift
+namespace rb Accounts.V1
+
+struct EmailAddress {
+   1:i64 id
+   2:string email
+}
+
+struct User {
+    1:i64 id
+    2:required list<EmailAddress> emails
+}
+
+struct Account {
+    1:i64 id
+    3:list<User> users
+}
+
+service AccountsService {
+  void create(1:Account account)
+}
+
+```
+
+```ruby
+client  = Accounts::V1::AccountsService::Client.new.extend(Thrift::LocalTypeChecking)
+account = Accounts::V1::Account.new(id: 'not a number! =D', users: nil)
+client.create(account)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/thrift-local_type_checking/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

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require './spec/support/rake/thrift.rb'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/circle.yml

@@ -0,0 +1,3 @@
+test:
+  override:
+    - bundle exec rake spec:thrift:generate spec

data/lib/thrift/local_type_checking/version.rb

@@ -0,0 +1,5 @@
+module Thrift
+  module LocalTypeChecking
+    VERSION = "0.0.1"
+  end
+end

data/lib/thrift/local_type_checking.rb

@@ -0,0 +1,45 @@
+require 'thrift/local_type_checking/version'
+require 'thrift'
+
+module Thrift
+  module LocalTypeChecking
+    def self.extended(*)
+      ::Thrift::Struct.extend(ClassMethods)
+      ::Thrift::Struct.overwrite_initialize
+      ::Thrift::Struct.instance_eval do
+        def method_added(name)
+          return if name != :initialize
+          overwrite_initialize
+        end
+      end
+    end
+
+    module ClassMethods
+      def overwrite_initialize
+        class_eval do
+          unless method_defined?(:custom_initialize)
+            define_method(:custom_initialize) do |d={}|
+              original_initialize(d)
+
+              unless d.empty?
+                d.each do |name, value|
+                  unless name_to_id(name.to_s)
+                    raise Exception, "Unknown key given to #{self.class}.new: #{name}"
+                  end
+                  Thrift.check_type(value, struct_fields[name_to_id(name.to_s)], name)
+                  instance_variable_set("@#{name}", value)
+                end
+              end
+            end
+          end
+
+          if instance_method(:initialize) != instance_method(:custom_initialize)
+            alias_method :original_initialize, :initialize
+            alias_method :initialize, :custom_initialize
+          end
+        end
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$:.unshift(File.expand_path('../lib', __FILE__))
+$:.unshift(File.expand_path('../support/thrift', __FILE__))
+
+require 'rspec'
+require 'byebug'
+
+require 'thrift/local_type_checking'
+require 'accounts_service'
+

data/spec/support/accounts.thrift

@@ -0,0 +1,22 @@
+namespace rb Accounts.V1
+
+struct EmailAddress {
+   1:i64 id
+   2:string email
+}
+
+struct User {
+    1:i64 id
+    2:required list<EmailAddress> emails
+}
+
+struct Account {
+    1:i64 id
+    3:list<User> users
+}
+
+service AccountsService {
+  void create(1:Account account)
+  void set_account_attribute(1:i64 attribute_value)
+  oneway void update(1:Account account)
+}

data/spec/support/rake/thrift.rb

@@ -0,0 +1,8 @@
+namespace :spec do
+  namespace :thrift do
+    desc 'Generate Thrift client and service files'
+    task :generate do
+      sh 'bundle exec thrift --out spec/support/thrift --gen rb spec/support/accounts.thrift'
+    end
+  end
+end

data/spec/thrift/local_type_checking_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe Thrift::LocalTypeChecking do
+
+  it 'has a version number' do
+    expect(Thrift::LocalTypeChecking::VERSION).not_to be nil
+  end
+
+  let(:base_client) { Accounts::V1::AccountsService::Client.new(protocol) }
+
+  describe 'when invoking the default Thrift client with invalid arguments' do
+    let(:protocol) { Thrift::CompactProtocol.new Thrift::MemoryBufferTransport.new }
+
+    describe 'scalars' do
+      let(:invalid_id) { 'should be a number :)'}
+      let(:invalid_users) { nil }
+      let(:invalid_account) { Accounts::V1::Account.new(id: invalid_id, users: invalid_users)}
+
+      it 'should raise a TypeError' do
+        expect {
+          base_client.create(invalid_account)
+        }.to raise_error
+      end
+    end
+
+    describe 'lists' do
+      let(:id) { 1 }
+      let(:invalid_users) { nil }
+      let(:invalid_account) { Accounts::V1::Account.new(id: id, users: invalid_users)}
+
+      it 'should not raise a TypeError' do
+        expect {
+          base_client.create(invalid_account)
+        }.not_to raise_error
+      end
+    end
+  end
+
+  describe 'when invoking the enhaced Thrift client with invalid arguments' do
+    let(:protocol) { Thrift::CompactProtocol.new Thrift::MemoryBufferTransport.new }
+    let(:client) { Accounts::V1::AccountsService::Client.new(protocol).extend(Thrift::LocalTypeChecking)}
+
+    describe 'scalars' do
+      let(:invalid_id) { 'should be a number :)'}
+      let(:invalid_users) { nil }
+      let(:invalid_account) { Accounts::V1::Account.new(id: invalid_id, users: invalid_users)}
+
+      it 'should raise a TypeError' do
+        expect {
+          client.create(invalid_account)
+        }.to raise_error
+      end
+    end
+
+    describe 'lists' do
+      let(:id) { 1 }
+      let(:invalid_users) { nil }
+      let(:invalid_account) { Accounts::V1::Account.new(id: id, users: invalid_users)}
+
+      it 'should not raise a TypeError' do
+        expect {
+          client.create(invalid_account)
+        }.not_to raise_error
+      end
+    end
+
+    describe 'nested structures' do
+      let(:id) { 1 }
+      let(:invalid_emails) { [Accounts::V1::EmailAddress.new(id: 'not a number', email: 'vicente@trolo.com')] }
+      let(:invalid_users) { [Accounts::V1::User.new(emails: invalid_emails)] }
+      let(:invalid_account) { Accounts::V1::Account.new(id: id, users: invalid_users)}
+
+      it 'should not raise a TypeError' do
+        expect {
+          client.create(invalid_account)
+        }.to raise_error Thrift::TypeError, 'Expected Types::I64, received String for field id'
+      end
+    end
+  end
+end

data/thrift-local_type_checking.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'thrift/local_type_checking/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'thrift-local_type_checking'
+  spec.version       = Thrift::LocalTypeChecking::VERSION
+  spec.authors       = ['Vicente Reig Rincón de Arellano']
+  spec.email         = ['vicente.reig@gmail.com']
+  spec.summary       = %q{Enables Type Checking per client}
+  spec.description   = %q{Enables Type Checking per client}
+  spec.homepage      = 'https://github.com/vicentereig/thrift-local_type_checking'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split
+  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_development_dependency 'bundler', '~> 1.6.5'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'byebug'
+  spec.add_dependency 'thrift'
+
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: thrift-local_type_checking
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vicente Reig Rincón de Arellano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.5
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !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'
+description: Enables Type Checking per client
+email:
+- vicente.reig@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- circle.yml
+- lib/thrift/local_type_checking.rb
+- lib/thrift/local_type_checking/version.rb
+- spec/spec_helper.rb
+- spec/support/accounts.thrift
+- spec/support/rake/thrift.rb
+- spec/support/thrift/.gitkeep
+- spec/thrift/local_type_checking_spec.rb
+- thrift-local_type_checking.gemspec
+homepage: https://github.com/vicentereig/thrift-local_type_checking
+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: Enables Type Checking per client
+test_files:
+- spec/spec_helper.rb
+- spec/support/accounts.thrift
+- spec/support/rake/thrift.rb
+- spec/support/thrift/.gitkeep
+- spec/thrift/local_type_checking_spec.rb