safedb 0.3.1009 → 0.3.1010

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93cd8e2ba6cd82c1825476110054999fc168d533
-  data.tar.gz: fe80242921b7acefc7344d0604270bea4c570b3f
+  metadata.gz: cc83fe6e9b8f141eef721eeb62608f57535aaedd
+  data.tar.gz: b7c90295820373a1b04ce3dc95574614e74ea132
 SHA512:
-  metadata.gz: dd195060d76f1fdab168946ee71c8b0d6edee7980e31f46310d5ab19c0c60502bba4c037ffc5ec2ec39988dca6eed27228495e19c62daf15bc52a01e6fc5c698
-  data.tar.gz: 7b600ed027658cbbdadb4ba76621c26f9ef01b041ff6df3157cb192ebf57187ba548b33dbef2e92f40dafa858f5a263b64944940301a8cbfbba13123265cb63e
+  metadata.gz: ed02288410213a27a4b6229e576355200176332b29a3598c15d1ea21af14717acfb18d5fdd8f2f6cb9177cfc6719863f68a224f387bed2298ccc74a691b38f0b
+  data.tar.gz: c4d63d2ee433403d931edac75093975da0a8909f69f4d2c300e503f481bcd00c80140d9765720030009ccc6f079d926dd44eed7ef435d1e9a54f5e6e12149de1

data/lib/interprete.rb

@@ -203,9 +203,9 @@ class Interprete < Thor
   # Description of the export use case command.
   desc "export", "exports the book or chapter or the mini dictionary at verse."
 
-  # Export the entire book if no chapter and verse is specified (achieved with a safe close),
-  # or the chapter if only the chapter is open (safe shut or safe open <<chapter>>, or the
-  # mini-dictionary at the verse if both chapter and verse are open.
+  # Export one, some or all chapters, verses and lines within the logged in book.
+  # The --print flag demands that the exported text goes to stdout otherwise it
+  # will be placed in an aptly named file in  the present working directory.
   def export
     log.info(x) { "[usecase] ~> export book chapter content or dictionary at verse in JSON format." }
     SafeDb::Export.new.flow_of_events

data/lib/keytools/key.api.rb

@@ -856,62 +856,6 @@ module SafeDb
     end
 
 
-    # Register the URL to the <b>frontend keystore</b> that is tied to
-    # this application instance on this workstation (and user). The default
-    # keystore sits on an accessible filesystem that is preferably a
-    # removable drive (like a USB key or phone) which allows the keys to
-    # your secrets to travel with you in your pocket.
-    #
-    # <b>Changing the Keystore Url</b>
-    #
-    # If the keystore url has already been configured this method will overwrite
-    # (thereby updating) it.
-    #
-    # <b>Changing the Keystore Url</b>
-    #
-    # The keystore directives in the global configuration file looks like this.
-    #
-    #     [keystore.ids]
-    #     dxEy-v2w3-x7y8 = /media/usb_key/family.creds
-    #     47S3-Nv0w-8SYf = /media/usb_key/friend.creds
-    #     3Dds-8Tts-Jy2G = /media/usb_key/office.creds
-    #
-    # <b>Which Use Case Sets the Keystore Url?</b>
-    #
-    # The keystore url must be provided <b>the very first time</b> init
-    # is called for an app instance on a machine. If the configuration
-    # is wiped, the next initialize use case must again provide it.
-    #
-    # <b>How to Add (Extend) Storage Services</b>
-    #
-    # We could use Redis, PostgreSQL, even a Rest API to provide storage
-    # services. To extend it - make a keystore ID boss its own section and
-    # then add keypairs like
-    #
-    # - the keystore URL
-    # - the keystore Type (or interface class)
-    # - keystore create destroy markers
-    #
-    # @param keystore_url [String]
-    #    The keystore url points to where the key metadata protecting
-    #    this application instance lives. The simplest keystores are
-    #    based on files and for them this url is just a folder path.
-    #
-    # @raise [KeyError]
-    #
-    # The keystore URL cannot be <b>NEW</b>. The <b>NEW acronym</b> asserts
-    # that the attribute is
-    #
-    # - neither <b>N</b>il
-    # - nor <b>E</b>mpty
-    # - nor <b>W</b>hitespace only
-    #
-    def register_keystore keystore_url
-      KeyError.not_new( keystore_url, self )
-      @keymap.write( @aim_id, KEYSTORE_IDENTIFIER_KEY, keystore_url )
-    end
-
-
     # Generate a new set of envelope breadcrumbs, derive the new envelope
     # filepath, then <b>encrypt</b> the raw envelope content, and write the
     # resulting ciphertext out into the new file.
@@ -1118,6 +1062,35 @@ module SafeDb
     end
 
 
+    # This method depends on {use_application_domain} which sets
+    # the application ID against the session identity so only call
+    # it if we are in a logged in state.
+    #
+    # NOTE this will NOT be set until the session is logged in so
+    # the call fails before that. For this reason do not call this
+    # method from outside this class. If the domain name is
+    # available use {KeyId.derive_app_instance_identifier} instead.
+    def self.read_app_id()
+
+      aim_id = read_aim_id()
+      keypairs = KeyPair.new( MACHINE_CONFIG_FILE )
+      keypairs.use( aim_id )
+      return keypairs.get( APP_INSTANCE_ID_KEY )
+
+    end
+
+
+    def self.read_aim_id()
+
+      session_identifier = KeyId.derive_session_id( to_token() )
+
+      keypairs = KeyPair.new( MACHINE_CONFIG_FILE )
+      keypairs.use( SESSION_APP_DOMAINS )
+      return keypairs.get( session_identifier )
+
+    end
+
+
     private
 
 
@@ -1230,35 +1203,6 @@ module SafeDb
     end
 
 
-    # This method depends on {use_application_domain} which sets
-    # the application ID against the session identity so only call
-    # it if we are in a logged in state.
-    #
-    # NOTE this will NOT be set until the session is logged in so
-    # the call fails before that. For this reason do not call this
-    # method from outside this class. If the domain name is
-    # available use {KeyId.derive_app_instance_identifier} instead.
-    def self.read_app_id()
-
-      aim_id = read_aim_id()
-      keypairs = KeyPair.new( MACHINE_CONFIG_FILE )
-      keypairs.use( aim_id )
-      return keypairs.get( APP_INSTANCE_ID_KEY )
-
-    end
-
-
-    def self.read_aim_id()
-
-      session_identifier = KeyId.derive_session_id( to_token() )
-
-      keypairs = KeyPair.new( MACHINE_CONFIG_FILE )
-      keypairs.use( SESSION_APP_DOMAINS )
-      return keypairs.get( session_identifier )
-
-    end
-
-
     def self.get_crumbs_db_from_domain_name( domain_name )
 
       KeyError.not_new( domain_name, self )

data/lib/usecase/export.rb

@@ -2,34 +2,55 @@
 
 module SafeDb
 
-  # Export the entire book if no chapter and verse is specified (achieved with a safe close),
-  # or the chapter if only the chapter is open (safe shut or safe open <<chapter>>, or the
-  # mini-dictionary at the verse if both chapter and verse are open.
+  # Export one, some or all chapters, verses and lines within the logged in book.
+  #
+  # == Aspirational Feature
+  #
+  # The --print flag demands that the exported text goes to stdout otherwise it
+  # will be placed in an aptly named file in  the present working directory.
   class Export < UseCase
 
-    def get_chapter_data( chapter_key )
-      return KeyDb.from_json( KeyApi.content_unlock( chapter_key ) )
-    end
-
     def execute
 
       return unless ops_key_exists?
       master_db = KeyApi.read_master_db()
 
-      return if unopened_envelope?( master_db )
+      puts ""
+      puts "### #############################################################\n"
+      puts "### Book Birthday =>> #{KeyApi.to_db_create_date(master_db)}\n"
+      puts "### The Book Name =>> #{KeyApi.to_db_domain_name(master_db)}\n"
+      puts "### The Book (Id) =>> #{KeyApi.to_db_domain_id(master_db)}\n"
+      puts "### #############################################################\n"
+      puts "--- --------------------------------------------------------------\n"
+
+      chapters = KeyApi.to_matching_dictionary( master_db, ENVELOPE_KEY_PREFIX )
+      export_filename = "safedb.book-#{KeyApi.read_app_id()}-#{KeyNow.yyjjj_hhmm_ss_nanosec()}.json"
+      export_filepath = File.join( Dir.pwd, export_filename )
+
+      exported_struct = {}
+      verse_count = 0
 
-      chapter_id = ENVELOPE_KEY_PREFIX + master_db[ ENV_PATH ]
-      has_chapter = KeyApi.db_envelope_exists?( master_db[ chapter_id ] )
+      chapters.each_pair do | chapter_name, crumb_dictionary |
+
+        chapter_struct = KeyDb.from_json( KeyApi.content_unlock( crumb_dictionary ) )
+        verse_count += chapter_struct.length
+        exported_struct.store( chapter_name, chapter_struct )
 
-      unless has_chapter
-        puts "{}"
-        return
       end
 
-      chapter_data = get_chapter_data( master_db[ chapter_id ] )
-      puts JSON.pretty_generate( chapter_data )
+      File.write( export_filepath, JSON.pretty_generate( exported_struct ) )
+
+      puts ""
+      puts "Number of chapters exported >> #{chapters.length}"
+      puts "Number of verses exported >> #{verse_count}"
+      puts "The export filename is #{export_filename}"
+      puts "The Present Working Directory is #{Dir.pwd}"
+      puts ""
+
+      puts "--- --------------------------------------------------------------\n"
+      puts "### #############################################################\n"
+      puts ""
 
-      return
 
     end
 

data/lib/usecase/init.rb

@@ -48,10 +48,6 @@ module SafeDb
       KeyApi.setup_domain_keys( @domain_name, domain_password, create_header() )
       print_domain_initialized
 
-# -->      unless @base_path.nil?
-# -->        key_api.register_keystore( @base_path )
-# -->      end
-
     end
 
 

data/lib/version.rb

@@ -1,3 +1,3 @@
 module SafeDb
-  VERSION = "0.3.1009"
+  VERSION = "0.3.1010"
 end

data/safedb.gemspec

@@ -29,9 +29,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'thor',    '~> 0.20'
   spec.add_dependency 'inifile', '~> 3.0'
 
-  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "bundler", "~> 0"
   spec.add_development_dependency "cucumber", "~> 2.0"
   spec.add_development_dependency "aruba", "~> 1.0.0-alpha.1"
-  spec.add_development_dependency "gem-release"
+  spec.add_development_dependency "gem-release", "~> 0"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safedb
 version: !ruby/object:Gem::Version
-  version: 0.3.1009
+  version: 0.3.1010
 platform: ruby
 authors:
 - Apollo Akora
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-10 00:00:00.000000000 Z
+date: 2019-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -56,14 +56,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -98,14 +98,14 @@ dependencies:
   name: gem-release
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 description: safe is a credentials manager for the linux command line written in Ruby.