micropub-endpoint 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea41f10e540c64355824dca9221efb99ac2710b5
-  data.tar.gz: e087dd656a9941c707c35fdf71b75a709c36ce4e
+  metadata.gz: d168f8f8420066caefc1659a7100715a30295d42
+  data.tar.gz: a70f780105503fe3e2fe1c0a3b4e8628ce8fa618
 SHA512:
-  metadata.gz: ffaba208bddb2101b840d2d33d5d3014181899829b3ec995c7ab938837ae47efb6ecb3762b2fea77ed2898ddb64683229e3ab2fe84244bcbd2929a14aafb05e8
-  data.tar.gz: 9e82e30e261a900ca4496b764d17ea4ee251b6484257b85da878f548337c458f0c6ad1dc8fa26d15366f859746b7bbc4175c87cdca1a9f8e4f84d1fd60845f57
+  metadata.gz: '058327ba6c3f67336619a8c9ff516d42b3b0e71946c6892a954af5880e9e0e08a8dc6a0cf68e9ae29908c5b34c315c8f107a1fb3765c53d7f43ef1ac0c186028'
+  data.tar.gz: 010edbc4bc7119a9bc69fbe77c7ba12c66c3a559612cd96eaba8d843915e025e6a173313be6ad37d6858d630fd7d10cae64667ee4aaa167d605d6774a0e57922

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.0.0 / 2018-07-17
+
+- Adds new `Micropub::Endpoint::Client` and `Micropub::Endpoint::Response` classes and refactors `Micorpub::Endpoint::Discover` API ([77f9865](https://github.com/jgarber623/micropub-endpoint-ruby/commit/77f9865)).
+- Updates specs ([78d15d0](https://github.com/jgarber623/micropub-endpoint-ruby/commit/78d15d0)) and documentation ([383e6b9](https://github.com/jgarber623/micropub-endpoint-ruby/commit/383e6b9)).
+
 ## 0.2.1 / 2018-07-05
 
 - Updates [Absolutely](https://github.com/jgarber623/absolutely) to v1.1.0 ([f6027c3](https://github.com/jgarber623/micropub-endpoint-ruby/commit/f6027c3)).

data/README.md

@@ -11,7 +11,7 @@
 
 ## Key Features
 
-- Compliant with [Section 5.3](https://www.w3.org/TR/micropub/#endpoint-discovery) of [the W3C's Micropub specification](https://www.w3.org/TR/micropub/).
+- Compliant with [Section 5.3](https://www.w3.org/TR/micropub/#endpoint-discovery) of [the W3C's Micropub Recommendation](https://www.w3.org/TR/micropub/).
 - Supports Ruby 2.4 and newer.
 
 ## Getting Started
@@ -50,7 +50,7 @@ endpoint = Micropub::Endpoint.discover('https://adactio.com')
 puts endpoint # returns String: 'https://adactio.com/micropub'
 ```
 
-This example will search `https://adactio.com` for a valid Micropub endpoint in accordance with the rules described in [the W3C's Micropub specification](https://www.w3.org/TR/micropub/#endpoint-discovery). In this case, the program returns a string: `https://adactio.com/micropub`.
+This example will search `https://adactio.com` for a valid Micropub endpoint in accordance with the rules described in [the W3C's Micropub Recommendation](https://www.w3.org/TR/micropub/#endpoint-discovery). In this case, the program returns a string: `https://adactio.com/micropub`.
 
 If no endpoint is discovered at the provided URL, the program will return `nil`:
 
@@ -64,18 +64,15 @@ puts endpoint.nil? # returns Boolean: true
 
 ### Advanced Usage
 
-Should the need arise, you may work directly with the `Micropub::Endpoint::Discover` class:
+Should the need arise, you may work directly with the `Micropub::Endpoint::Client` class:
 
 ```ruby
 require 'micropub/endpoint'
 
-discoverer = Micropub::Endpoint::Discover.new('https://adactio.com')
+client = Micropub::Endpoint::Client.new('https://adactio.com')
 
-puts discoverer.url      # returns String: 'https://adactio.com'
-puts discoverer.endpoint # returns String: 'https://adactio.com/micropub'
-
-puts discoverer.uri      # returns Addressable::URI
-puts discoverer.response # returns HTTP::Response
+puts client.response # returns HTTP::Response
+puts client.endpoint # returns String: 'https://adactio.com/micropub'
 ```
 
 ### Exception Handling

data/lib/micropub/endpoint.rb

@@ -5,12 +5,14 @@ require 'nokogiri'
 
 require 'micropub/endpoint/version'
 require 'micropub/endpoint/error'
+require 'micropub/endpoint/client'
 require 'micropub/endpoint/discover'
+require 'micropub/endpoint/response'
 
 module Micropub
   module Endpoint
     def self.discover(url)
-      Discover.new(url).endpoint
+      Client.new(url).endpoint
     end
   end
 end

data/lib/micropub/endpoint/client.rb

@@ -0,0 +1,21 @@
+module Micropub
+  module Endpoint
+    class Client
+      def initialize(url)
+        raise ArgumentError, "url must be a String (given #{url.class.name})" unless url.is_a?(String)
+
+        @uri = Addressable::URI.parse(url)
+      rescue Addressable::URI::InvalidURIError => error
+        raise InvalidURIError, error
+      end
+
+      def endpoint
+        @endpoint ||= Discover.new(response).endpoint
+      end
+
+      def response
+        @response ||= Response.new(@uri).response
+      end
+    end
+  end
+end

data/lib/micropub/endpoint/discover.rb

@@ -1,11 +1,6 @@
 module Micropub
   module Endpoint
     class Discover
-      HTTP_HEADERS_OPTS = {
-        accept: '*/*',
-        user_agent: 'Micropub Endpoint Discovery (https://rubygems.org/gems/micropub-endpoint)'
-      }.freeze
-
       # Ultra-orthodox pattern matching allowed values in HTTP Link header `rel` parameter
       # https://tools.ietf.org/html/rfc8288#section-3.3
       REGEXP_REG_REL_TYPE_PATTERN = '[a-z\d][a-z\d\-\.]*'.freeze
@@ -18,44 +13,26 @@ module Micropub
       # https://www.w3.org/TR/micropub/#endpoint-discovery
       REGEXP_MICROPUB_REL_PATTERN = /(?:;|\s)rel="?(?:#{REGEXP_REG_REL_TYPE_PATTERN}+\s)?micropub(?:\s#{REGEXP_REG_REL_TYPE_PATTERN})?"?/
 
-      attr_reader :uri, :url
-
-      def initialize(url)
-        raise ArgumentError, "url must be a String (given #{url.class.name})" unless url.is_a?(String)
+      def initialize(response)
+        raise ArgumentError, "response must be an HTTP::Response (given #{response.class.name})" unless response.is_a?(HTTP::Response)
 
-        @url = url
-        @uri = Addressable::URI.parse(url)
-      rescue Addressable::URI::InvalidURIError => error
-        raise InvalidURIError, error
+        @response = response
       end
 
       def endpoint
         return unless endpoint_from_http_request
 
-        @endpoint ||= Absolutely.to_absolute_uri(base: url, relative: endpoint_from_http_request)
+        @endpoint ||= Absolutely.to_absolute_uri(base: @response.uri.to_s, relative: endpoint_from_http_request)
       rescue Absolutely::InvalidURIError => error
         raise InvalidURIError, error
       end
 
-      def response
-        @response ||= HTTP.follow.headers(HTTP_HEADERS_OPTS).timeout(
-          connect: 10,
-          read: 10
-        ).get(uri)
-      rescue HTTP::ConnectionError => error
-        raise ConnectionError, error
-      rescue HTTP::TimeoutError => error
-        raise TimeoutError, error
-      rescue HTTP::Redirector::TooManyRedirectsError => error
-        raise TooManyRedirectsError, error
-      end
-
       private
 
       def endpoint_from_body
-        return unless response.mime_type == 'text/html'
+        return unless @response.mime_type == 'text/html'
 
-        doc = Nokogiri::HTML(response.body.to_s)
+        doc = Nokogiri::HTML(@response.body.to_s)
 
         # Search response body for first `link` element with valid `rel` attribute
         link_element = doc.css('link[rel~="micropub"][href]').shift
@@ -64,7 +41,7 @@ module Micropub
       end
 
       def endpoint_from_headers
-        link_headers = response.headers.get('link')
+        link_headers = @response.headers.get('link')
 
         return unless link_headers
 

data/lib/micropub/endpoint/response.rb

@@ -0,0 +1,29 @@
+module Micropub
+  module Endpoint
+    class Response
+      HTTP_HEADERS_OPTS = {
+        accept: '*/*',
+        user_agent: 'Micropub Endpoint Discovery (https://rubygems.org/gems/micropub-endpoint)'
+      }.freeze
+
+      def initialize(uri)
+        raise ArgumentError, "uri must be an Addressable::URI (given #{uri.class.name})" unless uri.is_a?(Addressable::URI)
+
+        @uri = uri
+      end
+
+      def response
+        @response ||= HTTP.follow.headers(HTTP_HEADERS_OPTS).timeout(
+          connect: 10,
+          read: 10
+        ).get(@uri)
+      rescue HTTP::ConnectionError => error
+        raise ConnectionError, error
+      rescue HTTP::TimeoutError => error
+        raise TimeoutError, error
+      rescue HTTP::Redirector::TooManyRedirectsError => error
+        raise TooManyRedirectsError, error
+      end
+    end
+  end
+end

data/lib/micropub/endpoint/version.rb

@@ -1,5 +1,5 @@
 module Micropub
   module Endpoint
-    VERSION = '0.2.1'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

data/micropub-endpoint.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.16', '>= 1.16.2'
   spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.1'
   spec.add_development_dependency 'rspec', '~> 3.7'
-  spec.add_development_dependency 'rubocop', '~> 0.57.2'
+  spec.add_development_dependency 'rubocop', '~> 0.58.0'
   spec.add_development_dependency 'rubocop-rspec', '~> 1.27'
   spec.add_development_dependency 'simplecov', '~> 0.16.1'
   spec.add_development_dependency 'simplecov-console', '~> 0.4.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: micropub-endpoint
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Jason Garber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-05 00:00:00.000000000 Z
+date: 2018-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,14 +70,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.57.2
+        version: 0.58.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.57.2
+        version: 0.58.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -230,8 +230,10 @@ files:
 - README.md
 - Rakefile
 - lib/micropub/endpoint.rb
+- lib/micropub/endpoint/client.rb
 - lib/micropub/endpoint/discover.rb
 - lib/micropub/endpoint/error.rb
+- lib/micropub/endpoint/response.rb
 - lib/micropub/endpoint/version.rb
 - micropub-endpoint.gemspec
 homepage: https://github.com/jgarber623/micropub-endpoint-ruby