weather_gem_kg 0.31.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02a8cf12c9c8e11bd58b612f0a4cabfed6fcbaa89b0c4671b6bec3b45fa9fad7
-  data.tar.gz: c0ff3ea5a27edf08750775ff1e596420d233774755731a993c3262bc8094e876
+  metadata.gz: f8433c3a942dcdc25b325c40624f7c2be90399e35e7d2c6b957bfb49ae121c04
+  data.tar.gz: ef5867ae1f04271203a5763cd12499f0ad7baef80d90f3c74def8ee30e0bfd35
 SHA512:
-  metadata.gz: c654dd71e142f317e4404023567b70838180666c126463efca1303152a8c3ffe617aaa5e9f3817da1316e2a8f2d059cad27fc27da9c60fc1aba3b4642d943016
-  data.tar.gz: 1d4815336c89bae37c21c4fc42c38790356a19a8d184ef67f3c98aabfce71f5650bdb4d2b206e5484921b812a68847f33373de8208a70ce744413a25cae6205a
+  metadata.gz: 593022b166c4032612c908615de4179c26f50f9b2f9b3638e3d815bdf403c7a346dfba45e47f190e93264fb344f4444b7bdb0d53db9a2b61efce71b4542eab59
+  data.tar.gz: 907b62f12190c808e4237b7dd65d2422ce40b7ec2f0f5a840c5d6bd401aa73bb915ad29ae89792c3b09149ae12b5ddac4bce8f36212c76f3d05896bb10bcbf2f

data/.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: CI
+
+on:
+  push:
+    branches: [master, main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: .ruby-version
+          bundler-cache: true
+
+      - name: Run specs
+        run: bundle exec rake

data/.ruby-version

@@ -0,0 +1 @@
+4.0.6

data/Gemfile

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

data/Gemfile.lock

@@ -1,45 +1,57 @@
 PATH
   remote: .
   specs:
-    weather_gem_kg (0.30.0)
+    weather_gem_kg (1.0.0)
+      httparty (~> 0.24)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
-    geocoder (1.5.1)
-    httparty (0.17.0)
-      mime-types (~> 3.0)
+    addressable (2.9.0)
+      public_suffix (>= 2.0.2, < 8.0)
+    bigdecimal (4.1.2)
+    crack (1.0.1)
+      bigdecimal
+      rexml
+    csv (3.3.5)
+    diff-lcs (1.6.2)
+    hashdiff (1.2.1)
+    httparty (0.24.2)
+      csv
+      mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
-    mime-types (3.2.2)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.0331)
-    multi_xml (0.6.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    mini_mime (1.1.5)
+    multi_xml (0.9.1)
+      bigdecimal (>= 3.1, < 5)
+    public_suffix (7.0.5)
+    rake (13.4.2)
+    rexml (3.4.4)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.8)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.7)
+    webmock (3.26.2)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.0)
-  geocoder
-  httparty
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
   weather_gem_kg!
+  webmock (~> 3.0)
 
 BUNDLED WITH
-   2.0.2
+  4.0.16

data/README.md

@@ -1,43 +1,71 @@
 # WeatherGemKg
 
-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_gem_kg`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Ruby gem for daily city weather forecasts powered by [Open-Meteo](https://open-meteo.com/) (no API key required).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'weather_gem_kg'
+gem "weather_gem_kg"
 ```
 
 And then execute:
 
-    $ bundle
+```bash
+bundle install
+```
+
+Or install it yourself:
+
+```bash
+gem install weather_gem_kg
+```
 
-Or install it yourself as:
+### Rails
 
-    $ gem install weather_gem_kg
+```bash
+rails generate weather_gem_kg:install
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require "weather_gem_kg"
 
-## Development
+days = WeatherGemKg.forecast(city: "Bishkek", days: 3)
+
+days.each do |day|
+  puts "#{day.date}: #{day.min_temp}–#{day.max_temp}°C, #{day.condition}"
+end
+```
 
-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.
+Each day is a `WeatherGemKg::ForecastDay` with `date`, `max_temp`, `min_temp`, and `condition`.
 
-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).
+### Configuration
 
-## Contributing
+```ruby
+WeatherGemKg.configure do |config|
+  config.default_days = 3
+  # config.client = WeatherGemKg::Clients::OpenMeteo.new
+end
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/weather_gem_kg. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+### Custom client
 
-## License
+Any object responding to `#forecast(city:, days:)` and returning an array of `ForecastDay` can be passed:
+
+```ruby
+WeatherGemKg.forecast(city: "Bishkek", days: 1, client: MyClient.new)
+```
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+## Development
 
-## Code of Conduct
+```bash
+bundle install
+bundle exec rake
+```
+
+## License
 
-Everyone interacting in the WeatherGemKg project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/weather_gem_kg/blob/master/CODE_OF_CONDUCT.md).
+MIT

data/lib/generators/templates/weather_gem_kg_initializer.rb

@@ -0,0 +1,4 @@
+WeatherGemKg.configure do |config|
+  # config.default_days = 3
+  # config.client = WeatherGemKg::Clients::OpenMeteo.new
+end

data/lib/generators/weather_gem_kg/install_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WeatherGemKg
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      desc "Creates WeatherGemKg initializer for your application"
+
+      def copy_initializer
+        template "weather_gem_kg_initializer.rb", "config/initializers/weather_gem_kg.rb"
+      end
+    end
+  end
+end

data/lib/weather_gem_kg/client.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module WeatherGemKg
+  # Base contract for weather providers.
+  # Implementations must return an Array of ForecastDay.
+  class Client
+    def forecast(city:, days:)
+      raise NotImplementedError, "#{self.class}#forecast must be implemented"
+    end
+  end
+end

data/lib/weather_gem_kg/clients/open_meteo.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require "httparty"
+require "weather_gem_kg/client"
+require "weather_gem_kg/errors"
+require "weather_gem_kg/forecast_day"
+
+module WeatherGemKg
+  module Clients
+    class OpenMeteo < Client
+      GEOCODING_URL = "https://geocoding-api.open-meteo.com/v1/search"
+      FORECAST_URL = "https://api.open-meteo.com/v1/forecast"
+
+      WEATHER_CODES = {
+        0 => "Clear sky",
+        1 => "Mainly clear",
+        2 => "Partly cloudy",
+        3 => "Overcast",
+        45 => "Fog",
+        48 => "Depositing rime fog",
+        51 => "Light drizzle",
+        53 => "Moderate drizzle",
+        55 => "Dense drizzle",
+        56 => "Light freezing drizzle",
+        57 => "Dense freezing drizzle",
+        61 => "Slight rain",
+        63 => "Moderate rain",
+        65 => "Heavy rain",
+        66 => "Light freezing rain",
+        67 => "Heavy freezing rain",
+        71 => "Slight snow",
+        73 => "Moderate snow",
+        75 => "Heavy snow",
+        77 => "Snow grains",
+        80 => "Slight rain showers",
+        81 => "Moderate rain showers",
+        82 => "Violent rain showers",
+        85 => "Slight snow showers",
+        86 => "Heavy snow showers",
+        95 => "Thunderstorm",
+        96 => "Thunderstorm with slight hail",
+        99 => "Thunderstorm with heavy hail"
+      }.freeze
+
+      def forecast(city:, days:)
+        days = Integer(days)
+        raise InvalidArgumentError, "days must be between 1 and 16" unless days.between?(1, 16)
+
+        location = geocode(city)
+        payload = fetch_forecast(location.fetch(:latitude), location.fetch(:longitude), days)
+        parse_forecast(payload)
+      end
+
+      private
+
+      def geocode(city)
+        response = HTTParty.get(GEOCODING_URL, query: { name: city, count: 1 })
+        raise RequestError, "Geocoding failed (HTTP #{response.code})" unless response.success?
+
+        result = response.parsed_response&.dig("results", 0)
+        raise LocationNotFoundError, "No location found for #{city.inspect}" unless result
+
+        {
+          latitude: result.fetch("latitude"),
+          longitude: result.fetch("longitude")
+        }
+      end
+
+      def fetch_forecast(latitude, longitude, days)
+        response = HTTParty.get(
+          FORECAST_URL,
+          query: {
+            latitude: latitude,
+            longitude: longitude,
+            daily: "weather_code,temperature_2m_max,temperature_2m_min",
+            forecast_days: days,
+            timezone: "auto"
+          }
+        )
+        raise RequestError, "Forecast request failed (HTTP #{response.code})" unless response.success?
+
+        response.parsed_response
+      end
+
+      def parse_forecast(payload)
+        daily = payload.fetch("daily")
+        times = daily.fetch("time")
+        max_temps = daily.fetch("temperature_2m_max")
+        min_temps = daily.fetch("temperature_2m_min")
+        codes = daily.fetch("weather_code")
+
+        times.each_index.map do |index|
+          ForecastDay.new(
+            date: times[index],
+            max_temp: max_temps[index],
+            min_temp: min_temps[index],
+            condition: WEATHER_CODES.fetch(codes[index], "Unknown")
+          )
+        end
+      end
+    end
+  end
+end

data/lib/weather_gem_kg/config.rb

@@ -1,17 +1,33 @@
+# frozen_string_literal: true
+
 module WeatherGemKg
-  module Configuration
-    Config = Struct.new :api_key_apixu, :api_key_dark
+  class << self
+    attr_writer :configuration
+  end
 
-    class << self
-      attr_accessor :api_key_apixu, :api_key_dark
-    end
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+
+  def self.reset_configuration!
+    @configuration = Configuration.new
+  end
+
+  class Configuration
+    attr_writer :client
+    attr_accessor :default_days
 
-    def self.configure(&config_block)
-      config_block.call config
+    def initialize
+      @default_days = 1
+      @client = nil
     end
 
-    def self.config
-      @config ||= Config.new
+    def client
+      @client ||= Clients::OpenMeteo.new
     end
   end
 end

data/lib/weather_gem_kg/errors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module WeatherGemKg
+  class Error < StandardError; end
+  class LocationNotFoundError < Error; end
+  class RequestError < Error; end
+  class InvalidArgumentError < Error; end
+end

data/lib/weather_gem_kg/forecast_day.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module WeatherGemKg
+  ForecastDay = Data.define(:date, :max_temp, :min_temp, :condition)
+end

data/lib/weather_gem_kg/version.rb

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

data/lib/weather_gem_kg.rb

@@ -1,14 +1,17 @@
-require "httparty"
+# frozen_string_literal: true
+
 require "weather_gem_kg/version"
-require "weather_gem_kg/generator"
+require "weather_gem_kg/errors"
+require "weather_gem_kg/forecast_day"
+require "weather_gem_kg/client"
 require "weather_gem_kg/config"
+require "weather_gem_kg/clients/open_meteo"
 
 module WeatherGemKg
-  extend Configuration
-end
+  def self.forecast(city:, days: nil, client: nil)
+    raise InvalidArgumentError, "city is required" if city.nil? || city.to_s.strip.empty?
 
-# weather1 = WeatherGemKg::Generator.new('Bishkek', 1, WeatherGemKg::Clients::Apixu.new)
-# weather1.generate_me
-#
-# weather2 = WeatherGemKg::Generator.new('Bishkek', 1, WeatherGemKg::Clients::DarkSky.new)
-# puts weather2.generate_me
+    days ||= configuration.default_days
+    (client || configuration.client).forecast(city: city, days: days)
+  end
+end

data/weather_gem_kg.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "weather_gem_kg/version"
@@ -8,27 +10,21 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Edilbek"]
   spec.email         = ["edil.talantbekov@gmail.com"]
 
-  spec.summary       = %q{Write a short summary, because RubyGems requires one.}
-  spec.description   = %q{Write a longer description or delete this line.}
-  # spec.homepage      = "Put your gem's website or public repo URL here."
+  spec.summary       = "Daily weather forecasts via Open-Meteo"
+  spec.description   = "A small Ruby gem that fetches daily city forecasts using the free Open-Meteo API."
   spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.2"
 
-  # spec.metadata["allowed_push_host"] = "Set to 'http://mygemserver.com'"
-
-  # spec.metadata["homepage_uri"] = spec.homepage
-  # spec.metadata["source_code_uri"] = "Put your gem's public repo URL here."
-  # spec.metadata["changelog_uri"] = "Put your gem's CHANGELOG.md URL here."
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "httparty", "~> 0.24"
+
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.0"
 end

metadata

@@ -1,43 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: weather_gem_kg
 version: !ruby/object:Gem::Version
-  version: 0.31.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Edilbek
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-15 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
+        version: '0.24'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.24'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,16 +51,32 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Write a longer description or delete this line.
+- !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 small Ruby gem that fetches daily city forecasts using the free Open-Meteo
+  API.
 email:
 - edil.talantbekov@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -70,18 +85,19 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/generators/templates/weather_gem_kg_initializer.rb
+- lib/generators/weather_gem_kg/install_generator.rb
 - lib/weather_gem_kg.rb
-- lib/weather_gem_kg/clients/apixu.rb
-- lib/weather_gem_kg/clients/dark_sky.rb
+- lib/weather_gem_kg/client.rb
+- lib/weather_gem_kg/clients/open_meteo.rb
 - lib/weather_gem_kg/config.rb
-- lib/weather_gem_kg/generator.rb
+- lib/weather_gem_kg/errors.rb
+- lib/weather_gem_kg/forecast_day.rb
 - lib/weather_gem_kg/version.rb
 - weather_gem_kg.gemspec
-homepage: 
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -89,15 +105,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 4.0.16
 specification_version: 4
-summary: Write a short summary, because RubyGems requires one.
+summary: Daily weather forecasts via Open-Meteo
 test_files: []

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.4.1
-before_install: gem install bundler -v 2.0.2

data/lib/weather_gem_kg/clients/apixu.rb

@@ -1,30 +0,0 @@
-require_relative '../config'
-
-module WeatherGemKg
-  module Clients
-    class Apixu
-      API_KEY = WeatherGemKg::Configuration.config.api_key_apixu
-
-      def initialize
-        @base_url = "http://api.apixu.com/v1/forecast.json?key=#{API_KEY}"
-      end
-
-      def get_weather(city, days)
-        @data = get_weather_info(city, days)
-        @data.dig('forecast', 'forecastday').map do |f|
-          day = f.dig('day')
-          {
-            date: Time.at(f['date_epoch']).ctime.slice(0, 10),
-            max_temp: day['maxtemp_c'],
-            min_temp: day['mintemp_c'],
-            condition: day.dig('condition', 'text')
-          }
-        end
-      end
-
-      def get_weather_info(city, days)
-        HTTParty.get("#{@base_url}&q=#{city}&days=#{days}")
-      end
-    end
-  end
-end

data/lib/weather_gem_kg/clients/dark_sky.rb

@@ -1,37 +0,0 @@
-require "geocoder"
-require_relative '../config'
-
-module WeatherGemKg
-  module Clients
-    class DarkSky
-      API_KEY = WeatherGemKg::Configuration.config.api_key_dark
-
-      def initialize
-        @base_url = "https://api.darksky.net/forecast/#{API_KEY}"
-      end
-
-      def get_weather(city, days)
-        @data = get_weather_info(city, days)
-
-        @data.dig("daily", "data")[0...days].map do |f|
-          {
-            date: Time.at(f['time']).ctime.slice(0, 10),
-            max_temp: ((f["temperatureHigh"] - 32) * 5 / 9).round(1),
-            min_temp: ((f["temperatureLow"] - 32) * 5 / 9).round(1),
-            condition: f["summary"]
-          }
-        end
-      end
-
-      def get_weather_info(city, days)
-        coordinates = get_city_coordinates(city)
-
-        HTTParty.get("#{@base_url}/#{coordinates}")
-      end
-
-      def get_city_coordinates(city)
-        Geocoder.search("#{city}").first.coordinates.map(&:inspect).join(',')
-      end
-    end
-  end
-end

data/lib/weather_gem_kg/generator.rb

@@ -1,18 +0,0 @@
-require "weather_gem_kg/clients/apixu"
-require "weather_gem_kg/clients/dark_sky"
-
-module WeatherGemKg
-  class Generator
-    attr_reader :city, :day, :generator
-
-    def initialize(city, day, generator)
-      @city = city
-      @day = day
-      @generator = generator
-    end
-
-    def generate_me
-      generator.get_weather(city, day)
-    end
-  end
-end