webmention 0.1.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fb054d8a144253225b03c07b8cb1b70e78b01c5d
-  data.tar.gz: a73bd416adcbcd7c3aac45eb3fc053cb2a2296f8
+SHA256:
+  metadata.gz: b1bde7851ec0309258c157929d3e7e53b640f253d97b7cd2b1ac68785afeb75e
+  data.tar.gz: b6af4fdee3e16035cbdc4479ecffb48d2685a29a4193a43c2145a348a9b95f4c
 SHA512:
-  metadata.gz: 792d42a1dea5a5be92f1550753688699ddd4da47a166ed52fa09463cae5ce2c5264fc924cc10bb585f3f5eb84a2f7283805db44f11f82b5f6e3833e51da63bba
-  data.tar.gz: f8dd7faaa37ea1de848ccdb6b40dc737707a18c2f93a412d6ea48c2be8ae34058ca887506b3c84f42b93aed89835940003d944f6409e88bc842f6ce321aa2f62
+  metadata.gz: a2c9c9de6ac875786c3795849490c7ceab6e1323510f7bd905d10c971b171b2898a22ad3fbf21b9d08afc65fc859baa6bbcad676d393d6be06181006f32f545e
+  data.tar.gz: 70ec1f5ce90d1ac832ceceab666abd0a430fb73ee0a3728d08c826608526ff7e52bdc37351190a2bf38c7093e3641ec5be45d89de9d423c837b341153d68ae0c

data/.editorconfig

@@ -0,0 +1,10 @@
+# EditorConfig is awesome: https://EditorConfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_size = 2
+indent_style = space
+trim_trailing_whitespace = true

data/.gitignore

@@ -1,17 +1,34 @@
 *.gem
 *.rbc
-.bundle
-.config
-.yardoc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+# Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
 Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.reek.yml

@@ -0,0 +1,8 @@
+detectors:
+  DuplicateMethodCall:
+    max_calls: 3
+  IrresponsibleModule:
+    enabled: false
+
+exclude_paths:
+  - vendor/

data/.rubocop

@@ -0,0 +1,3 @@
+--display-style-guide
+--extra-details
+--parallel

data/.rubocop.yml

@@ -0,0 +1,30 @@
+require:
+  - rubocop-performance
+
+Layout/AlignHash:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Metrics/BlockLength:
+  Exclude:
+    - webmention.gemspec
+    - test/**/*
+
+Metrics/LineLength:
+  Enabled: false
+
+Naming/RescuedExceptionsVariableName:
+  PreferredName: exception
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/SingleLineMethods:
+  Exclude:
+    - test/**/*
+
+Style/SymbolArray:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.4.6

data/.simplecov

@@ -0,0 +1,10 @@
+require 'simplecov-console'
+
+SimpleCov.start do
+  add_filter '/test/'
+
+  formatter SimpleCov::Formatter::MultiFormatter.new([
+    SimpleCov::Formatter::Console,
+    SimpleCov::Formatter::HTMLFormatter
+  ])
+end

data/.travis.yml

@@ -1,7 +1,17 @@
 language: ruby
+cache: bundler
 rvm:
-  - 2.4.1
-  - 2.3.4
-  - 2.2.7
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
+before_install:
+  - gem update --system
+  - gem update bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 notifications:
   email: false

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+## 1.0.0 / 2019-07-03
+
+### Breaking Changes
+
+For an instance of the `Webmention::Client` class:
+
+- The `send_mention` no longer accepts the `full_response` argument. When a Webmention endpoint is found, the method returns an `HTTP::Response` object. Otherwise, the method returns `nil`.
+- The `send_mentions` method is renamed to `send_all_mentions` and now returns a Hash whose keys are URLs and values are `HTTP::Response` objects (or `nil` when no Webmention endpoint is found at the given URL).
+- The `mentioned_url` method returns an Array of URLs mentioned within given URL's first `.h-entry` (if one exists). Otherwise, it returns a list of all URLs within the given URL's `<body>`.
+
+### Development Changes
+
+- Removes [Bundler](https://bundler.io) as a dependency (5e1662d)
+- Updates project Ruby to 2.4.6 (the latest 2.4.x release at this time) (b53a400)
+- Add the [Reek](https://github.com/troessner/reek) code smell detector (eb314dc)
+- Adds binstubs for more easily running common development tools (8899a22)

data/CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Contributing to webmention-client-ruby
+
+There are a couple ways you can help improve webmention-client-ruby:
+
+1. Fix an existing [issue][issues] and submit a [pull request][pulls].
+1. Review open [pull requests][pulls].
+1. Report a new [issue][issues]. _Only do this after you've made sure the behavior or problem you're observing isn't already documented in an open issue._
+
+## Getting Started
+
+webmention-client-ruby is developed using Ruby 2.4.6 and is additionally tested against Ruby 2.5.5 and 2.6.3 using [Travis CI](https://travis-ci.org/indieweb/webmention-client-ruby).
+
+Before making changes to webmention-client-ruby, you'll want to install Ruby 2.4.6. It's recommended that you use a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm). Once you've installed Ruby 2.4.6 using your method of choice, install the project's gems by running:
+
+```sh
+bundle install
+```
+
+## Making Changes
+
+1. Fork and clone the project's repo.
+1. Install development dependencies as outlined above.
+1. Create a feature branch for the code changes you're looking to make: `git checkout -b my-new-feature`.
+1. _Write some code!_
+1. If your changes would benefit from testing, add the necessary tests and verify everything passes by running `bundle exec rspec`.
+1. Commit your changes: `git commit -am 'Add some new feature or fix some issue'`. _(See [this excellent article](https://chris.beams.io/posts/git-commit/) for tips on writing useful Git commit messages.)_
+1. Push the branch to your fork: `git push -u origin my-new-feature`.
+1. Create a new [pull request][pulls] and we'll review your changes.
+
+## Code Style
+
+Code formatting conventions are defined in the `.editorconfig` file which uses the [EditorConfig](http://editorconfig.org) syntax. There are [plugins for a variety of editors](http://editorconfig.org/#download) that utilize the settings in the `.editorconfig` file. We recommended you install the EditorConfig plugin for your editor of choice.
+
+Your bug fix or feature addition won't be rejected if it runs afoul of any (or all) of these guidelines, but following the guidelines will definitely make everyone's lives a little easier.
+
+[issues]: https://github.com/indieweb/webmention-client-ruby/issues
+[pulls]: https://github.com/indieweb/webmention-client-ruby/pulls

data/LICENSE

@@ -0,0 +1,13 @@
+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/README.md

@@ -1,78 +1,110 @@
-Webmention Client
-=================
+# webmention-client-ruby
 
-A Ruby gem for sending [webmention](http://indiewebcamp.com/webmention) (and [pingback](http://indiewebcamp.com/pingback)) notifications.
+**A Ruby gem for sending [Webmention](https://indieweb.org/Webmention) notifications.**
 
-[![Build Status](https://travis-ci.org/indieweb/mention-client-ruby.png?branch=master)](https://travis-ci.org/indieweb/mention-client-ruby)
+[![Gem](https://img.shields.io/gem/v/webmention.svg?style=for-the-badge)](https://rubygems.org/gems/webmention)
+[![Downloads](https://img.shields.io/gem/dt/webmention.svg?style=for-the-badge)](https://rubygems.org/gems/webmention)
+[![Build](https://img.shields.io/travis/indieweb/webmention-client-ruby/master.svg?style=for-the-badge)](https://travis-ci.org/indieweb/webmention-client-ruby)
+[![Maintainability](https://img.shields.io/codeclimate/maintainability/indieweb/webmention-client-ruby.svg?style=for-the-badge)](https://codeclimate.com/github/indieweb/webmention-client-ruby)
+[![Coverage](https://img.shields.io/codeclimate/c/indieweb/webmention-client-ruby.svg?style=for-the-badge)](https://codeclimate.com/github/indieweb/webmention-client-ruby/code)
 
-Installation
-------------
+## Key Features
 
-    gem install webmention
+- Crawls a given URL for mentioned URLs.
+- Performs [endpoint discovery](https://www.w3.org/TR/webmention/#sender-discovers-receiver-webmention-endpoint) on mentioned URLs.
+- Sends webmentions to mentioned URLs.
 
+## Getting Started
 
-Usage
------
+Before installing and using webmention-client-ruby, you'll want to have [Ruby](https://www.ruby-lang.org) 2.4 (or newer) installed. It's recommended that you use a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm).
 
-### Send webmentions to all links on a page
+webmention-client-ruby is developed using Ruby 2.4.6 and is additionally tested against Ruby 2.5.5 and 2.6.3 using [Travis CI](https://travis-ci.org/indieweb/webmention-client-ruby).
+
+## Installation
+
+If you're using [Bundler](https://bundler.io) to manage gem dependencies, add webmention-client-ruby to your project's Gemfile:
 
 ```ruby
-client = Webmention::Client.new url
-sent = client.send_mentions
+source 'https://rubygems.org'
 
-puts "Sent #{sent} mentions"
+gem 'webmention'
 ```
 
-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.
+…and then run:
 
-After finding either webmention or pingback endpoints, the request is sent to each.
+```sh
+bundle install
+```
 
-### Send webmention to a specific URL
+## Usage
+
+With webmention-client-ruby added to your project's `Gemfile` and installed, you may send a webmention from a source URL to a target URL:
 
 ```ruby
-# Discover the webmention endpoint of a target and send the mention
+require 'webmention'
 
-source = "http://source.example.com/post/100"   # For example, your page
-target = "http://indiewebcamp.com/"             # The page you linked to
+source = 'https://source.example.com/post/100'  # A post on your website
+target = 'https://target.example.com/post/100'  # A post on someone else's website
 
-if endpoint = Webmention::Client.supports_webmention?(target)
-  Webmention::Client.send_mention endpoint, source, target
-end
+Webmention.send_mention(source, target) # => #<HTTP::Response/1.1 200 OK {…}>
 ```
 
-Command Line Utility
---------------------
+If no Webmention endpoint is found for a given source URL, the `send_mention` method will return `nil`.
+
+**Note:** `HTTP::Response` objects may return a variety of status codes that will vary depending on the endpoint's capabilities and the success or failure of the request. See [the Webmention spec](https://www.w3.org/TR/webmention/) for more on status codes on their implications.
 
-For testing or for sending webmentions manually, you can use the command-line utility provided.
+### Sending multiple webmentions
 
-```bash
-$ webmention http://source.example.com/post/100
+To send webmentions to all URLs mentioned within a source URL's [h-entry](http://microformats.org/wiki/h-entry):
+
+```ruby
+require 'webmention'
+
+client = Webmention.client('https://source.example.com/post/100')
+
+client.mentioned_urls    # => Array
+client.send_all_mentions # => Hash
 ```
 
-This will look for an [h-entry](http://indiewebcamp.com/h-entry) on the given URL and attempt to send webmentions to each URL in the entry. 
+This example will crawl `https://source.example.com/post/100`, parse its markup for the first h-entry, perform endpoint discovery on mentioned URLs, and attempt to send webmentions to those URLs.
+
+**Note:** If no h-entry is found at the provided source URL, the `send_all_mentions` method will search the source URL's `<body>` for mentioned URLs.
+
+The `send_all_mentions` method returns a hash of mentioned URLs and the associated HTTP response (an [`HTTP::Response` object](https://github.com/httprb/http/wiki/Response-Handling)):
+
+```ruby
+{
+  'https://target.example.com/post/100' => #<HTTP::Response/1.1 200 OK {…}>,
+  'https://target.example.com/post/101' => #<HTTP::Response/1.1 200 OK {…}>
+}
+```
+
+### Exception Handling
+
+There are several exceptions that may be raised by webmention-client-ruby's underlying dependencies. These errors are raised as subclasses of `WebmentionClientError` (which itself is a subclass of `StandardError`).
+
+From [sporkmonger/addressable](https://github.com/sporkmonger/addressable):
+
+- `Webmention::Client::InvalidURIError`
+
+From [httprb/http](https://github.com/httprb/http):
 
+- `Webmention::Client::ConnectionError`
+- `Webmention::Client::TimeoutError`
+- `Webmention::Client::TooManyRedirectsError`
 
-Webmention
-----------
+webmention-client-ruby will also raise a `Webmention::Client::UnsupportedMimeTypeError` when encountering an `HTTP::Response` instance with an unsupported MIME type.
 
-To learn more about Webmention, see [webmention.org](http://webmention.org) and [indiewebcamp.com/webmention](http://indiewebcamp.com/webmention).
+## Contributing
 
+Interested in helping improve webmention-client-ruby? Awesome! Your help is greatly appreciated. See [CONTRIBUTING.md](https://github.com/indieweb/webmention-client-ruby/blob/master/CONTRIBUTING.md) for details.
 
-License
--------
+## Acknowledgments
 
-Copyright 2013 by Aaron Parecki
+webmention-client-ruby is written and maintained by [Aaron Parecki](https://aaronparecki.com) ([@aaronpk](https://github.com/aaronpk)) and [Nat Welch](https://natwelch.com) ([@icco](https://github.com/icco)) with help from [these additional contributors](https://github.com/indieweb/webmention-client-ruby/graphs/contributors).
 
-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
+To learn more about Webmention, see [indieweb.org/Webmention](https://indieweb.org/Webmention) and [webmention.net](https://webmention.net).
 
-   http://www.apache.org/licenses/LICENSE-2.0
+## License
 
-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.
+webmention-client-ruby is freely available under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html). See [LICENSE](https://github.com/indieweb/webmention-client-ruby/blob/master/LICENSE) for more details.

data/Rakefile

@@ -1,10 +1,21 @@
 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
+require 'reek/rake/task'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
- 
-task :default => :test
+
+Reek::Rake::Task.new do |task|
+  task.fail_on_error = false
+end
+
+RuboCop::RakeTask.new do |task|
+  task.fail_on_error = false
+end
+
+task default: [:rubocop, :reek, :test]

data/lib/webmention.rb

@@ -1,9 +1,27 @@
-require 'json'
-require 'httparty'
+require 'absolutely'
+require 'addressable/uri'
+require 'http'
+require 'indieweb/endpoints'
 require 'nokogiri'
-require 'open-uri'
-require 'set'
-require 'uri'
 
 require 'webmention/version'
+require 'webmention/exceptions'
+
 require 'webmention/client'
+require 'webmention/http_request'
+require 'webmention/registerable'
+
+require 'webmention/parsers'
+require 'webmention/parsers/html_parser'
+
+module Webmention
+  class << self
+    def client(source)
+      Client.new(source)
+    end
+
+    def send_mention(source, target)
+      client(source).send_mention(target)
+    end
+  end
+end