vx-common-amqp 0.2.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d22e0e16e443910a96c0200d9c7e01eec6f9c5b5
+  data.tar.gz: b78374356e36e00925cff0f076673e7adea1f815
+SHA512:
+  metadata.gz: 13c65d9bbbd886758e22d4b712a0792c9386ffb9ecfd72c48c00926f8213efabbb03915b03fa590dac6e7e81c2338ddbd8d16d32a8eb9cd2d11e8e44fb976f22
+  data.tar.gz: 046cab0abc468287b048036bd6491800a4cf3e1f2473a8645e5e9ed18fe139c22cfb1da683b496a03446d234b7f1636ed767f9774dc736eb317bf476dc6d8933

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+-fd
+--color
+--order=rand

data/.travis.yml

@@ -0,0 +1,14 @@
+rvm:
+- 1.9.3
+- 2.0.0
+- jruby-19mode
+
+
+services:
+- rabbitmq
+
+env:
+  global:
+  - JAVA_OPTS="-Djruby.jit.enabled=true"
+
+script: "bundle exec rake SPEC_OPTS='-fd --color --order=rand --tty'"

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,276 @@
+Copyright (c) 2013 Dmitry Galinsky
+
+The GNU General Public License, Version 2, June 1991 (GPLv2)
+============================================================
+
+> Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+> 59 Temple Place, Suite 330
+> Boston, MA  02111-1307 USA
+
+Everyone is permitted to copy and distribute verbatim copies of this license
+document, but changing it is not allowed.
+
+
+Preamble
+--------
+
+The licenses for most software are designed to take away your freedom to share
+and change it. By contrast, the GNU General Public License is intended to
+guarantee your freedom to share and change free software--to make sure the
+software is free for all its users. This General Public License applies to most
+of the Free Software Foundation's software and to any other program whose
+authors commit to using it. (Some other Free Software Foundation software is
+covered by the GNU Library General Public License instead.) You can apply it to
+your programs, too.
+
+When we speak of free software, we are referring to freedom, not price. Our
+General Public Licenses are designed to make sure that you have the freedom to
+distribute copies of free software (and charge for this service if you wish),
+that you receive source code or can get it if you want it, that you can change
+the software or use pieces of it in new free programs; and that you know you can
+do these things.
+
+To protect your rights, we need to make restrictions that forbid anyone to deny
+you these rights or to ask you to surrender the rights. These restrictions
+translate to certain responsibilities for you if you distribute copies of the
+software, or if you modify it.
+
+For example, if you distribute copies of such a program, whether gratis or for a
+fee, you must give the recipients all the rights that you have. You must make
+sure that they, too, receive or can get the source code. And you must show them
+these terms so they know their rights.
+
+We protect your rights with two steps: (1) copyright the software, and (2) offer
+you this license which gives you legal permission to copy, distribute and/or
+modify the software.
+
+Also, for each author's protection and ours, we want to make certain that
+everyone understands that there is no warranty for this free software. If the
+software is modified by someone else and passed on, we want its recipients to
+know that what they have is not the original, so that any problems introduced by
+others will not reflect on the original authors' reputations.
+
+Finally, any free program is threatened constantly by software patents. We wish
+to avoid the danger that redistributors of a free program will individually
+obtain patent licenses, in effect making the program proprietary. To prevent
+this, we have made it clear that any patent must be licensed for everyone's free
+use or not licensed at all.
+
+The precise terms and conditions for copying, distribution and modification
+follow.
+
+
+Terms And Conditions For Copying, Distribution And Modification
+---------------------------------------------------------------
+0.  This License applies to any program or other work which contains a notice
+    placed by the copyright holder saying it may be distributed under the terms
+    of this General Public License. The "Program", below, refers to any such
+    program or work, and a "work based on the Program" means either the Program
+    or any derivative work under copyright law: that is to say, a work
+    containing the Program or a portion of it, either verbatim or with
+    modifications and/or translated into another language. (Hereinafter,
+    translation is included without limitation in the term "modification".)
+    Each licensee is addressed as "you".
+
+    Activities other than copying, distribution and modification are not
+    covered by this License; they are outside its scope. The act of running the
+    Program is not restricted, and the output from the Program is covered only
+    if its contents constitute a work based on the Program (independent of
+    having been made by running the Program). Whether that is true depends on
+    what the Program does.
+
+1.  You may copy and distribute verbatim copies of the Program's source code as
+    you receive it, in any medium, provided that you conspicuously and
+    appropriately publish on each copy an appropriate copyright notice and
+    disclaimer of warranty; keep intact all the notices that refer to this
+    License and to the absence of any warranty; and give any other recipients
+    of the Program a copy of this License along with the Program.
+
+    You may charge a fee for the physical act of transferring a copy, and you
+    may at your option offer warranty protection in exchange for a fee.
+
+2.  You may modify your copy or copies of the Program or any portion of it,
+    thus forming a work based on the Program, and copy and distribute such
+    modifications or work under the terms of Section 1 above, provided that you
+    also meet all of these conditions:
+
+    a)  You must cause the modified files to carry prominent notices stating
+        that you changed the files and the date of any change.
+
+    b)  You must cause any work that you distribute or publish, that in whole
+        or in part contains or is derived from the Program or any part thereof,
+        to be licensed as a whole at no charge to all third parties under the
+        terms of this License.
+
+    c)  If the modified program normally reads commands interactively when run,
+        you must cause it, when started running for such interactive use in the
+        most ordinary way, to print or display an announcement including an
+        appropriate copyright notice and a notice that there is no warranty (or
+        else, saying that you provide a warranty) and that users may
+        redistribute the program under these conditions, and telling the user
+        how to view a copy of this License. (Exception: if the Program itself
+        is interactive but does not normally print such an announcement, your
+        work based on the Program is not required to print an announcement.)
+
+    These requirements apply to the modified work as a whole. If identifiable
+    sections of that work are not derived from the Program, and can be
+    reasonably considered independent and separate works in themselves, then
+    this License, and its terms, do not apply to those sections when you
+    distribute them as separate works. But when you distribute the same
+    sections as part of a whole which is a work based on the Program, the
+    distribution of the whole must be on the terms of this License, whose
+    permissions for other licensees extend to the entire whole, and thus to
+    each and every part regardless of who wrote it.
+
+    Thus, it is not the intent of this section to claim rights or contest your
+    rights to work written entirely by you; rather, the intent is to exercise
+    the right to control the distribution of derivative or collective works
+    based on the Program.
+
+    In addition, mere aggregation of another work not based on the Program with
+    the Program (or with a work based on the Program) on a volume of a storage
+    or distribution medium does not bring the other work under the scope of
+    this License.
+
+3.  You may copy and distribute the Program (or a work based on it, under
+    Section 2) in object code or executable form under the terms of Sections 1
+    and 2 above provided that you also do one of the following:
+
+    a)  Accompany it with the complete corresponding machine-readable source
+        code, which must be distributed under the terms of Sections 1 and 2
+        above on a medium customarily used for software interchange; or,
+
+    b)  Accompany it with a written offer, valid for at least three years, to
+        give any third party, for a charge no more than your cost of physically
+        performing source distribution, a complete machine-readable copy of the
+        corresponding source code, to be distributed under the terms of
+        Sections 1 and 2 above on a medium customarily used for software
+        interchange; or,
+
+    c)  Accompany it with the information you received as to the offer to
+        distribute corresponding source code. (This alternative is allowed only
+        for noncommercial distribution and only if you received the program in
+        object code or executable form with such an offer, in accord with
+        Subsection b above.)
+
+    The source code for a work means the preferred form of the work for making
+    modifications to it. For an executable work, complete source code means all
+    the source code for all modules it contains, plus any associated interface
+    definition files, plus the scripts used to control compilation and
+    installation of the executable. However, as a special exception, the source
+    code distributed need not include anything that is normally distributed (in
+    either source or binary form) with the major components (compiler, kernel,
+    and so on) of the operating system on which the executable runs, unless
+    that component itself accompanies the executable.
+
+    If distribution of executable or object code is made by offering access to
+    copy from a designated place, then offering equivalent access to copy the
+    source code from the same place counts as distribution of the source code,
+    even though third parties are not compelled to copy the source along with
+    the object code.
+
+4.  You may not copy, modify, sublicense, or distribute the Program except as
+    expressly provided under this License. Any attempt otherwise to copy,
+    modify, sublicense or distribute the Program is void, and will
+    automatically terminate your rights under this License. However, parties
+    who have received copies, or rights, from you under this License will not
+    have their licenses terminated so long as such parties remain in full
+    compliance.
+
+5.  You are not required to accept this License, since you have not signed it.
+    However, nothing else grants you permission to modify or distribute the
+    Program or its derivative works. These actions are prohibited by law if you
+    do not accept this License. Therefore, by modifying or distributing the
+    Program (or any work based on the Program), you indicate your acceptance of
+    this License to do so, and all its terms and conditions for copying,
+    distributing or modifying the Program or works based on it.
+
+6.  Each time you redistribute the Program (or any work based on the Program),
+    the recipient automatically receives a license from the original licensor
+    to copy, distribute or modify the Program subject to these terms and
+    conditions. You may not impose any further restrictions on the recipients'
+    exercise of the rights granted herein. You are not responsible for
+    enforcing compliance by third parties to this License.
+
+7.  If, as a consequence of a court judgment or allegation of patent
+    infringement or for any other reason (not limited to patent issues),
+    conditions are imposed on you (whether by court order, agreement or
+    otherwise) that contradict the conditions of this License, they do not
+    excuse you from the conditions of this License. If you cannot distribute so
+    as to satisfy simultaneously your obligations under this License and any
+    other pertinent obligations, then as a consequence you may not distribute
+    the Program at all. For example, if a patent license would not permit
+    royalty-free redistribution of the Program by all those who receive copies
+    directly or indirectly through you, then the only way you could satisfy
+    both it and this License would be to refrain entirely from distribution of
+    the Program.
+
+    If any portion of this section is held invalid or unenforceable under any
+    particular circumstance, the balance of the section is intended to apply
+    and the section as a whole is intended to apply in other circumstances.
+
+    It is not the purpose of this section to induce you to infringe any patents
+    or other property right claims or to contest validity of any such claims;
+    this section has the sole purpose of protecting the integrity of the free
+    software distribution system, which is implemented by public license
+    practices. Many people have made generous contributions to the wide range
+    of software distributed through that system in reliance on consistent
+    application of that system; it is up to the author/donor to decide if he or
+    she is willing to distribute software through any other system and a
+    licensee cannot impose that choice.
+
+    This section is intended to make thoroughly clear what is believed to be a
+    consequence of the rest of this License.
+
+8.  If the distribution and/or use of the Program is restricted in certain
+    countries either by patents or by copyrighted interfaces, the original
+    copyright holder who places the Program under this License may add an
+    explicit geographical distribution limitation excluding those countries, so
+    that distribution is permitted only in or among countries not thus excluded.
+    In such case, this License incorporates the limitation as if written in
+    the body of this License.
+
+9.  The Free Software Foundation may publish revised and/or new versions of the
+    General Public License from time to time. Such new versions will be similar
+    in spirit to the present version, but may differ in detail to address new
+    problems or concerns.
+
+    Each version is given a distinguishing version number. If the Program
+    specifies a version number of this License which applies to it and "any
+    later version", you have the option of following the terms and conditions
+    either of that version or of any later version published by the Free
+    Software Foundation. If the Program does not specify a version number of
+    this License, you may choose any version ever published by the Free
+    Software Foundation.
+
+10. If you wish to incorporate parts of the Program into other free programs
+    whose distribution conditions are different, write to the author to ask for
+    permission. For software which is copyrighted by the Free Software
+    Foundation, write to the Free Software Foundation; we sometimes make
+    exceptions for this. Our decision will be guided by the two goals of
+    preserving the free status of all derivatives of our free software and of
+    promoting the sharing and reuse of software generally.
+
+
+No Warranty
+-----------
+
+11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR
+    THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+    OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+    PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+    OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+    MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO
+    THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM
+    PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
+    CORRECTION.
+
+12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL
+    ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE
+    THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+    GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+    USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+    DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+    PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+    EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+    SUCH DAMAGES.

data/README.md

@@ -0,0 +1,29 @@
+# Vx::Common::Amqp
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'vx-common-amqp'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vx-common-amqp
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/vx-consumers

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require File.expand_path("../../lib/vx/common/amqp", __FILE__)
+
+begin
+  cli = Vx::Common::AMQP::CLI.new
+  cli.run
+rescue Exception => e
+  STDERR.puts e.message
+  STDERR.puts e.backtrace.join("\n")
+  exit 1
+end

data/lib/vx/common/amqp/cli.rb

@@ -0,0 +1,88 @@
+require 'optparse'
+require 'ostruct'
+
+trap "INT" do
+  Vx::Common::AMQP.shutdown
+end
+
+module Vx
+  module Common
+    module AMQP
+      class CLI
+
+        def initialize
+          @options = parse_options
+        end
+
+        def run
+          require_before_executing
+          load_consumers
+
+          consumers = find_consumers.inject({}) do |a,c|
+            a[c] = 2
+            a
+          end
+
+          supervisor = Common::AMQP::Supervisor::Threaded.new
+          consumers.each do |k,v|
+            v.times do |n|
+              supervisor.add k, :subscribe, n
+            end
+          end
+          supervisor.run
+        end
+
+        private
+
+          def find_consumers
+            Vx::Common::AMQP::Consumer.classes.inject([]) do |a,c|
+              c = Kernel.const_get(c)
+              a << c if c.method_defined? :perform
+              a
+            end.uniq
+          end
+
+          def load_consumers
+            if l = @options[:load_from]
+              path = File.expand_path(l, Dir.pwd)
+              Dir["#{path}/**.rb"].each do |f|
+                load f
+              end
+            end
+          end
+
+          def require_before_executing
+            if r = @options[:require]
+              require File.expand_path(r, Dir.pwd)
+            end
+          end
+
+          def parse_options
+            options = {}
+
+            OptionParser.new do |opts|
+              opts.banner = "Usage: amqp_consumers [options]"
+
+              opts.on("-r", "--require FILE", String, 'Require file before executing') do |r|
+                options[:require] = r
+              end
+
+              opts.on("-l", "--load DIR", "Load consumers from directory") do |l|
+                options[:load_from] = l
+              end
+
+              opts.on("-c", "--consumer CONSUMER[,NUM]", "a", "b") do |l|
+                name,num = l.split(",")
+                num ||= 1
+                options[:consumers] ||= []
+                options[:consumers] << [name, num.to_i]
+              end
+            end.parse!
+
+            options
+          end
+
+      end
+    end
+  end
+end

data/lib/vx/common/amqp/config.rb

@@ -0,0 +1,74 @@
+require 'logger'
+require 'vx/common/rack/builder'
+
+module Vx
+  module Common
+    module AMQP
+      class Config
+
+        attr_accessor :url, :default_exchange_options, :default_queue_options,
+          :default_publish_options, :default_exchange_type, :logger, :pool_timeout,
+          :heartbeat, :spawn_attempts, :content_type, :callbacks
+
+        def initialize
+          reset!
+        end
+
+        def formatter
+          Common::AMQP::Formatter
+        end
+
+        %w{ before after }.each do |p|
+          %w{ subscribe publish recieve }.each do |m|
+            define_method "#{p}_#{m}" do |&callback|
+              callbacks["#{p}_#{m}".to_sym] = callback
+            end
+          end
+        end
+
+        def on_error(&block)
+          callbacks[:on_error] = block
+        end
+
+        def default_exchange_name
+          "amq.#{default_exchange_type}"
+        end
+
+        def reset!
+          @url                   = nil
+          @logger                = ::Logger.new(STDOUT)
+          @default_exchange_type = :topic
+          @pool_timeout          = 0.1
+          @heartbeat             = 10
+
+          @publishing_builder    = nil
+          @recieving_builder     = nil
+          @subscribing_builder   = nil
+
+          @spawn_attempts        = 5
+
+          @content_type          = 'application/json'
+
+          @callbacks             = {}
+
+          @default_exchange_options = {
+            durable:     true,
+            auto_delete: false
+          }
+
+          @default_queue_options = {
+            durable:     true,
+            autodelete:  false,
+            exclusive:   false
+          }
+
+          @default_publish_options = {
+            durable:     false
+          }
+
+        end
+
+      end
+    end
+  end
+end

data/lib/vx/common/amqp/consumer/ack.rb

@@ -0,0 +1,19 @@
+module Vx
+  module Common
+    module AMQP
+      module Consumer::Ack
+
+        def ack!(multiple = false)
+          self.class.session.channel.ack delivery_info.delivery_tag, multiple
+          debug "commit ##{delivery_info.delivery_tag.to_i}"
+        end
+
+        def nack!(multiple = false, requeue = false)
+          self.class.session.channel.ack delivery_info.delivery_tag, multiple, requeue
+          debug "reject ##{delivery_info.delivery_tag.to_i}"
+        end
+
+      end
+    end
+  end
+end

data/lib/vx/common/amqp/consumer/configuration.rb

@@ -0,0 +1,119 @@
+require 'ostruct'
+require 'thread'
+
+module Vx
+  module Common
+    module AMQP
+      module Consumer::Configuration
+
+        @@consumer_configuration_lock = Mutex.new
+
+        def consumer_configuration
+          @consumer_configuration || reset_consumer_configuration!
+        end
+
+        def reset_consumer_configuration!
+          @@consumer_configuration_lock.synchronize do
+            @consumer_configuration =
+              OpenStruct.new(exchange:      OpenStruct.new(options: {}),
+                             queue:         OpenStruct.new(options: {}),
+                             consumer_name: make_consumer_name,
+                             ack:           false,
+                             content_type:  nil)
+          end
+        end
+
+        %w{ exchange queue }.each do |m|
+          define_method m do |*name, &b|
+            options = name.last.is_a?(Hash) ? name.pop : {}
+            val = b || name.first
+            consumer_configuration.__send__(m).name    = val
+            consumer_configuration.__send__(m).options = options
+          end
+
+          define_method "#{m}_name" do
+            value_maybe_proc(consumer_configuration.__send__(m).name || consumer_name)
+          end
+
+          define_method "#{m}_options" do
+            value_maybe_proc(consumer_configuration.__send__(m).options)
+          end
+        end
+
+        def routing_key(name = nil, &block)
+          val = block || name
+          if val
+            consumer_configuration.routing_key = val
+          else
+            value_maybe_proc consumer_configuration.routing_key
+          end
+        end
+
+        def headers(values = nil, &block)
+          val = block || values
+          if val
+            consumer_configuration.headers = val
+          else
+            value_maybe_proc consumer_configuration.headers
+          end
+        end
+
+        def model(value = nil)
+          consumer_configuration.model = value unless value == nil
+          consumer_configuration.model
+        end
+
+        def content_type(value = nil)
+          consumer_configuration.content_type = value if value
+          consumer_configuration.content_type
+        end
+
+        def ack(value = nil)
+          consumer_configuration.ack = value unless value == nil
+          consumer_configuration.ack
+        end
+
+        def consumer_name
+          consumer_configuration.consumer_name
+        end
+
+        def consumer_id
+          if cid = Thread.current[:vx_amqp_consumer_id]
+            "#{consumer_name}.#{cid}"
+          else
+            consumer_name
+          end
+        end
+
+        def bind_options
+          consumer_configuration.bind_options ||
+            @@consumer_configuration_lock.synchronize do
+              opts = {}
+              opts[:routing_key] = routing_key if routing_key
+              opts[:headers]     = headers     if headers
+              consumer_configuration.bind_options = opts
+            end
+        end
+
+        private
+
+          def value_maybe_proc(val)
+            case val
+            when Proc
+              val.call
+            else
+              val
+            end
+          end
+
+          def make_consumer_name
+            to_s.split("::")
+                .last
+                .scan(/[A-Z][a-z]*/).join("_")
+                .downcase
+          end
+
+      end
+    end
+  end
+end