webclient 0.1.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6e556a9e6949903368d71f7b0eec721c772edbf5
-  data.tar.gz: bf7fa4bf5f66eba5a31d1b5be692d09b4693ee7e
+SHA256:
+  metadata.gz: 8db40d5a48638657362e50374418f3f911079afbdf9852a6e99038a6dd46f549
+  data.tar.gz: 334f393fc27e197a685200c5f9a85f34c7940ac7c37bce7a80dcef971d642daf
 SHA512:
-  metadata.gz: 575883f59d791b4326d9dc88184875fb2e120a5676d946088dffc59aa9f4e493412621dc7b77e9b15c9cbb8edd611f0ad0ce25fdeae33b6248f574f9d3962a28
-  data.tar.gz: 40a53603700a3d12a55bca74071d8dbd48ebfea04bda68b0889c5cac135aca17e82aab9ab08cdf5c24f0c749fb9f24ea3a7ca64ad154d267881ef3406897dae2
+  metadata.gz: 81d41206af0b7c517318f908f4ce7482bb11849470ef1631c949a6479509d177ac2027c79f7cf18eb7b007cb0150f45d73e267f270b7e0a717482f002c4076fa
+  data.tar.gz: 2312bfe78c5c621a5b58e4498c9f5c0adbc2ecca929bbf73ccaf0f3c79f07d5ec823f234536bcfd22773506dfd1b891a29ac202081a05551b39b4b3f4ac7aabe

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-### 0.0.1 / 2020-10-03
-
-* Everything is new. First release.
-
+### 0.0.1 / 2020-10-03
+
+* Everything is new. First release.
+

data/README.md

@@ -1,22 +1,22 @@
-# webclient
-
-webclient gem - yet (another) universal network client interface for world wide web (www) requests via HTTP
-
-
-* home  :: [github.com/rubycoco/webclient](https://github.com/rubycoco/webclient)
-* bugs  :: [github.com/rubycoco/webclient/issues](https://github.com/rubycoco/webclient/issues)
-* gem   :: [rubygems.org/gems/webclient](https://rubygems.org/gems/webclient)
-* rdoc  :: [rubydoc.info/gems/webclient](http://rubydoc.info/gems/webclient)
-* forum :: [groups.google.com/group/wwwmake](https://groups.google.com/group/wwwmake)
-
-
-
-## Usage
-
-TBD
-
-
-## License
-
-The `webclient` scripts are dedicated to the public domain.
-Use it as you please with no restrictions whatsoever.
+# webclient
+
+webclient gem - yet (another) universal network client interface for world wide web (www) requests via HTTP
+
+
+* home  :: [github.com/rubycoco/webclient](https://github.com/rubycoco/webclient)
+* bugs  :: [github.com/rubycoco/webclient/issues](https://github.com/rubycoco/webclient/issues)
+* gem   :: [rubygems.org/gems/webclient](https://rubygems.org/gems/webclient)
+* rdoc  :: [rubydoc.info/gems/webclient](http://rubydoc.info/gems/webclient)
+* forum :: [groups.google.com/group/wwwmake](https://groups.google.com/group/wwwmake)
+
+
+
+## Usage
+
+TBD
+
+
+## License
+
+The `webclient` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.

data/Rakefile

@@ -1,28 +1,28 @@
-require 'hoe'
-require './lib/webclient/version.rb'
-
-Hoe.spec 'webclient' do
-
-  self.version = Webclient::VERSION
-
-  self.summary = 'webclient gem - yet (another) universal network client interface for world wide web (www) requests via HTTP'
-  self.description = summary
-
-  self.urls    = { home: 'https://github.com/rubycoco/webclient' }
-
-  self.author  = 'Gerald Bauer'
-  self.email   = 'ruby-talk@ruby-lang.org'
-
-  # switch extension to .markdown for gihub formatting
-  self.readme_file  = 'README.md'
-  self.history_file = 'CHANGELOG.md'
-
-  self.extra_deps = []
-
-  self.licenses = ['Public Domain']
-
-  self.spec_extras = {
-   required_ruby_version: '>= 2.2.2'
-  }
-
-end
+require 'hoe'
+require './lib/webclient/version.rb'
+
+Hoe.spec 'webclient' do
+
+  self.version = Webclient::VERSION
+
+  self.summary = 'webclient gem - yet (another) universal network client interface for world wide web (www) requests via HTTP'
+  self.description = summary
+
+  self.urls    = { home: 'https://github.com/rubycoco/webclient' }
+
+  self.author  = 'Gerald Bauer'
+  self.email   = 'ruby-talk@ruby-lang.org'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'CHANGELOG.md'
+
+  self.extra_deps = []
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+   required_ruby_version: '>= 2.2.2'
+  }
+
+end

data/lib/webclient/version.rb

@@ -1,20 +1,20 @@
-
-class Webclient
-  MAJOR = 0    ## todo: namespace inside version or something - why? why not??
-  MINOR = 1
-  PATCH = 1
-  VERSION = [MAJOR,MINOR,PATCH].join('.')
-
-  def self.version
-    VERSION
-  end
-
-  def self.banner
-    "webclient/#{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 Webclient
-
+
+class Webclient
+  MAJOR = 0    ## todo: namespace inside version or something - why? why not??
+  MINOR = 2
+  PATCH = 2
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "webclient/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}] in (#{root})"
+  end
+
+  def self.root
+    File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )
+  end
+end # module Webclient
+

data/lib/webclient/webclient.rb

@@ -1,96 +1,202 @@
-
-class Webclient
-
-  class Response   # nested class - wrap Net::HTTP::Response
-    def initialize( response )
-      @response = response
-    end
-    def raw() @response; end
-
-
-    def text
-      # note: Net::HTTP will NOT set encoding UTF-8 etc.
-      # will be set to ASCII-8BIT == BINARY == Encoding Unknown; Raw Bytes Here
-      # thus, set/force encoding to utf-8
-      text = @response.body.to_s
-      text = text.force_encoding( Encoding::UTF_8 )
-      text
-    end
-
-    ## convenience helper; returns parsed json data
-    def json() JSON.parse( text ); end
-
-
-
-    class Headers # nested (nested) class
-      def initialize( response )
-        @response = response
-      end
-      def each( &blk )
-        @response.each_header do |key, value|  # Iterate all response headers
-          blk.call( key, value )
-        end
-      end
-    end
-    def headers() @headers ||= Headers.new( @response ); end
-
-    class Status  # nested (nested) class
-      def initialize( response )
-        @response = response
-      end
-      def code() @response.code.to_i; end
-      def ok?()  code == 200; end
-      def nok?() code != 200; end
-      def message() @response.message; end
-    end
-    def status() @status ||= Status.new( @response ); end
-  end # (nested) class Response
-
-
-def self.get( url, headers: {}, auth: [] )
-
-  uri = URI.parse( url )
-  http = Net::HTTP.new( uri.host, uri.port )
-
-  if uri.instance_of? URI::HTTPS
-    http.use_ssl     = true
-    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-  end
-
-  request = Net::HTTP::Get.new( uri.request_uri )
-
-  ### add (custom) headers if any
-  ##  check/todo: is there are more idiomatic way for Net::HTTP ???
-  ##   use
-  ##     request = Net::HTTP::Get.new( uri.request_uri, headers )
-  ##    why? why not?
-  ##  instead of e.g.
-  ##   request['X-Auth-Token'] = 'xxxxxxx'
-  ##   request['User-Agent']   = 'ruby'
-  ##   request['Accept']       = '*/*'
-  if headers && headers.size > 0
-    headers.each do |key,value|
-      request[ key ] = value
-    end
-  end
-
-
-  if auth.size == 2   ## e.g. ['user', 'password']
-    ## always assume basic auth for now
-    ##  auth[0]  => user
-    ##  auth[1]  => password
-    request.basic_auth( auth[0], auth[1] )
-    puts "  using basic auth - user: #{auth[0]}, password: ***"
-  end
-
-
-  puts "GET #{uri}..."
-
-  response = http.request( request )
-
-  ## note: return "unified" wrapped response
-  Response.new( response )
-end  # method self.get
-
-end  # class Webclient
-
+
+class Webclient
+
+  class Response   # nested class - wrap Net::HTTP::Response
+    def initialize( response )
+      @response = response
+    end
+    def raw() @response; end
+
+
+    ## todo/check: rename encoding to html/http-like charset - why? why not?
+    def text( encoding: 'UTF-8' )
+      # note: Net::HTTP will NOT set encoding UTF-8 etc.
+      # will be set to ASCII-8BIT == BINARY == Encoding Unknown; Raw Bytes Here
+      # thus, set/force encoding to utf-8
+      text = @response.body.to_s
+      if encoding.downcase == 'utf-8'
+         text = text.force_encoding( Encoding::UTF_8 )
+      else
+    ## [debug] GET=http://www.football-data.co.uk/mmz4281/0405/SC0.csv
+    ##    Encoding::UndefinedConversionError: "\xA0" from ASCII-8BIT to UTF-8
+    ##     note:  0xA0 (160) is NBSP (non-breaking space) in Windows-1252
+
+    ## note: assume windows encoding (for football-data.uk)
+    ##   use "Windows-1252" for input and convert to utf-8
+    ##
+    ##    see https://www.justinweiss.com/articles/3-steps-to-fix-encoding-problems-in-ruby/
+    ##    see https://en.wikipedia.org/wiki/Windows-1252
+    ## txt = txt.force_encoding( 'Windows-1252' )
+    ## txt = txt.encode( 'UTF-8' )
+    ##   Encoding::UTF_8 => 'UTF-8'
+        puts " [debug] converting response.text encoding from >#{encoding}< to >UTF-8<"
+
+        text = text.force_encoding( encoding )
+        text = text.encode( Encoding::UTF_8 )
+      end
+
+      text
+    end
+
+    ## convenience helper; returns parsed json data; note: always assume utf-8 (text) encoding
+    def json() JSON.parse( text ); end
+
+
+    def body() @response.body.to_s; end
+    alias_method :blob, :body
+
+
+
+    class Headers # nested (nested) class
+      def initialize( response )
+        @response = response
+      end
+      def each( &blk )
+        @response.each_header do |key, value|  # Iterate all response headers
+          blk.call( key, value )
+        end
+      end
+    end
+    def headers() @headers ||= Headers.new( @response ); end
+
+
+    ## add some predefined/built-in header(s) convenience shortcuts
+    def content_type
+      ## check: change to headers['content-type'] or such - why? why not?
+      @response.content_type
+    end
+    def content_length
+      @response.content_length
+    end
+
+    def image_jpg?
+      content_type =~ %r{image/jpeg}i
+    end
+    def image_png?
+      content_type =~ %r{image/png}i
+    end
+    def image_gif?
+      content_type =~ %r{image/gif}i
+    end
+
+    alias_method :image_jpeg?, :image_jpg?
+    alias_method :jpeg?, :image_jpg?
+    alias_method :jpg?, :image_jpg?
+    alias_method :png?, :image_png?
+    alias_method :gif?, :image_gif?
+
+
+
+    class Status  # nested (nested) class
+      def initialize( response )
+        @response = response
+      end
+      def code() @response.code.to_i; end
+      def ok?()  code == 200; end
+      def nok?() code != 200; end
+      def message() @response.message; end
+    end
+    def status() @status ||= Status.new( @response ); end
+  end # (nested) class Response
+
+
+def self.get( url, headers: {}, auth: [] )
+
+  uri = URI.parse( url )
+  http = Net::HTTP.new( uri.host, uri.port )
+
+  if uri.instance_of? URI::HTTPS
+    http.use_ssl     = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+  end
+
+  request = Net::HTTP::Get.new( uri.request_uri )
+
+  ### add (custom) headers if any
+  ##  check/todo: is there are more idiomatic way for Net::HTTP ???
+  ##   use
+  ##     request = Net::HTTP::Get.new( uri.request_uri, headers )
+  ##    why? why not?
+  ##  instead of e.g.
+  ##   request['X-Auth-Token'] = 'xxxxxxx'
+  ##   request['User-Agent']   = 'ruby'
+  ##   request['Accept']       = '*/*'
+  if headers && headers.size > 0
+    headers.each do |key,value|
+      request[ key ] = value
+    end
+  end
+
+
+  if auth.size == 2   ## e.g. ['user', 'password']
+    ## always assume basic auth for now
+    ##  auth[0]  => user
+    ##  auth[1]  => password
+    request.basic_auth( auth[0], auth[1] )
+    puts "  using basic auth - user: #{auth[0]}, password: ***"
+  end
+
+
+  puts "GET #{uri}..."
+
+  response = http.request( request )
+
+  ## note: return "unified" wrapped response
+  Response.new( response )
+end  # method self.get
+
+
+def self.post( url, headers: {},
+                    body: nil,
+                    json: nil   ## json - convenience shortcut (for body & encoding)
+              )
+
+  uri = URI.parse( url )
+  http = Net::HTTP.new( uri.host, uri.port )
+
+  if uri.instance_of? URI::HTTPS
+    http.use_ssl     = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+  end
+
+  request = Net::HTTP::Post.new( uri.request_uri )
+
+  ### add (custom) headers if any
+  ##  check/todo: is there are more idiomatic way for Net::HTTP ???
+  ##   use
+  ##     request = Net::HTTP::Get.new( uri.request_uri, headers )
+  ##    why? why not?
+  ##  instead of e.g.
+  ##   request['X-Auth-Token'] = 'xxxxxxx'
+  ##   request['User-Agent']   = 'ruby'
+  ##   request['Accept']       = '*/*'
+  if headers && headers.size > 0
+    headers.each do |key,value|
+      request[ key ] = value
+    end
+  end
+
+  if body
+     request.body = body.to_s
+  end
+
+  if json
+     # note: the body needs to be a JSON string - use pretty generate and NOT "compact" style - why? why not?
+     request.body = JSON.pretty_generate( json )
+
+     ## move (auto-set) header content-type up (before custom headers) - why? why not?
+     request['Content-Type'] = 'application/json'
+  end
+
+
+  puts "POST #{uri}..."
+
+  response = http.request( request )
+
+  ## note: return "unified" wrapped response
+  Response.new( response )
+end  # method self.post
+
+
+end  # class Webclient
+

data/lib/webclient.rb

@@ -1,25 +1,25 @@
-require 'pp'
-require 'time'
-require 'date'
-require 'fileutils'
-
-require 'uri'
-require 'net/http'
-require 'net/https'
-
-require 'json'
-require 'yaml'
-
-
-# our own code
-require 'webclient/version'   # note: let version always go first
-require 'webclient/webclient'
-
-
-############
-## add convenience alias for camel case / alternate different spelling
-WebClient = Webclient
-
-
-# say hello
-puts Webclient.banner    if defined?( $RUBYLIBS_DEBUG )
+require 'pp'
+require 'time'
+require 'date'
+require 'fileutils'
+
+require 'uri'
+require 'net/http'
+require 'net/https'
+
+require 'json'
+require 'yaml'
+
+
+# our own code
+require 'webclient/version'   # note: let version always go first
+require 'webclient/webclient'
+
+
+############
+## add convenience alias for camel case / alternate different spelling
+WebClient = Webclient
+
+
+# say hello
+puts Webclient.banner     ## if defined?( $RUBYLIBS_DEBUG )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webclient
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Gerald Bauer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-07 00:00:00.000000000 Z
+date: 2022-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.22'
+        version: '3.23'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.22'
+        version: '3.23'
 description: webclient gem - yet (another) universal network client interface for
   world wide web (www) requests via HTTP
 email: ruby-talk@ruby-lang.org
@@ -65,7 +65,7 @@ homepage: https://github.com/rubycoco/webclient
 licenses:
 - Public Domain
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -82,9 +82,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: webclient gem - yet (another) universal network client interface for world
   wide web (www) requests via HTTP