weneedfeed 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2634d6a72650518bf2845381116e208a65fbb9f067b6e19f58352bb46ecb5ba
-  data.tar.gz: 1ccc6647e1a02d34af10460b34d5cd594eb5a184cbe18e2244d45637a38d9d96
+  metadata.gz: 3b2041bae9e09565e1b72a4799f8a57034ad73c139de460dc0d187a5b94dbbe2
+  data.tar.gz: 292b45f698fb86f8cd5632687210ab6c09cd74a6d6ad340bb6eb7b989ffc4e3a
 SHA512:
-  metadata.gz: 18d069fc8460e37e79b67869bd91f64d28f865d052c4464d6f169f811ad32c27698ccad3235f4b7f047160cd68341f56a576701758bb367d9766e9f8d46dc9c3
-  data.tar.gz: b4f5e74955365a5184b90ea2ce877b0f548e55da5a9eb55e1f92ad64e66f0426397fb441ccda7d4a678ec5c9acb2b4f782c0185fdbe511139b53087b0e6e0a05
+  metadata.gz: 8dc45d743eb961d6a18983b8c20340b1e4c2085c7ed1c348332bddb51c211aa2c5067211e789f9cdd192eb3b161602d63f304adc8421ade49210ce11396a0031
+  data.tar.gz: 60f284ba462f92130a3de4702e33ae3d73418a3057459b40656e75f0a27e8ad9bc8b67946b1137b590f38250d5dec695cdfe41cad58f96947cf0dc0885c2839b

data/.github/workflows/test.yml

@@ -7,14 +7,24 @@ on:
       - master
 
 jobs:
-  build:
-    runs-on: ubuntu-18.04
+  rspec:
+    runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: 2.7.2
+      - run: bundle exec rspec --force-color
+  rubocop:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
       - uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
           ruby-version: 2.7.2
       - uses: r7kamura/rubocop-problem-matchers-action@v1
       - run: bundle exec rubocop --parallel
-      - run: bundle exec rspec --force-color

data/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## 0.9.0 - 2020-12-03
+
+### Added
+
+- Add item_image_selector.
+
 ## 0.8.0 - 2020-11-25
 
 ### Added

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    weneedfeed (0.8.0)
+    weneedfeed (0.9.0)
       activesupport
       builder
       faraday
       faraday_middleware
       hibana (>= 0.2)
+      mimemagic
       nokogiri
       rack-capture (>= 0.4.0)
       thor
@@ -44,6 +45,7 @@ GEM
       tilt
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
+    mimemagic (0.3.5)
     mini_portile2 (2.4.0)
     minitest (5.14.2)
     multipart-post (2.1.1)
@@ -106,7 +108,7 @@ GEM
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.4.1)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -27,7 +27,7 @@ gem install weneedfeed
 
 ## Schema
 
-You need to write a schema file named with `weneedfeed.yml` to use this gem.
+Weneedfeed requires `weneedfeed.yml` that describes URLs and selectors.
 
 ### Example
 
@@ -39,6 +39,7 @@ pages:
     url: http://example.com/1
     item_selector: li
     item_description_selector: p:nth-child(3)
+    item_image_selector: img
     item_link_selector: a
     item_time_selector: time
     item_title_selector: p:nth-child(2)
@@ -47,6 +48,7 @@ pages:
     description: Example feed with XPath
     url: http://example.com/2
     item_selector: //li
+    item_image_selector: .//img
     item_description_selector: .//p[3]
     item_link_selector: .//a
     item_time_selector: .//time
@@ -109,6 +111,13 @@ CSS or XPath selector to find element with description information in each item.
 - optional
 - Used for `<description>` in `<item>`.
 
+### `item_image_selector`
+
+CSS or XPath selector to find `<img>`element in each item.
+
+- optional
+- Used for `<enclosure>` in `<item>`.
+
 ### `item_time_selector`
 
 CSS or XPath selector to find element with datetime information in each item.

data/lib/weneedfeed/controllers/show_feed.rb

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

data/lib/weneedfeed/item.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'mimemagic'
+
 module Weneedfeed
   class Item
     class << self
@@ -16,6 +18,7 @@ module Weneedfeed
     end
 
     # @param [String, nil] description_selector
+    # @param [String, nil] image_selector
     # @param [String, nil] link_selector
     # @param [Nokogiri::Node] node
     # @param [String] time_selector
@@ -23,6 +26,7 @@ module Weneedfeed
     # @param [String] url
     def initialize(
       description_selector:,
+      image_selector:,
       link_selector:,
       node:,
       time_selector:,
@@ -30,6 +34,7 @@ module Weneedfeed
       url:
     )
       @description_selector = description_selector
+      @image_selector = image_selector
       @link_selector = link_selector
       @node = node
       @time_selector = time_selector
@@ -44,6 +49,29 @@ module Weneedfeed
       @node.at(@description_selector)&.inner_html
     end
 
+    # @return [String, nil]
+    def image_mime_type
+      return unless image_url
+
+      ::MimeMagic.by_path(image_url)&.type
+    end
+
+    # @return [String, nil]
+    def image_path_or_url
+      return unless @image_selector
+
+      @node.at(@image_selector)&.[]('src')
+    end
+
+    def image_url
+      return unless image_path_or_url
+
+      ::URI.join(
+        @url,
+        image_path_or_url
+      ).to_s
+    end
+
     # @return [String]
     def link
       ::URI.join(

data/lib/weneedfeed/page.rb

@@ -13,6 +13,7 @@ module Weneedfeed
 
     # @param [String, nil] description
     # @param [String, nil] item_description_selector
+    # @param [String, nil] item_image_selector
     # @param [String] item_link_selector
     # @param [String, nil] item_time_selector
     # @param [String] item_title_selector
@@ -23,6 +24,7 @@ module Weneedfeed
     def initialize(
       description:,
       item_description_selector:,
+      item_image_selector:,
       item_link_selector:,
       item_time_selector:,
       item_title_selector:,
@@ -33,6 +35,7 @@ module Weneedfeed
     )
       @description = description
       @item_description_selector = item_description_selector
+      @item_image_selector = item_image_selector
       @item_link_selector = item_link_selector
       @item_time_selector = item_time_selector
       @item_title_selector = item_title_selector
@@ -47,6 +50,7 @@ module Weneedfeed
       @node.search(@item_selector).map do |node|
         ::Weneedfeed::Item.new(
           description_selector: @item_description_selector,
+          image_selector: @item_image_selector,
           link_selector: @item_link_selector,
           node: node,
           time_selector: @item_time_selector,

data/lib/weneedfeed/page_schema.rb

@@ -5,6 +5,7 @@ module Weneedfeed
     :description,
     :id,
     :item_description_selector,
+    :item_image_selector,
     :item_link_selector,
     :item_time_selector,
     :item_title_selector,

data/lib/weneedfeed/schema.rb

@@ -27,6 +27,7 @@ module Weneedfeed
           description: hash['description'],
           id: hash['id'],
           item_description_selector: hash['item_description_selector'],
+          item_image_selector: hash['item_image_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

@@ -16,6 +16,7 @@ module Weneedfeed
 
     # @param [String, nil] description
     # @param [String, nil] item_description_selector
+    # @param [String, nil] item_image_selector
     # @param [String] item_link_selector
     # @param [String, nil] item_time_selector
     # @param [String] item_title_selector
@@ -25,6 +26,7 @@ module Weneedfeed
     def initialize(
       description:,
       item_description_selector:,
+      item_image_selector:,
       item_link_selector:,
       item_time_selector:,
       item_title_selector:,
@@ -34,6 +36,7 @@ module Weneedfeed
     )
       @description = description
       @item_description_selector = item_description_selector
+      @item_image_selector = item_image_selector
       @item_link_selector = item_link_selector
       @item_time_selector = item_time_selector
       @item_title_selector = item_title_selector
@@ -48,6 +51,7 @@ module Weneedfeed
         description: @description,
         node: parsed_body,
         item_description_selector: @item_description_selector,
+        item_image_selector: @item_image_selector,
         item_selector: @item_selector,
         item_link_selector: @item_link_selector,
         item_time_selector: @item_time_selector,

data/lib/weneedfeed/version.rb

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

data/templates/show_feed.xml.erb

@@ -18,6 +18,9 @@
       <description><![CDATA[<%= item.description %>]]></description>
       <content:encoded><![CDATA[<%= item.description %>]]></content:encoded>
       <guid isPermaLink="true"><%= item.link %></guid>
+      <% if item.image_url %>
+        <enclosure url="<%= item.image_url %>" length="0" type="<%= item.image_mime_type %>"/>
+      <% end %>
     </item>
     <% end %>
   </channel>

data/weneedfeed.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'faraday'
   spec.add_runtime_dependency 'faraday_middleware'
   spec.add_runtime_dependency 'hibana', '>= 0.2'
+  spec.add_runtime_dependency 'mimemagic'
   spec.add_runtime_dependency 'nokogiri'
   spec.add_runtime_dependency 'rack-capture', '>= 0.4.0'
   spec.add_runtime_dependency 'thor'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weneedfeed
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-24 00:00:00.000000000 Z
+date: 2020-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  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: nokogiri
   requirement: !ruby/object:Gem::Requirement