kog 0.3.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 John Wyles
+
+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.rdoc

@@ -0,0 +1,44 @@
+= Kestrel Open Graph (kog)
+
+This is a Ruby implementation of the OpenGraph protocol outlined by Facebook in {The Open Graph Protocol}[http://opengraphprotocol.org].  More information can be found here: {kog: A Ruby implementation of The Open Graph Protocol by Facebook}[http://johnwyles.com/2010/05/04/kog-a-ruby-implementation-of-the-open-graph-protocol-by-facebook/].
+
+== Install
+
+    sudo gem install kog
+
+== Usage
+
+    require 'rubygems'
+    require 'kog'
+
+    # Parse a resource and getting the resource
+    obj = OpenGraph::Parser.parse('http://www.rottentomatoes.com/m/office_space/')
+    puts obj.class # => OpenGraph::Object
+
+    # The object
+    puts obj.inspect # => #<OpenGraph::Object:0x101b01060 @image="http://images.rottentomatoes.com/images/movie/custom/aa/1087856aa.jpg", @title="Office Space", @url="http://www.rottentomatoes.com/m/office_space/", @site_name="Rotten Tomatoes", @type="movie">
+
+    # Accessors
+    puts obj.type # => movie
+    puts obj.type?('movie').inspect # => true
+    puts obj.type?('dog').inspect # => false
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Credits
+
+* John Wyles: Author
+* Michael Bleigh: This project was loosely based off of Michael's original Ruby implementation
+
+== Copyright
+
+Copyright (c) 2010 John Wyles. See LICENSE for details.
+

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "kog"
+    gem.summary = %Q{A Ruby implementation of The Open Graph Protocol by Facebook}
+    gem.description = %Q{A Ruby implementation of The Open Graph Protocol by Facebook}
+    gem.email = "john@johnwyles.com"
+    gem.homepage = "http://github.com/johnwyles/kog"
+    gem.authors = ["John Wyles"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "cucumber", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "kog #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

@@ -0,0 +1,5 @@
+---
+:minor: 3 
+:patch: 1
+:major: 0 
+:build: 

data/features/kog.feature

@@ -0,0 +1,13 @@
+Feature:
+  kog should allow me
+  As a person
+  To parse resources for their meanings
+
+  Scenario Outline: Parse
+    Given that I have the URL <url>
+    When I parse it for <field>
+    Then I expect to <result>
+    Examples:
+      |                 url              |  field  |   result   |
+      | http://example.com/good/data/123 | "type"  | see "band" |
+      | http://example.com/good/data/123 | "title" | see "Foo"  |

data/features/step_definitions/kog_steps.rb

@@ -0,0 +1,15 @@
+Given /^that I have the URL (.*)$/ do |url|
+  @url = url
+  good_data = File.open(File.dirname(__FILE__) + '/../../spec/kog/xhtml/good_data.xhtml').read
+  FakeWeb.register_uri(:get, @url, :body => good_data)
+end
+
+When /^I parse it for "([^\"]*)"$/ do |field|
+  @field = field
+  @body = OpenGraph::Parser.parse(@url)
+  @body.should_not be_nil
+end
+
+Then /^I expect to see "([^\"]*)"$/ do |result|
+  @body.send("#{@field}").should == result
+end

data/features/support/env.rb

@@ -0,0 +1,12 @@
+# Cucumber
+require 'cucumber/formatter/unicode'
+$KCODE = 'u' unless Cucumber::RUBY_1_9
+
+# Fakeweb
+require 'fakeweb'
+
+# rSpec
+require File.expand_path(File.dirname(__FILE__) + "/../../spec/spec_helper")
+
+# Kestrel_OpenGraph
+require 'kog'

data/kog.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{kog}
+  s.version = "0.3.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Wyles"]
+  s.date = %q{2010-05-04}
+  s.description = %q{A Ruby implementation of The Open Graph Protocol by Facebook}
+  s.email = %q{john@johnwyles.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "features/kog.feature",
+     "features/step_definitions/kog_steps.rb",
+     "features/support/env.rb",
+     "kog.gemspec",
+     "lib/kog.rb",
+     "lib/kog/object.rb",
+     "lib/kog/parser.rb",
+     "spec/kog/object/object_spec.rb",
+     "spec/kog/opengraph_spec.rb",
+     "spec/kog/parser/parser_spec.rb",
+     "spec/kog/xhtml/bad_data.xhtml",
+     "spec/kog/xhtml/good_data.xhtml",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/johnwyles/kog}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A Ruby implementation of The Open Graph Protocol by Facebook}
+  s.test_files = [
+    "spec/kog/object/object_spec.rb",
+     "spec/kog/opengraph_spec.rb",
+     "spec/kog/parser/parser_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+  end
+end
+

data/lib/kog.rb

@@ -0,0 +1,8 @@
+require 'kog/parser'
+require 'kog/object'
+
+module OpenGraph
+  class << self
+    attr_accessor :nobody_here_but_us_wabbits
+  end
+end

data/lib/kog/object.rb

@@ -0,0 +1,38 @@
+module OpenGraph
+  class Object
+    # Define the types specified in the OpenGraph protocol
+    STANDARD_TYPES = {
+      'activity'     => %w(activity sport),
+      'business'     => %w(bar company cafe hotel restaurant),
+      'group'        => %w(cause sports_league sports_team),
+      'organization' => %w(band government non_profit school university),
+      'person'       => %w(actor athlete author director musician politician public_figure),
+      'place'        => %w(city country landmark state_province),
+      'product'      => %w(album book drink food game movie product song tv_show),
+      'website'      => %w(blog website)
+    }
+
+    # Create methods for each attribute (including the soon-to-be-deprecated "type" attribute)
+    def initialize(hash)
+      hash.each do |key, value|
+        unless (self.respond_to?(key) && key != 'type')
+          # Assign an instance variable to the value
+          instance_variable_set("@#{key}", value)
+
+          # Define accessors to the instance variable
+          object = class << self; self; end
+          object.send(:define_method, key) { hash[key] }
+          object.send(:define_method, "#{key}?") { |type| hash[key] == type }
+        end
+      end
+    end
+
+    # The schema this object belongs to
+    def schema
+      STANDARD_TYPES.each_pair do |schema, types|
+        return schema if types.include?(self.type)
+      end
+      return nil
+    end
+  end
+end

data/lib/kog/parser.rb

@@ -0,0 +1,37 @@
+require 'nokogiri'
+require 'httparty'
+
+module OpenGraph
+  module Parser
+    # Attributes that must be present according to the protocol
+    REQUIRED_ATTRIBUTES = ['image', 'title', 'type', 'url']
+
+    # Parse
+    def self.parse(url)
+      # Get the document
+      begin
+        body = HTTParty.get(url).body
+        doc = Nokogiri::HTML.parse(body)
+      rescue HTTParty::ResponseError, HTTParty::UnsupportedURIScheme, HTTParty::UnsupportedFormat,
+          URI::InvalidURIError, SocketError
+        return nil
+      end
+
+      # Initialize the temporary hash
+      type = Hash.new
+
+      # Parse the document and append to the temporary hash
+      doc.css('meta').each do |meta|
+        if !meta.attribute('property').nil? && meta.attribute('property').to_s.match(/^og:(.+)$/i)
+          type[$1.gsub('-','_')] = meta.attribute('content').to_s
+        end
+      end
+
+      # None of the required attributes were found
+      REQUIRED_ATTRIBUTES.each { |key| return nil if !type.has_key?(key) }
+
+      # Return the representative OpenGraph object
+      return OpenGraph::Object.new(type)
+    end
+  end
+end

data/spec/kog/object/object_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'spec_helper'))
+require 'kog'
+
+describe 'OpenGraph' do
+  describe 'Object' do
+    before(:each) do
+      hash = {
+        'title' => 'Foo',
+        'url' => 'http://example.com/foo/',
+        'type' => 'band',
+        'image' => 'http://example.com/foo/foo.jpg',
+        'foo' => 'bar'
+      }
+      @data = OpenGraph::Object.new(hash)
+    end
+
+    describe '.schema' do
+      it 'should give the full schema for the type' do
+        @data.schema.should == 'organization'
+      end
+    end
+
+    describe '.type' do
+      it 'should return the type specified for it' do
+        @data.type.should == 'band'
+      end
+    end
+
+    describe '.type?' do
+      it 'should return the type specified for it' do
+        @data.type?('band').should be_true
+        @data.type?('movie').should be_false
+      end
+    end
+
+    describe '.title' do
+      it 'should return the title specified for it' do
+        @data.title.should == 'Foo'
+      end
+    end
+
+    describe '.foo' do
+      it 'should return the foo specified for it' do
+        @data.foo.should == 'bar'
+      end
+    end
+  end
+end

data/spec/kog/opengraph_spec.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+require 'kog'
+
+describe 'OpenGraph' do
+  it 'should do nothing' do
+    OpenGraph.instance_variables.should be_empty
+  end
+end

data/spec/kog/parser/parser_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'spec_helper'))
+require 'kog'
+
+describe 'OpenGraph' do
+  describe 'Parser' do
+    before(:each) do
+      good_data = File.open(File.dirname(__FILE__) + '/../xhtml/good_data.xhtml').read
+      bad_data = File.open(File.dirname(__FILE__) + '/../xhtml/bad_data.xhtml').read
+      FakeWeb.register_uri(:get, 'http://example.com/good/data/123', :body => good_data)
+      FakeWeb.register_uri(:get, 'http://example.com/bad/data/123', :body => bad_data)
+    end
+
+    describe '.parse' do
+      it 'should return nil if the URL is invalid' do
+        OpenGraph::Parser.parse('bad://!#*@badurl.com/bad/data!/123').should be_nil
+      end
+
+      it 'should return nil if the required attributes are missing or invalid' do
+        OpenGraph::Parser.parse('http://example.com/bad/data/123').should be_nil
+      end
+
+      it 'should return an OpenGraph::Type instance if the required attributes are present and valid' do
+        OpenGraph::Parser.parse('http://example.com/good/data/123').should be_instance_of(OpenGraph::Object)
+      end
+
+      it 'should return a valid title if the attributes are present and valid' do
+        data = OpenGraph::Parser.parse('http://example.com/good/data/123')
+        data.title.should == 'Foo'
+      end
+    end
+  end
+end

data/spec/kog/xhtml/bad_data.xhtml

@@ -0,0 +1,21 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" xmlns:fb="http://www.facebook.com/2008/fbml" xmlns:og="http://opengraphprotocol.org/schema/" lang="en" id="website">
+<head>
+  <title>Foo</title>
+  <meta http-equiv="content-type" content="text/html; charset=iso-8859-1"> 
+  <meta name="title" content="Foo"> 
+  <meta name="description" content="Foo" />
+  <meta name="keywords" content="Foo, Bar, Example" />
+  <link href="http://example.com/foo/" rel="canonical">
+  <link rel="image_src" href="http://example.com/foo/foo.jpg" />
+  <link rel="stylesheet" type="text/css" media="screen" href="http://example.com/foo/foo.css" />
+  <link rel="icon" href="http://example.com/foo/favicon.ico" />
+  <link rel="apple-touch-icon" href="http://example.com/foo/foo.png" />
+  <meta property="og:image" content="http://example.com/foo/foo.jpg" />
+  <meta property="og:type" content="band" />
+</head>
+<body>
+  <h1>Foo</h1>
+</body>
+</html>
+

data/spec/kog/xhtml/good_data.xhtml

@@ -0,0 +1,22 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" xmlns:fb="http://www.facebook.com/2008/fbml" xmlns:og="http://opengraphprotocol.org/schema/" lang="en" id="website">
+<head>
+  <title>Foo</title>
+  <meta http-equiv="content-type" content="text/html; charset=iso-8859-1"> 
+  <meta name="title" content="Foo"> 
+  <meta name="description" content="Foo" />
+  <meta name="keywords" content="Foo, Bar, Example" />
+  <link href="http://example.com/foo/" rel="canonical">
+  <link rel="image_src" href="http://example.com/foo/foo.jpg" />
+  <link rel="stylesheet" type="text/css" media="screen" href="http://example.com/foo/foo.css" />
+  <link rel="icon" href="http://example.com/foo/favicon.ico" />
+  <link rel="apple-touch-icon" href="http://example.com/foo/foo.png" />
+  <meta property="og:image" content="http://example.com/foo/foo.jpg" />
+  <meta property="og:title" content="Foo" />
+  <meta property="og:type" content="band" />
+  <meta property="og:url" content="http://example.com/foo/" />
+</head>
+<body>
+  <h1>Foo</h1>
+</body>
+</html>

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib', 'kog'))
+
+require 'fakeweb'
+
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|  
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: kog
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 1
+  version: 0.3.1
+platform: ruby
+authors: 
+- John Wyles
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-04 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: A Ruby implementation of The Open Graph Protocol by Facebook
+email: john@johnwyles.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- features/kog.feature
+- features/step_definitions/kog_steps.rb
+- features/support/env.rb
+- kog.gemspec
+- lib/kog.rb
+- lib/kog/object.rb
+- lib/kog/parser.rb
+- spec/kog/object/object_spec.rb
+- spec/kog/opengraph_spec.rb
+- spec/kog/parser/parser_spec.rb
+- spec/kog/xhtml/bad_data.xhtml
+- spec/kog/xhtml/good_data.xhtml
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/johnwyles/kog
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A Ruby implementation of The Open Graph Protocol by Facebook
+test_files: 
+- spec/kog/object/object_spec.rb
+- spec/kog/opengraph_spec.rb
+- spec/kog/parser/parser_spec.rb
+- spec/spec_helper.rb