seo_noindex 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd2db9020eea8e6f6f58164bd2e1c7077b74348a
+  data.tar.gz: ca40272955bd46c5174fe395a058564470a76f55
+SHA512:
+  metadata.gz: c14404191416485e1b378853f1209d9efc46cfa894cbeaca5c87d9f4a8c6c22745db09c2cce3647663050f57b46c8c13f86d269dea63e70ca457426c9753d381
+  data.tar.gz: a9c05891ebbf9cc76aa0990b81befe0cd55b297e6940e9a01c295fe7d42b60c95bf5b281dd84d31af6a53cb71247bf73ace7ef053c118c2935a49bd668fcd31b

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+capybara-*.html
+.rspec
+/tmp
+/coverage/
+/spec/tmp
+**.orig
+Gemfile.lock
+
+# dotenv
+# TODO Comment out this rule if environment variables can be committed
+.env
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+.powenv

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Vsevolod
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# SeoNoindex
+
+Add noindex tag in head for disallowed paths from robots.txt file
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'seo_noindex'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install seo_noindex
+
+If you're not running Rails, you'll have to add the middleware to your config.ru:
+
+    require 'seo_noindex'
+    use SeoNoindex::Middleware
+
+Add helper to your view file in head section
+
+    <header>
+      <%= robots_noindex_tag -%>
+    </header>
+
+## Example
+
+For example in robots.txt we have this string:
+
+    Disallow: /admin
+
+And if we follow **https://sitename/admin** we get this:
+
+    <meta name="robots" content="noindex">

data/lib/seo_noindex/helper.rb

@@ -0,0 +1,15 @@
+module SeoNoindex
+  module ViewHelper
+
+    def robots_noindex_tag
+      if request.env['seo_noindex']
+        meta_tag_noindex
+      end
+    end
+
+    def meta_tag_noindex
+      '<meta name="robots" content="noindex">'.html_safe
+    end
+
+  end
+end

data/lib/seo_noindex/middleware.rb

@@ -0,0 +1,42 @@
+module SeoNoindex
+  class Middleware
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if check_noindex(env)
+        env['seo_noindex'] = 'true'
+      end
+      @app.call(env)
+    end
+
+    private
+
+    def check_noindex(env)
+      !!disallowed_array.find{ |x| env['REQUEST_URI'] =~ Regexp.new('^' + x.first) }
+    end
+
+    def disallowed_array
+      @disallowed_array ||= begin
+        if defined?(Rails)
+          Rails.cache.fetch('parsed_robots_txt', expires_in: 1.day) do
+            prepare_robots(File.read('public/robots.txt'))
+          end
+        else
+          prepare_robots(File.read('./public/robots.txt'))
+        end
+      rescue Errno::ENOENT
+        []
+      end
+    end
+
+    def prepare_robots(text)
+      text.gsub('*', '.*').
+           gsub('?', '\?').
+           scan(/Disallow: (.+)/).uniq || []
+    end
+
+  end
+end

data/lib/seo_noindex/railtie.rb

@@ -0,0 +1,7 @@
+module SeoNoindex
+  class Railtie < Rails::Railtie
+    initializer "seo_noindex.insert_middleware" do |app|
+      app.config.middleware.insert_before 0, SeoNoindex::Middleware
+    end
+  end
+end

data/lib/seo_noindex/version.rb

@@ -0,0 +1,3 @@
+module SeoNoindex
+  VERSION="0.0.3"
+end

data/lib/seo_noindex.rb

@@ -0,0 +1,9 @@
+require 'seo_noindex/version'
+require 'seo_noindex/middleware'
+
+if defined? Rails
+  require 'seo_noindex/railtie'
+  require 'seo_noindex/helper'
+
+  ActionView::Base.send :include, SeoNoindex::ViewHelper
+end

data/seo_noindex.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'seo_noindex/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "seo_noindex"
+  gem.version       = SeoNoindex::VERSION
+  gem.authors       = ["Vsevolod Avramov"]
+  gem.email         = ["gsevka@gmail.com"]
+  gem.description   = %q{Add noindex tag for disallowed path in robots.txt file}
+  gem.summary       = "seo_noindex-#{SeoNoindex::VERSION}"
+  gem.homepage      = "https://github.com/vsevolod/seo_noindex"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rack"
+end

data/spec/middleware_spec.rb

@@ -0,0 +1,61 @@
+require './spec/spec_helper'
+require 'rack/lint'
+
+module SeoNoindex
+  describe Middleware do
+
+    subject do
+      Middleware.new(nil).send(:check_noindex, env)
+    end
+
+    let :env do
+      {'REQUEST_URI' => url}
+    end
+
+    describe 'without robots file' do
+      let(:url){ '/lorem/ipsum/dolor' }
+      it { is_expected.to be false }
+    end
+
+    describe 'with robots txt' do
+
+      before :each do
+        allow(File).to receive(:read).and_return("
+          Allow: /lorem
+          Disallow: /ipsum
+          Disallow: /*?dolor
+          Disallow: /*&sit=
+        ")
+      end
+
+      indexed = %w{
+        /lorem/indexed
+        /noindexed/lorem
+        /indexed/ipsum
+        /indexed?a=b&dolor=true
+        /indexed?option=sit
+      }
+
+      noindexed = %w{
+        /ipsum/no_indexed
+        /no_indexed?dolor=false
+        /indexed?a=b&sit=false
+      }
+
+      indexed.each do |current_url|
+        context "for #{current_url} indexed" do
+          let(:url){ current_url }
+          it{ is_expected.to be false }
+        end
+      end
+
+      noindexed.each do |current_url|
+        context "for #{current_url} no indexed" do
+          let(:url){ current_url }
+          it{ is_expected.to be true }
+        end
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'pry'
+require 'seo_noindex'
+
+RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: seo_noindex
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Vsevolod Avramov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: pry
+  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: rspec
+  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: rack
+  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: Add noindex tag for disallowed path in robots.txt file
+email:
+- gsevka@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- lib/seo_noindex.rb
+- lib/seo_noindex/helper.rb
+- lib/seo_noindex/middleware.rb
+- lib/seo_noindex/railtie.rb
+- lib/seo_noindex/version.rb
+- seo_noindex.gemspec
+- spec/middleware_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/vsevolod/seo_noindex
+licenses:
+- MIT
+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.4.8
+signing_key: 
+specification_version: 4
+summary: seo_noindex-0.0.3
+test_files:
+- spec/middleware_spec.rb
+- spec/spec_helper.rb