passwordstate 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ead3a53cdb04468a85069d55f1e6764562ea518dfb1ccb2e0b640c883ecfc85f
-  data.tar.gz: 4d4dee12f8a862302b80c7fdb2027a0fb98bfe0a7ab45ece68622a6e42a9ed6a
+  metadata.gz: 8339c30925359da2d1fb10918796945cb5bdc4ad56beff7e99af39781bdfae96
+  data.tar.gz: 6d9c0c54ce250813c874fa7007c63e8378c9c20ac4a6b9df887b6fe74b5939b9
 SHA512:
-  metadata.gz: f306e2cf53329fc8f83f6364d02ec940a3df971f1f9b79e9e9866f40084c75e1fd96aeef42bca640f98e7507bb799006603f2007cf3cd01e5004eaeb93695ff9
-  data.tar.gz: 1f744f7a0f2bdd43b536b71de33bd218f1d496b79fcbfc4d0d284afdf9f80b35307c2acc21165e94d692268c22203ba1adb0a470ef76ba246c6292458cd971a2
+  metadata.gz: 7cbe2c67683aa901f0d4b3fc4c9991115c59f93ecef0b1b8436e78c0f752abcf71c60a2f8151df7714e0d872d9620402a2fc1273d30875f70648916f8f5459ab
+  data.tar.gz: 5feb809a4426576eb901a18c137f0d70337a692ef7cfdc633122ca1d0042d7b59f1727841f8b32ff68186ff0cc93cf4fa895de21622b250d5d9c92341d44a709

data/.gitlab-ci.yml

@@ -1,5 +1,5 @@
 ---
-image: "ruby:2.7"
+image: "ruby"
 
 # Cache gems in between builds
 cache:

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## v0.1.2 2025-08-26
+
+- Improved performance when working with large lists
+
+## v0.1.1 2024-03-27
+
+- Add Client#open_timeout=
+- Add Resource#modified?
+
 ## v0.1.0 2022-12-05
 
 - Reduced data transferred for regular queries

data/lib/passwordstate/client.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'json'
+require 'pp' # rubocop:disable Lint/RedundantRequireStatement - required for pretty_print_inspect
 
 module Passwordstate
   class Client
@@ -11,7 +12,7 @@ module Passwordstate
     }.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 = {})
@@ -20,6 +21,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
 
@@ -31,6 +33,11 @@ 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
@@ -155,6 +162,7 @@ module Passwordstate
       @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

data/lib/passwordstate/errors.rb

@@ -12,10 +12,14 @@ module Passwordstate
       @code = code.to_i
       @request = request
       @response = response
+
+      if errors.count == 1 && errors.first.is_a?(Hash) && errors.first.key?('errors')
+        errors = errors.first['errors']
+      end
       @errors = errors
 
       errorstr = errors.map { |err| err['message'] || err['phrase'] || err['error'] }.join('; ')
-      super "Passwordstate responded with an error to the request:\n#{errorstr}"
+      super("Passwordstate responded with an error to the request:\n#{errorstr}")
     end
 
     def self.new_by_code(code, req, res, errors = [])

data/lib/passwordstate/resource.rb

@@ -34,8 +34,7 @@ module Passwordstate
 
     def initialize(data)
       @client = data.delete :_client
-      set! data, store_old: false
-      old
+      set! data
     end
 
     # Is the object stored on the Passwordstate server
@@ -126,7 +125,7 @@ module Passwordstate
       nil_as_string = opts.fetch(:nil_as_string, self.class.nil_as_string)
       (self.class.send(:accessor_field_names) + self.class.send(:read_field_names) + self.class.send(:write_field_names)).to_h do |field|
         redact = self.class.send(:field_options)[field]&.fetch(:redact, false) && !ignore_redact
-        at_field = "@#{field}".to_sym
+        at_field = :"@#{field}"
         field = at_field if atify
         value = instance_variable_get(at_field) unless redact
         value = '[ REDACTED ]' if redact
@@ -151,6 +150,12 @@ module Passwordstate
       end
     end
 
+    def modified?(field = nil)
+      return modified.any? unless field
+
+      modified.include? field
+    end
+
     protected
 
     def api_path
@@ -158,20 +163,11 @@ module Passwordstate
     end
 
     def modified
-      attribs = attributes
-      attribs.reject { |field| old[field] == attribs[field] }
+      @modified ||= {}
     end
 
-    def modified?(field)
-      modified.include? field
-    end
-
-    def old
-      @old ||= attributes.dup
-    end
-
-    def set!(data, store_old: true)
-      @old = attributes.dup if store_old
+    def set!(data, reset_modified = true)
+      @modified = {} if reset_modified
       data = data.attributes if data.is_a? Passwordstate::Resource
       data.each do |key, value|
         field = self.class.passwordstate_to_ruby_field(key)
@@ -188,7 +184,7 @@ module Passwordstate
           parsed_value = convert.call(value, direction: :from)
         end
 
-        instance_variable_set "@#{field}".to_sym, parsed_value || value
+        instance_variable_set :"@#{field}", parsed_value || value
       end
       self
     end
@@ -272,7 +268,8 @@ module Passwordstate
         fields.each do |field|
           if field.is_a? Symbol
             accessor_field_names << field
-            attr_accessor field
+            attr_reader field
+            build_writer_method field
           else
             field_options[accessor_field_names.last] = field
           end
@@ -294,12 +291,24 @@ module Passwordstate
         fields.each do |field|
           if field.is_a? Symbol
             write_field_names << field
-            attr_writer field
+            build_writer_method field
           else
             field_options[write_field_names.last] = field
           end
         end
       end
+
+      private
+
+      def build_writer_method(field)
+        field = field.to_s.to_sym unless field.is_a? Symbol
+        define_method(:"#{field}=") do |arg|
+          return arg if send(field) == arg
+
+          instance_variable_set "@#{field}", arg
+          modified[field] = arg
+        end
+      end
     end
   end
   # rubocop:enable Metrics/ClassLength
@@ -315,7 +324,7 @@ module Passwordstate
     autoload :PasswordList,                'passwordstate/resources/password_list'
     autoload :PasswordListPermission,      'passwordstate/resources/password_list'
     autoload :PasswordHistory,             'passwordstate/resources/password'
-    autoload :PasswordPermission,          'passwordstate/resources/password_list'
+    autoload :PasswordPermission,          'passwordstate/resources/password'
     autoload :PrivilegedAccount,           'passwordstate/resources/privileged_account'
     autoload :PrivilegedAccountPermission, 'passwordstate/resources/privileged_account'
     autoload :Permission,                  'passwordstate/resources/permission'

data/lib/passwordstate/resource_list.rb

@@ -62,11 +62,11 @@ module Passwordstate
     end
 
     def operation_supported?(operation)
-      return nil unless %i[search all get post put delete].include?(operation)
+      return false unless %i[search all get post put delete].include?(operation)
       return false if options.key?(:only) && !options[:only].include?(operation)
       return false if options.key?(:except) && options[:except].include?(operation)
 
-      !options.fetch("#{operation}_path".to_sym, '').nil?
+      !options.fetch(:"#{operation}_path", '').nil?
     end
 
     def new(data)

data/lib/passwordstate/resources/document.rb

@@ -13,7 +13,7 @@ module Passwordstate
       alias title document_name
 
       def self.all(client, store, **query)
-        super client, query.merge(_api_path: "#{api_path}/#{validate_store! store}")
+        super(client, query.merge(_api_path: "#{api_path}/#{validate_store! store}"))
       end
 
       def self.search(client, store, **options)
@@ -21,19 +21,19 @@ module Passwordstate
       end
 
       def self.get(client, store, object)
-        super client, object, _api_path: "#{api_path}/#{validate_store! store}"
+        super(client, object, _api_path: "#{api_path}/#{validate_store! store}")
       end
 
       def self.post(client, store, data, **query)
-        super client, data, query.merge(_api_path: "#{api_path}/#{validate_store! store}")
+        super(client, data, query.merge(_api_path: "#{api_path}/#{validate_store! store}"))
       end
 
       def self.put(client, store, data, **query)
-        super client, data, query.merge(_api_path: "#{api_path}/#{validate_store! store}")
+        super(client, data, query.merge(_api_path: "#{api_path}/#{validate_store! store}"))
       end
 
       def self.delete(client, store, object, **query)
-        super client, object, query.merge(_api_path: "#{api_path}/#{validate_store! store}")
+        super(client, object, query.merge(_api_path: "#{api_path}/#{validate_store! store}"))
       end
 
       class << self

data/lib/passwordstate/resources/password.rb

@@ -112,11 +112,13 @@ module Passwordstate
       end
 
       def self.all(client, **query)
-        super client, **{ query_all: true }.merge(query)
+        query = { query_all: true }.merge(query)
+        super(client, **query)
       end
 
       def self.search(client, **query)
-        super client, **{ _api_path: 'searchpasswords' }.merge(query)
+        query = { _api_path: 'searchpasswords' }.merge(query)
+        super(client, **query)
       end
 
       def self.generate(client, **options)

data/lib/passwordstate/resources/password_list.rb

@@ -70,7 +70,7 @@ module Passwordstate
       alias title password_list
 
       def self.search(client, **query)
-        super client, **query.merge(_api_path: 'searchpasswordlists')
+        super(client, **query.merge(_api_path: 'searchpasswordlists'))
       end
 
       def passwords

data/lib/passwordstate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Passwordstate
-  VERSION = '0.1.0'
+  VERSION = '0.1.2'
 end

data/lib/passwordstate.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'logging'
-require 'pp'
 require 'passwordstate/version'
 require 'passwordstate/client'
 require 'passwordstate/errors'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: passwordstate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Alexander Olofsson
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -173,7 +172,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -188,8 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.8
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A ruby API client for interacting with a passwordstate server
 test_files: []