opensrs 0.3.8 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ab4edecdc574d1a43b6363a82ee08aafec9009c4
-  data.tar.gz: 2573a679c20e68b6620480f8b6098344a8b96741
+SHA256:
+  metadata.gz: 71d1e83d17bb3fbcf14fe9da34120322c4411bfeb37b9f6023806467025e5d5f
+  data.tar.gz: 941f1cc4275cf0f64635d6ed5e326a7ebdb9bc6ee98230c495de7e809637d661
 SHA512:
-  metadata.gz: 66a37ff3deabef598de0110754b6ccc56d03b86abe14c40ed35f273145eec35e414aaa5788a63904086cf91027dbae1d7d1c786d82320b0976dcdc0e01dd5026
-  data.tar.gz: 3bd39902a5ba5e08bf23f04c1e3f201e4e9e57e07af3b168c06e0dd42098031c9f5ebcdf151dadadb18729f63b7391d7a0234a2aec469851415c44b2ccfcd476
+  metadata.gz: df149b8fcd50164c419c51aa789d4dab1e8409952ec0b4b1f2fcd202948111512931d82a5169635b8690feec9f01d82fba0548b5952691dcf2d3323081b25210
+  data.tar.gz: 54e8f4bcbb4538d6215d94dd3bcd797f59dffa7e120a181b2af62d4f38c1cf8fb737d8298e516feda9f7bfc7b100b894714ea33cab4f8fc00458ab95b4b5c330

data/.github/workflows/rubocop-analysis.yml

@@ -0,0 +1,43 @@
+# pulled from repo
+name: "Rubocop"
+
+on:
+  push:
+    branches: [ master, rubocop ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master, rubocop ]
+  schedule:
+    - cron: '37 10 * * 2'
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # If running on a self-hosted runner, check it meets the requirements
+    # listed at https://github.com/ruby/setup-ruby#using-self-hosted-runners
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+
+    - name: Install dependencies
+      run: bundle install
+
+    - name: Rubocop run
+      run: |
+        bash -c "
+          bundle exec rubocop --require code_scanning --format CodeScanning::SarifFormatter -o rubocop.sarif
+          [[ $? -ne 2 ]]
+        "
+
+    - name: Upload Sarif output
+      uses: github/codeql-action/upload-sarif@v1
+      with:
+        sarif_file: rubocop.sarif

data/.gitignore

@@ -1,4 +1,5 @@
 /.bundle/
+/.vscode
 /.yardoc
 /Gemfile.lock
 /_yardoc/
@@ -13,3 +14,4 @@
 *.a
 *.gem
 mkmf.log
+*.sarif

data/.rubocop.yml

@@ -0,0 +1,131 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.5
+  SuggestExtensions: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+RSpec/FilePath:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/StubbedMock:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/ClassVars:
+  Enabled: false
+
+Gemspec/DateAssignment: # (new in 1.10)
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation: # (new in 1.18)
+  Enabled: true
+Layout/SpaceBeforeBrackets: # (new in 1.7)
+  Enabled: true
+Lint/AmbiguousAssignment: # (new in 1.7)
+  Enabled: true
+Lint/AmbiguousRange: # (new in 1.19)
+  Enabled: true
+Lint/DeprecatedConstants: # (new in 1.8)
+  Enabled: true
+Lint/DuplicateBranch: # (new in 1.3)
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
+  Enabled: true
+Lint/EmptyBlock: # (new in 1.1)
+  Enabled: true
+Lint/EmptyClass: # (new in 1.3)
+  Enabled: true
+Lint/EmptyInPattern: # (new in 1.16)
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # (new in 1.8)
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
+  Enabled: true
+Lint/NumberedParameterAssignment: # (new in 1.9)
+  Enabled: true
+Lint/OrAssignmentToConstant: # (new in 1.9)
+  Enabled: true
+Lint/RedundantDirGlobSort: # (new in 1.8)
+  Enabled: true
+Lint/SymbolConversion: # (new in 1.9)
+  Enabled: true
+Lint/ToEnumArguments: # (new in 1.1)
+  Enabled: true
+Lint/TripleQuotes: # (new in 1.9)
+  Enabled: true
+Lint/UnexpectedBlockArity: # (new in 1.5)
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
+  Enabled: true
+Naming/InclusiveLanguage: # (new in 1.18)
+  Enabled: true
+Style/ArgumentsForwarding: # (new in 1.1)
+  Enabled: true
+Style/CollectionCompact: # (new in 1.2)
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # (new in 1.1)
+  Enabled: true
+Style/EndlessMethod: # (new in 1.8)
+  Enabled: true
+Style/HashConversion: # (new in 1.10)
+  Enabled: true
+Style/HashExcept: # (new in 1.7)
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # (new in 1.9)
+  Enabled: true
+Style/InPatternThen: # (new in 1.16)
+  Enabled: true
+Style/MultilineInPatternThen: # (new in 1.16)
+  Enabled: true
+Style/NegatedIfElseCondition: # (new in 1.2)
+  Enabled: true
+Style/NilLambda: # (new in 1.3)
+  Enabled: true
+Style/QuotedSymbols: # (new in 1.16)
+  Enabled: true
+Style/RedundantArgument: # (new in 1.4)
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # (new in 1.19)
+  Enabled: true
+Style/StringChars: # (new in 1.12)
+  Enabled: true
+Style/SwapValues: # (new in 1.1)
+  Enabled: true
+RSpec/IdenticalEqualityAssertion: # (new in 2.4)
+  Enabled: true
+RSpec/Rails/AvoidSetupHook: # (new in 2.4)
+  Enabled: true

data/Gemfile.lock

@@ -1,32 +1,43 @@
 PATH
   remote: .
   specs:
-    opensrs (0.3.6)
+    opensrs (0.3.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.2.1)
+    activesupport (4.2.10)
       i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
+    ast (2.4.2)
+    code-scanning-rubocop (0.5.0)
+      rubocop (~> 1.0)
     coderay (1.1.0)
+    concurrent-ruby (1.0.5)
     diff-lcs (1.2.5)
-    i18n (0.7.0)
-    json (1.8.2)
-    libxml-ruby (2.8.0)
+    i18n (0.9.3)
+      concurrent-ruby (~> 1.0)
+    libxml-ruby (3.2.1)
     method_source (0.8.2)
-    mini_portile (0.6.2)
-    minitest (5.6.1)
-    nokogiri (1.6.6.2)
-      mini_portile (~> 0.6.0)
+    mini_portile2 (2.5.1)
+    minitest (5.11.3)
+    nokogiri (1.11.4)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
     pry (0.10.1)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    rake (10.4.2)
+    racc (1.5.2)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
     rspec (3.2.0)
       rspec-core (~> 3.2.0)
       rspec-expectations (~> 3.2.0)
@@ -40,6 +51,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.2.0)
     rspec-support (3.2.2)
+    rubocop (1.19.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.10.0)
+      parser (>= 3.0.1.1)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
     shoulda (3.5.0)
       shoulda-context (~> 1.0, >= 1.0.1)
       shoulda-matchers (>= 1.4.1, < 3.0)
@@ -47,19 +73,27 @@ GEM
     shoulda-matchers (2.8.0)
       activesupport (>= 3.0.0)
     slop (3.6.0)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.4)
       thread_safe (~> 0.1)
+    unicode-display_width (2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport (~> 4.2.2)
   bundler
-  libxml-ruby (~> 2)
-  nokogiri
+  code-scanning-rubocop (~> 0.5)
+  libxml-ruby (~> 3)
+  nokogiri (~> 1.11.4)
   opensrs!
   pry
   rake
   rspec
+  rubocop (~> 1)
+  rubocop-rspec
   shoulda
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -1,17 +1,13 @@
 # OpenSRS
 
-[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/voxxit/opensrs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
-[![Build Status](https://travis-ci.org/voxxit/opensrs.svg?branch=master)](https://travis-ci.org/voxxit/opensrs)
-[![Code Climate](https://codeclimate.com/github/voxxit/opensrs/badges/gpa.svg)](https://codeclimate.com/github/voxxit/opensrs)
 [![Coverage Status](https://img.shields.io/coveralls/voxxit/opensrs.svg)](https://coveralls.io/r/voxxit/opensrs)
 
-This (unofficial) OpenSRS gem provides basic support to connect to, and utilize the [OpenSRS API.](http://www.opensrs.com/site/resources/documentation/api) This library has been well-tested in high-performance production
+This unofficial OpenSRS gem provides basic support to connect to and utilize the [OpenSRS API.](http://www.opensrs.com/site/resources/documentation/api) This library has been well-tested in high-performance production
 environments.
 
 ### Requirements
 
-  * Ruby **>= 1.9.2** or **>= 2.0.0** or **>= 2.1.2**
+  * Ruby **>= 2.5**
 
 ### Installation
 
@@ -101,7 +97,6 @@ Responses from OpenSRS are returned in an OpenSRS::Response object, which gives
   Method | Description
   ---|---
   `response.response` | This gives you the response in a Hash form, which is highly accessible to most other actions in your application.
-  `response.response` | This gives you the response in a Hash form, which is highly accessible to most other actions in your application.
   `response.errors` | If there are errors which come back from OpenSRS, they are returned here. If not, it returns nil.
   `response.success?` | Returns true if the response was labeled as successful. If not, it returns false.
   `response.request_xml` | Returns raw request XML.
@@ -126,9 +121,6 @@ If you have any bugs or feature requests for this gem, feel free to [open an iss
 
 ### Copyright
 
-Copyright (c) 2010-2016 Joshua Delsman.
+Copyright (c) 2010-2021 Joshua Delsman.
 
 Distributed under the MIT license. See `LICENSE` for details.
-
-
-[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/voxxit/opensrs/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

data/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/SECURITY.md

@@ -0,0 +1,12 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.4.x   | :white_check_mark: |
+| < 0.4.x | :x:                |
+
+## Reporting a Vulnerability
+
+Please encyrpt your message to me at https://keybase.io/encrypt#jdelsman, then send to j@srv.im. Since this is an unsupported open-source project, I will get to it as quickly as I can.

data/bin/console

@@ -1,10 +1,9 @@
 #!/usr/bin/env ruby
+require 'bundler/setup'
+require 'opensrs'
 
-require "bundler/setup"
-require "opensrs"
-
-require "pry"
+require 'pry'
 Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/opensrs.rb

@@ -1,7 +1,9 @@
-require "opensrs/xml_processor"
-require "opensrs/server"
-require "opensrs/response"
-require "opensrs/version"
+require 'opensrs/xml_processor'
+require 'opensrs/server'
+require 'opensrs/response'
+require 'opensrs/sanitizable_string'
+require 'opensrs/version'
 
+# OpenSRS
 module OpenSRS
 end

data/lib/opensrs/response.rb

@@ -1,4 +1,5 @@
 module OpenSRS
+  # Response
   class Response
     attr_reader :request_xml, :response_xml
     attr_accessor :response, :success
@@ -13,19 +14,22 @@ module OpenSRS
     # We need to return the error message unless the
     # response is successful.
     def errors
-      unless success?
-        msg  = @response["response_text"]
-        code = @response["response_code"]
+      return if success?
 
-        return msg && code ? "#{msg} (Code #{code})" : "Unknown error"
-      end
+      msg  = @response['response_text']
+      code = @response['response_code']
+
+      msg && code ? "#{msg} (Code #{code})" : 'Unknown error'
     end
 
     # If 'is_success' is returned, the API is letting us know that they
     # will explicitly tell us whether something has succeeded or not.
-    # Otherwise, just assume it is successful.
+    #
+    # Otherwise, just assume it failed.
     def success?
-      @response["is_success"] && @response["is_success"] == "1" ? true : false
+      return false unless @response['is_success']
+
+      @response['is_success'] == '1'
     end
   end
 end

data/lib/opensrs/sanitizable_string.rb

@@ -0,0 +1,21 @@
+require 'delegate'
+
+module OpenSRS
+  # SanitizableString
+  class SanitizableString < SimpleDelegator
+    @enable_sanitization = false
+
+    class << self
+      attr_accessor :enable_sanitization
+    end
+
+    def initialize(original_string, sanitized_string)
+      super(original_string)
+      @sanitized_string = sanitized_string
+    end
+
+    def sanitized
+      self.class.enable_sanitization ? @sanitized_string : self
+    end
+  end
+end

data/lib/opensrs/server.rb

@@ -1,45 +1,53 @@
-require "uri"
-require "net/https"
-require "digest/md5"
-require "openssl"
+require 'uri'
+require 'net/https'
+require 'digest/md5'
+require 'openssl'
 
 module OpenSRS
   class OpenSRSError < StandardError; end
 
   class BadResponse < OpenSRSError; end
+
   class ConnectionError < OpenSRSError; end
+
   class TimeoutError < ConnectionError; end
 
+  # Server
   class Server
-    attr_accessor :server, :username, :password, :key, :timeout, :open_timeout, :logger
+    attr_accessor :server, :username, :password, :key, :timeout, :open_timeout, :logger, :proxy
 
     def initialize(options = {})
-      @server   = URI.parse(options[:server] || "https://rr-n1-tor.opensrs.net:55443/")
+      @server   = URI.parse(options[:server] || 'https://rr-n1-tor.opensrs.net:55443/')
       @username = options[:username]
       @password = options[:password]
       @key      = options[:key]
       @timeout  = options[:timeout]
       @open_timeout = options[:open_timeout]
       @logger   = options[:logger]
+      @proxy    = URI.parse(options[:proxy]) if options[:proxy]
+      @sanitize_request = options[:sanitize_request]
+
+      OpenSRS::SanitizableString.enable_sanitization = @sanitize_request
     end
 
     def call(data = {})
-      xml = xml_processor.build({ :protocol => "XCP" }.merge!(data))
-      log('Request', xml, data)
+      xml = xml_processor.build({ protocol: 'XCP' }.merge!(data))
+      log('Request', xml.sanitized, data)
 
       begin
         response = http.post(server_path, xml, headers(xml))
         log('Response', response.body, data)
       rescue Net::HTTPBadResponse
-        raise OpenSRS::BadResponse, "Received a bad response from OpenSRS. Please check that your IP address is added to the whitelist, and try again."
+        raise OpenSRS::BadResponse,
+              'Received a bad response from OpenSRS. Please check that your IP address is added to the whitelist, and try again.'
       end
 
       parsed_response = xml_processor.parse(response.body)
-      return OpenSRS::Response.new(parsed_response, xml, response.body)
-    rescue Timeout::Error => err
-      raise OpenSRS::TimeoutError, err
-    rescue Errno::ECONNRESET, Errno::ECONNREFUSED => err
-      raise OpenSRS::ConnectionError, err
+      OpenSRS::Response.new(parsed_response, xml.sanitized, response.body)
+    rescue Timeout::Error => e
+      raise OpenSRS::TimeoutError, e
+    rescue Errno::ECONNRESET, Errno::ECONNREFUSED => e
+      raise OpenSRS::ConnectionError, e
     end
 
     def xml_processor
@@ -48,17 +56,17 @@ module OpenSRS
 
     def self.xml_processor=(name)
       require "opensrs/xml_processor/#{name.to_s.downcase}"
-      @@xml_processor = OpenSRS::XmlProcessor.const_get("#{name.to_s.capitalize}")
+      @@xml_processor = OpenSRS::XmlProcessor.const_get(name.to_s.capitalize.to_s)
     end
 
     private
 
     def headers(request)
       {
-        "Content-Length"  => request.length.to_s,
-        "Content-Type"    => "text/xml",
-        "X-Username"      => username,
-        "X-Signature"     => signature(request)
+        'Content-Length' => request.length.to_s,
+        'Content-Type' => 'text/xml',
+        'X-Username' => username,
+        'X-Signature' => signature(request)
       }
     end
 
@@ -67,8 +75,13 @@ module OpenSRS
     end
 
     def http
-      http = Net::HTTP.new(server.host, server.port)
-      http.use_ssl = (server.scheme == "https")
+      http = if @proxy
+               Net::HTTP.new(server.host, server.port, @proxy.host, @proxy.port, @proxy.user, @proxy.password)
+             else
+               Net::HTTP.new(server.host, server.port)
+             end
+
+      http.use_ssl = (server.scheme == 'https')
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE
       http.read_timeout = http.open_timeout = @timeout if @timeout
       http.open_timeout = @open_timeout                if @open_timeout

data/lib/opensrs/version.rb

@@ -1,3 +1,3 @@
 module OpenSRS
-  VERSION = "0.3.8"
+  VERSION = '0.4.0'.freeze
 end

data/lib/opensrs/xml_processor.rb

@@ -1,18 +1,16 @@
 module OpenSRS
+  # XmlProcessor
   class XmlProcessor
-
     # Parses the main data block from OpenSRS and discards
     # the rest of the response.
     def self.parse(response)
       data_block = data_block_element(response)
 
-      raise ArgumentError.new("No data found in document") if !data_block
+      raise ArgumentError, 'No data found in document' unless data_block
 
-      return decode_data(data_block)
+      decode_data(data_block)
     end
 
-    protected
-
     # Encodes individual elements, and their child elements, for the root XML document.
     def self.encode_data(data, container = nil)
       case data
@@ -42,11 +40,16 @@ module OpenSRS
       # if hash, item will be array of the key & value
       data.each_with_index do |item, index|
         item_node = new_element(:item, container)
-        item_node["key"] = item.is_a?(Array) ? item[0].to_s : index.to_s
+        item_node['key'] = item.is_a?(Array) ? item[0].to_s : index.to_s
 
         value = item.is_a?(Array) ? item[1] : item
 
-        item_node << encode_data(value, item_node)
+        encoded_data = encode_data(value, item_node)
+        if encoded_data.is_a?(String)
+          item_node.content = encoded_data
+        else
+          item_node << encoded_data
+        end
         element << item_node
       end
 
@@ -58,16 +61,16 @@ module OpenSRS
     def self.decode_data(data)
       data.each do |element|
         case element.name
-        when "dt_array"
+        when 'dt_array'
           return decode_dt_array_data(element)
-        when "dt_assoc"
+        when 'dt_assoc'
           return decode_dt_assoc_data(element)
-        when "text", "item", "dt_scalar"
+        when 'text', 'item', 'dt_scalar'
           next if element.content.strip.empty?
+
           return element.content.strip
         end
       end
     end
-
   end
 end

data/lib/opensrs/xml_processor/libxml.rb

@@ -1,12 +1,13 @@
 begin
   require 'libxml'
 rescue LoadError => e
-  $stderr.puts "Cannot find `libxml` gem. Please install it before using it as the XML processor"
+  warn 'Cannot find `libxml` gem. Please install it before using it as the XML processor'
   raise e
 end
 
 module OpenSRS
   class XmlProcessor
+    # Libxml
     class Libxml < OpenSRS::XmlProcessor
       include ::LibXML::XML
 
@@ -14,23 +15,35 @@ module OpenSRS
       # go ahead and build the entire XML document to send to OpenSRS.
       def self.build(data)
         xml = Document.new
-        xml.root = envelope = Node.new("OPS_envelope")
+        xml.root = envelope = Node.new('OPS_envelope')
 
-        envelope << header = Node.new("header")
-        envelope << body = Node.new("body")
-        header   << Node.new("version", "0.9")
-        body     << data_block = Node.new("data_block")
+        envelope << header = Node.new('header')
+        envelope << body = Node.new('body')
+        header   << Node.new('version', '0.9')
+        body     << data_block = Node.new('data_block')
 
         data_block << encode_data(data, data_block)
 
-        return xml.to_s
+        OpenSRS::SanitizableString.new(xml.to_s, sanitize(xml).to_s)
       end
 
-      protected
+      def self.sanitize(doc)
+        # Before changing the iteration through the nodes, read:
+        # https://www.rubydoc.info/gems/libxml-ruby/LibXML/XML/Document#find-instance_method
+
+        username_nodes = doc.find("//item[@key='reg_username']")
+        username_nodes.each { |node| node.content = 'FILTERED' }
+
+        password_nodes = doc.find("//item[@key='reg_password']")
+        password_nodes.each { |node| node.content = 'FILTERED' }
+
+        doc
+      end
+      private_class_method :sanitize
 
       def self.data_block_element(response)
         doc = Parser.string(response).parse
-        return doc.find("//OPS_envelope/body/data_block/*")
+        doc.find('//OPS_envelope/body/data_block/*')
       end
 
       def self.decode_dt_array_data(element)
@@ -38,10 +51,11 @@ module OpenSRS
 
         element.children.each do |item|
           next if item.empty?
-          dt_array[item.attributes["key"].to_i] = decode_data(item)
+
+          dt_array[item.attributes['key'].to_i] = decode_data(item)
         end
 
-        return dt_array
+        dt_array
       end
 
       def self.decode_dt_assoc_data(element)
@@ -49,19 +63,19 @@ module OpenSRS
 
         element.children.each do |item|
           next if item.content.strip.empty?
-          dt_assoc[item.attributes["key"]] = decode_data(item)
+
+          dt_assoc[item.attributes['key']] = decode_data(item)
         end
 
-        return dt_assoc
+        dt_assoc
       end
 
       # Accepts two parameters but uses only one; to keep the interface same as other xml parser classes
       # Is that a side effect of Template pattern?
       #
-      def self.new_element(element_name, container)
-        return Node.new(element_name.to_s)
+      def self.new_element(element_name, _container)
+        Node.new(element_name.to_s)
       end
-
     end
   end
 end

data/lib/opensrs/xml_processor/nokogiri.rb

@@ -1,22 +1,22 @@
 begin
   require 'nokogiri'
 rescue LoadError => e
-  $stderr.puts "Cannot find `nokogiri` gem. Please install it before using it as the XML processor"
+  warn 'Cannot find `nokogiri` gem. Please install it before using it as the XML processor'
   raise e
 end
 
 module OpenSRS
   class XmlProcessor
+    # Nokogiri
     class Nokogiri < OpenSRS::XmlProcessor
-
       def self.build(data)
         builder = ::Nokogiri::XML::Builder.new
 
-        envelope   = ::Nokogiri::XML::Node.new("OPS_envelope", builder.doc)
-        header     = ::Nokogiri::XML::Node.new("header", builder.doc)
-        version    = ::Nokogiri::XML::Node.new("version", builder.doc)
-        body       = ::Nokogiri::XML::Node.new("body", builder.doc)
-        data_block = ::Nokogiri::XML::Node.new("data_block", builder.doc)
+        envelope   = ::Nokogiri::XML::Node.new('OPS_envelope', builder.doc)
+        header     = ::Nokogiri::XML::Node.new('header', builder.doc)
+        version    = ::Nokogiri::XML::Node.new('version', builder.doc)
+        body       = ::Nokogiri::XML::Node.new('body', builder.doc)
+        data_block = ::Nokogiri::XML::Node.new('data_block', builder.doc)
         other_data = encode_data(data, builder.doc)
         version << '0.9'
         header << version
@@ -25,14 +25,25 @@ module OpenSRS
         data_block << other_data
         body << data_block
         envelope << body
-        return builder.to_xml
+
+        OpenSRS::SanitizableString.new(builder.to_xml, sanitize(builder.to_xml))
       end
 
-      protected
+      def self.sanitize(xml_string)
+        doc = ::Nokogiri::XML(xml_string)
+        doc.xpath("//item[@key='reg_username']").each do |node|
+          node.content = 'FILTERED'
+        end
+        doc.xpath("//item[@key='reg_password']").each do |node|
+          node.content = 'FILTERED'
+        end
+        doc.to_xml
+      end
+      private_class_method :sanitize
 
       def self.data_block_element(response)
         doc = ::Nokogiri::XML(response)
-        return doc.xpath('//OPS_envelope/body/data_block/*')
+        doc.xpath('//OPS_envelope/body/data_block/*')
       end
 
       def self.decode_dt_array_data(element)
@@ -40,10 +51,11 @@ module OpenSRS
 
         element.children.each do |item|
           next if item.content.strip.empty?
-          dt_array[item.attributes["key"].value.to_i] = decode_data(item.children)
+
+          dt_array[item.attributes['key'].value.to_i] = decode_data(item.children)
         end
 
-        return dt_array
+        dt_array
       end
 
       def self.decode_dt_assoc_data(element)
@@ -51,16 +63,16 @@ module OpenSRS
 
         element.children.each do |item|
           next if item.content.strip.empty?
-          dt_assoc[item.attributes["key"].value] = decode_data(item.children)
+
+          dt_assoc[item.attributes['key'].value] = decode_data(item.children)
         end
 
-        return dt_assoc
+        dt_assoc
       end
 
       def self.new_element(element_name, container)
-        return ::Nokogiri::XML::Node.new(element_name.to_s, container)
+        ::Nokogiri::XML::Node.new(element_name.to_s, container)
       end
-
     end
   end
 end

data/opensrs.gemspec

@@ -1,29 +1,32 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "opensrs/version"
+require 'opensrs/version'
 
 Gem::Specification.new do |spec|
-
-  spec.name          = "opensrs"
+  spec.name          = 'opensrs'
   spec.version       = OpenSRS::VERSION
-  spec.authors       = [ "Joshua Delsman" ]
-  spec.email         = [ "j@srv.im" ]
-  spec.summary       = "OpenSRS API for Ruby"
-  spec.description   = "Provides support to utilize the OpenSRS API with Ruby."
-  spec.homepage      = "https://github.com/voxxit/opensrs"
-  spec.license       = "MIT"
+  spec.authors       = ['Joshua Delsman']
+  spec.email         = ['j@srv.im']
+  spec.summary       = 'OpenSRS API for Ruby'
+  spec.description   = 'Provides support to utilize the OpenSRS API with Ruby.'
+  spec.homepage      = 'https://github.com/voxxit/opensrs'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '~> 2.5'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "libxml-ruby", "~> 2"
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "shoulda"
-  spec.add_development_dependency "nokogiri"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency 'activesupport', '~> 4.2.2'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'code-scanning-rubocop', '~> 0.5'
+  spec.add_development_dependency 'libxml-ruby', '~> 3'
+  spec.add_development_dependency 'nokogiri', '~> 1.11.4'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop', '~> 1'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'shoulda'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: opensrs
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.4.0
 platform: ruby
 authors:
 - Joshua Delsman
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-09-03 00:00:00.000000000 Z
+date: 2021-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: libxml-ruby
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 4.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 4.2.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: code-scanning-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: libxml-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.4
+- !ruby/object:Gem::Dependency
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +123,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: shoulda
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -116,17 +172,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".document"
+- ".github/workflows/rubocop-analysis.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- SECURITY.md
 - bin/console
 - bin/setup
 - lib/opensrs.rb
 - lib/opensrs/response.rb
+- lib/opensrs/sanitizable_string.rb
 - lib/opensrs/server.rb
 - lib/opensrs/version.rb
 - lib/opensrs/xml_processor.rb
@@ -137,25 +197,23 @@ homepage: https://github.com/voxxit/opensrs
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.0.3.1
+signing_key:
 specification_version: 4
 summary: OpenSRS API for Ruby
 test_files: []
-has_rdoc: