Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add README and contributing guidelines

  • Loading branch information...
commit e4ebfff1defdd7acbe215a3feb8a3090d7f50378 1 parent 3bd7a0c
James Stewart jystewart authored
Showing with 34 additions and 0 deletions.
  1. +1 −0  .gitignore
  2. +4 −0 CONTRIBUTING.md
  3. +29 −0 README.md
1  .gitignore
View
@@ -0,0 +1 @@
+config.rb
4 CONTRIBUTING.md
View
@@ -0,0 +1,4 @@
+Pull requests are great.
+
+I'm aware there are no tests for this code, but if you're submitting
+changes please supply some.
29 README.md
View
@@ -0,0 +1,29 @@
+# Need-O-Tron Daily
+
+A script to send a daily email about the previous day's traffic to GOV.UK.
+This used to be part of need-o-tron but didn't really need to be included
+there, so I've pulled it out on its own.
+
+## Usage
+
+Use ```bundle install``` to install dependencies.
+
+Run the script with ```bundle exec ruby send_email.rb```
+
+The script depends on a set of environment variables:
+
+* ENV['GOOGLE_OAUTH_TOKEN'] # The OAuth token to access Google Analytics
+* ENV['GOOGLE_OAUTH_SECRET'] # The OAuth secret to access Google Analytics
+* ENV['ANALYTICS_ACCOUNT_ID'] # The Google Analytics account ID
+* ENV['SES_ACCESS_KEY_ID'] # Access Key ID for Amazon SES (for outbound email)
+* ENV['SES_SECRET_KEY'] # Access Secret for Amazon SES (for outbound email)
+* ENV['RECIPIENT_ADDRESS'] # Email address to send the report to
+
+The recipient address will have to have been authorised via Amazon SES.
+
+To run locally you can create a file called config.rb to set these values. Don't
+commit it to this repository.
+
+## Credits
+
+The original need-o-tron daily was created by [Richard Pope](https://github.com/memespring) and [James Stewart](https://github.com/jystewart) some time ago.
Please sign in to comment.
Something went wrong with that request. Please try again.