mako_rss 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb8b5a3c394b989b9722f6ae04b6373d23ba7e08
-  data.tar.gz: 11efdfb201da11cf3ec348d84ae41c639c7a52a8
+  metadata.gz: 770630990cc3595bb157dee7f3d764d6a91b4e92
+  data.tar.gz: add1706141f24d42b880ae7f0b2ab819c2eeed60
 SHA512:
-  metadata.gz: a7603d695ded87c83719c2cd159d4e33f85878525fdd29c597c6a6fd033148c7e7a3add809f824c6e544634b196b109b3a1ada4d8cb0fcb5b6a44f7c93751f99
-  data.tar.gz: 0ba4e36181aa8dd232ad7f83fb3960dba146c136095cd0e875e0547a262aee1ceb80980e2a98a886a1534bb000bfd5259df3e77815ea87c0da2f8ea1bec675d9
+  metadata.gz: 58295d6d252e28a6ed94bbac881d2b35ea69f81cb965ede92c3f32598fb5201596f5b610a3d1e54b0ca4c2ed1828bc08f8a05edde5d4345ce30505cf76598796
+  data.tar.gz: 066590c44fb0fb8a6660f8085aa9bc24cd33986f82bacb0688522a590ed1292c67f8cd1f988b59768dc81cf7c45d1ee538412c63bfcb9524db3a8e0fb62c3070

data/.rubocop_todo.yml

@@ -1,21 +1,22 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-06-06 16:33:49 -0400 using RuboCop version 0.35.1.
+# on 2017-07-11 13:25:18 -0400 using RuboCop version 0.49.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
+# Offense count: 4
 Metrics/AbcSize:
-  Max: 26
+  Max: 28
 
-# Offense count: 37
-# Configuration parameters: AllowURI, URISchemes.
+# Offense count: 40
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
 Metrics/LineLength:
   Max: 629
 
-# Offense count: 5
+# Offense count: 8
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 25
@@ -25,8 +26,7 @@ Style/AccessorMethodName:
   Exclude:
     - 'lib/mako/core.rb'
 
-# Offense count: 22
-# Configuration parameters: Exclude.
+# Offense count: 25
 Style/Documentation:
   Enabled: false
 

data/README.md

@@ -13,7 +13,7 @@ I designed Mako with the following principals in mind:
 
 To install Mako, do:
 
-    $ gem install mako
+    $ gem install mako_rss
 
 Once the gem is installed, you'll need to generate a new Mako site.  You can do
 this in 1 of 2 ways.  
@@ -62,6 +62,18 @@ Whichever you choose, place the file in the root directory and be sure its name
 is `subscriptions`.  The file extension (`.xml`/`.opml`, `.json`, or `.txt`)
 will tell Mako what kind of subscription file you have.
 
+## Subscribing to Additional Feeds
+
+If you already have imported your subscription file, and subsequently want to
+subscribe to additional feeds, Mako has a handy `subscribe` command to help you
+out.
+
+    $ mako subscribe [url or urls]
+
+It's generally best if you use the root URL of the site you would like to
+subscribe to, such as https://jonathanpike.net.  Mako will look at the site,
+find a feed URL if it can, and add that URL to your subscription file.  Easy!
+
 ## Configuration
 
 Mako has very few configuration options.  You can see all of them in the

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/testtask'
 require 'rubocop/rake_task'
 
 Rake::TestTask.new do |t|
-  t.pattern = 'test/*_test.rb'
+  t.pattern = 'test/**/*_test.rb'
 end
 
 RuboCop::RakeTask.new(:rubocop)

data/lib/mako.rb

@@ -3,7 +3,7 @@
 require 'time'
 require 'erb'
 require 'logger'
-require 'faraday'
+require 'httparty'
 require 'feedjira'
 require 'nokogiri'
 require 'json'
@@ -16,10 +16,12 @@ require_relative 'mako/mako_logger'
 require_relative 'mako/view_helpers'
 require_relative 'mako/configuration'
 require_relative 'mako/subscription_list_parser'
+require_relative 'mako/subscription_list_writer'
 require_relative 'mako/feed'
 require_relative 'mako/article'
 require_relative 'mako/feed_requester'
 require_relative 'mako/feed_constructor'
+require_relative 'mako/feed_finder'
 require_relative 'mako/html_renderer'
 require_relative 'mako/sass_renderer'
 require_relative 'mako/writer'

data/lib/mako/cli.rb

@@ -2,11 +2,12 @@
 
 require_relative 'commands/build'
 require_relative 'commands/new'
+require_relative 'commands/subscribe'
 require_relative 'commands/version'
 
 module Mako
   class CLI
-    COMMANDS = %w[build new version].freeze
+    COMMANDS = %w[build new subscribe version].freeze
 
     # Takes ARGV and parses the first element (command) to see if it is
     # in the commands array.  If not, display help.
@@ -24,6 +25,7 @@ module Mako
           Subcommands:
             new       Create a new Mako scaffold in PATH.  If no PATH provided, defaults to current directory.
             build     Build your Mako site. Default: only build HTML.
+            subscribe Subscribe to the supplied URL or URLs.  Accepts a list separated by spaces.
             version   Display the version.
 
           Options:

data/lib/mako/commands/subscribe.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Mako
+  class Subscribe
+    def self.perform(args)
+      if args.empty?
+        Mako.errors.add_error 'No feeds to find'
+        return
+      end
+      feeds = Mako::FeedFinder.new(uris: args).find
+      write_to_subscriptions(feeds)
+    end
+
+    def self.write_to_subscriptions(feed_urls)
+      path = File.expand_path(Dir.glob('subscriptions.*').first, Dir.pwd)
+      Mako::SubscriptionListWriter.new(feeds: feed_urls, destination: path).append_and_write
+    end
+  end
+end

data/lib/mako/feed_finder.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Mako
+  class FeedFinder
+    # Patterns for RSS, Atom, and JSON feeds
+    XPATHS = ["//link[@rel='alternate'][@type='application/rss+xml']/@href",
+              "//link[@rel='alternate'][@type='application/atom+xml']/@href",
+              "//link[@rel='alternate'][@type='application/json']/@href"].freeze
+    MIME_TYPES = ['text/xml',
+                  'application/xml',
+                  'application/rss+xml',
+                  'application/atom+xml',
+                  'application/json'].freeze
+
+    attr_reader :uris
+
+    def initialize(args)
+      @uris = args.fetch(:uris)
+    end
+
+    # From an array of supplied URIs, will request each one and attempt to
+    # find a feed URI on the page.  If one is found, it will be added to
+    # an array and returned.
+    #
+    # @return [Array]
+    def find
+      request_uris.map do |request|
+        if request[:body].nil?
+          request[:uri]
+        else
+          html = Nokogiri::HTML(request[:body])
+          potential_feed_uris = html.xpath(XPATHS.detect { |path| !html.xpath(path).empty? })
+          next if potential_feed_uris.empty?
+          uri_string = potential_feed_uris.first.value
+          feed_uri = URI.parse(uri_string)
+          if request[:uri].host == feed_uri.host
+            feed_uri.to_s
+          else
+            request[:uri].merge(feed_uri).to_s
+          end
+        end
+      end.compact
+    end
+
+    private
+
+    # @private
+    # Make requests for each URI passed in and return an array of hashes
+    # with either just the URI (in the case that the URI passed in was already
+    # a feed URI), or the URI and the response body.
+    #
+    # @return [Array]
+    def request_uris
+      uris.map do |uri|
+        parsed_uri = URI.parse(uri)
+        # Try giving the URI a scheme if one isn't passed
+        parsed_uri = URI.parse('http://' + uri) if parsed_uri.scheme.nil?
+        request = Mako::FeedRequester.new(feed_url: parsed_uri).fetch
+        next unless request.ok?
+        if MIME_TYPES.include? request.headers['content-type'].split(';').first
+          { uri: parsed_uri.to_s }
+        else
+          { uri: parsed_uri, body: request.body }
+        end
+      end.compact
+    end
+  end
+end

data/lib/mako/feed_requester.rb

@@ -3,11 +3,12 @@
 module Mako
   class FeedRequester
     attr_reader :feed_url
-    attr_accessor :ok, :body
+    attr_accessor :ok, :body, :headers
 
     def initialize(args)
       @ok = true
       @body = ''
+      @headers = {}
       @feed_url = args.fetch(:feed_url)
     end
 
@@ -18,17 +19,18 @@ module Mako
     # @return [Mako::FeedRequester]
     def fetch
       begin
-        request = Faraday.get(feed_url)
-      rescue Faraday::Error
+        request = HTTParty.get(feed_url)
+      rescue SocketError
         Mako.errors.add_error "Could not complete request to #{feed_url}."
         self.ok = false
         return self
       end
-      unless request.status == 200
-        Mako.errors.add_error "Request to #{feed_url} returned #{request.status}."
+      unless request.code == 200
+        Mako.errors.add_error "Request to #{feed_url} returned #{request.code}."
         self.ok = false
         return self
       end
+      self.headers = request.headers
       self.body = request.body
       self
     end

data/lib/mako/subscription_list_parser.rb

@@ -14,15 +14,21 @@ module Mako
     #
     # @return [Array]
     def parse
-      loaded_list = load_resource(list)
       case File.extname list
       when '.xml' || '.opml'
-        Nokogiri::XML(loaded_list).xpath('//@xmlUrl').map(&:value)
+        Nokogiri::XML(load_list).xpath('//@xmlUrl').map(&:value)
       when '.json'
-        JSON.parse(loaded_list)
+        JSON.parse(load_list)
       when '.txt'
-        loaded_list.split("\n")
+        load_list.split("\n")
       end
     end
+
+    # Load the subscription list file
+    #
+    # @return [String]
+    def load_list
+      load_resource(list)
+    end
   end
 end

data/lib/mako/subscription_list_writer.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Mako
+  class SubscriptionListWriter
+    include FileOpenUtil
+
+    attr_reader :feeds, :destination
+
+    def initialize(args)
+      @feeds = args.fetch(:feeds)
+      @destination = args.fetch(:destination)
+    end
+
+    # Appends the new subscriptions to the subscription list and
+    # writes the results out to the file.
+    def append_and_write
+      contents = append_and_render
+      File.open(destination, 'w+', encoding: 'utf-8') do |f|
+        f.write(contents)
+      end
+    end
+
+    private
+
+    # @private
+    # Returns the rendered string for the correct file type.
+    #
+    # @return [String]
+    def append_and_render
+      loaded_list = SubscriptionListParser.new(list: destination)
+      case File.extname destination
+      when '.xml' || '.opml'
+        render_opml(loaded_list)
+      when '.json'
+        render_json(loaded_list)
+      when '.txt'
+        render_txt(loaded_list)
+      end
+    end
+
+    # Append feeds to current subscription list and return a string separated
+    # by \n characters
+    #
+    # @return [String]
+    def render_txt(list)
+      (list.parse + feeds).join("\n")
+    end
+
+    # Append feeds to current subscription list and return a JSON array
+    #
+    # @return [String]
+    def render_json(list)
+      (list.parse + feeds).to_json
+    end
+
+    # Append feeds to current subscription list and return XML document
+    #
+    # @return [String]
+    def render_opml(list)
+      document = Nokogiri::XML(list.load_list)
+      feeds.each do |feed_url|
+        node = "<outline xmlUrl='#{feed_url}' />\n"
+        document.xpath("//outline[@text='Subscriptions']").last.add_child node
+      end
+      formatted_no_decl = Nokogiri::XML::Node::SaveOptions::FORMAT +
+                          Nokogiri::XML::Node::SaveOptions::NO_DECLARATION
+      document.to_xml(encoding: 'utf-8', save_with: formatted_no_decl)
+    end
+  end
+end

data/lib/mako/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mako
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/templates/Gemfile

@@ -2,4 +2,4 @@
 
 source 'https://rubygems.org'
 
-gem 'mako'
+gem 'mako_rss'

data/mako_rss.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'coveralls', '~> 0.8'
 
   spec.add_runtime_dependency 'feedjira', '~> 2.0'
-  spec.add_runtime_dependency 'faraday', '~> 0.12'
+  spec.add_runtime_dependency 'httparty', '~> 0.15'
   spec.add_runtime_dependency 'nokogiri', '~> 1.8'
   spec.add_runtime_dependency 'sass', '~> 3.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mako_rss
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jonathan Pike
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-19 00:00:00.000000000 Z
+date: 2017-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,19 +109,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.15'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -174,6 +174,7 @@ files:
 - lib/mako/commands/build.rb
 - lib/mako/commands/new.rb
 - lib/mako/commands/schedule.rb
+- lib/mako/commands/subscribe.rb
 - lib/mako/commands/version.rb
 - lib/mako/configuration.rb
 - lib/mako/core.rb
@@ -183,6 +184,7 @@ files:
 - lib/mako/errors.rb
 - lib/mako/feed.rb
 - lib/mako/feed_constructor.rb
+- lib/mako/feed_finder.rb
 - lib/mako/feed_requester.rb
 - lib/mako/file_open_util.rb
 - lib/mako/html_renderer.rb
@@ -190,6 +192,7 @@ files:
 - lib/mako/mako_logger.rb
 - lib/mako/sass_renderer.rb
 - lib/mako/subscription_list_parser.rb
+- lib/mako/subscription_list_writer.rb
 - lib/mako/version.rb
 - lib/mako/view_helpers.rb
 - lib/mako/writer.rb