qwirk 0.0.1

data/History.md

@@ -0,0 +1,7 @@
+Qwirk Changelog
+=====================
+
+0.0.1
+-----
+
+ - Initial release

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2011 Clarity Services, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,180 @@
+# qwirk
+
+http://github.com/ClarityServices/qwirk
+
+## Description:
+
+JRuby library for performing background tasks via JMS.
+
+Alpha version.  API still subject to change.
+
+## Features/Problems:
+
+Currently tested only for ActiveMQ
+
+## Install:
+
+  gem install qwirk
+
+## Rails Usage:
+
+TODO: This stuff is all obsolete modern_times documentation.  Look at the examples for usage information.
+
+Create config/jms.yml which might look as follows:
+
+    development_server: &defaults
+      :factory: org.apache.activemq.ActiveMQConnectionFactory
+      :broker_url: tcp://127.0.0.1:61616
+      :require_jars:
+        - <%= Rails.root %>/lib/activemq/activemq-all.jar
+
+    development_vm:
+      <<: *defaults
+      :broker_url: vm://127.0.0.1
+      :object_message_serialization_defered: true
+
+    staging:
+      <<: *defaults
+      :broker_url: tcp://stage2:61616
+      :username: myuser
+      :password: mypassword
+
+    production:
+      <<: *defaults
+      :broker_url: failover://(tcp://msg1:61616,tcp://msg2:61616)?randomize=false&initialReconnectDelay=100&useExponentialBackOff=true&maxCacheSize=524288&trackMessages=true
+      :username: myuser
+      :password: mypassword
+
+In development and test mode, you will notice that there is no configuration defined.  In this case, published messages will cause
+synchronous calls to the Worker's perform method which matches the destination queue or topic.
+This will allow your coworkers to use the functionality
+of the queueing system without having to startup a JMS server.  If you wanted to start up in an actual server-type mode, you
+might set the QWIRK_ENV environment variable to "development_server" to override the Rails.env.  This will allow you to test
+the queueing system without having to make temporary changes to the config file which could accidentally get checked in.
+For staging and production
+modes, you will need to have a JMS server running.  Note that this library has only been tested with ActiveMQ.
+
+Create config/workers.yml which might look as follows:
+
+    development:
+      Analytics:
+        :count: 1
+      Dashboard:
+        :count: 1
+
+    stage1:
+      Analytics:
+        :count: 2
+      Dashboard:
+        :count: 2
+
+    app1: &default_setup
+      Analytics:
+        :count: 2
+      Dashboard:
+        :count: 2
+
+    app2:
+      <<: *default_setup
+
+    app3:
+      <<: *default_setup
+
+In this file, the count represents the number of threads dedicated per worker.  The worker first looks for a key that matches
+the Rails.env.  If it doesn't find one, it will look for a key matching the non-qualified hostname of the machine.  (TODO: Show how to add options
+that get passed to the constructor and a single worker class that operates on 2 different queues).  This file is optional and workers
+can be configured ad-hoc instead.
+
+If you don't want to explicitly define your workers in a config file, you can create them ad-hoc instead.
+Configure your workers by starting jconsole and connecting to
+the manager process.  Go to the MBeans tab and open the tree to
+Qwirk => Manager => Operations => start_worker
+
+Start/stop/increase/decrease workers as needed.  The state is stored in the log directory (by default)
+so you can stop and start the manager and not have to reconfigure your workers.
+
+Create config/initializers/qwirk.rb which might look as follows (TODO: Maybe add or refer to
+examples for registering marshal strategies):
+
+    Qwirk.init_rails
+    # Publishers can be defined wherever appropriate, probably as class variables within the class that uses it
+    $foo_publisher = Qwirk::QueueAdapter::JMS::Publisher.new('Foo')
+
+When creating publishers, you will probably want to store the value in a class variable.  Publishers internally
+make use of a session pool for communicating with the JMS server so you wouldn't want to create a new connection
+every time you published an object.
+
+In your code, queue foo objects:
+
+    $foo_publisher.publish(my_foo_object)
+
+In app/workers, create a FooWorker class:
+
+    class FooWorker
+      include Qwirk::QueueAdapter::JMS::Worker
+      def perform(my_foo_object)
+        # Operate on my_foo_object
+      end
+    end
+
+For the staging and production environment, you will need to startup a Manager process on each machine that handles messages.  You
+might create script/worker_manager as follows (assumes Rails.root/script is in your PATH):
+
+    #!/usr/bin/env runner
+
+    manager = Qwirk.create_rails_manager
+    manager.join
+
+TODO:  Refer to example jsvc daemon script
+
+
+## Multiple Workers For a Virtual Topic:
+
+By default, a worker operates on the queue with the same name as the class minus the Worker postfix.  You can override
+this by explicitily by specifying a queue or a virtual topic instead.  A virtual_topic (ActiveMQ only) allows you to publish to one destination
+and allow for multiple workers to subscribe.  (TODO: need to completely remove the use of topics as every thread for every worker
+receives all messages instead of a group of workers (threads) collectively receiving all messages.  Virtual topics get around this
+problem). For instance, suppose you have the following workers:
+
+    class FooWorker
+      include Qwirk::QueueAdapter::JMS::Worker
+      virtual_topic 'inquiry'
+
+      def perform(my_inquiry)
+        # Operate on my_inquiry
+      end
+    end
+
+    class BarWorker
+      include Qwirk::QueueAdapter::JMS::Worker
+      virtual_topic 'inquiry'
+
+      def perform(my_inquiry)
+        # Operate on my_inquiry
+      end
+    end
+
+Then you can create a publisher where messages are delivered to both workers:
+
+    @@publisher = Qwirk::QueueAdapter::JMS::Publisher.new(:virtual_topic_name => 'inquiry')
+    ...
+    @@publisher.publish(my_inquiry)
+
+
+## Requestor Pattern:
+
+TODO: See examples/requestor
+
+
+## Requestor Pattern with Multiple RequestWorkers:
+
+TODO: See examples/advanced_requestor
+
+
+## Author
+
+Brad Pardee
+
+## Copyright
+
+Copyright (c) 2012 Clarity Services. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,34 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Qwirk'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/examples/README

@@ -0,0 +1 @@
+Modify the qwirk.yml file to setup the proper credentials for you ActiveMQ server.

data/examples/activemq.xml

@@ -0,0 +1,84 @@
+<!--
+    ActiveMQ Configuration where the Broker is in-vm
+
+    Settings objectives:
+    - Use available resources
+    - No indefinite limiting of producers to prevent "hanging" of producers
+      when consumers are slow
+    - Use store based message flow so that slow consumers do not slow down producers
+-->
+<beans
+  xmlns="http://www.springframework.org/schema/beans"
+  xmlns:amq="http://activemq.apache.org/schema/core"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
+  http://activemq.apache.org/schema/core http://activemq.apache.org/schema/core/activemq-core.xsd">
+
+    <broker xmlns="http://activemq.apache.org/schema/core" brokerName="qwirk" dataDirectory="tmp" destroyApplicationContextOnStop="true">
+
+        <!-- Set producerFlowControl limits -->
+        <destinationPolicy>
+            <policyMap>
+                <policyEntries>
+                    <policyEntry topic=">" producerFlowControl="true" memoryLimit="1024mb" />
+                    <policyEntry queue=">" producerFlowControl="true" memoryLimit="1024mb" />
+                </policyEntries>
+            </policyMap>
+        </destinationPolicy>
+
+        <!-- Use the JMX context already created by the JVM -->
+        <managementContext>
+            <managementContext createConnector="false"/>
+        </managementContext>
+
+        <!--
+            Configure message persistence for the broker. The default persistence
+            mechanism is the KahaDB store (identified by the kahaDB tag).
+            For more information, see:
+
+            http://activemq.apache.org/persistence.html
+        -->
+        <persistenceAdapter>
+            <kahaDB directory="tmp/kahadb"/>
+        </persistenceAdapter>
+
+        <plugins>
+            <!-- Configure authentication of remote connections -->
+            <simpleAuthenticationPlugin>
+                <users>
+                    <authenticationUser username="qwirkadmin" password="qwirkadmin" groups="users,admins"/>
+                    <authenticationUser username="qwirk" password="qwirk" groups="users"/>
+                </users>
+            </simpleAuthenticationPlugin>
+        </plugins>
+
+        <!-- Limits for the broker before it slows down or fails producers.
+             Cause producers to fail with javax.jms.ResourceAllocationException
+             if no space is available after 3 seconds -->
+        <systemUsage>
+            <systemUsage sendFailIfNoSpaceAfterTimeout="3000">
+                <!-- Memory limit for NON_PERSISTENT messages
+                     Apparently no longer used since ActiveMQ 5 now uses store
+                     based cursors for NON_PERSISTENT messages -->
+                <memoryUsage>
+                    <memoryUsage limit="2 gb"/>
+                </memoryUsage>
+                <!-- Disk storage limit for PERSISTENT messages -->
+                <storeUsage>
+                    <storeUsage limit="50 gb"/>
+                </storeUsage>
+                <!-- Disk storage limit for temporary (NON_PERSISTENT) messages -->
+                <tempUsage>
+                    <tempUsage limit="50 gb"/>
+                </tempUsage>
+            </systemUsage>
+        </systemUsage>
+
+        <!-- Allow remote connections using openwire protocols -->
+        <transportConnectors>
+            <transportConnector name="openwire" uri="tcp://0.0.0.0:61616"/>
+        </transportConnectors>
+
+    </broker>
+
+</beans>