wikk_webbrowser 0.9.5 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a25cf9aea236d9ba4945504da12b1208fdca1cda7350858e60fcb6fc5637eda
-  data.tar.gz: 2ab9b741a5c225ba0e450f44caef3de02d5edf16c3307b494d9cdea7315672c3
+  metadata.gz: b68922378ce9c4777c7810d94449ec8c4cdd738d9480b80430aa9f8829cd0d97
+  data.tar.gz: 33654b9c6d202036b39895c2b41facba850bfcee44e211866cca373a45443c8f
 SHA512:
-  metadata.gz: 27c92d6d75b5e1348072f09931f07c2965ffc00834fd7216a756f25dae48cd31f1908c2ea1a905ef61abd1d981a85f050b48bb94c012b315b2c70219d046cd90
-  data.tar.gz: cd36b51057af6d8d4bce69de2db3a0b442b1ab0a8601dd042e061a994b2fa8be56d51684e6f2520beec1af435f4011c413511f6430f515f7e1b4a7a7a29b9ac3
+  metadata.gz: a3ed4f35c54b8d96baddfe7e21afc0fdf674706daf36aa5a97a0da5717a3fb513a1bbda23c7840765b9891d314a3ff26601847272b8c146b34bf196c7c9f0534
+  data.tar.gz: 9bafdc4f3fd1b77d92b749b5970e224811a631a3f1fc8c9f48cbf59b07a884f8a12d9431620ef331bd8afc0e99d4cbb6a109f09c315f1e5722eb4a2ae569b680

data/History.txt

@@ -1,3 +1,11 @@
+robertburrowes	Mon Sep 20 12:14:31 2021 +1200
+	Add aliases for put,post,get and delete
+robertburrowes	Mon Sep 20 12:14:09 2021 +1200
+	Added optional form arguments to delete_req Added optional data/content arguments to delete_req
+robertburrowes	Sat Sep 18 17:49:31 2021 +1200
+	Rubocop Beautifier
+robertburrowes	Sat Sep 18 17:23:58 2021 +1200
+	Rubocop beautifier reformat
 robertburrowes	Wed Apr 21 19:03:05 2021 +1200
 	Dependency version was wrong
 robertburrowes	Wed Apr 21 18:54:00 2021 +1200

data/lib/wikk_webbrowser.rb

@@ -1,4 +1,4 @@
-module WIKK
+module WIKK # :nodoc:
   require 'net/http'
   require 'net/https'
   require 'uri'
@@ -12,18 +12,17 @@ module WIKK
   #  WIKK_WebBrowser.new.https_session(host: 'www.blah.com') do |session|
   #    response = get_page(query: ,'/')
   #  end
-
   class WebBrowser
-    VERSION = '0.9.5'
-  
-    class Error < RuntimeError
+    VERSION = '0.9.6'
+
+    class Error < RuntimeError # :nodoc:
       attr_accessor :web_return_code
+
       def initialize(web_return_code:, message:)
         super(message)
         @web_return_code = web_return_code
       end
     end
-  
 
     attr_reader :host
     attr_accessor :session
@@ -35,7 +34,6 @@ module WIKK
     attr_accessor :port
     attr_accessor :use_ssl
     attr_accessor :response
-  
 
     # Create a WIKK_WebBrowser instance
     #
@@ -46,11 +44,11 @@ module WIKK
     # @return [WIKK_WebBrowser]
     #
     def initialize(host:, port: nil, use_ssl: false, cookies: {}, verify_cert: true, debug: false)
-      @host = host  #Need to do this, as passing nil is different to passing nothing to initialize!
-      @cookies = cookies == nil ? {} : cookies
+      @host = host # Need to do this, as passing nil is different to passing nothing to initialize!
+      @cookies = cookies.nil? ? {} : cookies
       @debug = debug
       @use_ssl = use_ssl
-      @port = port != nil ? port : ( use_ssl ? 443 : 80 )
+      @port = port.nil? ? ( use_ssl ? 443 : 80 ) : port
       @verify_cert = verify_cert
       @response = nil
     end
@@ -78,7 +76,7 @@ module WIKK
     # @param host [String] the host we want to connect to
     # @param port [Fixnum] (443) the port the remote web server is running on
     # @param verify_cert [Boolean] Validate certificate if true (Nb lots of embedded devices have self signed certs, so verify will fail)
-    # @param block [Proc] 
+    # @param block [Proc]
     # @yieldparam [WIKK_WebBrowser] the session descriptor for further calls.
     def self.https_session(host:, port: nil, verify_cert: true, cookies: {}, debug: false)
       wb = self.new(host: host, port: port, cookies: cookies, use_ssl: true, verify_cert: verify_cert, debug: debug)
@@ -88,62 +86,62 @@ module WIKK
     end
 
     # Creating a session for http connection
-    #   attached block would then call get or post NET::HTTP calls
+    # attached block would then call get or post NET::HTTP calls
     # @param port [Fixnum] Optional http server port
     # @param use_ssl [Boolean] Use https, if true
     # @param verify_cert [Boolean] Validate certificate if true (Nb lots of embedded devices have self signed certs, so verify will fail)
-    # @param block [Proc] 
+    # @param block [Proc]
     def http_session
-      @http = Net::HTTP.new(@host, @port)   
+      @http = Net::HTTP.new(@host, @port)
       @http.set_debug_output($stdout) if @debug
-      @http.use_ssl = @use_ssl      
-      @http.verify_mode = OpenSSL::SSL::VERIFY_NONE  if ! @use_ssl || ! @verify_cert 
-      @http.start do |session| #ensure we close the session after the block
-        @session = session 
-        yield 
+      @http.use_ssl = @use_ssl
+      @http.verify_mode = OpenSSL::SSL::VERIFY_NONE if ! @use_ssl || ! @verify_cert
+      @http.start do |session| # ensure we close the session after the block
+        @session = session
+        yield
       end
     end
-  
+
     # Web basic authentication (not exactly secure)
     # @param user [String] Account name
     # @param password [String] Accounts password
     # @return [String] Base64 encoded concatentation of user + ':' + password
     def basic_authorization(user:, password:)
-      #req.basic_auth( user, password) if  user != nil
+      # req.basic_auth( user, password) if  user != nil
       'Basic ' + Base64.encode64( "#{user}:#{password}" )
     end
-  
+
     # Dropbox style token authentication
     # @param token [String] Token, as issued by dropbox
     # @return [String] Concatenation of 'Bearer ' + token
     def bearer_authorization(token:)
-      "Bearer " + token
+      'Bearer ' + token
     end
-  
+
     # Add additional cookies
     # @param cookies [Hash] cookie_name => cookie_value
     def add_cookies(cookies)
       cookies.each { |cookie_name, cookie_value| @cookies[cookie_name] = cookie_value }
     end
-        
-    # Save cookies returned by last html get/post. 
+
+    # Save cookies returned by last html get/post.
     # Removes previous cookies.
     # @param response [Net::HTTPResponse] result from HTTP calls
     def save_cookies(response)
-      if(cookie_lines = response.get_fields('set-cookie')) != nil
-        cookie_lines.each do | cookie_line |
-          cookies = cookie_line.split('; ').map { |v| v.split('=')}
+      if (cookie_lines = response.get_fields('set-cookie')) != nil
+        cookie_lines.each do |cookie_line|
+          cookies = cookie_line.split('; ').map { |v| v.split('=') }
           cookies.each { |c| @cookies[c[0]] = c[1] }
         end
       end
     end
-  
+
     # Convert @cookies to ; separated strings
     # @return cookies string
     def cookies_to_s
       @cookies.to_a.map { |v| v.join('=') }.join('; ')
     end
-    
+
     # Get a header value, from the last response
     #
     # @param key [String] header key
@@ -161,13 +159,13 @@ module WIKK
     # @param extra_headers [Hash] Add these to standard headers
     # @param extra_cookies [Hash] Add these to standard cookies
     # @return [String] The Net::HTTPResponse.body text response from the web server
-    def get_page(query: ,form_values: nil, authorization: nil, extra_headers: {}, extra_cookies: {})
-      $stderr.puts "Debugging On" if @debug
-      query += form_values_to_s(form_values, query.index('?') != nil) #Should be using req.set_form_data, but it seems to by stripping the leading / and then the query fails.
-      url = URI.parse("#{@use_ssl ? "https" : "http"}://#{@host}/#{query.gsub(/^\//,'')}")
+    def get_page(query:, form_values: nil, authorization: nil, extra_headers: {}, extra_cookies: {})
+      $stderr.puts 'Debugging On' if @debug
+      query += form_values_to_s(form_values, query.index('?') != nil) # Should be using req.set_form_data, but it seems to by stripping the leading / and then the query fails.
+      url = URI.parse("#{@use_ssl ? 'https' : 'http'}://#{@host}/#{query.gsub(/^\//, '')}")
       $stderr.puts url if @debug
-    
-      req = Net::HTTP::Get.new(url.request_uri)  
+
+      req = Net::HTTP::Get.new(url.request_uri)
 
       header = { 'HOST' => @host }
       header['Accept'] = '*/*'
@@ -175,41 +173,44 @@ module WIKK
       header['Accept-Language'] = 'en-US,en;q=0.5'
       header['Connection'] = 'keep-alive'
       header['User-Agent'] = 'Mozilla/5.0'
-      header['Content-Type'] = 'application/x-www-form-urlencoded'   
+      header['Content-Type'] = 'application/x-www-form-urlencoded'
       add_cookies(extra_cookies)
       header['Cookie'] = cookies_to_s if @cookies.length > 0
-      header['DNT'] = "1"
+      header['DNT'] = '1'
       header['Authorization'] = authorization if authorization != nil
 
-      extra_headers.each do |k,v| 
+      extra_headers.each do |k, v|
         header[k] = v
       end
-    
+
       req.initialize_http_header( header )
 
-      @response = @session.request(req)      
+      @response = @session.request(req)
       save_cookies(@response)
-    
+
       $stderr.puts @response.code.to_i if @debug
 
-      if(@response.code.to_i >= 300)
-        if(@response.code.to_i == 302)
-            #ignore the redirects.
-            #$stderr.puts "302"
-            #@response.each {|key, val| $stderr.printf "%s = %s\n", key, val }  #Location seems to have cgi params removed. End up with .../cginame?&
-            #$stderr.puts "Redirect to #{@response['location']}"   #Location seems to have cgi params removed. End up with .../cginame?&
-            #$stderr.puts
+      if @response.code.to_i >= 300
+        if @response.code.to_i == 302
+          # ignore the redirects.
+          # $stderr.puts "302"
+          # @response.each {|key, val| $stderr.printf "%s = %s\n", key, val }  #Location seems to have cgi params removed. End up with .../cginame?&
+          # $stderr.puts "Redirect to #{@response['location']}"   #Location seems to have cgi params removed. End up with .../cginame?&
+          # $stderr.puts
           return
         elsif @response.code.to_i >= 400 && @response.code.to_i < 500
           return @response.body
         end
+
         raise Error.new(web_return_code: @response.code.to_i, message: "#{@response.code} #{@response.message} #{query} #{form_values} #{@response.body}")
       end
 
       return @response.body
     end
 
-    # send a POST query to the server and return the response. 
+    alias get get_page
+
+    # send a POST query to the server and return the response.
     # @param query [String] URL, less the 'http://host/'  part
     # @param authorization [String] If present, add Authorization header, using this string
     # @param content_type [String] Posted content type
@@ -218,9 +219,9 @@ module WIKK
     # @param extra_cookies [Hash] Add these to standard cookies
     # @return [String] The Net::HTTPResponse.body text response from the web server
     def post_page(query:, authorization: nil, content_type: 'application/x-www-form-urlencoded', data: nil, extra_headers: {}, extra_cookies: {})
-      url = URI.parse("#{@use_ssl ? "https" : "http"}://#{@host}/#{query}")
+      url = URI.parse("#{@use_ssl ? 'https' : 'http'}://#{@host}/#{query}")
       req = Net::HTTP::Post.new(url.path)
-    
+
       header = { 'HOST' => @host }
       header['Accept'] = '*/*'
       header['Accept-Encoding'] = 'gzip, deflate, br'
@@ -230,80 +231,102 @@ module WIKK
       header['Content-Type'] = content_type
       add_cookies(extra_cookies)
       header['Cookie'] = cookies_to_s if @cookies.length > 0
-      header['DNT'] = "1"
+      header['DNT'] = '1'
       header['Authorization'] = authorization if authorization != nil
-    
-      extra_headers.each do |k,v| 
+
+      extra_headers.each do |k, v|
         header[k] = v
       end
       req.initialize_http_header( header )
-    
-      if data != nil
-        if data.class == Hash
-          if content_type =~ /application\/octet-stream/
-            req.set_form_data(data, '&') 
-          else
-            req.set_form_data.to_j
-          end
+
+      if data.nil?
+        req.body = ''
+      elsif data.instance_of?(Hash)
+        if content_type =~ /application\/octet-stream/
+          req.set_form_data(data, '&')
         else
-          req.body = data #If json as a string or raw string
+          req.set_form_data.to_j
         end
       else
-        req.body = ''
+        req.body = data # If json as a string or raw string
       end
-  
+
       @response = @session.request(req)
       save_cookies(@response)
 
-      if(@response.code.to_i >= 300)
-        if(@response.code.to_i == 302)
-            #ignore the redirects. 
-            #puts "302"
-            #@response.each {|key, val| printf "%s = %s\n", key, val }  #Location seems to have cgi params removed. End up with .../cginame?&
-            #puts "Redirect of Post to #{@response['location']}" #Location seems to have cgi params removed. End up with .../cginame?&
+      if @response.code.to_i >= 300
+        if @response.code.to_i == 302
+          # ignore the redirects.
+          # puts "302"
+          # @response.each {|key, val| printf "%s = %s\n", key, val }  #Location seems to have cgi params removed. End up with .../cginame?&
+          # puts "Redirect of Post to #{@response['location']}" #Location seems to have cgi params removed. End up with .../cginame?&
           return
         end
+
         raise Error.new(web_return_code: @response.code, message: "#{@response.code} #{@response.message} #{query} #{data} #{@response.body}")
       end
-  
+
       return @response.body
     end
 
-    # send a DELETE query to the server and return the response. 
+    alias post post_page
+
+    # send a DELETE query to the server and return the response.
     # @param query [String] URL, less the 'http://host/'  part
     # @param authorization [String] If present, add Authorization header, using this string
+    # @param form_values [Hash{String=>Object-with-to_s}] The parameter passed to the web server eg. ?key1=value1&key2=value2...
+    # @param content_type [String] Posted content type. Only meaningful if there is data
+    # @param data [String] Text to add to body of DELETE to the web server. Not always supported at the server end.
     # @param extra_headers [Hash] Add these to standard headers
     # @param extra_cookies [Hash] Add these to standard cookies
     # @return [String] The Net::HTTPResponse.body text response from the web server
-    def delete_req(query:, authorization: nil, extra_headers: {}, extra_cookies: {})
-      url = URI.parse("#{@use_ssl ? "https" : "http"}://#{@host}/#{query.gsub(/^\//,'')}")
+    def delete_req(query:, authorization: nil, form_values: nil, content_type: '"application/octet-stream"', data: nil, extra_headers: {}, extra_cookies: {})
+      $stderr.puts 'Debugging On' if @debug
+
+      query += form_values_to_s(form_values, query.index('?') != nil)
+      url = URI.parse("#{@use_ssl ? 'https' : 'http'}://#{@host}/#{query.gsub(/^\//, '')}")
       req = Net::HTTP::Delete.new(query)
-    
+
       header = { 'HOST' => @host }
       add_cookies(extra_cookies)
       header['Cookie'] = cookies_to_s if @cookies.length > 0
       header['Authorization'] = authorization if authorization != nil
-    
-      extra_headers.each do |k,v| 
+
+      extra_headers.each do |k, v|
         header[k] = v
       end
       req.initialize_http_header( header )
 
+      if data.nil?
+        req.body = ''
+      elsif data.instance_of?(Hash)
+        if content_type =~ /application\/octet-stream/
+          req.set_form_data(data, '&')
+        else
+          req.set_form_data.to_j
+        end
+      else
+        req.body = data # If json as a string or raw string
+      end
+
       begin
         @response = @session.request(req)
         save_cookies(@response)
-      
-        if(@response.code.to_i >= 300)
+
+        if @response.code.to_i >= 300
           raise "#{url} : #{@response.code} #{@response.message}"
         end
+
         return @response.body
       rescue StandardError => e
         puts "#{e}"
         return nil
       end
     end
-  
-    # send a PUT query to the server and return the response. 
+
+    alias delete delete_req
+
+    # send a PUT query to the server and return the response.
     # @param query [String] URL, less the 'http://host/'  part
     # @param authorization [String] If present, add Authorization header, using this string
     # @param content_type [String] Posted content type
@@ -312,9 +335,9 @@ module WIKK
     # @param extra_cookies [Hash] Add these to standard cookies
     # @return [String] The Net::HTTPResponse.body text response from the web server
     def put_req(query:, authorization: nil, content_type: '"application/octet-stream"', data: nil, extra_headers: {}, extra_cookies: {})
-      url = URI.parse("#{@use_ssl ? "https" : "http"}://#{@host}/#{query}")
+      url = URI.parse("#{@use_ssl ? 'https' : 'http'}://#{@host}/#{query}")
       req = Net::HTTP::Put.new(url.path)
-    
+
       header = { 'HOST' => @host }
       header['Accept'] = '*/*'
       header['Accept-Encoding'] = 'gzip, deflate, br'
@@ -324,85 +347,84 @@ module WIKK
       header['Content-Type'] = content_type
       add_cookies(extra_cookies)
       header['Cookie'] = cookies_to_s if @cookies.length > 0
-      header['DNT'] = "1"
+      header['DNT'] = '1'
       header['Authorization'] = authorization if authorization != nil
-    
-      extra_headers.each do |k,v| 
+
+      extra_headers.each do |k, v|
         header[k] = v
       end
       req.initialize_http_header( header )
-    
-      if data != nil
-        if data.class == Hash
-          if content_type =~ /application\/octet-stream/
-            req.set_form_data(data, '&') 
-          else
-            req.set_form_data.to_j
-          end
+
+      if data.nil?
+        req.body = ''
+      elsif data.instance_of?(Hash)
+        if content_type =~ /application\/octet-stream/
+          req.set_form_data(data, '&')
         else
-          req.body = data #If json as a string or raw string
+          req.set_form_data.to_j
         end
       else
-        req.body = ''
+        req.body = data # If json as a string or raw string
       end
-  
+
       @response = @session.request(req)
       save_cookies(@response)
 
-      if(@response.code.to_i >= 300)
-        if(@response.code.to_i == 302)
-            #ignore the redirects. 
-            #puts "302"
-            #@response.each {|key, val| printf "%s = %s\n", key, val }  #Location seems to have cgi params removed. End up with .../cginame?&
-            #puts "Redirect of Post to #{@response['location']}" #Location seems to have cgi params removed. End up with .../cginame?&
+      if @response.code.to_i >= 300
+        if @response.code.to_i == 302
+          # ignore the redirects.
+          # puts "302"
+          # @response.each {|key, val| printf "%s = %s\n", key, val }  #Location seems to have cgi params removed. End up with .../cginame?&
+          # puts "Redirect of Post to #{@response['location']}" #Location seems to have cgi params removed. End up with .../cginame?&
           return
         end
+
         raise Error.new(web_return_code: @response.code, message: "#{@response.code} #{@response.message} #{query} #{data} #{@response.body}")
       end
-  
+
       return @response.body
     end
 
-    #Extract form field values from the html body.
+    alias put put_req
+
+    # Extract form field values from the html body.
     # @param body [String] The html response body
     # @return [Hash] Keys are the field names, values are the field values
     def extract_input_fields(body)
-      entry = true
       @inputs = {}
       doc = Nokogiri::HTML(body)
-      doc.xpath("//form/input").each do |f|
+      doc.xpath('//form/input').each do |f|
         @inputs[f.get_attribute('name')] = f.get_attribute('value')
       end
     end
 
-    #Extract links from the html body.
+    # Extract links from the html body.
     # @param body [String] The html response body
     # @return [Hash] Keys are the link text, values are the html links
     def extract_link_fields(body)
-      entry = true
       @inputs = {}
       doc = Nokogiri::HTML(body)
-      doc.xpath("//a").each do |f|
-        return URI.parse( f.get_attribute('href') ).path if(f.get_attribute('name') == 'URL$1')
+      doc.xpath('//a').each do |f|
+        return URI.parse( f.get_attribute('href') ).path if f.get_attribute('name') == 'URL$1'
       end
       return nil
     end
 
-    #Take a hash of the params to the post and generate a safe URL string.
+    # Take a hash of the params to the post and generate a safe URL string.
     # @param form_values [Hash] Keys are the field names, values are the field values
     # @param has_q [Boolean] We have a leading ? for the html get, so don't need to add one.
     # @return [String] The 'safe' text for fields the get or post query to the web server
-    def form_values_to_s(form_values=nil, has_q = false)
-      return "" if form_values == nil || form_values.length == 0
-      s = (has_q == true ? "" : "?")
+    def form_values_to_s(form_values = nil, has_q = false)
+      return '' if form_values.nil? || form_values.length == 0
+
+      s = (has_q == true ? '' : '?')
       first = true
-      form_values.each do |key,value|
-        s += "&" if !first
-        s += "#{CGI::escape(key.to_s)}=#{CGI::escape(value.to_s)}"
+      form_values.each do |key, value|
+        s += '&' unless first
+        s += "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"
         first = false
       end
       return s
     end
   end
 end
-

data/version

@@ -1,2 +1,2 @@
 PROJECT="wikk_webbrowser"
-VERSION="0.9.5"
+VERSION="0.9.6"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wikk_webbrowser
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.6
 platform: ruby
 authors:
 - Rob Burrowes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-21 00:00:00.000000000 Z
+date: 2021-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -70,14 +70,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: |-
   Wrapper around ruby http and https libraries.