alephant-broker 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c7eb9d93af6eb83061d4cba25206c4bd7aeb391
-  data.tar.gz: a8acd8e9e369fe2c00deedf2ede6fe3fa513842b
+  metadata.gz: 62ea8a88fdcc92e2e8d8cacf3b7b35e4dc3077d0
+  data.tar.gz: e58c67bdb11c2b4028bb897337f795ca13e9a48f
 SHA512:
-  metadata.gz: f499be32c43b244351fe3e1d56aec13f71cc9ad3d4efacbc0bdeb677689f62070dc6345bd5972193a597859985fec5e3c50734e67a92222ab1116f065ab1f66b
-  data.tar.gz: 92d32d8eb5e3a5a2123fb7dc80b4ff45d4724548c78055ba704eb11df2201ad0d7dd448fdd282981d77d879ade9ee4fafb066f1254556ded486299af1c83c11f
+  metadata.gz: f4a00e454e3dd9ea1b6ca4bfd8c62e99df6791891c30873153a1546254e29c679e4145751cb7371f46da59f317c583f5a35231650d954fb863b97d7a6dcbef99
+  data.tar.gz: 2dbbb0dbdd399039794d5e72f120d1901087506e544384ada28c627422e7e2639dc1eee9b507e68925e06e82d0ffa8fba5b6db05eaa5f3f32f44cd49492bb8e0

data/.gitignore

@@ -4,4 +4,3 @@ Gemfile.lock
 *.gem
 
 /pkg
-.ruby-version

data/.ruby-version

@@ -0,0 +1 @@
+jruby-1.7.9

data/.travis.yml

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

data/Rakefile

@@ -1,3 +1,9 @@
-$: << File.join(File.dirname(__FILE__),"..", "lib")
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
 
-require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+require 'alephant/broker'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/alephant-broker.gemspec

@@ -28,7 +28,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
 
   spec.add_runtime_dependency "alephant-lookup"
   spec.add_runtime_dependency "alephant-cache"
+  spec.add_runtime_dependency 'alephant-logger'
 end

data/lib/alephant/broker/app.rb

@@ -2,10 +2,13 @@ $: << File.dirname(__FILE__)
 
 require 'alephant/broker'
 require 'alephant/broker/models/request'
+require 'alephant/logger'
 
 module Alephant
   module Broker
     class Application
+      include Logger
+
       def initialize(config)
         @config = config
       end

data/lib/alephant/broker/errors/invalid_cache_key.rb

@@ -2,6 +2,10 @@ module Alephant
   module Broker
     class InvalidCacheKey < Exception
 
+      def initialize
+        super("Cache key not found based on component_id and options combination")
+      end
+
     end
   end
 end

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

@@ -1,8 +1,10 @@
-require 'cgi'
+require 'alephant/logger'
 
 module Alephant
   module Broker
     class Request
+      include Logger
+
       attr_reader :type, :component_id, :options, :extension, :content_type
 
       DEFAULT_EXTENSION = :html
@@ -16,17 +18,20 @@ module Alephant
         request = request_components(path, querystring)
         case request[:type]
         when "component"
+          logger.info("Broker.request: Type: component, Asset ID: #{request[:component_id]}, Options: #{request[:options].inspect}")
           @type = :asset
 
           @component_id = request[:component_id]
           raise Errors::InvalidAssetId.new("No Asset ID specified") if @component_id.nil?
 
           @options = request[:options]
-          @extension = request[:extension] || DEFAULT_EXTENSION
+          @extension = request[:extension]
           @content_type = @@extension_mapping[@extension.to_sym] || @@extension_mapping[DEFAULT_EXTENSION]
         when "status"
+          logger.info("Broker.request: Type: status")
           @type = :status
         else
+          logger.info("Broker.request: Type: notfound")
           @type = :notfound
         end
       end
@@ -35,10 +40,11 @@ module Alephant
 
       def request_components(path, query_string)
         request_parts = path.split('/')
+        extension = path.split('.')[1] ? path.split('.')[1].to_sym : DEFAULT_EXTENSION
         {
           :type         => request_parts[1],
           :component_id => (request_parts[2] || '').split('.')[0],
-          :extension    => path.split('.')[1],
+          :extension    => extension,
           :options      => options_from(query_string)
         }
       end

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

@@ -4,6 +4,7 @@ require 'alephant/broker/models/response_factory'
 module Alephant
   module Broker
     class RequestHandler
+      include Logger
 
       def initialize(config)
         @response_factory = ResponseFactory.new(config)
@@ -13,6 +14,7 @@ module Alephant
         begin
           @response_factory.response_from(request)
         rescue Exception => e
+          logger.info("Broker.requestHandler.process: Exception raised (#{e.message})")
           @response_factory.response(500)
         end
       end

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

@@ -5,6 +5,7 @@ require 'alephant/broker/errors/invalid_cache_key'
 module Alephant
   module Broker
     class AssetResponse < Response
+      include Logger
 
       attr_reader :request
 
@@ -19,16 +20,22 @@ module Alephant
         begin
           self.content_type = request.content_type
           self.content = @cache.get cache_id
-        rescue AWS::S3::Errors::NoSuchKey, InvalidCacheKey
-          self.status = 404
+        rescue AWS::S3::Errors::NoSuchKey, InvalidCacheKey => e
+          set_error_for(e, 404)
         rescue Exception => e
-          self.status = 500
+          set_error_for(e, 500)
         end
 
       end
 
       private
 
+      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? }
       end

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

@@ -5,12 +5,11 @@ module Alephant
   module Broker
     class ResponseFactory
 
-      def initialize(config)
+      def initialize(config = nil)
         @config = config
       end
 
       def response_from(request)
-
           case request.type
           when :asset
             AssetResponse.new(request, @config)
@@ -21,7 +20,6 @@ module Alephant
           when :error
             response(500)
           end
-
       end
 
       def response(status)

data/lib/alephant/broker/version.rb

@@ -1,5 +1,5 @@
 module Alephant
   module Broker
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/spec/asset_response_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Alephant::Broker::AssetResponse do
+
+  describe "#initialize(request, config)" do
+    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', :options => {:variant => 'test_variant'} ) }
+    let(:location) { 'test_location' }
+
+    before {
+      @lookup_table = double('Alephant::Lookup::LookupTable')
+      Alephant::Lookup.stub(:create).and_return(@lookup_table)
+    }
+
+    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.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)
+    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)
+      Alephant::Cache.any_instance.stub(:initialize)
+      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)
+    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)
+
+      expect(instance.status).to eq(500)
+
+    end
+
+  end
+
+end
+
+

data/spec/rack_spec.rb

@@ -0,0 +1,72 @@
+ENV['RACK_ENV'] = 'test'
+
+require 'rack/test'
+require 'alephant/broker/app/rack'
+
+RSpec.configure do |conf|
+  conf.include Rack::Test::Methods
+end
+
+describe 'Broker rack app tests' do
+
+  before {
+    @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')
+  }
+
+  def app
+    Alephant::Broker::RackApplication.new({
+      :lookup_table_name  => 'test_table',
+      :bucket_id          => 'test_bucket',
+      :path               => 'bucket_path'
+    })
+  end
+
+  it "Tests status page" do
+    get '/status'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('ok')
+  end
+
+  it "Tests not found page" do
+    get '/some/non-existent-page'
+    expect(last_response.status).to eq(404)
+    expect(last_response.body).to eq('Not found')
+  end
+
+  it "Test asset data is returned" do
+    allow(@lookup_table).to receive(:read).and_return('some_location')
+
+    get '/component/test_component'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('Test response')
+  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 '/component/test_component?variant=test_variant'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('Test response')
+  end
+
+  it "Tests 404 when lookup doesn't return a valid location" do
+    allow(@lookup_table).to receive(:read).and_return(nil)
+
+    get '/component/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)
+
+    get '/component/test_component'
+    expect(last_response.status).to eq(500)
+  end
+
+end

data/spec/request_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Alephant::Broker::Request do
+
+  describe "#initialize(path, querystring)" do
+    let(:component_id) { 'foo' }
+    let(:querystring) { 'variant=test' }
+
+
+    it "Sets the component id" do
+
+      instance = Alephant::Broker::Request.new("/component/#{component_id}", '')
+      expect(instance.component_id).to eq(component_id)
+    end
+
+    it "Sets the request type to asset" do
+
+      instance = Alephant::Broker::Request.new("/component/#{component_id}", '')
+      expect(instance.type).to eq(:asset)
+      expect(instance.options).to eq({})
+    end
+
+    it "Sets the request type to asset with parsed options" do
+      instance = Alephant::Broker::Request.new("/component/#{component_id}", querystring)
+      expect(instance.type).to eq(:asset)
+      expect(instance.options).to eq({ :variant => 'test' })
+
+    end
+
+    it "Sets the request type to status" do
+      instance = Alephant::Broker::Request.new("/status", '')
+      expect(instance.type).to eq(:status)
+    end
+
+    it "Sets the default extension" do
+      instance = Alephant::Broker::Request.new("/component/blah", '')
+      expect(instance.extension).to eq(:html)
+    end
+
+    it "Sets the extension from the path" do
+      instance = Alephant::Broker::Request.new("/component/blah.json", '')
+      expect(instance.extension).to eq(:json)
+    end
+
+    it "Sets the content type to default if the extension does not exist" do
+      instance = Alephant::Broker::Request.new("/component/blah.test", '')
+      expect(instance.content_type).to eq('text/html')
+    end
+
+  end
+end

data/spec/response_factory_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Alephant::Broker::ResponseFactory do
+
+  describe "#response_from(request)" do
+    let (:request) { double("Alephant::Broker::Request") }
+
+    it "should return as asset response" do
+      instance = Alephant::Broker::ResponseFactory.new({})
+      allow(request).to receive(:type).and_return(:asset)
+
+      Alephant::Broker::AssetResponse.any_instance.stub(:initialize).with(request, {})
+      expect(instance.response_from(request)).to be_a Alephant::Broker::AssetResponse
+    end
+
+    it "should return a status response" do
+      allow(request).to receive(:type).and_return(:status)
+      response = subject.response_from(request)
+      expect(response.status).to eq(200)
+    end
+
+    it "should return a 404 response" do
+      allow(request).to receive(:type).and_return(:notfound)
+      response = subject.response_from(request)
+      expect(response.status).to eq(404)
+    end
+
+    it "should return a 500 response" do
+      allow(request).to receive(:type).and_return(:error)
+      response = subject.response_from(request)
+      expect(response.status).to eq(500)
+    end
+
+  end
+end

metadata

@@ -1,169 +1,197 @@
 --- !ruby/object:Gem::Specification
 name: alephant-broker
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Steven Jack
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-02-20 00:00:00.000000000 Z
+date: 2014-02-24 00:00:00.000000000 Z
 dependencies:
 - !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'
-  type: :development
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec-nc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: guard
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: pry
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: pry-remote
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-remote
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: pry-nav
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  type: :development
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
+  prerelease: false
+  type: :development
 - !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'
-  type: :development
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rack-test
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: alephant-lookup
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :development
+- !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-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'
-  type: :runtime
   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
 description: Brokers requests for alephant components
 email:
 - stevenmajack@gmail.com
@@ -172,6 +200,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .ruby-version
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -188,12 +218,16 @@ files:
 - lib/alephant/broker/models/response/asset_response.rb
 - lib/alephant/broker/models/response_factory.rb
 - lib/alephant/broker/version.rb
+- spec/asset_response_spec.rb
+- spec/rack_spec.rb
+- spec/request_spec.rb
+- spec/response_factory_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/BBC-News/alephant-broker
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -208,10 +242,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.3
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
 specification_version: 4
 summary: Brokers requests for alephant components
 test_files:
+- spec/asset_response_spec.rb
+- spec/rack_spec.rb
+- spec/request_spec.rb
+- spec/response_factory_spec.rb
 - spec/spec_helper.rb