rssable 0.0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd99535f844b27a604a0ae97f648807976045c7350dc536312a50f77ed438446
+  data.tar.gz: 0a6d02f9f66a54959f41d3e912c40e7ee7b91b73039113cdcde1707e1b9be682
+SHA512:
+  metadata.gz: 9a19230d6acf341655b659f49b8bc0d8421a2e2f487174877db6e56fc587fc9303c559d3bd0be4c8a33033592dfc1d55d51d30e15dc47e22f4d9b2897f256be0
+  data.tar.gz: 77af58376a4f40ad9fdfadcf4ec2a9f78c01336bf97940945b10cf5086e5929a94763b0209c0463d37b1970c23c3342b484872915a970cd0e4486d5a6f273976

data/lib/rssable/detection/engine_detector.rb

@@ -0,0 +1,47 @@
+module RSSable
+  module Detection
+    class EngineDetector
+      MAPPINGS = {
+        blogger: /\/feeds\/posts\/default\?alt\=rss$/,
+        wordpress: /\/feed\/$/,
+        medium: /medium\.com\/feed\//
+      }
+
+      # It returns array of RSS feed link and the driver
+      # If feed link is not found it returns blank array
+      # If the provider is not detected it returns :default
+      #
+      # @return [Array]
+      def self.call(urls:, source_url:)
+        result = nil
+
+        urls.each do |url|
+          result = if url.match(MAPPINGS[:blogger])
+            [url, :blogger]
+          elsif url.match(MAPPINGS[:wordpress]) && url.match(/\/comments\//).nil?
+            [url, :wordpress]
+          elsif url.match(MAPPINGS[:medium])
+            [url, :medium]
+          elsif url == "/feed.xml"
+            parsed_url = URI.join(source_url, "/feed.xml")
+            [parsed_url.to_s, :jekyll]
+          end
+
+          break unless result.nil?
+        end
+
+        return result unless result.nil?
+
+        if urls.size != 0
+          [urls.first, :default]
+        else
+          []
+        end
+      end
+
+      private
+
+      attr_reader :urls
+    end
+  end
+end

data/lib/rssable/detection/feed_finder.rb

@@ -0,0 +1,15 @@
+module RSSable
+  module Detection
+    class FeedFinder
+      # It returns array of RSS feed links for given URL
+      #
+      # @return [Array<String>]
+      def self.call(url:)
+        response = RestClient.get(url)
+        html = Nokogiri::HTML(response.body)
+
+        html.css("link[type='application/rss+xml']").map { |node| node[:href] }
+      end
+    end
+  end
+end

data/lib/rssable/parsers/channel.rb

@@ -0,0 +1,53 @@
+module RSSable
+  module Parsers
+    class Channel
+
+      def initialize(feed:, driver:)
+        @feed = feed
+        @driver = driver
+      end
+
+      # Returns the RSS feed title
+      #
+      # @return [String]
+      def title
+        xml.xpath("//channel").at("title").text
+      end
+
+      # Returns the RSS feed description
+      #
+      # @return [String]
+      def description
+        xml.xpath("//channel").at("description").text
+      end
+
+      # Returns the website link
+      #
+      # @return [String]
+      def link
+        xml.xpath("//channel").at("link").text
+      end
+
+      # Returns a collection of the RSS feed items
+      #
+      # @return [Array]
+      def items
+        xml.css("item").map { |node| item_class.new(node) }
+      end
+
+      private
+
+      attr_reader :feed, :driver
+
+      def xml
+        @xml ||= Nokogiri::XML(feed)
+      end
+
+      def item_class
+        @item_class ||= ::RSSable::Parsers::ItemClassBuilder.call(
+          driver: driver
+        )
+      end
+    end
+  end
+end

data/lib/rssable/parsers/item_class_builder.rb

@@ -0,0 +1,21 @@
+module RSSable
+  module Parsers
+    class ItemClassBuilder
+      # Returns the parser class for the given driver
+      #
+      # @return [Class]
+      def self.call(driver:)
+        case driver
+        when :wordpress
+          RSSable::Parsers::Items::Wordpress
+        when :blogger
+          RSSable::Parsers::Items::Blogger
+        when :medium
+          RSSable::Parsers::Items::Medium
+        else
+          RSSable::Parsers::Items::Base
+        end
+      end
+    end
+  end
+end

data/lib/rssable/parsers/items/base.rb

@@ -0,0 +1,66 @@
+module RSSable
+  module Parsers
+    module Items
+      class Base
+        def initialize(node)
+          @node = node
+        end
+
+        # Returns the item title
+        #
+        # @return [String]
+        def title
+          node_text(node.at("title"))
+        end
+
+        # Returns the item link
+        #
+        # @return [String]
+        def link
+          node_text(node.at("link"))
+        end
+
+        # Returns the item publication date
+        #
+        # @return [String]
+        def published_at
+          node_text(node.at("pubDate"))
+        end
+
+        # Returns the item description
+        #
+        # @return [String]
+        def description
+          node_text(node.at("description"))
+        end
+
+        # Returns an array of the item categories
+        #
+        # @return [Array<String>]
+        def tags
+          node.css("category").map(&:text)
+        end
+
+        # Returns the article author
+        #
+        # @return [String]
+        def author
+          node_text(node.at("author"))
+        end
+
+        # Returns nil by the default
+        #
+        # @return [NilClass]
+        def comments_count; end
+
+        private
+
+        attr_reader :node
+
+        def node_text(node)
+          node.text unless node.nil?
+        end
+      end
+    end
+  end
+end

data/lib/rssable/parsers/items/blogger.rb

@@ -0,0 +1,18 @@
+module RSSable
+  module Parsers
+    module Items
+      class Blogger < RSSable::Parsers::Items::Base
+
+        # Returns the comments count
+        # If the comments count node does not exist it returns nil
+        #
+        # @return [Integer]
+        def comments_count
+          count = node_text(node.at_xpath("//thr:total"))
+          count.to_i unless count.nil?
+        end
+
+      end
+    end
+  end
+end

data/lib/rssable/parsers/items/medium.rb

@@ -0,0 +1,23 @@
+module RSSable
+  module Parsers
+    module Items
+      class Medium < RSSable::Parsers::Items::Base
+
+        # Returns the article author
+        #
+        # @return [String]
+        def author
+          creator_node = node.elements.find { |c| c.name == "creator" }
+          node_text(creator_node)
+        end
+
+        # Returns the article description
+        #
+        # @return [String]
+        def description
+          node_text(node.at_xpath("//content:encoded"))
+        end
+      end
+    end
+  end
+end

data/lib/rssable/parsers/items/wordpress.rb

@@ -0,0 +1,25 @@
+module RSSable
+  module Parsers
+    module Items
+      class Wordpress < RSSable::Parsers::Items::Base
+
+        # Returns the article author
+        #
+        # @return [String]
+        def author
+          creator_node = node.elements.find { |c| c.name == "creator" }
+          node_text(creator_node)
+        end
+
+        # Returns the comments count
+        # If the comments count node does not exist it returns nil
+        #
+        # @return [Integer]
+        def comments_count
+          count = node_text(node.at_xpath("//slash:comments"))
+          count.to_i unless count.nil?
+        end
+      end
+    end
+  end
+end

data/lib/rssable/processor.rb

@@ -0,0 +1,22 @@
+module RSSable
+  class Processor
+    def self.call(url:)
+      # Returns the RSSable::Parsers::Channel instance
+      # If the feed URL is not detected it returns nil
+      #
+      # @return [RSSable::Parsers::Channel]
+      urls = RSSable::Detection::FeedFinder.call(url: url)
+      feed_url, driver = RSSable::Detection::EngineDetector.call(
+        urls: urls, source_url: url
+      )
+
+      return if feed_url.nil?
+
+      response = RestClient.get(feed_url)
+
+      RSSable::Parsers::Channel.new(
+        feed: response.body, driver: driver
+      )
+    end
+  end
+end

data/lib/rssable/version.rb

@@ -0,0 +1,12 @@
+module RSSable
+  module Version
+    module_function
+
+    # Gem current version
+    #
+    # @return [String]
+    def to_s
+      "0.0.0.1"
+    end
+  end
+end

data/lib/rssable.rb

@@ -0,0 +1,23 @@
+require 'nokogiri'
+require 'rest-client'
+require 'URI'
+require 'rssable/detection/feed_finder'
+require 'rssable/detection/engine_detector'
+require 'rssable/parsers/items/base'
+require 'rssable/parsers/items/wordpress'
+require 'rssable/parsers/items/blogger'
+require 'rssable/parsers/items/medium'
+require 'rssable/parsers/item_class_builder'
+require 'rssable/parsers/channel'
+require 'rssable/processor'
+
+module RSSable
+  # Returns the channel driver instance
+  #
+  # @return [RSSable::Parsers::Channel]
+  def self.subscribe(url)
+    RSSable::Processor.call(
+      url: url
+    )
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: rssable
+version: !ruby/object:Gem::Version
+  version: 0.0.0.1
+platform: ruby
+authors:
+- Paweł Dąbrowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Access the RSS channel of any webiste without worrying about the engine
+email: dziamber@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rssable.rb
+- lib/rssable/detection/engine_detector.rb
+- lib/rssable/detection/feed_finder.rb
+- lib/rssable/parsers/channel.rb
+- lib/rssable/parsers/item_class_builder.rb
+- lib/rssable/parsers/items/base.rb
+- lib/rssable/parsers/items/blogger.rb
+- lib/rssable/parsers/items/medium.rb
+- lib/rssable/parsers/items/wordpress.rb
+- lib/rssable/processor.rb
+- lib/rssable/version.rb
+homepage: http://github.com/rubyhero/rssable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Access the RSS channel of any webiste without worrying about the engine
+test_files: []