prove_keybase 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98de567e2e93c7858d52f3ddc970d034353a0222666537e2148403d9929a2d23
-  data.tar.gz: b19bb531849068ecc423ea074c5b6c35957551133dafa147a5a034779830a978
+  metadata.gz: 478d6b2e7486a318cd58545885ffcbf95630d7e7354584b9a61b17da13ffce75
+  data.tar.gz: ef316bec11d97651ff7d13aa55ecd688fdc4757b41935ed04465623c16e3d8a9
 SHA512:
-  metadata.gz: 7504350b2e10e01a0136c765a34e32b01e51d3aeef0b51a5fd42bccdab0dbc519aa596a3f832a01df5207732904e1a728c1398a0a5cc7be9336a73f4cfba37cf
-  data.tar.gz: 00db06417b4fb949fce1d6a0324c0882190f132aa2697b8c41d9b2524c3ffd195bfc52d149a2fe8f34045cf5c7329fdf5e844314149941f10cb1f6807a6e1645
+  metadata.gz: 7d428ac813a60791e12b1ac02c1ce65945516851418b9761bc3aff171d2ce5e2f5bd02c866475b8d322790a4e81aa2c969d4819d17840802eee08165dcdaf25c
+  data.tar.gz: 0e6714bcf31889b507bea552debb89c37ce4fe7247a5e96ce6f147158f1553000f91464a1eee6f77e640b257d41f269a2fbecbb27557855d2e7be2e2e17336f9

data/README.md

@@ -38,10 +38,10 @@ curl https://keybase.io/_/api/1.0/validate_proof_config.json\?config_url\=https:
 ## Overrides
 
 ### Definitely do this
-First and foremost, the view template to create a new proof is ugly as sin. This is intentional. Please make it look and feel like it's part of your site, which it is. For an example of how to do this, [here](app/views/prove_keybase/proofs/new.html.erb) is the view you need to override, and [here](spec/dummy/app/views/prove_keybase/proofs/new.html.erb) it is being overridden in the dummy app.
+First and foremost, the view template to create a new proof is ugly as sin. This is intentional. Please make it look and feel like it's part of your site, which it is. For an example of how to do this, [here](app/views/prove_keybase/proofs/new.html.erb) is the view you need to override, and [here](spec/dummy/app/views/prove_keybase/proofs/new.html.erb) it is being overridden in the dummy app. The generator should have put a file in the right place.
 
 ### Consider doing this
-A lot of the controller behavior, especially around handling authentication, is constructed in this gem with subclassing / method-overriding in mind. Take a look at the [KeybaseBaseController](app/controllers/prove_keybase/keybase_base_controller.rb). All of these methods _can_ (and some _should_) be overridden. The dummy app has an example of this [here](spec/dummy/app/controllers/keybase_base_controller.rb).
+A lot of the controller behavior, especially around handling authentication, is constructed in this gem with subclassing / method-overriding in mind and some assumptions about, for example, identifying the logged-in user. Take a look at the [KeybaseBaseController](app/controllers/prove_keybase/keybase_base_controller.rb). All of these methods _can_ (and some _should_) be overridden. The generator should have put a file in the right place with some notes to get you started. The dummy app has an [example](spec/dummy/app/controllers/keybase_base_controller.rb).
 
 ## Keeping data up-to-date
 It's always possible for a user to revoke their proof in Keybase. To ensure that your site is not linking to a broken proof, we have a couple of suggestions. The behavior that checks Keybase for a proof and updates your `keybase_proofs` table is accessible through an async job called `UpdateFromKeybaseJob`. Keybase would prefer if you did not call this every time every user sees another user's proofs. A nice compromise is to fire this off whenever a user looks at their own proofs. We do this in the dummy app [here](spec/dummy/app/controllers/users_controller.rb).

data/app/controllers/prove_keybase/keybase_base_controller.rb

@@ -18,17 +18,19 @@ class ProveKeybase::KeybaseBaseController < ::ApplicationController
     redirect_to new_proof_url(params: proof_params)
   end
 
-  def handle_wrong_logged_in_user(logged_in_as, proving)
-    flash[:alert] = "you're logged in as #{logged_in_as} but trying to prove #{proving}"
-    handle_login_redirect
-  end
-
   def avatar_url_from_username(username)
     # if you override this method, please keep the behavior
     # of raising an exception when a user does not exist.
     User.find_by!(username: username).avatar_url || 'https://example.com/default_avatar.jpg'
   end
 
+  private
+
+  def handle_wrong_logged_in_user(logged_in_as, proving)
+    flash[:alert] = "you're logged in as #{logged_in_as} but trying to prove #{proving}"
+    handle_login_redirect
+  end
+
   def handle_login_redirect
     redirect_to Rails.application.routes.url_helpers.send(ProveKeybase.configuration.login_redirection)
   end

data/lib/generators/prove_keybase/prove_keybase_generator.rb

@@ -5,6 +5,8 @@ class ProveKeybaseGenerator < Rails::Generators::NamedBase
   def install
     copy_file "initializer.rb", "config/initializers/prove_keybase.rb"
     migration_template "migration.rb", "db/migrate/create_keybase_proofs.rb"
+    copy_file "base_controller.rb", "app/controllers/keybase_base_controller.rb"
+    copy_file "new_proof.html.erb", "app/views/prove_keybase/proofs/new.html.erb"
   end
 
   def self.next_migration_number(dir)

data/lib/generators/prove_keybase/templates/base_controller.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require ProveKeybase::Engine.root.join('app', 'controllers', 'prove_keybase', 'keybase_base_controller')
+
+class ProveKeybase::KeybaseBaseController
+
+  # current_user is expected to be the logged in user. In your app, this is
+  # very likely already the case. If it is, you can just delete this and
+  # stop reading.
+  # If you don't use current_user from elsewhere, then please uncomment this.
+  # It should be the logged-in user. This is also used in the view file that
+  # you'll be overriding / rewriting, which is why `helper_method` is here.
+  # helper_method :current_user
+  # def current_user
+  #   User.find_by(username: params[:username]) || User.new
+  # end
+
+  # def user_is_logged_in!
+  #   handle_login_redirect unless current_user
+  # end
+
+  # def user_proving_own_account!
+  #   unless current_user.username.casecmp(@proving_username).zero?
+  #     handle_wrong_logged_in_user(current_user.username, @proving_username)
+  #   end
+  # end
+
+  # def handle_proof_failed
+  #   flash[:alert] = 'proof failed. please start again from keybase.'
+  #   redirect_to new_proof_url(params: proof_params)
+  # end
+
+  # def avatar_url_from_username(username)
+  #   # if you override this method, please keep the behavior
+  #   # of raising an exception when a user does not exist.
+  #   User.find_by!(username: username).avatar_url || 'https://example.com/default_avatar.jpg'
+  # end
+
+  # private
+
+  # def handle_wrong_logged_in_user(logged_in_as, proving)
+  #   flash[:alert] = "you're logged in as #{logged_in_as} but trying to prove #{proving}"
+  #   handle_login_redirect
+  # end
+
+  # def handle_login_redirect
+  #   redirect_to Rails.application.routes.url_helpers.send(ProveKeybase.configuration.login_redirection)
+  # end
+
+end

data/lib/generators/prove_keybase/templates/new_proof.html.erb

@@ -0,0 +1,18 @@
+<p id='alert'><%= alert %></p>
+
+<h2>Rewrite Me Please</h2>
+
+<p>this is you here:</p>
+<p><%= image_tag current_user.avatar_url, width: 200 %></p>
+
+<p>is this you on keybase?</p>
+<p><%= image_tag @proof.keybase_avatar_url, width: 200 %></p>
+
+
+<%= form_with scope: :proof, url: proofs_path, local: true do |f| %>
+  <%= f.hidden_field :token, value: @proof.token %>
+  <%= f.hidden_field :username, value: @proof.username %>
+  <%= f.hidden_field :kb_username, value: @proof.kb_username %>
+  <%= f.hidden_field :kb_ua, value: params[:kb_ua] %>
+  <%= submit_tag 'yes' %>
+<% end %>

data/lib/prove_keybase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ProveKeybase
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prove_keybase
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alex Gessner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-10 00:00:00.000000000 Z
+date: 2019-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
@@ -147,8 +147,10 @@ files:
 - config/routes.rb
 - lib/generators/prove_keybase/USAGE
 - lib/generators/prove_keybase/prove_keybase_generator.rb
+- lib/generators/prove_keybase/templates/base_controller.rb
 - lib/generators/prove_keybase/templates/initializer.rb
 - lib/generators/prove_keybase/templates/migration.rb
+- lib/generators/prove_keybase/templates/new_proof.html.erb
 - lib/prove_keybase.rb
 - lib/prove_keybase/configuration.rb
 - lib/prove_keybase/engine.rb