story_key 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8817282d492c7937c7e5e9cedca2b8b3bc65ed9615311bdb3bd1e00bbb665a64
-  data.tar.gz: b4776a9cf0648428b5e3ed0e0394c54f257419d629365fa0c64b0623f0a31034
+  metadata.gz: eeeb70d8a72b1bc5e5d79ddfbcdd209e99fc0a06585e39a962e03c23e16668da
+  data.tar.gz: 65f19dfe8a2dea256fd81b9e89cc408abbf49bec3cdca1ab2c11d5e0f727d595
 SHA512:
-  metadata.gz: da93f898ecad35d8949d8d2917d7104dcae73f53b851c35e0b3a7d2ddafc010edc83bb27f24caa363c15a4235c0c37344d962f379a681ef01d2fdce1b4540dce
-  data.tar.gz: a3a87b54e9551dec7238e6587198ad4c93eda1741fc178fb29f42d446671268851da364527cb5a8358493d39e7a8a238f4c60fbd5f716845b754d0fe7e873c08
+  metadata.gz: b20a511ddc38ac544dcf5f9d406ac2828d9f0f0605bf4e8d645742d2fe0e032f0581f8b0faec9d7bf9983a7231bca0ceccde8d2f7334263a610295f4aa2bd797
+  data.tar.gz: 1b10fdb21424a1712520e2d12b6c48bd4766bfc7f9d49e0880524469aa4ca060c881860e1e7180acd595ed2ccf3c81688e91d4b3618d00c1d51f31ba2ffffbd5

data/.gitignore

@@ -1,9 +1,12 @@
+**/.DS_Store
+.env
 .rspec_status
+*.gem
 /_yardoc/
 /.bundle/
 /.yardoc
 /doc/
 /pkg/
 /spec/reports/
-/tmp/
-*.gem
+/tmp/*
+!/tmp/.keep

data/.rubocop.yml

@@ -1,5 +1,6 @@
 require:
   - rubocop-performance
+  - rubocop-rake
   - rubocop-rspec
 
 AllCops:
@@ -8,7 +9,7 @@ AllCops:
     - vendor/**/*
     - lib/story_key/data.rb
   NewCops: enable
-  TargetRubyVersion: 3.1.1
+  TargetRubyVersion: 3.2.0
 Gemspec/RequireMFA:
   Enabled: false
 Layout/EmptyLineAfterGuardClause:

data/.ruby-version

@@ -1 +1 @@
-3.1.1
+3.2.0

data/.travis.yml

@@ -2,7 +2,7 @@ dist: focal
 language: ruby
 cache: bundler
 rvm:
-  - 3.1.1
+  - 3.2.0
 notifications:
   email: false
 before_install:

data/Gemfile.lock

@@ -1,21 +1,24 @@
 PATH
   remote: .
   specs:
-    story_key (0.2.0)
-      activesupport (~> 7.0.2)
+    story_key (0.4.0)
+      activesupport (~> 7.0.4)
       awesome_print (~> 1.9.2)
       base58 (~> 0.2.3)
+      dotenv (~> 2.8.1)
       dry-initializer (~> 3.1.1)
-      indefinite_article (~> 0.2.4)
+      indefinite_article (~> 0.2.5)
       pry (~> 0.14.1)
       remedy (~> 0.3.0)
+      rmagick (~> 5.1.0)
+      ruby-openai (~> 3.0.2)
       thor (~> 1.2.1)
-      zeitwerk (~> 2.5.4)
+      zeitwerk (~> 2.6.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.2.3)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -26,75 +29,91 @@ GEM
     coderay (1.1.3)
     concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
+    dotenv (2.8.1)
     dry-initializer (3.1.1)
-    i18n (1.10.0)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    indefinite_article (0.2.4)
+    indefinite_article (0.2.5)
       activesupport
+    json (2.6.3)
     method_source (1.0.0)
-    minitest (5.15.0)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    minitest (5.16.3)
+    multi_xml (0.6.0)
     parallel (1.22.1)
-    parser (3.1.1.0)
+    parser (3.1.3.0)
       ast (~> 2.4.1)
+    pkg-config (1.5.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.1)
+    regexp_parser (2.6.1)
     remedy (0.3.0)
     rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rmagick (5.1.0)
+      pkg-config (~> 1.4)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.26.1)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.41.1)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.16.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
+    rubocop-ast (1.24.1)
       parser (>= 3.1.1.0)
-    rubocop-performance (1.13.3)
+    rubocop-performance (1.15.2)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.9.0)
-      rubocop (~> 1.19)
+    rubocop-rspec (2.16.0)
+      rubocop (~> 1.33)
+    ruby-openai (3.0.2)
+      httparty (>= 0.18.1, < 0.21.0)
     ruby-progressbar (1.11.0)
     thor (1.2.1)
-    tzinfo (2.0.4)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
-    zeitwerk (2.5.4)
+    unicode-display_width (2.3.0)
+    zeitwerk (2.6.6)
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-22
   x86_64-linux
 
 DEPENDENCIES
-  bundler (~> 2.3.7)
+  bundler (~> 2.4.1)
   rake (~> 13.0.6)
-  rspec (~> 3.11.0)
-  rubocop (~> 1.26.1)
-  rubocop-performance (~> 1.13.3)
+  rspec (~> 3.12.0)
+  rubocop (~> 1.41.1)
+  rubocop-performance (~> 1.15.2)
   rubocop-rake (~> 0.6.0)
-  rubocop-rspec (~> 2.9.0)
+  rubocop-rspec (~> 2.16.0)
   story_key!
 
 BUNDLED WITH
-   2.3.7
+   2.4.1

data/README.md

@@ -1,5 +1,4 @@
 [![Gem Version](https://badge.fury.io/rb/story_key.svg)](https://badge.fury.io/rb/story_key)
-![Gem Downloads](https://ruby-gem-downloads-badge.herokuapp.com/story_key?type=total)
 [![Build Status](https://travis-ci.org/jcraigk/story_key.svg?branch=main)](https://travis-ci.org/jcraigk/story_key)
 [![Maintainability](https://api.codeclimate.com/v1/badges/6046413814d7f6417ce9/maintainability)](https://codeclimate.com/github/jcraigk/story_key/maintainability)
 
@@ -8,23 +7,28 @@
 
 | Gem Version | Locale | Lexicon SHA |
 |-------------|--------|-------------|
-| 0.2.0       | Miami  | 4eea29f     |
+| 0.4.0       | Miami  | 3bfbbf9     |
+
+Locale will not change until v1.0 release
 
 
 # StoryKey
 
-StoryKey is a [Brainwallet](https://en.bitcoin.it/wiki/Brainwallet) inspired by [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) written in [Ruby](https://www.ruby-lang.org/en/). It converts an arbitrary string of data, such as a [cryptocurrency private key](https://en.bitcoin.it/wiki/Private_key), into an English paragraph intended for longterm human memory. It also assists in decoding the story back into its original form.
+StoryKey is a proof of concept [Brainwallet](https://en.bitcoin.it/wiki/Brainwallet) inspired by [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) written in [Ruby](https://www.ruby-lang.org/en/). It converts an arbitrary string of data, such as a [cryptocurrency private key](https://en.bitcoin.it/wiki/Private_key), into an English paragraph intended for longterm human memory. It also assists in decoding the story back into its original form. Optionally, a visual representation of the paragraph is also provided using [OpenAI DALL-E](https://openai.com/dall-e-2).
 
-Each story is provided in two formats:
-* Humanized
+Each story is provided in multiple formats:
+* Humanized Text
   * Version locale header ("In Miami I saw...")
   * Enumerated phrases
   * Colorized parts of speech (adjectives, verbs, nouns)
   * Grammatical filler (articles, prepositions, conjunctions, punctuation)
-* Tokenized
+* Tokenized Text
   * Ordered list of unique tokens
   * Space-delimited lowercase alphanumeric/dash
   * Useful as a seed phrase for generating derivative keys
+* Graphical
+  * AI-generated images via [DALL-E](https://openai.com/dall-e-2)
+  * Requires OpenAI key
 
 ## Features
 
@@ -33,7 +37,7 @@ Each story is provided in two formats:
 * Includes version slug to ensure accurate decoding
 * Uses a repeating English grammar to aid in mnemonics
 * Uses a lexicon curated for mental visualization
-* Avoids token repetition
+* Avoids word repetition
 * Provides interactive command-line recovery
 
 Each token of the story, which may be a single word or short compound phrase, encodes 10 bits. The checksum length is variable based on the input size and space available in the last two tokens after accounting for a 4-bit footer. Here are a few example key sizes along with their respective story and checksum sizes.
@@ -47,24 +51,25 @@ Each token of the story, which may be a single word or short compound phrase, en
 | 384      | 40           | 12            |
 | 512      | 53           | 14            |
 
-An example key and its associated story and seed phrase are shown below.
+An example key with its associated story, seed phrase, and image are shown below.
 
-![Key/Story Example](https://user-images.githubusercontent.com/104095/161372021-1edb5999-453d-453a-a7bb-d2fc2bcc3120.png)
+![KeyStory Example Text](https://user-images.githubusercontent.com/104095/210197560-45494c50-6382-465b-8163-a61b3783ac76.png)
+![KeyStory Example Image](https://user-images.githubusercontent.com/104095/210197577-11e1d6ac-a32f-4438-b7eb-f766bf62f0f2.png)
 
 ```
 Key:
-CH8krjSZpGFmxnKo9QPqQEd9oMUkXnLcUhhEQFLrGCtg
+CgCLLXvoch7sLaQWe5Y3Evtzety2Vr9XJGRmAq9YZUXY
 Story:
 In Miami I saw
-1. a pensive Ellen Ripley surpass a musician,
-2. an unhappy pug drink vodka with a dove,
-3. an opulent Dante Alighieri diagnose Huckleberry Finn,
-4. a frantic sister eat pretzels with Mozart,
-5. a cunning meerkat trim a balloonist,
-6. a rich ocelot step to John Wayne,
-7. and a civilian convict a locust.
+1. a practical theorist eating toast with a shopkeeper,
+2. a jobless macaw disowning a scientist,
+3. a toothsome brother eating dumplings with Paul Cezanne,
+4. a rabid outsider leveling a vulture,
+5. a hysterical Marge Simpson threatening Moe Szyslak,
+6. a rancid cyborg demanding a jeweler,
+7. and a wife paging Jimi Hendrix.
 Seed Phrase:
-pensive ellen-ripley surpass musician unhappy pug drink-vodka dove opulent dante-alighieri diagnose huckleberry-finn frantic sister eat-pretzels mozart cunning meerkat trim balloonist rich ocelot step john-wayne civilian convict locust
+miami practical theorist eating-toast shopkeeper jobless macaw disowning scientist toothsome brother eating-dumplings paul-cezanne rabid outsider leveling vulture hysterical marge-simpson threatening moe-szyslak rancid cyborg demanding jeweler wife paging jimi-hendrix
 ````
 
 This paragraph or seed phrase can be deterministically decoded back into its original form using the same version of StoryKey. The locale of the story (e.g. `Miami`) identifies that version. During key recovery, an exception will be raised if:
@@ -86,11 +91,6 @@ The lexicon was selected using the following criteria:
 * Balance brevity with clarity.
 
 
-### Graphical Visualization
-
-When AI becomes more common, StoryKey stories may be converted to graphical panels similar to the [DALL-E Project](https://openai.com/blog/dall-e/). This will likely aid in mnemonics process for many users.
-
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -113,7 +113,16 @@ $ gem install story_key
 
 ## Usage
 
-This library may be used by calling Ruby methods or directly from the command line.
+This library may be used directly from the command line or by calling Ruby methods.
+
+If you want to generate images of the story along with the text, create a file named `.env` in the project directory and add your [OpenAI key](https://beta.openai.com/account/api-keys) as an environment variable:
+
+```
+# .env
+OPENAI_KEY=<your-api-key>
+```
+
+You must have [ImageMagick](https://imagemagick.org/index.php) installed locally.
 
 
 ### Command Line Usage
@@ -129,6 +138,8 @@ StoryKey commands:
   storykey recover         # Decode a story interactively
 ```
 
+To see help on a specific command, run `bin/storyke --help [command]`.
+
 The command line also features an interactive recovery tool to aid in converting a story back into its source key. Run `bin/storykey recover` to initiate the process:
 
 ![Key/Story Example](https://user-images.githubusercontent.com/104095/161376334-4a591100-e3fc-41ce-b931-4773bebc23fd.png)
@@ -141,10 +152,10 @@ After installing the gem, you may run `bin/console` or `require` the gem in your
 
 ### Generate new key/story
 
-Generate a new random key/story pair.
+Generate a new random key and associated story.
 
 ```
-3.1.1# StoryKey.generate
+# StoryKey.generate
  =>
 ["4eqfoXzMDyqQW6p8zAQj7c8KkynK5K2BW6D5Vfp7xCaQ",
  #<struct StoryKey::Story
@@ -157,12 +168,12 @@ Generate a new random key/story pair.
 ```
 
 
-### Encode key => story
+### Encode an existing key
 
 Produce an English paragraph given input data (e.g. a cryptocurrency private key):
 
 ```
-3.1.1# StoryKey.encode(key: '4eqfoXzMDyqQW6p8zAQj7c8KkynK5K2BW6D5Vfp7xCaQ')
+# StoryKey.encode(key: '4eqfoXzMDyqQW6p8zAQj7c8KkynK5K2BW6D5Vfp7xCaQ')
  =>
  #<struct StoryKey::Story
  text=
@@ -176,12 +187,12 @@ Produce an English paragraph given input data (e.g. a cryptocurrency private key
 `key` may be in the form of a hexidecimal (`ab29f3`), a binary string (`1001101`), a decimal (`230938`), or a base58 string (`uMBca`). If not in the default base58, `format` must be provided.
 
 
-### Decode story => key
+### Decode an existing story
 
 Recover source data (e.g. a cryptocurrency private key) based on the English paragraph:
 
 ```
-3.1.1# StoryKey.decode(story: 'In Miami I saw an official Benjamin Franklin transport Matt Damon')
+# StoryKey.decode(story: 'In Miami I saw an official Benjamin Franklin transport Matt Damon')
  => "4NTM"
 ```
 
@@ -195,7 +206,7 @@ When editing the lexicon, be sure to:
 2. Copy the lexicon SHA into `version.rb` as well as this README (if publishing)
 3. Increment the semantic version of the gem (if publishing)
 
-When incrementing the semantic version, be sure to:
+When incrementing the semantic version post-1.0, be sure to:
 1. Create a new `VERSION_SLUG`, adhering to the locale convention
 2. Append a row to the version reference at the top of this README
 

data/lexicons/adjectives/misc.txt

@@ -46,13 +46,11 @@ clear
 cold
 colorful
 comical
-complex
 cosmic
 coy
 cynical
 dangerous
 dark
-dead
 decayed
 deficient
 delicate
@@ -152,7 +150,6 @@ late
 lewd
 liberal
 limpid
-limping
 little
 lively
 lofty
@@ -307,11 +304,11 @@ volatile
 wasteful
 wholesome
 wide
+wide-eyed
 wild
 winged
 wintery
 wobbly
-wonderful
 woozy
 worried
 wrinkled

data/lexicons/adjectives/personable.txt

@@ -1,8 +1,8 @@
 adamant
-adroit
+adament
 affable
 affluent
-ageless
+aging
 albino
 alcoholic
 alluring
@@ -50,8 +50,8 @@ chaste
 cheap
 childish
 childlike
-choking
 chubby
+churlish
 civilized
 clairvoyant
 clammy
@@ -91,6 +91,7 @@ dapper
 dashing
 dastardly
 dazed
+dead
 deaf
 decadent
 decisive
@@ -107,6 +108,7 @@ difficult
 dignified
 diligent
 dim
+disabled
 discreet
 diseased
 disguised
@@ -126,7 +128,6 @@ drunk
 dull
 dumb
 dutiful
-dying
 eager
 earnest
 elderly
@@ -358,6 +359,7 @@ purring
 pushy
 queasy
 quirky
+quivering
 rambling
 rash
 reckless
@@ -465,6 +467,7 @@ trashy
 trembling
 trendy
 truthful
+twitching
 unconscious
 undead
 unkempt