alephant-broker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4990f7ae94eb498ef2fc00824325d839ca80cb1b
+  data.tar.gz: 8b7fe24b2c111717e7023675383943172d194ce2
+SHA512:
+  metadata.gz: bfe0972285fd8270c402a313a761c313407ba10d8cca5b28481299f0c1ea96dc2494ac9abb898576868b74d1bce3a8290ed935dccd1b980a95536f844c6aa28c
+  data.tar.gz: 20ecc192a81a4a6e5e06240996537c0643bc03d74aa7e127f1611121d2eca43a51c82b96a403adc8d333755ba577f3bf26ca5aaf471bcc6fb1e53f50ea79674d

data/.gitignore

@@ -0,0 +1,7 @@
+*.swp
+Gemfile.lock
+.rspec
+*.gem
+
+/pkg
+.ruby-version

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in alephant-broker.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 Steven Jack
+
+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,114 @@
+# Alephant::Broker
+
+Brokers requests for rendered templates stored in S3
+
+[![Build Status](https://travis-ci.org/BBC-News/alephant-broker.png?branch=master)](https://travis-ci.org/BBC-News/alephant-broker)
+
+[![Gem Version](https://badge.fury.io/rb/alephant-broker.png)](http://badge.fury.io/rb/alephant-broker)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'alephant-broker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install alephant-broker
+
+## Usage
+
+### Barebones
+
+```ruby
+require 'alephant/broker'
+
+request = Alephant::Broker::Request.new('/component/id', 'variant=hello')
+config  = {
+  :bucket_id         => "s3-render-example",
+  :path              => "foo",
+  :lookup_table_name => "example_lookup"
+}
+
+broker = Alephant::Broker.handle(request, config)
+
+# => #<Alephant::Broker::Response:0x5215005d
+# @content="<p>some HTML response</p>",
+# @content_type="text/html",
+# @status=200>
+```
+
+### Simple App
+
+```ruby
+require 'alephant/broker/app'
+
+config  = {
+  :bucket_id         => "s3-render-example",
+  :path              => "foo",
+  :lookup_table_name => "example_lookup"
+}
+
+app = Alephant::Broker::Application.new(config)
+request = app.request_from('/component/id', 'variant=hello')
+
+app.handle(request)
+
+# => #<Alephant::Broker::Response:0x5215005d
+# @content="<p>some HTML response</p>",
+# @content_type="text/html",
+# @status=200>
+```
+
+### Rack
+
+```ruby
+require 'alephant/broker/app/rack'
+require 'configuration'
+
+module Foo
+  class Bar < Alephant::Broker::RackApplication
+    def initialize
+      super(Configuration.new)
+    end
+  end
+end
+```
+
+## Pry'ing
+
+If you're using Pry to debug this gem...
+
+```ruby
+export AWS_ACCESS_KEY_ID='xxxx'
+export AWS_SECRET_ACCESS_KEY='xxxx'
+export AWS_REGION='eu-west-1'
+
+config = {
+  :bucket_id         => "s3-render-example",
+  :path              => "foo",
+  :lookup_table_name => "example_lookup"
+}
+ 
+env = {
+  "PATH_INFO"    => "/component/england_council_header",
+  "QUERY_STRING" => ""
+}
+ 
+require 'alephant/broker/app/rack'
+ 
+app = Alephant::Broker::RackApplication.new(config)
+app.call(env)
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/alephant-broker/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,3 @@
+$: << File.join(File.dirname(__FILE__),"..", "lib")
+
+require "bundler/gem_tasks"

data/alephant-broker.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'alephant/broker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "alephant-broker"
+  spec.version       = Alephant::Broker::VERSION
+  spec.authors       = ["Steven Jack"]
+  spec.email         = ["stevenmajack@gmail.com"]
+  spec.summary       = "Brokers requests for alephant components"
+  spec.description   = "Brokers requests for alephant components"
+  spec.homepage      = "https://github.com/BBC-News/alephant-broker"
+  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 "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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+
+  spec.add_runtime_dependency "alephant-lookup"
+  spec.add_runtime_dependency "alephant-cache"
+end

data/lib/alephant/broker.rb

@@ -0,0 +1,13 @@
+require "alephant/broker/version"
+require "alephant/broker/models/request_handler"
+
+module Alephant
+  module Broker
+
+    def self.handle(request, config = {})
+      @@request_handler ||= RequestHandler.new(config)
+      @@request_handler.process(request)
+    end
+  end
+
+end

data/lib/alephant/broker/app.rb

@@ -0,0 +1,23 @@
+$: << File.dirname(__FILE__)
+
+require 'alephant/broker'
+require 'alephant/broker/models/request'
+
+module Alephant
+  module Broker
+    class Application
+      def initialize(config)
+        @config = config
+      end
+
+      def handle(request)
+        Alephant::Broker.handle(request, @config)
+      end
+
+      def request_from(path, querystring)
+        Request.new(path, querystring)
+      end
+
+    end
+  end
+end

data/lib/alephant/broker/app/rack.rb

@@ -0,0 +1,25 @@
+$: << File.dirname(__FILE__)
+
+require 'alephant/broker/app'
+
+module Alephant
+  module Broker
+    class RackApplication < Application
+
+      def call(env)
+        response = handle(
+          request_from(env['PATH_INFO'], env['QUERY_STRING'])
+        )
+        send response
+      end
+
+      def send(response)
+        [
+          response.status,
+          {"Content-Type" => response.content_type},
+          [response.content.to_s]
+        ]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Alephant
+  module Broker
+    class InvalidCacheKey < Exception
+
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+require 'cgi'
+
+module Alephant
+  module Broker
+    class Request
+      attr_reader :type, :component_id, :options, :extension, :content_type
+
+      DEFAULT_EXTENSION = :html
+
+      @@extension_mapping = {
+        :html => 'text/html',
+        :json => 'application/json'
+      }
+
+      def initialize(path, querystring)
+        request = request_components(path, querystring)
+        case request[:type]
+        when "component"
+          @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
+          @content_type = @@extension_mapping[@extension.to_sym] || @@extension_mapping[DEFAULT_EXTENSION]
+        when "status"
+          @type = :status
+        else
+          @type = :notfound
+        end
+      end
+
+      def request_components(path, query_string)
+        request_parts = path.split('/')
+        {
+          :type         => request_parts[1],
+          :component_id => (request_parts[2] || '').split('.')[0],
+          :extension    => path.split('.')[1],
+          :options      => options_from(query_string)
+        }
+      end
+
+      def options_from(query_string)
+        query_string.split('&').reduce({}) do |object, key_pair|
+          key, value = key_pair.split('=')
+          object.tap { |o| o.store(key, value) }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+require 'alephant/broker/models/request'
+require 'alephant/broker/models/response_factory'
+
+module Alephant
+  module Broker
+    class RequestHandler
+
+      def initialize(config)
+        @response_factory = ResponseFactory.new(config)
+      end
+
+      def process(request)
+        begin
+          @response_factory.response_from(request)
+        rescue Exception => e
+          @response_factory.response(500)
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Alephant
+  module Broker
+    class Response
+      attr_accessor :content, :content_type
+      attr_reader :status
+
+      STATUS_CODE_MAPPING = {
+        200 => 'ok',
+        404 => 'Not found',
+        500 => 'Error retrieving content'
+      }
+
+      def initialize(status = 200)
+        @content_type = "text/html"
+        self.status = status
+        setup
+      end
+
+      def status=(code)
+        @status = code
+        @content = STATUS_CODE_MAPPING[code]
+      end
+
+      def setup; end
+
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+require 'alephant/cache'
+require 'alephant/lookup'
+require 'alephant/broker/errors/invalid_cache_key'
+
+module Alephant
+  module Broker
+    class AssetResponse < Response
+
+      attr_reader :request
+
+      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])
+        super()
+      end
+
+      def setup
+        begin
+          self.content_type = request.content_type
+          self.content = @cache.get cache_id
+        rescue AWS::S3::Errors::NoSuchKey, InvalidCacheKey
+          self.status = 404
+        rescue Exception => e
+          self.status = 500
+        end
+
+      end
+
+      private
+
+      def cache_id
+        @lookup.read(request.options).tap { |cache_id| raise InvalidCacheKey if cache_id.nil? }
+      end
+
+    end
+  end
+end
+
+

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

@@ -0,0 +1,33 @@
+require 'alephant/broker/models/response'
+require 'alephant/broker/models/response/asset_response'
+
+module Alephant
+  module Broker
+    class ResponseFactory
+
+      def initialize(config)
+        @config = config
+      end
+
+      def response_from(request)
+
+          case request.type
+          when :asset
+            AssetResponse.new(request, @config)
+          when :status
+            response(200)
+          when :notfound
+            response(404)
+          when :error
+            response(500)
+          end
+
+      end
+
+      def response(status)
+        Response.new(status)
+      end
+
+    end
+  end
+end

data/lib/alephant/broker/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$: << File.join(File.dirname(__FILE__),"..", "lib")
+
+require 'alephant/broker'
+
+

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: alephant-broker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Steven Jack
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2014-02-19 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'
+  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: 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: 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: :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'
+  prerelease: false
+  type: :runtime
+description: Brokers requests for alephant components
+email:
+- stevenmajack@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- alephant-broker.gemspec
+- lib/alephant/broker.rb
+- lib/alephant/broker/app.rb
+- lib/alephant/broker/app/rack.rb
+- lib/alephant/broker/errors/invalid_cache_key.rb
+- lib/alephant/broker/models/request.rb
+- lib/alephant/broker/models/request_handler.rb
+- lib/alephant/broker/models/response.rb
+- lib/alephant/broker/models/response/asset_response.rb
+- lib/alephant/broker/models/response_factory.rb
+- lib/alephant/broker/version.rb
+- spec/spec_helper.rb
+homepage: https://github.com/BBC-News/alephant-broker
+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: Brokers requests for alephant components
+test_files:
+- spec/spec_helper.rb