p3p 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c491a4afd145f53e99b87d7fcd14d6d4a025516
-  data.tar.gz: 954575000f78212db0ee6d99d2b584686187343a
+  metadata.gz: 1efe1a6e863dfcfc6f7150b817ac34356565baac
+  data.tar.gz: a3707c343bcb3148b7c1b4f966ee1ec0930678dd
 SHA512:
-  metadata.gz: 62c8cb796aa5e879e33b5ed7e81f35838a1af892a93ad3e8c608a9d144d68eed1cf1ee72d8ca42db1574c27413d314ab828e985b31f90859450fb158b12d2154
-  data.tar.gz: 72121dfb38b9c4cf742f3597c5ac3c211f9b6fd562ba7bb114a7c99709355499a8178e03c8f50f88ca0fd92639030b7fc0d821acecf492ae468886dc0e8bb225
+  metadata.gz: e72a87707679893d1a54395cdbe7f53c2707e2bdc89d190637da05c3d90c21e046dcde048c18a000a3d66381d28f3eb43fe76814fb4e4a58341901df0ae5b1e3
+  data.tar.gz: 395a8cc7c2ca967b5f639f60e9ff8e3720db698dc43e00144454f9887260f1c1a33c28017be7fe0caee4814f6cf626a26a8c07961009a6ba9c4512e6b889a0de

data/.rubocop.yml

@@ -0,0 +1,60 @@
+Lint/HandleExceptions:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Max: 2
+
+Metrics/LineLength:
+  AllowURI: true
+  Enabled: false
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 15
+
+Metrics/ParameterLists:
+  Max: 4
+  CountKeywordArgs: true
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Style/CollectionMethods:
+  PreferredMethods:
+    map:      'collect'
+    reduce:   'inject'
+    find:     'detect'
+    find_all: 'select'
+
+Style/Documentation:
+  Enabled: false
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false
+
+Style/Encoding:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/Lambda:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: 'comma'

data/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/lib/p3p.rb

@@ -1,8 +1,9 @@
-require "p3p/configuration"
-require "p3p/middleware"
-require "p3p/version"
-require "p3p/railtie" if defined?(Rails)
+require 'p3p/configuration'
+require 'p3p/middleware'
+require 'p3p/version'
+require 'p3p/railtie' if defined?(Rails)
 
+# Base module
 module P3P
   class << self
     attr_writer :configuration

data/lib/p3p/configuration.rb

@@ -1,9 +1,14 @@
 module P3P
+  # Responsible for handling P3P configuration
   class Configuration
     DEFAULT_HEADER = 'CP="NOI ADM DEV PSAi COM NAV OUR OTRo STP IND DEM"'
     attr_accessor :header
 
     def initialize
+      set_default_header!
+    end
+
+    def set_default_header!
       @header = DEFAULT_HEADER
     end
   end

data/lib/p3p/middleware.rb

@@ -1,12 +1,13 @@
 module P3P
+  # Responsible for applying the configured P3P header to the response
   class Middleware
-    def initialize app
+    def initialize(app)
       @app = app
     end
 
-    def call env
+    def call(env)
       res           = @app.call(env)
-      res[1]["P3P"] = P3P.configuration.header
+      res[1]['P3P'] = P3P.configuration.header
       res
     end
   end

data/lib/p3p/railtie.rb

@@ -1,6 +1,7 @@
 module P3P
+  # Responsible for applying middleware to Rails projects
   class Railtie < Rails::Railtie
-    initializer "p3p.middleware" do |app|
+    initializer 'p3p.middleware' do |app|
       app.middleware.use Middleware
     end
   end

data/lib/p3p/version.rb

@@ -1,3 +1,4 @@
+# Gem version information
 module P3P
-  VERSION = "1.1.1"
+  VERSION = '1.2.0'
 end

data/p3p.gemspec

@@ -4,19 +4,19 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'p3p/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "p3p"
+  gem.name          = 'p3p'
   gem.version       = P3P::VERSION
-  gem.authors       = ["Tom Milewski"]
-  gem.email         = ["tmilewski@gmail.com"]
-  gem.description   = %q{Inserts P3P header}
-  gem.summary       = %q{Inserts P3P headers to allow cookies to be utilized in iframe scenarios with IE.}
-  gem.homepage      = "https://github.com/tmilewski/p3p"
+  gem.authors       = ['Tom Milewski']
+  gem.email         = ['tmilewski@gmail.com']
+  gem.description   = 'Inserts P3P header'
+  gem.summary       = 'Inserts P3P headers to allow cookies to be utilized in iframe scenarios with IE.'
+  gem.homepage      = 'https://github.com/tmilewski/p3p'
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).collect { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
 
-  gem.add_dependency "rack"
-  gem.add_development_dependency "rspec", "~> 3.1.0"
+  gem.add_dependency 'rack'
+  gem.add_development_dependency 'rspec', '~> 3.1.0'
 end

data/spec/configuration_spec.rb

@@ -1,36 +1,33 @@
 require 'spec_helper'
 
-shared_examples "it returns the configured P3P header" do |http_verb|
-  let(:header) { P3P::Configuration::DEFAULT_HEADER }
-
-  it "should return P3P headers in a the case of a #{http_verb} request" do
-    headers  = { 'Content-Type' => 'text/html' }
-    app      = lambda { |env| [200, headers, []] }
-    request  = Rack::MockRequest.env_for('/', lint: true, fatal: true, method: http_verb)
+shared_examples 'it returns configured P3P header' do |header, http_verb|
+  it "should return custom P3P headers in the case of a #{http_verb} request" do
+    headers  = {'Content-Type' => 'text/html'}
+    app      = lambda { |_env| [200, headers, []] }
+    request  = Rack::MockRequest.env_for('/', :lint => true, :fatal => true, :method => http_verb)
     response = P3P::Middleware.new(app).call(request)
 
-    expect(response[1]).to include("P3P" => header)
+    expect(response[1]).to include('P3P' => header)
   end
 end
 
 describe P3P do
-  describe "#configure" do
-    let(:header) { "This is not a real p3p header. Check out our privacy policy at example.com/privacy" }
+  describe '#configure' do
+    let(:header) { 'Fake p3p header' }
 
     before do
       P3P.configure do |config|
-        config.header = header
+        config.header = @header
       end
     end
 
-    it_should_behave_like "it returns the configured P3P header", "GET"
-    it_should_behave_like "it returns the configured P3P header", "POST"
-    it_should_behave_like "it returns the configured P3P header", "PUT"
-    it_should_behave_like "it returns the configured P3P header", "DELETE"
-    it_should_behave_like "it returns the configured P3P header", "HEAD"
-    it_should_behave_like "it returns the configured P3P header", "OPTIONS"
-    it_should_behave_like "it returns the configured P3P header", "TRACE"
-    it_should_behave_like "it returns the configured P3P header", "CONNECT"
-
+    it_should_behave_like 'it returns configured P3P header', @header, 'GET'
+    it_should_behave_like 'it returns configured P3P header', @header, 'POST'
+    it_should_behave_like 'it returns configured P3P header', @header, 'PUT'
+    it_should_behave_like 'it returns configured P3P header', @header, 'DELETE'
+    it_should_behave_like 'it returns configured P3P header', @header, 'HEAD'
+    it_should_behave_like 'it returns configured P3P header', @header, 'OPTIONS'
+    it_should_behave_like 'it returns configured P3P header', @header, 'TRACE'
+    it_should_behave_like 'it returns configured P3P header', @header, 'CONNECT'
   end
 end

data/spec/middleware_spec.rb

@@ -1,23 +1,43 @@
-require "spec_helper"
+require 'spec_helper'
 
-shared_examples "it returns P3P headers" do |http_verb|
-  it "should return P3P headers in a the case of a #{http_verb} request" do
-    headers  = { 'Content-Type' => 'text/html' }
-    app      = lambda { |env| [200, headers, []] }
-    request  = Rack::MockRequest.env_for('/', lint: true, fatal: true, method: http_verb)
+shared_examples 'it returns P3P headers' do |http_verb|
+  it "should return default P3P headers in the case of a #{http_verb} request" do
+    headers  = {'Content-Type' => 'text/html'}
+    app      = lambda { |_env| [200, headers, []] }
+    request  = Rack::MockRequest.env_for('/', :lint => true, :fatal => true, :method => http_verb)
     response = P3P::Middleware.new(app).call(request)
 
-    expect(response[1]).to include("P3P"=> 'CP="NOI ADM DEV PSAi COM NAV OUR OTRo STP IND DEM"')
+    expect(response[1]).to include('P3P' => P3P::Configuration::DEFAULT_HEADER)
   end
 end
 
 describe P3P::Middleware do
-  it_should_behave_like "it returns P3P headers", "GET"
-  it_should_behave_like "it returns P3P headers", "POST"
-  it_should_behave_like "it returns P3P headers", "PUT"
-  it_should_behave_like "it returns P3P headers", "DELETE"
-  it_should_behave_like "it returns P3P headers", "HEAD"
-  it_should_behave_like "it returns P3P headers", "OPTIONS"
-  it_should_behave_like "it returns P3P headers", "TRACE"
-  it_should_behave_like "it returns P3P headers", "CONNECT"
+  describe '.initialize' do
+    it 'should set the default header' do
+      expect_any_instance_of(P3P::Configuration).to receive(:set_default_header!)
+      P3P.configure { |_config| }
+    end
+  end
+
+  describe '.set_default_header!' do
+    it 'should set the default header' do
+      header = 'abc123'
+      default_header = P3P::Configuration::DEFAULT_HEADER
+
+      P3P.configure { |c| c.header = header }
+      expect(P3P.configuration.header).to eq header
+
+      P3P.configuration.set_default_header!
+      expect(P3P.configuration.header).to eq default_header
+    end
+  end
+
+  it_should_behave_like 'it returns P3P headers', 'GET'
+  it_should_behave_like 'it returns P3P headers', 'POST'
+  it_should_behave_like 'it returns P3P headers', 'PUT'
+  it_should_behave_like 'it returns P3P headers', 'DELETE'
+  it_should_behave_like 'it returns P3P headers', 'HEAD'
+  it_should_behave_like 'it returns P3P headers', 'OPTIONS'
+  it_should_behave_like 'it returns P3P headers', 'TRACE'
+  it_should_behave_like 'it returns P3P headers', 'CONNECT'
 end

data/spec/spec_helper.rb

@@ -1,7 +1,12 @@
-require "rack"
-require "p3p"
+require 'rack'
+require 'p3p'
 
 RSpec.configure do |config|
   config.color = true
   config.formatter = :documentation
+  config.order = :random
+
+  config.after(:each) do
+    P3P.configuration.set_default_header!
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: p3p
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Tom Milewski
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md