microdata 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jason Ronallo
+
+MIT License
+
+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,41 @@
+# Microdata
+
+Ruby library for extracting HTML5 Microdata
+
+## Story 
+
+Most of the code here was extracted from [Mida](https://github.com/LawrenceWoodman/mida) by Lawrence Woodman. This was done in order to have a simpler, more generic Microdata parser without all the vocabulary awareness and other features. This gem is also tested under Ruby 1.9.3 and Ruby 2.0.0, though it could be better tested.
+
+## Installation
+
+This library has not been released to RubyGems.org yet, but when it is the intention is to have it install with the following.
+
+Add this line to your application's Gemfile:
+
+    gem 'microdata'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install microdata
+
+## Usage
+
+The commandline tool microdata.rb can be run like the following:
+
+```
+microdata.rb http://d.lib.ncsu.edu/collections/catalog/mc00383-001-ff0006-001-001_0038
+```
+
+Output is in pretty JSON format.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+ t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/microdata.rb

@@ -0,0 +1,8 @@
+#! /usr/bin/env ruby
+
+# microdata.rb 
+# Extract HTML5 Microdata and output JSON
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'microdata'
+
+puts Microdata.to_json(ARGV[0])

data/lib/microdata.rb

@@ -0,0 +1,42 @@
+require "microdata/version"
+require "nokogiri"
+require "microdata/item"
+require "microdata/document"
+require "microdata/itemprop"
+require 'open-uri'
+require 'json'
+require 'uri'
+
+module Microdata
+
+  # PROPERTY_VALUES = {
+  #   meta:     'content',
+  #   audio:    'src',
+  #   embed:    'src',
+  #   iframe:   'src',
+  #   img:      'src',
+  #   source:   'src',
+  #   video:    'src',
+  #   a:        'href',
+  #   area:     'href',
+  #   link:     'href',
+  #   object:   'data',
+  #   time:     'datetime'
+  # }
+
+  def self.get_items(location)
+    content = open(location)
+    page_url = location
+    Microdata::Document.new(content, page_url).extract_items
+  end
+
+  def self.to_json(location)
+    items = get_items(location)
+    hash = {}
+    hash[:items] = items.map do |item|
+      item.to_hash
+    end
+    JSON.pretty_generate hash
+  end
+
+end

data/lib/microdata/document.rb

@@ -0,0 +1,22 @@
+module Microdata
+  class Document
+
+    attr_reader :items
+
+    def initialize(content, page_url=nil)
+      @doc = Nokogiri::HTML(content)
+      @page_url = page_url
+      @items = extract_items
+    end
+
+    def extract_items
+      itemscopes = @doc.search('//*[@itemscope and not(@itemprop)]')
+      return nil unless itemscopes
+
+      itemscopes.collect do |itemscope|
+        Item.new(itemscope, @page_url)
+      end
+    end
+
+  end
+end

data/lib/microdata/item.rb

@@ -0,0 +1,65 @@
+module Microdata
+  class Item
+    attr_reader :type, :properties, :id
+
+    def initialize(top_node, page_url)
+      @top_node = top_node
+      @type = extract_itemtype
+      @id   = extract_itemid
+      @properties = {}
+      @page_url = page_url
+      parse_elements(extract_elements(@top_node))
+    end
+
+    def to_hash
+      hash = {}
+      hash[:id] = id if id
+      hash[:type] = type
+      hash[:properties] = {}
+      properties.each do |name, values|
+        final_values = values.map do |value|
+          if value.is_a?(Item)
+            value.to_hash
+          else
+            value
+          end
+        end
+        hash[:properties][name] = final_values
+      end
+      hash
+    end
+
+    private
+
+    def extract_elements(node)
+      node.search('./*')
+    end
+
+    def extract_itemid
+      (value = @top_node.attribute('itemid')) ? value.value : nil
+    end
+
+    def extract_itemtype
+      (value = @top_node.attribute('itemtype')) ? value.value.split(' ') : nil
+    end
+
+    def parse_elements(elements)
+      elements.each {|element| parse_element(element)}
+    end
+
+    def parse_element(element)
+      itemscope = element.attribute('itemscope')
+      itemprop = element.attribute('itemprop')
+      internal_elements = extract_elements(element)
+      add_itemprop(element) if itemscope || itemprop
+      parse_elements(internal_elements) if internal_elements && !itemscope
+    end
+
+    # Add an 'itemprop' to the properties
+    def add_itemprop(itemprop)
+      properties = Itemprop.parse(itemprop, @page_url)
+      properties.each { |name, value| (@properties[name] ||= []) << value }
+    end
+
+  end
+end

data/lib/microdata/itemprop.rb

@@ -0,0 +1,91 @@
+module Microdata
+# Class that parses itemprop elements
+  class Itemprop
+
+    NON_TEXTCONTENT_ELEMENTS = {
+      'a' => 'href',        'area' => 'href',
+      'audio' => 'src',     'embed' => 'src',
+      'iframe' => 'src',    'img' => 'src',
+      'link' => 'href',     'meta' => 'content',
+      'object' => 'data',   'source' => 'src',
+      'time' => 'datetime', 'track' => 'src',
+      'video' => 'src'
+    }
+
+    URL_ATTRIBUTES = ['data', 'href', 'src']
+
+    # A Hash representing the properties.
+    # Hash is of the form {'property name' => 'value'}
+    attr_reader :properties
+
+    # Create a new Itemprop object
+    # [element]  The itemprop element to be parsed
+    # [page_url] The url of the page, including filename, used to form
+    #            absolute urls
+    def initialize(element, page_url=nil)
+      @element, @page_url = element, page_url
+      @properties = extract_properties
+    end
+
+    # Parse the element and return a hash representing the properties.
+    # Hash is of the form {'property name' => 'value'}
+    # [element]  The itemprop element to be parsed
+    # [page_url] The url of the page, including filename, used to form
+    #            absolute urls
+    def self.parse(element, page_url=nil)
+      self.new(element, page_url).properties
+    end
+
+  private
+    def extract_properties
+      prop_names = extract_property_names
+      prop_names.each_with_object({}) do |name, memo|
+        memo[name] = extract_property
+      end
+    end
+
+    # This returns an empty string if can't form a valid
+    # absolute url as per the Microdata spec.
+    def make_absolute_url(url)
+      return url unless URI.parse(url).relative?
+      begin
+        URI.parse(@page_url).merge(url).to_s
+      rescue URI::Error
+        url
+      end
+    end
+
+    def non_textcontent_element?(element)
+      NON_TEXTCONTENT_ELEMENTS.has_key?(element)
+    end
+
+    def url_attribute?(attribute)
+      URL_ATTRIBUTES.include?(attribute)
+    end
+
+    def extract_property_names
+      itemprop_attr = @element.attribute('itemprop')
+      itemprop_attr ? itemprop_attr.value.split() : []
+    end
+
+    def extract_property_value
+      element = @element.name
+      if non_textcontent_element?(element)
+        attribute = NON_TEXTCONTENT_ELEMENTS[element]
+        value = @element.attribute(attribute).value
+        url_attribute?(attribute) ? make_absolute_url(value) : value
+      else
+        @element.inner_text.strip
+      end
+    end
+
+    def extract_property
+      if @element.attribute('itemscope')
+        Item.new(@element, @page_url)
+      else
+        extract_property_value
+      end
+    end
+
+  end
+end

data/lib/microdata/version.rb

@@ -0,0 +1,3 @@
+module Microdata
+  VERSION = "0.0.1"
+end

data/microdata.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'microdata/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "microdata"
+  spec.version       = Microdata::VERSION
+  spec.authors       = ["Jason Ronallo"]
+  spec.email         = ["jronallo@gmail.com"]
+  spec.description   = %q{HTML5 Microdata extractor}
+  spec.summary       = %q{Ruby library for extracting HTML5 Microdata}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/test/data/example.html

@@ -0,0 +1,22 @@
+<!doctype html>
+<html>
+    <!-- shameless -->
+    <head>
+        <title>Jason Ronallo</title>
+    </head>
+
+    <body>
+      <span itemscope itemtype="http://schema.org/Person"
+        itemid="http://ronallo.com#me">
+        <a itemprop="url" href="http://twitter.com/ronallo">
+          <span itemprop="name">Jason Ronallo</span>
+        </a> is the 
+        <span itemprop="jobTitle">Associate Head of Digital Library Initiatives</span> at 
+        <span itemprop="affiliation" itemscope itemtype="http://schema.org/Library" itemid="http://lib.ncsu.edu">
+          <span itemprop="name">
+            <a itemprop="url" href="http://www.lib.ncsu.edu">NCSU Libraries</a>
+          </span>
+        </span>.
+      </span>
+    </body>
+</html>

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require 'microdata'

data/test/test_parse.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+class TestParse < Test::Unit::TestCase
+
+  def setup
+    @items = Microdata.get_items('test/data/example.html')
+  end
+
+  def test_top_item_type
+    assert_equal ['http://schema.org/Person'], @items.first.type
+  end
+
+  def test_top_item_id
+    assert_equal "http://ronallo.com#me", @items.first.id
+  end
+
+  def test_top_item_properties
+    properties = @items.first.properties
+    assert_equal ["Jason Ronallo"], properties['name']
+    assert_equal ["http://twitter.com/ronallo"], properties['url']
+    assert_equal ["Associate Head of Digital Library Initiatives"], properties['jobTitle']
+  end 
+
+  def test_nested_item
+    item = @items.first.properties['affiliation'][0]
+    assert_equal ['http://schema.org/Library'], item.type
+    assert_equal "http://lib.ncsu.edu", item.id
+  end
+
+  def test_nested_item_properties
+    properties = @items.first.properties['affiliation'][0].properties
+    assert_equal ['NCSU Libraries'], properties['name']
+    assert_equal ['http://www.lib.ncsu.edu'], properties['url']
+  end
+
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: microdata
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jason Ronallo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: HTML5 Microdata extractor
+email:
+- jronallo@gmail.com
+executables:
+- microdata.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/microdata.rb
+- lib/microdata.rb
+- lib/microdata/document.rb
+- lib/microdata/item.rb
+- lib/microdata/itemprop.rb
+- lib/microdata/version.rb
+- microdata.gemspec
+- test/data/example.html
+- test/test_helper.rb
+- test/test_parse.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Ruby library for extracting HTML5 Microdata
+test_files:
+- test/data/example.html
+- test/test_helper.rb
+- test/test_parse.rb
+has_rdoc: