alephant-publisher 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 76c21b712ec1b6c51c2997742420dfb0fbd7ccd1
+  data.tar.gz: f36fa3db507bb27ea2e17b1cb0616003e2cbfe4e
+SHA512:
+  metadata.gz: c3e23d4acc640ab07ffba6aa94e07a6eabad20774004cb20a4a71f79a49f0ea5977d8a5de91e8cd3b3aae1c765313e50177e54744759fb726c0279e6efe987cb
+  data.tar.gz: cbd43452f89a987beffd8d1c90ba20aa84685bea9a73184563c1529953c20b3a1de9ab046ee58e4c3d8461a293414685ef53639e8591426e2c3337f37a998af8

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rspec
+.ruby-version
+/config/*.yaml
+/config/*.yml
+/components
+*.swp

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - "jruby"
+notifications:
+  email:
+    recipients:
+      - kenoir@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/.+\.rb$})
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('spec/spec_helper.rb')                        { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Integralist
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,181 @@
+# Alephant::Publisher
+
+Static publishing to S3 based on SQS messages
+
+[![Build Status](https://travis-ci.org/BBC-News/alephant-publisher.png?branch=master)](https://travis-ci.org/BBC-News/alephant-publisher)
+
+[![Dependency Status](https://gemnasium.com/BBC-News/alephant-publisher.png)](https://gemnasium.com/BBC-News/alephant-publisher)
+
+[![Gem Version](https://badge.fury.io/rb/alephant-publisher.png)](http://badge.fury.io/rb/alephant-publisher)
+
+## Dependencies
+
+- JRuby 1.7.8
+- An AWS account (you'll need to create):
+  - An S3 bucket
+  - An SQS Queue (if no sequence id provided then `sequence_id` will be used)
+  - A Dynamo DB table (optional, will attempt to create if can't be found)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'alephant-publisher'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install alephant-publisher
+
+## Setup
+
+Ensure you have a `config/aws.yml` in the format:
+
+```yaml
+access_key_id: ACCESS_KEY_ID
+secret_access_key: SECRET_ACCESS_KEY
+```
+
+## Usage
+
+**In your application:**
+
+```rb
+require 'alephant'
+
+sequential_proc = Proc.new do |last_seen_id, data|
+  last_seen_id < data['sequence_id'].to_i
+end
+
+set_last_seen_proc = Proc.new do |data|
+  data['sequence_id'].to_i
+end
+
+opts = {
+  :s3_bucket_id       => 'bucket-id',
+  :s3_object_path     => 'path/to/object',
+  :s3_object_id       => 'object_id',
+  :table_name         => 'your_dynamo_db_table',
+  :sqs_queue_id       => 'https://your_amazon_sqs_queue_url',
+  :sequential_proc    => sequential_proc,
+  :set_last_seen_proc => set_last_seen_proc
+}
+
+logger = Logger.new
+
+thread = Alephant::Alephant.new(opts, logger).run!
+thread.join
+```
+
+logger is optional, and must confirm to the Ruby standard logger interface
+
+Provide a view in a folder (fixtures are optional):
+
+```
+└── views
+    ├── models
+    │   └── foo.rb
+    ├── fixtures
+    │   └── foo.json
+    └── templates
+        └── foo.mustache
+```
+
+**SQS Message Format**
+
+```json
+{
+  "content": "hello world",
+  "sequential_id": 1
+}
+```
+
+**foo.rb**
+
+```rb
+module MyApp
+  module Views
+    class Foo < Alephant::Views::Base
+      def content
+        @data['content']
+      end
+    end
+  end
+end
+```
+
+**foo.mustache**
+
+```mustache
+{{content}}
+```
+
+**S3 Output**
+
+```
+hello world
+```
+
+## Build the gem locally
+
+If you want to test a modified version of the gem within your application without publishing it then you can follow these steps...
+
+- `gem uninstall alephant-publisher`
+- `gem build alephant-publisher.gemspec` (this will report the file generated which you reference in the next command)
+- `gem install ./alephant-publisher-0.0.9.1-java.gem`
+
+Now you can test the gem from within your application as you've installed the gem from the local version rather than your published version
+
+## Preview Server
+
+`alephant preview`
+
+The included preview server allows you to see the html generated by your
+templates, both standalone and in the context of a page.
+
+**Standalone**
+
+`/component/:id/?:fixture?`
+
+### Full page preview
+
+When viewing the component in the context of a page, you'll need to retrieve a
+mustache template to provide the page context.
+
+When performing an update a regex is applied to replace the static hostnames in
+the retrieved html.
+
+**Environment Variables**
+
+```sh
+STATIC_HOST_REGEX="static.(sandbox.dev|int|test|stage|live).yourapp(i)?.com\/"
+PREVIEW_TEMPLATE_URL="http://yourapp.com/template"
+```
+
+**Example Remote Template**
+
+`id` is the component/folder name  
+
+`template` is the mustache template file name  
+
+`location_in_page` should be something like (for example) `page_head` (specified within a `preview.mustache` file that the consuming application needs to create).
+
+- `http://localhost:4567/component/id/template`
+- `http://localhost:4567/preview/id/template/location_in_page`
+
+`alephant update`
+
+**In page**
+
+`/preview/:id/:region/?:fixture?`
+
+## Contributing
+
+1. Fork it ( http://github.com/BBC-News/alephant-publisher/fork )
+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,9 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+require 'alephant/publisher'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/alephant-publisher.gemspec

@@ -0,0 +1,45 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'alephant/publisher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "alephant-publisher"
+  spec.version       = Alephant::Publisher::VERSION
+  spec.authors       = ["Integralist"]
+  spec.email         = ["mark.mcdx@gmail.com"]
+  spec.summary       = "Static publishing to S3 based on SQS messages"
+  spec.description   = "Static publishing to S3 based on SQS messages"
+  spec.homepage      = "https://github.com/BBC-News/alephant-publisher"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-nc"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-remote"
+  spec.add_development_dependency "pry-nav"
+
+  spec.add_runtime_dependency 'sinatra'
+  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'trollop'
+  spec.add_runtime_dependency 'rake'
+  spec.add_runtime_dependency 'aws-sdk', '~> 1.0'
+  spec.add_runtime_dependency 'mustache', '>= 0.99.5'
+  spec.add_runtime_dependency 'jsonpath'
+  spec.add_runtime_dependency 'crimp'
+  spec.add_runtime_dependency 'alephant-support'
+  spec.add_runtime_dependency 'alephant-sequencer'
+  spec.add_runtime_dependency 'alephant-cache'
+  spec.add_runtime_dependency 'alephant-logger'
+  spec.add_runtime_dependency 'alephant-renderer'
+  spec.add_runtime_dependency 'alephant-lookup'
+  spec.add_runtime_dependency 'alephant-preview'
+end

data/lib/alephant/env.rb

@@ -0,0 +1,9 @@
+require 'aws-sdk'
+require 'yaml'
+
+config_file = 'config/aws.yaml'
+
+if File.exists? config_file
+  config = YAML.load(File.read(config_file))
+  AWS.config(config)
+end

data/lib/alephant/publisher.rb

@@ -0,0 +1,78 @@
+require_relative 'env'
+
+require 'alephant/support'
+require 'alephant/sequencer'
+require 'alephant/cache'
+require 'alephant/logger'
+require 'alephant/views'
+require 'alephant/renderer'
+require 'alephant/lookup'
+
+require "alephant/publisher/version"
+require 'alephant/publisher/models/render_mapper'
+require 'alephant/publisher/models/writer'
+require 'alephant/publisher/models/queue'
+
+module Alephant
+  module Publisher
+    include ::Alephant::Logger
+
+    def self.create(opts = {}, logger = nil)
+      Publisher.new(opts, logger)
+    end
+
+    private
+
+    class Publisher
+      attr_reader :sequencer, :queue, :writer, :parser
+
+      def initialize(opts, logger)
+        ::Alephant::Logger.set_logger(logger) unless logger.nil?
+
+        @parser = Support::Parser.new(
+          opts[:msg_vary_id_path]
+        )
+
+        @sequencer = Sequencer.create(
+          opts[:sequencer_table_name],
+          opts[:sqs_queue_url],
+          opts[:sequence_id_path]
+        )
+
+        @queue = Queue.new(
+          opts[:sqs_queue_url]
+        )
+
+        @writer = Writer.new(
+          opts.select do |k,v|
+            [
+              :renderer_id,
+              :s3_bucket_id,
+              :s3_object_path,
+              :view_path,
+              :lookup_table_name
+            ].include? k
+          end
+        )
+      end
+
+      def run!
+        Thread.new do
+          @queue.poll { |msg| receive(msg) }
+        end
+      end
+
+      def receive(msg)
+        write msg if sequencer.sequential?(msg)
+      end
+
+      private
+
+      def write(msg)
+        writer.write(parser.parse(msg), sequencer.sequence_id_from(msg))
+        sequencer.set_last_seen(msg)
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require 'aws-sdk'
+require 'alephant/logger'
+
+module Alephant
+  module Publisher
+    class Queue
+      include ::Alephant::Logger
+
+      attr_accessor :q
+
+      def initialize(id)
+        @sqs = AWS::SQS.new
+        @q = @sqs.queues[id]
+
+        unless @q.exists?
+          @q = @sqs.queues.create(id)
+          sleep_until_queue_exists
+          logger.info("Queue.initialize: created queue with id #{id}")
+        end
+
+        logger.info("Queue.initialize: ended with id #{id}")
+      end
+
+      def sleep_until_queue_exists
+        sleep 1 until @q.exists?
+      end
+
+      def poll(*args, &block)
+        logger.info("Queue.poll: polling with arguments #{args}")
+        @q.poll(*args, &block)
+      end
+    end
+  end
+end

data/lib/alephant/publisher/models/render_mapper.rb

@@ -0,0 +1,59 @@
+require 'alephant/logger'
+
+module Alephant
+  module Publisher
+    class RenderMapper
+      include ::Alephant::Logger
+      DEFAULT_LOCATION = 'components'
+
+      def initialize(component_id, view_base_path=nil)
+        self.base_path = "#{view_base_path}/#{component_id}" unless view_base_path.nil?
+        @component_id = component_id
+      end
+
+      def base_path
+        @base_path || DEFAULT_LOCATION
+      end
+
+      def base_path=(path)
+        @base_path = File.directory?(path) ? path : (raise "Invalid path")
+      end
+
+      def generate(data)
+        template_locations.reduce({}) do |obj, file|
+          template_id = template_id_for file
+          obj.tap { |o| o[template_id] = create_renderer(template_id, data) }
+        end
+      end
+
+      def create_renderer(template_file, data)
+        model = instantiate_model(template_file, data)
+        Renderer.create(template_file, base_path, model)
+      end
+
+      private
+
+      def instantiate_model(view_id, data)
+        require model_location_for view_id
+        Views.get_registered_class(view_id).new(data)
+      end
+
+      def model_location_for(template_file)
+        File.join(base_path, 'models', "#{template_file}.rb")
+      end
+
+     def template_locations
+        Dir[template_base_path]
+      end
+
+      def template_base_path
+        "#{base_path}/templates/*"
+      end
+
+      def template_id_for(template_location)
+        template_location.split('/').last.sub(/\.mustache/, '')
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+require 'crimp'
+
+module Alephant
+  module Publisher
+    class Writer
+      attr_reader :mapper, :cache
+
+      def initialize(opts)
+        @renderer_id =
+          opts[:renderer_id]
+        @cache = Cache.new(
+          opts[:s3_bucket_id],
+          opts[:s3_object_path]
+        )
+        @mapper = RenderMapper.new(
+          opts[:renderer_id],
+          opts[:view_path]
+        )
+        @lookup_table_name =
+          opts[:lookup_table_name]
+      end
+
+      def write(data, version = nil)
+        mapper.generate(data).each do |id, r|
+          store(id, r.render, data[:options], version)
+        end
+      end
+
+      private
+      def store(id, content, options, version)
+        location = location_for(
+          id,
+          Crimp.signature(options),
+          version
+        )
+
+        cache.put(location, content)
+        lookup(id).write(options, location)
+      end
+
+      def lookup(component_id)
+        Lookup.create(@lookup_table_name, component_id)
+      end
+
+      def location_for(component_id, options_hash, version = nil)
+        base_name = "#{@renderer_id}/#{component_id}/#{options_hash}"
+        version ? "#{base_name}/#{version}" : base_name
+      end
+
+    end
+  end
+end

data/lib/alephant/publisher/version.rb

@@ -0,0 +1,5 @@
+module Alephant
+  module Publisher
+    VERSION = "0.0.1"
+  end
+end

data/spec/fixtures/components/foo/models/bar.rb

@@ -0,0 +1,7 @@
+module MyApp
+  class Bar < ::Alephant::Views::Base
+    def content
+      @data[:content]
+    end
+  end
+end

data/spec/fixtures/components/foo/models/foo.rb

@@ -0,0 +1,7 @@
+module MyApp
+  class Foo < ::Alephant::Views::Base
+    def content
+      @data[:content]
+    end
+  end
+end

data/spec/fixtures/components/foo/templates/bar.mustache

@@ -0,0 +1 @@
+{{content}}

data/spec/fixtures/components/foo/templates/foo.mustache

@@ -0,0 +1 @@
+{{content}}

data/spec/publisher_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+describe Alephant::Publisher do
+  let(:instance) { Alephant::Publisher.create }
+
+  before(:each) do
+    Alephant::Publisher::Writer.any_instance.stub(:initialize)
+    Alephant::Publisher::Queue.any_instance.stub(:initialize)
+    Alephant::Support::Parser.any_instance.stub(:initialize)
+    Alephant::Sequencer::Sequencer.any_instance.stub(:initialize)
+  end
+
+  describe "#initialize(opts = {}, logger)" do
+    it "sets parser, sequencer, queue and writer" do
+      expect(instance.writer).to    be_a Alephant::Publisher::Writer
+      expect(instance.queue).to     be_a Alephant::Publisher::Queue
+      expect(instance.parser).to    be_a Alephant::Support::Parser
+      expect(instance.sequencer).to be_a Alephant::Sequencer::Sequencer
+    end
+  end
+
+  describe "#run!" do
+    it "returns a Thread" do
+      expect(instance.run!).to be_a(Thread)
+    end
+
+    it "calls @queue.poll" do
+      instance.should_receive(:receive).with(:msg)
+
+      expect_any_instance_of(Alephant::Publisher::Queue)
+      .to receive(:poll)
+      .and_yield(:msg)
+
+      t = instance.run!
+      t.join
+    end
+  end
+
+  describe "#receive(msg)" do
+    before(:each) do
+      Alephant::Support::Parser
+        .any_instance
+        .stub(:parse)
+        .and_return(:parsed_msg)
+
+      Alephant::Sequencer::Sequencer
+        .any_instance
+        .stub(:sequence_id_from)
+        .and_return(:sequence_id)
+
+      Alephant::Sequencer::Sequencer
+        .any_instance
+        .stub(:set_last_seen)
+    end
+
+    context "message is nonsequential" do
+      before(:each) do
+        Alephant::Sequencer::Sequencer
+          .any_instance
+          .stub(:sequential?)
+          .and_return(false)
+      end
+
+      it "should not call write" do
+        Alephant::Publisher::Writer
+          .any_instance
+          .should_not_receive(:write)
+
+        instance.receive(:msg)
+      end
+    end
+
+    context "message is sequential" do
+      before(:each) do
+        Alephant::Sequencer::Sequencer
+          .any_instance
+          .stub(:sequential?)
+          .and_return(true)
+      end
+
+      it "calls writer with a parsed message and sequence_id" do
+        Alephant::Publisher::Writer
+          .any_instance
+          .should_receive(:write)
+          .with(:parsed_msg, :sequence_id)
+
+        instance.receive(:msg)
+      end
+    end
+  end
+
+end

data/spec/queue_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe Alephant::Publisher::Queue do
+  subject { Alephant::Publisher::Queue }
+
+  describe "initialize(id)" do
+    it "sets @q to an instance of AWS:SQS::Queue" do
+      AWS::SQS::Queue
+        .any_instance
+        .stub(:exists?)
+        .and_return(true)
+
+      instance = subject.new(:id)
+      expect(instance.q).to be_a(AWS::SQS::Queue)
+    end
+
+    context "@q.exists? == false" do
+      it "@q = AWS::SQS.new.queues.create(id), then sleep_until_queue_exists" do
+        queue = double()
+        queue.stub(:exists?).and_return(false)
+
+        queue_collection = double()
+        queue_collection
+          .should_receive(:create)
+          .with(:id)
+          .and_return(queue)
+
+        sqs = double()
+        sqs.should_receive(:queues)
+          .and_return({ :id => queue }, queue_collection)
+
+        AWS::SQS
+          .should_receive(:new)
+          .and_return(sqs)
+
+        subject
+          .any_instance
+          .should_receive(:sleep_until_queue_exists)
+
+        instance = subject.new(:id)
+      end
+    end
+  end
+
+  describe "poll(*args, &block)" do
+    it "calls @q.poll(*args, &block)" do
+      block = double()
+      block.should_receive(:called)
+
+      AWS::SQS::Queue
+        .any_instance
+        .stub(:exists?)
+        .and_return(true)
+
+      AWS::SQS::Queue
+        .any_instance
+        .should_receive(:poll)
+        .with(:arg)
+        .and_yield
+
+      subject.new(:id).poll(:arg) do
+        block.called
+      end
+    end
+  end
+
+  describe "sleep_until_queue_exists" do
+    context "@q.exists? == true" do
+      it "should not call sleep" do
+        AWS::SQS::Queue
+          .any_instance
+          .stub(:exists?)
+          .and_return(true)
+
+        Alephant::Publisher::Queue
+          .any_instance
+          .stub(:sleep)
+
+        Alephant::Publisher::Queue
+          .any_instance
+          .should_not_receive(:sleep)
+
+        subject.new(:id).sleep_until_queue_exists
+      end
+    end
+    context "@q.exists? == false" do
+      it "should call sleep(1)" do
+        AWS::SQS::Queue
+          .any_instance
+          .stub(:exists?)
+          .and_return(true, false, true)
+
+        Alephant::Publisher::Queue
+          .any_instance
+          .stub(:sleep)
+
+        Alephant::Publisher::Queue
+          .any_instance
+          .should_receive(:sleep)
+          .with(1)
+
+        subject.new(:id).sleep_until_queue_exists
+      end
+    end
+  end
+end

data/spec/render_mapper_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Alephant::Publisher::RenderMapper do
+  let(:component_id) { :foo }
+  let(:data) {{ :foo => :bar }}
+  let(:path) { File.join(File.dirname(__FILE__), 'fixtures/components') }
+
+  subject { Alephant::Publisher::RenderMapper }
+
+  before(:each) do
+    File.stub(:directory?).and_return(true)
+  end
+
+  describe "initialize(view_base_path)" do
+    context "view_base_path = invalid_path" do
+      it "should raise InvalidViewPath" do
+        File.stub(:directory?).and_return(false)
+        expect {
+          subject.new(component_id, './invalid_path')
+        }.to raise_error(
+          'Invalid path'
+        )
+      end
+    end
+
+    context "view_base_path = '.'" do
+      it "sets base_path" do
+        expect(
+          subject.new(component_id, '.').base_path
+        ).to eq("./#{component_id}")
+      end
+    end
+
+    context "view_base_path = nil" do
+      it "sets base_path" do
+        expect(
+          subject.new(component_id).base_path
+        ).to eq(Alephant::Publisher::RenderMapper::DEFAULT_LOCATION)
+      end
+    end
+  end
+
+  describe "create_renderer(template_file, data)" do
+    it "Returns a valid renderer" do
+      expect(
+        subject.new(component_id, path)
+          .create_renderer('foo', { :content => 'hello'})
+      ).to be_a(Alephant::Renderer::Mustache)
+    end
+
+    it "Returns expected rendered content from a render" do
+      expect(
+        subject.new(component_id, path)
+          .create_renderer('foo', { :content => 'hello'}).render
+      ).to eq("hello\n")
+    end
+  end
+
+  describe "generate(data)" do
+    it "calls create_renderer for each template found" do
+      expect(
+        subject.new(component_id, path).generate(data).size
+      ).to eq(2)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# $: << File.join(File.dirname(__FILE__),"..", "lib")
+
+require 'pry'
+require 'alephant/publisher'
+require 'alephant/publisher/models/writer'
+require 'alephant/publisher/models/queue'
+require 'alephant/publisher/models/render_mapper'
+# require 'logger'
+require 'alephant/renderer'
+require 'alephant/support/parser'
+

data/spec/writer_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Alephant::Publisher::Writer do
+  before(:each) do
+    Alephant::Publisher::RenderMapper
+      .any_instance
+      .stub(:initialize)
+
+      Alephant::Cache
+        .any_instance
+        .stub(:initialize)
+  end
+
+  subject do
+    Alephant::Publisher::Writer.new({
+      :renderer_id       => 'renderer_id',
+      :lookup_table_name => 'lookup_table_name'
+    })
+  end
+
+  describe "#write(data, version)" do
+    before(:each) do
+      Alephant::Publisher::RenderMapper
+        .any_instance
+        .stub(:generate)
+        .and_return({
+          'component_id' => Struct.new(:render).new('content')
+        })
+
+    end
+
+    it "should write the correct lookup location" do
+      options = { :key     => :value  }
+      data    = { :options => options }
+
+      Alephant::Cache.any_instance
+        .stub(:put)
+
+      Alephant::Lookup
+        .should_receive(:create)
+        .with('lookup_table_name', 'component_id')
+        .and_call_original
+
+      Alephant::Lookup::Lookup.any_instance
+        .stub(:initialize)
+
+      Alephant::Lookup::Lookup.any_instance
+        .should_receive(:write)
+        .with(options, 'renderer_id/component_id/42de5e5c6f74b9fe4d956704a6d9e1c7/0')
+
+      subject.write(data, 0)
+    end
+
+    it "should put the correct location, content to cache" do
+      Alephant::Lookup::Lookup
+        .any_instance
+        .stub(:initialize)
+
+      Alephant::Lookup::Lookup
+        .any_instance
+        .stub(:write)
+
+      Alephant::Cache.any_instance
+        .should_receive(:put)
+        .with('renderer_id/component_id/35589a1cc0b3ca90fc52d0e711c0c434/0', 'content')
+
+      subject.write({}, 0)
+    end
+  end
+end

metadata

@@ -0,0 +1,398 @@
+--- !ruby/object:Gem::Specification
+name: alephant-publisher
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Integralist
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2014-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: guard
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: pry
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: faraday
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: trollop
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: mustache
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.99.5
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.99.5
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: jsonpath
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: crimp
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: alephant-support
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: alephant-sequencer
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: alephant-cache
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: alephant-logger
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: alephant-renderer
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: alephant-lookup
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: alephant-preview
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+description: Static publishing to S3 based on SQS messages
+email:
+- mark.mcdx@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- alephant-publisher.gemspec
+- lib/alephant/env.rb
+- lib/alephant/publisher.rb
+- lib/alephant/publisher/models/queue.rb
+- lib/alephant/publisher/models/render_mapper.rb
+- lib/alephant/publisher/models/writer.rb
+- lib/alephant/publisher/version.rb
+- spec/fixtures/components/foo/models/bar.rb
+- spec/fixtures/components/foo/models/foo.rb
+- spec/fixtures/components/foo/templates/bar.mustache
+- spec/fixtures/components/foo/templates/foo.mustache
+- spec/publisher_spec.rb
+- spec/queue_spec.rb
+- spec/render_mapper_spec.rb
+- spec/spec_helper.rb
+- spec/writer_spec.rb
+homepage: https://github.com/BBC-News/alephant-publisher
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
+specification_version: 4
+summary: Static publishing to S3 based on SQS messages
+test_files:
+- spec/fixtures/components/foo/models/bar.rb
+- spec/fixtures/components/foo/models/foo.rb
+- spec/fixtures/components/foo/templates/bar.mustache
+- spec/fixtures/components/foo/templates/foo.mustache
+- spec/publisher_spec.rb
+- spec/queue_spec.rb
+- spec/render_mapper_spec.rb
+- spec/spec_helper.rb
+- spec/writer_spec.rb