rsscache 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 93d9d21a9a587043e1db22b3f64164308c755eee
-  data.tar.gz: 5e81b40fe30dc757fd46797d03bf670ba553206d
+SHA256:
+  metadata.gz: d7b8a75b9f765464f14794c0c83f576de028b66d3bd676cfcad0cbe146b2544d
+  data.tar.gz: 955f0ce59bd22e3974b95df6a19cd59e1a7cdcaaa0b269e8db33cd706db64eef
 SHA512:
-  metadata.gz: cfd87ca7214dde36963ee7a2bede8a41e1bf164a67159c688f93a34e83e80138a53f1d3a2eead31e1436bd9f4e12935333960e23a666982d1619743f077c8874
-  data.tar.gz: 7ac379f1d015f2a068616d4a0abd576124937c40cdf4e071bf7439580884ad384bcb428f72743f2e03f3eec6849291720865d439a80bccd90b836fa75e1a9f84
+  metadata.gz: a2113381445334a113e6461dd977ee58b0a382811f1454fca0cab627431945e4af1f813127d9fcf5381eb7dd1e0700581193e7daa00eb6706cad5e4b77509b0e
+  data.tar.gz: 4f745332d263530b6087ab344b0bdedbeff9d5eb59203fe94a8d589c377839050657dbfa5bb0f5fdeafc659e55630690c2b00d2aaac71bb048e2549e0ab703da

data/lib/rsscache.rb

@@ -1,36 +1,39 @@
 #!/usr/bin/env ruby
-# 
+
 # file: rsscache.rb
 
 require 'dynarex'
 require 'open-uri'
 require 'simple-rss'
-require 'fileutils'
 require 'timeout'
+require 'rxfreadwrite'
 
 
 class RSScache
-  
-  attr_reader :err_report
+  include RXFReadWrite
+
+  attr_reader :err_report, :dx
 
-  def initialize(rsslist, feedsfilepath='.', debug: true)
+  def initialize(rsslist=nil, filepath: '.', debug: false)
 
+    rsslist ||= File.join(filepath, 'rsscache.xml')
     @dx = open_dynarex(rsslist)
-    @rsslist, @feedsfilepath = rsslist, feedsfilepath
-    FileUtils.mkdir_p feedsfilepath
-    
+    @filepath = filepath
+    @cache_filepath = File.join(filepath, 'rsscache')
+    FileX.mkdir_p @cache_filepath
+
     @err_report = []
     @debug = debug
 
   end
-  
-  # Import a list of URLs into the Dynarex document. 
+
+  # Import a list of URLs into the Dynarex document.
   # URLs which already exist are ignored.
   #
   def import(raw_s)
-    
-    s, _ = RXFHelper.read(raw_s)
-    
+
+    s, _ = RXFReader.read(raw_s)
+
     s.strip.lines.each do |raw_url|
 
       url = raw_url.chomp
@@ -43,24 +46,24 @@ class RSScache
         puts 'new URL found' if @debug
         @dx.create url: url
       end
-      
-    end    
-    
-    save_dynarex()
+
+    end
+
+    save()
   end
 
   # refresh each RSS feed
   #
   def refresh
-    
+
     @err_report = []
 
     puts '@dx.to_xml'  + @dx.to_xml(pretty: true)  if @debug
-    
+
     @dx.all.each do |feed|
-      
+
       puts 'feed:' + feed.inspect if @debug
-      
+
       if feed.next_refresh.empty? or \
                              Time.now >= Time.parse(feed.next_refresh) then
 
@@ -68,7 +71,7 @@ class RSScache
 
         feed.refresh_rate = if feed.refresh_rate.empty? then
 
-          10 
+          10
 
         else
 
@@ -89,104 +92,140 @@ class RSScache
 
       end
     end
+
     puts '@dx: ' + @dx.to_xml(pretty: true) if @debug
-    save_dynarex()
+    save()
 
   end
 
   alias update refresh
 
-  def open_dynarex(x)
+  def save()
+
+    @dx.save File.join(@filepath, 'rsscache.xml')
+    FileX.write File.join(@filepath, 'rsscache.txt'), @dx.to_s
 
-    if x.lines.length == 1 and File.exists?(x) and \
-                                      File.extname(x) == '.txt' then
-      Dynarex.new.import x
-    else
-      Dynarex.new x
-    end
   end
 
-  def save_dynarex()
 
-    if @rsslist.lines.length == 1 and File.exists?(@rsslist)
+  private
 
-      if File.extname(@rsslist) == '.txt'then
+  def raw_doc(s)
 
-        File.write @rsslist, @dx.to_s
+    heading = '<?dynarex schema="rsscache[title]/feed(uid, title, ' +
+      'url, refresh_rate, next_refresh, filename)"?>'
 
-      else
+raw_dx=<<EOF
+#{heading}
+title: RSS Feeds to be cached
 
-        @dx.save
+--+
 
-      end
+#{s.strip.lines.map {|x| 'url: ' + x }.join }
+EOF
+
+  end
+
+  def fetch(url, timeout: 2)
 
+    puts 'inside fetch: url: '  + url.inspect if @debug
+
+    begin
+      Timeout::timeout(timeout){
+
+        buffer = URI.open(url).read.force_encoding("utf-8")
+        return [buffer, 200]
+      }
+    rescue Timeout::Error => e
+      ['connection timed out', 408]
+    rescue OpenURI::HTTPError => e
+      ['400 bad request', 400]
+    end
+
+  end
+
+  def open_dynarex(raw_s)
+
+    s, _ = RXFReader.read(raw_s)
+    puts 'inside open_dynarex s: ' + s.inspect if @debug
+
+    case s
+    when /^<?dynarex/
+      Dynarex.new.import s
+    when /^</
+      Dynarex.new s
+    else
+      Dynarex.new.import raw_doc(s)
     end
+
   end
 
-  # checks for any updates and saves the latest RSS file to 
-  #                                       the cache if there is
+  # checks for any updates and save the
+  # latest RSS file to the cache if there are updates
   #
   def updates?(feed)
 
     if @debug then
-      puts 'inside updates?' 
+      puts 'inside updates?'
       puts 'feed: ' + feed.inspect
     end
-    
+
     # fetch the feeds from the web
-    buffer, code = fetch(feed.url)
+    begin
+      buffer, code = fetch(feed.url)
+    rescue
+      puts 'RSScache::updates?: fetch() warning for feed ' + feed.url \
+          + ' ' + ($!).inspect
+      return
+    end
 
     if code == 200 then
-      rss = SimpleRSS.parse(buffer)
+      begin
+        rss = SimpleRSS.parse(buffer)
+      rescue
+        puts 'RSScache::updates?: err: 100 SimpleRSS warning for feed ' \
+            + feed.url + ' ' + ($!).inspect
+        return
+      end
     else
       @err_report << [feed.url, code]
       return false
     end
 
     if feed.filename.empty? then
-      
+
       filename = feed.url[6..-1].gsub(/\W+/,'').\
                           reverse.slice(0,40).reverse.downcase + '.xml'
       feed.filename = filename
 
     end
-    
-    rssfile = File.join(@feedsfilepath, feed.filename)
 
-    if File.exists? rssfile then
+    rssfile = File.join(@cache_filepath, feed.filename)
+
+    if FileX.exists? rssfile then
 
-      rss_cache = SimpleRSS.parse File.read(rssfile)
+      begin
+        rss_cache = SimpleRSS.parse FileX.read(rssfile)
+      rescue
+        puts 'RSScache::updates?: err: 200 SimpleRSS warning for feed ' \
+            + feed.url + ' ' + ($!).inspect
+        FileX.rm rssfile
+        return false
+      end
       new_rss_items = rss.items - rss_cache.items
-      (File.write rssfile, rss.source; return true) if new_rss_items.any?
-      
+      (FileX.write rssfile, rss.source; return true) if new_rss_items.any?
+
     else
 
-      File.write rssfile, rss.source
+      FileX.write rssfile, rss.source
       feed.title = rss.title if feed.title.empty?
 
       return true
-      
+
     end
-    
+
     return false
   end
-  
-  private
-  
-  def fetch(url, timeout: 2)
 
-    begin
-      Timeout::timeout(timeout){
 
-        buffer = open(url).read
-        return [buffer, 200]
-      }
-    rescue Timeout::Error => e
-      ['connection timed out', 408]
-    rescue OpenURI::HTTPError => e
-      ['400 bad request', 400]
-    end    
-    
-  end
-  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsscache
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - James Robertson
@@ -10,27 +10,32 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDXjCCAkagAwIBAgIBATANBgkqhkiG9w0BAQUFADAsMSowKAYDVQQDDCFnZW1t
-  YXN0ZXIvREM9amFtZXNyb2JlcnRzb24vREM9ZXUwHhcNMTgwMjA0MTUwMTQ0WhcN
-  MTkwMjA0MTUwMTQ0WjAsMSowKAYDVQQDDCFnZW1tYXN0ZXIvREM9amFtZXNyb2Jl
-  cnRzb24vREM9ZXUwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCc92mR
-  T6m1I0JF3lENRDv6liYXqJiStrmml5LWAEzI1kDXEXIeNziO9Jlo74rHwtrZxeJ0
-  vuPBwXwDsoLEz1uz94hq1cfgRXXrj6K9A5YA8fQAvsFyKqxaS3Dtg5heQbgv5DUl
-  p2dzrc057LaES5E5bdBmH2DVHoaHGyya17u4T2sz42gKkv3CURgRopj05JF3a0AZ
-  WFE/N1xbD7ioffsKuPbGds6eL1eYk0qajutC0KIaRUqiTgzaTmntS1mDdz7nJMRM
-  7bVGP3cI1XfAGj/IqqfnapgYsVurPw9pzYGgBgH3XT/lKZW+xWfxpzkZH/ydpaF9
-  XU61J04M6xm9pPMFAgMBAAGjgYowgYcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
-  HQYDVR0OBBYEFCTDqdNBDLPNgRVZx02eHi9sOV7vMCYGA1UdEQQfMB2BG2dlbW1h
-  c3RlckBqYW1lc3JvYmVydHNvbi5ldTAmBgNVHRIEHzAdgRtnZW1tYXN0ZXJAamFt
-  ZXNyb2JlcnRzb24uZXUwDQYJKoZIhvcNAQEFBQADggEBABRCQKjdYT2lYH/XVGjB
-  XabbdBuro3lsCqzm95wtF2qTyw60gNpXuP+FBbQbnf4YMrYe4N8+lDXdY6xs8KMP
-  F8CoEBQSS0FqX1p4PT+5IDFEq/5Mmu46P9ZTS3bC5jlClr+IyclMdWl8yElWfer8
-  1KXDv1bwr1yjhc0vgAmnnUzk+V9fgDHQf58sTPlDa1k0T396x+BJ3i0xnLTOi2iU
-  0sAYj5+mVEGRx284sLHwgieDyxrLQMdPhDBnx5pPgJaQCw8xMS1S8DSX4gQAj+PK
-  5tiFhikiYyE9RjMYlZVwdfKc9yEGPhxY2J3V8RufP3HE6GHrV2lk5d9yFVcEqq+q
-  T1k=
+  MIIEXjCCAsagAwIBAgIBATANBgkqhkiG9w0BAQsFADAsMSowKAYDVQQDDCFnZW1t
+  YXN0ZXIvREM9amFtZXNyb2JlcnRzb24vREM9ZXUwHhcNMjExMTE4MTk1NDM3WhcN
+  MjIxMTE4MTk1NDM3WjAsMSowKAYDVQQDDCFnZW1tYXN0ZXIvREM9amFtZXNyb2Jl
+  cnRzb24vREM9ZXUwggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQDl/WSn
+  rif0WGHmqi3lDo4hCKqsnTvQJFFBoYyGPd8nQPrXd1D6+o0B8qbihDaayk0itqVF
+  MAZpErc/X7G49/DsFHsCIggXezeu52Pjwos99kGla6qJoPUwP9uC4SMbUXrbfDOD
+  ONtkhEscM1vjZWfQketPUXxEpoQjQAgvEWP6JJ1wHIKf8zuxGgnOqXeyeMmI92sm
+  8zOo/Tph2scpEePy8LMxj1t7WY2IKnHAjVI2bwv0t4iqzoBTGArsoKFa9CJvlEPn
+  KC+XCfbOyPHDYZ9rMp1VjuzE73FNvLaZyemytRITy/xZcnCRJuQJ1M5lmG1k7VGo
+  h12tG5hepRnU+y5eYbc7locMlm+BA0zJO6h76O16ssTXdPGmWIx0bqvH+tnE3Y1p
+  ge/EpMmSPaY4DwpCrUOVB2lXkWEvCTxaEUfigbro+tNnGrlolMLzYunGh/rIPwf6
+  JlPQofTjBLEZZ4HnvsZrcpDbKg1UAJ8DRKuGMO8vW3+SIluXMoDfkDSornsCAwEA
+  AaOBijCBhzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUMZkI563V
+  qEbcdqMHGxFBtvTHazwwJgYDVR0RBB8wHYEbZ2VtbWFzdGVyQGphbWVzcm9iZXJ0
+  c29uLmV1MCYGA1UdEgQfMB2BG2dlbW1hc3RlckBqYW1lc3JvYmVydHNvbi5ldTAN
+  BgkqhkiG9w0BAQsFAAOCAYEAGq7ekyOf3MP2SWidstI5qt1pOcyY0IsjJbU9KWiS
+  K9mCa3DxPks6EFHswXTEBb91S/523He3iHw3XIx0wNgDycH6/hxXoylhG37He/RG
+  UZVIYjs7TaVqHpslQkGcO0/tGXzQ35mooF8XiB88l08sBiEunZU3quCwG0ja6A0V
+  VOZ/0X3SqdOgrhagTMsjDnz7ssiP/H6hIAoFBhF7D3X+Vavo6wMhSwGMoeFmQh67
+  CUipnJc6MBLlq8AxZcTYhulLOxTjefUxpbPxLV+pubf9xyG4rjkpv7lMap6wENLS
+  KzCP36ihBrIbQ6QFi1stEPDDXMNiIYbT4liyv1Ij0VUfnhZ8XtdlTrDzTeTQ2JjA
+  RAxFbgUVr0H2AyzRphwLN5UUUGYhsZOS4G+ObMbXYFHTDBlJBj0GIYi7yt48E6FE
+  G9akldSLDKgsN9vmwihdlnktMrNa8HUDxodpx5FFzXDsza/qaExLHJA4hPkbgeiC
+  4DQl3q4AK/bNTpTtJNtNQxts
   -----END CERTIFICATE-----
-date: 2018-02-04 00:00:00.000000000 Z
+date: 2022-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dynarex
@@ -38,20 +43,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.90
+        version: 1.9.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.90
+        version: 1.9.5
 - !ruby/object:Gem::Dependency
   name: simple-rss
   requirement: !ruby/object:Gem::Requirement
@@ -61,7 +66,7 @@ dependencies:
         version: '1.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: 1.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -71,9 +76,9 @@ dependencies:
         version: '1.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: 1.3.3
 description: 
-email: james@jamesrobertson.eu
+email: digital.robertson@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -98,10 +103,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
-summary: This gem helps reduce unnessecary requests to webservers by caching RSS feeds
+summary: This gem helps reduce unnecessary requests to webservers by caching RSS feeds
   where the RSS feeds are updated infrequently
 test_files: []