orb_def 0.0.1

data/app/models/orb_def/weather_station.rb

@@ -0,0 +1,33 @@
+module OrbDef
+  class WeatherStation < ApplicationRecord
+    acts_as_mappable :default_units => :kms,
+                     :default_formula => :sphere,
+                     :lat_column_name => :latitude,
+                     :lng_column_name => :longitude
+
+    has_many :weather_readings, dependent: :destroy
+    has_many :fires
+
+    validates :identifier, uniqueness: true
+
+    class << self
+      def find_or_create(reading_json)
+        identifier = "#{reading_json['name']}:AUS"
+        weather_station = WeatherStation.find_by(identifier: identifier)
+
+        return weather_station if weather_station.present?
+
+        WeatherStation.create(
+          identifier: identifier,
+          name: reading_json['name'],
+          latitude: reading_json['coord']['lat'],
+          longitude: reading_json['coord']['lon']
+        )
+      end
+    end
+
+    def latest_weather_reading
+      self.weather_readings.last
+    end
+  end
+end

data/app/serializers/orb_def/api/v1/fire_serializer.rb

@@ -0,0 +1,17 @@
+module OrbDef
+  class Api::V1::FireSerializer < ActiveModel::Serializer
+    attributes :id, :scan_type, :detected_at, :confidence, :latitude, :longitude, :weather_reading_id, :weather_station_id
+
+    def id
+      object.id.to_s
+    end
+
+    def weather_reading_id
+      object.weather_reading_id.to_s
+    end
+
+    def weather_station_id
+      object.weather_station_id.to_s
+    end
+  end
+end

data/app/services/orb_def/fire_weather_data.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module OrbDef
+  class FireWeatherData
+    attr_reader :fire
+
+    def initialize(fire)
+      @fire = fire
+    end
+
+    def find_or_create_weather
+      weather_station = WeatherStation.within(10, origin: [fire.latitude, fire.longitude]).first
+
+      if weather_station.present? && weather_reading_within_limits?(weather_station)
+        return weather_station, weather_station.weather_readings.last
+      else
+        create_station_and_reading
+      end
+    end
+
+    def create_station_and_reading
+      reading_json = OpenWeatherApi::WeatherByCoordinates.fetch(latitude: fire.latitude, longitude: fire.longitude)
+
+      return unless reading_json
+
+      weather_station = WeatherStation.find_or_create(reading_json)
+      weather_reading = WeatherReading.find_or_create_by_reading(reading_json, weather_station.id)
+
+      return weather_station, weather_reading
+    end
+
+    def weather_reading_within_limits?(weather_station)
+      weather_station.weather_readings&.last.reading_at.between?(fire.detected_at - 30.minutes, fire.detected_at + 30.minutes)
+    end
+  end
+end

data/app/services/orb_def/nasa/firms_client.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+module OrbDef
+  module Nasa
+    class RemoteServerError < StandardError; end
+
+    class FirmsClient
+      class << self
+        def fetch(url, date: julian_date)
+          Rails.logger.info('Nasa::FirmsClient#fetch - Started')
+
+          response = client.get do |req|
+            req.url "#{url}#{date}.txt"
+            req.headers['Authorization'] = "Bearer #{OrbDef.nasa_api_key}"
+          end
+
+          if response.success?
+            Rails.logger.info('Nasa::FirmsClient#fetch - Completed')
+            response.body
+          else
+            Rails.logger.error("Nasa::FirmsClient#fetch - Failed: #{response.status} #{response.body} - #{url}#{julian_date}")
+            raise RemoteServerError
+          end
+        end
+
+        private
+
+        def julian_date
+          @julian_date ||= "#{Date.today.year}#{"%.3d" % Date.today.yday}".to_i
+        end
+
+        def client
+          @client ||= Faraday.new(url: 'https://nrt4.modaps.eosdis.nasa.gov')
+        end
+      end
+    end
+  end
+end
+

data/app/services/orb_def/nasa/firms_import.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+module OrbDef
+  module Nasa
+    class FirmsImport
+      require 'csv'
+
+      FIRMS_DATA_URLS = {
+          # modis: '/api/v2/content/archives/FIRMS/c6/Australia_NewZealand/MODIS_C6_Australia_NewZealand_MCD14DL_NRT_',
+          # virrs: '/api/v2/content/archives/FIRMS/viirs/Australia_NewZealand/VIIRS_I_Australia_NewZealand_VNP14IMGTDL_NRT_'
+          modis: '/api/v2/content/archives/FIRMS/c6/Global/MODIS_C6_Global_MCD14DL_NRT_',
+          virrs: '/api/v2/content/archives/FIRMS/viirs/Global/VIIRS_I_Global_VNP14IMGTDL_NRT_'
+          #modis: '/api/v2/content/archives/FIRMS/c6/Southern_Africa/MODIS_C6_Southern_Africa_MCD14DL_NRT_',
+          #viirs: '/api/v2/content/archives/FIRMS/viirs/Southern_Africa/VIIRS_I_Southern_Africa_VNP14IMGTDL_NRT_'
+      }
+
+      class << self
+        def all
+          FIRMS_DATA_URLS.each do |key, url|
+            csv_text = Nasa::FirmsClient.fetch(url)
+            parse_and_create_fire(csv_text: csv_text, scan_type: key)
+
+          rescue Nasa::RemoteServerError
+            Rails.logger.error("Nasa::FirmsImport#all - Failed to fetch #{key}")
+          end
+        end
+
+        def file(file:, scan_type:)
+          parse_and_create(
+            csv_text: File.read(Rails.root.join('external_data', file)),
+            scan_type: scan_type
+          )
+        end
+
+        private
+
+        def parse_and_create_fire(csv_text:, scan_type:)
+          CSV.parse(csv_text, :headers => true, :encoding => 'ISO-8859-1').each do |row|
+            Fire.create_from_csv_row(row, scan_type)
+          end
+        end
+      end
+    end
+  end
+end

data/app/services/orb_def/open_weather_api/weather_by_coordinates.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+module OrbDef
+  module OpenWeatherApi
+    class WeatherByCoordinates
+      API_THROTTLE_TIME = (ENV['API_THROTTLE_TIME'] || 0.02).freeze
+
+      class << self
+        def fetch(latitude:, longitude:)
+          response = open_weather_client.get do |req|
+            req.url "/data/2.5/weather?lat=#{latitude}&lon=#{longitude}&appid=#{open_weather_key}"
+          end
+
+          sleep API_THROTTLE_TIME
+
+          JSON.parse(response.body) if response.success?
+        end
+
+        private
+
+        def open_weather_client
+          @open_weather_client ||= Faraday.new(url: 'http://api.openweathermap.org')
+        end
+
+        def open_weather_key
+          @open_weather_key ||= OrbDef.open_weather_api_key
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Orbital defence engine</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "orb_def/application", media: "all" %>
+  <%= javascript_include_tag "orb_def/application" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/bin/rails

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/orb_def/engine', __dir__)
+APP_PATH = File.expand_path('../spec/dummy/config/application', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+require "active_job/railtie"
+require "active_record/railtie"
+require "active_storage/engine"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "action_cable/engine"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+require 'rails/engine/commands'

data/config/routes.rb

@@ -0,0 +1,13 @@
+OrbDef::Engine.routes.draw do
+  namespace :api do
+    namespace :v1 do
+      resources :fires, only: :index do
+        collection do
+          get '/windIndicators', to: 'fires#fires_current_wind_direction_indicator'
+          get '/search',  to: 'fires#search'
+        end
+      end
+      resources :weather_readings, only: :show
+    end
+  end
+end

data/db/migrate/20200422073925_create_orb_def_weather_stations.rb

@@ -0,0 +1,12 @@
+class CreateOrbDefWeatherStations < ActiveRecord::Migration[5.2]
+  def change
+    create_table :orb_def_weather_stations do |t|
+      t.string :name
+      t.float :latitude
+      t.float :longitude
+      t.string :identifier, index: true, uniqueness: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200422073938_create_orb_def_weather_readings.rb

@@ -0,0 +1,20 @@
+class CreateOrbDefWeatherReadings < ActiveRecord::Migration[5.2]
+  def change
+    create_table :orb_def_weather_readings do |t|
+      t.belongs_to :weather_station, index: true
+      t.string :identifier, index: true, uniqueness: true
+      t.float :temperature
+      t.float :pressure
+      t.float :ground_level
+      t.integer :humidity
+      t.float :wind_speed
+      t.float :wind_direction
+      t.float :rain
+      t.integer :cloud
+      t.string :description
+      t.datetime :reading_at
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200423064313_create_orb_def_detection_types.rb

@@ -0,0 +1,9 @@
+class CreateOrbDefDetectionTypes < ActiveRecord::Migration[5.2]
+  def change
+    create_table :orb_def_detection_types do |t|
+      t.string :name
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200428063630_create_orb_def_fires.rb

@@ -0,0 +1,28 @@
+class CreateOrbDefFires < ActiveRecord::Migration[5.2]
+  def change
+    create_table :orb_def_fires do |t|
+      t.belongs_to :weather_station, index: true
+      t.belongs_to :detected_at_weather_reading, limit: 8, index: true
+      t.belongs_to :detection_type
+      t.float :latitude, precision: 10, scale: 6, index: true
+      t.float :longitude, precision: 10, scale: 6, index: true
+      t.float   :brightness
+      t.float   :bright_t31
+      t.float   :bright_ti5
+      t.float   :bright_ti4
+      t.float   :scan
+      t.float   :track
+      t.float   :frp
+      t.integer :distance
+      t.string  :scan_type
+      t.string  :identifier, index: true, uniqueness: true
+      t.string  :lat_long, index: true, uniqueness: false
+      t.string  :satellite
+      t.string  :confidence
+      t.string  :version
+      t.string  :day_night
+      t.timestamp :detected_at, index: true, uniqueness: false
+      t.timestamps
+    end
+  end
+end

data/db/seeds.rb

@@ -0,0 +1,8 @@
+[
+  { name: "Satellite" },
+  { name: "User" },
+].each do |detection_type_attributes|
+  unless OrbDef::DetectionType.exists?(name: detection_type_attributes[:name])
+    OrbDef::DetectionType.create!(detection_type_attributes)
+  end
+end

data/lib/orb_def/engine.rb

@@ -0,0 +1,16 @@
+module OrbDef
+  class Engine < ::Rails::Engine
+    isolate_namespace OrbDef
+
+    require 'pagy'
+    require 'active_model_serializers'
+    require 'geokit-rails'
+    require 'faraday'
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_bot #newly added code
+      g.factory_bot dir: 'spec/factories' #newly added code
+    end
+  end
+end

data/lib/orb_def/version.rb

@@ -0,0 +1,3 @@
+module OrbDef
+  VERSION = '0.0.1'
+end

data/lib/orb_def.rb

@@ -0,0 +1,16 @@
+require "orb_def/engine"
+
+module OrbDef
+  class << self
+    mattr_accessor :nasa_api_key, :open_weather_api_key
+    self.nasa_api_key = "NASA API KEY"
+    self.open_weather_api_key = "OPEN WEATHER API API KEY"
+
+    # add default values of more config vars here
+  end
+
+  # this function maps the vars from your app into your engine
+  def self.setup(&block)
+    yield self
+  end
+end

data/lib/tasks/orb_def_tasks.rake

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

data/orb_def.gemspec

@@ -0,0 +1,38 @@
+$:.push File.expand_path("lib", __dir__)
+
+# Maintain your gem's version:
+require "orb_def/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |spec|
+  spec.name        = "orb_def"
+  spec.version     = OrbDef::VERSION
+  spec.authors     = ["James Gascoigne-Taylor"]
+  spec.email       = ["james@flippakitten.com"]
+  spec.homepage    = "https://github.com/flippakitten/orbital_defence_engine"
+  spec.summary     = "Fire and weather data you can query by geolocation"
+  spec.description = "Uses Nasa FIRMS data and OpenWeatherApi data"
+  spec.license     = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.test_files = Dir["spec/**/*"]
+
+  spec.add_dependency 'rails', '~> 5.2.4', '>= 5.2.4.2'
+  spec.add_dependency 'pagy', '~> 3.7', '>= 3.7.5'
+  spec.add_dependency 'geokit-rails', '~> 2.3', '>= 2.3.1'
+  spec.add_dependency 'faraday', '~> 0.15.3'
+  spec.add_dependency 'active_model_serializers'
+
+  spec.add_development_dependency 'pg'
+  spec.add_development_dependency 'rspec-rails', '~> 3.9.0'
+  spec.add_development_dependency 'rspec_junit_formatter'
+  spec.add_development_dependency 'factory_bot_rails', '>= 5.1.1'
+  spec.add_development_dependency 'shoulda-matchers', '~> 3.1'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'rspec-sidekiq'
+  spec.add_development_dependency 'timecop', '~> 0.9.1'
+end

data/spec/controllers/orb_def/api/v1/fires_controller_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe OrbDef::Api::V1::FiresController, type: :controller do
+  #before(:all) do
+  #end
+
+  describe 'GET index' do
+    # let(:csv_text) {File.read(Rails.root.join('spec/fixtures/nasa/firms', 'virrs.txt')) }
+
+    it 'does something' do
+      expect(true).to be_truthy
+    end
+  end
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,4 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link orb_def_manifest.js

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// 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 rails-ujs
+//= require activestorage
+//= require_tree .

data/spec/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/dummy/app/assets/stylesheets/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/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy/app/mailers/application_mailer.rb

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

data/spec/dummy/app/models/application_record.rb

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

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end