passwordstate 0.0.4 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9df4373808dbc9ab6b38c17bfa109d60e0c32b6aa5c0cc399045960478e238d0
-  data.tar.gz: 7cee656fb7e2311d8c6ca8dbb210061df3110b2822998f88e1d0a9c31c0f5ccb
+  metadata.gz: 2548f3e172e66faaa1d3a80f2e366161a61694a1874bffa97e68246d0bfbc091
+  data.tar.gz: 273d810d08aafd3849a42ff5397f4d6e123b1557f33f17590106758ee17773dc
 SHA512:
-  metadata.gz: d9838dc2ca7fcaffdcef5443d7e0ec2ffc25d0cc282c9e22646c6467bffd4c1d19a544f50eeb915457afcd96ea07874773768d0829125f3e40fb4943f8faa458
-  data.tar.gz: a5520cbc1051f6e534aa270aaf63bb92b24ba8241a920f3e8f4c4055ca2dd352528a85d1ed55a1bbbba9e7d101bc716b057f438b7e1fbdd3a5ad2f9031947af9
+  metadata.gz: c515ecce21af9bdd9e6c72b85041bd979cd23c3d3bb0927c17f665cd7077834a239daaa5f3001a2251d6fa6914e884f39941ab91c9cc33926f9fa194529f84dd
+  data.tar.gz: e087dc037ce713911d626876677a9aacc818261a717a3e867524fb3aece1d4a28f2dde71329c3896fcda2afbde808021b729f3ec7121800e29d5cb5df3fa2500

data/.github/workflows/ruby.yml

@@ -0,0 +1,33 @@
+---
+name: Ruby
+
+on:
+  push:
+    tags: ["*"]
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1']
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Install rubocop
+        run: gem install -N rubocop
+      - name: Rubocop
+        run: rubocop lib/
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -4,7 +4,8 @@
 /coverage/
 /doc/
 /pkg/
-/spec/reports/
+/test/reports/
 /tmp/
 /vendor/
 Gemfile.lock
+*.gem

data/.gitlab-ci.yml

@@ -1,5 +1,5 @@
 ---
-image: "ruby:2.4"
+image: "ruby:2.7"
 
 # Cache gems in between builds
 cache:
@@ -12,12 +12,15 @@ before_script:
 
 rubocop:
   script:
-    - bundle exec rubocop
+    - bundle exec rubocop lib/ -f p -f ju -o junit.xml
+  artifacts:
+    reports:
+      junit: junit.xml
 
 pages:
-  stage: deploy
+  before_script: []
   script:
-    - gem install yard
+    - gem install yard redcarpet
     - yard doc -o public/
   artifacts:
     paths:
@@ -25,6 +28,6 @@ pages:
   only:
     - master
 
-# rspec:
-#   script:
-#   - rspec spec
+rake:
+  script:
+    - bundle exec rake

data/.rubocop.yml

@@ -1,10 +1,11 @@
 ---
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.7
   Exclude:
     - '*.spec'
     - 'Rakefile'
     - 'vendor/**/*'
+  NewCops: enable
 
 # Don't enforce documentation
 Style/Documentation:
@@ -22,7 +23,7 @@ Style/SafeNavigation:
 Layout/ClosingHeredocIndentation:
   Enabled: false
 
-Layout/IndentHeredoc:
+Layout/HeredocIndentation:
   Enabled: false
 
 Metrics/PerceivedComplexity:
@@ -34,19 +35,15 @@ Metrics/CyclomaticComplexity:
 Style/RescueModifier:
   Enabled: false
 
+Layout/LineLength:
+  Max: 140
+
 Metrics/MethodLength:
   Max: 40
 
-Metrics/LineLength:
-  Max: 190
-
 Metrics/AbcSize:
   Enabled: false
 
-Performance/FixedSize:
-  Exclude:
-    - 'test/**/*'
-
 Metrics/BlockLength:
   Exclude:
     - 'test/**/*'

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## v0.1.0 2022-12-05
+
+- Reduced data transferred for regular queries
+- Fixed support for more modern Ruby (3+)
+- Fixed error handling and changes for newer Passwordstate versions
+- Improved pretty printing when debugging
+
 ## v0.0.4 2019-10-23
 
 - Fixed a client request issue due to a rubocop change

data/README.md

@@ -1,8 +1,8 @@
 # Passwordstate
 
-A ruby gem for communicating with a Passwordstate instance
+A Ruby gem for communicating with a [Passwordstate](https://clickstudios.com.au/passwordstate.aspx) instance
 
-The documentation for the development version can be found at http://iti.gitlab-pages.liu.se/ruby-passwordstate
+The documentation for the development version can be found at https://iti.gitlab-pages.liu.se/ruby-passwordstate
 
 ## Installation
 
@@ -22,22 +22,70 @@ Or install it yourself as:
 
 ## Usage example
 
-```irb
-irb(main):001:0> require 'passwordstate'
-irb(main):002:0> client = Passwordstate::Client.new 'https://passwordstate', username: 'user', password: 'password'
-irb(main):003:0> #        Passwordstate::Client.new 'https://passwordstate', apikey: 'key'
-irb(main):004:0> client.folders
-=> [#<Passwordstate::Resources::Folder:0x000055ed493636e8 @folder_name="Example", @folder_id=2, @tree_path="\\Example">, #<Passwordstate::Resources::Folder:0x000055ed49361fa0 @folder_name="Folder", @folder_id=3, @tree_path="\\Example\\Folder">]
-irb(main):005:0> client.password_lists.get(7).passwords
-=> [#<Passwordstate::Resources::Password:0x0000555fda8acdb8 @title="Webserver1", @user_name="test_web_account", @account_type_id=0, @password="[ REDACTED ]", @allow_export=false, @password_id=2>, #<Passwordstate::Resources::Password:0x0000555fda868640 @title="Webserver2", @user_name="test_web_account2", @account_type_id=0, @password="[ REDACTED ]", @allow_export=false, @password_id=3>, #<Passwordstate::Resources::Password:0x0000555fda84da48 @title="Webserver3", @user_name="test_web_account3", @account_type_id=0, @password="[ REDACTED ]", @allow_export=false, @password_id=4>]
-irb(main):006:0> pw = client.password_lists.first.passwords.create title: 'example', user_name: 'someone', generate_password: true
-=> #<Passwordstate::Resources::Password:0x0000555fdaf9ce98 @title="example", @user_name="someone", @account_type_id=0, @password="[ REDACTED ]", @allow_export=true, @password_id=12, @generate_password=true, @password_list_id=6>
-irb(main):007:0> pw.password
-=> "millionfE2rMrcb2LngBTHnDyxdpsGSmK3"
-irb(main):008:0> pw.delete
-=> true
+```ruby
+require 'passwordstate'
+client = Passwordstate::Client.new 'https://passwordstate.example.com', username: 'user', password: 'password'
+#        Passwordstate::Client.new 'https://passwordstate.example.com', apikey: 'key'
+# #<Passwordstate::Client:0x0000559eb1fabec8
+#  @headers=
+#   {"accept"=>"application/json", "user-agent"=>"RubyPasswordstate/0.1.0"},
+#  @server_url=#<URI::HTTPS https://passwordstate.example.com>,
+#  @timeout=15,
+#  @validate_certificate=true>
+
+client.folders
+# [#<Passwordstate::Resources::Folder:0x000055ed493636e8
+#   @folder_name="Example",
+#   @folder_id=2,
+#   @tree_path="\\Example">,
+#  #<Passwordstate::Resources::Folder:0x000055ed49361fa0
+#   @folder_name="Folder",
+#   @folder_id=3,
+#   @tree_path="\\Example\\Folder">]
+
+client.password_lists.get(7).passwords
+# [#<Passwordstate::Resources::Password:0x0000555fda8acdb8
+#   @title="Webserver1",
+#   @user_name="test_web_account",
+#   @account_type_id=0,
+#   @password="[ REDACTED ]",
+#   @allow_export=false,
+#   @password_id=2>,
+#  #<Passwordstate::Resources::Password:0x0000555fda868640
+#   @title="Webserver2",
+#   @user_name="test_web_account2",
+#   @account_type_id=0,
+#   @password="[ REDACTED ]",
+#   @allow_export=false,
+#   @password_id=3>,
+#  #<Passwordstate::Resources::Password:0x0000555fda84da48
+#   @title="Webserver3",
+#   @user_name="test_web_account3",
+#   @account_type_id=0,
+#   @password="[ REDACTED ]",
+#   @allow_export=false,
+#   @password_id=4>]
+
+pw = client.password_lists.first.passwords.create title: 'example', user_name: 'someone', generate_password: true
+# #<Passwordstate::Resources::Password:0x0000555fdaf9ce98
+#  @title="example",
+#  @user_name="someone",
+#  @account_type_id=0,
+#  @password="[ REDACTED ]",
+#  @allow_export=true,
+#  @password_id=12,
+#  @generate_password=true,
+#  @password_list_id=6>
+
+pw.password
+# "millionfE2rMrcb2LngBTHnDyxdpsGSmK3"
+
+pw.delete
+# true
 ```
 
+A larger - and much more convoluted - example can be found at https://github.com/ananace/foreman_passwordstate/
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ananace/ruby-passwordstate

data/Rakefile

@@ -1,5 +1,5 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"

data/lib/passwordstate/client.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module Passwordstate
   class Client
-    USER_AGENT = "RubyPasswordstate/#{Passwordstate::VERSION}".freeze
+    USER_AGENT = "RubyPasswordstate/#{Passwordstate::VERSION}"
     DEFAULT_HEADERS = {
       'accept' => 'application/json',
       'user-agent' => USER_AGENT
     }.freeze
 
     attr_accessor :server_url, :auth_data, :headers, :validate_certificate
-    attr_reader :timeout
+    attr_reader :open_timeout, :timeout
     attr_writer :api_type
 
     def initialize(url, options = {})
@@ -18,6 +20,7 @@ module Passwordstate
       @headers = DEFAULT_HEADERS
       @auth_data = options.select { |k, _v| %i[apikey username password].include? k }
       @api_type = options.fetch(:api_type) if options.key? :api_type
+      @open_timeout = options.fetch(:open_timeout, 5)
       @timeout = options.fetch(:timeout, 15)
     end
 
@@ -29,27 +32,41 @@ module Passwordstate
       @api_type || (auth_data.key?(:apikey) ? :api : :winapi)
     end
 
+    def open_timeout=(sec)
+      @open_timeout = sec
+      @http.open_timeout = sec if @http
+    end
+
     def timeout=(sec)
       @timeout = sec
       @http.read_timeout = sec if @http
     end
 
+    def address_book
+      ResourceList.new Passwordstate::Resources::AddressBook,
+                       client: self
+    end
+
     def folders
-      ResourceList.new self, Passwordstate::Resources::Folder,
+      ResourceList.new Passwordstate::Resources::Folder,
+                       client: self,
                        only: %i[all search post]
     end
 
     def hosts
-      ResourceList.new self, Passwordstate::Resources::Host,
+      ResourceList.new Passwordstate::Resources::Host,
+                       client: self,
                        except: %i[search put]
     end
 
     def passwords
-      ResourceList.new self, Passwordstate::Resources::Password
+      ResourceList.new Passwordstate::Resources::Password,
+                       client: self
     end
 
     def password_lists
-      ResourceList.new self, Passwordstate::Resources::PasswordList,
+      ResourceList.new Passwordstate::Resources::PasswordList,
+                       client: self,
                        except: %i[put delete]
     end
 
@@ -65,21 +82,31 @@ module Passwordstate
         html = request(:get, '', allow_html: true)
         version = html.find_line { |line| line.include? '<span>V</span>' }
         version = />(\d\.\d) \(Build (.+)\)</.match(version)
-        "#{version[1]}.#{version[2]}"
+        "#{version[1]}.#{version[2]}" if version
       end
     end
 
     def version?(compare)
+      if version.nil?
+        logger.debug 'Unable to detect Passwordstate version, assuming recent enough.'
+        return true
+      end
+
       Gem::Dependency.new(to_s, compare).match?(to_s, version)
     end
 
     def require_version(compare)
+      if version.nil?
+        logger.debug 'Unable to detect Passwordstate version, assuming recent enough.'
+        return true
+      end
+
       raise "Your version of Passwordstate (#{version}) doesn't support the requested feature" unless version? compare
     end
 
-    def request(method, api_path, options = {})
+    def request(method, api_path, query: nil, reason: nil, **options)
       uri = URI(server_url + "/#{api_type}/" + api_path)
-      uri.query = URI.encode_www_form(options.fetch(:query)) if options.key? :query
+      uri.query = URI.encode_www_form(query) unless query.nil?
       uri.query = nil if uri.query.nil? || uri.query.empty?
 
       req_obj = Net::HTTP.const_get(method.to_s.capitalize.to_sym).new uri
@@ -92,7 +119,7 @@ module Passwordstate
       req_obj.ntlm_auth(auth_data[:username], auth_data[:password]) if api_type == :winapi
       headers.each { |h, v| req_obj[h] = v }
       req_obj['APIKey'] = auth_data[:apikey] if api_type == :api
-      req_obj['Reason'] = options.fetch(:reason) if options.key?(:reason) && version?('>= 8.4.8449')
+      req_obj['Reason'] = reason if !reason.nil? && version?('>= 8.4.8449')
 
       print_http req_obj
       res_obj = http.request req_obj
@@ -104,9 +131,11 @@ module Passwordstate
       if data
         return data if res_obj.is_a? Net::HTTPSuccess
 
-        data = data&.first
+        # data = data.first if data.is_a? Array
+        # parsed = data.fetch('errors', []) if data.is_a?(Hash) && data.key?('errors')
+        parsed = [data].flatten
 
-        raise Passwordstate::HTTPError.new_by_code(res_obj.code, req_obj, res_obj, data&.fetch('errors', []) || [])
+        raise Passwordstate::HTTPError.new_by_code(res_obj.code, req_obj, res_obj, parsed || [])
       else
         return res_obj.body if res_obj.is_a?(Net::HTTPSuccess) && options.fetch(:allow_html, true)
 
@@ -114,23 +143,32 @@ module Passwordstate
       end
     end
 
-    def inspect
-      "#{to_s[0..-2]} #{instance_variables.reject { |k| %i[@auth_data @http @logger].include? k }.map { |k| "#{k}=#{instance_variable_get(k).inspect}" }.join ', '}>"
+    def pretty_print_instance_variables
+      instance_variables.reject { |k| %i[@auth_data @http @logger].include? k }.sort
+    end
+
+    def pretty_print(pp)
+      return pp.pp self if respond_to? :mocha_inspect
+
+      pp.pp_object self
     end
 
+    alias inspect pretty_print_inspect
+
     private
 
     def http
       @http ||= Net::HTTP.new server_url.host, server_url.port
       return @http if @http.active?
 
+      @http.open_timeout = @open_timeout if @open_timeout
       @http.read_timeout = @timeout if @timeout
       @http.use_ssl = server_url.scheme == 'https'
       @http.verify_mode = validate_certificate ? ::OpenSSL::SSL::VERIFY_NONE : nil
       @http.start
     end
 
-    def print_http(http, truncate = true)
+    def print_http(http, truncate: true)
       return unless logger.debug?
 
       if http.is_a? Net::HTTPRequest
@@ -147,9 +185,17 @@ module Passwordstate
 
       return if http.body.nil?
 
+      body_cleaner = lambda do |obj|
+        obj.each { |k, v| v.replace('[ REDACTED ]') if k.is_a?(String) && %w[password apikey].include?(k.downcase) } if obj.is_a? Hash
+      end
+
       clean_body = JSON.parse(http.body) rescue nil
       if clean_body
-        clean_body = clean_body.each { |k, v| v.replace('[ REDACTED ]') if k.is_a?(String) && %w[password apikey].include?(k.downcase) }.to_json if http.body
+        if clean_body.is_a? Array
+          clean_body.each { |val| body_cleaner.call(val) }
+        else
+          body_cleaner.call(clean_body)
+        end
       else
         clean_body = http.body
       end

data/lib/passwordstate/errors.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 module Passwordstate
   class PasswordstateError < RuntimeError; end
 
+  class NotAcceptableError < PasswordstateError; end
+
   class HTTPError < PasswordstateError
     attr_reader :code, :request, :response, :errors
 
@@ -10,7 +14,8 @@ module Passwordstate
       @response = response
       @errors = errors
 
-      super "Passwordstate responded with an error to the request:\n#{errors.map { |err| err['message'] || err['phrase'] }.join('; ')}"
+      errorstr = errors.map { |err| err['message'] || err['phrase'] || err['error'] }.join('; ')
+      super "Passwordstate responded with an error to the request:\n#{errorstr}"
     end
 
     def self.new_by_code(code, req, res, errors = [])