alephant-publisher-queue 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43275970bcb48206ee6a00c7f7889a00579fc983
-  data.tar.gz: 48081162062dda40382d065ca4b2e11fb15decf6
+  metadata.gz: 271b65caf5491b610ac599b0b66e2de1b6349006
+  data.tar.gz: f17b0f88a4c71649d72707b922d48e50a0fd66b5
 SHA512:
-  metadata.gz: 3cc53d959cc6c21cc85bbd8f9acf6bd5c2eb74cab2915919a37d69ed0563cfbf3df6fea8db032803b7645dcf12d77c67d7090992d6f6518e2b11a2d49739b4f1
-  data.tar.gz: 07050f7c856a0d1db3bca8396b9fc5bcf832c067c80f41f6c7d67f0f5169334d31ddb65ba0295d3f172233cdf5df6f0d10069ccb6c4a525fdd4d6f677c8c5d00
+  metadata.gz: d0f916092df9a3675158bd99db058cc328b5e0799e5143e4bfd7fe54ae138299c4d93d37681c7ddf900431b570417a6cb048d95288bc22c96e84331a322e90d9
+  data.tar.gz: 9b93abe8ba89c4c50b85b647d693cff72f3342a9c3e0d717545b9cc7708ecc6b7ec71cd38fd5f316bc7c7143e1d0ea2c2985e304b522d1c790e7721753069e94

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 /config/*.yml
 /components
 *.swp
+app.log

data/Gemfile

@@ -1,4 +1,3 @@
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in alephant-publishing.gemspec
 gemspec

data/alephant-publisher-queue.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "alephant/publisher/queue/version"
@@ -26,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-remote"
   spec.add_development_dependency "pry-nav"
-  spec.add_development_dependency 'rake-rspec'
+  spec.add_development_dependency "rake-rspec"
 
   spec.add_runtime_dependency "rake"
   spec.add_runtime_dependency "aws-sdk", "~> 1.0"

data/lib/alephant/publisher/queue/options.rb

@@ -50,7 +50,7 @@ module Alephant
           begin
             validate type, opts
             instance.merge! opts
-          rescue Exception => e
+          rescue InvalidKeySpecifiedError => e
             logger.metric "QueueOptionsInvalidKeySpecified"
             logger.error(
               "event"     => "QueueOptionsKeyInvalid",
@@ -64,8 +64,10 @@ module Alephant
         end
 
         def validate(type, opts)
-          opts.each do |key, value|
-            raise InvalidKeySpecifiedError, "The key '#{key}' is invalid" unless type.include? key.to_sym
+          opts.each do |key, _value|
+            unless type.include? key.to_sym
+              raise InvalidKeySpecifiedError, "The key '#{key}' is invalid"
+            end
           end
         end
       end

data/lib/alephant/publisher/queue/processor/base.rb

@@ -2,11 +2,11 @@ module Alephant
   module Publisher
     module Queue
       class BaseProcessor
-        
         def consume(msg)
-          raise NotImplementedError.new("You must implement the #consume(msg) method")
+          raise NotImplementedError.new(
+            "You must implement the #consume(msg) method"
+          )
         end
-
       end
     end
   end

data/lib/alephant/publisher/queue/sqs_helper/archiver.rb

@@ -68,7 +68,7 @@ module Alephant
           end
 
           def body_for(message)
-             log_message_body ? message.body : "No message body available"
+            log_message_body ? message.body : "No message body available"
           end
 
           def date_key

data/lib/alephant/publisher/queue/sqs_helper/queue.rb

@@ -13,27 +13,35 @@ module Alephant
 
           attr_reader :queue, :timeout, :wait_time, :archiver
 
-          def initialize(queue, archiver = nil, timeout = VISABILITY_TIMEOUT, wait_time = WAIT_TIME)
+          def initialize(
+            queue,
+            archiver  = nil,
+            timeout   = VISABILITY_TIMEOUT,
+            wait_time = WAIT_TIME
+          )
             @queue     = queue
             @archiver  = archiver
             @timeout   = timeout
             @wait_time = wait_time
+            log_queue_creation queue.url, archiver, timeout
+          end
+
+          def message
+            receive.tap { |m| process(m) unless m.nil? }
+          end
+
+          private
 
+          def log_queue_creation(queue_url, archiver, timeout)
             logger.info(
               "event"    => "QueueConfigured",
-              "queueUrl" => queue.url,
+              "queueUrl" => queue_url,
               "archiver" => archiver,
               "timeout"  => timeout,
               "method"   => "#{self.class}#initialize"
             )
           end
 
-          def message
-            receive.tap { |m| process(m) unless m.nil? }
-          end
-
-          private
-
           def process(m)
             logger.metric "MessagesReceived"
             logger.info(
@@ -58,10 +66,10 @@ module Alephant
           end
 
           def receive
-            queue.receive_message({
+            queue.receive_message(
               :visibility_timeout => timeout,
               :wait_time_seconds  => wait_time
-            })
+            )
           end
         end
       end

data/lib/alephant/publisher/queue/version.rb

@@ -1,7 +1,7 @@
 module Alephant
   module Publisher
     module Queue
-      VERSION = "2.0.0"
+      VERSION = "2.0.1"
     end
   end
 end

data/lib/alephant/publisher/queue/writer.rb

@@ -41,23 +41,30 @@ module Alephant
         protected
 
         def perform
-          Proc.new { views.each { |id, view| write(id, view) } }
+          Proc.new do
+            views.each { |component, view| write(component, view) }
+          end
         end
 
-        def write(id, view)
-          seq_for(id).validate(message) do
-            store(id, view, location_for(id), :msg_id => message.id)
+        def write(component, view)
+          seq_for(component).validate(message) do
+            store(
+              component,
+              view,
+              location_for(component),
+              :msg_id => message.id
+            )
           end.tap do
             logger.info(
               "event"     => "MessageWritten",
-              "id"        => id,
+              "component" => component,
               "view"      => view,
               "method"    => "#{self.class}#write"
             )
           end
         end
 
-        def store(id, view, location, storage_opts = {})
+        def store(component, view, location, storage_opts = {})
           render = view.render
           cache.put(location, render, view.content_type, storage_opts).tap do
             logger.info(
@@ -71,10 +78,10 @@ module Alephant
               "method"         => "#{self.class}#store"
             )
           end
-          lookup.write(id, options, seq_id, location).tap do
+          lookup.write(component, options, seq_id, location).tap do
             logger.info(
               "event"      => "LookupLocationUpdated",
-              "id"         => id,
+              "component"  => component,
               "options"    => options,
               "sequenceId" => seq_id,
               "location"   => location,
@@ -83,8 +90,8 @@ module Alephant
           end
         end
 
-        def location_for(id)
-          "#{config[:renderer_id]}/#{id}/#{opt_hash}/#{seq_id}"
+        def location_for(component)
+          "#{config[:renderer_id]}/#{component}/#{opt_hash}/#{seq_id}"
         end
 
         def batch
@@ -109,7 +116,9 @@ module Alephant
         end
 
         def seq_id
-          @seq_id ||= Sequencer::Sequencer.sequence_id_from(message, config[:sequence_id_path])
+          @seq_id ||= Sequencer::Sequencer.sequence_id_from(
+            message, config[:sequence_id_path]
+          )
         end
 
         def views

data/lib/alephant/publisher/queue.rb

@@ -51,7 +51,7 @@ module Alephant
             :log_archive_message => true,
             :async_store         => true
           }
-          options.each do |key, value|
+          options.each do |key, _value|
             options[key] = opts.queue[key] == "true" if opts.queue.has_key? key
           end
         end
@@ -68,7 +68,7 @@ module Alephant
         end
 
         def sqs_queue_options
-          (opts.queue[:aws_account_id].nil? ? {} : { :queue_owner_aws_account_id => opts.queue[:aws_account_id] }).tap do |ops|
+          (opts.queue[:aws_account_id].nil? ? {} : fallback).tap do |ops|
             logger.info(
               "event"   => "SQSQueueOptionsConfigured",
               "options" => ops,
@@ -77,8 +77,16 @@ module Alephant
           end
         end
 
+        def fallback
+          {
+            :queue_owner_aws_account_id => opts.queue[:aws_account_id]
+          }
+        end
+
         def aws_queue
-          queue_url = sqs_client.queues.url_for(opts.queue[:sqs_queue_name], sqs_queue_options)
+          queue_url = sqs_client.queues.url_for(
+            opts.queue[:sqs_queue_name], sqs_queue_options
+          )
           sqs_client.queues[queue_url]
         end
       end

data/spec/archiver_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Alephant::Publisher::Queue::SQSHelper::Archiver do
   let (:cache) { instance_double("Alephant::Cache", :put => nil) }
@@ -34,12 +34,10 @@ describe Alephant::Publisher::Queue::SQSHelper::Archiver do
         expect(cache).to receive(:put).with(
           "archive/#{time_now.strftime('%d-%m-%Y_%H')}/id",
           message.body,
-          {
-            :id        => message.id,
-            :md5       => message.md5,
-            :logged_at => time_now.to_s,
-            :queue     => message.queue.url
-          }
+          :id        => message.id,
+          :md5       => message.md5,
+          :logged_at => time_now.to_s,
+          :queue     => message.queue.url
         )
         subject.see(message)
       end
@@ -66,4 +64,3 @@ describe Alephant::Publisher::Queue::SQSHelper::Archiver do
     end
   end
 end
-

data/spec/processor_spec.rb

@@ -1,19 +1,21 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Alephant::Publisher::Queue::Processor do
-
   before(:each) do
-    allow_any_instance_of(Alephant::Publisher::Queue::Writer).to receive(:initialize)
-    allow_any_instance_of(Alephant::Publisher::Queue::Writer).to receive(:run!)
+    allow_any_instance_of(
+      Alephant::Publisher::Queue::Writer
+    ).to receive(:initialize)
+
+    allow_any_instance_of(
+      Alephant::Publisher::Queue::Writer
+    ).to receive(:run!)
   end
 
   describe "#consume(msg)" do
     it "Consume the message and deletes it" do
-
-      msg = double('AWS::SQS::ReceivedMessage', :delete => nil)
+      msg = double("AWS::SQS::ReceivedMessage", :delete => nil)
       expect(msg).to receive(:delete)
       subject.consume(msg)
-
     end
   end
 end

data/spec/publisher_spec.rb

@@ -1,10 +1,12 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Alephant::Publisher::Queue do
   let(:options)       { Alephant::Publisher::Queue::Options.new }
-  let(:queue)         { double('AWS::SQS::Queue', :url => nil ) }
-  let(:queue_double)  { double('AWS::SQS::QueueCollection', :[] => queue, :url_for => nil) }
-  let(:client_double) { double('AWS::SQS', :queues => queue_double) }
+  let(:queue)         { double("AWS::SQS::Queue", :url => nil ) }
+  let(:client_double) { double("AWS::SQS", :queues => queue_double) }
+  let(:queue_double)  {
+    double("AWS::SQS::QueueCollection", :[] => queue, :url_for => nil)
+  }
 
   before(:each) do
     expect(AWS::SQS).to receive(:new).and_return(client_double)
@@ -13,15 +15,22 @@ describe Alephant::Publisher::Queue do
   describe ".create" do
     it "sets parser, sequencer, queue and writer" do
       instance = Alephant::Publisher::Queue.create(options)
-      expect(instance.queue).to be_a Alephant::Publisher::Queue::SQSHelper::Queue
+      expect(instance.queue)
+        .to be_a Alephant::Publisher::Queue::SQSHelper::Queue
     end
 
     context "with account" do
       it "creates a queue with an account number in the option hash" do
         options = Alephant::Publisher::Queue::Options.new
-        options.add_queue({ :sqs_queue_name => 'bar', :aws_account_id => 'foo' })
+        options.add_queue(
+          :sqs_queue_name => "bar",
+          :aws_account_id => "foo"
+        )
 
-        expect(queue_double).to receive(:url_for).with('bar', { :queue_owner_aws_account_id => 'foo' })
+        expect(queue_double).to receive(:url_for).with(
+          "bar",
+          :queue_owner_aws_account_id => "foo"
+        )
 
         Alephant::Publisher::Queue.create(options)
       end
@@ -30,9 +39,9 @@ describe Alephant::Publisher::Queue do
     context "without account" do
       it "creates a queue with an empty option hash" do
         options = Alephant::Publisher::Queue::Options.new
-        options.add_queue({ :sqs_queue_name => 'bar' })
+        options.add_queue(:sqs_queue_name => "bar")
 
-        expect(queue_double).to receive(:url_for).with('bar', {})
+        expect(queue_double).to receive(:url_for).with("bar", {})
 
         Alephant::Publisher::Queue.create(options)
       end

data/spec/queue_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Alephant::Publisher::Queue::SQSHelper::Queue do
   describe "#message" do
@@ -27,4 +27,3 @@ describe Alephant::Publisher::Queue::SQSHelper::Queue do
     end
   end
 end
-

data/spec/spec_helper.rb

@@ -1,5 +1,4 @@
-require 'pry'
-
-require 'aws-sdk'
-require 'alephant/publisher/queue'
+require "pry"
 
+require "aws-sdk"
+require "alephant/publisher/queue"

data/spec/writer_spec.rb

@@ -1,14 +1,14 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Alephant::Publisher::Queue::Writer do
   let(:opts) do
     {
-      :lookup_table_name    => 'lookup_table_name',
-      :msg_vary_id_path     => '$.vary',
+      :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',
+      :sequence_id_path     => "$.sequence",
       :sequencer_table_name => :sequencer_table_name,
       :view_path            => :view_path
     }
@@ -23,37 +23,45 @@ describe Alephant::Publisher::Queue::Writer do
         opts[:s3_object_path]
       )
 
-    allow_any_instance_of(Alephant::Sequencer::SequenceTable).to receive(:create)
 
-    allow_any_instance_of(Alephant::Sequencer::Sequencer).to receive(:sequencer_id_from)
-      .and_return(1)
+    allow_any_instance_of(
+      Alephant::Sequencer::SequenceTable
+    ).to receive(:create)
 
-    allow_any_instance_of(Alephant::Sequencer::Sequencer).to receive(:set_last_seen)
 
-    allow_any_instance_of(Alephant::Sequencer::Sequencer).to receive(:get_last_seen)
-
-    allow_any_instance_of(Alephant::Lookup::LookupTable).to receive(:create)
+    allow_any_instance_of(Alephant::Sequencer::Sequencer)
+      .to receive_messages(
+        :sequencer_id_from => nil,
+        :set_last_seen     => nil,
+        :get_last_seen     => nil
+      )
 
-    allow_any_instance_of(Alephant::Lookup::LookupTable).to receive(:table_name)
+    allow_any_instance_of(Alephant::Lookup::LookupTable)
+      .to receive_messages(
+        :create     => nil,
+        :table_name => nil
+      )
 
-    allow_any_instance_of(Alephant::Renderer::Renderer).to receive(:views).and_return({})
+    allow_any_instance_of(
+      Alephant::Renderer::Renderer
+    ).to receive(:views).and_return({})
   end
 
   describe "#run!" do
     let(:msg) do
       data = {
         "sequence" => "1",
-        "vary" => "foo"
+        "vary"     => "foo"
       }
-      Struct.new(:body,:id).new(data.to_json,'id')
+      Struct.new(:body, :id).new(data.to_json, "id")
     end
 
     let(:expected_location) do
-      'renderer_id/component_id/218c835cec343537589dbf1619532e4d/1'
+      "renderer_id/component_id/218c835cec343537589dbf1619532e4d/1"
     end
 
     let(:renderer) do
-      instance_double 'Alephant::Renderer::Renderer'
+      instance_double "Alephant::Renderer::Renderer"
     end
 
     subject do
@@ -66,7 +74,7 @@ describe Alephant::Publisher::Queue::Writer do
       allow_any_instance_of(Alephant::Lookup::LookupHelper).to receive(:write)
         .with(
           "component_id",
-          {:variant=>"foo"},
+          { :variant => "foo" },
           1,
           expected_location
         )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alephant-publisher-queue
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - BBC News
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-07-14 00:00:00.000000000 Z
+date: 2015-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement