weather_gov_api 0.2.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +30 -24
  3. data/.rubocop_todo.yml +39 -0
  4. data/README.md +30 -0
  5. data/lib/weather_gov_api/version.rb +1 -1
  6. metadata +4 -3
  7. data/weather_gov_api-0.1.0.gem +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ef2d712f1eb48bd665d2026b525fa1350b6df2074d708404ab909c6e7cc07157
4
- data.tar.gz: 85c59f8fc33f121b29ef6a8f0470afd9ac80e794f1502aa97ab317d8e702a6a2
3
+ metadata.gz: 9a3357a492f9e0fefc3414c9f9e8cd54d4fbf1bd24caff3741021af46948b9a6
4
+ data.tar.gz: 9f5f503e4db23945aa94eb18dfac9d24f1bb5fbf11d72f2040201c5db7cb004e
5
5
  SHA512:
6
- metadata.gz: e0bc42ef1eb84d7071f11c5125fe97fa13b140a060a312a464f7fdeeb79f40bc0a094804d73a73182698a03cbe5f7b1717c2981325854875ec8a0bbcec1d3df7
7
- data.tar.gz: 466cf682be9fa48f9cf4c947472a2cf2a194769632ba083bdbd3d458344df62d0a385a19932d17c74aa1a6fa6665bca584c71fac75603090717060a59e4bdd5e
6
+ metadata.gz: fcbe8dc202094f73f1693806a6356644b7e68b37a5c5f378b3e129377bae89d883dbe5905768db8124f74c15a83ea4d4d55b50569dc508fa731f9d4ab246b0ce
7
+ data.tar.gz: d6f8cbbb7ccb653fb09d0e05a191b306ed69c650346f05a5b7c1a5baa0000a0ac29c7afa184b10918430f1e1b5f625e9cc6d05c63c4d4427b7142df07c4c2937
data/.rubocop.yml CHANGED
@@ -1,24 +1,30 @@
1
- AllCops:
2
- TargetRubyVersion: 3.1
3
-
4
- Style/StringLiterals:
5
- EnforcedStyle: double_quotes
6
-
7
- Style/StringLiteralsInInterpolation:
8
- EnforcedStyle: double_quotes
9
-
10
- Layout/EndOfLine:
11
- EnforcedStyle: lf
12
-
13
- # Disable documentation requirements for specs
14
- Style/Documentation:
15
- Enabled: true
16
- Exclude:
17
- - "spec/**/*"
18
-
19
- # Allow longer blocks in specs
20
- Metrics/BlockLength:
21
- Enabled: true
22
- Exclude:
23
- - "spec/**/*"
24
- - "*.gemspec"
1
+ inherit_from: .rubocop_todo.yml
2
+
3
+ require:
4
+ - rubocop-rspec
5
+
6
+ AllCops:
7
+ NewCops: enable
8
+ TargetRubyVersion: 3.1
9
+
10
+ Style/StringLiterals:
11
+ EnforcedStyle: double_quotes
12
+
13
+ Style/StringLiteralsInInterpolation:
14
+ EnforcedStyle: double_quotes
15
+
16
+ Layout/EndOfLine:
17
+ EnforcedStyle: lf
18
+
19
+ # Disable documentation requirements for specs
20
+ Style/Documentation:
21
+ Enabled: true
22
+ Exclude:
23
+ - "spec/**/*"
24
+
25
+ # Allow longer blocks in specs
26
+ Metrics/BlockLength:
27
+ Enabled: true
28
+ Exclude:
29
+ - "spec/**/*"
30
+ - "*.gemspec"
data/.rubocop_todo.yml ADDED
@@ -0,0 +1,39 @@
1
+ # This configuration was generated by
2
+ # `rubocop --auto-gen-config`
3
+ # on 2025-02-22 02:13:57 UTC using RuboCop version 1.72.2.
4
+ # The point is for the user to remove these configuration records
5
+ # one by one as the offenses are removed from the code base.
6
+ # Note that changes in the inspected code, or installation of new
7
+ # versions of RuboCop, may require this file to be generated again.
8
+
9
+ # Offense count: 3
10
+ # Configuration parameters: EnforcedStyle, AllowedGems, Include.
11
+ # SupportedStyles: Gemfile, gems.rb, gemspec
12
+ # Include: **/*.gemspec, **/Gemfile, **/gems.rb
13
+ Gemspec/DevelopmentDependencies:
14
+ Exclude:
15
+ - 'weather_gov_api.gemspec'
16
+
17
+ # Offense count: 2
18
+ # Configuration parameters: EnforcedStyle.
19
+ # SupportedStyles: native, lf, crlf
20
+ Layout/EndOfLine:
21
+ Exclude:
22
+ - 'spec/weather_gov_api_spec.rb'
23
+ - 'weather_gov_api.gemspec'
24
+
25
+ # Offense count: 1
26
+ # Configuration parameters: Prefixes, AllowedPatterns.
27
+ # Prefixes: when, with, without
28
+ RSpec/ContextWording:
29
+ Exclude:
30
+ - 'spec/weather_gov_api/client_spec.rb'
31
+
32
+ # Offense count: 10
33
+ # Configuration parameters: CountAsOne.
34
+ RSpec/ExampleLength:
35
+ Max: 22
36
+
37
+ # Offense count: 5
38
+ RSpec/MultipleExpectations:
39
+ Max: 4
data/README.md CHANGED
@@ -44,12 +44,42 @@ Fetches the current weather conditions from the closest observation station.
44
44
 
45
45
  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.
46
46
 
47
+ ### Building and Releasing
48
+
49
+ 1. Update the version number in `version.rb`
50
+ 2. Build the gem:
51
+ ```bash
52
+ gem build weather_gov_api.gemspec
53
+ ```
54
+ 3. Test the built gem locally:
55
+ ```bash
56
+ gem install ./weather_gov_api-X.X.X.gem
57
+ ```
58
+ 4. Release to RubyGems:
59
+ ```bash
60
+ gem push weather_gov_api-X.X.X.gem
61
+ ```
62
+
47
63
  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).
48
64
 
49
65
  ## Contributing
50
66
 
51
67
  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).
52
68
 
69
+ ## TODO
70
+
71
+ - [ ] Implement forecast retrieval functionality
72
+ - [ ] Add validation to limit latitude and longitude to 4 decimal places (weather.gov API requirement)
73
+ - [ ] Improve error handling to properly surface weather.gov API error messages
74
+ - [ ] Implement rate limiting strategies:
75
+ - [ ] Local rate limiting
76
+ - [ ] Distributed rate limiting (Redis/DB-based)
77
+ - [ ] Add caching support for API responses
78
+ - [ ] Automate CHANGELOG.md updates during release process
79
+ - [ ] Configure Git repository settings:
80
+ - [ ] Disable direct commits to main branch
81
+ - [ ] Require passing CI builds for branch merges
82
+
53
83
  ## License
54
84
 
55
85
  The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
data/lib/weather_gov_api/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module WeatherGovApi
4
- VERSION = "0.2.0"
4
+ VERSION = "0.2.1"
5
5
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: weather_gov_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ version: 0.2.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - JeffreyMPrice
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2025-02-19 00:00:00.000000000 Z
11
+ date: 2025-02-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday
@@ -77,6 +77,7 @@ extra_rdoc_files: []
77
77
  files:
78
78
  - ".rspec"
79
79
  - ".rubocop.yml"
80
+ - ".rubocop_todo.yml"
80
81
  - CHANGELOG.md
81
82
  - CODE_OF_CONDUCT.md
82
83
  - LICENSE.txt
@@ -87,7 +88,6 @@ files:
87
88
  - lib/weather_gov_api/response.rb
88
89
  - lib/weather_gov_api/version.rb
89
90
  - sig/weather_gov_api.rbs
90
- - weather_gov_api-0.1.0.gem
91
91
  homepage: https://github.com/JeffreyMPrice/weather_gov_api
92
92
  licenses:
93
93
  - MIT
@@ -96,6 +96,7 @@ metadata:
96
96
  homepage_uri: https://github.com/JeffreyMPrice/weather_gov_api
97
97
  source_code_uri: https://github.com/JeffreyMPrice/weather_gov_api
98
98
  changelog_uri: https://github.com/JeffreyMPrice/weather_gov_api/blob/main/CHANGELOG.md
99
+ rubygems_mfa_required: 'true'
99
100
  post_install_message:
100
101
  rdoc_options: []
101
102
  require_paths:
data/weather_gov_api-0.1.0.gem DELETED
Binary file