weneedfeed 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65814d68cfaf1936de388ce721e3aee49a0e4641c0ecd6ae2afb72c858fbd8f4
-  data.tar.gz: ed124803cfb9589dd3b8e44169454b07623a2460a7ac2412c1946d08e51d590f
+  metadata.gz: a2634d6a72650518bf2845381116e208a65fbb9f067b6e19f58352bb46ecb5ba
+  data.tar.gz: 1ccc6647e1a02d34af10460b34d5cd594eb5a184cbe18e2244d45637a38d9d96
 SHA512:
-  metadata.gz: 486e7af49032ebf8124d6360cd835ec5ede778c4dc6911259fcee753247166ef6c53e3468bb3c386a3e2d794b3939685795c230a4ff24e65a67e615c5b39a800
-  data.tar.gz: 636f09f3860a1a7a16bf425facd29988e7037ae35a9ab8a11b8a37118339c9bdf750336eb01b8c36e2bee0d8b81ed2b1a9846269096428b702c09b27b873617a
+  metadata.gz: 18d069fc8460e37e79b67869bd91f64d28f865d052c4464d6f169f811ad32c27698ccad3235f4b7f047160cd68341f56a576701758bb367d9766e9f8d46dc9c3
+  data.tar.gz: b4f5e74955365a5184b90ea2ce877b0f548e55da5a9eb55e1f92ad64e66f0426397fb441ccda7d4a678ec5c9acb2b4f782c0185fdbe511139b53087b0e6e0a05

data/.github/workflows/test.yml

@@ -18,5 +18,3 @@ jobs:
       - uses: r7kamura/rubocop-problem-matchers-action@v1
       - run: bundle exec rubocop --parallel
       - run: bundle exec rspec --force-color
-
-

data/.rubocop.yml

@@ -1,4 +1,8 @@
+require:
+  - rubocop-rspec
+
 AllCops:
+  NewCops: enable
   TargetRubyVersion: 2.5
 
 Lint/SuppressedException:
@@ -7,8 +11,20 @@ Lint/SuppressedException:
 Metrics:
   Enabled: false
 
+RSpec/ImplicitSubject:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 
 Style/TrailingCommaInArguments:
   Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false

data/CHANGELOG.md

@@ -7,6 +7,52 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## 0.8.0 - 2020-11-25
+
+### Added
+
+- Add page description for writing channel description.
+
+### Changed
+
+- Change channel link content from feeds index URL to page URL.
+
+## 0.7.2 - 2020-11-25
+
+### Fixed
+
+- Fix time parse error by HTML entities handling.
+
+## 0.7.1 - 2020-11-25
+
+### Fixed
+
+- Fix error when no title element found.
+
+## 0.7.0 - 2020-11-23
+
+### Added
+
+- Convert JSON response into XML.
+
+### Fixed
+
+- Fix bug that item_description_selector is not used.
+
+## 0.6.1 - 2020-11-15
+
+### Changed
+
+- Require hibana 0.2 or later.
+
+### Fixed
+
+- Fix installation error caused by hanami-router version restriction.
+
+### Removed
+
+- Remove direct dependency on hanami-router.
+
 ## 0.6.0 - 2020-11-15
 
 ### Changed

data/Gemfile

@@ -9,4 +9,5 @@ gem 'rack-test'
 gem 'rake', '~> 12.0'
 gem 'rspec'
 gem 'rubocop'
+gem 'rubocop-rspec'
 gem 'webmock'

data/Gemfile.lock

@@ -1,10 +1,12 @@
 PATH
   remote: .
   specs:
-    weneedfeed (0.6.0)
+    weneedfeed (0.8.0)
+      activesupport
+      builder
       faraday
-      hanami-router (= 2.0.0.alpha3)
-      hibana
+      faraday_middleware
+      hibana (>= 0.2)
       nokogiri
       rack-capture (>= 0.4.0)
       thor
@@ -12,25 +14,38 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.1)
+    builder (3.2.4)
+    concurrent-ruby (1.1.7)
     crack (0.4.4)
     diff-lcs (1.4.4)
     faraday (1.1.0)
       multipart-post (>= 1.2, < 3)
       ruby2_keywords
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
     hanami-router (2.0.0.alpha3)
       mustermann (~> 1.0)
       mustermann-contrib (~> 1.0)
       rack (~> 2.0)
     hansi (0.2.0)
     hashdiff (1.0.1)
-    hibana (0.1.1)
-      hanami-router
+    hibana (0.2.0)
+      hanami-router (>= 2.0.0.alpha3)
       rack
       tilt
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
     mini_portile2 (2.4.0)
+    minitest (5.14.2)
     multipart-post (2.1.1)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
@@ -39,7 +54,7 @@ GEM
       mustermann (= 1.1.1)
     nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
-    parallel (1.19.2)
+    parallel (1.20.1)
     parser (2.7.2.0)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
@@ -65,26 +80,33 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.4)
-    rubocop (1.0.0)
+    rubocop (1.4.0)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8)
       rexml
-      rubocop-ast (>= 0.6.0)
+      rubocop-ast (>= 1.1.1)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.1.0)
+    rubocop-ast (1.1.1)
       parser (>= 2.7.1.5)
+    rubocop-rspec (2.0.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.10.1)
     ruby2_keywords (0.0.2)
     thor (1.0.1)
+    thread_safe (0.3.6)
     tilt (2.0.10)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
     webmock (3.9.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.4.1)
 
 PLATFORMS
   ruby
@@ -94,6 +116,7 @@ DEPENDENCIES
   rake (~> 12.0)
   rspec
   rubocop
+  rubocop-rspec
   webmock
   weneedfeed!
 

data/README.md

@@ -34,7 +34,8 @@ You need to write a schema file named with `weneedfeed.yml` to use this gem.
 ```yaml
 pages:
   - id: example1
-    title: Example feed with CSS Selector
+    title: Example 1
+    description: Example feed with CSS Selector
     url: http://example.com/1
     item_selector: li
     item_description_selector: p:nth-child(3)
@@ -42,7 +43,8 @@ pages:
     item_time_selector: time
     item_title_selector: p:nth-child(2)
   - id: example2
-    title: Example feed with XPath
+    title: Example 2
+    description: Example feed with XPath
     url: http://example.com/2
     item_selector: //li
     item_description_selector: .//p[3]
@@ -56,7 +58,7 @@ pages:
 Feed ID.
 
 - required
-- Used for feed URL.
+- Used for feed URL and `<link>` element in `<channel>` element.
 
 ### `title`
 
@@ -65,6 +67,13 @@ Feed title.
 - required
 - Used for RSS `<title>` element in `<channel>` element.
 
+### `description`
+
+Feed description.
+
+- optional
+- Used for RSS `<description>` element in `<channel>` element.
+
 ### `url`
 
 HTML source URL.

data/lib/weneedfeed.rb

@@ -7,6 +7,7 @@ module Weneedfeed
   autoload :Capture, 'weneedfeed/capture'
   autoload :Command, 'weneedfeed/command'
   autoload :Controllers, 'weneedfeed/controllers'
+  autoload :FaradayResponseMiddleware, 'weneedfeed/faraday_response_middleware'
   autoload :Helpers, 'weneedfeed/helpers'
   autoload :Item, 'weneedfeed/item'
   autoload :Page, 'weneedfeed/page'

data/lib/weneedfeed/controllers/show_feed.rb

@@ -11,6 +11,7 @@ module Weneedfeed
         end
 
         scraping = ::Weneedfeed::Scraping.new(
+          description: page_schema.description,
           item_description_selector: page_schema.item_description_selector,
           item_link_selector: page_schema.item_link_selector,
           item_time_selector: page_schema.item_time_selector,

data/lib/weneedfeed/faraday_response_middleware.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/array/conversions'
+require 'active_support/core_ext/hash/conversions'
+require 'faraday'
+require 'faraday_middleware/response_middleware'
+require 'json'
+
+module Weneedfeed
+  class FaradayResponseMiddleware < ::FaradayMiddleware::ResponseMiddleware
+    define_parser do |body, options|
+      options ||= {}
+      options = { dasherize: false }.merge(options)
+      object = ::JSON.parse(body)
+      object.to_xml(options)
+    end
+
+    # @note Overriding.
+    def parse_response?(env)
+      env.response.headers['Content-Type'].to_s.include?('application/json')
+    end
+  end
+end

data/lib/weneedfeed/item.rb

@@ -48,10 +48,21 @@ module Weneedfeed
     def link
       ::URI.join(
         @url,
-        @node.at(@link_selector)['href']
+        link_path_or_url
       ).to_s
     end
 
+    # @return [Nokogiri::Node, nil]
+    def link_node
+      @node.at(@link_selector)
+    end
+
+    # @return [String, nil]
+    def link_path_or_url
+      node = link_node
+      node['href'] || node.inner_text
+    end
+
     # @return [Time, nil]
     def time
       return unless @time_selector
@@ -62,9 +73,9 @@ module Weneedfeed
       self.class.parse_time(string)
     end
 
-    # @return [String]
+    # @return [String, nil]
     def title
-      @node.at(@title_selector).inner_text
+      @node.at(@title_selector)&.inner_text
     end
 
     private
@@ -79,7 +90,7 @@ module Weneedfeed
       node = time_node
       return unless node
 
-      node['datetime'] || node.inner_html
+      node['datetime'] || node.inner_text
     end
   end
 end

data/lib/weneedfeed/page.rb

@@ -2,12 +2,16 @@
 
 module Weneedfeed
   class Page
+    # @return [String, nil]
+    attr_reader :description
+
     # @return [String]
     attr_reader :title
 
     # @return [String]
     attr_reader :url
 
+    # @param [String, nil] description
     # @param [String, nil] item_description_selector
     # @param [String] item_link_selector
     # @param [String, nil] item_time_selector
@@ -17,6 +21,7 @@ module Weneedfeed
     # @param [String] title
     # @param [String] url
     def initialize(
+      description:,
       item_description_selector:,
       item_link_selector:,
       item_time_selector:,
@@ -26,6 +31,7 @@ module Weneedfeed
       title:,
       url:
     )
+      @description = description
       @item_description_selector = item_description_selector
       @item_link_selector = item_link_selector
       @item_time_selector = item_time_selector

data/lib/weneedfeed/page_schema.rb

@@ -2,6 +2,7 @@
 
 module Weneedfeed
   PageSchema = Struct.new(
+    :description,
     :id,
     :item_description_selector,
     :item_link_selector,

data/lib/weneedfeed/schema.rb

@@ -24,7 +24,9 @@ module Weneedfeed
     def page_schemata
       @raw['pages'].map do |hash|
         ::Weneedfeed::PageSchema.new(
+          description: hash['description'],
           id: hash['id'],
+          item_description_selector: hash['item_description_selector'],
           item_link_selector: hash['item_link_selector'],
           item_time_selector: hash['item_time_selector'],
           item_title_selector: hash['item_title_selector'],

data/lib/weneedfeed/scraping.rb

@@ -5,6 +5,16 @@ require 'nokogiri'
 
 module Weneedfeed
   class Scraping
+    class << self
+      # @return [Faraday::Connection]
+      def faraday_connection
+        @faraday_connection ||= ::Faraday.new do |connection|
+          connection.use ::Weneedfeed::FaradayResponseMiddleware
+        end
+      end
+    end
+
+    # @param [String, nil] description
     # @param [String, nil] item_description_selector
     # @param [String] item_link_selector
     # @param [String, nil] item_time_selector
@@ -13,6 +23,7 @@ module Weneedfeed
     # @param [String] title
     # @param [String] url
     def initialize(
+      description:,
       item_description_selector:,
       item_link_selector:,
       item_time_selector:,
@@ -21,6 +32,7 @@ module Weneedfeed
       title:,
       url:
     )
+      @description = description
       @item_description_selector = item_description_selector
       @item_link_selector = item_link_selector
       @item_time_selector = item_time_selector
@@ -33,6 +45,7 @@ module Weneedfeed
     # @return [Weneedfeed::Page]
     def call
       ::Weneedfeed::Page.new(
+        description: @description,
         node: parsed_body,
         item_description_selector: @item_description_selector,
         item_selector: @item_selector,
@@ -48,12 +61,12 @@ module Weneedfeed
 
     # @return [Nokogiri::Node]
     def parsed_body
-      ::Nokogiri::HTML.parse(response.body)
+      ::Nokogiri::XML.parse(response.body)
     end
 
     # @return [Faraday::Response]
     def response
-      ::Faraday.get(@url)
+      self.class.faraday_connection.get(@url)
     end
   end
 end

data/lib/weneedfeed/version.rb

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

data/templates/show_feed.xml.erb

@@ -4,9 +4,9 @@
   xmlns:content="http://purl.org/rss/1.0/modules/content/">
   <channel>
     <title><![CDATA[<%= @page.title %>]]></title>
-    <link><%= "#{request.base_url}#{top_page_path}" %></link>
+    <link><%= "#{@page.url}" %></link>
     <atom:link href="<%= "#{request.base_url}#{request.path}" %>" rel="self"/>
-    <description><![CDATA[Recent content on <%= @page.title %>]]></description>
+    <description><![CDATA[<%= @page.description %>]]></description>
     <lastBuildDate><%= Time.now.rfc822 %></lastBuildDate>
     <% items.each do |item| %>
     <item>

data/weneedfeed.gemspec

@@ -25,9 +25,11 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'builder'
   spec.add_runtime_dependency 'faraday'
-  spec.add_runtime_dependency 'hanami-router', '2.0.0.alpha3'
-  spec.add_runtime_dependency 'hibana'
+  spec.add_runtime_dependency 'faraday_middleware'
+  spec.add_runtime_dependency 'hibana', '>= 0.2'
   spec.add_runtime_dependency 'nokogiri'
   spec.add_runtime_dependency 'rack-capture', '>= 0.4.0'
   spec.add_runtime_dependency 'thor'

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: weneedfeed
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-15 00:00:00.000000000 Z
+date: 2020-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,21 +25,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hanami-router
+  name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0.alpha3
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0.alpha3
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: hibana
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hibana
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +151,7 @@ files:
 - lib/weneedfeed/controllers/base.rb
 - lib/weneedfeed/controllers/show_feed.rb
 - lib/weneedfeed/controllers/show_top_page.rb
+- lib/weneedfeed/faraday_response_middleware.rb
 - lib/weneedfeed/helpers.rb
 - lib/weneedfeed/helpers/parameters.rb
 - lib/weneedfeed/item.rb