bookwatch 1.0.0

data/master_middleman/source/stylesheets/partials/_syntax-highlight.scss

@@ -0,0 +1,64 @@
+/*
+ * FILE: _syntax-highlight.scss
+======================================================================== */
+pre .hll { background-color: #ffffcc; }
+pre .c { color: #666666; font-style: italic; } // Comment
+pre .err { color: #FF0000; background-color: #FFAAAA; } // Error
+pre .k { color: #228899; font-weight: bold; } // Keyword
+pre .o { color: #333333; } // Operator
+pre .cm { color: #666666; font-style: italic; } // Comment.Multiline
+pre .cp { color: #557799; } // Comment.Preproc
+pre .c1 { color: #666666; font-style: italic; } // Comment.Single
+pre .cs { color: #cc0000; font-weight: bold; font-style: italic; } // Comment.Special
+pre .gd { color: #A00000; } // Generic.Deleted
+pre .ge { font-style: italic; } // Generic.Emph
+pre .gr { color: #FF0000; } // Generic.Error
+pre .gh { color: #000080; font-weight: bold; } // Generic.Heading
+pre .gi { color: #00A000; } // Generic.Inserted
+pre .go { color: #888888; } // Generic.Output
+pre .gp { color: #c65d09; font-weight: bold; } // Generic.Prompt
+pre .gs { font-weight: bold; } // Generic.Strong
+pre .gu { color: #800080; font-weight: bold; } // Generic.Subheading
+pre .gt { color: #0044DD; } // Generic.Traceback
+pre .kc { color: #228899; font-weight: bold; } // Keyword.Constant
+pre .kd { color: #228899; font-weight: bold; } // Keyword.Declaration
+pre .kn { color: #228899; font-weight: bold; } // Keyword.Namespace
+pre .kp { color: #0088ff; font-weight: bold; } // Keyword.Pseudo
+pre .kr { color: #228899; font-weight: bold; } // Keyword.Reserved
+pre .kt { color: #6666ff; font-weight: bold; } // Keyword.Type
+pre .m { color: #6600EE; font-weight: bold; } // Literal.Number
+// pre .s { background-color: #F5F5FF; } // Literal.String
+pre .na { color: #000077; } // Name.Attribute
+pre .nb { color: #007722; } // Name.Builtin
+pre .nc { color: #ee99ee; font-weight: bold; } // Name.Class
+pre .no { color: #41AA9E; font-weight: bold; } // Name.Constant
+pre .nd { color: #555555; font-weight: bold; } // Name.Decorator
+pre .ni { color: #880000; } // Name.Entity
+pre .ne { color: #FF0000; font-weight: bold; } // Name.Exception
+pre .nf { color: #3E37DA; font-weight: bold; } // Name.Function
+pre .nl { color: #997700; font-weight: bold; } // Name.Label
+pre .nn { color: #0e84b5; font-weight: bold; } // Name.Namespace
+pre .nt { color: #007700; } // Name.Tag
+pre .nv { color: #003366; } // Name.Variable
+pre .ow { color: #000000; font-weight: bold; } // Operator.Word
+pre .w { color: #bbbbbb; } // Text.Whitespace
+pre .mf { color: #6600EE; font-weight: bold; } // Literal.Number.Float
+pre .mh { color: #005588; font-weight: bold; } // Literal.Number.Hex
+pre .mi { color: #6666ff; font-weight: bold; } // Literal.Number.Integer
+pre .mo { color: #4400EE; font-weight: bold; } // Literal.Number.Oct
+pre .sb { background-color: #F5F5FF; } // Literal.String.Backtick
+pre .sc { color: #8888FF; } // Literal.String.Char
+pre .sd { color: #DD4422; } // Literal.String.Doc
+pre .s2 { background-color: rgba(211, 211, 211, 0.2); } // Literal.String.Double
+pre .se { color: #666666; font-weight: bold; background-color: #F5F5FF; } // Literal.String.Escape
+pre .sh { background-color: #F5F5FF; } // Literal.String.Heredoc
+pre .si { background-color: #eeeeee; } // Literal.String.Interpol
+pre .sx { color: #ff8888; background-color: #F5F5FF; } // Literal.String.Other
+pre .sr { color: #000000; background-color: #F5F5FF; } // Literal.String.Regex
+pre .s1 { background-color: rgba(211, 211, 211, 0.2); } // Literal.String.Single
+pre .ss { color: #D60F3F; } // Literal.String.Symbol
+pre .bp { color: #007722; } // Name.Builtin.Pseudo
+pre .vc { color: #ccccff; } // Name.Variable.Class
+pre .vg { color: #ff8844; } // Name.Variable.Global
+pre .vi { color: #aaaaff; } // Name.Variable.Instance
+pre .il { color: #6666ff; font-weight: bold; } // Literal.Number.Integer.Long

data/master_middleman/source/stylesheets/partials/_vars.scss

@@ -0,0 +1,64 @@
+$em-base: 16px !default;
+
+// ~BEGIN BASE VALUES
+// ===================================================
+$font-primary: 'Source Sans Pro', sans-serif;
+$font-size-xxl: 2.441em;
+$font-size-xl: 1.953em;
+$font-size-l: 1.563em;
+$font-size-m: 1.25em;
+$font-size-s: 1em;
+$font-size-xs: 0.8em;
+
+$gray1: #424242;
+$gray2: #686868;
+$gray3: #b5b5b5;
+$gray4: #eceae9;
+$gray5: #f8f8f8;
+$gray6: #fdfdfd;
+
+// Book-specific overrides
+@import "book-base-values.scss";
+
+$color-accent: $gray6;
+$color-accent-bright: $gray6;
+$color-accent-bright-contrast: #000000;
+
+// text colors
+$color-header: $gray2;
+$color-text: $gray1;
+$color-text-dim: $gray3;
+
+// link colors
+$color-link: #b5292e;
+$color-link-border: #154896;
+
+// border colors
+$color-border-row: $gray5;
+$color-border: $gray4;
+$color-border-light: $gray4;
+$color-border-superlight: $gray4;
+$color-border-dark: $gray3;
+$color-border-tip: $gray1;
+
+// background-colors
+$color-bg: $gray5;
+$color-bg-light: $gray6;
+$color-bg-panel: $gray5;
+$color-bg-header: #b625ff;
+$color-bg-dark: #523f74;
+
+// ~SIZES
+// ===================================================
+$radius: 3px;
+$sidenav-wide: 278px/$em-base + 0em;
+$sidenav-widest: 367px/$em-base + 0em;
+
+// ~BREAKPOINTS
+// ===================================================
+$bp-superwide: 1340px/$em-base + 0em;
+$bp-widest: 900px/$em-base + 0em;
+$bp-wide: 700px/$em-base + 0em;
+
+@import "layout-vars.scss";
+@import "book-vars.scss";

data/master_middleman/source/stylesheets/print.css.scss

@@ -0,0 +1,58 @@
+/*
+ * FILE: print.scss
+======================================================================== */
+@import "partials/_vars.scss";
+
+// Book-specific overrides
+@import "partials/_book-vars.scss";
+
+pre code, p code, .terminal {
+  font-family: "DejaVu Sans Mono";
+  page-break-inside: avoid;
+}
+
+ol li {
+  margin-left: 15px;
+}
+
+.wrap {
+  width: 2400px;
+
+  .container {
+    margin-left: 0;
+  }
+}
+
+li p code {
+  width: auto;
+  display: inline;
+}
+
+note {
+  overflow: visible;
+  page-break-inside: avoid !important;
+  page-break-before: avoid !important;
+}
+
+pre, pre code {
+  overflow: visible;
+}
+
+.pivotalcf .logo {
+  background: none;
+  padding-left: 0;
+}
+
+.quick-links,
+.nav-container,
+.header,
+.site-footer-links,
+#feedback {
+  display: none;
+}
+
+h1 {
+  margin-top: 0;
+  font-size: $font-size-l;
+}
+

data/master_middleman/source/subnavs/_nav-links.erb

@@ -0,0 +1,10 @@
+<% unless links?(@links) %>
+  <ul>
+    <% @links.each do |link| %>
+      <li class="<%= submenu_class(link) %>">
+        <a href="<%= link[:url] %>"><%= escape_html link[:text] %></a>
+        <%= render_links link[:nested_links] %>
+      </li>
+    <% end %>
+  </ul>
+<% end %>

data/master_middleman/source/subnavs/_subnav_template.erb

@@ -0,0 +1,8 @@
+<div id="sub-nav" class="nav-container js-sidenav" role="navigation" >
+  <a class="sidenav-title" data-behavior="SubMenuMobile">
+    Doc Index
+  </a>
+  <div class="nav-content">
+    <%= render_links @links %>
+  </div>
+</div>

data/master_middleman/subdirectory_aware_assets.rb

@@ -0,0 +1,47 @@
+class SubdirectoryAwareAssets < ::Middleman::Extension
+  def initialize(app, options_hash={}, &block)
+    super
+
+    # After compass is setup, make it use the registered cache buster
+    app.compass_config do |config|
+      config.relative_assets = true
+    end if app.respond_to?(:compass_config)
+  end
+
+  helpers do
+    def asset_url(path, prefix="", options={})
+      url = super(path, prefix, options)
+
+      unless global_asset_at? url
+        current_dir = Pathname('/' + current_resource.destination_path)
+        url = Pathname(url).relative_path_from(current_dir.dirname).to_s
+      end
+
+      # middleman assumes your assets live at the top level, but they may be in the nested repos instead
+      # here we start at top level and dive down until we find the real asset
+      current_page_path_parts = current_resource.destination_path.split('/')
+      current_page_path_parts.pop
+      current_page_dir = File.join('source', current_page_path_parts, '')
+      while (!File.exists? "#{current_page_dir}#{url}") && url.match(/^\.\.\//) do
+        url = url.gsub(/^\.\.\//, "")
+      end
+
+      url
+    end
+
+    private
+
+    def global_asset_at?(path)
+      path.include?('//') ||
+        path.start_with?('data:') ||
+        !current_resource ||
+        path.index('.css') ||
+        path.index('.js')
+    end
+  end
+
+end
+
+::Middleman::Extensions.register(:subdirectory_aware_assets, SubdirectoryAwareAssets)
+
+

data/template_app/Gemfile

@@ -0,0 +1,10 @@
+source 'http://rubygems.org'
+
+ruby '2.3.0'
+
+gem 'rack'
+gem 'rack-rewrite'
+gem 'puma'
+gem 'therubyracer'
+gem 'sendgrid-ruby', '< 3.0'
+gem 'elasticsearch'

data/template_app/Gemfile.lock

@@ -0,0 +1,43 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    elasticsearch (1.0.17)
+      elasticsearch-api (= 1.0.17)
+      elasticsearch-transport (= 1.0.17)
+    elasticsearch-api (1.0.17)
+      multi_json
+    elasticsearch-transport (1.0.17)
+      faraday
+      multi_json
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    libv8 (3.16.14.7)
+    mimemagic (0.3.0)
+    multi_json (1.11.2)
+    multipart-post (2.0.0)
+    puma (3.3.0)
+    rack (1.5.2)
+    rack-rewrite (1.5.0)
+    ref (1.0.5)
+    sendgrid-ruby (1.1.5)
+      faraday (~> 0.9)
+      mimemagic
+      smtpapi (~> 0.1)
+    smtpapi (0.1.0)
+    therubyracer (0.12.1)
+      libv8 (~> 3.16.14.0)
+      ref
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  elasticsearch
+  puma
+  rack
+  rack-rewrite
+  sendgrid-ruby (< 3.0)
+  therubyracer
+
+BUNDLED WITH
+   1.11.2

data/template_app/config.ru

@@ -0,0 +1,9 @@
+require 'pathname'
+require './rack_app'
+require './mail_sender'
+
+mail_client = Bookwatch::MailSender.new(ENV['SENDGRID_USERNAME'],
+                                         ENV['SENDGRID_API_KEY'],
+                                         {to: ENV['FEEDBACK_TO'], from: ENV['FEEDBACK_FROM']})
+
+run Bookwatch::RackApp.new(Pathname('redirects.rb'), mail_client).app

data/template_app/lib/rack_static_if_exists.rb

@@ -0,0 +1,19 @@
+require 'rack'
+
+module Bookwatch
+  class RackStaticIfExists < Rack::Static
+    def can_serve(path)
+      file_exists?(path) || dir_with_index_exists?(path)
+    end
+
+    private
+
+    def file_exists?(path)
+      File.file?(File.join(@file_server.root, path))
+    end
+
+    def dir_with_index_exists?(path)
+      File.directory?(File.join(@file_server.root, path)) && !!@index && file_exists?(File.join(path, @index))
+    end
+  end
+end

data/template_app/lib/search/handler.rb

@@ -0,0 +1,47 @@
+require 'elasticsearch'
+require 'cgi'
+require 'json'
+
+require_relative 'query'
+require_relative 'renderer'
+
+module Bookwatch
+  module Search
+    class Handler
+      def initialize(client_class = Elasticsearch::Client, environment = ENV)
+        @client_class = client_class
+        @environment = environment
+        @renderer = Renderer.new
+      end
+
+      def call(request_env)
+        query = Query.new(extract_query_params(request_env['QUERY_STRING']))
+        query.get_results(client_class.new(url: elasticsearch_url))
+
+        [200, {'Content-Type' => 'text/html'}, [renderer.render_results(query)]]
+      rescue Exception => e
+        puts e.message
+        puts e.backtrace.join("\n")
+
+        [500, {'Content-Type' => 'text/plain'}, ['An error occurred']]
+      end
+
+      def extract_query_params(param_string)
+        parsed = CGI::parse(param_string || '')
+        parsed.keys.inject(Hash.new('')) do |params, key|
+          # CGI::parse returns values in an array
+          params[key] = parsed[key].first
+          params
+        end
+      end
+
+      private
+
+      attr_reader :renderer, :client_class, :environment
+
+      def elasticsearch_url
+        @elasticsearch_url ||= JSON.parse(environment['VCAP_SERVICES'])['searchly'][0]['credentials']['uri']
+      end
+    end
+  end
+end

data/template_app/lib/search/hit.rb

@@ -0,0 +1,21 @@
+module Bookwatch
+  module Search
+    class Hit
+      def initialize(attrs = {})
+        source_fields = attrs.fetch('_source')
+        @title = source_fields.fetch('title').sub(/\A(.+)\|.*\z/, '\\1').strip
+        @url = source_fields.fetch('url')
+        @product_name = source_fields['product_name']
+        @product_version = source_fields['product_version']
+
+        if attrs.has_key?('highlight')
+          @text = attrs.fetch('highlight').fetch('text').first.strip
+        else
+          @text = source_fields.fetch('summary')
+        end
+      end
+
+      attr_reader :title, :url, :text, :product_name, :product_version
+    end
+  end
+end

data/template_app/lib/search/query.rb

@@ -0,0 +1,74 @@
+require 'yaml'
+
+require_relative 'hit'
+
+module Bookwatch
+  module Search
+    class Query
+      attr_reader :search_term, :product_name, :product_version, :page_number, :result_list, :result_count, :last_page, :page_window
+
+      def initialize(params)
+        @search_term = params.fetch('q', '')
+        @product_name = params.fetch('product_name', nil)
+        @product_version = @product_name && params.fetch('product_version', nil)
+        @page_number = @search_term == '' ? 1 : [params['page'].to_i, 1].max
+      end
+
+      def query_options
+        options = YAML.load_file(File.expand_path('../../../search.yml', __FILE__))
+
+        options['from'] = (page_number - 1) * 10
+        options['query']['bool']['should']['simple_query_string']['query'] = search_term
+
+        unless product_name.nil?
+          filters = [{
+            'term' => { 'product_name' => product_name }
+          }]
+
+          unless product_version.nil?
+            filters << {'term' => { 'product_version' => product_version }}
+          end
+
+          options['query']['bool']['filter'] = {
+            'bool' => {
+              'must' => filters
+            }
+          }
+        end
+
+        options
+      end
+
+      def get_results(elasticsearch_client)
+        if search_term == ''
+          @result_count = 0
+          @result_list = []
+          @last_page = 1
+        else
+          results = elasticsearch_client.search index: 'searching', body: query_options
+          @result_count = results['hits']['total']
+          @result_list = results['hits']['hits'].map { |h| Hit.new(h) }
+          @last_page = (result_count / 10.0).ceil
+        end
+        @page_window = calculate_page_window
+      end
+
+      private
+
+      def calculate_page_window
+        window_start = [page_number - 2, 1].max
+        window_end = [window_start + 4, last_page].min
+        window = (window_start .. window_end).to_a
+
+        if window.length < 5 && window.last == last_page && window.first != 1
+          window.unshift(window.first - 1)
+          if window.length < 5
+            window.unshift(window.first - 1)
+          end
+        end
+
+        window
+      end
+    end
+  end
+end