sidekiq-thrift_arguments 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8bd6d2c719d60decd03a9eb65143dfff7e07169d
+  data.tar.gz: a2b4b0b813b5fc7c39424a1757d307a17f8f62c1
+SHA512:
+  metadata.gz: ee528c07110634f3c83c43638c6e2cbdcc98917f55dfe96610d8520605b3b2aa06b785d8a9ffa7b34286db89d0803e04c4e1589787f89b79c56deb15929b7dc1
+  data.tar.gz: ed12e8b18aa8de20f69acf0982717500001b603544ce366e1c601c4131211af7cf626b6a904ecbde67633629bbac3f890ba41ed9f89be74e2b8f593554cbd9c6

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 sidekiq-thrift_job.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,76 @@
+# Sidekiq::ThriftArguments
+
+This library transparent handles and serializing & deserializing
+`Thrift::Struct` instances used as job arguments. This is a tedious
+process because `Thrift::Struct` instances **cannot** be used
+transparently with `JSON.dump` and `JSON.load`. The internal JSON
+serializers must be used. So in pratice there would be code like this:
+
+```ruby
+class SomeWorker
+  include Sidekiq::Worker
+
+  def perform(json_blob)
+    deserializer = Thrift::Deserializer.new Thrift::JsonProtocolFactory.new
+	struct = deserializer.deserialize(MyThriftStruct.new, json_blob)
+
+	# do the work ...
+  end
+end
+
+serializer = Thrift::Serializer.new Thrift::JsonProtocolFactory.new
+SomeWorker.perform_async serializer.serialize(some_thrift_struct)
+```
+
+This code functions as you'd expect. First, serialize the thrift
+struct to a JSON string. The worker class accepts a serialized thrift
+blob it can deserialize into the required object. This is fine and
+dandy when you have a few classes. It gets out of hand when you have
+repeated the same thing in the same codebase and then across multiple
+codebases. There is also a slight problem in that you must know the
+class you want to deserialize into. This makes it hard to abstract the
+code in some cases. This library solves this problem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-thrift_arguments'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-thrift_arguments
+
+## Usage
+
+Usage is simple. `include Sidekiq::ThriftArguments` after including
+`Sidekiq::Worker`. Here's an example:
+
+```ruby
+class ThriftWorker
+  include Sidekiq::Worker
+  # Important! You need to include this after, not before.
+  include Sidekiq::ThriftArguments
+end
+```
+
+Now you can call `perform_async` and `perform` with `Thrift::Struct`
+instances as you would with any other method.
+
+## Testing
+
+    $ make test
+
+## Contributing
+
+1. Fork it ( https://github.com/saltside/sidekiq-thrift_arguements/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 "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.test_files = Rake::FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/lib/sidekiq-thrift_arguments.rb

@@ -0,0 +1 @@
+require 'sidekiq/thrift_arguments'

data/lib/sidekiq/thrift_arguments.rb

@@ -0,0 +1,48 @@
+require 'thrift'
+require 'thrift/utf8_json'
+require 'sidekiq'
+
+module Sidekiq
+  module ThriftArguments
+    class << self
+      def included(base)
+        base.extend ArgumentEncoder
+        base.prepend ArgumentDecoder
+      end
+    end
+
+    module ArgumentEncoder
+      def perform_async(*args)
+        thrift_encoded = args.map do |argument|
+          case argument
+          when Thrift::Struct
+            {
+              '__thrift__' => true,
+              '__thrift_class__' => argument.class.name,
+              '__thrift_blob__' => Thrift::JsonSerializer.new.serialize(argument)
+            }
+          else
+            argument
+          end
+        end
+
+        super(*thrift_encoded)
+      end
+    end
+  end
+
+  module ArgumentDecoder
+    def perform(*args)
+      decoded = args.map do |argument|
+        if argument.is_a?(Hash) && argument.key?('__thrift__')
+          klass, blob = argument.fetch('__thrift_class__'), argument.fetch('__thrift_blob__')
+          Thrift::JsonDeserializer.new.deserialize(klass.constantize.new, blob)
+        else
+          argument
+        end
+      end
+
+      super(*decoded)
+    end
+  end
+end

data/sidekiq-thrift_arguments.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-thrift_arguments"
+  spec.version       = "0.1.0"
+  spec.authors       = ["ahawkins"]
+  spec.email         = ["adam@hawkins.io"]
+  spec.summary       = %q{Transparently serialize/deserialize Thirft structs used a Sidekiq job arguments}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/saltside/sidekiq-thrift_arguments"
+  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 "sidekiq"
+  spec.add_dependency "thrift-utf8_json"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/test.thrift

@@ -0,0 +1,3 @@
+struct Person  {
+  1: required string name
+}

data/test/acceptance_test.rb

@@ -0,0 +1,42 @@
+require_relative 'test_helper'
+
+class AcceptanceTest < MiniTest::Unit::TestCase
+  class CountPeople
+    include Sidekiq::Worker
+    include Sidekiq::ThriftArguments
+
+    COUNTED = [ ]
+
+    class << self
+      def counted
+        COUNTED
+      end
+    end
+
+    # This method uses Person instance and calls a method. It tests the
+    # job does received a deserialized Person instance. It would be nice
+    # to assert on the result of this method, but perform_async only returns
+    # the job id. So here the counted people are stored in a constant so
+    # its members can be referenced after a job is processed.
+    def perform(person, count = true)
+      return unless count
+      COUNTED << person.name
+    end
+  end
+
+  def setup
+    CountPeople.counted.clear
+  end
+
+  def test_roundtrips_thrift_classes
+    Sidekiq::Testing.inline! do
+      person = Person.new name: 'adam'
+
+      CountPeople.perform_async Person.new(name: 'adam'), true
+      CountPeople.perform_async Person.new(name: 'terje'), true
+      CountPeople.perform_async Person.new(name: 'foo'), false
+
+      assert_equal 2, CountPeople.counted.size
+    end
+  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 'sidekiq-thrift_arguments'
+
+Thrift.type_checking = true
+
+require 'sidekiq/testing'
+
+require 'test_types'
+require 'minitest/autorun'

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 Person
+  include ::Thrift::Struct, ::Thrift::Struct_Union
+  NAME = 1
+
+  FIELDS = {
+    NAME => {:type => ::Thrift::Types::STRING, :name => 'name'}
+  }
+
+  def struct_fields; FIELDS; end
+
+  def validate
+    raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field name is unset!') unless @name
+  end
+
+  ::Thrift::Struct.generate_accessors self
+end
+

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-thrift_arguments
+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: sidekiq
+  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: thrift-utf8_json
+  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/sidekiq-thrift_arguments.rb
+- lib/sidekiq/thrift_arguments.rb
+- sidekiq-thrift_arguments.gemspec
+- test.thrift
+- test/acceptance_test.rb
+- test/test_helper.rb
+- vendor/gen-rb/test_constants.rb
+- vendor/gen-rb/test_types.rb
+homepage: https://github.com/saltside/sidekiq-thrift_arguments
+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: Transparently serialize/deserialize Thirft structs used a Sidekiq job arguments
+test_files:
+- test/acceptance_test.rb
+- test/test_helper.rb