cutting_edge 0.0.1 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec5ca2019987b750f41a29d32bd821812ddc4dba8cf2a966e32e99d28159d6d1
-  data.tar.gz: 17c2f8d3f6d9bcc2b47a8df64860a01d5c326a782ef4faff1c27d70c5749e331
+  metadata.gz: 374d8036819a980b91ba6a3ca1ed76afac1432c44533544d4f5f8d5ab8abb721
+  data.tar.gz: 38a4d5f3b19c65929e26477a9b093029e75ded17ef577dfcf5059d33ced8c197
 SHA512:
-  metadata.gz: '068abcda4a2dae1581ef085a4de162bde10dc8cfe48a5e10b1ad2b011448e1846ed171b479c29c67d7b9fba4bf750def7a3b1d2ea6fff2eb58273a65860d7b7a'
-  data.tar.gz: bafde30af96064fc436dcf866c2a1e64062abd2d6b80e59fc9a337df21e4482f6ac5d7a29a61dd6c4398b90f7439910042614ef0985e525697a0d68b9c5dadbf
+  metadata.gz: 6961bd941782441ad05e4462ef3b20053800a2612490e8cadc2f2fcdafe06904fe64b03f00b36471b921ef62ef1b235c698c685a7bac71730776fd854102babe
+  data.tar.gz: efaeb201b0558e759abb93003ebadc4793622f6a327563f9517355d05bcdb9ea13cc7664a29eb2baebf085ceffae1ca5a6e65dccdf84800575996463923c8796

data/Gemfile

@@ -2,8 +2,13 @@ source 'https://rubygems.org'
 
 gem 'redis', require: false
 
-gem 'rspec', '~> 3.9', :group => :development
-gem 'simplecov', :group => :development
+gem 'hashdiff'
+
+group :development do
+  gem 'rspec', '~> 3.9'
+  gem 'simplecov'
+  gem 'rack-test'
+end
 
 gem 'coveralls', '~>0.8.23', require: false
 

data/Gemfile.lock

@@ -0,0 +1,130 @@
+PATH
+  remote: .
+  specs:
+    cutting_edge (0.1)
+      gemnasium-parser (~> 0.1.9)
+      http (~> 4.3)
+      mail (~> 2.7)
+      moneta (~> 1.2)
+      rufus-scheduler (~> 3.6)
+      sinatra (~> 2.0)
+      sinatra-logger (~> 0.3)
+      sucker_punch (~> 2.1)
+      toml-rb (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    citrus (3.0.2)
+    concurrent-ruby (1.1.7)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    et-orbi (1.2.4)
+      tzinfo
+    ffi (1.13.1)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    fugit (1.4.0)
+      et-orbi (~> 1.1, >= 1.1.8)
+      raabro (~> 1.4)
+    gemnasium-parser (0.1.9)
+    hashdiff (1.0.1)
+    http (4.4.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http-parser (1.2.1)
+      ffi-compiler (>= 1.0, < 2.0)
+    json (2.3.1)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    mini_mime (1.0.2)
+    moneta (1.4.1)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    public_suffix (4.0.6)
+    raabro (1.4.0)
+    rack (2.2.3)
+    rack-protection (2.1.0)
+      rack
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rake (13.0.1)
+    redis (4.2.2)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    ruby2_keywords (0.0.2)
+    rufus-scheduler (3.6.0)
+      fugit (~> 1.1, >= 1.1.6)
+    semantic_logger (4.7.3)
+      concurrent-ruby (~> 1.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sinatra (2.1.0)
+      mustermann (~> 1.0)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
+      tilt (~> 2.0)
+    sinatra-logger (0.3.2)
+      semantic_logger
+      sinatra
+    sucker_punch (2.1.2)
+      concurrent-ruby (~> 1.0)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.0.1)
+    tilt (2.0.10)
+    tins (1.26.0)
+      sync
+    toml-rb (2.0.1)
+      citrus (~> 3.0, > 3.0)
+    tzinfo (2.0.2)
+      concurrent-ruby (~> 1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls (~> 0.8.23)
+  cutting_edge!
+  hashdiff
+  rack-test
+  redis
+  rspec (~> 3.9)
+  simplecov
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -1,5 +1,5 @@
-                    GNU GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
 
  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
@@ -7,17 +7,15 @@
 
                             Preamble
 
-  The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
+  The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
 
   The licenses for most software and other practical works are designed
 to take away your freedom to share and change the works.  By contrast,
-the GNU General Public License is intended to guarantee your freedom to
+our General Public Licenses are intended to guarantee your freedom to
 share and change all versions of a program--to make sure it remains free
-software for all its users.  We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors.  You can apply it to
-your programs, too.
+software for all its users.
 
   When we speak of free software, we are referring to freedom, not
 price.  Our General Public Licenses are designed to make sure that you
@@ -26,44 +24,34 @@ them if you wish), that you receive source code or can get it if you
 want it, that you can change the software or use pieces of it in new
 free programs, and that you know you can do these things.
 
-  To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights.  Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received.  You must make sure that they, too, receive
-or can get the source code.  And you must show them these terms so they
-know their rights.
-
-  Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
-  For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software.  For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
-  Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so.  This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software.  The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable.  Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products.  If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
-  Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary.  To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
+  Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+  A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+  The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+  An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
 
   The precise terms and conditions for copying, distribution and
 modification follow.
@@ -72,7 +60,7 @@ modification follow.
 
   0. Definitions.
 
-  "This License" refers to version 3 of the GNU General Public License.
+  "This License" refers to version 3 of the GNU Affero General Public License.
 
   "Copyright" also means copyright-like laws that apply to other kinds of
 works, such as semiconductor masks.
@@ -549,35 +537,45 @@ to collect a royalty for further conveying from those to whom you convey
 the Program, the only way you could satisfy both those terms and this
 License would be to refrain entirely from conveying the Program.
 
-  13. Use with the GNU Affero General Public License.
+  13. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
 
   Notwithstanding any other provision of this License, you have
 permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
+under version 3 of the GNU General Public License into a single
 combined work, and to convey the resulting work.  The terms of this
 License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
 
   14. Revised Versions of this License.
 
   The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
+the GNU Affero General Public License from time to time.  Such new versions
+will be similar in spirit to the present version, but may differ in detail to
 address new problems or concerns.
 
   Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU General
+Program specifies that a certain numbered version of the GNU Affero General
 Public License "or any later version" applies to it, you have the
 option of following the terms and conditions either of that numbered
 version or of any later version published by the Free Software
 Foundation.  If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
+GNU Affero General Public License, you may choose any version ever published
 by the Free Software Foundation.
 
   If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
+versions of the GNU Affero General Public License can be used, that proxy's
 public statement of acceptance of a version permanently authorizes you
 to choose that version for the Program.
 
@@ -635,40 +633,29 @@ the "copyright" line and a pointer to where the full notice is found.
     Copyright (C) <year>  <name of author>
 
     This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
+    it under the terms of the GNU Affero General Public License as published
+    by the Free Software Foundation, either version 3 of the License, or
     (at your option) any later version.
 
     This program is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
+    GNU Affero General Public License for more details.
 
-    You should have received a copy of the GNU General Public License
+    You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
-  If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
-    <program>  Copyright (C) <year>  <name of author>
-    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
+  If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source.  For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code.  There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
 
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
+For more information on this, and how to apply and follow the GNU AGPL, see
 <https://www.gnu.org/licenses/>.
-
-  The GNU General Public License does not permit incorporating your program
-into proprietary programs.  If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.  But first, please read
-<https://www.gnu.org/licenses/why-not-lgpl.html>.

data/Procfile

@@ -0,0 +1 @@
+web: bundle exec cutting_edge -p $PORT --config heroku.config.rb

data/README.md

@@ -1,95 +1,293 @@
+# CuttingEdge -- Simple, self-hosted dependency monitoring
+
 [![Build Status](https://travis-ci.org/repotag/cutting_edge.svg?branch=master)](https://travis-ci.org/repotag/cutting_edge)
 [![Coverage Status](https://coveralls.io/repos/github/repotag/cutting_edge/badge.svg?branch=master)](https://coveralls.io/github/repotag/cutting_edge?branch=master)
+[![Cutting Edge Dependency Status](https://dometto-cuttingedge.herokuapp.com/github/repotag/cutting_edge/svg 'Cutting Edge Dependency Status')](https://dometto-cuttingedge.herokuapp.com/github/repotag/cutting_edge/info)
+
+CuttingEdge monitors the status of the dependencies of your projects and lets you know when any of them go out of date.
+
+## Features
+
+* Generates badge images that you can include in your projects' Readme, like the one above!
+* Can send you email when the status of a project's dependencies changes
+* Serves a simple [info page](https://dometto-cuttingedge.herokuapp.com/github/repotag/cutting_edge/info) detailing the status of each project
+* Supports the following languages:
+  * Ruby
+  * Python
+  * Rust
+  * [...add more!](https://github.com/repotag/cutting_edge/wiki/Languages)
+* Supports the following platforms:
+  * GitHub
+  * Gitlab (both gitlab.com and [self-hosted instances](#Adding-self-hosted-repository-servers))
+  * Gitea ([self-hosted](#Adding-self-hosted-repository-servers))
+  * Both public and [private repositories](#Authorization-and-private-repositories)
+
+**View the web front end of a [live instance](https://dometto-cuttingedge.herokuapp.com/)**.
+ 
+## Requirements
+
+CuttingEdge is lightweight and easy to deploy: 
+
+* No database required
+  * you can optionally use [data stores like Redis](#Using-Redis-and-other-data-stores)
+* Simple configuration through a `projects.yml` file
+* Requires relatively few resources (~120MB RAM), so...
+* It can even run on [Heroku](#Deploying-on-Heroku)'s free plan!
+
+## Installation
+
+Simply:
+
+```
+$ gem install cutting_edge
+$ cutting_edge
+```
+
+Or run from source:
+
+```
+$ git clone https://github.com/repotag/cutting_edge.git
+$ cd cutting_edge
+$ bundle install
+$ bundle exec cutting_edge
+```
+
+Before running, define your repositories in [projects.yml](#projects-yml). You may also want to change some settings in [config.rb](#config-rb).
+
+### Deploying on Heroku
+
+CuttingEdge runs out of the box on Heroku, and is lightweight enough to function on the Heroku free plan. This repository already contains the `Procfile` needed for deployment.
+
+**Note: on Heroku, CuttingEdge uses `heroku.config.rb` instead of `config.rb`**.
+
+Steps:
+
+1. Clone/fork this repository, as it already contains some settings (in `heroku.config.rb`) relevant to Heroku
+1. Edit `projects.yml` and commit it to the repo
+1. `heroku create my-cuttingedge`
+1. `heroku config:add HEROKU_APP_NAME=my-cuttingedge`
+1. `git push heroku master`
+1. *Optional, if you want to receive [email notifications](#Email-Notifications)*:
+  * `heroku addons:create mailgun:starter`
+  * `heroku config:add CUTTING_EDGE_MAIL_TO=mydependencies@mydependencymonitoring.com`
+  * If you are on the free plan: [add your email addresses as Authorized Recipients](https://help.mailgun.com/hc/en-us/articles/217531258-Authorized-Recipients) in [Mailgun](https://app.mailgun.com/) (login via Heroku)
+
+You may also want to set some [Heroku config variables](https://devcenter.heroku.com/articles/config-vars), for instance to [use authentication tokens](#Authorization-and-private-repositories) in `heroku.config.rb`.
+
+Note that Heroku switches off apps running on their free plan when they idle, so you may want to look at [this](https://medium.com/better-programming/keeping-my-heroku-app-alive-b19f3a8c3a82).
+
+## Usage
+
+When your instance of CuttingEdge is running, you can visit the landing page by pointing your browser to the root URL of the app. Locally, it is by default accessible at:
+
+`http://localhost:4567/`
+
+(Of course, you can also bind it to port 80 or 443 and make it accessible from the internet using the `--port` and `--host` arguments. Or you could place Apache or nginx in front of CuttingEdge.)
+
+An instance on Heroku will be accessible through:
+
+`https://your-app-name.herokuapp.com/`
+
+### projects.yml
+
+`projects.yml` is the file in which you define which repositories you want CuttingEdge to monitor. Here's an example:
+
+```yaml
+github:
+  my_org:
+    my_project:
+      language: ruby
+```
+
+This will make CuttingEdge monitor the GitHub project `my_org/my_project`. You can add multiple repositories under the `github:` key, and also use the `gitlab:` key for repositories on gitlab.com out of the box. If you [add self-hosted providers](#Adding-self-hosted-repository-servers), you'll be able to define repositories using, for instance, `my_gitea:`.
+
+ The `language:` key can currently be set to `ruby` (default), `rust`, or `python`. Further supported keys:
+
+* `auth_token`: see [here](#Authorization-and-private-repositories)
+* `hide`: see [here](#Hide-repositories)
+* `locations`: use to change the default path to dependency definition files. For instance, for a Ruby project, CuttingEdge will by default try to monitor `Gemfile` and `my_project.gemspec`. You can override this with `language: [Gemfile, alternative/file.gemspec]`
+* `branch`: use a different branch than the default `master`
+* `email`:
+  * disable email notifications for a single project by setting this to `false`
+  * use a non-default address delivery address for this project by setting this to e.g. `myproject@mydependencymonitoring.com`
+
+Note: by default CuttingEdge will use `projects.yml` in the working directory. You may optionally specify a different path by running `cutting_edge path/to/my_projects.yml`.
+
+Instead of `projects.yml`, you can also [define projects in `config.rb`](#Defining-repositories-in-configrb).
+
+### config.rb
+
+To configure CuttingEdge specific settings in `config.rb`, you can run `cutting_edge` with the `--config` switch (you can optionally specify an alternative location for the config file). Always make sure you are defining your settings from within the `CuttingEdge` module. For instance:
+
+```ruby
+module CuttingEdge
+  REFRESH_SCHEDULE = '2h'
+end
+```
+
+The sample [config.rb](config.rb) contains some examples of constants that you may wish to configure. Here are some descriptions of what the less obvious ones achieve:
+
+* `SECRET_TOKEN`: set a global secret token for administrative purposes. This token is used to configure [hooks](#Refreshing-dependency-status-through-git-hooks), and to list [hidden projects](#Hide-Repositories).
+* `SERVER_URL`: the link to the app that should be displayed, for instance in emails. Defaults to `"http://#{SERVER_HOST}"`
+* `MAIL_TEMPLATE`: override the [ERB](https://www.stuartellis.name/articles/erb/) template used to render [emails](#Email-Notifications). See [mail.html.erb](lib/cutting_edge/templates/mail.html.erb) for an example on which variables you can use within the template.
+
+### Email Notifications
+
+CuttingEdge can send email notifications whenever a change in the dependency status of a monitored project is detected. This is disabled by default. Enable it in `config.rb`:
+
+```ruby
+module CuttingEdge
+  MAIL_TO = 'mydeps@mymail.com'  # Default address to send email to. If set to false (=default!), don't send any emails except for repositories that have their 'email:' attribute set in projects.yml
+  MAIL_FROM = "cutting_edge@my_server.com" # From Address used for sending emails.
+end
+```
 
-# CuttingEdge
+By default, the app wil try to use an SMTP server on `localhost:25`. Change these settings in your `config.rb` by calling `Mail.defaults`:
 
-## Sinatra App
+```ruby
+# This should be outside the module CuttingEdge
+Mail.defaults do
+  delivery_method :smtp, address: "localhost", port: 1025
+end
+```
 
-* start the app with `bundle exec ruby lib/app.rb`
-* Runs on http://localhost:4567
-* Routes under `/source/org/name`
-  * For example: http://localhost:4567/github/gollum/gollum/info
+See [the mail gem](https://github.com/mikel/mail#sending-an-email) for more information.
 
-## DependencyWorker
+You can switch off email notifications for a single project by setting its `email:` key to `false` in [projects.yml](#projects-yml). Alternatively, you can set the `email:` key for a single project to a different address than the default `MAIL_TO`.
 
-The DependencyWorker currently performs the following actions:
+### Adding self-hosted repository servers
+
+You can monitor projects on your own self-hosted Gitlab or Gitea instances. To do so, you need to tell CuttingEdge about your server by editing `config.rb` as follows:
 
-* Fetch gemfile and gemspec for a given Gem
-  * Currently, the `GithubGem` class specifies the needed information for a gem hosted on github, ditto for the `GitlabGem` class for gitlab.
-  * These are subclasses of `RepositoryGem`.
-* Parse both files for dependency requirements
-  * Does not bork if either of the files could not be retrieved.
-* Determine the latest version for each required gem
-  * By querying rubygems for a version of the gem `>= 0`.
-* Generate a Hash of results of the following form:
 ```ruby
-{:gemspec=>
-  {:outdated_major=>
-    [{:name=>"kramdown",
-      :required=>"~> 1.9.0",
-      :latest=>"2.1.0",
-      :type=>:runtime},
-     {:name=>"sinatra",
-      :required=>"~> 1.4, >= 1.4.4",
-      :latest=>"2.0.8.1",
-      :type=>:runtime},
-     {:name=>"mustache",
-      :required=>">= 0.99.5, < 1.0.0",
-      :latest=>"1.1.1",
-      :type=>:runtime},
-     {:name=>"gemojione",
-      :required=>"~> 3.2",
-      :latest=>"4.3.2",
-      :type=>:runtime}],
-   :outdated_minor=>[],
-   :outdated_bump=>[],
-   :ok=>
-    [{:name=>"gollum-lib",
-      :required=>"~> 4.2, >= 4.2.10",
-      :latest=>"4.2.10",
-      :type=>:runtime},
-     {:name=>"useragent",
-      :required=>"~> 0.16.2",
-      :latest=>"0.16.10",
-      :type=>:runtime}],
-   :unknown=>[]},
- :gemfile=>
-  {:outdated_major=>
-    [{:name=>"rake",
-      :required=>"~> 10.4",
-      :latest=>"13.0.1",
-      :type=>:runtime}],
-   :outdated_minor=>[],
-   :outdated_bump=>[],
-   :ok=>[],
-   :unknown=>[]}}
-
-```
-* These results are stored in a Moneta store under a key generated by `RepositoryGem#identifier` (for e.g. a `GithubGem`, the identifier will be of the form `'github/org/name'`).
-* The Moneta store used by the Worker is provided by the Sinatra app Class: `::CuttingEdge::App.store`.
-  * So we must do e.g. `CuttingEdge::App.set(:store, Moneta.new(:Memory))` to set the `#store` method on the `CuttingEdge` Class.
-
-### Example use of the DependencyWorker and Gem API
-
-See `test.rb` for a basic example (without Sinatra) of how the setup works. Run it with `bundle exec ruby test.rb`.
+module CuttingEdge
+    require './lib/cutting_edge/repo.rb'
+    define_gitlab_server('mygitlab', 'https://mygitlab.com')
+    define_gitea_server('mygitea', 'https://mygitea.com')
+end
+```
+
+This will allow you to use the `mygitlab:` and `mygitea:` keys in `projects.yml`, for instance like so:
+
+```yaml
+mygitlab:
+  myorg:
+    project-name:
+      lang: rust
+mygitea:
+  myorg2:
+    project-name2:
+      lang: python
+```
+
+Don't forget to run CuttingEdge with the `--config` option!
+
+### Authorization and private repositories
+
+If you want to monitor dependencies in a private (e.g. GitHub or Gitlab) project, you can instruct CuttingEdge to use an API token for accessing the dependency files. In `projects.yml`:
+
+```yaml
+github:
+   secret-org:
+     secret-repo:
+       auth_token: 'mysecrettoken'
+```
+
+For info on generating API tokens, see:
+
+* [GitHub](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token)
+* [Gitlab](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)
+* [Gitea](https://docs.gitea.io/en-us/api-usage/)
+
+### Defining repositories in config.rb
+
+If you don't want to expose information about a project in (**such as an [API token](#Authorization-and-private-repositories)!**) `projects.yml` (which may be publically accessible on the internet), you can instead define your project repository programatically in `config.rb`. This will allow you to define repositories with secret parameters by (for instance) utilising environment variables:
 
 ```ruby
-require 'redis-objects'
+module CuttingEdge
+    require './lib/cutting_edge/repo.rb'
+    REPOSITORIES = {
+      "gitlab/#{ENV['SECRET_REPO1_ORG']}/#{ENV['SECRET_REPO1_NAME']}" => GitlabRepository.new(org: ENV['SECRET_REPO1_ORG'], name: ENV['SECRET_REPO1_NAME'], auth_token: ENV['SECRET_REPO1_AUTH_TOKEN'], hide: ENV['SECRET_REPO1_HIDE_TOKEN'])
+    }
+end
+```
 
-gem = GithubGem.new('gollum', 'gollum')
+This approach is especially useful on Heroku, where you can use [Heroku config variables](https://devcenter.heroku.com/articles/config-vars).
 
-Redis::Objects.redis = Redis.new
-gem_dependencies = Redis::Value.new(gem.identifier)
+### Hide Repositories
 
-puts gem_dependencies.value # Currently nil
+You may want the name and dependency monitoring information for private repositories (see above) not to be visible on the internet. To achieve this, you can use `hide: token` in `projects.yml`:
 
-DependencyWorker.perform_async(gem.identifier, gem.gemspec_location, gem.gemfile_location) # Fire up a Sidekiq job
+```yaml
+github:
+   secret-org:
+     secret-repo:
+       auth_token: 'mysecrettoken'
+       hide: 'myhiddenrepo'
+```
 
-# Sleep 5
+...or again, you can do so in `config.rb` following the [method explained above](#Defining-repositories-in-configrb):
 
-puts gem_dependencies.value # The JSON results hash
+```ruby
+GitlabRepository.new(org: ENV['SECRET_REPO1_ORG'], name: ENV['SECRET_REPO1_NAME'], auth_token: ENV['SECRET_REPO1_AUTH_TOKEN'], hide: ENV['SECRET_REPO1_HIDE_TOKEN'])
+end
 ```
 
+Setting the `hide` key to a token of your choice will ensure that:
+
+1. your hidden repo is not listed in the web frontend.
+  * to list all hidden repositories, you can enter your `CuttingEdge::SECRET_TOKEN` after clicking the "List hidden repositories" on the landing page.
+  * **NB: this is your [global administrator token](#configrb), not the particular token used to hide a particular project.** 
+2. the `/info` route and SVG image for your hidden repo are not accessible without the repo-specific token you have set via `hide:`
+
+When you go to the `/info` route for your hidden repo (by first entering your administrator token, then clicking on the SVG for the project), you can click the "Embed" button and thereby acquire a link to the SVG dependency status image that contains the `hide:` token. You can thus use this link on a private repository, without giving collaborators on that project access to information about your other hidden repositories!
+
+### Refreshing dependency status through git hooks
+
+CuttingEdge by default checks whether the status of your dependencies has changed once every hour. However, if you wish, you can also setup hooks so that dependency status is checked (for instance) whenever you make a commit to your project.
+
+For this purpose, CuttingEdge provides the following route:
+
+```
+http://mycuttingedge.com/github/org/myproject/refresh?token=mysecrettoken
+```
+
+An HTTP `POST` request to that route will cause the dependencies for that project to refresh. This requires you to define a secret token in `config.rb`, so that third parties cannot trigger refreshes. In `config.rb`:
+
+```ruby
+module CuttingEdge
+  CuttingEdge::SECRET_TOKEN = 'mysecrettoken' # Note: this token is used to refresh all the projects on your CuttingEdge instance
+end
+```
+
+Using this route you can, for instance, set up a [GitHub Action](https://docs.github.com/en/free-pro-team@latest/actions) (or equivalent for other providers). Of course, this requires defining the secret token as (for instance) a [GitHub Secret](https://docs.github.com/en/free-pro-team@latest/actions/reference/encrypted-secrets).
+
+You can test the route like this:
+
+```
+curl -d 'token=mysecrettoken' http://mycuttingedge.com/github/org/myproject/refresh
+```
+
+## Using Redis and other data stores
+
+CuttingEdge does not require persistence, as the data it uses (which dependencies does a project have, and are they up to date?) is refreshed periodically anyway. By default, this information is stored in memory. However, if you would like to store data in a different kind of data store (for instance Redis) that can be trivially accomplished. This may further decrease the amount of RAM CuttingEdge requires, and possibly improve performance.
+
+CuttingEdge uses [Moneta](https://github.com/moneta-rb/moneta) as an abstraction layer for its data store, so to change the data store can just do the following in `config.rb`:
+
+```ruby
+module CuttingEdge
+  STORE = Moneta.new(:Redis)
+end
+```
+
+See the [Moneta](https://github.com/moneta-rb/moneta) instructions.
+
+Note that Heroku offers a free [Redis Add-on](https://elements.heroku.com/addons/heroku-redis).
+
+## Contributing
+
+See [here](CONTRIBUTING.md).
+
 ## License
 
-This work is licensed under the terms of the [GNU GPLv3.0](LICENSE).
+This work is licensed under the terms of the [GNU Affero GPLv3.0](LICENSE). Copyright Dawa Ometto and Bart Kamphorst, 2020.