cocos 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 805a278e6d9393cd8d8dc34993735c77656e0dd35cbc8639f231fd2379b9633d
-  data.tar.gz: f29c8e08820c5cf7c7e852d081466bd49532a0fd7b6edd790bdbd3bb6c329ec9
+  metadata.gz: 40d870d3371a969672ba3e6b61dfb5cfbfae18809fa2edb96c8a3dbdfa44f1e8
+  data.tar.gz: f811adb7be939ff1dd90108fe16bf036f45e40540cbbff81fb7d20d6591c1426
 SHA512:
-  metadata.gz: 58806d72f9e21997a77d5b5ef7ef066367929e73bda712939c20508244be6774686a10df3de213298f1a61711607590d4cb4665946dcaebc46bc75b402767cca
-  data.tar.gz: 28e6e3f7cb54a18d179c3f5ef3cf15f4a100324f371b16ddb85a58019abb4d80be42611dad2bebd3f9e84d49c41185bc6b08b1b0074debac24e2098977913658
+  metadata.gz: b504140b89069be5896ab2028263e191475d5d92423fc6df4be069523c2b037b0c28830ec0fa89426e0212007044344ed4c849345e016d12c2c0832575b85920
+  data.tar.gz: 1b5a4741a03b48740fb4868bf54c054382dbee3a3f7b7cca243d2393c88cc0c6cb5b5d75e593d5c3bdec075d3df32a714eb4f7ec861572dfd9c3e4a2278f9548

data/README.md

@@ -1,8 +1,8 @@
 # cocos (code commons) - auto-include quick-starter prelude & prolog
 
 
-* home  :: [github.com/rubycocos/cococs](https://github.com/rubycocos/cococs)
-* bugs  :: [github.com/rubycocos/cococs/issues](https://github.com/rubycocos/cococs/issues)
+* home  :: [github.com/rubycocos/cocos](https://github.com/rubycocos/cocos)
+* bugs  :: [github.com/rubycocos/cocos/issues](https://github.com/rubycocos/cocos/issues)
 * gem   :: [rubygems.org/gems/cocos](https://rubygems.org/gems/cocos)
 * rdoc  :: [rubydoc.info/gems/cocos](http://rubydoc.info/gems/cocos)
 
@@ -22,6 +22,7 @@ require 'time'
 require 'date'
 require 'json'
 require 'yaml'
+require 'base64'
 require 'fileutils'
 
 require 'uri'
@@ -86,6 +87,9 @@ And so on.
 
 _Read / parse convenience short-cut helpers_
 
+`read_blob( path )` <br>
+also known as `read_binary` or `read_bin`
+
 
 `read_text( path )` <br>
 also known as `read_txt`
@@ -94,6 +98,7 @@ also known as `read_txt`
 `read_lines( path )`
 
 
+
 `read_json( path )` / `parse_json( str )`
 
 
@@ -106,6 +111,13 @@ note: comma-separated values (.csv) reading & parsing service
 brought to you by the [**csvreader library / gem »**](https://github.com/rubycocos/csvreader/tree/master/csvreader)
 
 
+`read_data( path )` / `parse_data( str )`
+
+note:  alternate shortcut / alias for `read_csv( path, headers: false )` / `parse_csv( str, headers: false )`
+
+
+
+
 `read_tab( path )` / `parse_tab( str )`
 
 note: tabulator (`\t`)-separated values (.tab) reading & parsing service

data/Rakefile

@@ -24,6 +24,7 @@ Hoe.spec 'cocos' do
     ['csvreader',      '>= 1.2.5'],
     ['tabreader',      '>= 1.0.1'],
     ['iniparser',      '>= 1.0.1'],
+    ['webclient',      '>= 0.2.2'],
   ]
 
   self.spec_extras = {

data/lib/cocos/version.rb

@@ -1,7 +1,7 @@
 
 module Cocos
   MAJOR = 0    ## todo: namespace inside version or something - why? why not??
-  MINOR = 1
+  MINOR = 2
   PATCH = 1
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 

data/lib/cocos.rb

@@ -6,12 +6,13 @@ require 'time'
 require 'date'
 require 'json'
 require 'yaml'
+require 'base64'    ## e.g. Base64.decode64,Base64.encode64,...
 require 'fileutils'
 
 require 'uri'
 require 'net/http'
 require 'net/https'
-
+require 'cgi'
 
 require 'optparse'    ## used by monofile (built-in test/debug) command line tool
 
@@ -22,6 +23,9 @@ require 'csvreader'
 require 'tabreader'
 require 'iniparser'
 
+require 'webclient'
+
+
 
 #####################
 # our own code
@@ -36,14 +40,35 @@ module Kernel
 
 
 
+################
+#  private helpers - keep along here - why? why not?
+
+##### check if path starts with http:// or https://
+##       if yes, assume it's a download
+DOWNLOAD_RX = %r{^https?://}i
+
+## note: hack - use !! to force nil (no match) to false
+##                         and matchdata to true
+def _download?( path )
+   !! DOWNLOAD_RX.match( path )
+end
+
+
+
 ## todo:  add symbolize options a la read_json
 ##         add sep options
 def read_csv( path, headers: true )
-   if headers
-      CsvHash.read( path )
+
+   if _download?( path )
+     parse_csv( _wget!( path ).text,
+                headers: headers )
    else
-      Csv.read( path )
-   end
+     if headers
+        CsvHash.read( path )
+     else
+        Csv.read( path )
+     end
+    end
 end
 
 def parse_csv( str, headers: true )
@@ -55,8 +80,29 @@ def parse_csv( str, headers: true )
 end
 
 
+### note: use read_data / parse_data
+##  for alternate shortcut for read_csv / parse_csv w/ headers: false
+##       returning arrays of strings
+def read_data( path )
+  if _download?( path )
+    read_data( _wget!( path ).text )
+  else
+    Csv.read( path )
+  end
+end
+
+def parse_data( str )
+  Csv.parse( str )
+end
+
+
+
 def read_tab( path )
-   Tab.read( path )
+  if _download?( path )
+    parse_tab( _wget!( path ).text )
+  else
+    Tab.read( path )
+  end
 end
 
 def parse_tab( str )
@@ -66,16 +112,17 @@ end
 
 ## todo:  add symbolize options ???
 def read_json( path )
-   JSON.parse( read_text( path ))
+  JSON.parse( read_text( path ))
 end
 
 def parse_json( str )
   JSON.parse( str )
 end
 
+
 ### todo/check:  use parse_safeyaml or such? (is default anyway?) - why? why not?
 def read_yaml( path )
-  YAML.load( read_text( path ))
+   YAML.load( read_text( path ))
 end
 
 def parse_yaml( str )
@@ -84,7 +131,7 @@ end
 
 
 def read_ini( path )
-  INI.load( read_text( path ))
+   INI.load( read_text( path ))
 end
 
 def parse_ini( str )
@@ -98,25 +145,125 @@ alias_method :parse_conf, :parse_ini
 
 
 def read_text( path )
+  if _download?( path )
+    _wget!( path ).text
+  else
+   ## todo/check: add universal newline mode or such?
+   ##  e.g. will always convert all
+   ##    newline variants (\n|\r|\n\r) to "universal" \n only
     txt = File.open( path, 'r:utf-8' ) do |f|
                 f.read
           end
     txt
+  end
 end
 alias_method :read_txt, :read_text
 
 
-def read_lines( path )
-    lines = File.open( path, 'r:utf-8' ) do |f|
-               f.readlines
+def read_blob( path )
+  if _download?( path )
+    _wget!( path ).blob
+  else
+    blob =  File.open( path, 'rb' ) do |f|
+                   f.read
             end
-    lines
+    blob
+  end
 end
+alias_method :read_binary, :read_blob
+alias_method :read_bin,    :read_blob
 
 
-end # module Kernel
 
 
+## todo/check: remove \n (or\r or \r\n) from line
+##   ruby (by default) keeps the newline - follow tradition? why? why not?
+##   add/offer chomp: true/false option or such - why? why not?
+##    see String.lines in rdoc
+##
+def read_lines( path )
+  read_text( path ).lines
+end
+
+def parse_lines( str )
+  str.lines
+end
+
+
+
+
+######
+#  add writers
+
+def write_json( path, data )
+  ###
+  ## todo/check:  check if data is Webclient.Response?
+  ##   if yes use res.json  - why? why not?
+
+  dirname = File.dirname( path )
+  FileUtils.mkdir_p( dirname )  unless Dir.exist?( dirname )
+
+  ## note: pretty print/reformat json
+  File.open( path, "w:utf-8" ) do |f|
+     f.write( JSON.pretty_generate( data ))
+  end
+end
+
+
+def write_blob( path, blob )
+  ###
+  ## todo/check:  check if data is Webclient.Response?
+  ##   if yes use res.blob/body  - why? why not?
+
+  dirname = File.dirname( path )
+  FileUtils.mkdir_p( dirname )  unless Dir.exist?( dirname )
+
+  File.open( path, "wb" ) do |f|
+    f.write( blob )
+  end
+end
+alias_method :write_binary, :write_blob
+alias_method :write_bin,    :write_blob
+
+
+def write_text( path, text )
+  ###
+  ## todo/check:  check if data is Webclient.Response?
+  ##   if yes use res.text  - why? why not?
+
+  dirname = File.dirname( path )
+  FileUtils.mkdir_p( dirname )  unless Dir.exist?( dirname )
+
+  File.open( path, "w:utf-8" ) do |f|
+    f.write( text )
+  end
+end
+alias_method :write_txt,  :write_text
+
+
+
+######
+#   world wide web (www) support
+
+def wget( url, **kwargs )
+  Webclient.get( url, **kwargs )
+end
+##  add alias www_get or web_get - why? why not?
+
+
+
+## private helper - make public -why? why not?
+def _wget!( url, **kwargs )
+  res = Webclient.get( url, **kwargs )
+
+  ##  check/todo - use a different exception/error - keep RuntimeError - why? why not?
+  raise RuntimeError, "HTTP #{res.status.code} - #{res.status.message}"   if res.status.nok?
+
+  res
+end
+
+
+end # module Kernel
 
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocos
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-01 00:00:00.000000000 Z
+date: 2022-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: csvreader
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: webclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement