alephant-broker 2.1.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d0fba4a759155935e050a30431e65427f220f4d
-  data.tar.gz: 0137552efcd8d64f3d9539938542b27ea2ab3544
+  metadata.gz: 71dd81ac255c7701b1676aa6f0e57d6c9913789e
+  data.tar.gz: 1ddc1f6954fe7302e9c87aba60ea0d1daee40b3d
 SHA512:
-  metadata.gz: 4c0855c51f3d4d04f68b5772709f2d6174cdee95b15cb7e09198df64060b7c03ef66a323a3fd668e6f565cd96ccc2896c1be41a8086fbf7cb35940a478d387dd
-  data.tar.gz: a025fa90065324a15f51be05633239bbfa0fe212cdd3b425c1e3ebc5ff8ee099acceec0dfc965139a6065df4412f5d1aa9f02e0a6961c9e6a50bd94403631aaf
+  metadata.gz: adf9b7900d4723e2f7686c26848b856cc43d440c1e12d0e5fe524461939aab2950aba64ca3c7adf8bc69036c952e7a55c21a41371655605294274668e4d1a80c
+  data.tar.gz: 25553c80bb8a7c8c25c330d728df926fc9662d46df3349dd8491064c4c8babc56996fc47aa90cb5b885e2b109f6a1adbc0d1e6f326bfc3cf7c3f3c5e5ee2de48

data/README.md

@@ -1,10 +1,8 @@
 # Alephant::Broker
 
-Brokers requests for rendered templates stored in S3
+Brokers requests for rendered templates, retrieved from S3 or a HTML endpoint.
 
-[![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)
+[![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
 
@@ -14,101 +12,105 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    bundle install
 
 Or install it yourself as:
 
-    $ gem install alephant-broker
+    gem install alephant-broker
 
 ## Usage
 
+The **Broker** is capable of retrieving rendered templates from either [S3](http://aws.amazon.com/s3/) or a HTML endpoint (e.g. [alephant-publisher-request](https://github.com/BBC-News/alephant-publisher-request)). This must be decided when creating an instance of the **Broker**, as a **load strategy** is given as a parameter (see below for examples).
+
 ### Barebones
 
+##### S3 Load Strategy
+
 ```ruby
 require 'alephant/broker'
+require 'alephant/broker/load_strategy/s3'
 
-request = Alephant::Broker::Request.new('/component/id', 'variant=hello')
-config  = {
-  :bucket_id         => "s3-render-example",
-  :path              => "foo",
-  :lookup_table_name => "example_lookup"
+config = {
+  :bucket_id         => 'test_bucket',
+  :path              => 'foo',
+  :lookup_table_name => 'test_lookup'
 }
 
-broker = Alephant::Broker.handle(request, config)
+request = {
+  'PATH_INFO'      => '/component/foo',
+  'QUERY_STRING'   => 'variant=bar',
+  'REQUEST_METHOD' => 'GET'
+}
 
-# => #<Alephant::Broker::Response:0x5215005d
-# @content="<p>some HTML response</p>",
-# @content_type="text/html",
-# @status=200>
+Alephant::Broker::Application.new(
+  Alephant::Broker::LoadStrategy::S3.new,
+  config
+).call(request).tap do |response|
+  puts "status:  #{response.status}"
+  puts "content: #{response.content}"
+end
 ```
 
-### Simple App
+##### HTML Load Strategy
 
 ```ruby
-require 'alephant/broker/app'
+require 'alephant/broker'
+require 'alephant/broker/load_strategy/http'
+
+class UrlGenerator < Alephant::Broker::LoadStrategy::HTTP::URL
+  def generate(id, options)
+    "http://example-api.com/data?id=#{id}"
+  end
+end
 
-config  = {
-  :bucket_id         => "s3-render-example",
-  :path              => "foo",
-  :lookup_table_name => "example_lookup"
+request = {
+  'PATH_INFO'      => '/component/foo',
+  'QUERY_STRING'   => 'variant=bar',
+  'REQUEST_METHOD' => 'GET'
 }
 
-app = Alephant::Broker::Application.new(config)
-request = app.request_from('/component/id', 'variant=hello')
+Alephant::Broker::Application.new(
+  Alephant::Broker::LoadStrategy::HTTP.new(UrlGenerator.new),
+  {}
+).call(request).tap do |response|
+  puts "status:  #{response.status}"
+  puts "content: #{response.content}"
+end
+```
+
+**Note**: the HTML load strategy relies upon being given a [URLGenerator](https://github.com/BBC-News/alephant-broker/blob/master/lib/alephant/broker/load_strategy/http.rb#L9-L13). This must be implemented within your own application, and extend `Alephant::Broker::LoadStrategy::HTTP::URL` (see above for an example). It is used to generate the URL which will act as the HTML endpoint.
 
-app.handle(request)
+### Rack App
 
-# => #<Alephant::Broker::Response:0x5215005d
-# @content="<p>some HTML response</p>",
-# @content_type="text/html",
-# @status=200>
-```
+Create **config.ru** using example below, and then run:
 
-### Rack
+    rackup config.ru
 
 ```ruby
-require 'alephant/broker/app/rack'
-require 'configuration'
-
-module Foo
-  class Bar < Alephant::Broker::RackApplication
-    def initialize
-      super(Configuration.new)
-    end
+require 'alephant/broker'
+require 'alephant/broker/load_strategy/http'
+
+class UrlGenerator < Alephant::Broker::LoadStrategy::HTTP::URL
+  def generate(id, options)
+    "http://example-api.com/data?id=#{id}"
   end
 end
+
+run Alephant::Broker::Application.new(
+  Alephant::Broker::LoadStrategy::HTTP.new(UrlGenerator.new),
+  {}
+)
 ```
 
-## Pry'ing
+## Contributing
 
-If you're using Pry to debug this gem...
+1. [Fork it!]( http://github.com/bbc-news/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 a new [Pull Request](https://github.com/BBC-News/alephant-broker/pulls).
 
-```ruby
-export AWS_ACCESS_KEY_ID='xxxx'
-export AWS_SECRET_ACCESS_KEY='xxxx'
-export AWS_REGION='eu-west-1'
+Feel free to create a new [issue](https://github.com/BBC-News/alephant-broker/issues/new) if you find a bug.
 
-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/lib/alephant/broker/environment.rb

@@ -1,5 +1,6 @@
 require 'json'
 require 'alephant/logger'
+require 'rack'
 
 module Alephant
   module Broker

data/lib/alephant/broker/request.rb

@@ -5,7 +5,6 @@ module Alephant
       require 'alephant/broker/request/batch'
       require 'alephant/broker/request/factory'
       require 'alephant/broker/request/handler'
-      require 'alephant/broker/request/multi'
 
       class NotFound; end
       class Status; end

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

@@ -13,8 +13,6 @@ module Alephant
           component_factory = ComponentFactory.new load_strategy
 
           case request_type_from(env)
-          when 'multi'
-            Multi.new(env)
           when 'component'
             Asset.new(component_factory, env)
           when 'components'

data/lib/alephant/broker/response.rb

@@ -4,7 +4,6 @@ module Alephant
       require 'alephant/broker/response/base'
       require 'alephant/broker/response/asset'
       require 'alephant/broker/response/batch'
-      require 'alephant/broker/response/multi'
       require 'alephant/broker/response/factory'
 
       class NotFound < Base

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

@@ -10,8 +10,6 @@ module Alephant
             Asset.new(request.component)
           when Request::Batch
             Batch.new(request.components, request.batch_id)
-          when Request::Multi
-            Multi.new(request.requests)
           when Request::Status
             Status.new
           else

data/lib/alephant/broker/version.rb

@@ -1,5 +1,5 @@
 module Alephant
   module Broker
-    VERSION = "2.1.3"
+    VERSION = "3.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alephant-broker
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 3.0.0
 platform: ruby
 authors:
 - Steven Jack
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-11-06 00:00:00.000000000 Z
+date: 2014-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -309,13 +309,11 @@ files:
 - lib/alephant/broker/request/batch.rb
 - lib/alephant/broker/request/factory.rb
 - lib/alephant/broker/request/handler.rb
-- lib/alephant/broker/request/multi.rb
 - lib/alephant/broker/response.rb
 - lib/alephant/broker/response/asset.rb
 - lib/alephant/broker/response/base.rb
 - lib/alephant/broker/response/batch.rb
 - lib/alephant/broker/response/factory.rb
-- lib/alephant/broker/response/multi.rb
 - lib/alephant/broker/version.rb
 - spec/component_meta_spec.rb
 - spec/fixtures/json/batch.json

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

@@ -1,40 +0,0 @@
-require 'alephant/logger'
-require 'alephant/broker/component'
-
-module Alephant
-  module Broker
-    module Request
-      class Multi
-        include Logger
-
-        attr_reader :requests
-
-        def initialize(env)
-          logger.debug("Request::Multi#initialize(#{env.settings})")
-          @requests = requests_for env
-        end
-
-        private
-
-        def requests_for(env)
-          env.data['requests'].map do |c|
-            case c['type']
-            when 'asset'
-              asset = Asset.new
-
-              component_id = c['payload']['component_id']
-              options      = c['payload']['options']
-
-              component = Component.new(component_id, nil, options)
-              asset.tap { |a| a.component = component }
-            else
-              raise StandardError.new "request type not identified"
-            end
-          end
-        end
-
-      end
-    end
-  end
-end
-

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

@@ -1,49 +0,0 @@
-require 'json'
-
-module Alephant
-  module Broker
-    module Response
-      class Multi < Base
-        attr_reader :requests
-
-        POLLING_DELAY = 2
-
-        def initialize(requests)
-          @requests = requests
-
-          super()
-        end
-
-        def raw_response
-          requests.reduce(:delay => POLLING_DELAY, :responses => []) do |m,request|
-            response = Factory.response_for request
-
-            case response
-            when Asset
-              m[:responses] << {
-                :type     => response.class.to_s.downcase,
-                :datatype => response.content_type,
-                :payload  => {
-                  :component_id => response.component.id,
-                  :options      => response.component.options,
-                  :body         => response.to_h
-                }
-              }
-            when NotFound
-              # Do nothing
-            else
-              raise StandardError.new "response type not identified"
-            end
-
-            m
-          end
-        end
-
-        def setup
-          @content_type = 'application/json'
-          @content      = JSON.generate(raw_response)
-        end
-      end
-    end
-  end
-end