bookends 3.4.1rc1 → 3.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e7124753e4af5f64c504d6243f2c553a17fb7a3
-  data.tar.gz: 9766448a3a3a3768b6bf3fc273c0674246e9b1d3
+  metadata.gz: fdd8ebb804846502833570d6d6b7bcb664f62a85
+  data.tar.gz: 180ef3aa45926c2f2510c8339aa4b3a35fed6767
 SHA512:
-  metadata.gz: d1dba6fe2151ddfa1f1cc0c644775fb156b04afcdd2c099a2b84d90849c156afa99e58f52375d66d4a73678ffa4f9f46ec37de907faff43309596fd67af45cdb
-  data.tar.gz: ef3d0034f2ca47a91becf364dc3b081fd370526015b275f8f93d74961d729ac510168599a1d52f613bde176fbcf4181411dd5880abeba06732120f586e45124e
+  metadata.gz: 19e4cd2f2d2403c1dde4aa94f45ed9f3ab174547e246669c1c55cec16f4e87dee73a585fbcfba734d57c375fa44aa5a8b632ca23b9b32af5d16ec4a37c4af5e4
+  data.tar.gz: f917c63524372adad96c593d106c856d6f03ba39019a32257bac337c4c423656e14894b377dda4f265d4e732a246481cfa4d40867faabc6bd4d76db2067f0048

data/app/helpers/bookends/application_helper.rb

@@ -48,42 +48,13 @@ module Bookends
     end
 
     private
+
     def glostick_user
-      @glostick_user ||= GlostickUserExtractor.new(cookies).user
+      @glostick_user ||= Bookends::GlostickUserExtractor.new(cookies, session_cookie_secret).user
     end
 
-    class GlostickUserExtractor
-      attr_reader :secret,
-                  :token
-
-      def initialize(cookies)
-        @secret = ENV['SESSION_COOKIE_SECRET_PRIMARY'] || ENV['SESSION_COOKIE_SECRET_SECONDARY']
-        @token  = CGI::unescape(cookies[:heroku_user_session]) if cookies[:heroku_user_session]
-      end
-
-      def user
-        session_info = decrypt_session_cookie
-        if session_info && session_info['user']
-          session_info['user']
-        else
-          {
-            'email' => '',
-            'full_name' => ''
-          }
-        end
-      end
-
-      private
-      def decrypt_session_cookie
-        return nil unless token && secret
-
-        verifier = Fernet.verifier(secret, token)
-        verifier.enforce_ttl = false
-
-        return nil unless verifier.valid?
-
-        JSON.parse(verifier.message)
-      end
+    def session_cookie_secret
+      ENV['SESSION_COOKIE_SECRET_PRIMARY'] || ENV['SESSION_COOKIE_SECRET_SECONDARY']
     end
   end
 end

data/app/services/bookends/glostick_user_extractor.rb

@@ -0,0 +1,36 @@
+module Bookends
+  class GlostickUserExtractor
+    attr_reader :secret,
+                :token
+
+    def initialize(cookies, secret)
+      @secret = secret
+      @token  = CGI::unescape(cookies[:heroku_user_session]) if cookies[:heroku_user_session]
+    end
+
+    def user
+      session_info = decrypt_session_cookie
+      if session_info && session_info['user']
+        session_info['user']
+      else
+        {
+          'email' => '',
+          'full_name' => ''
+        }
+      end
+    end
+
+    private
+
+    def decrypt_session_cookie
+      return nil unless token && secret
+
+      verifier = Fernet.verifier(secret, token)
+      verifier.enforce_ttl = false
+
+      return nil unless verifier.valid?
+
+      JSON.parse(verifier.message)
+    end
+  end
+end

data/app/views/bookends/_header.html.erb

@@ -80,8 +80,8 @@
                 <h3><a class="js-blog-link" href="https://blog.heroku.com">Heroku Blog</a></h3>
                 <p class="js-blog-date"></p>
                 <p class="js-blog-content">Find out what's new with Heroku on our blog.</p>
-                <a class="button btn btn-default btn-sm btn-inline" href="#">More news</a>
-                <a class="button btn-inline" href="https://blog.heroku.com">View all blog posts</a>
+                <a class="button btn btn-default btn-sm btn-inline" href="<%= Bookends::Config.host_blog %>/news">More news</a>
+                <a class="button btn-inline" href="<%= Bookends::Config.host_blog %>">View all blog posts</a>
               </section>
             </div>
           </li>

data/lib/bookends/version.rb

@@ -1,3 +1,3 @@
 module Bookends
-  VERSION = '3.4.1rc1'.freeze
+  VERSION = '3.4.1'.freeze
 end

data/spec/services/bookends/glostick_user_extractor_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'fernet'
+require_relative '../../../app/services/bookends/glostick_user_extractor'
+
+RSpec.describe Bookends::GlostickUserExtractor do
+  let(:secret) { 'iAATWj4Q1Pm5Eh4kjjtkQAwCo+zrxcBW/73MBJqNgxs=' }
+
+  context 'when token and secret not present' do
+    it 'returns empty values' do
+      expect(Bookends::GlostickUserExtractor.new({}, secret).user).to eq({ 'email' => '', 'full_name' => '' })
+    end
+  end
+
+  describe 'when session cookie secret set' do
+    let(:message) do
+      {
+        'user' => {
+          'email' => 'email@example.com', 'full_name' => 'My Name'
+        }
+      }
+    end
+    let(:token) { Fernet.generate(secret, JSON.dump(message)) }
+    let(:cookies) do
+      { heroku_user_session: CGI::escape(token) }
+    end
+
+    it 'has a decoded cookie' do
+      expect(Bookends::GlostickUserExtractor.new(cookies, secret).token).to eq token
+    end
+
+    it 'works?' do
+      expect(Bookends::GlostickUserExtractor.new(cookies, secret).user).to eq message['user']
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path("../test_app/config/environment.rb",  __FILE__)
+
+require 'rspec/rails'
+
+ENGINE_RAILS_ROOT=File.join(File.dirname(__FILE__), '../')
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(ENGINE_RAILS_ROOT, "spec/support/**/*.rb")].each {|f| require f }
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  config.formatter = :documentation # :progress, :html, :textmate
+
+  config.before(:each) do
+  end
+
+  config.after(:each) do
+  end
+end
+

data/spec/test_app/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/test_app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/test_app/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require bookends
+//= require_tree .

data/spec/test_app/app/assets/stylesheets/application.scss

@@ -0,0 +1 @@
+@import 'bookends/bookends';

data/spec/test_app/app/controllers/application_controller.rb

@@ -0,0 +1,6 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+  helper Bookends::ApplicationHelper
+end

data/spec/test_app/app/controllers/home_controller.rb

@@ -0,0 +1,4 @@
+class HomeController < ApplicationController
+  def home
+  end
+end

data/spec/test_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/test_app/app/views/layouts/application.html.erb

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>TestApp</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= render 'bookends/header' %>
+
+<%= yield %>
+
+<%= render 'bookends/footer' %>
+
+</body>
+</html>

data/spec/test_app/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/test_app/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/test_app/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/test_app/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/spec/test_app/bookends-config.yml

@@ -0,0 +1,18 @@
+production:
+  logo_link: 'https://www.heroku.com/home'
+  host_www: 'https://www.heroku.com'
+  host_elements: 'https://elements.heroku.com'
+  host_blog: 'https://blog.heroku.com'
+  host_dev_center: 'https://devcenter.heroku.com'
+  login_path: 'https://id.heroku.com'
+
+development: &development
+  logo_link: '/'
+  host_www: '/'
+  host_elements: '/'
+  host_blog: '/'
+  host_dev_center: '/'
+  login_path: 'https://id.heroku.com'
+
+test:
+  <<: *development

data/spec/test_app/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+run Rails.application

data/spec/test_app/config/application.rb

@@ -0,0 +1,32 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "bookends"
+
+module TestApp
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/spec/test_app/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/test_app/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/spec/test_app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/test_app/config/environments/development.rb

@@ -0,0 +1,41 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end