alephant-broker 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88c15819c22cfcde769e9b1b1406d9563ddd11f8
-  data.tar.gz: f1ed322acae0dc5740f6a965e3d790e1fca99dfd
+  metadata.gz: 8b93740e5628e1841d3f296c5675304678cc0be7
+  data.tar.gz: 9412546f75f2f95a77c3b2cbfa3b53e98a296f9d
 SHA512:
-  metadata.gz: c3360481c1f7707c893d55635660cf3a5c56894c71aba9d87d80e73c549338ed47b9cede9a36233dbe5f0459b8405d7dbd39824819b4f2d42fcfc06aba0448c8
-  data.tar.gz: 2192c4157e16662cf51d26645d9cb0e9c1f859d487669926a87ab68bba3a78046de9eb49cc1cf8fa2dba60db5e579baf7c5e265b8cf2a3a5944119baa5913600
+  metadata.gz: 34c3356dc0bab54c046bf2d8c269a07ea08c60ebfa9077d9f3eadd46a3df6fb48e1dd01d0bab710022607228629f98b6a4b91448153ed125cc38340e7a6e3626
+  data.tar.gz: 9414facbf42866a0eba6e903ec71ba365f0f342c183edb13a8710125c9fba411b08067a6493551bd1fb8223c64f3a5ef58722404fcf796c7faed88fae2ed56bd

data/alephant-broker.gemspec

@@ -34,4 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "alephant-lookup"
   spec.add_runtime_dependency "alephant-cache"
   spec.add_runtime_dependency 'alephant-logger'
+  spec.add_runtime_dependency 'alephant-sequencer'
 end

data/lib/alephant/broker/call_environment.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module Alephant
   module Broker
     class CallEnvironment
@@ -9,23 +11,27 @@ module Alephant
       end
 
       def method
-        @settings['REQUEST_METHOD']
+        settings['REQUEST_METHOD']
       end
 
       def post?
-        @settings['REQUEST_METHOD'] == 'POST'
+        settings['REQUEST_METHOD'] == 'POST'
       end
 
       def get?
-        @settings['REQUEST_METHOD'] == 'GET'
+        settings['REQUEST_METHOD'] == 'GET'
       end
 
       def query
-        @settings['QUERY_STRING']
+        settings['QUERY_STRING']
       end
 
       def path
-        @settings['PATH_INFO']
+        settings['PATH_INFO']
+      end
+
+      def request_type
+        path.split('/')[1]
       end
 
       def data
@@ -35,7 +41,7 @@ module Alephant
       private
 
       def rack_input
-          (@settings['rack.input'].read).tap { @settings['rack.input'].rewind } # http://rack.rubyforge.org/doc/SPEC.html
+          (settings['rack.input'].read).tap { settings['rack.input'].rewind } # http://rack.rubyforge.org/doc/SPEC.html
       end
 
       def parse(json)

data/lib/alephant/broker/models/request/post_request.rb

@@ -3,16 +3,16 @@ require 'alephant/broker/models/request'
 module Alephant
   module Broker
     class PostRequest < Request
-      attr_reader :type, :component_id, :options, :content_type
+      attr_reader :type, :renderer_id, :component_id, :options, :content_type
 
       def initialize
-        @env = RequestStore.store[:env]
+        @renderer_id  = batch_id
         @content_type = 'application/json'
         super(:batch)
       end
 
       def components
-        @requested_components ||= components_for @env.path
+        @requested_components ||= components_for env.path
       end
 
       def set_component(id, options)
@@ -22,6 +22,10 @@ module Alephant
 
       private
 
+      def env
+        @env ||= RequestStore.store[:env]
+      end
+
       def components_for(path)
         request_parts = path.split('/')
 
@@ -33,11 +37,11 @@ module Alephant
       end
 
       def batch_id
-        @env.data['batch_id']
+        env.data['batch_id']
       end
 
       def batched
-        @env.data['components'].reduce({ :components => [] }) do |obj, component|
+        env.data['components'].reduce({ :components => [] }) do |obj, component|
           obj.tap { |o| o[:components].push(component) }
         end
       end

data/lib/alephant/broker/models/request_handler.rb

@@ -7,24 +7,30 @@ module Alephant
       include Logger
 
       def initialize(config)
-        @env = RequestStore.store[:env]
-        @request = RequestFactory.process(request_type)
-        @response_factory = ResponseFactory.new(config)
+        @config = config
       end
 
       def process
         begin
-          @response_factory.response_from(@request)
+          response_factory.response_from(request)
         rescue Exception => e
           logger.info("Broker.requestHandler.process: Exception raised (#{e.message})")
-          @response_factory.response(500)
+          response_factory.response(500)
         end
       end
 
       private
 
+      def request
+        @request ||= RequestFactory.process(request_type)
+      end
+
+      def response_factory
+        @response_factory ||= ResponseFactory.new(@config)
+      end
+
       def request_type
-        case @env.path.split('/')[1]
+        case env.request_type
         when 'components'
           component_type
         when 'status'
@@ -35,13 +41,17 @@ module Alephant
       end
 
       def component_type
-        case @env.method
+        case env.method
         when 'POST'
           :component_batch
         when 'GET'
           :component
         end
       end
+
+      def env
+        @env ||= RequestStore.store[:env]
+      end
     end
   end
 end

data/lib/alephant/broker/models/response.rb

@@ -22,7 +22,6 @@ module Alephant
       end
 
       def setup; end
-
     end
   end
 end

data/lib/alephant/broker/models/response/asset_response.rb

@@ -1,6 +1,8 @@
+require 'crimp'
 require 'alephant/cache'
 require 'alephant/lookup'
 require 'alephant/broker/errors/invalid_cache_key'
+require 'alephant/sequencer'
 
 module Alephant
   module Broker
@@ -11,15 +13,14 @@ module Alephant
 
       def initialize(request, config)
         @request = request
-        @lookup = Alephant::Lookup.create(config[:lookup_table_name], request.component_id)
-        @cache = Cache.new(config[:bucket_id], config[:path])
+        @config  = config
         super()
       end
 
       def setup
         begin
           self.content_type = request.content_type
-          self.content = @cache.get cache_id
+          self.content = cache.get(s3_path)
         rescue AWS::S3::Errors::NoSuchKey, InvalidCacheKey => e
           set_error_for(e, 404)
         rescue Exception => e
@@ -29,14 +30,66 @@ module Alephant
 
       private
 
+      def cache
+        @cache ||= Alephant::Cache.new(config[:bucket_id], config[:path])
+      end
+
       def set_error_for(exception, status)
         logger.info("Broker.assetResponse.set_error_for: #{status} exception raised (#{exception.message})")
         self.status = status
         self.content = exception.message
       end
 
-      def cache_id
-        @lookup.read(request.options).tap { |cache_id| raise InvalidCacheKey if cache_id.nil? }
+      def s3_path
+        lookup.read(id, request.options, version).tap { |cache_id| raise InvalidCacheKey if cache_id.nil? }
+      end
+
+      def lookup
+        @lookup ||= Alephant::Lookup.create(config[:lookup_table_name])
+      end
+
+      def asset?
+        request.type == :asset
+      end
+
+      def key
+        asset? ? component_key : renderer_key
+      end
+
+      def component_key
+        "#{component_id}/#{opts_hash}"
+      end
+
+      def renderer_key
+        "#{renderer_id}/#{opts_hash}"
+      end
+
+      def id
+        asset? ? component_id : renderer_id
+      end
+
+      def component_id
+        request.component_id
+      end
+
+      def renderer_id
+        request.renderer_id
+      end
+
+      def opts_hash
+        @opts_hash ||= Crimp.signature(request.options)
+      end
+
+      def version
+        @version ||= sequencer.get_last_seen
+      end
+
+      def sequencer
+        @sequencer ||= Alephant::Sequencer.create(config[:sequencer_table_name], key)
+      end
+
+      def config
+        @config
       end
     end
   end

data/lib/alephant/broker/models/response_factory.rb

@@ -13,9 +13,9 @@ module Alephant
       def response_from(request)
           case request.type
           when :asset
-            AssetResponse.new(request, @config)
+            AssetResponse.new(request, config)
           when :batch
-            BatchResponse.new(request, @config).process
+            BatchResponse.new(request, config).process
           when :status
             response(200)
           when :notfound
@@ -25,6 +25,12 @@ module Alephant
           end
       end
 
+      private
+
+      def config
+        @config
+      end
+
       def response(status)
         Response.new(status)
       end

data/lib/alephant/broker/version.rb

@@ -1,5 +1,5 @@
 module Alephant
   module Broker
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/spec/asset_response_spec.rb

@@ -1,73 +1,75 @@
 require 'spec_helper'
 
 describe Alephant::Broker::AssetResponse do
+  subject { Alephant::Broker::AssetResponse }
+
   describe "#initialize(request, config)" do
     let(:location) { 'test_location' }
+
     let(:config) {{
       :lookup_table_name => 'test_table',
       :bucket_id => 'test_bucket',
       :path => 'test_path'
     }}
+
     let(:request) { double(
                       "Alephant::Broker::Request",
                       :component_id => 'test',
                       :content_type => 'text/html',
+                      :type         => :asset,
                       :options      => { :variant => 'test_variant' }
                     )
                   }
 
     before do
-      @lookup_table = double('Alephant::Lookup::LookupTable')
-      Alephant::Lookup.stub(:create).and_return(@lookup_table)
-    end
-
-    it "Should return the content from a successful cache lookup" do
-      allow(@lookup_table)
-        .to receive(:read)
-        .with(request.options)
-        .and_return(location)
-
-      Alephant::Cache
-        .any_instance
-        .stub(:initialize)
-
-      Alephant::Cache
+      subject
         .any_instance
-        .stub(:get)
-        .with(location)
-        .and_return('Test cache content')
-
-      instance = Alephant::Broker::AssetResponse.new(request, config)
-
-      expect(instance.content).to eq('Test cache content')
-      expect(instance.status).to eq(200)
+        .stub(:s3_path)
+        .and_return(:foo)
     end
 
-    it "should return a 404 if lookup can't find a valid location" do
-      allow(@lookup_table)
-        .to receive(:read)
-        .with(request.options)
-        .and_return(nil)
+    context "successful" do
+      before(:each) do
+        subject
+          .any_instance
+          .stub(:cache)
+          .and_return(double(:get => 'Test'))
+      end
 
-      Alephant::Cache
-        .any_instance
-        .stub(:initialize)
+      it "Should return the content from a successful cache lookup" do
+        instance = subject.new(request, config)
 
-      instance = Alephant::Broker::AssetResponse.new(request, config)
-
-      expect(instance.content).to eq('Cache key not found based on component_id and options combination')
-      expect(instance.status).to eq(404)
+        expect(instance.content).to eq('Test')
+        expect(instance.status).to eq(200)
+      end
     end
 
-    it "should return a 500 for any other exceptions" do
-      allow(@lookup_table)
-        .to receive(:read)
-        .with(request.options)
-        .and_raise(Exception)
-
-      instance = Alephant::Broker::AssetResponse.new(request, config)
+    context "client failure" do
+      before(:each) do
+        subject
+          .any_instance
+          .stub(:cache)
+          .and_raise(Alephant::Broker::InvalidCacheKey)
+      end
+
+      it "should return a 404 if lookup can't find a valid location" do
+        instance = subject.new(request, config)
+        expect(instance.status).to eq(404)
+      end
+    end
 
-      expect(instance.status).to eq(500)
+    context "server failure" do
+      before(:each) do
+        subject
+          .any_instance
+          .stub(:cache)
+          .and_raise(Exception)
+      end
+
+      it "should return a 500 for any other exceptions" do
+        instance = subject.new(request, config)
+        expect(instance.status).to eq(500)
+      end
     end
   end
 end

data/spec/batch_response_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 
 describe Alephant::Broker::BatchResponse do
+  subject { Alephant::Broker::BatchResponse }
+
   let (:config) {{
     :lookup_table_name => 'test_table',
     :bucket_id => 'test_bucket',
@@ -15,6 +17,7 @@ describe Alephant::Broker::BatchResponse do
       :content_type  => 'application/json',
       :set_component => nil,
       :component_id  => nil,
+      :renderer_id   => nil,
       :components    => {
         :batch_id   => :baz,
         :components => [
@@ -25,31 +28,20 @@ describe Alephant::Broker::BatchResponse do
   }
 
   before do
-    @lookup_table = double('Alephant::Lookup::LookupTable', :read => 'test_location')
-
-    Alephant::Lookup
-      .stub(:create)
-      .and_return(@lookup_table)
-
-    Alephant::Cache
+    Alephant::Broker::AssetResponse
       .any_instance
       .stub(:initialize)
-
-    Alephant::Cache
-      .any_instance
-      .stub(:get)
-      .and_return('Test response')
   end
 
   describe "#process" do
     context "if a component is unrecognised" do
       before(:each) do
-        Alephant::Cache
+        Alephant::Broker::AssetResponse
           .any_instance
-          .stub(:get)
-          .and_raise(Alephant::Broker::InvalidCacheKey)
+          .stub(:status)
+          .and_return(404)
 
-        instance       = Alephant::Broker::BatchResponse.new(post_request, config)
+        instance       = subject.new(post_request, config)
         json           = JSON.parse(instance.process.content)
         @bad_component = json.fetch('components')[1]
       end
@@ -65,7 +57,17 @@ describe Alephant::Broker::BatchResponse do
 
     context "if a component is recognised" do
       before(:each) do
-        @instance = Alephant::Broker::BatchResponse.new(post_request, config)
+        Alephant::Broker::AssetResponse
+          .any_instance
+          .stub(:status)
+          .and_return(200)
+
+        Alephant::Broker::AssetResponse
+          .any_instance
+          .stub(:content)
+          .and_return('Test')
+
+        @instance = subject.new(post_request, config)
         @content  = @instance.process.content
         @json     = JSON.parse(@content)
       end
@@ -77,7 +79,7 @@ describe Alephant::Broker::BatchResponse do
       end
 
       it "set @content to be JSON string containing retrieved components" do
-        compiled_json = '{"batch_id":"baz","components":[{"component":"foo1","options":{"variant":"bar1"},"status":200,"body":"Test response"},{"component":"foo2","options":{"variant":"bar2"},"status":200,"body":"Test response"}]}'
+        compiled_json = '{"batch_id":"baz","components":[{"component":"foo1","options":{"variant":"bar1"},"status":200,"body":"Test"},{"component":"foo2","options":{"variant":"bar2"},"status":200,"body":"Test"}]}'
         expect(@content).to eq(compiled_json)
       end
     end

data/spec/rack_spec.rb

@@ -12,11 +12,19 @@ describe 'Broker Rack Application' do
   before do
     RequestStore.store[:env] = nil
 
-    @lookup_table = double('Alephant::Lookup::LookupTable')
-    Alephant::Lookup.stub(:create).and_return(@lookup_table)
-
-    Alephant::Cache.any_instance.stub(:initialize)
-    Alephant::Cache.any_instance.stub(:get).and_return('Test response')
+    Alephant::Broker::AssetResponse
+      .any_instance
+      .stub(:initialize)
+
+    Alephant::Broker::AssetResponse
+      .any_instance
+      .stub(:status)
+      .and_return(200)
+
+    Alephant::Broker::AssetResponse
+      .any_instance
+      .stub(:content)
+      .and_return('Test')
   end
 
   def app
@@ -40,41 +48,44 @@ describe 'Broker Rack Application' do
   end
 
   it "Test asset data is returned" do
-    allow(@lookup_table).to receive(:read).and_return('some_location')
-
     get '/components/test_component'
+
     expect(last_response).to be_ok
-    expect(last_response.body).to eq('Test response')
+    expect(last_response.body).to eq('Test')
   end
 
   it "Tests query string parameters are passed correctly to lookup" do
-    variant = {:variant => 'test_variant'}
-    allow(@lookup_table).to receive(:read).with(variant).and_return('some_location')
-
     get '/components/test_component?variant=test_variant'
+
     expect(last_response).to be_ok
-    expect(last_response.body).to eq('Test response')
+    expect(last_response.body).to eq('Test')
   end
 
   it "Tests 404 when lookup doesn't return a valid location" do
-    allow(@lookup_table).to receive(:read).and_return(nil)
+    Alephant::Broker::AssetResponse
+      .any_instance
+      .stub(:status)
+      .and_return(404)
 
     get '/components/test_component'
+
     expect(last_response.status).to eq(404)
   end
 
   it "Tests 500 when exception is raised in application" do
-    allow(@lookup_table).to receive(:read).and_raise(Exception)
+    Alephant::Broker::AssetResponse
+      .any_instance
+      .stub(:status)
+      .and_return(500)
 
     get '/components/test_component'
+
     expect(last_response.status).to eq(500)
   end
 
   it "Test batch asset data is returned" do
-    allow(@lookup_table).to receive(:read).and_return('some_location')
-
     json          = '{"batch_id":"baz","components":[{"component":"ni_council_results_table"},{"component":"ni_council_results_table"}]}'
-    compiled_json = '{"batch_id":"baz","components":[{"component":"ni_council_results_table","status":200,"body":"Test response"},{"component":"ni_council_results_table","status":200,"body":"Test response"}]}'
+    compiled_json = '{"batch_id":"baz","components":[{"component":"ni_council_results_table","status":200,"body":"Test"},{"component":"ni_council_results_table","status":200,"body":"Test"}]}'
 
     post '/components/batch', json, "CONTENT_TYPE" => "application/json"
 

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 $: << File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'pry'
+require 'json'
 require 'alephant/broker'
 require 'request_store'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alephant-broker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Steven Jack
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-03-14 00:00:00.000000000 Z
+date: 2014-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -206,6 +206,20 @@ dependencies:
         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
 description: Brokers requests for alephant components
 email:
 - stevenmajack@gmail.com