ronin-db 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb843bad7ea3acbc3e60ab034a6a7eae3d89b95433a46e80ee92c49d38a0d7e1
-  data.tar.gz: 37af4e6642c8a551df6b83547ae96c642359c3e3964e0bae173cbd9bf7d34e39
+  metadata.gz: e887e863b916cfbb31dcccf48adfb04ed662e5ecc8012e749d6389f1b9149a5a
+  data.tar.gz: 698d79788a12a30cd7fd03d9295d76dfe98e12911aef13d4a830f35c1a99ac29
 SHA512:
-  metadata.gz: 1480524a5b1356e1206f1a24dc928faf9c37e7b54109949180626dd5be4bd0b32e93f36a3b3527a9fe6f9ed70d3699ab94bd50c1fcf38f185ef1359afac734e6
-  data.tar.gz: 8a02d484ff3620a7165940d5eb77b5815f57571768c6353aaffdba5358700ea9114f629f42918a97d70938b77a5bd9547ac6851e7fd875be2136b4c92c44d77c
+  metadata.gz: 655172b999161aeec34794d90fd279e8d468e280a67b07f1db03f3659facedc99ad053c508e9245e40bb6623fae792cec2f241a476ece1fe178bbcd75674c198
+  data.tar.gz: 21e77b67c29ed5cc37aea7888d80b0547375eb7140bf1491283789750505ef35344bd53b185aef251b36a7186cb33001aa849728b2c6f13cb3a618b3ba916448

data/.github/workflows/ruby.yml

@@ -16,7 +16,7 @@ jobs:
           - truffleruby
     name: Ruby ${{ matrix.ruby }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -35,7 +35,7 @@ jobs:
   rubocop:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/ChangeLog.md

@@ -1,3 +1,8 @@
+### 0.1.3 / 2023-12-13
+
+* Fixed a bug in {Ronin::DB::ConfigFile.edit} when `YAML::Store` would attempt
+  to create the config file but the parent directory did not exist yet.
+
 ### 0.1.2 / 2023-09-19
 
 * Fixed a typo in an exception message in {Ronin::DB.connect}.

data/lib/ronin/db/config_file.rb

@@ -21,6 +21,7 @@
 require 'ronin/db/exceptions'
 require 'ronin/db/home'
 
+require 'fileutils'
 require 'yaml'
 require 'yaml/store'
 
@@ -65,21 +66,21 @@ module Ronin
       #
       def self.validate(path,data)
         unless data.kind_of?(Hash)
-          raise(InvalidConfig)
+          raise(InvalidConfig,"config data must be a Hash: #{data.inspect}")
         end
 
         data.each do |key,value|
-          unless (key.kind_of?(Symbol) || key.kind_of?(String))
-            raise(InvalidConfig)
+          unless key.kind_of?(Symbol)
+            raise(InvalidConfig,"all Hash keys must be a Symbol: #{key.inspect}")
           end
 
           unless value.kind_of?(Hash)
-            raise(InvalidConfig)
+            raise(InvalidConfig,"all Hash values must also be a Hash: #{value.inspect}")
           end
 
           value.each_key do |sub_key|
-            unless (sub_key.kind_of?(Symbol) || sub_key.kind_of?(String))
-              raise(InvalidConfig)
+            unless sub_key.kind_of?(Symbol)
+              raise(InvalidConfig,"all sub-keys must be a Symbol: #{sub_key.inspect}")
             end
           end
         end
@@ -124,8 +125,12 @@ module Ronin
       #   The loaded YAML configuration data.
       #
       def self.edit(path=PATH,&block)
-        store = YAML::Store.new(path)
+        unless File.file?(path)
+          # create the parent directory for YAML::Store
+          FileUtils.mkdir_p(File.dirname(path))
+        end
 
+        store = YAML::Store.new(path)
         store.transaction(&block)
       end
     end

data/lib/ronin/db/exceptions.rb

@@ -20,7 +20,16 @@
 
 module Ronin
   module DB
+    #
+    # Indicates that the given database name is not in the config file.
+    #
     class UnknownDatabase < RuntimeError
     end
+
+    #
+    # Indicates that the config file is corrupted.
+    #
+    class InvalidConfig < RuntimeError
+    end
   end
 end

data/lib/ronin/db/version.rb

@@ -21,6 +21,6 @@
 module Ronin
   module DB
     # ronin-db version
-    VERSION = '0.1.2'
+    VERSION = '0.1.3'
   end
 end

data/lib/ronin/db.rb

@@ -91,6 +91,15 @@ module Ronin
     # @raise [ArgumentError]
     #   The given database was not a Symbol or a Hash.
     #
+    # @example Connect to the default database (`~/.local/share/ronin-db/default.sqlite3`):
+    #   DB.connect
+    #
+    # @example Connect to a specific database from the configuration file (`~/.config/ronin-db/databases.yml`):
+    #   DB.connect(:my_database)
+    #
+    # @example Connect to an arbitrary database:
+    #   Db.connect({adapter: 'sqlite3', database: '/path/to/database.sqlite3'})
+    #
     # @api semipublic
     #
     def self.connect(database=:default, migrate: nil, load_models: true)

data/man/ronin-db-add.1

@@ -1,10 +1,10 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-db-add 1 "2023-02-01" Ronin DB "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-db add\fR \[lB]\fIoptions\fP\[rB] \fINAME\fP \[lB]\fIURI\fP\[rB]
 .LP
 .SH DESCRIPTION

data/man/ronin-db-asn.1

@@ -1,10 +1,10 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-db-asn 1 "2023-02-01" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-db asn\fR \[lB]\fIoptions\fP\[rB]
 .LP
 .SH DESCRIPTION

data/man/ronin-db-creds.1

@@ -1,10 +1,10 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-db-creds 1 "2023-01-02" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-db creds\fR \[lB]\fIoptions\fP\[rB]
 .LP
 .SH DESCRIPTION

data/man/ronin-db-edit.1

@@ -1,10 +1,10 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-db-edit 1 "2023-02-01" Ronin DB "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-db edit\fR \[lB]\fIoptions\fP\[rB]
 .LP
 .SH DESCRIPTION

data/man/ronin-db-emails.1

@@ -1,10 +1,10 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-db-emails 1 "2023-02-01" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-db emails\fR \[lB]\fIoptions\fP\[rB]
 .LP
 .SH DESCRIPTION
@@ -59,7 +59,7 @@ Searches for email addresses associated with the \fIHOST\fP\.
 \fB-I\fR, \fB--with-ip\fR \fIIP\fP
 Searches for email addresses associated with the IP address\.
 .LP
-.HP
+.PP
 \fB-u\fR, \fB--with-users\fR \fINAME\fP \[lB]\.\.\.\[rB]
 Searches for email addresses associated with the user NAME(s)\.
 .LP

data/man/ronin-db-hosts.1

@@ -1,10 +1,10 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-db-hosts 1 "2023-02-01" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-db hosts\fR \[lB]\fIoptions\fP\[rB]
 .LP
 .SH DESCRIPTION

data/man/ronin-db-ips.1

@@ -1,10 +1,10 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-db-ips 1 "2023-02-01" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-db ips\fR \[lB]\fIoptions\fP\[rB]
 .LP
 .SH DESCRIPTION

data/man/ronin-db-irb.1

@@ -1,10 +1,10 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-db-irb 1 "2023-02-01" Ronin DB "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-db irb\fR \[lB]\fIoptions\fP\[rB]
 .LP
 .SH DESCRIPTION

data/man/ronin-db-list.1

@@ -1,10 +1,10 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-db-list 1 "2023-02-01" Ronin DB "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-db list\fR \[lB]\fIoptions\fP\[rB] \[lB]\fINAME\fP\[rB]
 .LP
 .SH DESCRIPTION

data/man/ronin-db-migrate.1

@@ -1,10 +1,10 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-db-migrate 1 "2023-02-01" Ronin DB "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-db migrate\fR \[lB]\fIoptions\fP\[rB]
 .LP
 .SH DESCRIPTION

data/man/ronin-db-remove.1

@@ -1,10 +1,10 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-db-remove 1 "2023-02-01" Ronin DB "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-db remove\fR \[lB]\fIoptions\fP\[rB] \fINAME\fP
 .LP
 .SH DESCRIPTION

data/man/ronin-db-urls.1

@@ -1,10 +1,10 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-db-urls 1 "2023-02-01" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-db urls\fR \[lB]\fIoptions\fP\[rB]
 .LP
 .SH DESCRIPTION
@@ -71,11 +71,11 @@ Searches for URLs associated with the \fIPORT\fP\.
 \fB-d\fR, \fB--directory\fR \fIDIRECTORY\fP
 Searches for URLs sharing the DIRECTORY\.
 .LP
-.HP
+.PP
 \fB-q\fR, \fB--with-query-param\fR \fINAME\fP \[lB]\.\.\.\[rB]
 Searches for URLs containing the query\-param NAME\.
 .LP
-.HP
+.PP
 \fB-Q\fR, \fB--with-query-value\fR \fIVALUE\fP \[lB]\.\.\.\[rB]
 Searches for URLs containing the query\-param VALUE\.
 .LP

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ronin-db
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-19 00:00:00.000000000 Z
+date: 2023-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3