ruby-keepassx 0.2.0beta11 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA512: 
-  metadata.gz: 23df857ea8fd01dacd6b60497d8f95075c0f827767835eca41258166fb98504198eefe9c3bb75cf67f42ec1abdff0410b2f9a38aaad314b6fe8e9feaf871abaa
-  data.tar.gz: 078c8430644ba977faf74ee6646adb1c039355819d975ff4e584ad4ac84d0dd3f897ce31b861a2e2bac3dfdf9cfb9b4d56b05d183c47bc680632f730b1b915c9
-SHA1: 
-  metadata.gz: a3fa2dedf5c4ad9d9ee9c742d4daff03044a6ed2
-  data.tar.gz: d9e4c27365a9772e81486e23b9da7f4f602a48d3
+---
+SHA1:
+  metadata.gz: 35f2f1221b72c8c74d1fa5a93850c16344d45545
+  data.tar.gz: c0ab67fd645312df9583a7d98304f19c7f287cce
+SHA512:
+  metadata.gz: 1f09e9cdd21f2e08a544f02c868877c05f3e3dcb8e30b1e850d6dc3e0f977a305a868064a0abfd2dcd2aab49b9bbf065535503b29ee7252c00f97e579facefb7
+  data.tar.gz: 4307be70d609093891f1bdf59f2e5cfd263a5ee9febcfec84cf8e29ae4f7dff984a2a0e634758460ada410b8bb01127acb9d57bc90c61d216d3fff94d469f46e

data/lib/keepassx.rb

@@ -5,25 +5,6 @@ require 'digest/sha2'
 require 'securerandom'
 require 'rexml/document'
 
-# Add backward compatibility stuff
-if RUBY_VERSION =~ /1\.8/
-  require 'backports/tools'
-  require 'backports/1.9.1/symbol/empty'
-  require 'backports/1.9.3/io/write'
-  require 'time' # Get Time.parse
-
-  unless SecureRandom.method_defined? :uuid
-    module SecureRandom
-      # Based on this post https://www.ruby-forum.com/topic/3171049#1035902
-      def self.uuid
-        s = hex 16
-        [s[0..7], s[8..11], s[12..15], s[16..19], s[20..-1]].join '-'
-      end
-    end
-  end
-end
-
-
 require 'keepassx/exceptions'
 require 'keepassx/header'
 require 'keepassx/utilities'
@@ -39,6 +20,14 @@ require 'keepassx/aes_crypt'
 module Keepassx
 
   class << self
+
+
+    # Create Keepassx database
+    #
+    # @param opts [Hash] Keepassx database options.
+    # @yield [opts]
+    # @yieldreturn [Fixnum]
+    # @return [Keepassx::Database]
     def new opts
       db = Database.new opts
       return db unless block_given?
@@ -46,6 +35,12 @@ module Keepassx
     end
 
 
+    # Read Keepassx database from file storage.
+    #
+    # @param opts [Hash] Keepassx database options.
+    # @yield [opts]
+    # @yieldreturn [Fixnum]
+    # @return [Keepassx::Database]
     def open opts
       db = Database.open opts
       return db unless block_given?

data/lib/keepassx/database.rb

@@ -50,6 +50,11 @@ module Keepassx
     end
 
 
+    # Get raw encoded database.
+    #
+    # @param password [String] Password the database will be encoded with.
+    # @param key_file [String] Path to key file.
+    # @return [String]
     def dump password = nil, key_file = nil
       # FIXME: Figure out what this is needed for
       # my $e = ($self->find_entries({title => 'Meta-Info', username => 'SYSTEM', comment => 'KPX_GROUP_TREE_STATE', url => '$'}))[0] || $self->add_entry({
@@ -73,8 +78,13 @@ module Keepassx
     end
 
 
-    # TODO: Switch to rails style, i.e. save(:password => 'pass')
+    # Save database to file storage
+    #
+    # @param password [String] Password the database will be encoded with.
+    # @param key_file [String] Path to key file.
+    # @return [Fixnum]
     def save password = nil, key_file = nil
+      # TODO: Switch to rails style, i.e. save(:password => 'pass')
       fail TypeError, 'File path is not set' if path.nil?
       File.write path, dump(password, key_file)
 
@@ -89,6 +99,10 @@ module Keepassx
 
 
     # Search for items, using AND statement for the search conditions
+    #
+    # @param item_type [Symbol] Can be :entry or :group.
+    # @param opts [Hash] Search options.
+    # @return [Keepassx::Group, Keepassx::Entry]
     def get item_type, opts = {}
 
       case item_type
@@ -110,7 +124,7 @@ module Keepassx
         match_number = opts.length
         items = []
         opts.each do |k, v|
-          items += Array(item_list.select { |e| e.send(k).eql?(v) })
+          items += Array item_list.select { |e| e.send(k).eql?(v) }
         end
 
         buffer = Hash.new 0
@@ -138,7 +152,9 @@ module Keepassx
     end
 
 
-    # Get first matching entry
+    # Get first matching entry.
+    #
+    # @return [Keepassx::Entry]
     def entry opts = {}
       entries = get :entry, opts
       if entries.empty?
@@ -150,13 +166,17 @@ module Keepassx
     end
 
 
-    # Get all matching entries
+    # Get all matching entries.
+    #
+    # @return [Array<Keepassx::Entry>]
     def entries opts = {}
       get :entry, opts
     end
 
 
-    # Get first matching group
+    # Get first matching group.
+    #
+    # @return [Keepassx::Group]
     def group opts = {}
       groups = get :group, opts
       if groups.empty?
@@ -168,12 +188,19 @@ module Keepassx
     end
 
 
-    # Get all matching groups
+    # Get all matching groups.
+    #
+    # @param opts [Hash]
+    # @return [Array<Keepassx::Group>]
     def groups opts = {}
       get :group, opts
     end
 
 
+    # Add new item to database.
+    #
+    # @param item [Symbol, Keepassx::Group, Keepassx::Entry] New item.
+    # @return [Keepassx::Group, Keepassx::Entry]
     def add item, opts = {}
       if item.is_a? Symbol
 
@@ -197,6 +224,10 @@ module Keepassx
     end
 
 
+    # Add new group to database.
+    #
+    # @param opts [Hash] Options that will be passed to Keepassx::Group#new.
+    # @return [Keepassx::Group]
     def add_group opts
 
       if opts.is_a? Hash
@@ -232,7 +263,12 @@ module Keepassx
     end
 
 
+    # Add new entry to database.
+    #
+    # @param opts [Hash] Options that will be passed to Keepassx::Entry#new.
+    # @return [Keepassx::Entry]
     def add_entry opts
+      # FIXME: Add warnings and detailed description
       if opts.is_a? Hash
         opts = deep_copy opts
 
@@ -258,11 +294,11 @@ module Keepassx
     end
 
 
-    # Delete item from database
+    # Delete item from database.
     #
-    # @param [Keepassx::Group, Keepassx::Entry, Symbol] item Item to delete.
-    # @param [Hash] opts If first parameter is a Symbol, then this is used to
-    #   determine which item to delete.
+    # @param item [Keepassx::Group, Keepassx::Entry, Symbol] Item to delete.
+    # @param opts [Hash] If first parameter is a Symbol, then this will be
+    #  used to determine which item to delete.
     def delete item, opts = {}
       if item.is_a? Keepassx::Group
         delete_group item
@@ -285,11 +321,11 @@ module Keepassx
     end
 
 
-    # Unlock database
+    # Unlock database.
     #
-    # @param [String] password Datbase password
-    # @param [String] key_file Key file path
-    # @return [Boolean] Whether or not password validation successfull
+    # @param password [String] Datbase password.
+    # @param key_file [String] Key file path.
+    # @return [Boolean] Whether or not password validation successfull.
     def unlock password, key_file = nil
 
       return true unless locked?
@@ -310,12 +346,13 @@ module Keepassx
     end
 
 
-    # FIXME: Seqrch by any atribute by pattern
-    # Searn entry by title
+
+    # Search entry by title.
     #
-    # @param [String] pattern Entry's title to search for
+    # @param pattern [String] Entry's title to search for.
     # @return [Keepassx::Entry]
     def search pattern
+      # FIXME: Seqrch by any atribute by pattern
       backup = group 'Backup'
 
       entries.select do |e|
@@ -324,7 +361,7 @@ module Keepassx
     end
 
 
-    # Check database validity
+    # Check database validity.
     #
     # @return [Boolean]
     def valid?
@@ -340,9 +377,9 @@ module Keepassx
     end
 
 
-    # Get Group/Entry index in storage
+    # Get Group/Entry index in storage.
     #
-    # @return [Integer]
+    # @return [Fixnum]
     def index v
       if v.is_a? Keepassx::Group
         groups.find_index v
@@ -357,9 +394,9 @@ module Keepassx
     end
 
 
-    # Get Enries and Groups total number
+    # Get Enries and Groups total number.
     #
-    # @return [Integer]
+    # @return [Fixnum]
     def length
       length = 0
       [@groups, @entries].each do |items|
@@ -372,7 +409,7 @@ module Keepassx
     end
 
 
-    # Get actual payload checksum
+    # Get actual payload checksum.
     #
     # @return [String]
     def checksum
@@ -380,9 +417,9 @@ module Keepassx
     end
 
 
-    # Get next group ID number
+    # Get next group ID number.
     #
-    # @return [Integer]
+    # @return [Fixnum]
     def next_group_id
       if groups.empty?
         # Start each time from 1 to make sure groups get the same id's for the

data/lib/keepassx/entry.rb

@@ -51,6 +51,12 @@ module Keepassx
     }
 
 
+    # Create entries from raw data.
+    #
+    # @param header [Keepassx::Header] Keepassx database header.
+    # @param groups [Array<Keepassx::Group>] Group list, the entry will bind to.
+    # @param payload [StringIO] Raw data.
+    # @return [Array<Keepassx::Entry>]
     def self.extract_from_payload(header, groups, payload)
       items = []
       header.entry_number.times do
@@ -62,6 +68,9 @@ module Keepassx
     end
 
 
+    # Get list of supported entry fields.
+    #
+    # @return [Array<Symbol>]
     def self.fields
       FIELD_MAPPING.keys
     end
@@ -78,8 +87,8 @@ module Keepassx
         fail "'group' is required" if payload[:group].nil?
         self.group = payload[:group]
 
-        fields =  self.class.fields
-        data = payload.reject { |k, _| !fields.include? k }
+        field_list = FIELD_MAPPING.keys
+        data = payload.select { |k| field_list.include? k }
         data[:group_id] = group.id
 
         @fields = []
@@ -97,6 +106,10 @@ module Keepassx
     attr_reader :group
 
 
+    # Set parent group.
+    #
+    # @param v [Keepassx::Group] Parent group.
+    # @return [Keepassx::Group]
     def group= v
       if v.is_a? Keepassx::Group
         self.group_id = v.id

data/lib/keepassx/field.rb

@@ -53,7 +53,9 @@ module Keepassx
     end
 
 
-    # Return raw data length
+    # Get raw data length
+    #
+    # @return [Integer]
     def length
       TYPE_CODE_FIELD_SIZE + DATA_LENGTH_FIELD_SIZE + size
     end
@@ -167,6 +169,7 @@ module Keepassx
 
 
     def ascii= value
+      # TODO: Add spec
       @data = [value].pack('H*')
     end
 

data/lib/keepassx/header.rb

@@ -164,7 +164,7 @@ module Keepassx
       end
 
       key = Digest::SHA2.new.update(key).digest
-      key = Digest::SHA2.new.update(master_seed + key).digest
+      Digest::SHA2.new.update(master_seed + key).digest
 
     end
 

data/lib/keepassx/item.rb

@@ -22,12 +22,6 @@ module Keepassx
     end
 
 
-    # TODO: Remove debug method
-    def dump
-      @fields
-    end
-
-
     def to_hash
       result = {}
       self.class.fields.each do |field|

data/lib/keepassx/utilities.rb

@@ -92,7 +92,7 @@ module Keepassx
 
     # Set parents for groups
     #
-    #  @param [Array] list Array of groups.
+    #  @param list [Array] Array of groups.
     #  @return [Array] Updated array of groups.
     def initialize_groups list
 
@@ -109,9 +109,9 @@ module Keepassx
         if previous_group.nil? or group.level.eql? 0
           group.parent = nil
 
-        # If group has level greater than parent's level by one,
-        # it gets parent set to the first previous group with level less
-        # than group's level by one
+          # If group has level greater than parent's level by one,
+          # it gets parent set to the first previous group with level less
+          # than group's level by one
         elsif group.level == previous_group.level + 1 or
             group.level == previous_group.level
 
@@ -153,7 +153,7 @@ module Keepassx
 
     # Retrieves last sibling index
     #
-    #  @param [Keepassx::Group] parent Last sibling group.
+    #  @param parent [Keepassx::Group] Last sibling group.
     #  @return [Integer] index Group index.
     def last_sibling_index parent
 
@@ -187,7 +187,7 @@ module Keepassx
       # Remove groups and entries from options, so new group could be
       # initialized from incoming Hash
       fields          = Keepassx::Group.fields
-      group_opts      = opts.reject { |k, _| !fields.include? k }
+      group_opts      = opts.select { |k, _| fields.include? k }
       group           = add_group group_opts
 
       entries.each do |e|
@@ -197,6 +197,7 @@ module Keepassx
 
       # Recursively proceed each child group
       groups.each { |g| parse_data_array g } unless groups.nil?
+
     end
 
 

data/ruby-keepassx.gemspec

@@ -3,20 +3,15 @@ Gem::Specification.new do |s|
   s.summary     = 'Ruby API access for KeePassX databases'
   s.description = 'This is fork of Tony Pitluga\'s ' \
       'Ruby API for keepassx with read-write support.'
-  s.version     = '0.2.0beta11'
+  s.version     = '0.2.0'
   s.authors     = ['Tony Pitluga', 'Paul Hinze', 'Tio Teath']
   s.email       = ['tony.pitluga@gmail.com', 'paul.t.hinze@gmail.com',
-      'tio.teath@gmail.com']
+      'tioteath@gmail.com']
   s.homepage    = 'https://github.com/tioteath/ruby-keepassx.git'
   s.files       = `git ls-files`.split "\n"
 
-  # TODO: This won't work, figure out why.
-  if RUBY_VERSION =~ /1\.8/
-    s.add_dependency 'backports', '~> 3.6.0'
-  end
-
   s.add_development_dependency 'rspec', '~> 3.0'
-  s.add_development_dependency 'pry', '~> 0.9.12'
+  s.add_development_dependency 'pry', '~> 0'
   s.add_development_dependency 'rake', '~> 0.8', '>= 0.8.7'
   # s.add_development_dependency 'respect', '~> 0.1.1'
   # s.add_development_dependency 'rspec-prof', '~> 0'

data/spec/keepassx/database_spec.rb

@@ -16,8 +16,9 @@ describe Keepassx::Database do
     subject { Keepassx }
     let(:db1) { subject.new data_array }
     let(:db2) { subject.new data_array }
-
     it 'has the same checksum for the same data' do
+      # warn "db1: #{File.write '/tmp/db1', db1.entries.inspect}>><<"
+      # warn "db2: #{File.write '/tmp/db2', db2.entries.inspect}>><<"
       expect(db1.checksum).to eq db2.checksum
     end
   end

metadata

@@ -1,77 +1,78 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ruby-keepassx
-version: !ruby/object:Gem::Version 
-  version: 0.2.0beta11
+version: !ruby/object:Gem::Version
+  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Tony Pitluga
 - Paul Hinze
 - Tio Teath
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-09-18 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: backports
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 3.6.0
-  type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+date: 2014-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "3.0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: pry
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.9.12
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0.8"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
     - - ">="
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.8.7
   type: :development
-  version_requirements: *id004
-description: This is fork of Tony Pitluga's Ruby API for keepassx with read-write support.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+description: This is fork of Tony Pitluga's Ruby API for keepassx with read-write
+  support.
+email:
 - tony.pitluga@gmail.com
 - paul.t.hinze@gmail.com
-- tio.teath@gmail.com
+- tioteath@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .coveralls.yml
-- .gitignore
-- .rvmrc
-- .travis.yml
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
@@ -97,30 +98,26 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/tioteath/ruby-keepassx.git
 licenses: []
-
 metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 1.3.1
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby API access for KeePassX databases
 test_files: []
-
+has_rdoc: 

data/.rvmrc

@@ -1 +0,0 @@
-rvm ruby-1.8.7@keepassx --create