pluto-news 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7908922c343e9a80b979528c5561f2b946b77a74
-  data.tar.gz: 1c6753f57ad5d2f47ac9b1f9d2dc774619a5fe0d
+  metadata.gz: a014d89094549725b6cbd78214ee882094a0aeb3
+  data.tar.gz: f7cae9d5c36c7bb69ec34f276cce937639097bac
 SHA512:
-  metadata.gz: 2278051b4c6b0729a83d2697012b61fe214f8cfecbcaffc24ca365ad6e8dba4db3a4c8cae9b22feadf23cd4b9a80115893b2d0e2f10f72b42628f39d5c927e1e
-  data.tar.gz: 232c79b23e21ce139bfc107495e65f2bcb960c1f926c98f8d40197ddf1885f5d8add3bea79d9afcb4939817a8de7383bb13d08e7dc9f771d1f981a0f00ffa9e3
+  metadata.gz: 3244fbe52589e3ae1c9a5aadb06b2050b7e8382f2b9f0f68854b419852f9d5ed45cf056f54185485ffae975dde0e18f21db314b260df49aa4d05928139f76896
+  data.tar.gz: a92e359f7776f47f520b920931d069176c67f1cde6cf957e1d5f9085df4ce3f1136e61cf9be1a51e5262939ee229c4b8c848a164790453716366a819bb7d0ea3

data/lib/pluto/news.rb

@@ -8,6 +8,8 @@ require 'time'
 require 'cgi'
 require 'uri'
 require 'digest'
+require 'yaml'    ## check - already included upstream?
+require 'json'    ## check - already included upstream?
 
 require 'erb'
 require 'ostruct'
@@ -54,36 +56,110 @@ require 'pluto/news/version'
 
 module News
 
+  ##
+  ## todo/check: allow (add) site = nil for no site "filter" (all items / feeds) - why? why not?
   def self.site=(value)  @site   = value;  end
   def self.site()        @site ||= 'news'; end   ## note: defaults to news
 
 
+####
+# helpers
+
+  def self.autogen_feed_key( feed_url )
+    ## note:
+    ##   use a "fingerprint" hash digest as key
+    ##     do NOT include scheme (e.g. https or http)
+    ##     do NOT include port
+    ##   so you can change it without "breaking" the key - why? why not?
+    ##
+    ##  e.g.   u = URI( 'https://example.com:333/a/b?f=xml'
+    ##          u.host+u.request_uri
+    ##         #=> example.com/a/b?f=xml
+    uri = URI( feed_url )
+    ## note: add host in "plain" text - making errors and the key more readable
+    ## note: cut-off www. if leading e.g. www.ruby-lang.org => ruby-lang.org
+    host = uri.host.downcase.sub( /^www\./, '' )
+    #   use a differt separator e.g _ or ~ and NOT $ - why? why not?
+    key = "#{host}$#{Digest::MD5.hexdigest( uri.request_uri )}"
+    key
+  end
 
-  def self.subscribe( *feeds )
-    site_hash = {        ## note: keys are strings (NOT symbols) for now
-      'title' => 'Untitled'
-    }
-
-    feeds.each_with_index do |feed|
-      ## note:
-      ##   use a "fingerprint" hash digest as key
-      ##     do NOT include scheme (e.g. https or http)
-      ##     do NOT include port
-      ##   so you can change it without "breaking" the key - why? why not?
-      ##
-      ##  e.g.   u = URI( 'https://example.com:333/a/b?f=xml'
-      ##          u.host+u.request_uri
-      ##         #=> example.com/a/b?f=xml
-      uri = URI( feed )
-      ## note: add host in "plain" text - making errors and the key more readable
-      ## note: cut-off www. if leading e.g. www.ruby-lang.org => ruby-lang.org
-      host = uri.host.downcase.sub( /^www\./, '' )
-      #   use a differt separator e.g _ or ~ and NOT $ - why? why not?
-      key = "#{host}$#{Digest::MD5.hexdigest( uri.request_uri )}"
-
-      site_hash[ key ] = { 'feed'  => feed }
+  def self.norm_feed_hash( old_h )   ## todo/check: rename to normalize/unify_feeds or resolve_feedlist or something?
+    ## unify feed list entries
+    ## case 1) if section name is some thing like [Andrew Kane]
+    ##           and  NO title/name key than assume it's the title/name
+    ##           and auto-generated key/id
+
+    ## move all "global" settings to [planet] section - why? why not?
+    ##  e.g.
+    ##   title = Planet Open Data News
+    ##  becomes
+    ##   [planet]
+    ##     title = Planet Open Data News
+
+    h = {}
+    old_h.each do |k,v|
+       if    v.is_a?( String )
+          h[ k ] = v   ## pass along as-is (assume "top-level" / global setting)
+       elsif v.is_a?( Hash )
+          ## puts "#{k}:"
+          ## pp v
+          ## todo/fix: use "proper" ident e.g. allow 0-9 and .-_ too? why? why not?
+          if k =~ /^[a-z_][a-z0-9$_.]*$/   ## all lower case; assume id - add 0-9 and .-_ - why? why not?
+            h[ k ] = v
+          else
+             ## puts "bingo! section name shortcut - #{k}"
+             if k.start_with?( 'http' )
+                if v.has_key?( 'feed' ) then raise ArgumentError.new( "duplicate >feed< hash table entry in section >#{k}<; cannot autogen key" );  end
+
+                new_k = autogen_feed_key( k )
+                # note: use merge - why? why not? to NOT overwrite existing entry - why? why not?
+                h[ new_k ]  = { 'feed' => k }.merge( v )
+             else
+                ## transform key to title and auto-generate id (new key)
+                if v.has_key?( 'title' ) || v.has_key?( 'name' ) then raise ArgumentError.new( "duplicate >name< or >title< hash table entry in section >#{k}<; cannot autogen key" );  end
+                if v.has_key?( 'feed' ) == false                 then raise ArgumentError.new( "expected / required >feed< hash table entry missing for section >#{k}<");  end
+
+                new_k = autogen_feed_key( v['feed'] )
+                # note: use merge - why? why not? to NOT overwrite existing entry - why? why not?
+                h[ new_k ]  = { 'title' => k }.merge( v )
+             end
+          end
+       else
+         raise ArgumentError.new( "expected String or Hash for value (in hash table) but got >#{v.class.name}< for key >#{k}<" )
+       end
     end
 
+    ## todo/check - auto-add required (?) missing title if missing - why? why not?
+    h['title'] = 'Untitled'   if h.has_key?( 'title' ) == false
+
+    h
+  end
+
+
+  def self.subscribe( *feeds )
+
+    site_hash =   if feeds.size == 1 && feeds[0].is_a?( Hash )
+                     ## puts "bingo!  it's a hash"
+                     norm_feed_hash( feeds[0] )
+                  elsif feeds.size == 1 && feeds[0].is_a?( String ) && feeds[0] =~ /\n/
+                     ## string includes newline (e.g. more than a single line?)
+                     ## if yes, parse and assume ini (config) format
+                     norm_feed_hash( INI.load( feeds[0] ))
+                  else   ## assume list / array of strings (feed_urls)
+                     ## puts "bingo! it's a string list"
+                     ##   auto-build a (simple) site hash
+                     feeds.reduce( {        ## note: keys are strings (NOT symbols) for now
+                                      'title' => 'Untitled'
+                                      ## todo/check: remove title? required? check in model update if missing?
+                                    } ) do |h, feed|
+                                         key = autogen_feed_key( feed )
+
+                                         h[ key ] = { 'feed'  => feed }
+                                         h
+                                        end
+                  end
+
     connection   ## make sure we have a database connection (and setup) up-and-running
     ## note: always use "multi-site" setup; defaults to 'news' site key
     Pluto::Model::Site.deep_create_or_update_from_hash!( site, site_hash )
@@ -118,7 +194,7 @@ module News
     ## note: always use "multi-site" setup; defaults to 'news' site key
     ## note: add "default" scope - orders (sorts) by latest / time
     rec = Pluto::Model::Site.where(key: site).first
-    if rec.nil? 
+    if rec.nil?
       Pluto::Model::Item.none    ## use null (relation) pattern to avoid crash on nil - why? why not?
     else
       rec.items.order(

data/lib/pluto/news/version.rb

@@ -3,20 +3,20 @@ module PlutoNews
 
     MAJOR = 1
     MINOR = 1
-    PATCH = 0
+    PATCH = 1
     VERSION = [MAJOR,MINOR,PATCH].join('.')
-  
+
     def self.version
       VERSION
     end
-  
+
     def self.banner
       ### todo: add RUBY_PATCHLEVEL or RUBY_PATCH_LEVEL  e.g. -p124
       "pluto-news/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
     end
-  
+
     def self.root
       "#{File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )}"
     end
-  
+
 end # module PlutoNews

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pluto-news
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-26 00:00:00.000000000 Z
+date: 2020-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pluto-models