social_web-well_known 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2916f12849cd44cd8a9eee7e5085d5c39e2e13e6d27deea343140ce72897bfd4
+  data.tar.gz: ba1b499ab666b37499ab87da2c0cbd3add82cadd13b378c9850031d81ad1c13d
+SHA512:
+  metadata.gz: 1bfc7e23acc16b89d8a5cbed4861d542ddad9d367d62d79e1b0fa3c2c361cd98d3d03377a6cd294fdfc7a52ee65e919a4e3e2c4edf01e3cfdbd5e6821af2e7e2
+  data.tar.gz: 56a8cdd9c9d876a70a409bcabbdb5f57459bf8b790f5a8a8c1d631caa9d71f75dce92dab46852407d19e03c4a626a35b0eda50ac13bdd80c01148a51a15433fc

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Shane Cavanaugh
+
+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/lib/well_known.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+require 'roda'
+
+require 'well_known/exceptions'
+require 'well_known/configuration'
+require 'well_known/hooks'
+
+module WellKnown
+  def self.configure
+    yield config
+  end
+
+  def self.config
+    @configuration ||= Configuration.new
+  end
+
+  class Routes < ::Roda
+    plugin :halt
+    plugin :json
+    plugin :json_parser
+    plugin :middleware, env_var: 'social_web.well_known'
+
+    route do |r|
+      r.on('.well-known') do
+        r.get 'webfinger' do
+          Hooks.run('well_known.webfinger.before_get', r)
+
+          resource_param = r.params['resource']
+          r.halt 400 if resource_param.nil?
+          if WellKnown.config.webfinger_resource[:subject] != resource_param
+            r.halt 404
+          end
+
+          response.status = 200
+          response['Content-Type'] = 'application/jrd+json'
+          WellKnown.config.webfinger_resource
+        ensure
+          Hooks.run('well_known.webfinger.after_get', response)
+        end
+      end
+    end
+  end
+end

data/lib/well_known/configuration.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module WellKnown
+  class Configuration
+    attr_accessor :webfinger_resource
+
+    def initialize
+      @webfinger_resource = {}
+    end
+  end
+end

data/lib/well_known/exceptions.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module WellKnown
+  class Error < StandardError; end
+end

data/lib/well_known/hooks.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module WellKnown
+  HOOKS = %w[
+    well_known.webfinger.before_get
+    well_known.webfinger.after_get
+  ].freeze
+
+  module Hooks
+    class FailedHook < Error
+      MESSAGE_FORMAT = <<~TXT
+        %<hook_name>s: %<hook_source_location>s
+
+        %<exception_class>s: %<exception_message>s
+      TXT
+      attr_accessor :hook_name, :hook_source_location, :wrapped_exception
+
+      def initialize(hook_name, hook_source_location, wrapped_exception)
+        @hook_name = hook_name
+        @hook_source_location = hook_source_location
+        @wrapped_exception = wrapped_exception
+        super(format_message)
+      end
+
+      def cause
+        wrapped_exception || super
+      end
+
+      private
+
+      def format_message
+        format(
+          MESSAGE_FORMAT,
+          hook_name: hook_name,
+          exception_class: wrapped_exception.class,
+          exception_message: wrapped_exception.message,
+          hook_source_location: hook_source_location.join(':')
+        )
+      end
+    end
+
+    def self.register(name, &blk)
+      Registry.instance.register(name, &blk)
+    end
+
+    def self.run(name, *args, **kwargs)
+      hooks = Registry.instance[name]
+      hooks&.each do |hook|
+        hook.call(*args, **kwargs)
+      rescue StandardError => e
+        raise FailedHook.new(name, hook.source_location, e)
+      end
+    end
+
+    class Registry
+      attr_accessor :hooks
+
+      def self.instance
+        @instance ||= new
+      end
+
+      def initialize
+        @hooks = {}
+      end
+
+      def [](name)
+        @hooks[name]
+      end
+
+      def register(name, &action)
+        @hooks[name] ||= []
+        @hooks[name] << action.to_proc
+      end
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Helper
+  def app
+    builder = Rack::Builder.new
+    builder.run WellKnown::Routes
+  end
+
+  def configure
+    mock_config = instance_double('WellKnown::Configuration')
+    allow(WellKnown).to receive(:config).and_return(mock_config)
+    yield mock_config
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+SimpleCov.add_filter(/spec/)
+SimpleCov.start
+
+require 'well_known'
+require 'rack/test'
+require 'helper'
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods, type: :route
+  config.include Helper
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  config.example_status_persistence_file_path = 'tmp/examples.txt'
+
+  config.disable_monkey_patching!
+
+  config.warnings = false
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/spec/well_known_spec.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module WellKnown
+  class Routes
+    RSpec.describe '/.well-known', type: :route do
+      context '/.well-known/webfinger' do
+        context 'GET /.well-known/webfinger' do
+          context 'resource is absent or empty' do
+            it 'returns a 400' do
+              get '/.well-known/webfinger'
+              expect(last_response.status).to eq(400)
+            end
+          end
+
+          context 'resource is not found' do
+            it 'returns a 404' do
+              get '/.well-known/webfinger', { resource: '' }
+              expect(last_response.status).to eq(404)
+            end
+          end
+
+          context 'resource is found' do
+            it 'returns the resource' do
+              subject = 'acct:beep@boop.com'
+              configure do |config|
+                allow(config).
+                  to receive(:webfinger_resource).
+                    and_return(subject: subject)
+              end
+
+              get '/.well-known/webfinger', { resource: subject }
+              expect(last_response.status).to eq(200)
+              expect(last_response.content_type).to eq('application/jrd+json')
+            end
+          end
+
+          it 'runs hooks before and after the request' do
+            expect(Hooks).
+              to receive(:run).
+              ordered.
+              with(
+                'well_known.webfinger.before_get',
+                kind_of(Rack::Request)
+              )
+            expect(Hooks).
+              to receive(:run).
+              ordered.
+              with(
+                'well_known.webfinger.after_get',
+                kind_of(Roda::RodaResponse)
+              )
+            get '/.well-known/webfinger', '{}'
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: social_web-well_known
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Shane Cavanaugh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: roda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Ednpoints for Well-Known URIs
+email:
+- shane@shanecav.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/well_known.rb
+- lib/well_known/configuration.rb
+- lib/well_known/exceptions.rb
+- lib/well_known/hooks.rb
+- spec/helper.rb
+- spec/spec_helper.rb
+- spec/well_known_spec.rb
+homepage: https://github.com/social_web/webmention
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/social_web/webmention
+  source_code_uri: https://github.com/social_web/webmention
+  changelog_uri: https://github.com/social_web/well_known/tree/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Ednpoints for Well-Known URIs
+test_files: []