weather_gov 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3695a2a5f281cfa4a459a22001806ada54204d5de7bfb0f175a7bed7cd36808a
+  data.tar.gz: 7daddbe58419911e0ecb0bdc79796fc4ef728773ec8aca5557bd06e6f059c1f1
+SHA512:
+  metadata.gz: a45fc78d81da76809428d727d27e26dfcd9336f7dd132fd7fb7a5d2f0b0da11aa8b50f614fcbc668ea96aa6d2aa585d48d1829dc82868ab9b4bcbea93c92e82e
+  data.tar.gz: 77220225658632bff07594a49b65a790f1082f5cff7f931ff8eeed397f9aba0cc2226eb7df1ca12c4dd3e319123796cca4114a82d861d2dce74a81e4185bd202

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "13:00"
+  open-pull-requests-limit: 10

data/.github/workflows/rspec.yml

@@ -0,0 +1,23 @@
+name: rspec
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7.2']
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run rspec tests
+      run: bundle exec rspec spec

data/.github/workflows/rubocop.yml

@@ -0,0 +1,23 @@
+name: rubocop
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7.2']
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run rubocop style check
+        run: bundle exec rubocop

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+/.idea/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,29 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  Include:
+    - "bin/**/*.rb"
+    - "lib/**/*.rb"
+    - "spec/**/*.rb"
+    - "Gemfile"
+    - "*.gemspec"
+  NewCops: enable
+
+Layout/HashAlignment:
+  EnforcedColonStyle: key
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/WordArray:
+  EnforcedStyle: brackets

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in weather_gov.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    weather_gov (0.1.0)
+      activesupport (~> 6.1)
+      httparty (~> 0.18.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0225)
+    minitest (5.14.4)
+    multi_xml (0.6.0)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.18.2)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.18)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.4)
+  weather_gov!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Jeremy Cole
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# WeatherGov
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/weather_gov`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'weather_gov'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install weather_gov
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/weather_gov.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "weather_gov"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/weather_gov.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "weather_gov/version"
+
+module WeatherGov
+  class Error < StandardError; end
+
+  API_BASE_URI = "https://api.weather.gov"
+end
+
+require "weather_gov/identifier"
+require "weather_gov/api"
+require "weather_gov/client"

data/lib/weather_gov/address.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module WeatherGov
+  class Address
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def street_address
+      data.fetch("streetAddress")
+    end
+
+    def address_locality
+      data.fetch("addressLocality")
+    end
+
+    def address_region
+      data.fetch("addressRegion")
+    end
+
+    def postal_code
+      data.fetch("postalCode")
+    end
+  end
+end

data/lib/weather_gov/alert.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module WeatherGov
+  class Alert < Feature
+    SUMMARY_KEYS = [
+      "sent",
+      "effective",
+      "onset",
+      "expires",
+      "ends",
+      "status",
+      "severity",
+      "certainty",
+      "urgency",
+      "event",
+      "headline",
+      "description",
+      "instruction",
+    ].freeze
+
+    def sent_time
+      Time.parse(properties.fetch("sent"))
+    end
+
+    def effective_time
+      Time.parse(properties.fetch("effective"))
+    end
+
+    def expires_time
+      Time.parse(properties.fetch("expires"))
+    end
+
+    def active_time_range
+      effective_time...expires_time
+    end
+
+    def active?
+      active_time_range.include?(Time.now)
+    end
+
+    def summary_hash
+      properties.slice(*SUMMARY_KEYS)
+    end
+  end
+end

data/lib/weather_gov/alert_collection.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "weather_gov/feature_collection"
+require "weather_gov/alert"
+
+module WeatherGov
+  class AlertCollection < FeatureCollection
+    def self.feature_class
+      Alert
+    end
+
+    def update_time
+      @update_time ||= Time.parse(data.fetch("updated"))
+    end
+
+    def title
+      data.fetch("title")
+    end
+
+    def alerts
+      features
+    end
+
+    def summary
+      features.map(&:summary_hash)
+    end
+  end
+end

data/lib/weather_gov/api.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "httparty"
+
+module WeatherGov
+  class API
+    class RequestError < RuntimeError; end
+
+    include HTTParty
+    base_uri API_BASE_URI
+    format :json
+
+    def initialize(user_agent:)
+      @headers = {
+        "User-Agent" => user_agent,
+      }
+    end
+
+    def format_coord(value)
+      format("%.2f", value).sub(/0+$/, "")
+    end
+
+    def format_coords(lat, lon)
+      "#{format_coord(lat)},#{format_coord(lon)}"
+    end
+
+    def get(uri: nil, path: nil)
+      response = self.class.get(uri || path)
+
+      unless response.ok?
+        if response.parsed_response
+          error_type_id = Identifier::Problem.new(response.parsed_response.fetch("type")).id
+          error_detail = response.parsed_response.fetch("detail", response.code)
+          raise RequestError, "#{error_type_id}: #{error_detail}"
+        end
+
+        raise RequestError, "Error: Code #{response.code}"
+      end
+
+      response
+    end
+
+    def station(id:)
+      get(path: "/stations/#{id}")
+    end
+
+    def office(id:)
+      get(path: "/offices/#{id}")
+    end
+
+    def point(lat:, lon:)
+      get(path: "/points/#{format_coords(lat, lon)}")
+    end
+
+    def gridpoint(office_id:, grid_x:, grid_y:)
+      get(path: "/gridpoints/#{office_id}/#{grid_x},#{grid_y}")
+    end
+
+    def zone(type:, id:)
+      get(path: "/zones/#{type}/#{id}")
+    end
+
+    def product_locations(type: nil)
+      return get(path: "/products/types/#{type}/locations") if type
+
+      get(path: "/products/locations")
+    end
+
+    def product_types(location: nil)
+      return get(path: "/products/locations/#{location}/types") if location
+
+      get(path: "/products/types")
+    end
+
+    def products(type: nil, location: nil)
+      return get(path: "/products/types/#{type}/locations/#{location}") if type && location
+
+      get(path: "/products")
+    end
+
+    def product(id:)
+      get(path: "/products/#{id}")
+    end
+
+    def alerts_active(zone: nil, area: nil, region: nil)
+      return get(path: "/alerts/active/zone/#{zone}") if zone
+      return get(path: "/alerts/active/area/#{area}") if area
+      return get(path: "/alerts/active/region/#{region}") if region
+
+      get(path: "/alerts/active")
+    end
+  end
+end