petrel 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e4ca7d5b33db5c664a43da5f972104140f04dbed3c31b8b1bef9a79d9491e040
+  data.tar.gz: 4c5959a769371047b594e022d231d4de299df05ec2ef17f082620e248fbf2cef
+SHA512:
+  metadata.gz: 87e5c57a1f86f03a7a61bbfaad34a134155bfa5634024825cfc1e3b45f298abb6763c9e4e791907f39670f33cc62bc7020649c017787acdfd82d053ff1fcf210
+  data.tar.gz: a2ec7a64517c0120b2a20f9a3b0b50ef6d32f5c60781586b2507f5d1f6575392e725e26d59e103906b0a3786692795257b2bd29ed277ef75113c31cb10a25d30

data/.gitignore

@@ -0,0 +1,6 @@
+# Mac nonsense
+.DS_Store
+
+# Don't checkin Gemfile.lock
+# See: http://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2020 John Akers
+
+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,51 @@
+# Petrel
+
+A RubyGem wrapp for [OpenWeatherMap's Free API]((https://openweathermap.org/appid))
+
+### Installation
+
+```rb
+gem install petrel
+```
+
+or in your Gemfile...
+
+```rb
+gem 'petrel'
+```
+
+### Configuration
+
+You will need to set your OpenWeather `api_key`  before making requests. You can get one [here](https://home.openweathermap.org/users/sign_up).
+
+```rb
+Petrel.configure do |c|
+  c.api_key = 'YOUR_API_KEY'
+end
+```
+
+Alternatively, you can do:
+
+```rb
+Petrel.api_token = 'YOUR_API_TOKEN'
+```
+
+### Usage / Examples
+
+Once configured, you have access to the below methods. They correspond to the available endpoints, listed on OpenWeatherMap's API.
+
+```rb
+# 5 day / 3 hour forecast data
+query = { q: 'San Francisco' }
+Petrel.forecat(query)
+
+# One Call
+query = { lat: 37, lon: -122 }
+Petrel.one_call(query)
+
+# Current weather
+query = { lat: 37, lon: -122 }
+Petrel.weather(query)
+```
+
+Full documentation on what can be in `query` can be found in OpenWeatherMap's API documentation [here](https://openweathermap.org/api).

data/lib/petrel/configuration.rb

@@ -0,0 +1,17 @@
+module Petrel
+  module Configuration
+    BASE_URL = 'https://api.openweathermap.org/data/2.5'
+
+    attr_accessor :api_key
+
+    alias appid api_key
+
+    def url
+      BASE_URL
+    end
+
+    def configure
+      yield self
+    end
+  end
+end

data/lib/petrel/forecast.rb

@@ -0,0 +1,7 @@
+module Petrel
+  def self.forecast(params)
+    weather_url = "#{url}/forecast"
+    query = params.merge(appid: appid)
+    HTTParty.get(weather_url, query: query)
+  end
+end

data/lib/petrel/one_call.rb

@@ -0,0 +1,7 @@
+module Petrel
+  def self.one_call(params)
+    one_call_url = "#{url}/onecall"
+    query = params.merge(appid: appid)
+    HTTParty.get(one_call_url, query: query)
+  end
+end

data/lib/petrel/version.rb

@@ -0,0 +1,3 @@
+module Petrel
+  VERSION = '0.0.2'
+end

data/lib/petrel/weather.rb

@@ -0,0 +1,7 @@
+module Petrel
+  def self.weather(params)
+    weather_url = "#{url}/weather"
+    query = params.merge(appid: appid)
+    HTTParty.get(weather_url, query: query)
+  end
+end

data/lib/petrel.rb

@@ -0,0 +1,13 @@
+# files
+require 'petrel/version'
+require 'petrel/configuration'
+require 'petrel/forecast'
+require 'petrel/one_call'
+require 'petrel/weather'
+
+# gems
+require 'httparty'
+
+module Petrel
+  extend Configuration
+end

data/petrel.gemspec

@@ -0,0 +1,28 @@
+$LOAD_PATH.push(File.expand_path('../lib', __FILE__))
+
+require 'petrel/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'petrel'
+  s.version     = Petrel::VERSION
+  s.authors     = ['John Akers']
+  s.homepage    = 'https://github.com/johnakers/petrel'
+  s.summary     = "RubyGem for OpenWeatherMap's current weather"
+  s.description = 'RubyGem wrapper for openweathermap.org'
+  s.licenses    = ['MIT']
+  s.require_paths = ['lib']
+
+  #
+  s.add_dependency('httparty', '~> 0.18.1')
+
+  #
+  s.add_development_dependency('awesome_print', '~> 1.8.0')
+  s.add_development_dependency('rspec', '~> 3.9.0')
+  s.add_development_dependency('pry', '~> 0.13.1')
+
+  # files
+  s.files = `git ls-files`.split("\n")
+
+  # Remove this line for no squawking
+  s.post_install_message = '*squawk* *squawk* Thanks for using Petrel - John'
+end

data/spec/petrel/configuration_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+RSpec.describe Petrel::Configuration do
+  describe '.configure' do
+    it 'returns the set values' do
+      api_key = 'mock_api_key'
+
+      Petrel.configure do |c|
+        c.api_key = api_key
+      end
+
+      expect(Petrel.api_key).to eq(api_key)
+      expect(Petrel.appid).to eq(api_key)
+      expect(Petrel.url).to eq(
+        'https://api.openweathermap.org/data/2.5'
+      )
+    end
+  end
+end

data/spec/petrel/forecast_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+RSpec.describe Petrel do
+  describe '.forecast' do
+    let(:query) do
+      {
+        lat: 37,
+        lon: -122
+      }
+    end
+
+    let(:forecast_response) do
+      double(
+        code: 200,
+        parsed_response: {
+          'cod' => '200',
+          'message' => 0,
+          'cnt' => 40,
+          'city' => {
+            'id' => 5339111,
+            'name' => 'Concord',
+            'coord' => {
+              'lat' => 38,
+              'lon' => -122
+            },
+            'country' => 'US',
+            'population' => 122067,
+            'timezone' => -25200,
+            'sunrise' => 1601820404,
+            'sunset' => 1601862363
+          },
+          'list' => [
+            {
+              'dt' => 1601877600,
+              'main' => {
+                'temp' => 293.98,
+                'feels_like' => 292.18,
+                'temp_min' => 293.98,
+                'temp_max' => 296,
+                'pressure' => 1015,
+                'sea_level' => 1015,
+                'grnd_level' => 1012,
+                'humidity' => 46,
+                'temp_kf' => -2.02
+              },
+              'weather' => [
+                {
+                  'id' => 800,
+                  'main' => 'Clear',
+                  'description' => 'clear
+                  sky',
+                  'icon' => '01n'
+                }
+              ],
+              'clouds' => {
+                'all' => 1
+              },
+              'wind' => {
+                'speed' => 2.18,
+                'deg' => 216
+              },
+              'visibility' => 10000,
+              'pop' => 0,
+              'sys' => {
+                'pod' => 'n'
+              },
+              'dt_txt' => '2020-10-05 06:00:00'
+            }
+          ]
+        }
+      )
+    end
+
+    before do
+      allow(HTTParty).to receive(:get).
+        and_return(forecast_response)
+
+      Petrel.configure do |c|
+        c.api_key = 'mock_api_key'
+      end
+    end
+
+    it 'returns the current weather' do
+      expect(HTTParty).to receive(:get).
+        with("#{Petrel.url}/forecast", query: {
+          lat: 37,
+          lon: -122,
+          appid: Petrel.appid
+        }).
+        and_return(forecast_response)
+
+      Petrel.forecast(query)
+    end
+  end
+end

data/spec/petrel/one_call_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+RSpec.describe Petrel do
+  describe '.one_call' do
+    let(:query) do
+      {
+        lat: 37,
+        lon: -122
+      }
+    end
+
+    let(:one_call_response) do
+      double(
+        code: 200,
+        parsed_response: {
+          'lat' => 37,
+          'lon' => -122,
+          'timezone' => 'America/Los_Angeles',
+          'timezone_offset' => -25200,
+          'current' => {
+            'dt' => 1601879386,
+            'sunrise' => 1601820377,
+            'sunset' => 1601862390,
+            'temp' => 290.77,
+            'feels_like' => 292.82,
+            'pressure' => 1016,
+            'humidity' => 100,
+            'dew_point' => 290.77,
+            'uvi' => 5.78,
+            'clouds' => 1,
+            'visibility' => 10000,
+            'wind_speed' => 0.84,
+            'wind_deg' => 358,
+            'weather' => [
+              {
+                'id' => 800,
+                'main' => 'Clear',
+                'description' => 'clear sky',
+                'icon' => '01n'
+              }
+            ]
+          },
+          'minutely' => [
+            { 'dt'=>1601879400, 'precipitation'=>0 }
+          ],
+          'hourly' => [
+            {
+              'dt' => 1601877600,
+              'temp' => 290.77,
+              'feels_like' => 292.82,
+              'pressure' => 1016,
+              'humidity' => 100,
+              'dew_point' => 290.77,
+              'clouds' => 1,
+              'visibility' => 10000,
+              'wind_speed' => 0.84,
+              'wind_deg' => 358,
+              'weather' => [
+                {
+                  'id' => 800,
+                  'main' => 'Clear',
+                  'description' => 'clear sky',
+                  'icon' => '01n'
+                }
+              ],
+              'pop' => 0
+            }
+          ],
+          'daily' => [
+            {
+              'dt' => 1601838000,
+              'sunrise' => 1601820377,
+              'sunset' => 1601862390,
+              'temp' => {
+                'day' => 299.37,
+                'min' => 290.77,
+                'max' => 302.77,
+                'night' => 290.77,
+                'eve' => 301.85,
+                'morn' => 293.12
+              },
+              'feels_like' => {'day' => 297.62,
+              'night' => 292.82,
+              'eve' => 300.06, 'morn' => 291.88},
+              'pressure' => 1016,
+              'humidity' => 29,
+              'dew_point' => 280.09,
+              'wind_speed' => 1.43,
+              'wind_deg' => 264,
+              'weather' => [
+                {
+                  'id' => 800,
+                  'main' => 'Clear',
+                  'description' => 'clear sky', 'icon' => '01d'
+                }
+              ],
+              'clouds' => 0,
+              'pop' => 0,
+              'uvi' => 5.78
+            }
+          ]
+        }
+      )
+    end
+
+    before do
+      allow(HTTParty).to receive(:get).
+        and_return(one_call_response)
+
+      Petrel.configure do |c|
+        c.api_key = 'mock_api_key'
+      end
+    end
+
+    it 'returns the current weather' do
+      expect(HTTParty).to receive(:get).
+        with("#{Petrel.url}/onecall", query: {
+          lat: 37,
+          lon: -122,
+          appid: Petrel.appid
+        }).
+        and_return(one_call_response)
+
+      Petrel.one_call(query)
+    end
+  end
+end

data/spec/petrel/weather_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+RSpec.describe Petrel do
+  describe '.weather' do
+    let(:query) do
+      {
+        q: 'San Francisco'
+      }
+    end
+
+    let(:weather_response) do
+      double(
+        code: 200,
+        parsed_response: {
+          'coord' => {
+            'lon' => -122,
+            'lat' => 37
+          },
+          'weather' => [
+            {
+              'id' => 801,
+              'main' => 'Clouds',
+              'description' => 'few clouds',
+              'icon' => '02n'
+            }
+          ],
+          'base' => 'stations',
+          'main' => {
+            'temp' => 288.88,
+            'feels_like' => 286.78,
+            'temp_min' => 286.15,
+            'temp_max' => 290.37,
+            'pressure' => 1014,
+            'humidity' => 93
+          },
+          'visibility' => 10000,
+          'wind' => {
+            'speed' => 5.1,
+            'deg' => 300
+          },
+          'clouds' => {
+            'all' => 20
+          },
+          'dt' => 1601805220,
+          'sys' => {
+            'type' => 1,
+            'id' => 5817,
+            'country' => 'US',
+            'sunrise' => 1601820499,
+            'sunset' => 1601862470
+          },
+          'timezone' => -25200,
+          'id' => 5391959,
+          'name' => 'San Francisco',
+          'cod' => 200
+        }
+      )
+    end
+
+    before do
+      allow(HTTParty).to receive(:get).
+        and_return(weather_response)
+
+      Petrel.configure do |c|
+        c.api_key = 'mock_api_key'
+      end
+    end
+
+    it 'returns the current weather' do
+      expect(HTTParty).to receive(:get).
+        with("#{Petrel.url}/weather", query: {
+          q: 'San Francisco',
+          appid: Petrel.appid
+        }).
+        and_return(weather_response)
+
+      Petrel.weather(query)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'pry'
+require 'petrel'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: petrel
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- John Akers
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-10-06 00:00:00.000000000 Z
+dependencies:
+- !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: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !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: RubyGem wrapper for openweathermap.org
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/petrel.rb
+- lib/petrel/configuration.rb
+- lib/petrel/forecast.rb
+- lib/petrel/one_call.rb
+- lib/petrel/version.rb
+- lib/petrel/weather.rb
+- petrel.gemspec
+- spec/petrel/configuration_spec.rb
+- spec/petrel/forecast_spec.rb
+- spec/petrel/one_call_spec.rb
+- spec/petrel/weather_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/johnakers/petrel
+licenses:
+- MIT
+metadata: {}
+post_install_message: "*squawk* *squawk* Thanks for using Petrel - John"
+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.0.3
+signing_key:
+specification_version: 4
+summary: RubyGem for OpenWeatherMap's current weather
+test_files: []