hypernova 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  metadata.gz: 6154064fe73279cdc77345298bdf5739bd92acd9
+  data.tar.gz: 7cd5efc03841f7897c80ef0eb297a24e45d3e758
+SHA512: 
+  metadata.gz: 1c2f2306577a3f8542c77995c962a8ea713d54cb17ef06110b2bce04d9a465f8aa2eb9e037dcb2f50b21d6ab26c1838cd483c51bd78fe389425477b2ce39bef5
+  data.tar.gz: 8b6f89f50c0597b6f552ab575054836f513c8717effa6ec5370555900a431a9a94edd1b5f86251ef2d49f120e2972d972875ce334ee872fa4eb265a3dac43600

data/.gitignore

@@ -0,0 +1,38 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+mystique-ruby-*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+script:
+  - bundle exec rspec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hypernova.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Airbnb
+
+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,211 @@
+# hypernova-ruby [![Build Status](https://travis-ci.org/airbnb/hypernova-ruby.svg)](https://travis-ci.org/airbnb/hypernova-ruby)
+
+> A Ruby client for the Hypernova service
+
+## Getting Started
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'hypernova'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hypernova
+
+
+In Rails, create an initializer in `config/initializers/hypernova.rb`.
+
+```ruby
+# Really basic configuration only consists of the host and the port
+Hypernova.configure do |config|
+  config.host = "localhost"
+  config.port = 80
+end
+```
+
+Add an `:around_filter` to your controller so you can opt into Hypernova rendering of view partials.
+
+```ruby
+# In my_controller.rb
+require 'hypernova'
+
+class MyController < ApplicationController
+  around_filter :hypernova_render_support
+end
+```
+
+Use the following methods to render React components in your view/templates.
+
+```erb
+<%=
+  render_react_component(
+    'MyComponent.js',
+    :name => 'Person',
+    :color => 'Blue',
+    :shape => 'Triangle'
+  )
+%>
+```
+
+## Configuration
+
+You can pass more configuration options to Hypernova.
+
+```ruby
+Hypernova.configure do |config|
+  config.http_adapter = :patron # Use any adapter supported by Faraday
+  config.host = "localhost"
+  config.port = 80
+  config.open_timeout = 0.1
+  config.scheme = :https # Valid schemes include :http and :https
+  config.timeout = 0.6
+end
+```
+
+If you do not want to use `Faraday`, you can configure Hypernova Ruby to use an HTTP client that
+responds to `post` and accepts a hash argument.
+
+```ruby
+Hypernova.configure do |config|
+  # Use your own HTTP client!
+  config.http_client = SampleHTTPClient.new
+end
+```
+
+You can access a lower-level interface to exactly specify the parameters that are sent to the
+Hypernova service.
+
+```erb
+<% things.each |thing| %>
+  <li>
+    <%=
+      hypernova_batch_render(
+        :name => 'your/component/thing.bundle.js',
+        :data => thing
+      )
+    %>
+  </li>
+<% end %>
+```
+
+You can also use the batch interface if you want to create and submit batches yourself:
+
+```ruby
+batch = Hypernova::Batch.new(service)
+
+# each job in a hypernova render batch is identified by a token
+# this allows retrieval of unordered jobs
+token = batch.render(
+  :name => 'some_bundle.bundle.js',
+  :data => {foo: 1, bar: 2}
+)
+token2 = batch.render(
+  :name => 'some_bundle.bundle.js',
+  :data => {foo: 2, bar: 1}
+)
+# now we can submit the batch job and await its results
+# this blocks, and takes a significant time in round trips, so try to only
+# use it once per request!
+result = batch.submit!
+
+# ok now we can access our rendered strings.
+foo1 = result[token].html_safe
+foo2 = result[token2].html_safe
+```
+
+## Plugins
+
+Hypernova enables you to control and alter requests at different stages of
+the render lifecycle via a plugin system.
+
+### Example
+
+All methods on a plugin are optional, and they are listed in the order that
+they are called.
+
+**initializers/hypernova.rb:**
+```ruby
+# initializers/hypernova.rb
+require 'hypernova'
+
+class HypernovaPlugin
+  # get_view_data allows you to alter the data given to any individual
+  # component being rendered.
+  # component is the name of the component being rendered.
+  # data is the data being given to the component.
+  def get_view_data(component_name, data)
+    phrase_hash = data[:phrases]
+    data[:phrases].keys.each do |phrase_key|
+      phrase_hash[phrase_key] = "test phrase"
+    end
+    data
+  end
+
+  # prepare_request allows you to alter the request object in any way that you
+  # need.
+  # Unless manipulated by another plugin, request takes the shape:
+  # { 'component_name.js': { :name => 'component_name.js', :data => {} } }
+  def prepare_request(current_request, original_request)
+    current_request.keys.each do |key|
+      phrase_hash = req[key][:data][:phrases]
+      if phrase_hash.present?
+        phrase_hash.keys.each do |phrase_key|
+          phrase_hash[phrase_key] = phrase_hash[phrase_key].upcase
+        end
+      end
+    end
+    current_request
+  end
+
+  # send_request? allows you to determine whether a request should continue
+  # on to the hypernova server.  Returning false prevents the request from
+  # occurring, and results in the fallback html.
+  def send_request?(request)
+    true
+  end
+
+  # after_response gives you a chance to alter the response from hypernova.
+  # This will be most useful for altering the resulting html field, and special
+  # handling of any potential errors.
+  # res is a Hash like { 'component_name.js': { html: String, err: Error? } }
+  def after_response(current_response, original_response)
+    current_response.keys.each do |key|
+      hash = current_response[key]
+      hash['html'] = '<div>hello</div>'
+    end
+    current_response
+  end
+
+  # NOTE: If an error happens in here, it won’t be caught.
+  def on_error(error, jobs)
+    puts "Oh no, error - #{error}, jobs - #{jobs}"
+  end
+end
+
+Hypernova.add_plugin!(HypernovaPlugin.new)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release` to create a git tag for the version, push git
+commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/hypernova/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

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hypernova"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hypernova.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hypernova/version"
+
+Gem::Specification.new do |spec|
+  spec.authors = %w(
+    Jake Teton-Landis
+    Jordan Harband
+    Ian Christian Myers
+    Tommy Dang
+  )
+  spec.bindir = "exe"
+  spec.description = "A Ruby client for the Hypernova service"
+  spec.email = %w(
+    jake.tl@airbnb.com
+    ljharb@gmail.com
+    ian.myers@airbnb.com
+    tommy.dang@airbnb.com
+  )
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.homepage = 'https://github.com/airbnb/hypernova-ruby'
+  spec.license = 'MIT'
+  spec.name = 'hypernova'
+  spec.require_paths = ["lib"]
+  spec.summary = %q{Batch interface for Hypernova, the React render service.}
+  spec.version = Hypernova::VERSION
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+  end
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "simplecov", "~> 0.11"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "webmock", "~> 2.0"
+
+  spec.add_runtime_dependency "faraday", "~> 0.8"
+end

data/lib/hypernova/batch.rb

@@ -0,0 +1,49 @@
+require 'forwardable'
+
+module Hypernova
+  class Batch
+    extend Forwardable
+
+    attr_accessor :service
+    attr_reader :jobs
+
+    def_delegators :jobs, :empty?
+
+    ##
+    # @param service the Hypernova backend service to use for render_react_batch
+    # The only requirement for the `service` object is the method render_react_batch
+    # which should accept a Hash of { job_token :: Scalar => job_data :: Hash }
+    # the subscript operator, to access result via tokens
+    def initialize(service)
+      # TODO: make hashmap instead????
+      @jobs = []
+      @service = service
+    end
+
+    def render(job)
+      Hypernova.verify_job_shape(job)
+      token = jobs.length
+      jobs << job
+      token.to_s
+    end
+
+    def submit!
+      service.render_batch(jobs_hash)
+    end
+
+    def submit_fallback!
+      service.render_batch_blank(jobs_hash)
+    end
+
+    private
+
+    attr_reader :service
+
+    # creates a hash with each index mapped to the value at that index
+    def jobs_hash
+      hash = {}
+      jobs.each_with_index { |job, idx| hash[idx.to_s] = job }
+      hash
+    end
+  end
+end

data/lib/hypernova/batch_renderer.rb

@@ -0,0 +1,65 @@
+require "hypernova/blank_renderer"
+
+class Hypernova::BatchRenderer
+  def initialize(jobs)
+    @jobs = jobs
+  end
+
+  # Sample response argument:
+  # {
+  #   "DeathStarLaserComponent.js" => {
+  #     "duration" => 17,
+  #     "error" => nil,
+  #     "html" => "<h1>Hello World</h1>",
+  #     "statusCode" => 200,
+  #     "success" => true,
+  #   },
+  #   "IonCannon.js" => {
+  #     "duration" => 7,
+  #     "error" => {
+  #       "stack" => [
+  #         "no_plans",
+  #         "not_enough_resources",
+  #       ],
+  #     },
+  #     "html" => blank_html_rendered_by_blank_renderer,
+  #     "statusCode" => 500,
+  #     "success" => false,
+  #   },
+  # }
+
+  # Example of what is returned by this method:
+  # {
+  #   "DeathStarLaserComponent.js" => "<h1>Hello World</h1>",
+  #   "IonCannon.js" => <p>Feel my power!</p>,
+  # }
+  def render(response)
+    response.each_with_object({}) do |array, hash|
+      name_of_component = array[0]
+      hash[name_of_component] = extract_html_from_result(name_of_component, array[1])
+    end
+  end
+
+  # Example of what is returned by this method:
+  # {
+  #   "DeathStarLaserComponent.js" => <div>I am blank</div>,
+  #   "IonCannon.js" => <div>I am blank</div>,
+  # }
+  def render_blank
+    hash = {}
+    jobs.each { |name_of_component, job| hash[name_of_component] = render_blank_html(job) }
+    hash
+  end
+
+  private
+
+  attr_reader :jobs
+
+  def extract_html_from_result(name_of_component, result)
+    result["html"].nil? ? render_blank_html(jobs[name_of_component]) : result["html"]
+  end
+
+  def render_blank_html(job)
+    Hypernova::BlankRenderer.new(job).render
+  end
+end

data/lib/hypernova/batch_url_builder.rb

@@ -0,0 +1,13 @@
+require "uri"
+
+class Hypernova::BatchUrlBuilder
+  def self.base_url
+    configuration = Hypernova.configuration
+    builder = configuration.scheme == :https ? URI::HTTPS : URI::HTTP
+    builder.build(host: configuration.host, port: configuration.port).to_s
+  end
+
+  def self.path
+    "/batch"
+  end
+end

data/lib/hypernova/blank_renderer.rb

@@ -0,0 +1,34 @@
+require "json"
+
+class Hypernova::BlankRenderer
+  def initialize(job)
+    @job = job
+  end
+
+  def render
+    <<-HTML
+      <div data-hypernova-key="#{key}"></div>
+      <script type="application/json" data-hypernova-key="#{key}"><!--#{encode}--></script>
+    HTML
+  end
+
+  private
+
+  attr_reader :job
+
+  def data
+    job[:data]
+  end
+
+  def encode
+    JSON.generate(data).gsub(/&/, '&amp;').gsub(/>/, '&gt;')
+  end
+
+  def key
+    name.gsub(/\W/, "")
+  end
+
+  def name
+    job[:name]
+  end
+end

data/lib/hypernova/configuration.rb

@@ -0,0 +1,34 @@
+require "faraday"
+
+class Hypernova::Configuration
+  VALID_SCHEMES = [:http, :https].freeze
+
+  attr_accessor :http_adapter,
+                :http_client,
+                :host,
+                :open_timeout,
+                :port,
+                :scheme,
+                :timeout
+
+  def initialize
+    @open_timeout = 0.1
+    @scheme = :http
+    @timeout = 0.6
+  end
+
+  def http_adapter
+    @http_adapter || Faraday.default_adapter
+  end
+
+  def scheme=(value)
+    validate_scheme!(value)
+    @scheme = value
+  end
+
+  private
+
+  def validate_scheme!(value)
+    raise TypeError.new("Unknown scheme #{value}") unless VALID_SCHEMES.include?(value)
+  end
+end

data/lib/hypernova/controller_helpers.rb

@@ -0,0 +1,106 @@
+require "hypernova/plugin_helper"
+require "hypernova/request_service"
+
+module Hypernova
+  ##
+  # Mixin.
+  # Implements the high-level rails helper interface.
+  # Currently untested.
+  module ControllerHelpers
+    include Hypernova::PluginHelper
+
+    ##
+    # a Rails around_filter to support hypernova batch rendering.
+    def hypernova_render_support
+      hypernova_batch_before
+      yield
+      hypernova_batch_after
+    end
+
+    ##
+    # enqueue a render into the current request's hypernova batch
+    def hypernova_batch_render(job)
+      if @hypernova_batch.nil?
+        raise NilBatchError.new('called hypernova_batch_render without calling '\
+          'hypernova_batch_before. Check your around_filter for :hypernova_render_support')
+      end
+      batch_token = @hypernova_batch.render(job)
+      template_safe_token = Hypernova.render_token(batch_token)
+      @hypernova_batch_mapping[template_safe_token] = batch_token
+      template_safe_token
+    end
+
+    ##
+    # shortcut method to render a react component
+    # @param [String] name the hypernova bundle name, like 'packages/p3/foo.bundle.js' (for now)
+    # @param [Hash] props the props to be passed to the component
+    # :^)k|8 <-- this is a chill peep riding a skateboard
+    def render_react_component(component, data = {})
+      begin
+        new_data = get_view_data(component, data)
+      rescue StandardError => e
+        on_error(e)
+        new_data = data
+      end
+      job = {
+        :data => new_data,
+        :name => component,
+      }
+
+      hypernova_batch_render(job)
+    end
+
+    ##
+    # Retrieve a handle to a hypernova service
+    # OVERRIDE IN YOUR IMPLEMENTATION CLASS TO GET A DIFFERENT SERVICE
+    def hypernova_service
+      @_hypernova_service ||= Hypernova::RequestService.new
+    end
+
+    private
+
+    ##
+    # set up a new hypernova batch for this request.
+    # The batch's service is provided by instance method #hypernova_service
+    # which you should override after including this mixin.
+    def hypernova_batch_before
+      @hypernova_batch = Hypernova::Batch.new(hypernova_service)
+      @hypernova_batch_mapping = {}
+    end
+
+    ##
+    # Modifies response.body to have all batched hypernova render results
+    def hypernova_batch_after
+      if @hypernova_batch.nil?
+        raise NilBatchError.new('called hypernova_batch_after without calling '\
+          'hypernova_batch_before. Check your around_filter for :hypernova_render_support')
+      end
+      return if @hypernova_batch.empty?
+
+      jobs = @hypernova_batch.jobs
+      hash = jobs.each_with_object({}) do |job, h|
+        h[job[:name]] = job
+      end
+      hash = prepare_request(hash, hash)
+      if send_request?(hash)
+        begin
+          will_send_request(hash)
+          result = @hypernova_batch.submit!
+          on_success(result, hash)
+        rescue StandardError => e
+          on_error(e)
+          result = @hypernova_batch.submit_fallback!
+        end
+      else
+        result = @hypernova_batch.submit_fallback!
+      end
+
+      new_body = Hypernova.replace_tokens_with_result(
+        response.body,
+        @hypernova_batch_mapping,
+        result
+      )
+      response.body = new_body
+    end
+  end
+end

data/lib/hypernova/faraday_connection.rb

@@ -0,0 +1,17 @@
+require "faraday"
+require "hypernova/batch_url_builder"
+
+class Hypernova::FaradayConnection
+  def self.build
+    configuration = Hypernova.configuration
+    Faraday.new(
+      request: {
+        open_timeout: configuration.open_timeout,
+        timeout: configuration.timeout,
+      },
+      url: Hypernova::BatchUrlBuilder.base_url,
+    ) do |builder|
+      builder.adapter(configuration.http_adapter) if configuration.http_adapter
+    end
+  end
+end

data/lib/hypernova/faraday_request.rb

@@ -0,0 +1,11 @@
+require "hypernova/faraday_connection"
+
+class Hypernova::FaradayRequest
+  def self.post(payload)
+    Hypernova::FaradayConnection.build.post do |request|
+      request.url(Hypernova::BatchUrlBuilder.path)
+      request.headers["Content-Type"] = "application/json"
+      request.body = payload[:body].to_json
+    end
+  end
+end

data/lib/hypernova/http_client_request.rb

@@ -0,0 +1,21 @@
+require "hypernova/batch_url_builder"
+
+class Hypernova::HttpClientRequest
+  def self.post(payload)
+    if is_client_requiring_1_argument?
+      client.post(Hypernova::BatchUrlBuilder.path, payload)
+    else
+      client.post(payload)
+    end
+  end
+
+  def self.client
+    Hypernova.configuration.http_client
+  end
+
+  def self.is_client_requiring_1_argument?
+    client.method(:post).arity == -2
+  end
+
+  private_class_method :client, :is_client_requiring_1_argument?
+end

data/lib/hypernova/parsed_response.rb

@@ -0,0 +1,24 @@
+require "hypernova/request"
+require "hypernova/response"
+
+class Hypernova::ParsedResponse
+  def initialize(jobs)
+    @jobs = jobs
+  end
+
+  def body
+    response.parsed_body
+  end
+
+  private
+
+  attr_reader :jobs
+
+  def request
+    Hypernova::Request.new(jobs)
+  end
+
+  def response
+    Hypernova::Response.new(request)
+  end
+end

data/lib/hypernova/plugin_helper.rb

@@ -0,0 +1,59 @@
+module Hypernova::PluginHelper
+  def get_view_data(name, data)
+    Hypernova.plugins.reduce(data) do |data, plugin|
+      if plugin.respond_to?(:get_view_data)
+        plugin.get_view_data(name, data)
+      else
+        data
+      end
+    end
+  end
+
+  def prepare_request(current_request, original_request)
+    Hypernova.plugins.reduce(current_request) do |req, plugin|
+      if plugin.respond_to?(:prepare_request)
+        plugin.prepare_request(req, original_request)
+      else
+        req
+      end
+    end
+  end
+
+  def send_request?(jobs_hash)
+    Hypernova.plugins.all? do |plugin|
+      if plugin.respond_to?(:send_request?)
+        plugin.send_request?(jobs_hash)
+      else
+        true
+      end
+    end
+  end
+
+  def will_send_request(jobs_hash)
+    Hypernova.plugins.each do |plugin|
+      if plugin.respond_to?(:will_send_request)
+        plugin.will_send_request(jobs_hash)
+      end
+    end
+  end
+
+  def after_response(current_response, original_response)
+    Hypernova.plugins.reduce(current_response) do |response, plugin|
+      if plugin.methods.include?(:after_response)
+        plugin.after_response(response, original_response)
+      else
+        response
+      end
+    end
+  end
+
+  def on_error(error, job = {})
+    Hypernova.plugins.each { |plugin| plugin.on_error(error, job) if plugin.respond_to?(:on_error) }
+  end
+
+  def on_success(res, jobs_hash)
+    Hypernova.plugins.each do |plugin|
+      plugin.on_success(res, jobs_hash) if plugin.respond_to?(:on_success)
+    end
+  end
+end

data/lib/hypernova/plugins/development_mode_plugin.rb

@@ -0,0 +1,27 @@
+class DevelopmentModePlugin
+  def after_response(current_response, _)
+    current_response.each do |name, result|
+      current_response[name] = result.merge({ "html" => render(name, result) }) if result["error"]
+    end
+  end
+
+  private
+
+  def render(name, result)
+    <<-HTML
+      <div style="background-color: #ff5a5f; color: #fff; padding: 12px;">
+        <p style="margin: 0">
+          <strong>Development Warning!</strong>
+          The <code>#{name}</code> component failed to render with Hypernova. Error stack:
+        </p>
+        <ul style="padding: 0 20px">
+          <li>#{stack_trace(result).join("</li><li>")}</li>
+        </ul>
+      </div>
+    HTML
+  end
+
+  def stack_trace(result)
+    result["error"]["stack"] || []
+  end
+end

data/lib/hypernova/rails/action_controller.rb

@@ -0,0 +1,9 @@
+require "hypernova/controller_helpers"
+
+if defined?(ActionController::Base)
+  ActionController::Base.class_eval do
+    include Hypernova::ControllerHelpers
+
+    helper_method :render_react_component
+  end
+end

data/lib/hypernova/request.rb

@@ -0,0 +1,33 @@
+require "hypernova/faraday_request"
+require "hypernova/http_client_request"
+
+class Hypernova::Request
+  def initialize(jobs)
+    @jobs = jobs
+  end
+
+  def body
+    post.body
+  end
+
+  private
+
+  attr_reader :jobs
+
+  def payload
+    {
+      :body => jobs,
+      :idempotent => true,
+      :request_format => :json,
+      :response_format => :json,
+    }
+  end
+
+  def post
+    if Hypernova.configuration.http_client
+      Hypernova::HttpClientRequest.post(payload)
+    else
+      Hypernova::FaradayRequest.post(payload)
+    end
+  end
+end

data/lib/hypernova/request_service.rb

@@ -0,0 +1,34 @@
+require "hypernova/batch_renderer"
+require "hypernova/parsed_response"
+require "hypernova/plugin_helper"
+
+class Hypernova::RequestService
+  include Hypernova::PluginHelper
+
+  def render_batch(jobs)
+    return render_batch_blank(jobs) if jobs.empty?
+    response_body = Hypernova::ParsedResponse.new(jobs).body
+    response_body.each do |index_string, resp|
+      error(resp["error"], jobs[index_string.to_i]) if resp["error"]
+    end
+    build_renderer(jobs).render(response_body)
+  end
+
+  def render_batch_blank(jobs)
+    build_renderer(jobs).render_blank
+  end
+
+  private
+
+  def build_error(name, message)
+    Module.const_get(name).new(message)
+  end
+
+  def build_renderer(jobs)
+    Hypernova::BatchRenderer.new(jobs)
+  end
+
+  def error(error_data, job)
+    on_error(build_error(error_data["name"], error_data["message"]), job)
+  end
+end

data/lib/hypernova/response.rb

@@ -0,0 +1,64 @@
+require "json"
+require "hypernova/plugin_helper"
+
+class Hypernova::Response
+  include Hypernova::PluginHelper
+
+  def initialize(request)
+    @request = request
+  end
+
+  # Example parsed body with no error:
+  # {
+  #   "0" => {
+  #     "name" => "hello_world.js",
+  #     "html" => "<div>Hello World</div>",
+  #     "meta" => {},
+  #     "duration" => 100,
+  #     "statusCode" => 200,
+  #     "success" => true,
+  #     "error" => nil,
+  #   }
+  # }
+
+  # Example parsed body with error:
+  # {
+  #   "0" => {
+  #     "html" => "<p>Error!</p>",
+  #     "name" => "goodbye_galaxy.js",
+  #     "meta" => {},
+  #     "duration" => 100,
+  #     "statusCode" => 500,
+  #     "success" => false,
+  #     "error" => {
+  #       "name" => "TypeError",
+  #       "message" => "Cannot read property 'forEach' of undefined",
+  #       "stack" => [
+  #         "TypeError: Cannot read property 'forEach' of undefined",
+  #         "at TravelerLanding.componentWillMount",
+  #         "at ReactCompositeComponentMixin.mountComponent",
+  #       ],
+  #     },
+  #   }
+  # }
+  def parsed_body
+    response = parse_body
+    # This enables backward compatibility with the old server response format.
+    # In the new format, the response results are contained within a "results" key. The top level
+    # hash contains a "success" and "error" which relates to the whole batch.
+    response = response["results"] || response
+    after_response(response, response)
+  end
+
+  private
+
+  attr_reader :request
+
+  def body
+    request.body
+  end
+
+  def parse_body
+    JSON.parse(body)
+  end
+end

data/lib/hypernova/version.rb

@@ -0,0 +1,3 @@
+module Hypernova
+  VERSION = "1.0.0"
+end

data/lib/hypernova.rb

@@ -0,0 +1,66 @@
+require "hypernova/batch"
+require "hypernova/configuration"
+require "hypernova/rails/action_controller"
+require "hypernova/version"
+
+module Hypernova
+  # thrown by ControllerHelper methods if you don't call hypernova_batch_before first
+  class NilBatchError < StandardError; end
+
+  # thrown by Batch#render if your job doesn't have the right keys and stuff.
+  class BadJobError < StandardError; end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Hypernova::Configuration.new
+    yield(configuration)
+  end
+
+  # TODO: more interesting token format?
+  RENDER_TOKEN_REGEX = /__hypernova_render_token\[\w+\]__/
+
+  def self.render_token(batch_token)
+    "__hypernova_render_token[#{batch_token}]__"
+  end
+
+  def self.plugins
+    @plugins ||= []
+  end
+
+  def self.add_plugin!(plugin)
+    plugins << plugin
+  end
+
+  ##
+  # replace all hypernova tokens in `body` with the render results given by batch_result,
+  # using render_token_to_batch_token to map render tokens into batch tokens
+  # @param [String] body
+  # @param [Hash] render_token_to_batch_token
+  # @param respond_to(:[]) batch_result
+  def self.replace_tokens_with_result(body, render_token_to_batch_token, batch_result)
+    # replace all render tokens in the current response body with the
+    # hypernova result for that render.
+    return body.gsub(RENDER_TOKEN_REGEX) do |render_token|
+      batch_token = render_token_to_batch_token[render_token]
+      if batch_token.nil?
+        next render_token
+      end
+      render_result = batch_result[batch_token]
+      # replace with that render result.
+      next render_result
+    end
+  end
+
+  ##
+  # raises a BadJobError if the job hash is not of the right shape.
+  def self.verify_job_shape(job)
+    [:name, :data].each do |key|
+      if job[key].nil?
+        raise BadJobError.new("Hypernova render jobs must have key #{key}")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification 
+name: hypernova
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jake
+- Teton-Landis
+- Jordan
+- Harband
+- Ian
+- Christian
+- Myers
+- Tommy
+- Dang
+autorequire: 
+bindir: exe
+cert_chain: []
+
+date: 2016-06-08 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.9"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "10.0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.4"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.11"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: pry
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.10"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: faraday
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.8"
+  type: :runtime
+  version_requirements: *id007
+description: A Ruby client for the Hypernova service
+email: 
+- jake.tl@airbnb.com
+- ljharb@gmail.com
+- ian.myers@airbnb.com
+- tommy.dang@airbnb.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hypernova.gemspec
+- lib/hypernova.rb
+- lib/hypernova/batch.rb
+- lib/hypernova/batch_renderer.rb
+- lib/hypernova/batch_url_builder.rb
+- lib/hypernova/blank_renderer.rb
+- lib/hypernova/configuration.rb
+- lib/hypernova/controller_helpers.rb
+- lib/hypernova/faraday_connection.rb
+- lib/hypernova/faraday_request.rb
+- lib/hypernova/http_client_request.rb
+- lib/hypernova/parsed_response.rb
+- lib/hypernova/plugin_helper.rb
+- lib/hypernova/plugins/development_mode_plugin.rb
+- lib/hypernova/rails/action_controller.rb
+- lib/hypernova/request.rb
+- lib/hypernova/request_service.rb
+- lib/hypernova/response.rb
+- lib/hypernova/version.rb
+homepage: https://github.com/airbnb/hypernova-ruby
+licenses: 
+- MIT
+metadata: 
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - &id008 
+    - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id008
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: Batch interface for Hypernova, the React render service.
+test_files: []
+
+has_rdoc: