schema_dot_org 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '06093d53aa2d45e3ccb4220a1fb8537f6e0f6aae306d14d23e609b6939413aa5'
-  data.tar.gz: a4f5f7a98ef6753142f80c15eb82b37358e0c227d210962b98793cb0e10c3b0d
+  metadata.gz: ce2b289fea268f2a78df900f63d7d36736bcd0b08446eb7c18a21997cfb6ec8c
+  data.tar.gz: e0a512dcf0d386376a5d227312e8fea47f95a014ed34b2b4ac9be8777f5ef1fe
 SHA512:
-  metadata.gz: 5e336d118cff1aa7afb2b73d825314993f7ee67d55a9c4c58ce3c05d0db05d9ca8d078d48903bc76d5f41fdd2931d39136b4f4fbd81c8099ef7158790d34cbc5
-  data.tar.gz: 6bcdfe9ab05c06aafe5b762c84b98a64687d2dfbd9623dc3c2d1e15dde6d1aeae78994ddf4900b21d5428d628214bd12158cf1809a748418515392b03ff47f8c
+  metadata.gz: 05ca9ceb7a3c95478f86c31d11df20f6661f6caee962170615ac35c178e4e2747f031a2675e97ea31881c50931775304caf9e684335633e8fcb5fdb527935243
+  data.tar.gz: 31b3407922f8757746424c39d9571050dc063d24610a98762ee67d424af498314b97dbaf13a5c2f57ea9a23411c8f2509587bbf596fb6d956abce5c31e28b942

data/.ruby-version

@@ -1 +1 @@
-2.5.0
+2.5.1

data/.travis.yml

@@ -1,5 +1,6 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.2
+  - 2.4.0
+  - 2.5.1
 before_install: gem install bundler -v 1.16.1

data/Gemfile.lock

@@ -1,22 +1,22 @@
 PATH
   remote: .
   specs:
-    schema_dot_org (1.3.0)
-      validated_object (~> 2.0.0)
+    schema_dot_org (1.5.0)
+      validated_object (~> 2.0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.1.5)
-      activesupport (= 5.1.5)
-    activesupport (5.1.5)
+    activemodel (5.1.6)
+      activesupport (= 5.1.6)
+    activesupport (5.1.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
-    i18n (0.9.5)
+    i18n (1.0.0)
       concurrent-ruby (~> 1.0)
     minitest (5.11.3)
     rake (10.5.0)
@@ -36,7 +36,7 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    validated_object (2.0.0)
+    validated_object (2.0.2)
       activemodel (>= 3.2.21)
 
 PLATFORMS

data/README.md

@@ -1,9 +1,9 @@
-[![CircleCI](https://circleci.com/gh/dogweather/schema-dot-org.svg?style=svg)](https://circleci.com/gh/dogweather/schema-dot-org) [![Gem Version](https://badge.fury.io/rb/schema_dot_org.svg)](https://badge.fury.io/rb/schema_dot_org) [![Maintainability](https://api.codeclimate.com/v1/badges/e0c60b4cbc998563a484/maintainability)](https://codeclimate.com/github/dogweather/schema-dot-org/maintainability)
+[![Build Status](https://travis-ci.org/dogweather/schema-dot-org.svg?branch=master)](https://travis-ci.org/dogweather/schema-dot-org) [![Gem Version](https://badge.fury.io/rb/schema_dot_org.svg)](https://badge.fury.io/rb/schema_dot_org) [![Maintainability](https://api.codeclimate.com/v1/badges/e0c60b4cbc998563a484/maintainability)](https://codeclimate.com/github/dogweather/schema-dot-org/maintainability)
 
 # SchemaDotOrg
 
 Let's create [Structured Data](https://developers.google.com/search/docs/guides/intro-structured-data) that's correct,
-every single time.
+every single time. Good structured data [helps enhance a website's search result appearance](https://developers.google.com/search/docs/guides/enhance-site).
 
 > Google Search works hard to understand the content of a page. You can help us by providing explicit clues about the meaning of a page . . .
 
@@ -19,7 +19,11 @@ Let's say you have a Rails app. If you put this in a controller:
   founding_location: Place.new(address: 'Portland, OR'),
   email:            'say_hi@public.law',
   url:              'https://www.public.law',
-  logo:             'https://www.public.law/favicon-196x196.png'
+  logo:             'https://www.public.law/favicon-196x196.png',
+  same_as: [
+    'https://twitter.com/law_is_code',
+    'https://www.facebook.com/PublicDotLaw'
+    ]
   )
 ```
 
@@ -48,7 +52,11 @@ Let's say you have a Rails app. If you put this in a controller:
   "foundingLocation": {
     "@type": "Place",
     "address": "Portland, OR"
-  }
+  },
+  "sameAs": [
+    "https://twitter.com/law_is_code",
+    "https://www.facebook.com/PublicDotLaw"
+  ],
 </script>
 ```
 
@@ -71,16 +79,60 @@ Place.new(
   address: '12345 Happy Street',
   author:  'Hemmingway'
 )
-# => NoMethodError: undefined method `author='
+# => NoMethodError: undefined method `author'
 ```
 
 This type safety comes from the [ValidatedObject gem](https://github.com/dogweather/validated_object).
 
-## The Goal: Rich enough vocabulary for Google Schema.org parsing
+## Supported Schema.org Types
+
+### WebSite
+
+Example with only the required attributes:
+
+```ruby
+WebSite.new(
+  name: 'Texas Public Law',
+  url:  'https://texas.public.law',
+)
+```
+
+With the optional `SearchAction` to enable a [Sitelinks Searchbox](https://developers.google.com/search/docs/data-types/sitelinks-searchbox):
+
+```ruby
+WebSite.new(
+  name: 'Texas Public Law',
+  url:  'https://texas.public.law',
+  potential_action: SearchAction.new(
+    target: 'https://texas.public.law/?search={search_term_string}',
+    query_input: 'required name=search_term_string'
+  )
+)
+```
+
+### Organization
+
+Example:
+
+```ruby
+Organization.new(
+  name:             'Public.Law',
+  founder:           Person.new(name: 'Robb Shecter'),
+  founding_date:     Date.new(2009, 3, 6),
+  founding_location: Place.new(address: 'Portland, OR'),
+  email:            'say_hi@public.law',
+  url:              'https://www.public.law',
+  logo:             'https://www.public.law/favicon-196x196.png',
+  same_as: [
+    'https://twitter.com/law_is_code',
+    'https://www.facebook.com/PublicDotLaw'
+  ]
+)
+```
+
+### Person, Place, and SearchAction
 
-The plan is to implement a subset of types and attributes relevant to the Google web crawler.
-See `test-script.rb` for the supported types. Currently, all the attributes are required.
-Propose new types and attributes by opening an Issue.
+These three aren't too useful on their own in web apps. They're used when creating a `WebSite` and `Organization`, as shown above.
 
 ## Installation
 

data/lib/schema_dot_org.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'validated_object'
-require 'schema_dot_org/version'
 
 module SchemaDotOrg
   #
   # Base class for schema types. Refactors out common code.
   #
   class SchemaType < ValidatedObject::Base
-    ROOT_ATTR = {"@context" => "http://schema.org"}
+    ROOT_ATTR = { "@context" => "http://schema.org" }.freeze
+    UNQUALIFIED_CLASS_NAME_REGEX = /([^:]+)$/
+
 
-     
     def to_s
       json_string = to_json_ld(pretty: true)
 
@@ -26,7 +28,7 @@ module SchemaDotOrg
       "<script type=\"application/ld+json\">\n" + to_json(pretty: pretty, as_root: true) + "\n</script>"
     end
 
-    
+
     def to_json(pretty: false, as_root: false)
       structure = as_root ? ROOT_ATTR.merge(to_json_struct) : to_json_struct
 
@@ -41,7 +43,7 @@ module SchemaDotOrg
     # Use the class name to create the "@type" attribute.
     # @return a hash structure representing json.
     def to_json_struct
-      { "@type" => un_namespaced_classname }.merge( _to_json_struct )
+      { "@type" => un_namespaced_classname }.merge(_to_json_struct.compact)
     end
 
 
@@ -52,8 +54,8 @@ module SchemaDotOrg
 
     # @return the classname without the module namespace.
     def un_namespaced_classname
-      self.class.name =~ /([^:]+)$/
-      $1
+      self.class.name =~ UNQUALIFIED_CLASS_NAME_REGEX
+      Regexp.last_match(1)
     end
   end
 end

data/lib/schema_dot_org/organization.rb

@@ -1,18 +1,30 @@
+# frozen_string_literal: true
+
 require 'date'
 require 'schema_dot_org'
+require 'schema_dot_org/person'
+require 'schema_dot_org/place'
 
 
 module SchemaDotOrg
   class Organization < SchemaType
-    attr_accessor :email, :founder, :founding_date, :founding_location, :logo, :name, :url
+    attr_accessor :email,
+                  :founder,
+                  :founding_date,
+                  :founding_location,
+                  :logo,
+                  :name,
+                  :url,
+                  :same_as
 
     validates :email,             type: String
-    validates :founder,           type: Person
+    validates :founder,           type: SchemaDotOrg::Person
     validates :founding_date,     type: Date
-    validates :founding_location, type: Place
+    validates :founding_location, type: SchemaDotOrg::Place
     validates :logo,              type: String
     validates :name,              type: String
     validates :url,               type: String
+    validates :same_as,           type: Array, allow_nil: true
 
     def _to_json_struct
       {
@@ -22,8 +34,9 @@ module SchemaDotOrg
         "logo" => logo,
         "founder" => founder.to_json_struct,
         "foundingDate" => founding_date.to_s,
-        "foundingLocation" => founding_location.to_json_struct
+        "foundingLocation" => founding_location.to_json_struct,
+        "sameAs" => same_as
       }
     end
   end
-end
+end

data/lib/schema_dot_org/person.rb

@@ -1,18 +1,19 @@
+# frozen_string_literal: true
+
 require 'schema_dot_org'
 
 
 module SchemaDotOrg
   # Model the Schema.org `Person`.  See http://schema.org/Person
   class Person < SchemaType
-
     attr_accessor :name
     validates :name, type: String, presence: true
 
 
     def _to_json_struct
       {
-        name: self.name
+        'name' => self.name
       }
     end
   end
-end
+end

data/lib/schema_dot_org/place.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'schema_dot_org'
 
 
@@ -9,8 +11,8 @@ module SchemaDotOrg
 
     def _to_json_struct
       {
-        address: self.address
+        'address' => self.address
       }
     end
   end
-end
+end

data/lib/schema_dot_org/search_action.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'schema_dot_org'
+
+
+module SchemaDotOrg
+  # Model the Schema.org `Thing > SearchAction`.  See http://schema.org/SearchAction
+  class SearchAction < SchemaType
+    attr_accessor :target, :query_input
+    validates :target,      type: String, presence: true
+    validates :query_input, type: String, presence: true
+
+    def _to_json_struct
+      {
+        'target' => self.target,
+        'query_input' => self.query_input
+      }
+    end
+  end
+end

data/lib/schema_dot_org/web_site.rb

@@ -1,22 +1,23 @@
+# frozen_string_literal: true
+
 require 'schema_dot_org'
 
 
 module SchemaDotOrg
-  # Model the Schema.org `Thing > CreativeWork > WebSite`.  
+  # Model the Schema.org `Thing > CreativeWork > WebSite`.
   # @See http://schema.org/WebSite
   class WebSite < SchemaType
-    attr_accessor :name
-    validates :name, type: String, presence: true
-
-    attr_accessor :url
-    validates :url, type: String, presence: true
+    attr_accessor :name, :url, :potential_action
+    validates :name,             type: String, presence: true
+    validates :url,              type: String, presence: true
+    validates :potential_action, type: SearchAction, allow_nil: true
 
     def _to_json_struct
       {
-        name: self.name,
-        url:  self.url
+        'name' => self.name,
+        'url' =>  self.url,
+        'potentialAction' => self.potential_action&.to_json_struct
       }
     end
   end
 end
-

data/schema_dot_org.gemspec

@@ -1,11 +1,10 @@
 
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "schema_dot_org/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "schema_dot_org"
-  spec.version       = SchemaDotOrg::VERSION
+  spec.version       = '1.5.0'
   spec.authors       = ["Robb Shecter"]
   spec.email         = ["robb@public.law"]
 
@@ -21,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "validated_object", "~> 2.0.0"
+  spec.add_dependency "validated_object", "~> 2.0.2"
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_dot_org
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Robb Shecter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-24 00:00:00.000000000 Z
+date: 2018-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: validated_object
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -88,7 +88,7 @@ files:
 - lib/schema_dot_org/organization.rb
 - lib/schema_dot_org/person.rb
 - lib/schema_dot_org/place.rb
-- lib/schema_dot_org/version.rb
+- lib/schema_dot_org/search_action.rb
 - lib/schema_dot_org/web_site.rb
 - schema_dot_org.gemspec
 - test-script.rb

data/lib/schema_dot_org/version.rb

@@ -1,3 +0,0 @@
-module SchemaDotOrg
-  VERSION = "1.3.0"
-end