wettr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a7c3ea57ba52b516a4686c4b90178aaf530b3f48e3143dc4668ed7d68a5bac01
+  data.tar.gz: 1a71ff41e77ac32f584b3dda778701ac47ba70c5950e51ab36b136cdb55b6f6f
+SHA512:
+  metadata.gz: 69da8dcc34021766bb599ebea106f24ae2067f7ca296d93c0dd68e454dc0cf8539079dc288e7e253f38e1c309a04d391394caa39a103c73c5f1a445a79fb4250
+  data.tar.gz: 1606f750f62a11b9b70dd78bb53215de65ad05779c5c52df0d4e907ee54c31992897b5ed4f308c36003660567bb7f2a2e63b1e17e118ec11d4ba9ebc5b12e02c

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jameswilliamdonovan@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in wettr.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    wettr (0.1.0)
+      dotenv (~> 2.1)
+      httparty (~> 0.18.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    dotenv (2.7.6)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.1104)
+    multi_xml (0.6.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  pry (~> 0.13.1)
+  rake (~> 13.0)
+  rspec (~> 3.10)
+  wettr!
+
+BUNDLED WITH
+   2.2.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 JWDonovan
+
+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,52 @@
+# Wettr
+
+wettr (ˈvɛtɐ, From the German word 'Wetter' meaning weather) is a command line ruby gem to get current weather information using OpenWeatherMap's Current Weather API in conjunction with the ipapi.co IP address API.
+
+wettr can get current weather data using either a zip/postal code or an IP address. Once installed, simply type `wettr` to get started.
+
+## Installation
+
+    $ gem install wettr
+
+## Usage
+
+wettr does not need to be invoked with any parameters to work. Simply type `wettr` and you will get current weather information based on your public IP address.
+Below are some examples of the way wettr can be used:
+```bash
+wettr
+# prints the current weather at your current IP address location
+wettr --zip ZIP_CODE
+# prints the current weather at the given zip code
+wettr --version
+# outputs 'wettr 0.1.0'
+```
+
+To see more usage info, enter `wettr --help`.
+
+## 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.
+
+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).
+
+wettr requires an API key for OpenWeatherMap's Current Weather API.
+To get a key sign up for an account on [their website](https://home.openweathermap.org/users/sign_up).
+Once you have a key, create a `.env` file in the project's root directory.
+Add the following line to the `.env` file:
+
+```bash
+API_KEY=<YOUR_API_KEY_HERE>
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/JWDonovan/wettr. 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/JWDonovan/wettr/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Wettr project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/JWDonovan/wettr/blob/master/CODE_OF_CONDUCT.md).

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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wettr"
+
+# 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
+
+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/exe/wettr

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wettr"
+
+Wettr::CLI.new(ARGV).run

data/lib/wettr.rb

@@ -0,0 +1,13 @@
+require "dotenv/load"
+require "httparty"
+
+module Wettr
+  class Error < StandardError; end
+end
+
+require_relative "./wettr/version"
+require_relative "./wettr/cli"
+require_relative "./wettr/weather"
+require_relative "./wettr/weather_api"
+require_relative "./wettr/ip_api"
+require_relative "./wettr/ip"

data/lib/wettr/cli.rb

@@ -0,0 +1,53 @@
+class Wettr::CLI
+  attr_reader :args
+
+  def initialize(args = nil)
+    @args = args
+  end
+
+  def run
+    if !args.empty?
+      parse_args
+    else
+      ip = Wettr::IP.new_without_ip
+      weather = Wettr::Weather.new_with_lat_and_lon(lat: ip.lat, lon: ip.lon)
+      weather.print
+    end
+  end
+
+  def parse_args
+    if args.include?("--help")
+      print_help_menu
+    elsif args.include?("--version")
+      puts "wettr #{Wettr::VERSION}"
+    elsif zip = args[args.index("--zip") + 1]
+      weather = Wettr::Weather.new_with_zip(zip)
+      weather.print
+    else
+      puts "Please enter a zip code"
+    end
+  end
+
+  def print_help_menu
+    help_text = <<-HELP_TEXT
+    Usage:
+      wettr [options]
+    \nOptions:
+      --help                           # Print this menu
+      --version                        # Print the version number
+      --zip ZIP_CODE                   # Weather by zip/postal code
+    \nDescription:
+      wettr is a command line ruby gem to get current weather information
+      using OpenWeatherMap's Current Weather API in conjunction with the
+      ipapi.co IP address api.
+    \n  wettr can get current weather data using either a zip/postal code
+      or an IP address. Simply type wettr to get started.
+    \nExamples:
+      wettr                            # Weather by current IP address location
+      wettr --zip 10001                # Weather by zip/postal code for New York City
+      wettr --zip 20001                # Weather by zip/postal code for Washington D.C.
+    HELP_TEXT
+    
+    puts help_text
+  end
+end

data/lib/wettr/ip.rb

@@ -0,0 +1,13 @@
+class Wettr::IP
+  attr_reader :address, :lat, :lon
+
+  def initialize(address:, lat:, lon:)
+    @address, @lat, @lon = address, lat, lon
+  end
+
+  def self.new_without_ip
+    response = Wettr::IPAPI.call_without_ip
+    ip = self.new(address: response["ip"], lat: response["latitude"], lon: response["longitude"])
+    ip
+  end
+end

data/lib/wettr/ip_api.rb

@@ -0,0 +1,27 @@
+class Wettr::IPAPI
+  include HTTParty
+  # debug_output STDOUT
+
+  base_uri "https://ipapi.co"
+  # https://ipapi.co/1.1.1.1/json
+
+  def self.call_without_ip
+    response = self.get("/json")
+    
+    if response["error"]
+      puts "Encountered the following error with IPAPI.co:"
+      puts response["reason"]
+      puts response["message"]
+
+      exit
+    end
+
+    response
+  end
+
+  private
+
+  def self.call
+    response = self.class.get("#{ip}/json")
+  end
+end

data/lib/wettr/version.rb

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

data/lib/wettr/weather.rb

@@ -0,0 +1,71 @@
+class Wettr::Weather
+  attr_reader :weather_description, :temp, :feels_like, :temp_min, :temp_max, :pressure, :humidity, :visibility, :wind_speed, :cloudiness, :time_calculated, :country_code, :sunrise_time, :sunset_time, :timezone, :city_id, :city_name
+
+  def initialize(weather_description:, temp:, feels_like:, temp_min:, temp_max:, pressure:, humidity:, visibility:, wind_speed:, cloudiness:, time_calculated:, country_code:, sunrise_time:, sunset_time:, timezone:, city_id:, city_name:)
+    @weather_description = weather_description
+    @temp = temp
+    @feels_like = feels_like
+    @temp_min = temp_min
+    @temp_max = temp_max
+    @pressure = pressure
+    @humidity = humidity
+    @visibility = visibility
+    @wind_speed = wind_speed
+    @cloudiness = cloudiness
+    @time_calculated = time_calculated
+    @country_code = country_code
+    @sunrise_time = sunrise_time
+    @sunset_time = sunset_time
+    @timezone = timezone
+    @city_id = city_id
+    @city_name = city_name
+  end
+
+  def self.new_with_lat_and_lon(lat:, lon:)
+    response = Wettr::WeatherAPI.call_with_lat_and_lon(lat: lat, lon: lon)
+    weather = self.new_from_api_response(response)
+    weather
+  end
+
+  def self.new_with_zip(zip)
+    response = Wettr::WeatherAPI.call_with_zip(zip)
+    weather = self.new_from_api_response(response)
+    weather
+  end
+
+  def print
+    puts "Current weather for #{ @city_name.capitalize }, #{ @country_code }"
+    puts "Description: #{ @weather_description.capitalize }"
+    puts "#{ @temp }°F, Feels Like: #{ @feels_like }°F, Min. Temp: #{ @temp_min }°F, Max. Temp: #{ @temp_max }°F"
+    puts "Pressure: #{ @pressure } hPa, Humidity: #{ @humidity }%"
+    puts "Visibility: #{ @visibility.to_s.reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse } Ft., Wind Speed: #{ @wind_speed } m/h, Cloudiness: #{ @cloudiness }%"
+    puts "Sunrise: #{ Time.at(@sunrise_time).strftime("%k:%M") }, Sunset: #{ Time.at(@sunset_time).strftime("%k:%M") }"
+    puts "Weather Last Calculated at #{ Time.at(@time_calculated).strftime("%k:%M") }"
+  end
+
+  private
+
+  def self.new_from_api_response(response)
+    weather = self.new(
+      weather_description: response["weather"].first["description"],
+      temp: response["main"]["temp"],
+      feels_like: response["main"]["feels_like"],
+      temp_min: response["main"]["temp_min"],
+      temp_max: response["main"]["temp_max"],
+      pressure: response["main"]["pressure"],
+      humidity: response["main"]["humidity"],
+      visibility: response["visibility"],
+      wind_speed: response["wind"]["speed"],
+      cloudiness: response["clouds"]["all"],
+      time_calculated: response["dt"],
+      country_code: response["sys"]["country"],
+      sunrise_time: response["sys"]["sunrise"],
+      sunset_time: response["sys"]["sunset"],
+      timezone: response["timezone"],
+      city_id: response["id"],
+      city_name: response["name"]
+    )
+
+    weather
+  end
+end

data/lib/wettr/weather_api.rb

@@ -0,0 +1,24 @@
+class Wettr::WeatherAPI
+  include HTTParty
+  # debug_output STDOUT
+
+  base_uri "https://api.openweathermap.org"
+  default_params appid: ENV["API_KEY"], units: "imperial"
+
+  def self.call_with_lat_and_lon(lat:, lon:)
+    @options = { query: { lat: lat, lon: lon } }
+    call
+  end
+
+  def self.call_with_zip(zip)
+    @options = { query: { zip: zip } }
+    call
+  end
+
+  private
+  
+  def self.call
+    response = self.get("/data/2.5/weather", @options)
+    response
+  end
+end

data/wettr.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative "lib/wettr/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "wettr"
+  spec.version       = Wettr::VERSION
+  spec.authors       = ["JWDonovan"]
+  spec.email         = ["jameswilliamdonovan@gmail.com"]
+
+  spec.summary       = "Fetches weather data using the OpenWeatherMap API"
+  spec.homepage      = "https://github.com/JWDonovan/wettr"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage + "/blob/main/CHANGELOG.md"
+
+  # 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.executables << "wettr"
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dotenv", "~> 2.1"
+  spec.add_dependency "httparty", "~> 0.18.1"
+  
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "pry", "~> 0.13.1"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: wettr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- JWDonovan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+description: 
+email:
+- jameswilliamdonovan@gmail.com
+executables:
+- wettr
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- NOTES.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/wettr
+- lib/wettr.rb
+- lib/wettr/cli.rb
+- lib/wettr/ip.rb
+- lib/wettr/ip_api.rb
+- lib/wettr/version.rb
+- lib/wettr/weather.rb
+- lib/wettr/weather_api.rb
+- wettr.gemspec
+homepage: https://github.com/JWDonovan/wettr
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/JWDonovan/wettr
+  source_code_uri: https://github.com/JWDonovan/wettr
+  changelog_uri: https://github.com/JWDonovan/wettr/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.2
+signing_key: 
+specification_version: 4
+summary: Fetches weather data using the OpenWeatherMap API
+test_files: []