cutting_edge 0.0.1 → 0.1

data/Rakefile

@@ -55,11 +55,6 @@ def gemspec_file
   "#{name}.gemspec"
 end
 
-desc "Build the gem file."
-task :build do
-  system "gem build gollum_git_adapter_specs.gemspec"
-end
-
 def gem_file
   "#{name}-#{version}.gem"
 end

data/bin/cutting_edge

@@ -1,72 +1,87 @@
 #!/usr/bin/env ruby
 
-require File.expand_path('../../lib/cutting_edge/app.rb', __FILE__)
 require 'yaml'
 require 'rufus-scheduler'
+require 'optparse'
+require 'semantic_logger'
 
-config = <<YAML
-github:
-  gollum:
-    gollum:
-      api_token: secret
-    gollum-lib:
-      api_token: secret
-      locations: [gemspec.rb]
-      dependency_types: [runtime, development]
-  singingwolfboy:
-    flask-dance:
-      language: python
-  rust-lang:
-    crates.io:
-      language: rust
-      api_token: secret
-gitlab:
-  cthowl01:
-    team-chess-ruby:
-      api_token: secret
-YAML
+module CuttingEdge
+  REFRESH_SCHEDULE = '1h'
+end
 
 options = {
   :port => 4567,
-  :bind => '0.0.0.0',
+  :bind => '0.0.0.0'
 }
 
-store = Moneta.new(:Memory)
-
-repositories = {}
-YAML.load(config).each do |source, orgs|
-  orgs.each do |org, value|
-    value.each do |name, settings|
-      cfg = settings.is_a?(Hash) ? settings : {}
-      repo = Object.const_get("CuttingEdge::#{source.capitalize}Repository").new(org, name, cfg.fetch('language', nil), cfg.fetch('locations', nil), cfg.fetch('branch', nil), cfg.fetch('api_token', nil))
-      repo.dependency_types = cfg['dependency_types'].map {|dep| dep.to_sym} if cfg['dependency_types'].is_a?(Array)
-      repositories["#{source}/#{org}/#{name}"] = repo
+opts = OptionParser.new do |opts|
+  opts.banner = 'CuttingEdge is a dependency monitoring application.
+  
+  Usage:
+      cutting_edge [options] [projects]
+      
+  Arguments:
+      [projects]                     Path to the YAML file which defines the projects to be monitored. If not specified, projects.yml in the current working directory is used.
+'
+  opts.separator ''
+  
+  opts.on('-h', '--host [HOST]', 'Specify the hostname or IP address to listen on. Default: \'0.0.0.0\'.') do |host|
+    options[:bind] = host
+  end
+  
+  opts.on('-p', '--port [PORT]', 'Specify the port to bind to. Default: \'4567\'.') do |port|
+    begin
+      # don't use 'port.to_i' here... it doesn't raise errors which might result in a nice confusion later on
+      options[:port] = Integer(port)
+    rescue ArgumentError
+      puts "Error: '#{port}' is not a valid port number."
+      exit 1
     end
   end
+  
+  opts.on('-c', '--config [FILE]', 'Specify path to a .rb configuration file. Default: config.rb') do |file|
+    options[:config] = file || 'config.rb'
+  end
+end
+
+begin
+  opts.parse!
+rescue OptionParser::InvalidOption => e
+  puts "cutting_edge: #{e.message}"
+  puts 'cutting_edge: try \'cutting_edge --help\' for more information'
+  exit
+end
+
+if cfg = options[:config]
+  # If the path begins with a '/' it will be considered an absolute path,
+  # otherwise it will be relative to the CWD
+  cfg = File.join(Dir.getwd, cfg) unless cfg.slice(0) == File::SEPARATOR
+  require cfg
 end
 
+# Only require the app after loading the optional config file, to give user the chance to define constants.
+require File.expand_path('../../lib/cutting_edge/app.rb', __FILE__)
+
+include CuttingEdgeHelpers
+repositories = load_repositories(ARGV[0] || 'projects.yml')
+repositories.merge!(CuttingEdge::REPOSITORIES) if defined?(CuttingEdge::REPOSITORIES)
+
+CuttingEdge::STORE = Moneta.new(:Memory) unless defined?(CuttingEdge::STORE)
+CuttingEdge::App.set(:store, CuttingEdge::STORE)
+
 # Need to initialize the log like this once, because otherwise it only becomes available after the Sinatra app has received a request...
 ::SemanticLogger.add_appender(file_name: "#{CuttingEdge::App.environment}.log")
 
 CuttingEdge::App.set(:repositories, repositories)
-CuttingEdge::App.set(:store, store)
 CuttingEdge::App.set(:enable_logging, true)
 
-puts "Scheduling Jobs..."
+puts 'Scheduling Jobs...'
 scheduler = Rufus::Scheduler.new
-scheduler.every('1h') do
+scheduler.every(CuttingEdge::REFRESH_SCHEDULE) do
   worker_fetch_all(repositories.values)
 end
-scheduler.every('1h5m') do
-  worker_all_badges(repositories.values)
-end
 
-puts "Running Workers a first time..."
-include CuttingEdgeHelpers
+puts 'Running Workers a first time...'
 worker_fetch_all(repositories.values)
 
-sleep 5
-worker_all_badges(repositories.values)
-
-puts "Starting Sinatra..."
 CuttingEdge::App.run!(options)

data/config.rb

@@ -0,0 +1,55 @@
+# Example config.rb for CuttingEdge
+# All the settings below are purely optional: they all have sane defaults.  
+
+# Configure mail server settings (outside the CuttingEdge module)
+require 'mail'
+Mail.defaults do
+  delivery_method :smtp, address: 'localhost', port: 25
+end
+
+module CuttingEdge
+  REFRESH_SCHEDULE = '1h'  # How often to run workers to check for changes to dependency status. Examples of valid values: '10d', '10m', etc.
+  SERVER_HOST = 'mydependencymonitoring.com' # At what domain is this CuttingEdge instance running? Defaults to 'localhost'
+  SERVER_URL = "https://#{SERVER_HOST}:4567" # The URL used to refer to this CuttingEdge instance, for instance in e-mails. Defaults to 'http://#{SERVER_HOST}' 
+
+  MAIL_TO = 'mydeps@mymail.com'  # Default address to send email to. If set to false (=default!), don't send any e-mails except for repositories that have their 'email:' attribute set in projects.yml
+  MAIL_FROM = "cutting_edge@#{SERVER_HOST}" # From Address used for sending e-mails. Default: "cutting_edge@#{SERVER_HOST}" 
+  MAIL_TEMPLATE = <<EOF
+    Define your own ERB template for e-mail updates from CuttingEdge here!
+    Of course, you can also File.read it from a separate template file.
+    See lib/cutting_edge/templates/mail.html.erb for the default template, and the available variables.
+EOF
+
+  SECRET_TOKEN = 'mysecrettoken' # Global administrative secret
+
+  LAST_VERSION_TIMEOUT = 5 # Number of seconds after which to fail when trying to determine the latest version for a dependency.
+
+  BADGE_COLORS = {
+   ok: 'blue',
+   outdated_patch: '#dfb317',
+   outdated_minor: '#fe7d37',
+   outdated_major: '#e05d44',
+   unknown: '#9f9f9f'
+  } # Redefine the colors used in SVG badges
+
+# The following will allow you to define projects on your own GitLab or Gitea server in projects.yml
+# This will allow you to use the 'mygitlab' and 'mygitea' keys, respectively, in projects.yml
+  require './lib/cutting_edge/repo.rb'
+  define_gitlab_server('mygitlab', 'https://mygitlab.com')
+  define_gitea_server('mygitea', 'https://mygitea.com')
+  # Now you may use your own server instance in projects.yml like so:
+  # mygitlab:
+  #   orgname:
+  #     projectname:
+  #       language: rust
+  #     ruby_project:
+  #       language ruby
+
+# You may also define additional repositories programatically as follows.
+# These will be added to the repositories defined in projects.yml.
+# This may be useful, for instance, if you want to use environment variables to keep information secret.
+# Note: you need to require './lib/cutting_edge/repo.rb' first
+  REPOSITORIES = {
+    "gitlab/#{ENV['PRIVATE_REPO1_ORG']}/#{ENV['PRIVATE_REPO1_NAME']}" => GitlabRepository.new(org: ENV['PRIVATE_REPO1_ORG'], name: ENV['PRIVATE_REPO1_NAME'], lang: 'python', auth_token: ENV['PRIVATE_REPO1_TOKEN'], hide: true)
+  }
+end

data/cutting_edge.gemspec

@@ -5,8 +5,8 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.4'
 
   s.name              = 'cutting_edge'
-  s.version           = '0.0.1'
-  s.date              = '2020-02-19'
+  s.version           = '0.1'
+  s.date              = '2020-11-02'
   s.license           = 'GPL-3.0-only'
 
   s.summary     = 'Self-hosted dependency monitoring, including shiny badges.'
@@ -25,32 +25,61 @@ Gem::Specification.new do |s|
   s.add_dependency 'sucker_punch', '~> 2.1'
   s.add_dependency 'sinatra', '~> 2.0'
   s.add_dependency 'moneta', '~> 1.2'
-  s.add_dependency 'victor', '~> 0.2.8'
   s.add_dependency 'rufus-scheduler', '~> 3.6'
   s.add_dependency 'sinatra-logger', '~> 0.3'
   s.add_dependency 'toml-rb', '~> 2.0'
+  s.add_dependency 'mail', '~> 2.7'
+  
   # = MANIFEST =
   s.files = %w[
     Gemfile
+    Gemfile.lock
     LICENSE
+    Procfile
     README.md
     Rakefile
     bin/cutting_edge
+    config.rb
     cutting_edge.gemspec
+    heroku.config.rb
     lib/cutting_edge.rb
     lib/cutting_edge/app.rb
-    lib/cutting_edge/badge.rb
     lib/cutting_edge/langs.rb
     lib/cutting_edge/langs/python.rb
     lib/cutting_edge/langs/ruby.rb
     lib/cutting_edge/langs/rust.rb
+    lib/cutting_edge/public/images/error.svg
+    lib/cutting_edge/public/images/languages/python.svg
+    lib/cutting_edge/public/images/languages/ruby.svg
+    lib/cutting_edge/public/images/languages/rust.svg
+    lib/cutting_edge/public/images/ok.svg
+    lib/cutting_edge/public/javascript/clipboard.min.js
+    lib/cutting_edge/public/javascript/cuttingedge.js
+    lib/cutting_edge/public/stylesheets/primer.css
     lib/cutting_edge/repo.rb
+    lib/cutting_edge/templates/_footer.html.erb
+    lib/cutting_edge/templates/_header.html.erb
+    lib/cutting_edge/templates/_overview.html.erb
+    lib/cutting_edge/templates/badge.svg.erb
+    lib/cutting_edge/templates/index.html.erb
+    lib/cutting_edge/templates/info.html.erb
+    lib/cutting_edge/templates/mail.html.erb
     lib/cutting_edge/versions.rb
     lib/cutting_edge/workers/badge.rb
     lib/cutting_edge/workers/dependency.rb
     lib/cutting_edge/workers/helpers.rb
+    lib/cutting_edge/workers/mail.rb
+    projects.yml
+    spec/app_spec.rb
+    spec/badge_worker_spec.rb
+    spec/dependency_worker_spec.rb
+    spec/email_worker_spec.rb
+    spec/fixtures.rb
+    spec/fixtures/projects.yml
     spec/langs/python_spec.rb
+    spec/langs/ruby_spec.rb
     spec/langs/rust_spec.rb
+    spec/repo_spec.rb
     spec/spec_helper.rb
   ]
   # = MANIFEST =

data/heroku.config.rb

@@ -0,0 +1,20 @@
+# Default settings required for Heroku deployment
+
+module CuttingEdge
+  SERVER_HOST = "#{ENV['HEROKU_APP_NAME']}.herokuapp.com" # At what domain is this CuttingEdge instance running?
+  SERVER_URL = "https://#{SERVER_HOST}"
+  MAIL_TO = ENV['CUTTING_EDGE_MAIL_TO'] if ENV['CUTTING_EDGE_MAIL_TO']
+  
+  # Your additional configuration goes here.
+  # If you are going to host the repository containing this file publically (e.g. on GitHub), please read:
+  # https://github.com/repotag/cutting_edge/blob/master/README.md#Defining-repositories-in-configrb
+end
+
+# Needed to write to Heroku logs.
+::SemanticLogger.add_appender(io: $stderr)
+
+# Configure mail server settings
+require 'mail'
+Mail.defaults do
+  delivery_method :smtp, address: ENV['MAILGUN_SMTP_SERVER'], port: ENV['MAILGUN_SMTP_PORT'], user_name: ENV['MAILGUN_SMTP_LOGIN'], password: ENV['MAILGUN_SMTP_PASSWORD'], domain: CuttingEdge::SERVER_HOST
+end

data/lib/cutting_edge.rb

@@ -1,3 +1,3 @@
 module CuttingEdge
-  VERSION = '0.0.1'
+  VERSION = '0.1'
 end

data/lib/cutting_edge/app.rb

@@ -9,18 +9,10 @@ require File.expand_path('../../cutting_edge.rb', __FILE__)
 require File.expand_path('../repo.rb', __FILE__)
 require File.expand_path('../workers/dependency.rb', __FILE__)
 require File.expand_path('../workers/badge.rb', __FILE__)
+require File.expand_path('../workers/mail.rb', __FILE__)
 
 module CuttingEdgeHelpers
-  def worker_all_badges(repositories)
-    repositories.each do |repo|
-      worker_generate_badge(repo)
-    end
-  end
-
-  def worker_generate_badge(repo)
-    BadgeWorker.perform_async(repo.identifier)
-  end
-
+  
   def worker_fetch_all(repositories)
     repositories.each do |repo|
       worker_fetch(repo)
@@ -28,38 +20,110 @@ module CuttingEdgeHelpers
   end
 
   def worker_fetch(repo)
-    DependencyWorker.perform_async(repo.identifier, repo.lang, repo.locations, repo.dependency_types)
+    DependencyWorker.perform_async(repo.identifier, repo.lang, repo.locations, repo.dependency_types, repo.contact_email, repo.auth_token)
+  end
+  
+  def load_repositories(path)
+    repositories = {}
+    begin
+      YAML.load(File.read(path)).each do |source, orgs|
+        orgs.each do |org, value|
+          value.each do |name, settings|
+            cfg = settings.is_a?(Hash) ? settings : {}
+            repo = Object.const_get("CuttingEdge::#{source.capitalize}Repository").new(org: org, name: name, lang: cfg.fetch('language', nil), locations: cfg.fetch('locations', nil), branch: cfg.fetch('branch', nil), email: cfg.fetch('email', CuttingEdge::MAIL_TO), auth_token: cfg.fetch('auth_token', nil), hide: cfg.fetch('hide', false))
+            repo.dependency_types = cfg['dependency_types'].map {|dep| dep.to_sym} if cfg['dependency_types'].is_a?(Array)
+            repositories["#{source}/#{org}/#{name}"] = repo
+          end
+        end
+      end
+    rescue SyntaxError, Errno::ENOENT => e
+      puts "Error: #{path} does not contain a valid YAML project definition."
+      if ENV['RACK_ENV'] == 'test'
+        return nil
+      else
+        exit 1
+      end
+    end
+    repositories
   end
 end
 
-
 module CuttingEdge
-   LAST_VERSION_TIMEOUT = 5
   
+  LAST_VERSION_TIMEOUT = 5
+  SERVER_HOST = 'localhost' unless defined?(SERVER_HOST)
+  SERVER_URL = "http://#{SERVER_HOST}" unless defined?(SERVER_URL)
+  MAIL_TO = false unless defined?(MAIL_TO) # Default address to send email to. If set to false, don't send any e-mails except for repositories that have their 'email' attribute set.
+  MAIL_FROM = "cutting_edge@#{SERVER_HOST}" unless defined?(MAIL_FROM)
+   
   class App < Sinatra::Base
     include CuttingEdgeHelpers
 
+    set :views, ::File.join(::File.dirname(__FILE__), 'templates')
+    Tilt.register Tilt::ERBTemplate, 'html.erb'
+    set :public_folder, ::File.join(::File.dirname(__FILE__), 'public')
     logger filename: "#{settings.environment}.log", level: :trace
 
     before do
       @store = settings.store
     end
 
-    get %r{/(.+)/(.+)/(.+)/info} do |source, org, name|
+    get '/' do
+      hidden_repos, public_repos = CuttingEdge::App.repositories.partition{|_, repo| repo.hidden?}.map(&:to_h)
+      @hidden_repos_exist = !hidden_repos.empty?
+      @repos = public_repos
+      erb :index
+    end
+
+    post '/hidden_repos' do
+      payload = JSON.parse(request.body.read)
+      if valid_token?(payload['token'])
+        @repos = CuttingEdge::App.repositories.select{|_, repo| repo.hidden?}
+        partial = Tilt::ERBTemplate.new(::File.join(CuttingEdge::App.views, '_overview.html.erb'))
+        {partial: partial.render(self)}.to_json
+      else
+        status 401
+      end
+         
+    end
+
+    get %r{/(.+)/(.+)/(.+)/info/json} do |source, org, name|
       repo_defined?(source, org, name)
+      validate_repo_token(params[:token]) if @repo.hidden?
       content_type :json
-      @store[@repo.identifier].merge({:language => @repo.lang}).to_json # Todo: check whether value exists yet? If not, call worker / wait / timeout?
+      data = @store[@repo.identifier]
+      if data
+        data.merge({:language => @repo.lang}).to_json
+      else
+        status 500
+      end
+    end
+
+    get %r{/(.+)/(.+)/(.+)/info} do |source, org, name|
+      repo_defined?(source, org, name)
+      validate_repo_token(params[:token]) if @repo.hidden?
+      @name = name
+      @svg = url("/#{source}/#{org}/#{name}/svg")
+      @svg = "#{@svg}?token=#{@repo.hidden_token}" if @repo.hidden?
+      @md = "[![Cutting Edge Dependency Status](#{@svg} 'Cutting Edge Dependency Status')](#{url("/#{source}/#{org}/#{name}/info")})"
+      @colors = {ok: 'green', outdated_patch: 'yellow', outdated_minor: 'orange', outdated_major: 'red', unknown: 'gray'}
+      @specs = @store[@repo.identifier]
+      @project_url = @repo.url_for_project
+      @language = @repo.lang
+      erb :info
     end
 
     get %r{/(.+)/(.+)/(.+)/svg} do |source, org, name|
       repo_defined?(source, org, name)
+      validate_repo_token(params[:token]) if @repo.hidden?
+      cache_control no_cache: true
       content_type 'image/svg+xml'
       @store["svg-#{@repo.identifier}"]
     end
 
     post %r{/(.+)/(.+)/(.+)/refresh} do |source, org, name|
       repo_defined?(source, org, name)
-      if @repo.token && params[:token] == @repo.token
+      if valid_token?(params[:token])
         worker_fetch(@repo)
         status 200
       else
@@ -68,10 +132,22 @@ module CuttingEdge
     end
 
     private
-
+    
+    def not_found
+      halt 404, '404 Not Found'
+    end
+    
+    def valid_token?(token)
+      defined?(::CuttingEdge::SECRET_TOKEN) && token == ::CuttingEdge::SECRET_TOKEN
+    end
+    
+    def validate_repo_token(token)
+      not_found unless token == @repo.hidden_token
+    end
+    
     def repo_defined?(source, org, name)
-      halt 404, '404 Not Found' unless @repo = settings.repositories["#{source}/#{org}/#{name}"]
+      not_found unless @repo = settings.repositories["#{source}/#{org}/#{name}"]
     end
-
+    
   end
 end