Change Recaptcha keys to environment variables

[first-timers]

Hi, this is a first-timers-only issue. This means we've worked to make it more legible to folks who either haven't contributed to our codebase before, or even folks who haven't contributed to open source before.

If that's you, we're interested in helping you take the first step and can answer questions and help you out as you do. Note that we're especially interested in contributions from people from groups underrepresented in free and open source software!

We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you 💝

If you have contributed before, consider leaving this one for someone new, and looking through our general help wanted issues. Thanks!

🤔 What you will need to know.

Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process.

📋 Step by Step

• 🙋 Claim this issue: Comment below. If someone else has claimed it, ask if they've opened a pull request already and if they're stuck -- maybe you can help them solve a problem or move it along!

• 📝 Update the file config/initializers/recaptcha.rb in the plots2 repository (press the little pen Icon) and edit the line as shown below.

See this page for some help in taking your first steps!

Below is a "diff" showing in red (and a -) which lines to remove, and in green (and a +) which lines to add:

@@ -1,8 +1,8 @@
 # config/initializers/recaptcha.rb
 if Rails.env == "production"
   Recaptcha.configure do |config|
-    config.site_key  = '6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI'
-    config.secret_key = '6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe'
+    config.site_key  = ENV["RECAPTCHA_SITE_KEY"]
+    config.secret_key = ENV["RECAPTCHA_SECRET_KEY"]
     # Uncomment the following line if you are using a proxy server:
     # config.proxy = 'http://myproxy.com.au:8080'
   end

• 💾 Commit your changes

• 🔀 Start a Pull Request. There are two ways how you can start a pull request:

1. If you are familiar with the terminal or would like to learn it, here is a great tutorial on how to send a pull request using the terminal.

2. You can also edit files directly in your browser and open a pull request from there.

• 🏁 Done Ask in comments for a review :)

🤔❓ Questions?

Leave a comment below!

Is someone else already working on this?

We encourage you to link to this issue by mentioning the issue # in your pull request, so we can see if someone's already started on it. If someone seem stuck, offer them some help! Otherwise, take a look at some other issues you can help with. Thanks!

(This issue was created by First-Timers-Bot.)

[jywarren]

Hi @icarito - you mentioned We should keep the development API key in case there is not environment variable defined. -- how to do this? Would this work?

config.site_key  = ENV["recaptcha_site_key"] || "default-value"

[icarito]

Hi @jywarren - I assume it is useful to keep the development API key for development. Yes, I just tested the syntax you posted and it works for using either the environment variable or a fallback if it's missing.
Thanks for fleshing out the first-timer-only details!

[icarito]

Just a small caveat that by convention environment variables are all uppercase. I'll edit the description.

[gdestree]

Hey there!
I have been developing with RoR for a while now and i would really like to start contributing to some open source projects! Can i take this issue?

[icarito]

Absolutely @gdestree - thanks for the help! If you have any questions, we are here to help :)

[gdestree]

@icarito The entire recaptcha config is wrapped in an If statement for production.

if Rails.env == "production"
  Recaptcha.configure do |config|
    config.site_key  = '6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI'
    config.secret_key = '6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe'
    # Uncomment the following line if you are using a proxy server:
    # config.proxy = 'http://myproxy.com.au:8080'
  end
end

So in development this block won't be used and thus unnecessary to add the || part.
Should I just change it to the ENV variables?
Another edit I would prefer for this is:
instead of:
if Rails.env == "production"
use:
if Rails.env.production?

[jywarren]

Both of those sound great! Thank you!

…

On Thu, Jun 7, 2018 at 12:23 PM Gregor Destree ***@***.***> wrote: @icarito <https://github.com/icarito> The entire recaptcha config is wrapped in an If statement. if Rails.env == "production" Recaptcha.configure do |config| config.site_key = '6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI' config.secret_key = '6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe' # Uncomment the following line if you are using a proxy server: # config.proxy = 'http://myproxy.com.au:8080' end end So in development this block won't be used and thus unnecessary to add the || part. Should I just change it to the ENV variables? Another edit I would prefer for this is: instead of: if Rails.env == "production" use: if Rails.env.production? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#2762 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABfJwMAvpjvIH5VPf8wAIzoy4ln_6PGks5t6VN0gaJpZM4UYH8B> .

[gdestree]

@jywarren Sorry to bother you one last time, but should I use:

ENV.fetch("RECAPTCHA_SITE_KEY")
ENV.fetch("RECAPTCHA_SECRET_KEY")

This way it breaks on deploy if the environment variable isn't present.
http://ruby-doc.org/core-2.3.7/Hash.html#method-i-fetch

Here is the pr: #2786

[jywarren]

Hmm, not sure -- @icarito what do you think?

…

On Thu, Jun 7, 2018 at 2:28 PM Gregor Destree ***@***.***> wrote: @jywarren <https://github.com/jywarren> Sorry to bother you one last time, but should I use: ENV.fetch("RECAPTCHA_SITE_KEY") ENV.fetch("RECAPTCHA_SECRET_KEY") This way it breaks on deploy if the environment variable isn't present. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#2762 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABfJw-KZyZs4djlEbtf6SyNQudT4tcTks5t6XCsgaJpZM4UYH8B> .