webmention 0.0.1 → 0.1.0

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/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+notifications:
+  email: false

data/Gemfile

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

data/README.md

@@ -0,0 +1,67 @@
+Webmention Client
+=================
+
+A Ruby gem for sending [webmention](http://indiewebcamp.com/webmention) (and [pingback](http://indiewebcamp.com/pingback)) notifications.
+
+[![Build Status](https://travis-ci.org/icco/mention-client-ruby.png?branch=master)](https://travis-ci.org/icco/mention-client-ruby)
+
+Installation
+------------
+
+    gem install webmention
+
+
+Usage
+-----
+
+### Send webmentions to all links on a page
+
+```ruby
+client = Webmention::Client.new url
+sent = client.send_mentions
+
+puts "Sent #{sent} mentions"
+```
+
+This will find all absolute links on the page at `url` and will attempt to send
+mentions to each. This is accomplished by doing a HEAD request and looking at the headers
+for supported servers, if none are found, then it searches the body of the page.
+
+After finding either webmention or pingback endpoints, the request is sent to each.
+
+### Send webmention to a specific URL
+
+```ruby
+# Discover the webmention endpoint of a target and send the mention
+
+source = "http://source.example.com/post/100"   # For example, your page
+target = "http://indiewebcamp.com/"             # The page you linked to
+
+if endpoint = Webmention::Client.supports_webmention?(target)
+  Webmention::Client.send_mention endpoint, source, target
+end
+```
+
+
+Webmention
+----------
+
+To learn more about Webmention, see [webmention.org](http://webmention.org).
+
+
+License
+-------
+
+Copyright 2013 by Aaron Parecki
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+ 
+Rake::TestTask.new do |t|
+  t.libs << 'lib/webmention'
+  t.test_files = FileList['test/lib/webmention/*_test.rb']
+  t.verbose = true
+end
+ 
+task :default => :test

data/example.rb

@@ -0,0 +1,20 @@
+require './lib/webmention.rb'
+
+# Send webmentions to any links on the page that have a webmention endpoint
+url = 'http://aaronparecki.com/notes/2013/06/23/1/indiewebcamp'
+client = Webmention::Client.new url
+sent = client.send_mentions
+puts "Sent #{sent} mentions"
+
+
+# Discover the webmention endpoint of a target and send the mention
+target = "http://indiewebcamp.com/"
+endpoint = Webmention::Client.supports_webmention? target
+if endpoint 
+  Webmention::Client.send_mention endpoint, "http://source.example.com/post/100", target
+end
+
+
+# You can also use the client to send to a specific webmention endpoint
+Webmention::Client.send_mention "http://webmention.io/example/webmention", "http://source.example.com/post/100", "http://target.example.com/post/100"
+

data/lib/webmention.rb

@@ -1,2 +1,9 @@
 require 'json'
+require 'net/http'
+require 'nokogiri'
+require 'open-uri'
+require 'set'
+require 'uri'
+
+require 'webmention/version'
 require 'webmention/client'

data/lib/webmention/client.rb

@@ -0,0 +1,170 @@
+module Webmention
+  class Client
+    # Public: Returns a URI of the url initialized with.
+    attr_reader :url
+
+    # Public: Returns an array of links contained within the url.
+    attr_reader :links
+
+    # Public: Create a new client
+    #
+    # url - The url you want us to crawl.
+    def initialize(url)
+      @url = URI.parse(url)
+      @links ||= Set.new
+
+      unless Webmention::Client.valid_http_url? @url
+        raise ArgumentError.new "#{@url} is not a valid HTTP or HTTPS URI."
+      end
+    end
+
+    # Public: Crawl the url this client was initialized with.
+    #
+    # Returns the number of links found.
+    def crawl
+      @links ||= Set.new
+      if @url.nil?
+        raise ArgumentError.new "url is nil."
+      end
+
+      Nokogiri::HTML(open(self.url)).css('a').each do |link|
+        link = link.attribute('href').to_s
+        if Webmention::Client.valid_http_url? link
+          @links.add link
+        end
+      end
+
+      return @links.count
+    end
+
+    # Public: Sends mentions to each of the links found in the page.
+    #
+    # Returns the number of links mentioned.
+    def send_mentions
+      if self.links.nil? or self.links.empty?
+        self.crawl
+      end
+
+      cnt = 0
+      self.links.each do |link|
+        endpoint = Webmention::Client.supports_webmention? link
+        if endpoint
+          cnt += 1 if Webmention::Client.send_mention endpoint, self.url, link
+        end
+      end
+
+      return cnt
+    end
+
+    # Public: Send a mention to an endoint about a link from a link.
+    #
+    # endpoint - URL to send mention to.
+    # source - Source of mention (your page).
+    # target - The link that was mentioned in the source page.
+    #
+    # Returns a boolean.
+    def self.send_mention endpoint, source, target
+      data = {
+        :source => source,
+        :target => target,
+      }
+
+      uri = URI.parse(endpoint)
+      http = Net::HTTP.new(uri.host, uri.port)
+
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.set_form_data(data)
+      request['Content-Type'] = "application/x-www-form-urlencoded"
+      request['Accept'] = 'application/json'
+      response = http.request(request)
+
+      return response.code.to_i == 200
+    end
+
+    # Public: Fetch a url and check if it supports webmention
+    #
+    # url - URL to check
+    #
+    # Returns false if does not support webmention, returns string
+    # of url to ping if it does.
+    def self.supports_webmention? url
+      return false if !Webmention::Client.valid_http_url? url
+
+      doc = nil
+
+      begin
+        uri = URI.parse(url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.open_timeout = 3 # in seconds
+        http.read_timeout = 3 # in seconds
+
+        request = Net::HTTP::Get.new(uri.request_uri)
+        # Send a user agent like a browser because some sites seem to reject requests made by non-browsers
+        request["User-Agent"] = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/29.0.1547.57 Safari/537.36 (https://rubygems.org/gems/webmention)"
+        request["Accept"] = "*/*"
+
+        response = http.request(request)
+
+        # First check the HTTP Headers
+        if !response['Link'].nil? 
+          endpoint = self.discover_webmention_endpoint_from_header response['Link']
+          return endpoint if endpoint
+        end
+
+        # Do we support webmention?
+        endpoint = self.discover_webmention_endpoint_from_html response.body.to_s
+        return endpoint if endpoint
+
+        # TODO: Move to supports_pingback? method
+        # Last chance, do we support Pingback?
+        # if !doc.css('link[rel="pingback"]').empty?
+        #   return doc.css('link[rel="pingback"]').attribute("href").value
+        # end
+
+      rescue EOFError
+      rescue Errno::ECONNRESET
+      end
+
+      return false
+    end
+
+    def self.discover_webmention_endpoint_from_html html
+      doc = Nokogiri::HTML(html)
+      if !doc.css('link[rel="webmention"]').empty?
+        doc.css('link[rel="webmention"]').attribute("href").value
+      elsif !doc.css('link[rel="http://webmention.org/"]').empty?
+        doc.css('link[rel="http://webmention.org/"]').attribute("href").value
+      elsif !doc.css('link[rel="http://webmention.org"]').empty?
+        doc.css('link[rel="http://webmention.org"]').attribute("href").value
+      else
+        false
+      end
+    end
+
+    def self.discover_webmention_endpoint_from_header header
+      if matches = header.match(%r{<(https?://[^>]+)>; rel="webmention"})
+        return matches[1]
+      elsif matches = header.match(%r{rel="webmention"; <(https?://[^>]+)>})
+        return matches[1]
+      elsif matches = header.match(%r{<(https?://[^>]+)>; rel="http://webmention\.org/?"})
+        return matches[1]
+      elsif matches = header.match(%r{rel="http://webmention\.org/?"; <(https?://[^>]+)>})
+        return matches[1]
+      end
+      return false
+    end
+
+    # Public: Use URI to parse a url and check if it is HTTP or HTTPS.
+    #
+    # url - URL to check
+    #
+    # Returns a boolean.
+    def self.valid_http_url? url
+      if url.is_a? String
+        url = URI.parse(url)
+      end
+
+      return (url.is_a? URI::HTTP or url.is_a? URI::HTTPS)
+    end
+  end
+end

data/lib/webmention/version.rb

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

data/test/data/sample_html.rb

@@ -0,0 +1,77 @@
+class SampleData
+
+  def self.rel_webmention_href
+    <<-eos
+      <html>
+        <head>
+          <link rel="webmention" href="http://webmention.io/example/webmention">
+        </head>
+      </html>
+    eos
+  end
+
+  def self.rel_href_webmention
+    <<-eos
+      <html>
+        <head>
+          <link href="http://webmention.io/example/webmention" rel="webmention">
+        </head>
+      </html>
+    eos
+  end
+
+  def self.rel_webmention_org_href
+    <<-eos
+      <html>
+        <head>
+          <link rel="http://webmention.org" href="http://webmention.io/example/webmention">
+        </head>
+      </html>
+    eos
+  end
+
+  def self.rel_href_webmention_org
+    <<-eos
+      <html>
+        <head>
+          <link href="http://webmention.io/example/webmention" rel="http://webmention.org">
+        </head>
+      </html>
+    eos
+  end
+
+  def self.rel_webmention_org_slash_href
+    <<-eos
+      <html>
+        <head>
+          <link rel="http://webmention.org/" href="http://webmention.io/example/webmention">
+        </head>
+      </html>
+    eos
+  end
+
+  def self.rel_href_webmention_org_slash
+    <<-eos
+      <html>
+        <head>
+          <link href="http://webmention.io/example/webmention" rel="http://webmention.org/">
+        </head>
+      </html>
+    eos
+  end
+
+  def self.sample_source_post_html
+    <<-eos
+      <html>
+        <head>
+          <title>Sample Post</title>
+        </head>
+        <body>
+          <p><a href="http://target.example.com/post/4">Link to Target 4</a></p>
+          <p><a href="http://target.example.com/post/5">Link to Target 5</a></p>
+        </body>
+      </html>
+    eos
+  end
+
+end

data/test/lib/webmention/crawl_test.rb

@@ -0,0 +1,23 @@
+require_relative '../../test_helper'
+
+describe Webmention::Client do
+  before do
+    WebMock.stub_request(:any, 'http://source.example.com/post/100').to_return(
+      :status => 200,
+      :body => SampleData.sample_source_post_html,
+      :headers => {}
+    )
+
+    @client = Webmention::Client.new "http://source.example.com/post/100"
+  end
+
+  describe "#crawl" do
+    describe "when a valid url" do
+      it "should return a count and list of links" do
+        @client.crawl.must_be :>, 0
+        @client.links.must_include 'http://target.example.com/post/4'
+        @client.links.must_include 'http://target.example.com/post/5'
+      end
+    end
+  end
+end

data/test/lib/webmention/discovery_test.rb

@@ -0,0 +1,88 @@
+require_relative '../../test_helper'
+
+describe Webmention::Client do
+  before do
+    WebMock.stub_request(:any, 'http://example.com/header').to_return(
+      :status => 200,
+      :body => '<html>example</html>', 
+      :headers => {
+        'Link' => 'rel="webmention"; <http://webmention.io/example/webmention>'
+      }
+    )
+
+    WebMock.stub_request(:any, 'http://example.com/html').to_return(
+      :status => 200,
+      :body => '<html><head><link rel="webmention" href="http://webmention.io/example/webmention"></head><body>example</body></html>'
+    )
+
+    WebMock.stub_request(:any, 'http://example.com/none').to_return(
+      :status => 200,
+      :body => '<html><head></head><body>example</body></html>'
+    )
+  end
+
+  describe "#discover_webmention_endpoint_from_url" do
+    it "should find endpoint from html head" do
+      Webmention::Client.supports_webmention?("http://example.com/html").must_equal "http://webmention.io/example/webmention"
+    end
+
+    it "should find endpoint from http header" do
+      Webmention::Client.supports_webmention?("http://example.com/header").must_equal "http://webmention.io/example/webmention"
+    end
+
+    it "should return false when no endpoint found" do
+      Webmention::Client.supports_webmention?("http://example.com/none").must_equal false
+    end
+  end
+
+  describe "#discover_webmention_endpoint_from_string" do
+    it "should find rel=webmention followed by href in header" do
+      Webmention::Client.discover_webmention_endpoint_from_header('rel="webmention"; <http://webmention.io/example/webmention>').must_equal "http://webmention.io/example/webmention"
+    end
+
+    it "should find href followed by rel=webmention in header" do
+      Webmention::Client.discover_webmention_endpoint_from_header('<http://webmention.io/example/webmention>; rel="webmention"').must_equal "http://webmention.io/example/webmention"
+    end
+
+    it "should find rel=http://webmention.org followed by href in header" do
+      Webmention::Client.discover_webmention_endpoint_from_header('rel="http://webmention.org"; <http://webmention.io/example/webmention>').must_equal "http://webmention.io/example/webmention"
+    end
+
+    it "should find href followed by rel=http://webmention.org in header" do
+      Webmention::Client.discover_webmention_endpoint_from_header('<http://webmention.io/example/webmention>; rel="http://webmention.org"').must_equal "http://webmention.io/example/webmention"
+    end
+
+    it "should find rel=http://webmention.org/ followed by href in header" do
+      Webmention::Client.discover_webmention_endpoint_from_header('rel="http://webmention.org/"; <http://webmention.io/example/webmention>').must_equal "http://webmention.io/example/webmention"
+    end
+
+    it "should find href followed by rel=http://webmention.org/ in header" do
+      Webmention::Client.discover_webmention_endpoint_from_header('<http://webmention.io/example/webmention>; rel="http://webmention.org"').must_equal "http://webmention.io/example/webmention"
+    end
+
+    it "should find rel=webmention followed by href in html" do
+      Webmention::Client.discover_webmention_endpoint_from_html(SampleData.rel_webmention_href).must_equal "http://webmention.io/example/webmention"
+    end
+
+    it "should find href followed by rel=webmention in html" do
+      Webmention::Client.discover_webmention_endpoint_from_html(SampleData.rel_href_webmention).must_equal "http://webmention.io/example/webmention"
+    end
+
+    it "should find rel=http://webmention.org followed by href in html" do
+      Webmention::Client.discover_webmention_endpoint_from_html(SampleData.rel_webmention_org_href).must_equal "http://webmention.io/example/webmention"
+    end
+
+    it "should find href followed by rel=http://webmention.org in html" do
+      Webmention::Client.discover_webmention_endpoint_from_html(SampleData.rel_href_webmention_org).must_equal "http://webmention.io/example/webmention"
+    end
+
+    it "should find rel=http://webmention.org/ followed by href in html" do
+      Webmention::Client.discover_webmention_endpoint_from_html(SampleData.rel_webmention_org_slash_href).must_equal "http://webmention.io/example/webmention"
+    end
+
+    it "should find href followed by rel=http://webmention.org/ in html" do
+      Webmention::Client.discover_webmention_endpoint_from_html(SampleData.rel_href_webmention_org_slash).must_equal "http://webmention.io/example/webmention"
+    end
+  end
+
+end

data/test/lib/webmention/mention_test.rb

@@ -0,0 +1,38 @@
+require_relative '../../test_helper'
+
+describe Webmention::Client do
+  before do
+    WebMock.stub_request(:any, 'http://source.example.com/post/100').to_return(
+      :status => 200,
+      :body => SampleData.sample_source_post_html,
+      :headers => {}
+    )
+
+    WebMock.stub_request(:any, 'http://target.example.com/post/4').to_return(
+      :status => 200,
+      :body => SampleData.rel_webmention_href,
+      :headers => {}
+    )
+
+    WebMock.stub_request(:any, 'http://target.example.com/post/5').to_return(
+      :status => 200,
+      :body => '',
+      :headers => {
+        'Link' => 'rel="webmention"; <http://webmention.io/example/webmention>'
+      }
+    )
+
+    WebMock.stub_request(:any, 'http://webmention.io/example/webmention').to_return(
+      :status => 200
+    )
+
+    @client = Webmention::Client.new "http://source.example.com/post/100"
+  end
+
+  describe "#send_mentions" do
+    it "should return number of mentions sent" do
+      @client = Webmention::Client.new "http://source.example.com/post/100"
+      @client.send_mentions.must_equal 2
+    end
+  end
+end

data/test/lib/webmention/url_test.rb

@@ -0,0 +1,31 @@
+require_relative '../../test_helper'
+
+describe Webmention::Client do
+  describe "#new" do
+    describe "when a valid url" do
+      it "should not throw an error for http" do
+        client = Webmention::Client.new "http://google.com"
+        client.url.must_equal URI.parse("http://google.com")
+      end
+
+      it "should not throw an error for https" do
+        client = Webmention::Client.new "https://google.com"
+        client.url.must_equal URI.parse("https://google.com")
+      end
+    end
+
+    describe "when an invalid url" do
+      it "should raise an error for ftp" do
+        lambda do
+          Webmention::Client.new "ftp://google.com"
+        end.must_raise(ArgumentError)
+      end
+
+      it "should raise an error for no protocol" do
+        lambda do
+          Webmention::Client.new "google.com"
+        end.must_raise(ArgumentError)
+      end
+    end
+  end
+end

data/test/lib/webmention/version_test.rb

@@ -0,0 +1,9 @@
+require_relative '../../test_helper'
+
+describe Webmention do
+
+  it "must be defined" do
+    Webmention::VERSION.wont_be_nil
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'minitest/autorun'
+require 'webmock/minitest'
+
+require File.expand_path('../../lib/webmention.rb', __FILE__)
+require File.expand_path('../data/sample_html.rb', __FILE__)

data/webmention.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'webmention/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'webmention'
+  s.version       = Webmention::VERSION
+  s.date          = '2013-09-14'
+  s.homepage      = 'https://github.com/indieweb/mention-client-ruby'
+  s.summary       = 'A gem for sending webmention (and pingback) notifications'
+  s.authors       = [
+    'Aaron Parecki',
+    'Nat Welch'
+  ]
+
+  s.email         = 'aaron@parecki.com'
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_dependency 'json'
+  s.add_dependency 'nokogiri'
+
+  s.add_development_dependency 'bundler', '~> 1.3'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'webmock'
+end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: webmention
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
 - Aaron Parecki
+- Nat Welch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-02 00:00:00.000000000 Z
+date: 2013-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -28,7 +29,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -43,13 +44,93 @@ dependencies:
     - - ! '>='
       - !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: 
 email: aaron@parecki.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- example.rb
 - lib/webmention.rb
+- lib/webmention/client.rb
+- lib/webmention/version.rb
+- test/data/sample_html.rb
+- test/lib/webmention/crawl_test.rb
+- test/lib/webmention/discovery_test.rb
+- test/lib/webmention/mention_test.rb
+- test/lib/webmention/url_test.rb
+- test/lib/webmention/version_test.rb
+- test/test_helper.rb
+- webmention.gemspec
 homepage: https://github.com/indieweb/mention-client-ruby
 licenses: []
 post_install_message: 
@@ -74,5 +155,12 @@ rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A gem for sending webmention (and pingback) notifications
-test_files: []
+test_files:
+- test/data/sample_html.rb
+- test/lib/webmention/crawl_test.rb
+- test/lib/webmention/discovery_test.rb
+- test/lib/webmention/mention_test.rb
+- test/lib/webmention/url_test.rb
+- test/lib/webmention/version_test.rb
+- test/test_helper.rb
 has_rdoc: