hentry_consumer 0.5.3 → 0.6.0

data/README.md

@@ -1,28 +1,40 @@
 # H-Entry Consumer
 
-A Ruby gem to parse HTML containing one or more Microformat 2 h-entry elements, returning an a collection of
-serialized h-entry objects. The returned Object structure looks something like this:
-
-- HFeed
-  - HEntry
-    - [name]
-    - [summary]
-    - [email]
-    - [content]
-    - [author]
-    - bookmark
-      - HCard
-    - [categories]
-      - {}
-  - HEntry
-    - ...
-
-[Microformats 2 h-entry](http://microformats.org/wiki/microformats-2#h-entry)
+A Ruby gem to parse HTML containing one or more 
+[microformats 2 h-entry elements](http://microformats.org/wiki/microformats-2#h-entry), 
+returning an a collection of serialized h-entry objects. 
+
+The returned Object structure looks something like this:
+
+```ruby
+{ :items => [{ 
+  :type => ["h-entry"],
+    :properties => {
+      :bookmark     => "http://foo.bar/baz/qux",
+      :published_at => "2012-11-16T05:20:18Z",
+      :name         => ["Foo Bar"],
+      :summary      => ["Baz Qux"],
+      :content      => ["<p>all of the html inside of it</p>"],
+      :categories => {
+        "Category" => "http://foo.bar/category"
+      },
+      :author => [{
+        :type => ["h-card"],
+        :properties => {
+          :name  => ["Foo Bar"],
+          :email => ["foo@bar.com"],
+          :url   => ["http://foo.bar"]
+        }
+      }]
+    }
+  }
+}
+```
 
 
 ## Current Version
 
-0.5.3
+0.6.0
 
 
 ## Requirements
@@ -52,12 +64,20 @@ gem install hentry_consumer
 
 ## Usage
 
+Write some HTML marked up as a microformats 2 h-entry
+* [An example](https://gist.github.com/4085498)
+* [Oh look another example](https://gist.github.com/88d6d476483e9528fb3a)
+
 ```ruby
 require "hentry_consumer"
-HentryConsumer.parse(File|URL)
+
+feed = HentryConsumer.parse("path/to/file") || HentryConsumer.parse("http://foo.bar")
+
+feed.entries.each do |entry|
+  puts entry.name.first
+  puts entry.author.first.name
+end
 ```
-[Example Gist of HTML with h-entry posts](https://raw.github.com/gist/3835447/7128a66a3ac7e971a82daac5fa2076d17b88e435/gistfile1.html)
-[Another Example Gist of HTML with h-entry posts](https://gist.github.com/88d6d476483e9528fb3a)
 
 ## Authors
 
@@ -86,6 +106,8 @@ guard
 ### Releases
 
 ```bash
+vi lib/hentry_consumer/version.rb # change version
+vi README.md # change version
 rake release
 ```
 

data/hentry_consumer.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = HentryConsumer::VERSION
   gem.authors       = ["Bookis Smuin", "Jessica Lynn Suttles"]
   gem.email         = ["vegan.bookis@gmail.com", "jlsuttles@gmail.com"]
-  gem.description   = %q{A hATOM feed parser}
-  gem.summary       = %q{Takes in HTML containing an h-feed classed element and returns serialized data based on the Microformat 2 hEntry specs}
+  gem.description   = %q{A microformats 2 h-entry parser}
+  gem.summary       = %q{Parses HTML containing one or more h-entry elements and returns serialized data based on the microformat 2 spec}
   gem.homepage      = "https://github.com/G5/hentry_consumer"
 
   gem.files         = `git ls-files`.split($/)

data/lib/hentry_consumer/format_rules.rb

@@ -1,7 +1,7 @@
 module HentryConsumer
   class FormatRules
     REQUIRED = []
-    UNIQUE   = [:uid, :bookmark]
+    UNIQUE   = [:uid, :bookmark, :url, :urn]
 
     class << self
       def required?(format)

data/lib/hentry_consumer/version.rb

@@ -1,3 +1,3 @@
 module HentryConsumer
-  VERSION = "0.5.3"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hentry_consumer
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-16 00:00:00.000000000 Z
+date: 2012-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -108,7 +108,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.2.1
-description: A hATOM feed parser
+description: A microformats 2 h-entry parser
 email:
 - vegan.bookis@gmail.com
 - jlsuttles@gmail.com
@@ -150,25 +150,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3466350580781628104
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3466350580781628104
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Takes in HTML containing an h-feed classed element and returns serialized
-  data based on the Microformat 2 hEntry specs
+summary: Parses HTML containing one or more h-entry elements and returns serialized
+  data based on the microformat 2 spec
 test_files:
 - spec/lib/hentry_consumer/format_rules_spec.rb
 - spec/lib/hentry_consumer/h_card_spec.rb