keypairs 0.1.0.alpha.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf4de0021d86f8b939eb09102bf3523ff50c43b65306090823f4d7ea896f85c6
-  data.tar.gz: 69e0d3738b6e8d3c2d3d1e7b397b08361d83b98f075526ffd9174ab844201109
+  metadata.gz: 1d5f2f484253f46b38eb0c4ee8a71e77bec208ac0aeca8a5909f20389b8de9a9
+  data.tar.gz: bb148cb660872ca14d8ba9c3416fccff38efeac97619f581b5019f2f76b83157
 SHA512:
-  metadata.gz: 0e2acb9c0ec8069c3de1885bb810d6d759fa5e6594ce309feffb3abd5e357338106740949185734731f2fd9368b06472cbc2cd2dedc2a283711c78a17587c6af
-  data.tar.gz: 359aeb886e535c34f4c8071b4043e1186c92e91947b05c6215cd45efd3a54314abb85be17d8e56b5e186581b8a166f9b8f5f2e22ab4cc1af8a9590d796c9c546
+  metadata.gz: 6b0baa0b7ad99ed238cbd7021f81fe53a40abfc720e0a1b95bc8c83f23680b15aac0c19f551f3f4c19821423a29dc2a2e48c41e68a0af3da9e9442c094784920
+  data.tar.gz: 53160f8c12ff02c7b3143f771b7890a50e4ad1014f6c1b1c5ec6b3d97486477b831fefa5a3b3654daeb0617ae09dcdb5494cba0465850823023abe68de8a133b

data/README.md

@@ -4,15 +4,28 @@ Applications often need to have a public/private keypair so sign messages. This
 Note: This gem is intended to work within Rails applications. It can probably be adjusted easily to also work for non-rails / sinatra project but that's out of scope for now. 
 
 ## Installation
-Add this line to your application's Gemfile:
+1. **Add gem**
 
-```ruby
-gem 'keypairs'
-```
+   Add this line to your application's Gemfile:
+   
+   ```ruby
+   gem 'keypairs'
+   ```
+   
+   The of course run `bundle install`. 
+
+2. **Copy migration**
+
+   The default migration file can be copied to your app with:
+   ```bash
+   bundle exec rails keypairs:install:migrations
+   ```
+   
+   Then of course run `bundle exec rails db:migrate`
 
-The of course run `bundle install` and run the migrations `bundle exec rake db:migrate`. The migrations from the gem run automatically.
+3. **Setup encryption key**
 
-The private keys are encrypted with the [lockbox](https://github.com/ankane/lockbox) gem. In order for this to work, you need to set the master key as described in [the readme](https://github.com/ankane/lockbox#key-generation), but the easiest thing is to set the environment variable `LOCKBOX_MASTER_KEY` to a sufficient long string (you can generate one with `Lockbox.generate_key`).
+   The private keys are encrypted with the [lockbox](https://github.com/ankane/lockbox) gem. In order for this to work, you need to set the master key as described in [the readme](https://github.com/ankane/lockbox#key-generation), but the easiest thing is to set the environment variable `LOCKBOX_MASTER_KEY` to a sufficient long string (you can generate one with `Lockbox.generate_key`).
 
 ## Usage
 The central point of this gem is the `Keypair` model which is backed by the `keypairs` table. If you need to sign messages, you can get the current keypair with the `Keypair.current` method. This method performs the rotation of the keypairs if required.

data/lib/keypairs.rb

@@ -1,4 +1,11 @@
 # frozen_string_literal: true
 
 require 'lockbox'
-require 'keypairs/engine'
+
+autoload :Keypair, 'keypair.rb'
+
+module Keypairs
+  autoload :PublicKeysController, 'keypairs/public_keys_controller'
+end
+
+require 'keypairs/engine' if defined?(Rails)

data/lib/keypairs/engine.rb

@@ -1,18 +1,8 @@
 # frozen_string_literal: true
 
 module Keypairs
-  # Rails engine for this gem.
-  # It ensures that the migrations are automatically ran in the applications.
+  # This engine is only needed to add the migration installation rake task.
   class Engine < ::Rails::Engine
-    initializer :append_migrations do |app|
-      unless app.root.to_s.match? "#{root}/"
-        config.paths['db/migrate'].expanded.each do |expanded_path|
-          app.config.paths['db/migrate'] << expanded_path
-        end
-        # Apartment will modify this, but it doesn't fully support engine migrations,
-        # so we'll reset it here
-        ActiveRecord::Migrator.migrations_paths = app.paths['db/migrate'].to_a
-      end
-    end
+    engine_name 'keypairs'
   end
 end

data/lib/keypairs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Keypairs
-  VERSION = '0.1.0.alpha.2'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keypairs
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Stef Schenkelaars
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-26 00:00:00.000000000 Z
+date: 2020-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -215,11 +215,11 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- app/controllers/keypairs/public_keys_controller.rb
-- app/models/keypair.rb
 - db/migrate/20201024100500_create_keypairs.rb
+- lib/keypair.rb
 - lib/keypairs.rb
 - lib/keypairs/engine.rb
+- lib/keypairs/public_keys_controller.rb
 - lib/keypairs/version.rb
 homepage: https://drieam.github.io/keypairs
 licenses:
@@ -238,9 +238,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.4
 signing_key: