weather_gov_api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef2d712f1eb48bd665d2026b525fa1350b6df2074d708404ab909c6e7cc07157
-  data.tar.gz: 85c59f8fc33f121b29ef6a8f0470afd9ac80e794f1502aa97ab317d8e702a6a2
+  metadata.gz: 1774def1c5d0e09a3fb74a4d66b0f2c63c6c18fd97c02871690db6bfdac5c38c
+  data.tar.gz: 35336afbc96f2517d96b993de9e73501b427843cc649b0b1217d621c7b9be8dc
 SHA512:
-  metadata.gz: e0bc42ef1eb84d7071f11c5125fe97fa13b140a060a312a464f7fdeeb79f40bc0a094804d73a73182698a03cbe5f7b1717c2981325854875ec8a0bbcec1d3df7
-  data.tar.gz: 466cf682be9fa48f9cf4c947472a2cf2a194769632ba083bdbd3d458344df62d0a385a19932d17c74aa1a6fa6665bca584c71fac75603090717060a59e4bdd5e
+  metadata.gz: 0b54fd7e6fb5572e2ae2341f8a6e8049174c3961cda8f4a01e18541f6dfc63cca2e91c4e96fc1a98788f490fcc23ebac33208accdfb55f6f1faa57d07c05f0e4
+  data.tar.gz: 758cea3008922169f96395ba0540abad5154b224ffbf0b1a4435068db79a9b68031f3e733aa1e2c05189baf7950a4a90556345d9652b819b4b880bded8e84605

data/.rubocop.yml

@@ -1,4 +1,10 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-rspec
+
 AllCops:
+  NewCops: enable
   TargetRubyVersion: 3.1
 
 Style/StringLiterals:
@@ -22,3 +28,14 @@ Metrics/BlockLength:
   Exclude:
     - "spec/**/*"
     - "*.gemspec"
+
+Metrics/ParameterLists:
+  CountKeywordArgs:
+    Enabled: false
+
+# Allow multiple exceptions
+RSpec/MultipleExpectations:
+  Max: 4
+
+RSpec/ExampleLength:
+  Max: 10 # Adjust this value as needed

data/.rubocop_todo.yml

@@ -0,0 +1,8 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-02-22 02:13:57 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.
+

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

@@ -44,12 +44,39 @@ Fetches the current weather conditions from the closest observation station.
 
 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.
 
+### Building and Releasing
+
+1. Update the version number in `version.rb`
+2. Build the gem:
+   ```bash
+   gem build weather_gov_api.gemspec
+   ```
+3. Test the built gem locally:
+   ```bash
+   gem install ./weather_gov_api-X.X.X.gem
+   ```
+4. Release to RubyGems:
+   ```bash
+   gem push weather_gov_api-X.X.X.gem
+   ```
+
 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 the created tag, 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/JeffreyMPrice/weather_gov_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/JeffreyMPrice/weather_gov_api/blob/main/CODE_OF_CONDUCT.md).
 
+## 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
+- [ ] Automate CHANGELOG.md updates during release process
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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,53 @@ 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 validate_coordinates(latitude, longitude)
-      raise ArgumentError, "Invalid latitude: must be between -90 and 90" unless latitude.between?(-90, 90)
-
-      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 +67,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.0"
+  VERSION = "0.3.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.0
+  version: 0.3.0
 platform: ruby
 authors:
 - JeffreyMPrice
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-19 00:00:00.000000000 Z
+date: 2025-02-28 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.
@@ -77,17 +34,20 @@ extra_rdoc_files: []
 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
 - sig/weather_gov_api.rbs
-- weather_gov_api-0.1.0.gem
 homepage: https://github.com/JeffreyMPrice/weather_gov_api
 licenses:
 - MIT
@@ -96,7 +56,7 @@ metadata:
   homepage_uri: https://github.com/JeffreyMPrice/weather_gov_api
   source_code_uri: https://github.com/JeffreyMPrice/weather_gov_api
   changelog_uri: https://github.com/JeffreyMPrice/weather_gov_api/blob/main/CHANGELOG.md
-post_install_message:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -111,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: []