RubyGems - fastly-rails - Versions diffs - 0.1.0 - Mend

fastly-rails 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (62) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/Rakefile +32 -0
data/lib/fastly-rails.rb +29 -0
data/lib/fastly-rails/action_controller/cache_control_headers.rb +24 -0
data/lib/fastly-rails/action_controller/surrogate_control_headers.rb +20 -0
data/lib/fastly-rails/active_record/surrogate_key.rb +43 -0
data/lib/fastly-rails/client.rb +17 -0
data/lib/fastly-rails/configuration.rb +47 -0
data/lib/fastly-rails/engine.rb +24 -0
data/lib/fastly-rails/errors.rb +5 -0
data/lib/fastly-rails/version.rb +3 -0
data/lib/fastly/purgeable.rb +55 -0
data/test/dummy/README.rdoc +28 -0
data/test/dummy/Rakefile +6 -0
data/test/dummy/app/assets/javascripts/application.js +13 -0
data/test/dummy/app/assets/stylesheets/application.css +13 -0
data/test/dummy/app/controllers/application_controller.rb +5 -0
data/test/dummy/app/controllers/books_controller.rb +66 -0
data/test/dummy/app/helpers/application_helper.rb +2 -0
data/test/dummy/app/models/book.rb +12 -0
data/test/dummy/app/views/books/index.html.erb +2 -0
data/test/dummy/app/views/books/show.html.erb +2 -0
data/test/dummy/app/views/layouts/application.html.erb +14 -0
data/test/dummy/bin/bundle +3 -0
data/test/dummy/bin/rails +4 -0
data/test/dummy/bin/rake +4 -0
data/test/dummy/config.ru +4 -0
data/test/dummy/config/application.rb +23 -0
data/test/dummy/config/boot.rb +5 -0
data/test/dummy/config/database.yml +25 -0
data/test/dummy/config/environment.rb +5 -0
data/test/dummy/config/environments/development.rb +29 -0
data/test/dummy/config/environments/production.rb +80 -0
data/test/dummy/config/environments/test.rb +36 -0
data/test/dummy/config/initializers/_rails_version_check.rb +3 -0
data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/test/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/test/dummy/config/initializers/inflections.rb +16 -0
data/test/dummy/config/initializers/mime_types.rb +5 -0
data/test/dummy/config/initializers/secret_token.rb +16 -0
data/test/dummy/config/initializers/session_store.rb +3 -0
data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
data/test/dummy/config/locales/en.yml +23 -0
data/test/dummy/config/routes.rb +5 -0
data/test/dummy/db/migrate/20140407202136_create_books.rb +9 -0
data/test/dummy/db/schema.rb +22 -0
data/test/dummy/public/404.html +58 -0
data/test/dummy/public/422.html +58 -0
data/test/dummy/public/500.html +57 -0
data/test/dummy/public/favicon.ico +0 -0
data/test/dummy/test/controllers/books_controller_test.rb +38 -0
data/test/dummy/test/factories/books.rb +7 -0
data/test/dummy/test/fixtures/books.yml +7 -0
data/test/dummy/test/integration/fastly_headers_test.rb +91 -0
data/test/dummy/test/models/book_test.rb +41 -0
data/test/fastly-rails/cache_control_headers_test.rb +8 -0
data/test/fastly-rails/client_test.rb +36 -0
data/test/fastly-rails/configuration_test.rb +84 -0
data/test/fastly-rails_test.rb +57 -0
data/test/test_helper.rb +67 -0
metadata +270 -0

data/test/dummy/public/422.html ADDED Viewed

@@ -0,0 +1,58 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+  }
+  div.dialog {
+    width: 25em;
+    margin: 4em auto 0 auto;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 4em 0 4em;
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  body > p {
+    width: 33em;
+    margin: 0 auto 1em;
+    padding: 1em 0;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow:0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+  <p>If you are the application owner check the logs for more information.</p>
+</body>
+</html>

data/test/dummy/public/500.html ADDED Viewed

@@ -0,0 +1,57 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+  }
+  div.dialog {
+    width: 25em;
+    margin: 4em auto 0 auto;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 4em 0 4em;
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  body > p {
+    width: 33em;
+    margin: 0 auto 1em;
+    padding: 1em 0;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow:0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+  <p>If you are the application owner check the logs for more information.</p>
+</body>
+</html>

data/test/dummy/public/favicon.ico ADDED Viewed

File without changes

data/test/dummy/test/controllers/books_controller_test.rb ADDED Viewed

@@ -0,0 +1,38 @@
+require 'test_helper'
+class BooksControllerTest < ActionController::TestCase
+  def setup
+    WebMock.stub_request(:any, /.*/).
+    to_return(
+        :status   => 200,
+        :body     => "{}",
+        :message  => "{}"
+    )
+    @no_of_books = 5
+    create_list :book, @no_of_books
+    end
+  test "index" do
+    get :index
+    assert_response :success, 'it should return successfully'
+    assert_equal @no_of_books, assigns(:books).count, "it should retrieve #{@no_of_books} books"
+  end
+  test "show" do
+    expected_id = 1
+    get :show, {:id => expected_id}
+    assert_response :success, 'it should return successfully'
+    assert_not_nil assigns(:book), '@book should not be nil'
+    assert_instance_of Book, assigns(:book), 'it should be an instance of a book'
+    assert_equal expected_id, assigns(:book).id, 'book.id should be the expected id'
+  end
+  test "create" do
+    expected_name = 'newly-created-book'
+    assert_difference('Book.count') do
+      post :create, :book => {'name' => expected_name}
+    end
+  end
+end

data/test/dummy/test/factories/books.rb ADDED Viewed

@@ -0,0 +1,7 @@
+# Read about factories at https://github.com/thoughtbot/factory_girl
+FactoryGirl.define do
+  factory :book do
+    name  { Faker::Movie.title }
+  end
+end

data/test/dummy/test/fixtures/books.yml ADDED Viewed

@@ -0,0 +1,7 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+one:
+  name: MyText
+two:
+  name: MyText

data/test/dummy/test/integration/fastly_headers_test.rb ADDED Viewed

@@ -0,0 +1,91 @@
+require 'test_helper'
+class FastlyHeadersTest < ActionDispatch::IntegrationTest
+  test '/books index page should have fastly headers' do
+    get '/books'
+    assert_response :success
+    assert !request.session_options[:skip].nil?
+    assert_equal true, request.session_options[:skip]
+    assert response.headers.key?('Cache-Control')
+    assert_equal 'public, no-cache', response.headers['Cache-Control']
+    assert response.headers.key?('Surrogate-Control')
+    max_age = FastlyRails.configuration.max_age
+    assert_equal "max-age=#{max_age}", response.headers['Surrogate-Control']
+  end
+  test '/books/:id show page should have fastly headers' do
+    create :book, :id => 1
+    get '/books/1'
+    assert_response :success
+    assert !request.session_options[:skip].nil?
+    assert_equal true, request.session_options[:skip]
+    assert response.headers.key?('Cache-Control')
+    assert_equal 'public, no-cache', response.headers['Cache-Control']
+    assert response.headers.key?('Surrogate-Control')
+    max_age = FastlyRails.configuration.max_age
+    assert_equal "max-age=#{max_age}", response.headers['Surrogate-Control']
+  end
+  test 'POST /books should not have fastly headers/ fastly header values' do
+    assert_difference('Book.count') do
+      post '/books', 'book' => { 'name' => 'some new book' }
+    end
+    assert_nil request.session_options[:skip]
+    assert response.headers.key?('Cache-Control')
+    assert_equal 'no-cache', response.headers['Cache-Control']
+    assert !response.headers.key?('Surrogate-Control')
+  end
+  test 'PUT /books/:id should not have fastly headers/ fastly header values' do
+    create :book, :id => 1, :name => 'some new book'
+    put '/books/1', 'id' => 1, 'book' => { 'name' => 'changed book' }
+    assert_equal 'changed book', Book.find(1).name
+    assert_nil request.session_options[:skip]
+    assert response.headers.key?('Cache-Control')
+    assert_equal 'no-cache', response.headers['Cache-Control']
+    assert !response.headers.key?('Surrogate-Control')
+  end
+  test 'DELETE /books/:id should not have fastly headers/ fastly header values' do
+    create :book, :id => 1
+    delete '/books/1'
+    assert Book.where(:id => 1).empty?
+    assert_nil request.session_options[:skip]
+    assert response.headers.key?('Cache-Control')
+    assert_equal 'no-cache', response.headers['Cache-Control']
+    assert !response.headers.key?('Surrogate-Control')
+  end
+end

data/test/dummy/test/models/book_test.rb ADDED Viewed

@@ -0,0 +1,41 @@
+require 'test_helper'
+# class BookTest < ActiveSupport::TestCase
+#   test "the truth" do
+#     assert true
+#   end
+# end
+describe Book do
+  let (:book) { create :book, id: 1 }
+  it "should have Fastly::SurrogateKey instance methods" do
+    [:record_key, :table_key, :purge, :purge_all].each do |method|
+      assert_respond_to book, method
+    end
+  end
+  it "should have Fastly::SurrogateKey class methods" do
+    [:table_key, :purge_all].each do |method|
+      assert_respond_to Book, method
+    end
+  end
+  it "should have a record_key of books/1" do
+    assert_equal 'books/1', book.record_key
+  end
+  it "should have a table_key that returns its table name" do
+    assert_equal 'books', book.table_key
+  end
+  it "should have class.table_key and instance.table_key that are equivalent" do
+    assert_equal Book.table_key, book.table_key
+  end
+end

data/test/fastly-rails/cache_control_headers_test.rb ADDED Viewed

@@ -0,0 +1,8 @@
+require 'test_helper'
+class FastlyRails::CacheControlHeadersTest < ActiveSupport::TestCase
+  test "sets cache control headers on actioncontroller request" do
+  end
+end

data/test/fastly-rails/client_test.rb ADDED Viewed

@@ -0,0 +1,36 @@
+require 'test_helper'
+describe FastlyRails::Client do
+  let(:client) do
+    FastlyRails::Client.new(
+      :api_key => 'KEY', :user => 'USER', :password => 'PASS'
+    )
+  end
+  it 'should create a fastly rails client' do
+    assert_instance_of FastlyRails::Client, client
+  end
+  it 'should be delegated to the fastly client' do
+    assert_instance_of Fastly, client.instance_variable_get('@delegate_dc_obj')
+  end
+  # This is kind of a static-ish test that technically isn't necessary
+  # But if we decide to lock down the methods available from the client
+  # through this interface, we can ensure they're available via this test
+  it 'should respond to methods available in the fastly client' do
+    methods = [
+      :purge,
+      :get_service
+    ]
+    methods.each do |method|
+      assert_respond_to client, method
+    end
+  end
+end

data/test/fastly-rails/configuration_test.rb ADDED Viewed

@@ -0,0 +1,84 @@
+require 'test_helper'
+describe FastlyRails::Configuration do
+  let(:configuration) { FastlyRails::Configuration.new }
+  it 'should create a fastly rails client' do
+    assert_instance_of FastlyRails::Configuration, configuration
+  end
+  it 'should have configuration attributes' do
+    methods = [
+      :api_key,
+      :user,
+      :password,
+      :max_age
+    ]
+    methods.each do |method|
+      assert_respond_to configuration, method
+    end
+  end
+  describe 'max_age_default' do
+    it 'should be a class method' do
+      assert_respond_to FastlyRails::Configuration, :max_age_default
+    end
+    it 'should return the value of a constant MAX_AGE_DEFAULT' do
+      assert_equal FastlyRails::Configuration::MAX_AGE_DEFAULT, FastlyRails::Configuration.max_age_default
+    end
+  end
+  describe 'authenticatable?' do
+    before do
+      configuration.api_key = nil
+      configuration.user = nil
+      configuration.password = nil
+    end
+    it 'should be an instance method' do
+      assert_respond_to configuration, :authenticatable?
+    end
+    it 'should return false if api_key, user, and password are nil' do
+      assert_equal false, configuration.authenticatable?
+    end
+    it 'should return false if only user is not nil' do
+      configuration.user = 'user'
+      assert_equal false, configuration.authenticatable?
+    end
+    it 'should return true if only api_key is not nil' do
+      configuration.api_key = 'key'
+      assert_equal true, configuration.authenticatable?
+    end
+    it 'should return true if if user and password are not nil' do
+      configuration.user      = 'user'
+      configuration.password  = 'password'
+      assert_equal true, configuration.authenticatable?
+    end
+  end
+  it 'should have a default value for max_age since none was provided' do
+    assert_equal FastlyRails::Configuration.max_age_default, configuration.max_age
+  end
+end

data/test/fastly-rails_test.rb ADDED Viewed

@@ -0,0 +1,57 @@
+require 'test_helper'
+describe FastlyRails do
+  let(:api_key)       { 'test' }
+  let(:user)          { nil }
+  let(:password)      { nil }
+  let(:max_age)       { 100000 }
+  let(:configuration) { FastlyRails.configuration }
+  let(:client)        { FastlyRails.client }
+  it 'should be a module' do
+    assert_kind_of Module, FastlyRails
+  end
+  describe 'credentials not provided' do
+    it 'should raise an error if configuration is not authenticatable' do
+      assert_equal false, configuration.authenticatable?
+      assert_raises FastlyRails::NoAuthCredentialsProvidedError do
+        client
+      end
+    end
+  end
+  describe 'credentials provided' do
+    before do
+      FastlyRails.configure do |c|
+        c.api_key   = api_key
+        c.user      = user
+        c.password  = password
+        c.max_age   = max_age
+      end
+    end
+    it 'should have configuration options set up' do
+      assert_equal api_key, configuration.api_key
+      assert_equal user, configuration.user
+      assert_equal password, configuration.password
+      assert_equal max_age, configuration.max_age
+    end
+    it 'should return a valid client' do
+      assert_instance_of FastlyRails::Client, client
+    end
+  end
+end