expeditor 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28e3d0c9d21f60030c7e591f6fd79c849357b428
-  data.tar.gz: e3fd9e317a4d5fcd3b27bb4f9d4b8c48a03dc436
+  metadata.gz: 9545876fd08d33f5578deccef8bfffd39564c014
+  data.tar.gz: 2b1b2e2e586ac117986965c832326c0398104cae
 SHA512:
-  metadata.gz: 51d080f2f60dde13877de518bdf1ad4893cc98bfa970e3e8ee9891e754445f3564c517beadcec923b62900c44ef97bb0906dcead8dd78d4f7c92f823f186f6c9
-  data.tar.gz: 95753cfcd208ebe0e29ed06a51c69bbf4589d3252e299748a83f13ed17aa326e3a1e68483bbf9b7211a50985309c30b8c8db9de4d7e79b351005495822351fb2
+  metadata.gz: 1ed11e18c6a4c20cf6c80b2beb36481680776b52a167789178b29dc5038368df370b9eb8f58c42fddeeb06f4870ffc0f64fbfb1659a4a1ae000b4365a4df87b5
+  data.tar.gz: ddda85a097bf8cebdb050870d6cdc9b76edd6d37158dbed2f5da6ef69abba40679894e6e13b60576c4f0949aebb529be7d8ba369a4497334ac659ed542d38c56

data/.travis.yml

@@ -1,3 +1,9 @@
 language: ruby
 rvm:
-  - 2.2.1
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.1.1
+- Avoid to use concurrent-ruby 0.9.x. #1
+
+## 0.1.0
+- First release :tada:

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Cookpad Inc.
+
+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

@@ -1,6 +1,10 @@
 # Expeditor
+[![Gem Version](https://badge.fury.io/rb/expeditor.svg)](http://badge.fury.io/rb/expeditor)
+[![Build Status](https://travis-ci.org/cookpad/expeditor.svg?branch=master)](https://travis-ci.org/cookpad/expeditor)
 
-Expeditor is a Ruby library inspired by Netflix/Hystrix.
+Expeditor is a Ruby library that provides asynchronous execution and fault tolerance for microservices.
+
+It is inspired by [Netflix/Hystrix](https://github.com/Netflix/Hystrix).
 
 ## Installation
 
@@ -20,7 +24,119 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### asynchronous execution
+
+```ruby
+command1 = Expeditor::Command.new do
+  ...
+end
+
+command2 = Expeditor::Command.new do
+  ...
+end
+
+command1.start # non blocking
+command2.start # non blocking
+
+command1.get   # wait until command1 execution is finished and get the result
+command2.get   # wait until command2 execution is finished and get the result
+```
+
+### asynchronous execution with dependencies
+
+```ruby
+command1 = Expeditor::Command.new do
+  ...
+end
+
+command2 = Expeditor::Command.new do
+  ...
+end
+
+command3 = Expeditor::Command.new(dependencies: [command1, command2]) do |val1, val2|
+  ...
+end
+
+command3.start # command1 and command2 are started concurrently, execution of command3 is wait until command1 and command2 are finished.
+```
+
+### fallback
+
+```ruby
+command = Expeditor::Command.new do
+  # something that may be failed
+end
+
+# use fallback value if command is failed
+command_with_fallback = command.with_fallback do |e|
+  log(e)
+  default_value
+end
+
+command.start.get #=> error may be raised
+command_with_fallback.start.get #=> default_value if command is failed
+```
+
+### timeout
+
+```ruby
+command = Expeditor::Command.new(timeout: 1) do
+  ...
+end
+
+command.start
+command.get #=> Timeout::Error is raised if execution is timed out
+```
+
+### retry
+
+```ruby
+command = Expeditor::Command.new do
+  ...
+end
+
+# the option is completely same as retryable gem
+command.start_with_retry(
+  tries: 3,
+  sleep: 1,
+  on: [StandardError],
+)
+```
+
+### using thread pool
+
+Expeditor use [concurrent-ruby](https://github.com/ruby-concurrency/concurrent-ruby/)'s executors as thread pool.
+
+```ruby
+require 'concurrent'
+
+service = Expeditor::Service.new(
+  executor: Concurrent::ThreadPoolExecutor.new(
+    min_threads: 0,
+    max_threads: 5,
+    max_queue: 100,
+  )
+)
+
+command = Expeditor::Command.new(service: service) do
+  ...
+end
+```
+
+### circuit breaker
+
+```ruby
+service = Expeditor::Service.new(
+  period: 10,          # retention period of the service metrics (success, failure, timeout, ...)
+  sleep: 1,            # if once the circuit is opened, the circuit is still open until sleep time is passed even though failure rate is less than threshold
+  threshold: 0.5,      # if the failure rate is more than or equal to threshold, the circuit is opened
+  non_break_count: 100 # if the total count of metrics is not more than non_break_count, the circuit is not opened even though failure rate is more than threshold
+)
+
+command = Expeditor::Command.new(service: service) do
+  ...
+end
+```
 
 ## Development
 
@@ -30,7 +146,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/expeditor/fork )
+1. Fork it ( https://github.com/cookpad/expeditor/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`)

data/expeditor.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Expeditor::VERSION
   spec.authors       = ["shohei-yasutake"]
   spec.email         = ["shohei-yasutake@cookpad.com"]
+  spec.license       = "MIT"
 
   spec.summary       = "Expeditor provides asynchronous execution and fault tolerance for microservices"
   spec.description   = "Expeditor provides asynchronous execution and fault tolerance for microservices"
@@ -18,15 +19,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
-  end
-
-  spec.add_runtime_dependency "concurrent-ruby", "~> 0.8"
-  spec.add_runtime_dependency "concurrent-ruby-ext", "~> 0.8"
+  spec.add_runtime_dependency "concurrent-ruby", "0.8.0"
+  spec.add_runtime_dependency "concurrent-ruby-ext", "0.8.0"
   spec.add_runtime_dependency "retryable", "> 1.0"
 
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "3.2.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
 end

data/lib/expeditor/version.rb

@@ -1,3 +1,3 @@
 module Expeditor
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,99 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: expeditor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - shohei-yasutake
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-17 00:00:00.000000000 Z
+date: 2015-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby-ext
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: retryable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.0.0
 description: Expeditor provides asynchronous execution and fault tolerance for microservices
 email:
 - shohei-yasutake@cookpad.com
@@ -101,10 +101,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
@@ -122,28 +124,28 @@ files:
 - lib/expeditor/status.rb
 - lib/expeditor/version.rb
 homepage: https://github.com/cookpad/expeditor
-licenses: []
-metadata:
-  allowed_push_host: 'TODO: Set to ''http://mygemserver.com'' to prevent pushes to
-    rubygems.org, or delete to allow pushes to any server.'
+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.0.14
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Expeditor provides asynchronous execution and fault tolerance for microservices
 test_files: []
+has_rdoc: