kms_seo 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cee0939b2b5f7825c1bc2469f783ded0e11bedbb
-  data.tar.gz: bf2fc6ba9f87140f3373307d6b699f070045f120
+  metadata.gz: 108eacfbb67d758306993613211ecf4627402d1e
+  data.tar.gz: cbec80ab38fa20b36426c4fa5b996cea3bc7137c
 SHA512:
-  metadata.gz: b996a6b7bf18f46a92aee0723dde9378bd8479b3c4b3e1aa4633a5f4e88f021393dc76cd0a5c63b49ea40628eea328355aac9eb1ed377de8a0a70710b1a7e548
-  data.tar.gz: 2bf53cdacad8c9e533a11b227410ebc404198cc59d56e906d913aeec71573648a352e6737000ecc9922eaeba35931d7a6ef5b85f66808f68d75ef6bae944bf67
+  metadata.gz: 2c659111e84f299f9a6547fa087ef36def00694a1dcb40c5eef945ebb0fe33e4d37641bc617f1901331463b41ed06275232313ef66b83a6e843d7223003b787f
+  data.tar.gz: 94a680c49449f689dad56c504b1c887a8de5ada4a7ccce26218ac4cdd20fb641feab9114da38864136604c19d4806ce8007d52933c6a83b38da35404770badfe

data/README.md

@@ -1,12 +1,14 @@
 ## KMS SEO
 
-Adds SEO support to KMS: meta tags fields for Pages, sitemap.xml generating, redirects, special {{ seo }} variable.
+Adds SEO support to KMS: additional fields for Pages (meta tags, h1), sitemap.xml generating, redirects, special {{ seo }} variable.
 
 Use "seo" object for accessing SEO settings for page or object.
 
         <title>{{ seo.title }}</title>
         <meta name="keywords" content="{{ seo.keywords }}">
         <meta name="description" content="{{ seo.description }}">
+        ...
+        <h1>{{ seo.h1 }}</h1>
 
 Also, this adds sitemap generation support (at /sitemap.xml)
 

data/app/assets/javascripts/templates/pages/seo.html.slim

@@ -12,3 +12,6 @@ accordion close-others="true"
     .form-group
       label for="seo_description" = Kms::Page.human_attribute_name(:seo_description)
       input#seo_description.form-control type="text" ng-model="page.seo_description"
+    .form-group
+      label for="seo_h1" = Kms::Page.human_attribute_name(:seo_h1)
+      input#seo_h1.form-control type="text" ng-model="page.seo_h1"

data/app/assets/javascripts/templates/settings/robots.html.slim

@@ -0,0 +1,3 @@
+.form-group
+  label = I18n.t(:robots_txt)
+  textarea.form-control ng-model="settings.values.robots" rows='5'

data/app/controllers/kms/pages_controller_decorator.rb

@@ -1,3 +1,3 @@
 Kms::PagesController.class_eval do
-  wrap_parameters :page, include: [:title, :slug, :content, :published, :template_id, :templatable,:templatable_type,:position,:hidden, :parent_id, :seo_title, :seo_keywords, :seo_description]
+  wrap_parameters :page, include: [:title, :slug, :content, :published, :template_id, :templatable,:templatable_type,:position,:hidden, :parent_id, :seo_title, :seo_keywords, :seo_description, :seo_h1]
 end

data/app/controllers/kms/public/robots_controller.rb

@@ -0,0 +1,9 @@
+module Kms
+  module Public
+    class RobotsController < ActionController::Base
+      def show
+        render plain: Kms::Settings.instance.values['robots']
+      end
+    end
+  end
+end

data/config/initializers/settings.rb

@@ -0,0 +1 @@
+Kms::SettingsService.register_templates Kms::Seo::Engine, 'settings/robots.html'

data/config/locales/en.yml

@@ -1,6 +1,7 @@
 en:
   seo: "SEO"
   add_redirect: "Add Redirect"
+  robots_txt: "Robots.txt"
   activerecord:
     models:
       kms/redirect:
@@ -13,6 +14,7 @@ en:
         seo_title: "Meta Title"
         seo_keywords: "Meta Keywords"
         seo_description: "Meta Description"
+        seo_h1: "H1"
       kms/redirect:
         source: "Source/From"
         destination: "Destination/To"

data/config/locales/ru.yml

@@ -1,6 +1,7 @@
 ru:
   seo: "SEO"
   add_redirect: "Добавить редирект"
+  robots_txt: "Robots.txt"
   activerecord:
     models:
       kms/redirect:
@@ -13,6 +14,7 @@ ru:
         seo_title: "Meta Title"
         seo_keywords: "Meta Keywords"
         seo_description: "Meta Description"
+        seo_h1: "H1"
       kms/redirect:
         source: "Откуда"
         destination: "Куда"

data/config/routes.rb

@@ -5,4 +5,5 @@ Kms::Seo::Engine.routes.draw do
 end
 Rails.application.routes.draw do
   get '/sitemap.xml'  => 'kms/public/sitemaps#show', format: 'xml'
+  get '/robots.txt' => 'kms/public/robots#show', format: 'txt'
 end

data/db/migrate/20150727192219_add_seo_fields_to_pages.rb

@@ -1,4 +1,4 @@
-class AddSeoFieldsToPages < ActiveRecord::Migration
+class AddSeoFieldsToPages < ActiveRecord::Migration[4.2]
   def change
     add_column :kms_pages, :seo_title, :string
     add_column :kms_pages, :seo_keywords, :string

data/db/migrate/20150903135219_create_redirects.rb

@@ -1,4 +1,4 @@
-class CreateRedirects < ActiveRecord::Migration
+class CreateRedirects < ActiveRecord::Migration[4.2]
   def change
     create_table :kms_redirects do |t|
       t.string :source

data/db/migrate/20170202090601_add_seo_h1_to_pages.rb

@@ -0,0 +1,5 @@
+class AddSeoH1ToPages < ActiveRecord::Migration[5.0]
+  def change
+    add_column :kms_pages, :seo_h1, :string
+  end
+end

data/lib/{kms/drops → drops/kms}/seo_wrapper_drop.rb

@@ -1,5 +1,5 @@
 module Kms
   class SeoWrapperDrop < Liquor::Drop
-    attributes :title, :keywords, :description
+    attributes :title, :keywords, :description, :h1
   end
 end

data/lib/kms/seo/engine.rb

@@ -9,6 +9,10 @@ module Kms
           require_dependency(c)
         end
       end
+
+      config.generators do |g|
+        g.test_framework :rspec
+      end
     end
   end
 end

data/lib/kms/seo/version.rb

@@ -1,5 +1,5 @@
 module Kms
   module Seo
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/kms/seo_wrapper.rb

@@ -21,5 +21,10 @@ module Kms
       return nil unless @seo_context.respond_to?(:seo_description)
       @seo_context.seo_description
     end
+
+    def h1
+      return nil unless @seo_context.respond_to?(:seo_h1)
+      @seo_context.seo_h1
+    end
   end
 end

data/spec/controllers/kms/public/robots_controller_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+module Kms
+  module Public
+    describe RobotsController, type: :controller do
+      describe '#show' do
+        before do
+          Kms::Settings.instance.update(values: {robots: 'User-agent: *'})
+        end
+        it 'renders content of robots.txt setting' do
+          get :show
+          expect(response.body).to eql(Kms::Settings.instance.values['robots'])
+        end
+        it 'responds with http 200 status' do
+          get :show
+          expect(response).to be_success
+        end
+      end
+
+    end
+  end
+end

data/spec/drops/kms/seo_wrapper_drop_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+module Kms
+  describe SeoWrapperDrop do
+    let!(:page) { FactoryGirl.create(:page) }
+
+    let(:request) { ActionController::TestRequest.new({host:  'example.com', "rack.input" => "wtf"}, ActionController::TestRequest.new_session) }
+    let(:controller) do
+      controller = Kms::Public::PagesController.new
+      controller.request = request
+      controller
+    end
+
+    it 'should be registered as "seo" in ExternalsRegistry' do
+      expect(Kms::ExternalsRegistry.externals[:seo]).to be_instance_of(Proc)
+    end
+
+    it 'should return a "drop" of Kms::SeoWrapper' do
+      expect(Kms::ExternalsRegistry.externals[:seo].call(request, controller)).to be_instance_of(described_class)
+    end
+
+    it 'should respond_to/export "title" attribute' do
+      seo_wrapper_drop = Kms::ExternalsRegistry.externals[:seo].call(request, controller)
+      expect(seo_wrapper_drop).to respond_to(:title)
+    end
+
+    it 'should respond_to/export "keywords" attribute' do
+      seo_wrapper_drop = Kms::ExternalsRegistry.externals[:seo].call(request, controller)
+      expect(seo_wrapper_drop).to respond_to(:keywords)
+    end
+
+    it 'should respond_to/export "description" attribute' do
+      seo_wrapper_drop = Kms::ExternalsRegistry.externals[:seo].call(request, controller)
+      expect(seo_wrapper_drop).to respond_to(:description)
+    end
+
+    it 'should respond_to/export "h1" attribute' do
+      seo_wrapper_drop = Kms::ExternalsRegistry.externals[:seo].call(request, controller)
+      expect(seo_wrapper_drop).to respond_to(:h1)
+    end
+
+  end
+end

data/spec/factories/pages.rb

@@ -0,0 +1,11 @@
+FactoryGirl.define do
+  factory :page, class: 'Kms::Page' do
+    title "Home"
+    slug 'index'
+    published true
+    seo_title 'Home'
+    seo_keywords 'home, page'
+    seo_description 'Home Page'
+    seo_h1 'Home Page'
+  end
+end

data/spec/internal/Rakefile

@@ -0,0 +1,2 @@
+require 'combustion'
+Combustion::Application.load_tasks

data/spec/internal/config/database.yml

@@ -0,0 +1,7 @@
+test:
+  adapter:  postgresql
+  database: kms_test
+  username: postgres
+  password:
+  encoding: utf-8
+  host: localhost

data/spec/internal/config/database.yml.travis

@@ -0,0 +1,7 @@
+test:
+  adapter:  postgresql
+  database: kms_test
+  username: postgres
+  password:
+  encoding: utf-8
+  host: localhost

data/spec/internal/config/initializers/devise.rb

@@ -0,0 +1,257 @@
+# Use this hook to configure devise mailer, warden hooks and so forth.
+# Many of these configuration options can be set straight in your model.
+Devise.setup do |config|
+  # The secret key used by Devise. Devise uses this key to generate
+  # random tokens. Changing this key will render invalid all existing
+  # confirmation, reset password and unlock tokens in the database.
+  config.secret_key = '57e00a5d56d16d1341110df1455911bf2890d652efc6a2cf52ea3f341405770878d6a471530601ad1a7058a2e073537315eb3852e34b8384a93c108e05097725'
+
+  # ==> Mailer Configuration
+  # Configure the e-mail address which will be shown in Devise::Mailer,
+  # note that it will be overwritten if you use your own mailer class
+  # with default "from" parameter.
+  config.mailer_sender = 'please-change-me-at-config-initializers-devise@example.com'
+
+  # Configure the class responsible to send e-mails.
+  # config.mailer = 'Devise::Mailer'
+
+  # ==> ORM configuration
+  # Load and configure the ORM. Supports :active_record (default) and
+  # :mongoid (bson_ext recommended) by default. Other ORMs may be
+  # available as additional gems.
+  require 'devise/orm/active_record'
+
+  # ==> Configuration for any authentication mechanism
+  # Configure which keys are used when authenticating a user. The default is
+  # just :email. You can configure it to use [:username, :subdomain], so for
+  # authenticating a user, both parameters are required. Remember that those
+  # parameters are used only when authenticating and not when retrieving from
+  # session. If you need permissions, you should implement that in a before filter.
+  # You can also supply a hash where the value is a boolean determining whether
+  # or not authentication should be aborted when the value is not present.
+  # config.authentication_keys = [ :email ]
+
+  # Configure parameters from the request object used for authentication. Each entry
+  # given should be a request method and it will automatically be passed to the
+  # find_for_authentication method and considered in your model lookup. For instance,
+  # if you set :request_keys to [:subdomain], :subdomain will be used on authentication.
+  # The same considerations mentioned for authentication_keys also apply to request_keys.
+  # config.request_keys = []
+
+  # Configure which authentication keys should be case-insensitive.
+  # These keys will be downcased upon creating or modifying a user and when used
+  # to authenticate or find a user. Default is :email.
+  config.case_insensitive_keys = [ :email ]
+
+  # Configure which authentication keys should have whitespace stripped.
+  # These keys will have whitespace before and after removed upon creating or
+  # modifying a user and when used to authenticate or find a user. Default is :email.
+  config.strip_whitespace_keys = [ :email ]
+
+  # Tell if authentication through request.params is enabled. True by default.
+  # It can be set to an array that will enable params authentication only for the
+  # given strategies, for example, `config.params_authenticatable = [:database]` will
+  # enable it only for database (email + password) authentication.
+  # config.params_authenticatable = true
+
+  # Tell if authentication through HTTP Auth is enabled. False by default.
+  # It can be set to an array that will enable http authentication only for the
+  # given strategies, for example, `config.http_authenticatable = [:database]` will
+  # enable it only for database authentication. The supported strategies are:
+  # :database      = Support basic authentication with authentication key + password
+  # config.http_authenticatable = false
+
+  # If http headers should be returned for AJAX requests. True by default.
+  # config.http_authenticatable_on_xhr = true
+
+  # The realm used in Http Basic Authentication. 'Application' by default.
+  # config.http_authentication_realm = 'Application'
+
+  # It will change confirmation, password recovery and other workflows
+  # to behave the same regardless if the e-mail provided was right or wrong.
+  # Does not affect registerable.
+  # config.paranoid = true
+
+  # By default Devise will store the user in session. You can skip storage for
+  # particular strategies by setting this option.
+  # Notice that if you are skipping storage for all authentication paths, you
+  # may want to disable generating routes to Devise's sessions controller by
+  # passing skip: :sessions to `devise_for` in your config/routes.rb
+  config.skip_session_storage = [:http_auth]
+
+  # By default, Devise cleans up the CSRF token on authentication to
+  # avoid CSRF token fixation attacks. This means that, when using AJAX
+  # requests for sign in and sign up, you need to get a new CSRF token
+  # from the server. You can disable this option at your own risk.
+  # config.clean_up_csrf_token_on_authentication = true
+
+  # ==> Configuration for :database_authenticatable
+  # For bcrypt, this is the cost for hashing the password and defaults to 10. If
+  # using other encryptors, it sets how many times you want the password re-encrypted.
+  #
+  # Limiting the stretches to just one in testing will increase the performance of
+  # your test suite dramatically. However, it is STRONGLY RECOMMENDED to not use
+  # a value less than 10 in other environments. Note that, for bcrypt (the default
+  # encryptor), the cost increases exponentially with the number of stretches (e.g.
+  # a value of 20 is already extremely slow: approx. 60 seconds for 1 calculation).
+  config.stretches = Rails.env.test? ? 1 : 10
+
+  # Setup a pepper to generate the encrypted password.
+  # config.pepper = '941376f1bd6d84642f36af53a6ab6e4cde564019db133c446f53ee1fb2999536d72793983406f515b7bcb9fdb5e2cf174e9bdfab23edf0427a80b6a6977ee48e'
+
+  # ==> Configuration for :confirmable
+  # A period that the user is allowed to access the website even without
+  # confirming their account. For instance, if set to 2.days, the user will be
+  # able to access the website for two days without confirming their account,
+  # access will be blocked just in the third day. Default is 0.days, meaning
+  # the user cannot access the website without confirming their account.
+  # config.allow_unconfirmed_access_for = 2.days
+
+  # A period that the user is allowed to confirm their account before their
+  # token becomes invalid. For example, if set to 3.days, the user can confirm
+  # their account within 3 days after the mail was sent, but on the fourth day
+  # their account can't be confirmed with the token any more.
+  # Default is nil, meaning there is no restriction on how long a user can take
+  # before confirming their account.
+  # config.confirm_within = 3.days
+
+  # If true, requires any email changes to be confirmed (exactly the same way as
+  # initial account confirmation) to be applied. Requires additional unconfirmed_email
+  # db field (see migrations). Until confirmed, new email is stored in
+  # unconfirmed_email column, and copied to email column on successful confirmation.
+  config.reconfirmable = true
+
+  # Defines which key will be used when confirming an account
+  # config.confirmation_keys = [ :email ]
+
+  # ==> Configuration for :rememberable
+  # The time the user will be remembered without asking for credentials again.
+  # config.remember_for = 2.weeks
+
+  # If true, extends the user's remember period when remembered via cookie.
+  # config.extend_remember_period = false
+
+  # Options to be passed to the created cookie. For instance, you can set
+  # secure: true in order to force SSL only cookies.
+  # config.rememberable_options = {}
+
+  # ==> Configuration for :validatable
+  # Range for password length.
+  config.password_length = 8..128
+
+  # Email regex used to validate email formats. It simply asserts that
+  # one (and only one) @ exists in the given string. This is mainly
+  # to give user feedback and not to assert the e-mail validity.
+  # config.email_regexp = /\A[^@]+@[^@]+\z/
+
+  # ==> Configuration for :timeoutable
+  # The time you want to timeout the user session without activity. After this
+  # time the user will be asked for credentials again. Default is 30 minutes.
+  # config.timeout_in = 30.minutes
+
+  # If true, expires auth token on session timeout.
+  # config.expire_auth_token_on_timeout = false
+
+  # ==> Configuration for :lockable
+  # Defines which strategy will be used to lock an account.
+  # :failed_attempts = Locks an account after a number of failed attempts to sign in.
+  # :none            = No lock strategy. You should handle locking by yourself.
+  # config.lock_strategy = :failed_attempts
+
+  # Defines which key will be used when locking and unlocking an account
+  # config.unlock_keys = [ :email ]
+
+  # Defines which strategy will be used to unlock an account.
+  # :email = Sends an unlock link to the user email
+  # :time  = Re-enables login after a certain amount of time (see :unlock_in below)
+  # :both  = Enables both strategies
+  # :none  = No unlock strategy. You should handle unlocking by yourself.
+  # config.unlock_strategy = :both
+
+  # Number of authentication tries before locking an account if lock_strategy
+  # is failed attempts.
+  # config.maximum_attempts = 20
+
+  # Time interval to unlock the account if :time is enabled as unlock_strategy.
+  # config.unlock_in = 1.hour
+
+  # Warn on the last attempt before the account is locked.
+  # config.last_attempt_warning = false
+
+  # ==> Configuration for :recoverable
+  #
+  # Defines which key will be used when recovering the password for an account
+  # config.reset_password_keys = [ :email ]
+
+  # Time interval you can reset your password with a reset password key.
+  # Don't put a too small interval or your users won't have the time to
+  # change their passwords.
+  config.reset_password_within = 6.hours
+
+  # ==> Configuration for :encryptable
+  # Allow you to use another encryption algorithm besides bcrypt (default). You can use
+  # :sha1, :sha512 or encryptors from others authentication tools as :clearance_sha1,
+  # :authlogic_sha512 (then you should set stretches above to 20 for default behavior)
+  # and :restful_authentication_sha1 (then you should set stretches to 10, and copy
+  # REST_AUTH_SITE_KEY to pepper).
+  #
+  # Require the `devise-encryptable` gem when using anything other than bcrypt
+  # config.encryptor = :sha512
+
+  # ==> Scopes configuration
+  # Turn scoped views on. Before rendering "sessions/new", it will first check for
+  # "users/sessions/new". It's turned off by default because it's slower if you
+  # are using only default views.
+  # config.scoped_views = false
+
+  # Configure the default scope given to Warden. By default it's the first
+  # devise role declared in your routes (usually :user).
+  # config.default_scope = :user
+
+  # Set this configuration to false if you want /users/sign_out to sign out
+  # only the current scope. By default, Devise signs out all scopes.
+  # config.sign_out_all_scopes = true
+
+  # ==> Navigation configuration
+  # Lists the formats that should be treated as navigational. Formats like
+  # :html, should redirect to the sign in page when the user does not have
+  # access, but formats like :xml or :json, should return 401.
+  #
+  # If you have any extra navigational formats, like :iphone or :mobile, you
+  # should add them to the navigational formats lists.
+  #
+  # The "*/*" below is required to match Internet Explorer requests.
+  # config.navigational_formats = ['*/*', :html]
+
+  # The default HTTP method used to sign out a resource. Default is :delete.
+  config.sign_out_via = :get
+
+  # ==> OmniAuth
+  # Add a new OmniAuth provider. Check the wiki for more information on setting
+  # up on your models and hooks.
+  # config.omniauth :github, 'APP_ID', 'APP_SECRET', scope: 'user,public_repo'
+
+  # ==> Warden configuration
+  # If you want to use other strategies, that are not supported by Devise, or
+  # change the failure app, you can configure them inside the config.warden block.
+  #
+  # config.warden do |manager|
+  #   manager.intercept_401 = false
+  #   manager.default_strategies(scope: :user).unshift :some_external_strategy
+  # end
+
+  # ==> Mountable engine configurations
+  # When using Devise inside an engine, let's call it `MyEngine`, and this engine
+  # is mountable, there are some extra configurations to be taken into account.
+  # The following options are available, assuming the engine is mounted as:
+  #
+  #     mount MyEngine, at: '/my_engine'
+  #
+  # The router that invoked `devise_for`, in the example above, would be:
+  config.router_name = :kms
+  config.parent_controller = 'Kms::ApplicationController'
+  #
+  # When using omniauth, Devise cannot automatically set Omniauth path,
+  # so you need to do it manually. For the users scope, it would be:
+  # config.omniauth_path_prefix = '/my_engine/users/auth'
+end