background_proxy 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c284b354b76f9161cdf34e9e85b5a4b93597aec5
-  data.tar.gz: 676b8fbe4d05b2dd0f2eb65622892316f3d3d0ae
+  metadata.gz: 15ff589853b6e111150313a6f83ac1af9a9411ff
+  data.tar.gz: 3bb144a7034d74feb0a7bea9bccd4022bf3df466
 SHA512:
-  metadata.gz: a972f69b934c0375c53199aceac53624a974280f89ff93358f66b683a236ccf4006e1928668cf69d998aa8e7b04aa7863126dabbdd6a4ef683b3417b42f96292
-  data.tar.gz: 8bf09457fd619f31ab3406130df0b6e30f20052b4bc104d6b255e599e79926faac26d91cefbe0e7fb59a573e4117fd7c4ecfaac57b53de9b7c8b677b40d985af
+  metadata.gz: 323a8165e17c518ed8b97609e419b421890acd73816e1fbcaf8948c97f9c4e854a8d06f8ed836e654b5f5e3a45ea0aafe5a5ad59b16be71ecd1be6d8c8a9568b
+  data.tar.gz: b4459fae673be1dc78a5283c627417e648ea97287c732a492171915251bcd38d3677ed1ec4496d11a6dd354b9bc498d5617a28c0cc2a4a79dd1d7e1b25ed5c55

data/README.md

@@ -1,8 +1,6 @@
 # BackgroundProxy
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/background_proxy`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem provides a proxy interface to background method calls to a background thread. A good case is for an external api request that can be deferred until later (rather than blocking the rest of the request).
 
 ## Installation
 
@@ -22,7 +20,25 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Instead of using your client instance, wrap that client instance in a background proxy. It will create new Thread(s) to handle writing to the client.
+
+```ruby
+# example usage for writing messages to Kafka via the Poseidon gem
+client = Poseidon::Producer.new(...)
+proxy = BackgroundProxy::Proxy.new(client)
+proxy.send_messages([...])
+```
+
+Any message that the wrapped object can handle, the proxy will send through to that model.
+
+**IMPORTANT NOTES**
+* These proxies do not currently clean themselves up until after the request finishes.
+* The clients need to be thread-safe or not have any kind of mutable state (that is mutated).
+
+## Changelog
+
+v0.1.1 - Fix respond_to_missing? (respond_to? won't crash)
+v0.1.0 - Initial release
 
 ## Development
 
@@ -32,5 +48,5 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/background_proxy.
+Bug reports and pull requests are welcome on GitHub at https://github.com/chingor13/background_proxy.
 

data/lib/background_proxy/proxy.rb

@@ -24,7 +24,7 @@ module BackgroundProxy
       end
     end
 
-    def respond_to_missing?(method)
+    def respond_to_missing?(method, include_private = false)
       client.respond_to?(method) || super
     end
 

data/lib/background_proxy/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: background_proxy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jeff Ching
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-30 00:00:00.000000000 Z
+date: 2015-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler