open_weather_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7e71860d474b67b88ec968c56ca18bfcd98029b9078bbd73fef481bd1dcf8736
+  data.tar.gz: 8eb818af6393f4cbbac4dddea37800911ebe58a0dd10bc323f337251596cd088
+SHA512:
+  metadata.gz: 85a0e87c06cfa1753b6c3b2baaa251fd864fc03e50af861b86d015dc5a37739f043361c82fafea26794877b0652821a65b27f04efaab905ffb903bca22fedba5
+  data.tar.gz: 31ad8150d112bfcfd0b7b5e0b62830d3d5336968a76754dad1dc16e255ff0916901fd176fe8557688492101e2ed147392210cda1e4c6dd1920166d3c1bff477b

data/.gemrc

@@ -0,0 +1,8 @@
+---
+:backtrace: false
+:bulk_threshold: 1000
+:sources:
+- https://rubygems.org/
+- https://USERNAME:TOKEN@rubygems.pkg.github.com/qurasoft/
+:update_sources: true
+:verbose: true

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '20 21 * * 1'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/.idea/
+
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/CHANGES.md

@@ -0,0 +1,6 @@
+# Open Weather Client Changelog
+
+## 0.1.0
+- Initial commit of the Open Weather Client gem
+- Configuration of OpenWeatherClient
+- Request current weather with `OpenWeatherClient.current(lat:, lon:)`

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in open_weather_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Qurasoft GmbH
+
+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,70 @@
+# Open Weather Client
+
+[![Gem Version](https://badge.fury.io/rb/open_weather_client.svg)](https://badge.fury.io/rb/open_weather_client)
+![RSpec](https://github.com/qurasoft/open_weather_client/actions/workflows/ruby.yml/badge.svg)
+
+Welcome to Open Weather Client. This gem allows you to easily send messages from your ruby project to Microsoft Teams channels.
+It integrates in your rails project, when you are using bundler or even in plain ruby projects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'open_weather_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install open_weather_client
+
+## Usage
+During configuration the OpenWeatherMap API key must be set. Afterwards it is as simple as calling `OpenWeatherClient.current(lat:, lon:)` to get the current weather at a location.
+
+```ruby
+# OpenWeatherClient initializer
+OpenWeatherClient.configure do |config|
+  config.appid = "1234567890"
+end
+
+# Receive the current weather in Koblenz
+OpenWeatherClient::Weather.current(lat: 50.3569, lon: 7.5890)
+```
+
+### Secure Configuration
+In Rails provides the credentials functionality for [environmental security](https://edgeguides.rubyonrails.org/security.html#environmental-security). This mechanism can be used by OpenWeatherClient to load the API key from an encrypted file. This also allows easy separation of production and development channel configuration.
+All settings are defined under the top-level entry `open_weather_client`.
+```yaml
+# $ bin/rails credentials:edit
+open_weather_client:
+  appid: "<INSERT OPENWEATHERMAP API KEY HERE>"
+```
+
+After configuration of the credentials you can load the settings in your initializer with `#load_from_rails_configuration`.
+
+```ruby
+# OpenWeatherClient initializer
+OpenWeatherClient.configure do |config|
+  config.load_from_rails_credentials
+end
+```
+
+## Development
+
+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.
+
+You can define the client settings you use for testing in the file `bin/config.yml` or directly in the `bin/console` script.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/qurasoft/open_weather_client. 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.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/.gitignore

@@ -0,0 +1 @@
+config.yml

data/bin/console

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'open_weather_client'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+OpenWeatherClient.configure do |config|
+  if File.exist?('config.yml')
+    # NOTE(Keune): The channels available in the console can be set in the file channels.yml. It contains a simple
+    # mapping of channel identifiers to webhook URLs. The channel identifier is loaded as a symbol.
+    #
+    # Example: APPID: "<INSERT YOUR WEBHOOK URL HERE>"
+    puts 'Load channels specified by file'
+
+    require 'yaml'
+    settings = YAML.load_file 'config.yml'
+    config.appid = settings['APPID']
+  end
+end
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/open_weather_client/configuration.rb

@@ -0,0 +1,21 @@
+module OpenWeatherClient
+  class Configuration
+    attr_accessor :appid, :lang, :units, :url, :user_agent
+
+    def initialize
+      @lang = 'de'
+      @units = 'metric'
+      @url = 'https://api.openweathermap.org/data'
+      @user_agent = "Open Weather Client/#{OpenWeatherClient::VERSION}"
+    end
+
+    def load_from_rails_credentials
+      unless defined? Rails
+        raise RuntimeError, 'This method is only available in Ruby on Rails.'
+      end
+
+      settings = Rails.application.credentials.open_weather_client!
+      self.appid = settings[:appid]
+    end
+  end
+end

data/lib/open_weather_client/version.rb

@@ -0,0 +1,3 @@
+module OpenWeatherClient
+  VERSION = "0.1.0"
+end

data/lib/open_weather_client/weather.rb

@@ -0,0 +1,27 @@
+require 'faraday'
+
+module OpenWeatherClient
+  class Weather
+    def self.current(lat:, lon:)
+      connection = Faraday.new(
+        url: OpenWeatherClient.configuration.url,
+        params: {
+          appid: OpenWeatherClient.configuration.appid,
+          lat: lat,
+          lon: lon,
+          lang: OpenWeatherClient.configuration.lang,
+          units: OpenWeatherClient.configuration.units
+        },
+        headers: {
+          'User-Agent': OpenWeatherClient.configuration.user_agent
+        }
+      ) do |f|
+        f.response :json
+      end
+
+      response = connection.get('2.5/weather')
+
+      response.body
+    end
+  end
+end

data/lib/open_weather_client.rb

@@ -0,0 +1,38 @@
+require 'open_weather_client/configuration'
+require 'open_weather_client/version'
+require 'open_weather_client/weather'
+
+module OpenWeatherClient
+  class << self
+    attr_accessor :configuration, :testing
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.project_root
+    if defined?(Rails)
+      return Rails.root
+    end
+
+    if defined?(Bundler)
+      return Bundler.root
+    end
+
+    Dir.pwd
+  end
+
+  def self.gem_root
+    spec = Gem::Specification.find_by_name("open_weather_client")
+    spec.gem_dir rescue project_root
+  end
+end

data/open_weather_client.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "open_weather_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "open_weather_client"
+  spec.version       = OpenWeatherClient::VERSION
+  spec.authors       = ["Lucas Keune"]
+  spec.email         = ["lucas.keune@qurasoft.de"]
+
+  spec.summary       = %q{Access weather data from OpenWeatherMap}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/Qurasoft/open_weather_client"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/Qurasoft/open_weather_client"
+    spec.metadata["changelog_uri"] = "https://github.com/Qurasoft/open_weather_client/blob/main/CHANGES.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  # 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
+    `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_dependency "faraday", ">= 2"
+
+  spec.add_development_dependency "bundler", ">= 1.17"
+  spec.add_development_dependency "rake", ">= 10.0"
+  spec.add_development_dependency "rspec", ">= 3.0"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: open_weather_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lucas Keune
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- lucas.keune@qurasoft.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gemrc"
+- ".github/workflows/codeql-analysis.yml"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGES.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/.gitignore
+- bin/console
+- bin/setup
+- lib/open_weather_client.rb
+- lib/open_weather_client/configuration.rb
+- lib/open_weather_client/version.rb
+- lib/open_weather_client/weather.rb
+- open_weather_client.gemspec
+homepage: https://github.com/Qurasoft/open_weather_client
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Qurasoft/open_weather_client
+  source_code_uri: https://github.com/Qurasoft/open_weather_client
+  changelog_uri: https://github.com/Qurasoft/open_weather_client/blob/main/CHANGES.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key: 
+specification_version: 4
+summary: Access weather data from OpenWeatherMap
+test_files: []