hentry_consumer 0.1.0

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+group :test, :development do
+  gem "rspec"
+  gem 'guard-rspec'
+  gem 'rb-fsevent', '~> 0.9.1'
+end
+
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 G5
+
+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,112 @@
+# HentryConsumer
+
+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
+            - HCard
+        - categories
+            - {}
+    - HEntry
+        - ...
+  
+[Microformats H-Entry](http://microformats.org/wiki/microformats-2#h-entry)
+
+
+## Current Version
+
+0.1.0
+
+
+## Requirements
+
+* [Nokogiri](http://nokogiri.org)
+
+
+
+## Installation
+
+### Gemfile
+
+Add this line to your application's Gemfile.
+
+```ruby
+gem 'hentry_consumer'
+```
+
+### Manual
+
+Or install it yourself.
+
+```bash
+gem install hentry_consumer
+```
+
+
+## Usage
+
+```ruby
+HentryConsumer.parse(File|URL)
+```
+[Example Gist](https://raw.github.com/gist/84b2c0b0ea991cc12dfb/84c735583bb90d345a8ede203a3df3d6cb486e10/g5-hub-feed.html)
+
+## Authors
+
+* Bookis Smuin / [@bookis](https://github.com/bookis)
+
+## Contributions
+
+1. Fork it
+2. Get it running (see Installation above)
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Write your code and **specs**
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request
+
+If you find bugs, have feature requests or questions, please
+[file an issue](https://github.com/G5/picture_tag-rails/issues).
+
+### Specs
+
+```bash
+rake spec
+```
+
+### Releases
+
+```bash
+TODO how do you do a release?
+```
+
+
+## License
+
+Copyright (c) 2012 G5
+
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/hentry_consumer.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hentry_consumer/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "hentry_consumer"
+  gem.version       = HentryConsumer::VERSION
+  gem.authors       = ["Bookis Smuin"]
+  gem.email         = ["vegan.bookis@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.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_dependency 'nokogiri'
+  
+end

data/lib/hentry_consumer.rb

@@ -0,0 +1,11 @@
+require 'nokogiri'
+require 'open-uri'
+
+Gem.find_files("hentry_consumer/**/*.rb").each { |path| require path }
+
+module HentryConsumer
+  FormatClass = %w(p n e i u dt)
+  def self.parse(html)
+    HFeed.new(html)
+  end
+end

data/lib/hentry_consumer/element.rb

@@ -0,0 +1,23 @@
+module HentryConsumer
+  class Element
+    def initialize(microformat)
+      parse_elements(microformat)
+    end
+    
+    def parse_elements(microformat)
+      FormatClass.each do |letter|
+        microformat.css(">*[class*=#{letter}-]").each do |a|
+          self[symbolize_class(a["class"])] = a.text.gsub('\n', " ").strip
+        end
+      end
+    end
+
+    def symbolize_class(klass)
+      klass.to_s.downcase.split.first.gsub(/\w{1,2}-/, "").to_sym
+    end
+
+    def []=(key, value)
+      self.send(key.to_s + "=", value) if self.respond_to?(key.to_s + "=")
+    end
+  end
+end

data/lib/hentry_consumer/h_card.rb

@@ -0,0 +1,5 @@
+module HentryConsumer
+  class HCard < Element
+    attr_accessor :name, :email, :url
+  end
+end

data/lib/hentry_consumer/h_entry.rb

@@ -0,0 +1,45 @@
+module HentryConsumer
+  class HEntry < Element
+
+    attr_accessor :name, :categories, :author, :content, :bookmark, :published_at, :summary
+
+    # Certainly there is a better way to do this.
+    def initialize(microformat)
+      @categories = {}
+      super
+    end
+
+    def parse_elements(microformat)
+      FormatClass.each do |letter|
+        microformat.css(">*[class*=#{letter}-]").each do |attrs|
+          attrs["class"].split.each do |klass|
+            parse_element(attrs, klass)
+          end
+        end
+      end
+    end
+
+    private
+
+    def parse_element(microformat, klass)
+      case klass
+      when 'h-card'
+        self.author = HCard.new(microformat)
+      when 'p-category'
+        self.categories[microformat.text.gsub('\n', " ").strip] = microformat["href"]
+      when 'e-content'
+        self.content = parse_content(microformat)
+      when'dt-published'
+        self.published_at = microformat["datetime"]
+      when "u-uid"
+        self.bookmark = microformat["href"]
+      else
+        self[symbolize_class(klass)] = microformat.text.gsub('\n', " ").strip
+      end
+    end
+
+    def parse_content(microformat)
+      microformat.inner_html
+    end
+  end
+end

data/lib/hentry_consumer/h_feed.rb

@@ -0,0 +1,18 @@
+module HentryConsumer
+  class HFeed
+    attr_accessor :entries
+    def initialize(html)
+      @entries = []
+      parse_html(html)
+    end
+    
+    def parse_html(html)
+      doc = Nokogiri::HTML(open html)
+      doc.css(".h-entry").each do |mf_entry|
+        entry = HEntry.new(mf_entry)
+        self.entries << entry
+      end
+    end
+    
+  end
+end

data/lib/hentry_consumer/version.rb

@@ -0,0 +1,3 @@
+module HentryConsumer
+  VERSION = "0.1.0"
+end

data/spec/lib/hentry_consumer/h_card_spec.rb

@@ -0,0 +1,12 @@
+require 'hentry_consumer'
+
+describe HentryConsumer::HEntry do
+  let(:result) { HentryConsumer.parse(File.open("spec/support/example.html")) }
+  let(:entry) { result.entries.first }
+  subject { entry.author }
+  
+  its(:name)  { should eq "Jessica Suttles"}
+  its(:email) { should eq "jessica.suttles@getg5.com"}
+  its(:url)   { should eq "http//g5.com/authors/jessica-suttles"}
+  
+end

data/spec/lib/hentry_consumer/h_entry_spec.rb

@@ -0,0 +1,58 @@
+require 'hentry_consumer'
+
+describe HentryConsumer::HEntry do
+  let(:result) { HentryConsumer.parse(File.open("spec/support/example.html")) }
+  let(:entry) { result.entries.first }
+
+  it "should have an array of entries" do
+    entry.should be_an_instance_of HentryConsumer::HEntry
+  end
+
+  it "has a name" do
+    entry.name.should eq "Senior Cat Living"
+  end
+
+  it "has a summary" do
+    entry.summary.should eq "Signed up with 3 locations"
+  end
+
+  it "has a time" do
+    entry.published_at.should eq "2012-08-26 20:09-0700"
+  end
+
+  it "has a bookmark" do
+    entry.bookmark.should eq "http://g5.com/feed/entries/2012-08-26-20-09-0700"
+  end
+
+  it "has an author as an hcard" do
+    entry.author.should be_an_instance_of HentryConsumer::HCard
+  end
+
+  describe "categories" do
+    it "has an array of categories" do
+      entry.categories.should be_an_instance_of Hash
+    end
+
+    it "has a key of the content" do
+      entry.categories["New Customer"].should eq "http://g5.com/tag/new-customer"
+    end
+  end
+
+  describe "content" do
+    let(:content) { entry.content }
+
+    it "should be a blob of html" do
+      content.should match /Locations/
+    end
+
+    it "should be a blob of html" do
+      content.should match /\<dt\>/
+    end
+
+    it "should be a blob of html" do
+      content.should_not match /time/
+    end
+
+  end
+
+end

data/spec/lib/hentry_consumer/h_feed_spec.rb

@@ -0,0 +1,5 @@
+require 'hentry_consumer'
+
+describe HentryConsumer::HFeed do
+  
+end

data/spec/lib/hentry_consumer_spec.rb

@@ -0,0 +1,19 @@
+require 'hentry_consumer'
+
+describe HentryConsumer do
+  
+  it { should respond_to :parse }
+  
+  describe "parsing a file" do
+    let(:result) { HentryConsumer.parse(File.open("spec/support/example.html")) }
+    
+    it "should be a HentryConsumer object" do
+      result.should be_an_instance_of HentryConsumer::HFeed
+    end
+    
+    it "should have 2 enties" do
+      result.entries.size.should eq 2
+    end
+    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rubygems'
+require 'hentry_consumer'

data/spec/support/example.html

@@ -0,0 +1,157 @@
+<section class="">
+  <article class="h-entry">
+    <h1 class="p-name">Senior Cat Living</h1>
+    <p class="woot p-summary woot">Signed up with 3 locations</p>
+    <p class="p-five">Signed up with 3 locations</p>
+    <time datetime="2012-08-26 20:09-0700" class="dt-published">
+      8:09pm on August 26th, 2012
+    </time>
+    <a class="p-category" href="http://g5.com/tag/new-customer" rel="tag">
+      New Customer
+    </a>
+    <a class="u-url u-uid" href="http://g5.com/feed/entries/2012-08-26-20-09-0700">
+      http://g5.com/feed/entries/2012-08-26-20-09-0700
+    </a>
+    <div class="p-author h-card">
+      <p class="p-name">Jessica Suttles</p>
+      <a class="u-email" href="mailto:jessica.suttles@getg5.com">
+        jessica.suttles@getg5.com
+      </a>
+      <a class="u-url u-uid" href="http//g5.com/authors/jessica-suttles">
+        http//g5.com/authors/jessica-suttles
+      </a>
+    </div>
+    <dl class="e-content">
+      <dt>Customer</dt> 
+      <dd class="h-card">
+        <p class="p-name">Senior Cat Living</p>
+        <a class="u-url u-uid" href="http//g5.com/customers/senior-cat-living">
+          http//g5.com/customers/senior-cat-living
+        </a>
+      </dd>
+      <dt>Corporate</dt>
+      <dd class="h-card">
+        <p class="p-name">Senior Cat Living Corporate</p>
+        <a class="u-url u-uid" href="http//g5.com/customers/senior-cat-living/corporate">
+          http//g5.com/customers/senior-cat-living/corporate
+        </a>
+      </dd>
+      <dt>Locations</dt>
+      <dd class="h-card">
+        <p class="p-name">Senior Cat Living Location 1</p>
+        <a class="u-url u-uid" href="http//g5.com/customers/senior-cat-living/locations/1">
+          http//g5.com/customers/senior-cat-living/locations/1
+        </a>
+      </dd>
+      <dd class="h-card">
+        <p class="p-name">Senior Cat Living Location 2</p>
+        <a class="u-url u-uid" href="http//g5.com/customers/senior-cat-living/locations/2">
+          http//g5.com/customers/senior-cat-living/locations/2
+        </a>
+      </dd>
+      <dd class="h-card">
+        <p class="p-name">Senior Cat Living Location 3</p>
+        <a class="u-url u-uid" href="http//g5.com/customers/senior-cat-living/locations/3">
+          http//g5.com/customers/senior-cat-living/locations/3
+        </a>
+      </dd>
+      <dt>Features</dt>
+      <dd class="h-product">
+        <p class="p-name">Content</p>
+        <a class="u-url u-uid" href="http//g5.com/features/content">
+          http//g5.com/feature/content
+        </a>
+      </dd>
+      <dd class="h-product">
+        <p class="p-name">Insight</p>
+        <a class="u-url u-uid" href="http//g5.com/features/insight">
+          http//g5.com/feature/insight
+        </a>
+      </dd>
+      <dd class="h-product">
+        <p class="p-name">Support</p>
+        <a class="u-url u-uid" href="http//g5.com/features/support">
+          http//g5.com/feature/support
+        </a>
+      </dd>
+    </dl>
+  </article>
+  <article class="h-entry">
+    <h1 class="p-name">Senior Cat Living</h1>
+    <p class="woot p-summary woot">Signed up with 3 locations</p>
+    <p class="p-five">Signed up with 3 locations</p>
+    <time datetime="2012-08-26 20:09-0700" class="dt-published">
+      8:09pm on August 26th, 2012
+    </time>
+    <a class="p-category" href="http://g5.com/tag/new-customer" rel="tag">
+      New Customer
+    </a>
+    <a class="u-url u-uid" href="http://g5.com/feed/entries/2012-08-26-20-09-0700">
+      http://g5.com/feed/entries/2012-08-26-20-09-0700
+    </a>
+    <div class="p-author h-card">
+      <p class="p-name">Jessica Suttles</p>
+      <a class="u-email" href="mailto:jessica.suttles@getg5.com">
+        jessica.suttles@getg5.com
+      </a>
+      <a class="u-url u-uid" href="http//g5.com/authors/jessica-suttles">
+        http//g5.com/authors/jessica-suttles
+      </a>
+    </div>
+    <dl class="e-content">
+      <dt>Customer</dt> 
+      <dd class="h-card">
+        <p class="p-name">Senior Cat Living</p>
+        <a class="u-url u-uid" href="http//g5.com/customers/senior-cat-living">
+          http//g5.com/customers/senior-cat-living
+        </a>
+      </dd>
+      <dt>Corporate</dt>
+      <dd class="h-card">
+        <p class="p-name">Senior Cat Living Corporate</p>
+        <a class="u-url u-uid" href="http//g5.com/customers/senior-cat-living/corporate">
+          http//g5.com/customers/senior-cat-living/corporate
+        </a>
+      </dd>
+      <dt>Locations</dt>
+      <dd class="h-card">
+        <p class="p-name">Senior Cat Living Location 1</p>
+        <a class="u-url u-uid" href="http//g5.com/customers/senior-cat-living/locations/1">
+          http//g5.com/customers/senior-cat-living/locations/1
+        </a>
+      </dd>
+      <dd class="h-card">
+        <p class="p-name">Senior Cat Living Location 2</p>
+        <a class="u-url u-uid" href="http//g5.com/customers/senior-cat-living/locations/2">
+          http//g5.com/customers/senior-cat-living/locations/2
+        </a>
+      </dd>
+      <dd class="h-card">
+        <p class="h-five p-name">Senior Cat Living Location 3</p>
+        <a class="u-url u-uid" href="http//g5.com/customers/senior-cat-living/locations/3">
+          http//g5.com/customers/senior-cat-living/locations/3
+        </a>
+      </dd>
+      <dt>Features</dt>
+      <dd class="h-product">
+        <p class="p-name">Content</p>
+        <a class="u-url u-uid" href="http//g5.com/features/content">
+          http//g5.com/feature/content
+        </a>
+      </dd>
+      <dd class="h-product">
+        <p class="p-name">Insight</p>
+        <a class="u-url u-uid" href="http//g5.com/features/insight">
+          http//g5.com/feature/insight
+        </a>
+      </dd>
+      <dd class="h-product">
+        <p class="p-name">Support</p>
+        <a class="u-url u-uid" href="http//g5.com/features/support">
+          http//g5.com/feature/support
+        </a>
+      </dd>
+    </dl>
+  </article>
+  
+</section>

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: hentry_consumer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Bookis Smuin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-04 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'
+description: A hATOM feed parser
+email:
+- vegan.bookis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hentry_consumer.gemspec
+- lib/hentry_consumer.rb
+- lib/hentry_consumer/element.rb
+- lib/hentry_consumer/h_card.rb
+- lib/hentry_consumer/h_entry.rb
+- lib/hentry_consumer/h_feed.rb
+- lib/hentry_consumer/version.rb
+- spec/lib/hentry_consumer/h_card_spec.rb
+- spec/lib/hentry_consumer/h_entry_spec.rb
+- spec/lib/hentry_consumer/h_feed_spec.rb
+- spec/lib/hentry_consumer_spec.rb
+- spec/spec_helper.rb
+- spec/support/example.html
+homepage: ''
+licenses: []
+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.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
+test_files:
+- spec/lib/hentry_consumer/h_card_spec.rb
+- spec/lib/hentry_consumer/h_entry_spec.rb
+- spec/lib/hentry_consumer/h_feed_spec.rb
+- spec/lib/hentry_consumer_spec.rb
+- spec/spec_helper.rb
+- spec/support/example.html