owm_sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a96afd1d1c4a14f4f7e8328953212d16d61a493b3c1761d87ce061554b943c6e
+  data.tar.gz: 37a169b11b7fa4d8ef3bbfe6c328ce815c5edac7b356b5f39e19a7c28f2f6812
+SHA512:
+  metadata.gz: b2fc2e062b873c40acc9ae282668da1089990baa1f161bc1f5535e4cea9860d42208e7a89c0dc56bbc7f976edce0298c928baca262909c524a0d542d4481b5fa
+  data.tar.gz: bd9fda28c45f5b276795e1dee5c61b1b1b6c4a04ddd75eed246b978938fbae243c3582784f0eca25c6644909b830f172b7d25fd0092d7b7a4b3d0ed655e64bad

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-03-09
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Alexander Kulichkov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# OwmSdk
+
+Example SDK for working with OpenWeatherMap
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add 
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install 
+
+## Usage
+
+SDK supports two working mode: on demand and polling.
+
+On demand usage:
+
+```ruby
+
+require 'owm_sdk'
+
+client = OwmSdk::Weather.new(
+    api_key: "OpenWeatherMap API Key",
+    mode: "on_demand",
+    units: "metric"
+)
+
+puts client.get_weather("London")
+
+# Requested data is now cached for next 10 minutes
+
+```
+
+Polling usage:
+
+```ruby
+require 'owm_sdk'
+
+client = OwmSdk::Weather.new(
+    api_key: "...",
+    mode: "polling",
+    units: "metric",
+)
+
+puts client.get_weather("London")
+
+# Weather data for requested location 
+# will be constantly updated in the background
+
+puts client.get_weather("London") # Gets new data with zero latency
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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/hetyh/owm-sdk-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/owm_sdk/config.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module OwmSdk
+  module Config
+    extend self
+
+    ATTRIBUTES = %i[
+      api_key
+      mode
+      units
+    ].freeze
+
+    attr_accessor(*Config::ATTRIBUTES)
+
+    def reset
+      self.api_key = nil
+      self.mode = nil
+      self.units = nil
+    end
+  end
+
+  class << self
+    def configure
+      block_given? ? yield(Config) : Config
+    end
+
+    def config
+      Config
+    end
+  end
+end
+
+OwmSdk::Config.reset

data/lib/owm_sdk/errors.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module OwmSdk
+  module Errors
+    class Error < StandardError; end
+
+    class RequestError < StandardError; end
+
+    class ServerError < StandardError; end
+  end
+end

data/lib/owm_sdk/request.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module OwmSdk
+  module Request
+    private
+
+    def get(path, query)
+      uri = URI.parse("https://api.openweathermap.org")
+      uri.path = path
+      uri.query = URI.encode_www_form(query)
+
+      res = Net::HTTP.get_response(uri)
+      body = JSON.parse(res.body)
+
+      case res.code.to_f
+      when 200 then body
+      when 400..499 then raise OwmSdk::Errors::RequestError, (body["message"]).to_s
+      when 500..599 then raise OwmSdk::Errors::ServerError, (body["message"]).to_s
+      else raise OwmSdk::Errors::Error, (body["message"]).to_s
+      end
+    end
+
+    def get_weather_request(location)
+      res = get("/data/2.5/weather", {lat: location[:lat], lon: location[:lon], appid: @api_key, units: @units.to_s})
+
+      weather_data = res["weather"].first
+      temperature_data = res["main"]
+      wind_data = res["wind"]
+      sys_data = res["sys"]
+
+      weather = {
+        weather: {
+          main: weather_data["main"],
+          description: weather_data["description"]
+        },
+        temperature: {
+          temp: temperature_data["temp"],
+          feels_like: temperature_data["feels_like"]
+        },
+        visibility: res["visibility"],
+        wind: {
+          speed: wind_data["speed"]
+        },
+        datetime: res["dt"],
+        sys: {
+          sunrise: sys_data["sunrise"],
+          sunset: sys_data["sunset"]
+        },
+        timezone: res["timezone"],
+        name: res["name"]
+      }
+
+      @weather_cache[location] = weather
+
+      weather
+    end
+
+    def get_location_request(city)
+      res = get("/geo/1.0/direct", {q: city, limit: 1, appid: @api_key})
+
+      raise OwmSdk::Errors::Error, "Provided city was not found" if res[0].nil?
+
+      location = {lat: res[0]["lat"], lon: res[0]["lon"]}
+
+      @location_cache[city] = location
+
+      location
+    end
+  end
+end

data/lib/owm_sdk/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OwmSdk
+  VERSION = "0.1.0"
+end

data/lib/owm_sdk/weather.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module OwmSdk
+  class Weather
+    include Request
+
+    attr_accessor(*Config::ATTRIBUTES)
+
+    POLLING_RATE = 600
+    LOCATION_CACHE_SIZE = 10
+    WEATHER_CACHE_SIZE = 10
+    WEATHER_CACHE_TTL = 600
+
+    def get_weather(city)
+      location = get_location(city)
+
+      weather_cached = @weather_cache[location]
+      return weather_cached unless weather_cached.nil?
+
+      get_weather_request(location)
+    end
+
+    def initialize(config = {})
+      OwmSdk::Config::ATTRIBUTES.each do |key|
+        send(:"#{key}=", config[key] || OwmSdk.config.send(key))
+      end
+
+      validate_configuration(config)
+
+      @logger = Logger.new(STDOUT)
+
+      @location_cache = LruRedux::Cache.new(LOCATION_CACHE_SIZE)
+      @weather_cache = LruRedux::TTL::Cache.new(WEATHER_CACHE_SIZE, WEATHER_CACHE_TTL)
+
+      @polling_thread = Thread.new { polling_loop } if @mode == "polling"
+    end
+
+    class << self
+      def configure
+        block_given? ? yield(Config) : Config
+      end
+
+      def config
+        Config
+      end
+    end
+
+    private
+
+    def validate_configuration(config)
+      validate_api_key(config[:api_key])
+      validate_mode(config[:mode]) unless config[:mode].nil?
+      validate_units(config[:units]) unless config[:units].nil?
+    end
+
+    def validate_api_key(api_key)
+      raise ArgumentError, "API key cannot be nil or empty" if api_key.nil? || api_key.empty?
+    end
+
+    def validate_mode(mode)
+      valid_modes = %w[on_demand polling]
+      raise ArgumentError, "Invalid mode. Supported modes: #{valid_modes.join(", ")}" unless valid_modes.include?(mode)
+    end
+
+    def validate_units(units)
+      valid_units = %w[standard metric imperial]
+
+      unless valid_units.include?(units)
+        raise ArgumentError,
+          "Invalid units. Supported units: #{valid_units.join(", ")}"
+      end
+    end
+
+    def get_location(city)
+      location = @location_cache[city]
+
+      return location unless location.nil?
+
+      get_location_request(city)
+    end
+
+    def update_weather
+      @location_cache.to_a.each do |city|
+        get_weather_request(city[1])
+      end
+    end
+
+    def polling_loop
+      loop do
+        begin
+          update_weather
+        rescue Error => e
+          @logger.error "Error during polling: #{e.message}"
+        end
+
+        sleep POLLING_RATE
+      end
+    end
+  end
+end

data/lib/owm_sdk.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "owm_sdk/version"
+require_relative "owm_sdk/errors"
+require_relative "owm_sdk/config"
+require_relative "owm_sdk/request"
+require_relative "owm_sdk/weather"
+
+require "lru_redux"
+require "uri"
+require "net/http"
+require "json"
+require "logger"

data/sig/owm_sdk.rbs

@@ -0,0 +1,4 @@
+module OwmSdk
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: owm_sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Kulichkov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lru_redux
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.23.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.23.0
+- !ruby/object:Gem::Dependency
+  name: minitest-stub-const
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description:
+email:
+- hetyh2004@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/owm_sdk.rb
+- lib/owm_sdk/config.rb
+- lib/owm_sdk/errors.rb
+- lib/owm_sdk/request.rb
+- lib/owm_sdk/version.rb
+- lib/owm_sdk/weather.rb
+- sig/owm_sdk.rbs
+homepage: https://github.com/hetyh/owm-sdk-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hetyh/owm-sdk-ruby
+  source_code_uri: https://github.com/hetyh/owm-sdk-ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: An example SDK for accessing OpenWeatherMap API
+test_files: []