quintype-seo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 735ba38e315370e148fa0ac78f48f0fa99887cc5
+  data.tar.gz: 6c29a96c4bb81ed6e0a5bb377c056c4a32495def
+SHA512:
+  metadata.gz: 63126102f023151fc923d9b85d6ddadf203d25fc3bcd410f25ccf3e6bd865090ce42b49d60d48e81994c343bfd140b18cc232ef2f18b6158abc5fba3139cfb1b
+  data.tar.gz: 9df895611cfc144b733d15009bcd3d77bdca9909e830450754e960489b34fc66121485c579e6618afe549fa41d59ccfa3f7192716b46d43089b11f90fca7db6a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in quintype-seo.gemspec
+gemspec

data/README.md

@@ -0,0 +1,54 @@
+# Quintype::SEO
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'quintype-seo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install quintype-seo
+
+## Usage
+
+### Fetching meta tag data for a page
+
+You can fetch data for each page in the following way:
+
+Section:
+```ruby
+Quintype::Seo::Section.new(config, section).to_h
+```
+
+Home:
+```ruby
+Quintype::Seo::Home.new(config).to_h
+```
+
+Story:
+```ruby
+Quintype::Seo::Story.new(config, story).to_h
+```
+
+Search and Topic:
+```ruby
+Quintype::Seo::Search.new(config, search_term).to_h
+Quintype::Seo::Tag.new(config, search_term).to_h
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/quintype/quintype-seo-ruby.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "quintype/api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/quintype/seo.rb

@@ -0,0 +1,21 @@
+require "quintype/seo/version"
+
+module Quintype
+  module Seo
+    autoload :Base, "quintype/seo/base"
+
+    def self.Base(args)
+      clazz = Struct.new(*args.map(&:intern))
+      clazz.send(:include, BaseFunctions)
+      clazz
+    end
+
+    autoload :Home, "quintype/seo/home"
+    autoload :Story, "quintype/seo/story"
+    autoload :Section, "quintype/seo/section"
+    autoload :StaticPage, "quintype/seo/static_page"
+    autoload :Search, "quintype/seo/search"
+    autoload :StoryElement, "quintype/seo/story_element"
+    autoload :Tag, "quintype/seo/tag"
+  end
+end

data/lib/quintype/seo/base.rb

@@ -0,0 +1,30 @@
+module Quintype::Seo
+  class Base
+    attr_reader :config, :page_type, :page_identifier, :grouped_metadata
+
+    def initialize(config, page_type, page_identifier = nil)
+      @config = config
+      @page_type = page_type
+      @page_identifier = page_identifier
+      @grouped_metadata = group_metadata(config['seo_metadata'])
+    end
+
+    def to_h
+      tags(page_metadata)
+    end
+
+    def tags(metadata)
+      raise 'Implement this in a child class!'
+    end
+
+    private
+
+    def page_metadata
+      Rodash.get(grouped_metadata, [[page_type, page_identifier], 0, 'data'], {})
+    end
+
+    def group_metadata(metadata)
+      metadata.group_by { |m| [m['owner_type'], m['owner_id']] }
+    end
+  end
+end

data/lib/quintype/seo/home.rb

@@ -0,0 +1,39 @@
+module Quintype::Seo
+  class Home < Quintype::Seo::Base
+
+    def initialize(config)
+      super(config, 'home')
+    end
+
+    private
+
+    def tags(metadata)
+      title = get_title(metadata)
+      metadata.except('page_title').merge({
+        'title' => title,
+        'description' => metadata['description'],
+        'og' => {
+          'title' => metadata['title'],
+          'description' => metadata['description']
+        },
+        'twitter' => {
+          'title' => metadata['title'],
+          'description' => metadata['description']
+        },
+        'msvalidate.01' => Rodash.get(config, ['integrations', 'bing', 'app_id']),
+        'fb' => {
+          'app_id' => Rodash.get(config, ['facebook', 'app_id'])
+        },
+        'alternate' => [{
+          'href' => '/feed',
+          'type' => 'application/atom+xml',
+          'title' => "#{title} ATOM Feed"
+        }]
+      })
+    end
+
+    def get_title(metadata)
+      metadata['page_title'].presence || config['title']
+    end
+  end
+end

data/lib/quintype/seo/search.rb

@@ -0,0 +1,22 @@
+module Quintype::Seo
+  class Search < Quintype::Seo::Base
+    attr_reader :term
+    def initialize(config, term)
+      super(config, 'search')
+      @term = term
+    end
+
+    private
+
+    def tags(metadata)
+      title = get_title(metadata)
+      {
+        'title' => title
+      }
+    end
+
+    def get_title(metadata)
+      term + ' - Search Results'
+    end
+  end
+end

data/lib/quintype/seo/section.rb

@@ -0,0 +1,35 @@
+module Quintype::Seo
+  class Section < Quintype::Seo::Base
+    attr_reader :section
+    def initialize(config, section)
+      super(config, 'section', section['id'])
+      @section = section
+    end
+
+    private
+
+    def tags(metadata)
+      title = get_title(metadata)
+      metadata.except('page_title').merge({
+        'title' => title,
+        'description' => metadata['description'],
+        'og' => {
+          'title' => metadata['title'],
+          'description' => metadata['description']
+        },
+        'twitter' => {
+          'title' => metadata['title'],
+          'description' => metadata['description']
+        }
+      })
+    end
+
+    def get_title(metadata)
+      metadata['page_title'].presence || make_hyphenated_title
+    end
+
+    def make_hyphenated_title
+      (section['display_name'] || section['name']) + " - " + (config['title'] || '')
+    end
+  end
+end

data/lib/quintype/seo/static_page.rb

@@ -0,0 +1,18 @@
+module Quintype::Seo
+  class StaticPage < Quintype::Seo::Base
+    attr_reader :name, :title
+    def initialize(config, name, title)
+      super(config, 'static_page', name)
+      @name = name
+      @title = title
+    end
+
+    private
+
+    def tags(metadata)
+      {
+        'title' => title
+      }
+    end
+  end
+end

data/lib/quintype/seo/story.rb

@@ -0,0 +1,72 @@
+module Quintype::Seo
+  class Story < Quintype::Seo::Base
+    attr_reader :story
+    def initialize(config, story)
+      super(config, 'story', story['slug'])
+      @story = story
+    end
+
+    private
+
+    def tags(metadata)
+      title = get_title(metadata)
+      metadata.except('page_title').merge({
+        'title' => title,
+        'description' => story['summary'],
+        'og' => og_attributes,
+        'twitter' => twitter_attributes,
+        'fb' => {
+          'app_id' => Rodash.get(config, ['facebook', 'app_id'])
+        },
+        'article' => {
+          'publisher' => Rodash.get(config , ['social_links', 'facebook_url'])
+        },
+        'msvalidate.01' => Rodash.get(config, ['integrations', 'bing', 'app_id']),
+        'canonical' => API::URL.story_canonical(config['root_url'], story),
+        'al:android:package' => Rodash.get(config, ['apps_data', 'al:android:package']),
+        'al:android:app_name' => Rodash.get(config, ['apps_data', 'al:android:app_name']),
+        'al:android:url' => "quintypefb://#{config['host']}/#{story['slug']}"
+      })
+    end
+
+    def twitter_attributes
+      {
+        'title' => story['headline'],
+        'description' => story['summary'],
+        'card' => 'summary_large_image',
+        'site' => Rodash.get(config, ['social_app_credentials', 'twitter', 'username']),
+        'image' => {
+          'src' => hero_image_url
+        }
+      }
+    end
+
+    def og_attributes
+      hash = {
+        'title' => story['headline'],
+        'type' => 'article',
+        'url' => API::URL.story_canonical(config['root_url'], story),
+        'site_name' => config['title'],
+        'description' => story['summary'],
+        'image' => (config['cdn_name'] + story['hero_image_s3_key']).gsub(" ", "%20")
+      }
+      if hero_image_metadata = story['hero_image_metadata'].presence
+        hash.merge!("image:width" => hero_image_metadata["width"]) if hero_image_metadata["width"]
+        hash.merge!("image:height" => hero_image_metadata["height"]) if hero_image_metadata["height"]
+      end
+      hash
+    end
+
+    def hero_image_url
+      (config['cdn_name'] + story['hero_image_s3_key']).gsub(" ", "%20")
+    end
+
+    def get_title(metadata)
+      metadata['page_title'].presence || make_hyphenated_title
+    end
+
+    def make_hyphenated_title
+      story['headline'] + " - " + config['title']
+    end
+  end
+end

data/lib/quintype/seo/story_element.rb

@@ -0,0 +1,24 @@
+module Quintype::Seo
+  class StoryElement < Quintype::Seo::Base
+    attr_reader :story, :story_element
+    def initialize(config, story, story_element)
+      super(config, 'story-element')
+      @story = story
+      @story_element = story_element
+    end
+
+    private
+
+    def tags(metadata)
+      title = get_title(metadata)
+      metadata.except('page_title').merge({
+        'title' => title,
+        'canonical' => API::URL.story_canonical(config['root_url'], story),
+      })
+    end
+
+    def get_title(metadata)
+      story['headline'] + " - " + config['title']
+    end
+  end
+end

data/lib/quintype/seo/tag.rb

@@ -0,0 +1,22 @@
+module Quintype::Seo
+  class Tag < Quintype::Seo::Base
+    attr_reader :tag
+    def initialize(config, tag)
+      super(config, 'tag', tag)
+      @tag = tag
+    end
+
+    private
+
+    def tags(metadata)
+      title = get_title(metadata)
+      {
+        'title' => title
+      }
+    end
+
+    def get_title(metadata)
+      tag + ' - ' + (config['title'] || '')
+    end
+  end
+end

data/lib/quintype/seo/version.rb

@@ -0,0 +1,5 @@
+module Quintype
+  module Seo
+    VERSION = "0.0.1"
+  end
+end

data/quintype-seo.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'quintype/seo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "quintype-seo"
+  spec.version       = Quintype::Seo::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ["Ramsharan"]
+  spec.email         = ["sharangj@gmail.com"]
+
+  spec.summary       = %q{Ruby Gem to set seo meta tags for quintype}
+  spec.homepage      = "https://github.com/quintype/quintype-seo-ruby"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: quintype-seo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ramsharan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2016-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description:
+email:
+- sharangj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/quintype/seo.rb
+- lib/quintype/seo/base.rb
+- lib/quintype/seo/home.rb
+- lib/quintype/seo/search.rb
+- lib/quintype/seo/section.rb
+- lib/quintype/seo/static_page.rb
+- lib/quintype/seo/story.rb
+- lib/quintype/seo/story_element.rb
+- lib/quintype/seo/tag.rb
+- lib/quintype/seo/version.rb
+- quintype-seo.gemspec
+homepage: https://github.com/quintype/quintype-seo-ruby
+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.4.8
+signing_key:
+specification_version: 4
+summary: Ruby Gem to set seo meta tags for quintype
+test_files: []