alephant-publisher 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a5bbb93c60c689ce1f69b65a986b7e93717df1e
-  data.tar.gz: 03ed87d84d8464a6851fb4d35f639988cf8d57d7
+  metadata.gz: bacfbe3bd9b3fa1e06d05b6c1041e7e30d7c6e64
+  data.tar.gz: b58a5689a5a9f4028f6ac4c565801bc83ef18203
 SHA512:
-  metadata.gz: bfeba287b7109b70a12e04d3c3d694398096a0ff440ed1b3a344cadcdc2acccf67803b0ef8dd56df1799f9fbf0b2926fb35b056d00f6e79847f9132f5e94b210
-  data.tar.gz: 2ed0c9650818a0b1f5e68aac83d1286787e781ed7ddae6463e8d019cf9a7d32ffa892a5082b8b5386e0b7d4d445613f3be83b67fd3fcee240631bec3d5102f42
+  metadata.gz: fecb4254a1c8bd0cb72ea7e3b01f1ba3641b9dabc6ffc4c6fb90ed6066dca1df1504cb991c5fe454c015a1fdec5c7cd137201eeafa7cb2caf7c132b0916b8673
+  data.tar.gz: 09be2c0a1557a66538b2f83f46a4dc0069d99ca2898be8960c42bdaa74d36d22cf8d63d7f83be914f20c2107bdc3028bb8dabd8c7f3fbc20255dddc43e2a12b4

data/README.md

@@ -67,6 +67,47 @@ thread = Alephant::Alephant.new(opts, logger).run!
 thread.join
 ```
 
+Publisher requires both queue options and writer options to be provided. To ensure a standard format you should use the `Options` class to generate your options before passing them onto the Publisher...
+
+```ruby
+opts = Alephant::Publisher::Options.new
+# => #<Alephant::Publisher::Options:0x0602f958 @queue={}, @writer={}>
+
+opts.queue
+# => {}
+# empty to start with
+
+opts.writer
+# => {}
+# empty to start with
+
+opts.add_queue(:foo => "bar")
+# The key 'foo' is invalid
+# => nil
+
+opts.queue
+# => {}
+# still empty as the foo key was invalid
+
+opts.add_queue(:sqs_queue_url => "bar")
+# => {:sqs_queue_url=>"bar"}
+
+opts.queue
+# => {:sqs_queue_url=>"bar"}
+
+opts.add_writer(:sqs_queue_url => "bar")
+# The key 'sqs_queue_url' is invalid
+# => nil
+# the sqs_queue_url key was valid for the queue options,
+# but is invalid when trying to add it to the writer options
+
+opts.add_writer(:msg_vary_id_path => "bar")
+=> {:msg_vary_id_path=>"bar"}
+
+opts.writer
+=> {:msg_vary_id_path=>"bar"}
+```
+
 logger is optional, and must confirm to the Ruby standard logger interface
 
 Provide a view in a folder (fixtures are optional):

data/lib/alephant/publisher.rb

@@ -1,6 +1,7 @@
 require_relative 'env'
 
 require 'alephant/publisher/version'
+require 'alephant/publisher/options'
 require 'alephant/publisher/queue'
 require 'alephant/publisher/writer'
 require 'alephant/logger'
@@ -23,24 +24,12 @@ module Alephant
         ::Alephant::Logger.set_logger(logger) unless logger.nil?
 
         @opts = opts
+
         @queue = Queue.new(
-          opts[:sqs_queue_url],
-          opts[:visibility_timeout] || VISIBILITY_TIMEOUT,
-          opts[:receive_wait_time]  || RECEIVE_WAIT_TIME,
+          opts.queue[:sqs_queue_url],
+          opts.queue[:visibility_timeout] || VISIBILITY_TIMEOUT,
+          opts.queue[:receive_wait_time]  || RECEIVE_WAIT_TIME,
         )
-
-        @writer_opts = opts.select do |k,v|
-          [
-            :msg_vary_id_path,
-            :sequencer_table_name,
-            :sequence_id_path,
-            :renderer_id,
-            :s3_bucket_id,
-            :s3_object_path,
-            :view_path,
-            :lookup_table_name
-          ].include? k
-        end
       end
 
       def run!
@@ -51,7 +40,7 @@ module Alephant
 
       def process(msg)
         unless msg.nil?
-          Writer.new(@writer_opts, msg).run!
+          Writer.new(@opts.writer, msg).run!
           msg.delete
         end
       end

data/lib/alephant/publisher/options.rb

@@ -0,0 +1,59 @@
+require 'aws-sdk'
+require 'alephant/logger'
+
+module Alephant
+  module Publisher
+    class InvalidKeySpecifiedError < StandardError; end
+
+    class Options
+      attr_reader :queue, :writer
+
+      QUEUE_OPTS = [
+        :receive_wait_time,
+        :sqs_queue_url,
+        :visibility_timeout
+      ]
+
+      WRITER_OPTS = [
+        :lookup_table_name,
+        :msg_vary_id_path,
+        :renderer_id,
+        :s3_bucket_id,
+        :s3_object_path,
+        :sequence_id_path,
+        :sequencer_table_name,
+        :view_path
+      ]
+
+      def initialize
+        @queue  = {}
+        @writer = {}
+      end
+
+      def add_queue(opts)
+        execute @queue, QUEUE_OPTS, opts
+      end
+
+      def add_writer(opts)
+        execute @writer, WRITER_OPTS, opts
+      end
+
+      private
+
+      def execute(instance, type, opts)
+        begin
+          validate type, opts
+          instance.merge! opts
+        rescue Exception => e
+          puts e.message
+        end
+      end
+
+      def validate(type, opts)
+        opts.each do |key, value|
+          raise InvalidKeySpecifiedError, "The key '#{key}' is invalid" unless type.include? key.to_sym
+        end
+      end
+    end
+  end
+end

data/lib/alephant/publisher/version.rb

@@ -1,5 +1,5 @@
 module Alephant
   module Publisher
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

data/spec/publisher_spec.rb

@@ -1,7 +1,8 @@
 require 'spec_helper'
 
 describe Alephant::Publisher do
-  let(:instance) { Alephant::Publisher.create }
+  let(:options)  { Alephant::Publisher::Options.new }
+  let(:instance) { Alephant::Publisher.create(options) }
 
   before(:each) do
     Alephant::Publisher::Queue.any_instance.stub(:initialize)
@@ -9,8 +10,7 @@ describe Alephant::Publisher do
 
   describe "#initialize(opts = {}, logger)" do
     it "sets parser, sequencer, queue and writer" do
-      expect(instance.queue).to     be_a Alephant::Publisher::Queue
+      expect(instance.queue).to be_a Alephant::Publisher::Queue
     end
   end
 end
-

data/spec/writer_spec.rb

@@ -3,14 +3,14 @@ require 'spec_helper'
 describe Alephant::Publisher::Writer do
   let(:opts) do
     {
-      :s3_bucket_id => :s3_bucket_id,
-      :s3_object_path => :s3_object_path,
-      :renderer_id => :renderer_id,
-      :view_path => :view_path,
-      :lookup_table_name => 'lookup_table_name',
+      :lookup_table_name    => 'lookup_table_name',
+      :msg_vary_id_path     => '$.vary',
+      :renderer_id          => :renderer_id,
+      :s3_bucket_id         => :s3_bucket_id,
+      :s3_object_path       => :s3_object_path,
+      :sequence_id_path     => '$.sequence',
       :sequencer_table_name => :sequencer_table_name,
-      :sequence_id_path => '$.sequence',
-      :msg_vary_id_path => '$.vary',
+      :view_path            => :view_path
     }
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alephant-publisher
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Integralist
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-04-08 00:00:00.000000000 Z
+date: 2014-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -363,6 +363,7 @@ files:
 - alephant-publisher.gemspec
 - lib/alephant/env.rb
 - lib/alephant/publisher.rb
+- lib/alephant/publisher/options.rb
 - lib/alephant/publisher/queue.rb
 - lib/alephant/publisher/render_mapper.rb
 - lib/alephant/publisher/version.rb
@@ -410,3 +411,4 @@ test_files:
 - spec/render_mapper_spec.rb
 - spec/spec_helper.rb
 - spec/writer_spec.rb
+has_rdoc: