RubyGems - first_click_free - Versions diffs - 1.0.0 - Mend

first_click_free 1.0.0

Files changed (57) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +97 -0
data/Rakefile +30 -0
data/config/domains.yml +195 -0
data/lib/first_click_free.rb +42 -0
data/lib/first_click_free/concerns/controller.rb +108 -0
data/lib/first_click_free/exceptions/subsequent_access_exception.rb +6 -0
data/lib/first_click_free/helpers/google.rb +41 -0
data/lib/first_click_free/helpers/path.rb +22 -0
data/lib/first_click_free/helpers/referrer.rb +26 -0
data/lib/first_click_free/version.rb +3 -0
data/lib/tasks/first_click_free_tasks.rake +24 -0
data/spec/concerns/controller_spec.rb +128 -0
data/spec/dummy/README.rdoc +28 -0
data/spec/dummy/Rakefile +6 -0
data/spec/dummy/app/assets/javascripts/application.js +13 -0
data/spec/dummy/app/assets/stylesheets/application.css +13 -0
data/spec/dummy/app/controllers/application_controller.rb +5 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/bin/bundle +3 -0
data/spec/dummy/bin/rails +4 -0
data/spec/dummy/bin/rake +4 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/config/application.rb +23 -0
data/spec/dummy/config/boot.rb +5 -0
data/spec/dummy/config/database.yml +25 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +29 -0
data/spec/dummy/config/environments/production.rb +80 -0
data/spec/dummy/config/environments/test.rb +36 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/spec/dummy/config/initializers/inflections.rb +16 -0
data/spec/dummy/config/initializers/mime_types.rb +5 -0
data/spec/dummy/config/initializers/secret_token.rb +12 -0
data/spec/dummy/config/initializers/session_store.rb +3 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/en.yml +23 -0
data/spec/dummy/config/routes.rb +56 -0
data/spec/dummy/db/development.sqlite3 +0 -0
data/spec/dummy/db/schema.rb +16 -0
data/spec/dummy/db/test.sqlite3 +0 -0
data/spec/dummy/log/development.log +18 -0
data/spec/dummy/log/test.log +548 -0
data/spec/dummy/public/404.html +58 -0
data/spec/dummy/public/422.html +58 -0
data/spec/dummy/public/500.html +57 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/exceptions/subsequent_access_exception_spec.rb +5 -0
data/spec/first_click_free_spec.rb +46 -0
data/spec/helpers/google_spec.rb +104 -0
data/spec/helpers/path_spec.rb +35 -0
data/spec/helpers/referrer_spec.rb +39 -0
data/spec/spec_helper.rb +18 -0
metadata +185 -0

data/spec/dummy/public/404.html ADDED Viewed

@@ -0,0 +1,58 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</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/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+  <p>If you are the application owner check the logs for more information.</p>
+</body>
+</html>

data/spec/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/spec/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/spec/dummy/public/favicon.ico ADDED Viewed

File without changes

data/spec/exceptions/subsequent_access_exception_spec.rb ADDED Viewed

@@ -0,0 +1,5 @@
+require "spec_helper"
+describe FirstClickFree::Exceptions::SubsequentAccessException do
+  it { described_class.superclass.should eq Exception }
+end

data/spec/first_click_free_spec.rb ADDED Viewed

@@ -0,0 +1,46 @@
+require "spec_helper"
+describe FirstClickFree do
+  describe "#permitted_domains" do
+    subject { described_class.permitted_domains }
+    it { should have_at_least(10).items }
+    it { subject.select { |domain| domain =~ /google|bing|yahoo/ }.length.should eq subject.length }
+  end
+  describe "#permitted_paths" do
+    before { described_class.permitted_paths = nil }
+    it "should default to none" do
+      described_class.permitted_paths.should eq []
+    end
+    it "should be settable" do
+      expect { described_class.permitted_paths = ['/foo'] }.to change(described_class, :permitted_paths).to(['/foo'])
+    end
+  end
+  describe "#free_clicks" do
+    before { described_class.free_clicks = nil }
+    it "should default to one" do
+      described_class.free_clicks.should eq 1
+    end
+    it "should be settable" do
+      expect { described_class.free_clicks = 5 }.to change(described_class, :free_clicks).to(5)
+    end
+  end
+  describe "#test_mode" do
+    before { described_class.test_mode = nil }
+    it "should default to false" do
+      described_class.test_mode.should be_false
+    end
+    it "should be settable" do
+      expect { described_class.test_mode = true }.to change(described_class, :test_mode).to(true)
+    end
+  end
+end

data/spec/helpers/google_spec.rb ADDED Viewed

@@ -0,0 +1,104 @@
+require "spec_helper"
+require "ostruct"
+describe FirstClickFree::Helpers::Google, type: :helper do
+  describe "#googlebot?" do
+    context "test mode" do
+      before { FirstClickFree.test_mode = true }
+      subject { helper.googlebot?(false) }
+      context "correct parameter is set" do
+        before { helper.stub(params: {googlebot: true}) }
+        it { should be_true }
+      end
+      context "parameter is not set" do
+        before { helper.stub(params: {}) }
+        it { should be_false }
+      end
+    end
+    context "not verifying DNS" do
+      subject { helper.googlebot?(false) }
+      context "user agent matches" do
+        before { helper.stub(request: OpenStruct.new(user_agent: "Googlebot")) }
+        it { subject.should be_true }
+      end
+      context "user agent does not match" do
+        before { helper.stub(request: OpenStruct.new(user_agent: "Google Chrome")) }
+        it { subject.should be_false }
+      end
+    end
+    context "verifying DNS" do
+      subject { helper.googlebot?(true) }
+      context "user agent matches, DNS verified" do
+        before { helper.stub(request: OpenStruct.new(user_agent: "Googlebot"), verify_googlebot_domain: true) }
+        it { subject.should be_true }
+      end
+      context "user agent matches, DNS not verified" do
+        before { helper.stub(request: OpenStruct.new(user_agent: "Googlebot"), verify_googlebot_domain: false) }
+        it { subject.should be_false }
+      end
+      context "user agent does not match, DNS verified" do
+        before { helper.stub(request: OpenStruct.new(user_agent: "Google Chrome"), verify_googlebot_domain: true) }
+        it { subject.should be_false }
+      end
+      context "user agent does not match, DNS not verified" do
+        before { helper.stub(request: OpenStruct.new(user_agent: "Google Chrome"), verify_googlebot_domain: false) }
+        it { subject.should be_false }
+      end
+    end
+  end
+  describe "#verify_googlebot_domain" do
+    before { helper.stub(request: OpenStruct.new(remote_ip: "111.222.333.444")) }
+    subject { helper.send(:verify_googlebot_domain) }
+    context "hostname is googlebot and IP matches" do
+      before do
+        Resolv.stub(getname: "test.googlebot.com")
+        Socket.stub(getaddrinfo: [[nil, nil, "111.222.333.444"]])
+      end
+      it { subject.should be_true }
+    end
+    context "IP matches" do
+      before do
+        Resolv.stub(getname: "test.test.dev")
+        Socket.stub(getaddrinfo: [[nil, nil, "111.222.333.666"]])
+      end
+      it { subject.should be_false }
+    end
+    context "hostname is googlebot and IP does not match" do
+      before do
+        Resolv.stub(getname: "test.googlebot.com")
+        Socket.stub(getaddrinfo: [[nil, nil, "111.222.333.666"]])
+      end
+      it { subject.should be_false }
+    end
+    context "hostname and IP does not match" do
+      before do
+        Resolv.stub(getname: "test.test.dev")
+        Socket.stub(getaddrinfo: [[nil, nil, "111.222.333.666"]])
+      end
+      it { subject.should be_false }
+    end
+  end
+end

data/spec/helpers/path_spec.rb ADDED Viewed

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'ostruct'
+describe FirstClickFree::Helpers::Path, type: :helper do
+  describe '.permitted_path?' do
+    subject { helper.permitted_path? }
+    context 'with no permitted paths' do
+      it { should be_false }
+    end
+    describe 'with permitted paths' do
+      before { FirstClickFree.permitted_paths = %w[ /another/path ] }
+      context 'and mismatching path' do
+        before { helper.stub(request: OpenStruct.new(fullpath: '/a/path')) }
+        it { should be_false }
+      end
+      context 'and matching path' do
+        before { helper.stub(request: OpenStruct.new(fullpath: 'http://www.example.com/another/path')) }
+        it { should be_true }
+      end
+      context 'and matching path with params' do
+        before { helper.stub(request: OpenStruct.new(fullpath: 'https://www.example.com/another/path?a=1')) }
+        it { should be_true }
+      end
+    end
+  end
+end

data/spec/helpers/referrer_spec.rb ADDED Viewed

@@ -0,0 +1,39 @@
+require "spec_helper"
+require "ostruct"
+describe FirstClickFree::Helpers::Referrer, type: :helper do
+  describe ".permitted_domain?" do
+    subject { helper.permitted_domain? }
+    context "test mode" do
+      before { FirstClickFree.test_mode = true }
+      subject { helper.permitted_domain? }
+      context "correct parameter is set" do
+        before { helper.stub(params: {google_referrer: true}) }
+        it { should be_true }
+      end
+      context "parameter is not set" do
+        before { helper.stub(params: {}) }
+        it { should be_false }
+      end
+    end
+    context "with permitted domain" do
+      before { helper.stub(request: OpenStruct.new(referrer: "https://www.google.com/search?q=test")) }
+      it { should be_true }
+    end
+    context "without permitted domain" do
+      before { helper.stub(request: OpenStruct.new(referrer: "https://test.host/not/google")) }
+      it { should be_false }
+    end
+    context "no referrer" do
+      before { helper.stub(request: OpenStruct.new(referrer: nil)) }
+      it { should be_false }
+    end
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,18 @@
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require 'rspec/rails'
+require 'rspec/autorun'
+Rails.backtrace_cleaner.remove_silencers!
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.use_transactional_fixtures = true
+  config.infer_base_class_for_anonymous_controllers = false
+  config.order = "random"
+end

metadata ADDED Viewed

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: first_click_free
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- 3months
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Automatically allow Google-crawling and new visitors to your application
+                     access to content without requiring sign-in.
+email:
+- blackadmin@3months.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- config/domains.yml
+- lib/first_click_free.rb
+- lib/first_click_free/concerns/controller.rb
+- lib/first_click_free/exceptions/subsequent_access_exception.rb
+- lib/first_click_free/helpers/google.rb
+- lib/first_click_free/helpers/path.rb
+- lib/first_click_free/helpers/referrer.rb
+- lib/first_click_free/version.rb
+- lib/tasks/first_click_free_tasks.rake
+- spec/concerns/controller_spec.rb
+- spec/dummy/README.rdoc
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/db/development.sqlite3
+- spec/dummy/db/schema.rb
+- spec/dummy/db/test.sqlite3
+- spec/dummy/log/development.log
+- spec/dummy/log/test.log
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/exceptions/subsequent_access_exception_spec.rb
+- spec/first_click_free_spec.rb
+- spec/helpers/google_spec.rb
+- spec/helpers/path_spec.rb
+- spec/helpers/referrer_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/3months/first_click_free
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.2.2
+signing_key:
+specification_version: 4
+summary: Automatically support first-click-free access to your content.
+test_files:
+- spec/concerns/controller_spec.rb
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/config.ru
+- spec/dummy/db/development.sqlite3
+- spec/dummy/db/schema.rb
+- spec/dummy/db/test.sqlite3
+- spec/dummy/log/development.log
+- spec/dummy/log/test.log
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/Rakefile
+- spec/dummy/README.rdoc
+- spec/exceptions/subsequent_access_exception_spec.rb
+- spec/first_click_free_spec.rb
+- spec/helpers/google_spec.rb
+- spec/helpers/path_spec.rb
+- spec/helpers/referrer_spec.rb
+- spec/spec_helper.rb