weather_gov_api 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a3357a492f9e0fefc3414c9f9e8cd54d4fbf1bd24caff3741021af46948b9a6
-  data.tar.gz: 9f5f503e4db23945aa94eb18dfac9d24f1bb5fbf11d72f2040201c5db7cb004e
+  metadata.gz: 13b83eaaed19ffb380a72fcbe992cb5c931c3c207103f482cad4b1d2bf743f28
+  data.tar.gz: 493b84f0f0270463508257045fd73aad2183646588c3254e25ac42191655a5e8
 SHA512:
-  metadata.gz: fcbe8dc202094f73f1693806a6356644b7e68b37a5c5f378b3e129377bae89d883dbe5905768db8124f74c15a83ea4d4d55b50569dc508fa731f9d4ab246b0ce
-  data.tar.gz: d6f8cbbb7ccb653fb09d0e05a191b306ed69c650346f05a5b7c1a5baa0000a0ac29c7afa184b10918430f1e1b5f625e9cc6d05c63c4d4427b7142df07c4c2937
+  metadata.gz: afbfee51abe17ccdae50e3a32b6b59a351abf036b8abb524a591a99607416205763121ddb366c4703bc61c5e41af048f5364573b284c4cde688711cb8453a4db
+  data.tar.gz: 893b3113c9ad50908efccc2c28ad1dd5202f6c0f96d1f174ecad6ff0f2ecc5a157fdb6b638340a1bf594729dd72dab74320d1227f6f5453a5460f318012fba7a

data/.rubocop.yml

@@ -1,30 +1,41 @@
-inherit_from: .rubocop_todo.yml
-
-require:
-  - rubocop-rspec
-
-AllCops:
-  NewCops: enable
-  TargetRubyVersion: 3.1
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
-
-Layout/EndOfLine:
-  EnforcedStyle: lf
-
-# Disable documentation requirements for specs
-Style/Documentation:
-  Enabled: true
-  Exclude:
-    - "spec/**/*"
-
-# Allow longer blocks in specs
-Metrics/BlockLength:
-  Enabled: true
-  Exclude:
-    - "spec/**/*"
-    - "*.gemspec"
+inherit_from: .rubocop_todo.yml
+
+plugins:
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+# Disable documentation requirements for specs
+Style/Documentation:
+  Enabled: true
+  Exclude:
+    - "spec/**/*"
+
+# Allow longer blocks in specs
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - "spec/**/*"
+    - "*.gemspec"
+
+Metrics/ParameterLists:
+  CountKeywordArgs:
+    Enabled: false
+
+# Allow multiple exceptions
+RSpec/MultipleExpectations:
+  Max: 4
+
+RSpec/ExampleLength:
+  Max: 30 # Adjust this value as needed

data/.rubocop_todo.yml

@@ -1,39 +1,18 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-02-22 02:13:57 UTC using RuboCop version 1.72.2.
+# on 2025-03-17 20:00:04 UTC using RuboCop version 1.72.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
-# Configuration parameters: EnforcedStyle, AllowedGems, Include.
-# SupportedStyles: Gemfile, gems.rb, gemspec
-# Include: **/*.gemspec, **/Gemfile, **/gems.rb
-Gemspec/DevelopmentDependencies:
-  Exclude:
-    - 'weather_gov_api.gemspec'
-
-# Offense count: 2
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: native, lf, crlf
-Layout/EndOfLine:
-  Exclude:
-    - 'spec/weather_gov_api_spec.rb'
-    - 'weather_gov_api.gemspec'
-
-# Offense count: 1
-# Configuration parameters: Prefixes, AllowedPatterns.
-# Prefixes: when, with, without
-RSpec/ContextWording:
+# Offense count: 7
+# Configuration parameters: Max, CountAsOne.
+RSpec/ExampleLength:
   Exclude:
     - 'spec/weather_gov_api/client_spec.rb'
 
-# Offense count: 10
-# Configuration parameters: CountAsOne.
-RSpec/ExampleLength:
-  Max: 22
-
-# Offense count: 5
-RSpec/MultipleExpectations:
-  Max: 4
+# Offense count: 2
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 7

data/.ruby-version

@@ -0,0 +1 @@
+3.3.5

data/.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+        "shopify.ruby-lsp",
+        "rubocop.vscode-rubocop"
+    ]
+}

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## [0.3.0] - 2025-02-28
+
+### Added
+- Updated version handling adding WeatherGovApi::ApiError
+- added .ruby-version
+- added .vsc recommend plugins
+
+### Fixed
+- tackled rubocop_todo list
+- fixed CodeQL rb/request-forgery error by ensuring same host
+
+## [0.2.1] - 2025-02-21
+
+### Added
+- rubocop_todo
+- simplecov and rubycritic
+- updated CircleCI to require 90% overall and 80% on a file for test coverage
+
 ## [0.2.0] - 2025-02-19
 
 ### Added
@@ -9,7 +27,6 @@
 ## [0.1.0] - Initial Release
 
 ### Added
-- Basic client implementation
 - Basic client implementation for weather.gov API
 - `points` method for fetching weather data by coordinates
   - Error handling for:

data/README.md

@@ -39,6 +39,8 @@ Fetches a list of nearby weather observation stations.
 ### current_weather(latitude:, longitude:)
 Fetches the current weather conditions from the closest observation station.
 
+### forecast(latitude:, longitude:)
+Fetches the seven day forecast which will include a daytieme and nightime forecast.
 
 ## Development
 
@@ -68,17 +70,13 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Jeffre
 
 ## TODO
 
-- [ ] Implement forecast retrieval functionality
 - [ ] Add validation to limit latitude and longitude to 4 decimal places (weather.gov API requirement)
-- [ ] Improve error handling to properly surface weather.gov API error messages
 - [ ] Implement rate limiting strategies:
   - [ ] Local rate limiting
   - [ ] Distributed rate limiting (Redis/DB-based)
 - [ ] Add caching support for API responses
+- [ ] Memoize calls that might happen more than once (like points)
 - [ ] Automate CHANGELOG.md updates during release process
-- [ ] Configure Git repository settings:
-  - [ ] Disable direct commits to main branch
-  - [ ] Require passing CI builds for branch merges
 
 ## License
 

data/lib/weather_gov_api/api_errors.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module WeatherGovApi
+  # Custom error class to handle errors from the Weather.gov API
+  class ApiError < StandardError
+    attr_reader :type, :title, :status, :detail, :instance, :correlation_id, :parameter_errors
+
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(type: nil, title: nil, status: nil, detail: nil, instance: nil, correlation_id: nil, message: nil,
+                   parameter_errors: nil)
+      @type = type
+      @title = title
+      @status = status
+      @detail = detail
+      @instance = instance
+      @correlation_id = correlation_id
+      @parameter_errors = parameter_errors
+      @message = message
+      super(message || title || detail || "API request failed")
+    end
+    # rubocop:enable Metrics/ParameterLists
+
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
+    def to_s
+      return super unless super.empty?
+
+      parts = []
+      parts << "Type: #{@type}" if @type
+      parts << "Title: #{@title}" if @title
+      parts << "Status: #{@status}" if @status
+      parts << "Detail: #{@detail}" if @detail
+      parts << "Instance: #{@instance}" if @instance
+      parts << "CorrelationID: #{@correlation_id}" if @correlation_id
+      parts << "ParameterErros: #{@parameter_errors}" if @parameter_errors
+      parts.join(", ")
+    end
+    # rubocop:enable Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/CyclomaticComplexity
+  end
+end

data/lib/weather_gov_api/client.rb

@@ -11,44 +11,66 @@ module WeatherGovApi
     end
 
     def points(latitude:, longitude:)
-      validate_coordinates(latitude, longitude)
       response = connection.get("/points/#{latitude},#{longitude}")
+      raise_api_error(response) unless response.success?
       Response.new(response)
     rescue Faraday::Error => e
-      raise Error, "API request failed: #{e.message}"
+      raise WeatherGovApi::ApiError.new(message: "API request failed: #{e.message}")
     end
 
+    # rubocop:disable Metrics/MethodLength
     def observation_stations(latitude:, longitude:)
       points_response = points(latitude: latitude, longitude: longitude)
       stations_url = points_response.data.dig("properties", "observationStations")
-      raise Error, "No observation stations URL found in points response" unless stations_url
+      unless stations_url
+        raise WeatherGovApi::ApiError.new(message: "No observation stations URL found in points response")
+      end
+
+      stations_path = observation_stations_path(stations_url)
 
-      response = connection.get(stations_url.sub(BASE_URL, ""))
+      response = connection.get(stations_path)
+      raise_api_error(response) unless response.success?
       Response.new(response)
     rescue Faraday::Error => e
-      raise Error, "API request failed: #{e.message}"
+      raise WeatherGovApi::ApiError.new(message: "API request failed: #{e.message}")
     end
+    # rubocop:enable Metrics/MethodLength
 
     def current_weather(latitude:, longitude:)
       stations_response = observation_stations(latitude: latitude, longitude: longitude)
       station = stations_response.data.dig("features", 0)
-      raise Error, "No observation stations found" unless station
+      raise WeatherGovApi::ApiError.new(message: "No observation stations found") unless station
 
       station_id = station.dig("properties", "stationIdentifier")
       response = connection.get("/stations/#{station_id}/observations/latest")
+      raise_api_error(response) unless response.success?
       Response.new(response)
     rescue Faraday::Error => e
-      raise Error, "API request failed: #{e.message}"
+      raise WeatherGovApi::ApiError.new(message: "API request failed: #{e.message}")
     end
 
-    private
+    def forecast(latitude:, longitude:)
+      grid_data = points(latitude: latitude, longitude: longitude).data["properties"]
+      grid_id = grid_data["gridId"]
+      grid_x = grid_data["gridX"]
+      grid_y = grid_data["gridY"]
+
+      response = connection.get("/gridpoints/#{grid_id}/#{grid_x},#{grid_y}/forecast")
+      raise_api_error(response) unless response.success?
+      Response.new(response)
+    rescue Faraday::Error => e
+      raise WeatherGovApi::ApiError.new(message: "API request failed: #{e.message}")
+    end
 
-    def validate_coordinates(latitude, longitude)
-      raise ArgumentError, "Invalid latitude: must be between -90 and 90" unless latitude.between?(-90, 90)
+    private
 
-      return if longitude.between?(-180, 180)
+    def observation_stations_path(url)
+      uri = URI.parse(url)
+      unless uri.host == URI.parse(BASE_URL).host
+        raise WeatherGovApi::ApiError.new(message: "Invalid observation stations URL: #{url}")
+      end
 
-      raise ArgumentError, "Invalid longitude: must be between -180 and 180"
+      uri.path
     end
 
     def connection
@@ -58,5 +80,26 @@ module WeatherGovApi
         faraday.adapter Faraday.default_adapter
       end
     end
+
+    # rubocop:disable Metrics/MethodLength
+    def raise_api_error(response)
+      return if response.success?
+
+      begin
+        error_data = JSON.parse(response.body)
+      rescue JSON::ParserError
+        raise WeatherGovApi::ApiError.new(message: "API request failed with status #{response.status}\
+            but could not parse error response.")
+      end
+
+      raise WeatherGovApi::ApiError.new(
+        type: error_data["type"],
+        title: error_data["title"],
+        status: error_data["status"],
+        detail: error_data["detail"],
+        instance: error_data["instance"]
+      )
+    end
+    # rubocop:enable Metrics/MethodLength
   end
 end

data/lib/weather_gov_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WeatherGovApi
-  VERSION = "0.2.1"
+  VERSION = "0.4.0"
 end

data/lib/weather_gov_api.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "weather_gov_api/version"
+require_relative "weather_gov_api/api_errors"
 require_relative "weather_gov_api/response"
 require_relative "weather_gov_api/client"
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: weather_gov_api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - JeffreyMPrice
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-22 00:00:00.000000000 Z
+date: 2025-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,48 +23,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 description: |-
   A Ruby gem for accessing weather data from the National Weather Service (weather.gov) API.
       Provides a simple interface to fetch weather data for US locations.
@@ -78,12 +35,15 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".ruby-version"
+- ".vscode/extensions.json"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/weather_gov_api.rb
+- lib/weather_gov_api/api_errors.rb
 - lib/weather_gov_api/client.rb
 - lib/weather_gov_api/response.rb
 - lib/weather_gov_api/version.rb
@@ -97,7 +57,6 @@ metadata:
   source_code_uri: https://github.com/JeffreyMPrice/weather_gov_api
   changelog_uri: https://github.com/JeffreyMPrice/weather_gov_api/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -112,8 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Ruby wrapper for the Weather.gov API
 test_files: []