geo_monitor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9dfd57782846f5f060a3a1e2c036686653d71551
+  data.tar.gz: 6a1ed0c2c01bd0cc36213f0d5676f5bb098796b4
+SHA512:
+  metadata.gz: fee0dd08dedd152e716b4a6704841e57ee2babe4199e91f539f7ce358ac7add5d5941983a1dc6852ed5d1079abef2f0bca2dfae644e540c5d0b3c8f78ffad901
+  data.tar.gz: 604eb560be8f049ca89abdaa18b41f93182d8e6fdb2be9ddc6bb971e2723e2c2b03eabae1579178cbbb330f8b51552afccb894d81d10f5bf50cd8c9e14409f6c

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2017 The Board of Trustees of the Leland Stanford Junior University
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,28 @@
+# GeoMonitor
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'geo_monitor'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install geo_monitor
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [Apache License 2.0](https://opensource.org/licenses/Apache-2.0).

data/Rakefile

@@ -0,0 +1,30 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'bundler/gem_tasks'
+require 'engine_cart/rake_task'
+
+EngineCart.fingerprint_proc = EngineCart.rails_fingerprint_proc
+
+namespace :geomonitor do
+  desc 'Create the test rails app'
+  task generate: ['engine_cart:generate'] do
+  end
+end
+
+task ci: ['geomonitor:generate'] do
+  Rake::Task['spec'].invoke
+end
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: :ci
+rescue LoadError
+  # no rspec available
+end

data/app/assets/config/geo_monitor_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/geo_monitor .js
+//= link_directory ../stylesheets/geo_monitor .css

data/app/assets/javascripts/geo_monitor/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/geo_monitor/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/geo_monitor/application_controller.rb

@@ -0,0 +1,5 @@
+module GeoMonitor
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/geo_monitor/application_helper.rb

@@ -0,0 +1,4 @@
+module GeoMonitor
+  module ApplicationHelper
+  end
+end

data/app/jobs/geo_monitor/application_job.rb

@@ -0,0 +1,4 @@
+module GeoMonitor
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/geo_monitor/application_mailer.rb

@@ -0,0 +1,6 @@
+module GeoMonitor
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/geo_monitor/application_record.rb

@@ -0,0 +1,5 @@
+module GeoMonitor
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/geo_monitor/geo_monitor.rb

@@ -0,0 +1,7 @@
+module GeoMonitor
+  module GeoMonitor
+    def self.table_name_prefix
+      'geo_monitor_geo_monitor_'
+    end
+  end
+end

data/app/models/geo_monitor/layer.rb

@@ -0,0 +1,38 @@
+module GeoMonitor
+  class Layer < ApplicationRecord
+    has_many :statuses
+
+    ##
+    # @param [String] schema_json
+    def self.from_geoblacklight(schema_json)
+      schema = JSON.parse(schema_json)
+      references = JSON.parse(schema['dct_references_s'])
+      find_or_create_by(slug: schema['layer_slug_s']) do |layer|
+        layer.checktype = 'WMS'
+        layer.layername = schema['layer_id_s']
+        layer.bbox = schema['solr_geom']
+        layer.url = references['http://www.opengis.net/def/serviceType/ogc/wms']
+        layer.active = true
+      end
+    end
+
+    def bounding_box
+      w, e, n, s = bbox.delete('ENVELOPE(').delete(')').delete(' ').split(',')
+      GeoMonitor::BoundingBox.new(north: n, south: s, east: e, west: w)
+    end
+
+    def check
+      response = nil
+      time = Benchmark.measure do
+        response = GeoMonitor::Requests::WMS.new(
+          bbox: bounding_box, url: url, layers: layername
+        ).tile
+      end
+      GeoMonitor::Status.from_response(response, self, time.real.to_f)
+    end
+
+    def availability_score
+      statuses.where(res_code: '200').count.to_f / statuses.count
+    end
+  end
+end

data/app/models/geo_monitor/status.rb

@@ -0,0 +1,31 @@
+module GeoMonitor
+  class Status < ApplicationRecord
+    belongs_to :layer, counter_cache: true, touch: true
+    before_create :limit_by_layer
+
+    ##
+    # Limits the number of statuses per layer to prevent a ballooing database
+    def limit_by_layer
+      statuses_by_layer = self.class.where(layer: layer).count
+      max = GeoMonitor::Engine.config.max_status_per_layer
+      self.class
+          .where(layer: layer)
+          .last(statuses_by_layer - max + 1)
+          .map(&:destroy) if statuses_by_layer >= max
+    end
+
+    ##
+    # @param [Faraday::Resposne] response
+    # @param [GeoMonitor::Layer] layer
+    # @param [Float] time
+    def self.from_response(response, layer, time)
+      create(
+        res_time: time.to_f,
+        res_code: response.status,
+        submitted_query: response.env[:url].to_s,
+        layer: layer,
+        res_headers: response.headers
+      )
+    end
+  end
+end

data/app/views/layouts/geo_monitor/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Geo monitor</title>
+  <%= stylesheet_link_tag    "geo_monitor/application", media: "all" %>
+  <%= javascript_include_tag "geo_monitor/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+GeoMonitor::Engine.routes.draw do
+end

data/db/migrate/20171212180244_create_geo_monitor_layers.rb

@@ -0,0 +1,15 @@
+class CreateGeoMonitorLayers < ActiveRecord::Migration[5.1]
+  def change
+    create_table :geo_monitor_layers do |t|
+      t.string :slug, index: true, unique: true
+      t.string :checktype, index: true
+      t.string :layername
+      t.string :access, index: true
+      t.string :bbox
+      t.string :url
+      t.integer :statuses_count
+      t.boolean :active, index: true
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20171212181423_create_geo_monitor_statuses.rb

@@ -0,0 +1,12 @@
+class CreateGeoMonitorStatuses < ActiveRecord::Migration[5.1]
+  def change
+    create_table :geo_monitor_statuses do |t|
+      t.string :res_code, index: true
+      t.string :res_headers
+      t.decimal :res_time
+      t.text :submitted_query
+      t.references :layer, index: true
+      t.timestamps
+    end
+  end
+end

data/lib/generators/geo_monitor/install_generator.rb

@@ -0,0 +1,7 @@
+module GeoMonitor
+  ##
+  # GeoMonitor Installer
+  class Install < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+  end
+end

data/lib/geo_monitor.rb

@@ -0,0 +1,6 @@
+require "geo_monitor/engine"
+
+module GeoMonitor
+  # A simple structure to conform to Faraday::Response
+  FailedResponse = Struct.new(:env, :status, :headers)
+end

data/lib/geo_monitor/bounding_box.rb

@@ -0,0 +1,65 @@
+module GeoMonitor
+  ##
+  # Bounding Box
+  class BoundingBox
+    attr_reader :north, :south, :east, :west
+
+    def initialize(north:, south:, east:, west:)
+      @north = north.to_f
+      @south = south.to_f
+      @east = east.to_f
+      @west = west.to_f
+    end
+
+    def to_s
+      "#{west},#{south},#{east},#{north}"
+    end
+
+    ##
+    # Calculates the tilebounds for a tile within the existing bounds.
+    def tile_bounds
+      tile = tile_number
+      zoom = zoom_level
+      sw = GeoMonitor::LatLngPoint.from_number(tile[:x], tile[:y], zoom).to_3857
+      ne = GeoMonitor::LatLngPoint.from_number(tile[:x] + 1, tile[:y] - 1, zoom).to_3857
+      self.class.new(
+        north: ne.lat,
+        east: ne.lng,
+        south: sw.lat,
+        west: sw.lng
+      )
+    end
+
+    ##
+    # Calculates the "zoom level" that can best view the bounds.
+    # http://wiki.openstreetmap.org/wiki/Zoom_levels
+    def zoom_level
+      lat_diff = north - south
+      lng_diff = east - west
+      max_diff = [lat_diff, lng_diff].max
+
+      if max_diff < GeoMonitor::DEGREES_IN_CIRCLE / 2**20
+        zoom = 21
+      else
+        zoom = -1 * ((Math.log(max_diff) / Math.log(2)) - (Math.log(GeoMonitor::DEGREES_IN_CIRCLE) / Math.log(2)))
+        zoom = 1 if zoom < 1
+      end
+      zoom.ceil
+    end
+
+    ##
+    # See: http://wiki.openstreetmap.org/wiki/Slippy_map_tilenames#Lon..2Flat._to_tile_numbers_2
+    def tile_number
+      lat_rad = south / 180 * Math::PI
+      n = 2.0**zoom_level
+      x = ((west + 180.0) / GeoMonitor::DEGREES_IN_CIRCLE * n).to_i
+      y = ((1.0 - Math.log(Math.tan(lat_rad) + (1 / Math.cos(lat_rad))) / Math::PI) / 2.0 * n)
+      y = if y.infinite?.nil?
+            y.to_i
+          else
+            x
+          end
+      { x: x, y: y }
+    end
+  end
+end

data/lib/geo_monitor/engine.rb

@@ -0,0 +1,18 @@
+require 'rails/all'
+require 'faraday'
+require 'geo_monitor/bounding_box'
+require 'geo_monitor/lat_lng_point'
+require 'geo_monitor/requests/wms'
+
+module GeoMonitor
+  R = 6_378_137 # Radius of Earth in meters
+  DEGREES_IN_CIRCLE = 360.0
+
+  ##
+  # Top level Rails Engine class
+  class Engine < ::Rails::Engine
+    isolate_namespace GeoMonitor
+
+    GeoMonitor::Engine.config.max_status_per_layer = 5
+  end
+end

data/lib/geo_monitor/lat_lng_point.rb

@@ -0,0 +1,32 @@
+module GeoMonitor
+  class LatLngPoint
+    attr_accessor :lat, :lng
+    def initialize(lat: 0, lng: 0)
+      @lat = lat.to_f
+      @lng = lng.to_f
+    end
+
+    ##
+    # This needs better documentation, but projecting from EPSG:4326 to
+    # EPSG:3857
+    def to_3857
+      d = Math::PI / 180
+      max = 1 - 1E-15
+      sin = [[Math.sin(lng * d), max].min, -max].max
+      self.class.new(
+        lat: GeoMonitor::R * lat * d,
+        lng: GeoMonitor::R * Math.log((1 + sin) / (1 - sin)) / 2
+      )
+    end
+
+    # Get the lat/lng for a specific tile at a zoom level
+    # From http://wiki.openstreetmap.org/wiki/Slippy_map_tilenames#Pseudo-code
+    def self.from_number(xtile, ytile, zoom)
+      n = 2.0**zoom
+      lng = xtile / n * 360.0 - 180.0
+      lat_rad = Math.atan(Math.sinh(Math::PI * (1 - 2 * ytile / n)))
+      lat = 180.0 * (lat_rad / Math::PI)
+      new(lat: lat, lng: lng)
+    end
+  end
+end

data/lib/geo_monitor/requests/wms.rb

@@ -0,0 +1,58 @@
+module GeoMonitor
+  module Requests
+    ##
+    # Crafts a WMS request
+    class WMS
+      attr_reader :bbox, :url, :layers
+
+      def initialize(bbox:, url:, layers:)
+        @bbox = bbox
+        @url = url
+        @layers = layers
+      end
+
+      ##
+      # Parameters used for the WMS request.
+      def request_params
+        {
+          'SERVICE' => 'WMS',
+          'VERSION' => '1.1.1',
+          'REQUEST' => 'GetMap',
+          'LAYERS' => layers,
+          'STYLES' => '',
+          'CRS' => 'EPSG:900913',
+          'SRS' => 'EPSG:3857',
+          'BBOX' => bbox.tile_bounds.to_s,
+          'WIDTH' => '256',
+          'HEIGHT' => '256',
+          'FORMAT' => 'image/png',
+          'TILED' => true
+        }
+      end
+
+      ##
+      # Request the tile.
+      def tile
+        unless url.present?
+          return GeoMonitor::FailedResponse.new(
+            { url: url }, 'No URL provided', {}
+          )
+        end
+        conn = Faraday.new(url: url)
+        begin
+          conn.get do |request|
+            request.params = request_params
+            request.options.timeout = 10
+            request.options.open_timeout = 10
+          end
+        rescue Faraday::ConnectionFailed, Faraday::TimeoutError => e
+          GeoMonitor::FailedResponse.new(
+            { url: conn.url_prefix.to_s },
+            e.class,
+            nil
+          )
+        end
+      end
+    end
+  end
+end

data/lib/geo_monitor/version.rb

@@ -0,0 +1,3 @@
+module GeoMonitor
+  VERSION = '0.1.0'
+end

data/lib/tasks/geo_monitor_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :geo_monitor do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: geo_monitor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jack Reed
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: engine_cart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Rails engine for monitoring geo webservices
+email:
+- phillipjreed@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/config/geo_monitor_manifest.js
+- app/assets/javascripts/geo_monitor/application.js
+- app/assets/stylesheets/geo_monitor/application.css
+- app/controllers/geo_monitor/application_controller.rb
+- app/helpers/geo_monitor/application_helper.rb
+- app/jobs/geo_monitor/application_job.rb
+- app/mailers/geo_monitor/application_mailer.rb
+- app/models/geo_monitor/application_record.rb
+- app/models/geo_monitor/geo_monitor.rb
+- app/models/geo_monitor/layer.rb
+- app/models/geo_monitor/status.rb
+- app/views/layouts/geo_monitor/application.html.erb
+- config/routes.rb
+- db/migrate/20171212180244_create_geo_monitor_layers.rb
+- db/migrate/20171212181423_create_geo_monitor_statuses.rb
+- lib/generators/geo_monitor/install_generator.rb
+- lib/geo_monitor.rb
+- lib/geo_monitor/bounding_box.rb
+- lib/geo_monitor/engine.rb
+- lib/geo_monitor/lat_lng_point.rb
+- lib/geo_monitor/requests/wms.rb
+- lib/geo_monitor/version.rb
+- lib/tasks/geo_monitor_tasks.rake
+homepage: https://github.com/geoblacklight/geo_monitor
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: A Rails engine for monitoring geo webservices
+test_files: []