rsscache 0.1.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 84fa149159bb76649987604cc50dd3757ad3f486
-  data.tar.gz: fa60fefe08b19db3c7d85ce0acc7c8ba2d554175
+SHA256:
+  metadata.gz: fa5b1293b303475b5b3ec84c1f5c0d0f99209a8e00ae6b03ff27d84f11ed7da9
+  data.tar.gz: 298d687c80dc04d790ec63076b02868e10177ac35e8aef1b7c6981905ca5d5ea
 SHA512:
-  metadata.gz: 680703919349df43fac9486865c203f18befddb981c48fafe9205579e34c17c0dcdfa618c4f79a324248a99a91a7c4cc944202543c1fc480820b96f07266a7e5
-  data.tar.gz: 1913b72ca2e1c593e6dcf2a647e5a61299845f8efa691d60edd75e34e483dddb74ece6b99badcbb27f83886355c7b56d060f5568c2fca0b9f53200cd7c1e21a0
+  metadata.gz: bce3194dd3df0f6957769e9a4ac6df20f7420007a586a28372869096e638d2a0e1c504fa0391b89e857e470ad982d85e6a324e083f9ae2d5252077e017dd88d7
+  data.tar.gz: 7d38801562845a26c39085a7a1e8ea991af7ec02e0ad014d997bf7c21e39a830a14e04981a11baeb0989ae227823274b085065e43b328e53b95c826f98e68d62

data/lib/rsscache.rb

@@ -6,22 +6,63 @@ require 'dynarex'
 require 'open-uri'
 require 'simple-rss'
 require 'fileutils'
+require 'timeout'
 
 
 class RSScache
 
-  def initialize(rsslist, feedsfilepath=Dir.pwd)
+  attr_reader :err_report, :dx
 
+  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')
+    FileUtils.mkdir_p @cache_filepath
+
+    @err_report = []
+    @debug = debug
+
+  end
+
+  # 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.strip.lines.each do |raw_url|
+
+      url = raw_url.chomp
+      puts 'url : '  + url.inspect if @debug
+      r = @dx.find_by_url url.chomp
+
+      if r then
+        puts 'exists' if @debug
+      else
+        puts 'new URL found' if @debug
+        @dx.create url: url
+      end
+
+    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
 
@@ -29,7 +70,7 @@ class RSScache
 
         feed.refresh_rate = if feed.refresh_rate.empty? then
 
-          10 
+          10
 
         else
 
@@ -51,70 +92,139 @@ class RSScache
       end
     end
 
-    save_dynarex()
+    puts '@dx: ' + @dx.to_xml(pretty: true) if @debug
+    save()
 
   end
 
   alias update refresh
 
-  def open_dynarex(x)
+  def save()
+
+    @dx.save File.join(@filepath, 'rsscache.xml')
+    File.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
 
-  # checks for any updates and saves the latest RSS file to 
-  #                                       the cache if there is
+  def open_dynarex(raw_s)
+
+    s, _ = RXFHelper.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 save the
+  # latest RSS file to the cache if there are updates
   #
   def updates?(feed)
 
+    if @debug then
+      puts 'inside updates?'
+      puts 'feed: ' + feed.inspect
+    end
+
     # fetch the feeds from the web
-    rss = SimpleRSS.parse(open(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
+      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
 
-    
-    rssfile = if feed.filename.empty? then
       filename = feed.url[6..-1].gsub(/\W+/,'').\
                           reverse.slice(0,40).reverse.downcase + '.xml'
       feed.filename = filename
-      File.join(@feedsfilepath, filename)      
+
     end
-    
+
+    rssfile = File.join(@cache_filepath, feed.filename)
+
     if File.exists? rssfile then
 
-      rss_cache = SimpleRSS.parse File.read(rssfile)
+      begin
+        rss_cache = SimpleRSS.parse File.read(rssfile)
+      rescue
+        puts 'RSScache::updates?: err: 200 SimpleRSS warning for feed ' \
+            + feed.url + ' ' + ($!).inspect
+        FileUtils.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?
-      
+
     else
 
       File.write rssfile, rss.source
       feed.title = rss.title if feed.title.empty?
 
       return true
-      
+
     end
-    
+
     return false
   end
-end
+
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsscache
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.3
 platform: ruby
 authors:
 - James Robertson
@@ -10,28 +10,32 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDljCCAn6gAwIBAgIBATANBgkqhkiG9w0BAQUFADBIMRIwEAYDVQQDDAlnZW1t
-  YXN0ZXIxHjAcBgoJkiaJk/IsZAEZFg5qYW1lc3JvYmVydHNvbjESMBAGCgmSJomT
-  8ixkARkWAmV1MB4XDTE1MTEwNjE0MzkwM1oXDTE2MTEwNTE0MzkwM1owSDESMBAG
-  A1UEAwwJZ2VtbWFzdGVyMR4wHAYKCZImiZPyLGQBGRYOamFtZXNyb2JlcnRzb24x
-  EjAQBgoJkiaJk/IsZAEZFgJldTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC
-  ggEBAMgkQKulRgufn0SSYnKQ+qgJx7DZdJNAqqYbnxQmACxXX1+LBrdhjvIa4f+8
-  hFEywDRz/chnEGZVkL5el+mgP33rrFKBD85DqHWFNoCeaa9abdyoQFttTnmOwmVS
-  8vMqEAqdOsRH5P+86Hi3GxaB4nvjOJ3OI6cPL2hFNTOErjAenRe8GQOoQmnRooor
-  eqHSi/PJpymK2qAnRMT0YhJcWUPsqX2wyvoqhCdHGWDI3zh05f6IZaK2KO4J+PEj
-  mS/xsVPqNZei6iaHsjOfkSY0Nquji62PUcfSfTSpz8tm6IiNVzI4RwzOzLSHjfrd
-  86jvSW3Zg4+/wV9SpDlqoE5hO70CAwEAAaOBijCBhzAJBgNVHRMEAjAAMAsGA1Ud
-  DwQEAwIEsDAdBgNVHQ4EFgQUOhUHHP9MNyXcPfRUB25xNPgimREwJgYDVR0RBB8w
-  HYEbZ2VtbWFzdGVyQGphbWVzcm9iZXJ0c29uLmV1MCYGA1UdEgQfMB2BG2dlbW1h
-  c3RlckBqYW1lc3JvYmVydHNvbi5ldTANBgkqhkiG9w0BAQUFAAOCAQEAdGd2rZPC
-  kfnLVCNDZqAAUBePQN7af/mYKLHDRGhQR2J3+aeFm6DCY5aQJd9Fult1Nf+oHJnI
-  AJbq8GMkoKc1QQU+YjAIb6UgtL2qXo9VXZ3QXumQgkpbP7p4GQpH1ZQJ8m87bfms
-  oGDGtNn7F0b5EyTBTgDBBaVdgLDtPOMaED/yclJt6rUP//z3hGwP05NFANcjMw9c
-  x+u8RcmzdQ19ot55B/mN7gP/BTY6m/WiZWOkrg9NMRjrJTVknbDfL1aKparYCyoi
-  Fw4DQ6y8iLPuqjr0KqV/BO7FClXyXx4M+1Sejnchk0P5TEPx428bZqGPTakJNidM
-  6QO+pqPpZdfWfw==
+  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: 2015-11-06 00:00:00.000000000 Z
+date: 2021-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dynarex
@@ -39,20 +43,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.90
+        version: 1.8.27
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.90
+        version: 1.8.27
 - !ruby/object:Gem::Dependency
   name: simple-rss
   requirement: !ruby/object:Gem::Requirement
@@ -62,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
@@ -72,9 +76,9 @@ dependencies:
         version: '1.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: 1.3.3
 description: 
-email: james@r0bertson.co.uk
+email: digital.robertson@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -100,9 +104,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.7.10
 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: []