weather_gem_kg 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8433c3a942dcdc25b325c40624f7c2be90399e35e7d2c6b957bfb49ae121c04
-  data.tar.gz: ef5867ae1f04271203a5763cd12499f0ad7baef80d90f3c74def8ee30e0bfd35
+  metadata.gz: a95c4c55f26f7f75e7fe956bc5d91d0148849e3df4366d98b5a90ceb1cd45ca1
+  data.tar.gz: 7970245200fcfb56dfcaecefb6fbb33ab32f7266f626fda99bb3c69d5e4cbf1e
 SHA512:
-  metadata.gz: 593022b166c4032612c908615de4179c26f50f9b2f9b3638e3d815bdf403c7a346dfba45e47f190e93264fb344f4444b7bdb0d53db9a2b61efce71b4542eab59
-  data.tar.gz: 907b62f12190c808e4237b7dd65d2422ce40b7ec2f0f5a840c5d6bd401aa73bb915ad29ae89792c3b09149ae12b5ddac4bce8f36212c76f3d05896bb10bcbf2f
+  metadata.gz: 45d9ad7f35f0f21c345d8f12109b9cf177eed2b700236d8fad7b00e86d147c814b1cfd6b7c84d8ed9edac9a8adab9b0b93c85f27cc0eb56b36a1663c80ce7de0
+  data.tar.gz: 7432f57f7412c7f1c3b7370556941a3022821c9d1dce641bb7795eda1c38c29409d73390b1e27b5a7f5969d9189bdbe6d4070518ed28771a4efbac43c7308396

data/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+## [1.0.0] — 2026-07-21
+
+### Added
+
+- `WeatherGemKg.forecast(city:, days:, client:)` public API
+- `WeatherGemKg::ForecastDay` (`date`, `max_temp`, `min_temp`, `condition`)
+- `WeatherGemKg::Client` interface and `WeatherGemKg::Clients::OpenMeteo`
+- Errors: `LocationNotFoundError`, `RequestError`, `InvalidArgumentError`
+- GitHub Actions CI workflow
+- `.ruby-version` pinned to Ruby 4.0.6
+- Rails installer updated for key-free configuration
+
+### Changed
+
+- Runtime dependency is `httparty` only (declared in the gemspec)
+- Specs use WebMock stubs (no live HTTP in CI)
+- `required_ruby_version` set to `>= 3.2`
+
+### Removed
+
+- Apixu and Dark Sky clients
+- `WeatherGemKg::Generator` and `#generate_me`
+- API key settings (`api_key_apixu`, `api_key_dark`)
+- `geocoder` and `vcr` dependencies
+- Travis CI configuration
+
+## [0.32.0] — prior
+
+Initial published line with Apixu and Dark Sky providers.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    weather_gem_kg (1.0.0)
+    weather_gem_kg (1.0.1)
       httparty (~> 0.24)
 
 GEM

data/README.md

@@ -1,46 +1,65 @@
 # WeatherGemKg
 
-Ruby gem for daily city weather forecasts powered by [Open-Meteo](https://open-meteo.com/) (no API key required).
+Daily city weather forecasts for Ruby, powered by [Open-Meteo](https://open-meteo.com/).
+
+- **No API key** required
+- Returns structured `ForecastDay` objects (`date`, `max_temp`, `min_temp`, `condition`)
+- Swappable client interface for custom providers
+- Ruby **≥ 3.2**
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add to your Gemfile:
 
 ```ruby
-gem "weather_gem_kg"
+gem "weather_gem_kg", "~> 1.0"
 ```
 
-And then execute:
+Then:
 
 ```bash
 bundle install
 ```
 
-Or install it yourself:
+Or install directly:
 
 ```bash
 gem install weather_gem_kg
 ```
 
+Pin `~> 1.0` if you previously used `0.x` — **1.0.0 is a breaking release**. See [CHANGELOG.md](CHANGELOG.md).
+
 ### Rails
 
 ```bash
 rails generate weather_gem_kg:install
 ```
 
+This creates `config/initializers/weather_gem_kg.rb`.
+
 ## Usage
 
 ```ruby
 require "weather_gem_kg"
 
-days = WeatherGemKg.forecast(city: "Bishkek", days: 3)
+forecast = WeatherGemKg.forecast(city: "Bishkek", days: 3)
 
-days.each do |day|
+forecast.each do |day|
   puts "#{day.date}: #{day.min_temp}–#{day.max_temp}°C, #{day.condition}"
 end
+# => 2026-07-21: 15.2–30.1°C, Clear sky
 ```
 
-Each day is a `WeatherGemKg::ForecastDay` with `date`, `max_temp`, `min_temp`, and `condition`.
+### `ForecastDay`
+
+| Attribute   | Type    | Description              |
+|-------------|---------|--------------------------|
+| `date`      | String  | ISO date (`YYYY-MM-DD`)  |
+| `max_temp`  | Float   | Daily high (°C)          |
+| `min_temp`  | Float   | Daily low (°C)           |
+| `condition` | String  | Human-readable condition |
+
+`days` must be between **1 and 16** (Open-Meteo limit). If omitted, `configuration.default_days` is used (default: `1`).
 
 ### Configuration
 
@@ -51,21 +70,64 @@ WeatherGemKg.configure do |config|
 end
 ```
 
+No API keys are needed for the default Open-Meteo client.
+
+### Errors
+
+```ruby
+begin
+  WeatherGemKg.forecast(city: "Bishkek", days: 3)
+rescue WeatherGemKg::LocationNotFoundError
+  # city could not be geocoded
+rescue WeatherGemKg::RequestError
+  # HTTP / upstream failure
+rescue WeatherGemKg::InvalidArgumentError
+  # blank city or days out of range
+end
+```
+
+All errors inherit from `WeatherGemKg::Error`.
+
 ### Custom client
 
-Any object responding to `#forecast(city:, days:)` and returning an array of `ForecastDay` can be passed:
+Any object that implements `#forecast(city:, days:)` and returns an `Array` of `ForecastDay` can be used:
 
 ```ruby
+class MyClient < WeatherGemKg::Client
+  def forecast(city:, days:)
+    # ...
+  end
+end
+
 WeatherGemKg.forecast(city: "Bishkek", days: 1, client: MyClient.new)
+# or
+WeatherGemKg.configure { |c| c.client = MyClient.new }
 ```
 
 ## Development
 
 ```bash
 bundle install
-bundle exec rake
+bundle exec rake          # run specs
+bin/console               # interactive console with the gem loaded
+```
+
+Specs stub HTTP with WebMock — no network required for the test suite.
+
+### Releasing to RubyGems
+
+1. Bump `WeatherGemKg::VERSION` in `lib/weather_gem_kg/version.rb`
+2. Update [CHANGELOG.md](CHANGELOG.md)
+3. Commit all changes (the gemspec packs files via `git ls-files`)
+4. Publish:
+
+```bash
+bundle exec rake release
+# or
+gem build weather_gem_kg.gemspec
+gem push weather_gem_kg-X.Y.Z.gem
 ```
 
 ## License
 
-MIT
+MIT — see [LICENSE.txt](LICENSE.txt).

data/lib/weather_gem_kg/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WeatherGemKg
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: weather_gem_kg
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Edilbek
@@ -77,6 +77,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock