passwordstate 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab1c9b2c6cb3727612e991d77631ddf61d266c7a0b5ba26a5c835b5d349c51e6
-  data.tar.gz: 18f155663d7592f40c0dd54b09b13d075c0e2d1265a1e993ad1c2cc7811e1e3d
+  metadata.gz: e3e65ba47af619efcf537b2636eb297ac1cbe7a1c423c323e44a0126f27a5e2e
+  data.tar.gz: 5829c7ee7bf3af1d9098246e16f53f06f29d2002683cf8aed15b87a900e50bec
 SHA512:
-  metadata.gz: d3ad29d420d8bfb75bd7418747933716914b311fd87c8d50ee83451aed8de2a06d363ec2709823b3a3be11bfe68ea510359ab93638a483d45dcdd80fb1744b37
-  data.tar.gz: 6ddc4c5bcd72c5a03da7f046eeca3fec8113ba23c88d71a5d45901923ff01b0294eddf9dfa02cd937bc70698869bbdd68beb69673732a177879087ea159a251d
+  metadata.gz: 96b62d8b3701e7779c035f7bdb05cf4b6ab5540fa74749742169bde51e093ccbe2d255c50309965c3f056bd5081fb24e438dd3f04e096a55cee12e3301b755a1
+  data.tar.gz: 5ed0bc2e7d0c7f922cb1ceee760d3a090381afda9a952d9fb98919eaedc1eee7cb1fecd5d18d3e65f28f6be5564a3eda13f35a8cd0e6a5f25ef8e10b26671b24

data/.gitlab-ci.yml

@@ -14,6 +14,17 @@ rubocop:
   script:
     - bundle exec rubocop
 
+pages:
+  stage: deploy
+  script:
+    - gem install yard
+    - yard doc -o public/
+  artifacts:
+    paths:
+      - public/
+  only:
+    - master
+
 # rspec:
 #   script:
 #   - rspec spec

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## v0.0.2 2018-08-14
+
+- Add title and full_path fields to the appropriate resources - almost every resource should now have an obvious human-readable name
+- Fix password searching in password lists
+- Improved exception handling
+
+## v0.0.1 2018-07-31
+
+- Initial release

data/README.md

@@ -2,6 +2,8 @@
 
 A ruby gem for communicating with a Passwordstate instance
 
+The documentation for the development version can be found at http://iti.gitlab-pages.liu.se/ruby-passwordstate
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/passwordstate/client.rb

@@ -88,7 +88,8 @@ module Passwordstate
       if data
         return data if res_obj.is_a? Net::HTTPSuccess
         data = data&.first
-        raise Passwordstate::HTTPError.new(res_obj.code, data&.fetch('errors', []) || [])
+
+        raise Passwordstate::HTTPError.new_by_code(res_obj.code, req_obj, res_obj, data&.fetch('errors', []) || [])
       else
         return res_obj.body if options.fetch(:allow_html, false)
         raise Passwordstate::PasswordstateError, 'Response was not parseable as JSON'
@@ -110,7 +111,7 @@ module Passwordstate
       @http.start
     end
 
-    def print_http(http)
+    def print_http(http, truncate = true)
       return unless logger.debug?
 
       if http.is_a? Net::HTTPRequest
@@ -132,7 +133,9 @@ module Passwordstate
       else
         clean_body = http.body
       end
-      logger.debug "#{dir} #{clean_body.length < 200 ? clean_body : clean_body.slice(0..200) + "... [truncated, #{clean_body.length} Bytes]"}" if clean_body
+
+      clean_body = clean_body.slice(0..2000) + "... [truncated, #{clean_body.length} Bytes total]" if truncate && clean_body.length > 2000
+      logger.debug "#{dir} #{clean_body}" if clean_body
     end
   end
 end

data/lib/passwordstate/errors.rb

@@ -2,10 +2,12 @@ module Passwordstate
   class PasswordstateError < RuntimeError; end
 
   class HTTPError < PasswordstateError
-    attr_reader :code, :errors
+    attr_reader :code, :request, :response, :errors
 
-    def initialize(code, errors = [])
+    def initialize(code, request, response, errors = [])
       @code = code.to_i
+      @request = request
+      @response = response
       @errors = errors
 
       super <<-ERRMSG
@@ -13,5 +15,38 @@ Passwordstate responded with an error to the request;
 #{errors.map { |err| err['message'] || err['phrase'] }.join(', ')}
 ERRMSG
     end
+
+    def self.new_by_code(code, req, res, errors = [])
+      code_i = code.to_i
+
+      errtype = nil
+      errtype ||= NotFoundError if code_i == 404
+      errtype ||= ClientError if code_i >= 400 && code_i < 500
+      errtype ||= ServerError if code_i >= 500 && code_i < 600
+
+      errtype ||= HTTPError
+      errtype.new(code_i, req, res, errors)
+    end
+  end
+
+  # 4xx
+  class ClientError < HTTPError
+    def initialize(code, req, res, errors = [])
+      super
+    end
+  end
+
+  # 404
+  class NotFoundError < ClientError
+    def initialize(code, req, res, errors = [])
+      super
+    end
+  end
+
+  # 5xx
+  class ServerError < HTTPError
+    def initialize(code, req, res, errors = [])
+      super
+    end
   end
 end

data/lib/passwordstate/resource_list.rb

@@ -47,8 +47,10 @@ module Passwordstate
     end
 
     def load(entries)
-      clear && entries.each { |obj| self << obj }
-      true
+      clear && entries.tap do |loaded|
+        loaded.sort! { |obj| obj.send(obj.class.index_field) } if options.fetch(:sort, true)
+      end.each { |obj| self << obj }
+      self
     end
 
     def operation_supported?(operation)

data/lib/passwordstate/resources/document.rb

@@ -8,6 +8,8 @@ module Passwordstate
       read_fields :document_id, { name: 'DocumentID' },
                   :document_name
 
+      alias title document_name
+
       def self.search(client, store, options = {})
         client.request :get, "#{api_path}/#{store}/", query: options
       end

data/lib/passwordstate/resources/folder.rb

@@ -13,6 +13,8 @@ module Passwordstate
                   :site_id, { name: 'SiteID' },
                   :site_location
 
+      alias title folder_name
+
       def password_lists
         Passwordstate::ResourceList.new client, Passwordstate::Resources::PasswordList,
                                         search_query: { tree_path: tree_path },
@@ -20,6 +22,11 @@ module Passwordstate
                                         all_query: { tree_path: tree_path },
                                         object_data: { nest_undef_folder_id: folder_id }
       end
+
+      def full_path(unix = false)
+        return tree_path.tr('\\', '/') if unix
+        tree_path
+      end
     end
   end
 end

data/lib/passwordstate/resources/password.rb

@@ -10,16 +10,16 @@ module Passwordstate
                       :host_name,
                       :user_name,
                       :description,
-                      :generic_field_1,
-                      :generic_field_2,
-                      :generic_field_3,
-                      :generic_field_4,
-                      :generic_field_5,
-                      :generic_field_6,
-                      :generic_field_7,
-                      :generic_field_8,
-                      :generic_field_9,
-                      :generic_field_10,
+                      :generic_field_1, { name: 'GenericField1' },
+                      :generic_field_2, { name: 'GenericField2' },
+                      :generic_field_3, { name: 'GenericField3' },
+                      :generic_field_4, { name: 'GenericField4' },
+                      :generic_field_5, { name: 'GenericField5' },
+                      :generic_field_6, { name: 'GenericField6' },
+                      :generic_field_7, { name: 'GenericField7' },
+                      :generic_field_8, { name: 'GenericField8' },
+                      :generic_field_9, { name: 'GenericField9' },
+                      :generic_field_10, { name: 'GenericField10' },
                       :account_type_id, { name: 'AccountTypeID' },
                       :account_type,
                       :notes,
@@ -75,7 +75,7 @@ module Passwordstate
       end
 
       def self.search(client, query = {})
-        super client, query.merge(_api_path: 'searchpassword')
+        super client, { _api_path: 'searchpasswords' }.merge(query)
       end
 
       def self.generate(client, options = {})

data/lib/passwordstate/resources/password_list.rb

@@ -38,6 +38,12 @@ module Passwordstate
                   :generator_name,
                   :policy_name
 
+      alias title password_list
+
+      def self.search(client, query = {})
+        super client, query.merge(_api_path: 'searchpasswordlists')
+      end
+
       def passwords
         Passwordstate::ResourceList.new client, Passwordstate::Resources::Password,
                                         all_path: "passwords/#{password_list_id}",
@@ -46,8 +52,10 @@ module Passwordstate
                                         object_data: { password_list_id: password_list_id }
       end
 
-      def self.search(client, query = {})
-        super client, query.merge(_api_path: 'searchpasswordlists')
+      def full_path(unix = false)
+        [tree_path, password_list].compact.join('\\').tap do |full|
+          full.tr!('\\', '/') if unix
+        end
       end
     end
   end

data/lib/passwordstate/version.rb

@@ -1,3 +1,3 @@
 module Passwordstate
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: passwordstate
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alexander Olofsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-31 00:00:00.000000000 Z
+date: 2018-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -104,6 +104,7 @@ files:
 - ".gitignore"
 - ".gitlab-ci.yml"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md