weneedfeed 0.14.0 → 0.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa3500ddeba8701a3cc8c7f729fbfef3c61f95050572bc34327c489842c5744d
-  data.tar.gz: dd89a38ec4ceed97813e9fc5b73b5df1f1c7568ae0dd6b3ab2e0e6a52d0f7bec
+  metadata.gz: ac235ec3ef110856c49b2f1232ffef3318c95d401fda62f0d03a8ecbbe634e87
+  data.tar.gz: b0638cf42a0c679ef01e00551735bc71ea11325053a4695485e533e6640adbb0
 SHA512:
-  metadata.gz: 8e74fb89776dde8f1c7dfb068ddea721a9a9ce6da67d31aa496673e53efcd0993f3deee7452685d643ab73e56ac56fdf42be59aa11413593ee1de326bd219a2c
-  data.tar.gz: d9036bccf6f43b8480eb36d7ea3db5dc348e879705e93b92290ea953b04302898caa5cf4a3aea8fda71704291ab0bf1841e3c761873798f72172191f17c57c88
+  metadata.gz: 3cf511ebf7e37879f4a39bc564d8a0fe6ac18de6a88d91f5ae46f1c5a54e26d064bfac375cb8e6ed708ff75bada7a0e63ef749ed38c2ba6f7ad9de1bbe838eb7
+  data.tar.gz: 79770b221efdd171712d1e5bacb56ca3d971763dbc9ce4dbf1700e480a411eb3238455f10e28919fbd97781677cabd5d0c6418ff3687fef36e7f049456bdcea4

data/CHANGELOG.md

@@ -7,6 +7,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## 0.16.1 - 2022-04-15
+
+### Fixed
+
+- Fix bug that opml.xml is not built.
+
+## 0.16.0 - 2022-04-15
+
+### Added
+
+- Add OPML page.
+
+## 0.15.0 - 2022-04-14
+
+### Changed
+
+- Use hashed title and content as guid fallback.
+
 ## 0.14.0 - 2022-04-14
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    weneedfeed (0.14.0)
+    weneedfeed (0.16.1)
       activesupport
       addressable
       builder

data/lib/weneedfeed/application.rb

@@ -7,6 +7,7 @@ module Weneedfeed
     route do
       get '/', to: ::Weneedfeed::Controllers::ShowTopPage, as: :top_page
       get '/feeds/:page_id.xml', to: ::Weneedfeed::Controllers::ShowFeed, as: :feed
+      get '/opml.xml', to: ::Weneedfeed::Controllers::ShowOpml, as: :opml
     end
 
     # @param [String] schema_path
@@ -23,7 +24,10 @@ module Weneedfeed
 
     # @return [Array<String>]
     def paths
-      ['/'] + @schema.page_ids.map do |page_id|
+      %w[
+        /
+        /opml.xml
+      ] + @schema.page_ids.map do |page_id|
         "/feeds/#{page_id}.xml"
       end
     end

data/lib/weneedfeed/controllers/show_opml.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Weneedfeed
+  module Controllers
+    class ShowOpml < ::Weneedfeed::Controllers::Base
+      def call
+        response.content_type = 'application/xml; charset=utf-8'
+        response.write(
+          ::Weneedfeed::Views::ShowOpml.new(
+            page_schemata: schema.page_schemata.sort_by(&:title),
+            partial_template_path: ::File.expand_path(
+              'templates/show_opml.xml.erb',
+              "#{__dir__}/../../.."
+            ),
+            request: request
+          ).to_s
+        )
+      end
+    end
+  end
+end

data/lib/weneedfeed/controllers.rb

@@ -4,6 +4,7 @@ module Weneedfeed
   module Controllers
     autoload :Base, 'weneedfeed/controllers/base'
     autoload :ShowFeed, 'weneedfeed/controllers/show_feed'
+    autoload :ShowOpml, 'weneedfeed/controllers/show_opml'
     autoload :ShowTopPage, 'weneedfeed/controllers/show_top_page'
   end
 end

data/lib/weneedfeed/item.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'addressable'
+require 'digest/sha1'
 require 'marcel'
 
 module Weneedfeed
@@ -50,6 +51,11 @@ module Weneedfeed
       @node.at(@description_selector)&.inner_html
     end
 
+    # @return [String]
+    def guid
+      link || hashed_title_and_description
+    end
+
     # @return [String, nil]
     def image_mime_type
       return unless image_url
@@ -80,7 +86,7 @@ module Weneedfeed
       ).normalize.to_s
     end
 
-    # @return [String]
+    # @return [String, nil]
     def link
       return unless link_path_or_url
 
@@ -120,6 +126,13 @@ module Weneedfeed
 
     private
 
+    # @return [String]
+    def hashed_title_and_description
+      source = [title, description].join(':')
+      sha1 = ::Digest::SHA1.hexdigest(source)
+      "urn:sha1:#{sha1}"
+    end
+
     # @return [Nokogiri::Node, nil]
     def time_node
       @node.at(@time_selector)

data/lib/weneedfeed/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Weneedfeed
-  VERSION = '0.14.0'
+  VERSION = '0.16.1'
 end

data/lib/weneedfeed/views/base.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Weneedfeed
+  module Views
+    class Base < ::Hibana::View
+      private
+
+      # @return [Hanami::Router]
+      def router
+        ::Weneedfeed::Application.router
+      end
+    end
+  end
+end

data/lib/weneedfeed/views/show_feed.rb

@@ -2,7 +2,7 @@
 
 module Weneedfeed
   module Views
-    class ShowFeed < ::Hibana::View
+    class ShowFeed < Base
       include ::Weneedfeed::Helpers::Parameters
 
       # @param [Weneedfeed::Page] page
@@ -29,11 +29,6 @@ module Weneedfeed
       def page_id
         path_parameters[:page_id]
       end
-
-      # @return [Hanami::Router]
-      def router
-        ::Weneedfeed::Application.router
-      end
     end
   end
 end

data/lib/weneedfeed/views/show_opml.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Weneedfeed
+  module Views
+    class ShowOpml < Base
+      # @param [Array<Hash>] page_schemata
+      def initialize(page_schemata:, **argv)
+        super(**argv)
+        @page_schemata = page_schemata
+      end
+
+      private
+
+      # @return [String]
+      def base_path
+        request.path.delete_suffix(router.path(:opml))
+      end
+
+      # @param [String] page_id
+      # @return [String]
+      def feed_path(page_id:)
+        "#{base_path}#{router.path(:feed, page_id: page_id)}"
+      end
+    end
+  end
+end

data/lib/weneedfeed/views/show_top_page.rb

@@ -2,7 +2,7 @@
 
 module Weneedfeed
   module Views
-    class ShowTopPage < ::Hibana::View
+    class ShowTopPage < Base
       # @param [Array<Hash>] page_schemata
       def initialize(page_schemata:, **argv)
         super(**argv)
@@ -22,6 +22,11 @@ module Weneedfeed
         "#{base_path}#{router.path(:feed, page_id: page_id)}"
       end
 
+      # @return [String]
+      def opml_path
+        "#{base_path}#{router.path(:opml)}"
+      end
+
       # @return [Hanami::Router]
       def router
         ::Weneedfeed::Application.router

data/lib/weneedfeed/views.rb

@@ -2,7 +2,9 @@
 
 module Weneedfeed
   module Views
+    autoload :Base, 'weneedfeed/views/base'
     autoload :ShowFeed, 'weneedfeed/views/show_feed'
+    autoload :ShowOpml, 'weneedfeed/views/show_opml'
     autoload :ShowTopPage, 'weneedfeed/views/show_top_page'
   end
 end

data/templates/show_feed.xml.erb

@@ -17,7 +17,7 @@
       <% end %>
       <description><![CDATA[<%= item.description %>]]></description>
       <content:encoded><![CDATA[<%= item.description %>]]></content:encoded>
-      <guid isPermaLink="true"><%= item.link %></guid>
+      <guid isPermaLink="true"><%= item.guid %></guid>
       <% if item.image_url %>
         <enclosure url=<%= item.image_url.encode(xml: :attr) %> length="0" type="<%= item.image_mime_type %>"/>
       <% end %>

data/templates/show_opml.xml.erb

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<opml version="1.0">
+  <head>
+    <title>Feeds from Weneedfeed</title>
+  </head>
+  <body>
+    <outline text="Feeds" title="Feeds">
+      <% @page_schemata.each do |page_schema| %>
+        <outline type="rss" text="<%= page_schema.title %>" title="<%= page_schema.title %>" xmlUrl="<%= "#{request.base_url}#{feed_path(page_id: page_schema.id)}" %>" htmlUrl="<%= page_schema.url %>"/>
+      <% end %>
+    </outline>
+  </body>
+</opml>

data/templates/show_top_page.html.erb

@@ -6,12 +6,25 @@
     <title>Weneedfeed</title>
   </head>
   <body>
-    <ul>
-      <% @page_schemata.each do |page_schema| %>
-      <li>
-        <a href="<%= feed_path(page_id: page_schema.id) %>"><%= page_schema.title %></a>
-      </li>
-      <% end %>
-    </ul>
+    <section>
+      <header>
+        <h1>Feeds</h1>
+      </header>
+      <ul>
+        <% @page_schemata.each do |page_schema| %>
+        <li>
+          <a href="<%= feed_path(page_id: page_schema.id) %>"><%= page_schema.title %></a>
+        </li>
+        <% end %>
+      </ul>
+    </section>
+    <section>
+      <header>
+        <h1>Others</h1>
+      </header>
+      <ul>
+        <li><a href="<%= opml_path %>">OPML</a></li>
+      </ul>
+    </section>
   </body>
 </html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weneedfeed
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.16.1
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-14 00:00:00.000000000 Z
+date: 2022-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -192,6 +192,7 @@ files:
 - lib/weneedfeed/controllers.rb
 - lib/weneedfeed/controllers/base.rb
 - lib/weneedfeed/controllers/show_feed.rb
+- lib/weneedfeed/controllers/show_opml.rb
 - lib/weneedfeed/controllers/show_top_page.rb
 - lib/weneedfeed/faraday_response_middleware.rb
 - lib/weneedfeed/helpers.rb
@@ -203,9 +204,12 @@ files:
 - lib/weneedfeed/scraping.rb
 - lib/weneedfeed/version.rb
 - lib/weneedfeed/views.rb
+- lib/weneedfeed/views/base.rb
 - lib/weneedfeed/views/show_feed.rb
+- lib/weneedfeed/views/show_opml.rb
 - lib/weneedfeed/views/show_top_page.rb
 - templates/show_feed.xml.erb
+- templates/show_opml.xml.erb
 - templates/show_top_page.html.erb
 - weneedfeed.gemspec
 homepage: https://github.com/r7kamura/weneedfeed