alephant 0.0.7-java → 0.0.8-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df75578b70f5f4edee18315d47acdd5b446b319b
-  data.tar.gz: 7c21430e5949075f3fb2ea9db699a117a913ac77
+  metadata.gz: 494ed4c851d3825b798c74433d330325377d6d85
+  data.tar.gz: f6ab02a83752f07bda53b7cf4c5cdfc5c75ecf92
 SHA512:
-  metadata.gz: df985a135a85c1fd05f060c897c1e3408b3531d930cc2473862d06be1af3843ee7d54577e085fae4e2276a2abb2c3392d424a3a6308d7856c7125f82ec1ccdfb
-  data.tar.gz: 0ef61361d4139f8199437adee01356386c37553f261d9b129e262b886cf3cb28622007e0450d4d10207d3b2da628dd61e91ba393191349ff13caec6857c35659
+  metadata.gz: c8e671fae65d072ace104187c3c38c41e1dea2d84a74cec074a08c51c48de552c77e1a168e7dfc376d984f1159a46382ce4313e073ad68db95f49468a06fb2a4
+  data.tar.gz: a71fd8c93acd6757e44877b34db95f41431adcc36eda26b0eb9d388a811e9307ea878f23b7b669c76ef0a806bd2b32deb463d68c442b240693c72138443a431e

data/.gitignore

@@ -1,3 +1,4 @@
+/config/*.yaml
 /config/*.yml
 Gemfile.lock
 .rspec

data/README.md

@@ -22,17 +22,20 @@ Static publishing to S3 on push notification from SQS
 ##Setup
 
 Ensure you have a `config/aws.yml` in the format:
+
 ```yaml
 access_key_id: ACCESS_KEY_ID
 secret_access_key: SECRET_ACCESS_KEY
 ```
 
 Install the gem:
+
 ```sh
 gem install alephant
 ```
 
 In your application:
+
 ```rb
 require 'alephant'
 opts = {
@@ -58,12 +61,14 @@ thread.join
 
 logger is optional, and must confirm to the Ruby standard logger interface
 
-Provide a view in a folder:
+Provide a view in a folder (fixtures are optional):
 
 ```
 └── views
     ├── models
     │   └── foo.rb
+    ├── fixtures
+    │   └── foo.json
     └── templates
         └── foo.mustache
 ```
@@ -78,6 +83,7 @@ Provide a view in a folder:
 ```
 
 **foo.rb**
+
 ```rb
 module MyApp
   module Views
@@ -91,12 +97,49 @@ end
 ```
 
 **foo.mustache**
+
 ```mustache
 {{content}}
 ```
 
 **S3 Output**
+
 ```
 hello world
 ```
 
+###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**
+
+[http://m.int.bbc.co.uk/news/layout/template](http://m.int.bbc.co.uk/news/layout/template)
+
+`alephant update`
+
+**In page**
+`/preview/:id/:region/?:fixture?`
+

data/alephant.gemspec

@@ -5,23 +5,22 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'alephant/version'
 
 Gem::Specification.new do |s|
-  s.name        = 'alephant'
-  s.version     = Alephant::VERSION
-  s.date        = Time.now.strftime "%Y-%m-%d"
-  s.summary     = "Static Publishing in the Cloud"
-  s.description = "Static publishing to S3 based on SQS messages"
-  s.authors     = ["Robert Kenny"]
-  s.email       = 'kenoir@gmail.com'
-  s.license     = 'GPLv3'
+  s.name          = 'alephant'
+  s.version       = Alephant::VERSION
+  s.date          = Time.now.strftime "%Y-%m-%d"
+  s.summary       = "Static Publishing in the Cloud"
+  s.description   = "Static publishing to S3 based on SQS messages"
+  s.authors       = ["Robert Kenny"]
+  s.email         = 'kenoir@gmail.com'
+  s.license       = 'GPLv3'
 
-  s.files       = `git ls-files`.split($/)
-  s.platform    = "java"
-  s.homepage    =
-    'http://rubygems.org/gems/alephant'
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.platform      = "java"
+  s.homepage      = 'https://github.com/BBC-News/alephant'
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
   s.add_development_dependency "rspec-nc"
   s.add_development_dependency "guard"
@@ -29,7 +28,12 @@ Gem::Specification.new do |s|
   s.add_development_dependency "pry"
   s.add_development_dependency "pry-remote"
   s.add_development_dependency "pry-nav"
+  s.add_development_dependency "sinatra"
 
+  s.add_runtime_dependency 'faraday'
+  s.add_runtime_dependency 'trollop'
+  s.add_runtime_dependency 'rake'
   s.add_runtime_dependency 'aws-sdk', '~> 1.0'
   s.add_runtime_dependency 'mustache', '>= 0.99.5'
 end
+

data/bin/alephant

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+require 'trollop'
+
+root = Pathname.new(__FILE__).dirname.parent
+lib_path = (root + 'lib').realdirpath
+
+$LOAD_PATH.unshift(lib_path)
+
+require 'alephant'
+require 'alephant/tasks'
+
+SUB_COMMANDS = %w(preview)
+global_opts = Trollop::options do
+  banner <<-EOS
+Static publishing to S3 based on SQS messages
+Usage:
+    alephant preview # Runs preview server
+    alephant update  # Attempts to update preview template
+      Dependent on the following environmen variables being set:
+      - STATIC_HOST_REGEX="static.(int|test|live).myhost.com"
+      - PREVIEW_TEMPLATE_URL"http://myapp.com/mustache_template"
+EOS
+  stop_on SUB_COMMANDS
+end
+
+cmd = ARGV.shift # get the subcommand
+case cmd
+when "preview"
+  Rake::Task['alephant:preview:go'].invoke
+when "update"
+  Rake::Task['alephant:preview:update'].invoke
+else
+  Trollop::die "unknown subcommand #{cmd.inspect}"
+end
+

data/lib/alephant.rb

@@ -34,6 +34,7 @@ module Alephant
       set_logger(logger)
       set_opts(opts)
 
+      @logger = ::Alephant.logger
       @sequencer = Sequencer.new(
         {
           :table_name => @table_name
@@ -51,7 +52,7 @@ module Alephant
     end
 
     def parse(msg)
-      JSON.parse(msg)
+      JSON.parse(msg, :symbolize_names => true)
     end
 
     def write(data)
@@ -64,9 +65,13 @@ module Alephant
     def receive(msg)
       data = parse(msg.body)
 
+      @logger.info("Alephant.receive: with id #{msg.id} and body digest: #{msg.md5}")
+
       if @sequencer.sequential?(data, &@sequential_proc)
         write data
         @sequencer.set_last_seen(data, &@set_last_seen_proc)
+      else
+        @logger.warn("Alephant.receive: out of sequence message received #{msg.id} (discarded)")
       end
     end
 

data/lib/alephant/models/cache.rb

@@ -16,7 +16,7 @@ module Alephant
 
     def put(id, data)
       @bucket.objects["#{@path}/#{id}"].write(data)
-      @logger.info("Cache.put: #{@path}/#{id} and write data #{data}")
+      @logger.info("Cache.put: #{@path}/#{id}")
     end
 
     def get(id)

data/lib/alephant/models/renderer.rb

@@ -17,7 +17,7 @@ module Alephant
     end
 
     def render(data)
-      @logger.info("Renderer.render: rendered template with id #{id} and data #{data}")
+      @logger.info("Renderer.render: rendered template with id #{id}")
       Mustache.render(
         template(@id),
         model(@id,data)

data/lib/alephant/models/sequencer.rb

@@ -73,8 +73,9 @@ module Alephant
             :consistent_read => true
           }
         ).first["value"].to_i
-      rescue
-        @logger.error("Sequencer.get_last_seen: id #{id}")
+      rescue Exception => e
+        trace = e.backtrace.join('\n')
+        @logger.error("Sequencer.get_last_seen: id #{id}\nmessage: #{e.message}\ntrace: #{trace}")
         0
       end
     end

data/lib/alephant/preview/server.rb

@@ -0,0 +1,61 @@
+require 'sinatra/base'
+require 'alephant/models/renderer'
+require 'alephant/views/preview'
+require 'faraday'
+require 'json'
+require 'uri'
+
+module Alephant
+  module Preview
+    class Server < Sinatra::Base
+
+      get '/preview/:id/:region/?:fixture?' do
+        render_preview
+      end
+
+      get '/component/:id/?:fixture?' do
+        render_component
+      end
+
+      def render_preview
+        ::Alephant::Views::Preview.new(
+          { region => render_component },
+          preview_template_location
+        ).render
+      end
+
+      def render_component
+        Renderer.new(id, base_path).render(fixture_data)
+      end
+
+      private
+      def region
+        params['region']
+      end
+
+      def id
+        params['id']
+      end
+
+      def fixture
+        params['fixture'] || id
+      end
+
+      def fixture_data
+        JSON.parse(File.open(fixture_location).read)
+      end
+
+      def base_path
+        "#{Dir.pwd}/views"
+      end
+
+      def fixture_location
+        "#{base_path}/fixtures/#{fixture}.json"
+      end
+
+      def preview_template_location
+        "#{base_path}/templates/preview.mustache"
+      end
+    end
+  end
+end

data/lib/alephant/preview/template.rb

@@ -0,0 +1,58 @@
+require 'faraday'
+require 'uri'
+
+module Alephant
+  module Preview
+    class Template
+
+      def self.update(template_location)
+        self.new.update(template_location)
+      end
+
+      def template
+        response = Faraday.new(:url => host).get(path)
+        raise "Can't get template" if response.status != 200
+
+        apply_static_host_regex_to response.body
+      end
+
+      def update(template_location)
+        File.open(template_location, 'w') { |file|
+          file.write(template)
+        }
+      end
+
+      def host
+        "#{uri.scheme}://#{uri.host}"
+      end
+
+      def path
+        uri.path
+      end
+
+      def uri
+        return @uri if not @uri.nil?
+
+        uri_from_env = ENV['PREVIEW_TEMPLATE_URL']
+        raise Exception.new("PREVIEW_TEMPLATE_URL is unset!") if uri_from_env.nil?
+
+        @uri = URI(uri_from_env)
+      end
+
+      def apply_static_host_regex_to(string)
+        string.gsub(static_host_regex, '{{{static_host}}}')
+      end
+
+      def static_host_regex
+        return @static_host_regex if not @static_host_regex.nil?
+
+        static_host_regex_from_env = ENV['STATIC_HOST_REGEX']
+        raise Exception.new("STATIC_HOST_REGEX is unset!") if static_host_regex_from_env.nil?
+
+        @static_host_regex = Regexp.new(static_host_regex_from_env)
+      end
+    end
+  end
+end
+
+

data/lib/alephant/tasks.rb

@@ -0,0 +1,8 @@
+require 'rake'
+require 'pathname'
+
+root = Pathname.new(__FILE__).dirname.parent
+task_path = (root + 'tasks').realdirpath
+
+Dir["#{task_path}/**/*.rake"].each { |ext| load ext } if defined?(Rake)
+

data/lib/alephant/version.rb

@@ -1,3 +1,3 @@
 module Alephant
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/alephant/views/preview.rb

@@ -0,0 +1,44 @@
+require 'alephant/views/base'
+
+module Alephant
+  module Views
+    class Preview < Mustache
+      attr_accessor :regions
+
+      def initialize(regions, template_location)
+        @regions=regions
+        self.template_file = template_location
+      end
+
+      def static_host
+        'localhost:8000'
+      end
+
+      def method_missing(name, *args, &block)
+        return super unless respond_to? name.to_s
+        region @regions[name.to_s]
+      end
+
+      def respond_to?(method)
+        valid_regions.include? method.to_s
+      end
+
+      def region(components)
+        if components.kind_of?(Array)
+          components.join
+        else
+          components
+        end
+      end
+
+      def valid_regions
+        self.template.tokens.find_all { |token|
+          token.is_a?(Array) && token[0] == :mustache
+        }.map{ |token|
+          token[2][2][0].to_s
+        }
+      end
+
+    end
+  end
+end

data/lib/tasks/preview.rake

@@ -0,0 +1,16 @@
+require 'alephant/preview/server'
+require 'alephant/preview/template'
+
+namespace :alephant do
+  namespace :preview do
+    task :go do
+      Alephant::Preview::Server.run!
+    end
+    task :update do
+      Alephant::Preview::Template.update(
+        "#{Dir.pwd}/views/templates/preview.mustache"
+      )
+    end
+  end
+end
+

data/spec/alephant_spec.rb

@@ -164,7 +164,10 @@ describe Alephant::Alephant do
 
     it "writes data to cache if sequential order is true" do
       data = "{ \"foo\":\"bar\" }"
+
       msg = double()
+      msg.stub(:id).and_return(:id)
+      msg.stub(:md5).and_return(:md5)
       msg.stub(:body).and_return(data)
 
       instance = subject.new
@@ -172,11 +175,35 @@ describe Alephant::Alephant do
       Alephant::Sequencer.any_instance.stub(:sequential?).and_return(true)
       Alephant::Sequencer.any_instance.stub(:set_last_seen)
 
-      instance.should_receive(:write).with(JSON.parse(data))
+      instance.should_receive(:write).with(JSON.parse(data, :symbolize_names => true))
       instance.receive(msg)
     end
   end
 
+  describe "parse(msg)" do
+    before(:each) do
+      sequencer = double()
+      queue     = double()
+      cache     = double()
+      renderer  = double()
+
+      Alephant::Sequencer.any_instance.stub(:initialize).and_return(sequencer)
+      Alephant::Queue.any_instance.stub(:initialize).and_return(queue)
+      Alephant::Cache.any_instance.stub(:initialize).and_return(cache)
+      Alephant::Renderer.any_instance.stub(:initialize).and_return(renderer)
+    end
+
+    it "should return keys as symbols" do
+      data = "{ \"foo\":\"bar\" }"
+
+      instance = subject.new.parse data
+      key = instance.keys[0]
+
+      key.should be_a Symbol
+      instance[key].should eq 'bar'
+    end
+  end
+
   describe "write(data)" do
     before(:each) do
       sequencer = double()

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: alephant
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: java
 authors:
 - Robert Kenny
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-01-26 00:00:00.000000000 Z
+date: 2014-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -25,7 +25,7 @@ dependencies:
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-nc
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -39,7 +39,7 @@ dependencies:
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency
-  name: rspec-nc
+  name: guard
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -53,7 +53,7 @@ dependencies:
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: guard-rspec
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -67,7 +67,7 @@ dependencies:
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: pry
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -81,7 +81,7 @@ dependencies:
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: pry-remote
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -95,7 +95,7 @@ dependencies:
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency
-  name: pry-remote
+  name: pry-nav
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -109,7 +109,7 @@ dependencies:
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency
-  name: pry-nav
+  name: sinatra
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -122,6 +122,48 @@ dependencies:
         version: '0'
   prerelease: false
   type: :development
+- !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
@@ -152,7 +194,8 @@ dependencies:
   type: :runtime
 description: Static publishing to S3 based on SQS messages
 email: kenoir@gmail.com
-executables: []
+executables:
+- alephant
 extensions: []
 extra_rdoc_files: []
 files:
@@ -165,6 +208,7 @@ files:
 - README.md
 - Rakefile
 - alephant.gemspec
+- bin/alephant
 - lib/alephant.rb
 - lib/alephant/errors.rb
 - lib/alephant/errors/invalid_view_path.rb
@@ -175,11 +219,16 @@ files:
 - lib/alephant/models/queue.rb
 - lib/alephant/models/renderer.rb
 - lib/alephant/models/sequencer.rb
+- lib/alephant/preview/server.rb
+- lib/alephant/preview/template.rb
+- lib/alephant/tasks.rb
 - lib/alephant/util/string.rb
 - lib/alephant/version.rb
 - lib/alephant/views.rb
 - lib/alephant/views/base.rb
+- lib/alephant/views/preview.rb
 - lib/env.rb
+- lib/tasks/preview.rake
 - spec/alephant_spec.rb
 - spec/cache_spec.rb
 - spec/fixtures/views/models/example.rb
@@ -189,7 +238,7 @@ files:
 - spec/renderer_spec.rb
 - spec/sequencer_spec.rb
 - spec/spec_helper.rb
-homepage: http://rubygems.org/gems/alephant
+homepage: https://github.com/BBC-News/alephant
 licenses:
 - GPLv3
 metadata: {}