weather_judge 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a7cc48f83c00173d4ac5eb1d72ccb336b8ea206
+  data.tar.gz: 25131c80b1435c676367b06be003f62bbb5c950b
+SHA512:
+  metadata.gz: 131fdfde7a5ad13aa8478df225e564f1a661147d224d215b6d71010033287d38dac31fc1cc9216405fd9f90d8a2a1c4de8041d01b63a745f37cdba92532a3aca
+  data.tar.gz: de6e5d2dd793f317d9b645867c1b669d9051e28ea564d240ed85769818be15663c2d3924ddbaa28f71bb16bb240f50cc663a7819221669028b057fafebda8c89

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in weather_judge.gemspec
+gemspec
+
+gem 'forecast_io'
+
+ruby '2.3.1'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Makoto Scott-Hinkle
+
+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,84 @@
+# WeatherJudge
+
+This gem retrieves weather forecasting data from Forecast.IO via [forecast-ruby](https://github.com/darkskyapp/forecast-ruby) 
+using longitude and latitude and returns an overall score. The following criteria are used to judge
+the quality of weather. The total score is up to 100. 
+
+- Temperature
+- Sky Cover
+- Wind speed
+- Change of Rain
+
+Currently it only evaluates today's data but I plan on adding an ability to take a specified date. This is 
+more of a proof of concept at this point. Since there are four criteria at the moment, each of them holds
+up to 25 points. Optimal weather is considered as a day with comfortable temperature, less than 15 mph wind, 
+low chance of rain, and low sky cover.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'weather_judge'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install weather_judge
+
+## Usage
+`WeatherJudge` returns overall weather score, and scores of weather aspect. 
+
+Please see [Forecast IO's documentation](https://developer.forecast.io/) for creating an api key. 
+
+```ruby
+WeatherJudge.forecast_io_api_key = '(your api key here)'
+data = WeatherJudge.run(44, -122)
+# => Returns `WeatherData` object
+
+data.total_location_score
+# => returns a score of 0 - 100
+```
+
+Available methods for `WeatherData`
+- `raw_data`
+- `total_location_score`
+- `cloud_cover_score`
+- `wind_score`
+- `temperature_score`
+- `percent_rain_score`
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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).
+
+## Future Plans/Disclaimer
+The current state of this gem is more of a proof of concept. This gem was originally developed to be
+used in my personal project for ranking overall weather of different locations, but feel free to use 
+it for any purpose. This gem will be evolving in the near future. A couple of obvious future plans are:
+ - Add ability to change preferred weather aspects for scoring
+ - Add ability to specify a date for retrieving scored data
+
+## Contributing
+ 
+Bugs and pull requests are welcome, but if you want to make significant changes, please fork this project 
+and make changes there until you are satisfied, and then create a pull request. Please remember to add
+tests. :)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Copyright
+Copyright (c) 2016 Makoto Scott-Hinkle. Please see LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

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/weather_judge/configuration.rb

@@ -0,0 +1,9 @@
+module WeatherJudge
+  module Configuration
+    attr_writer :forecast_io_api_key
+
+    def forecast_io_api_key
+      @forecast_io_api_key
+    end
+  end
+end

data/lib/weather_judge/version.rb

@@ -0,0 +1,3 @@
+module WeatherJudge
+  VERSION = "0.1.1"
+end

data/lib/weather_judge/weather_data.rb

@@ -0,0 +1,55 @@
+# Calculates score for 4 different weather aspects: sky cover,
+# chance of rain, wind, and temperature
+
+module WeatherJudge
+  class WeatherData
+    SCORE_WEIGHT = 25
+
+    def initialize(forecast_today)
+      @forecast_today = forecast_today
+    end
+
+    # Returns raw forecast data object
+    def raw_data
+      @forecast_today
+    end
+
+    # Returns total location score based on forecast. It is the sum of
+    # cloud cover score, percent rain score, wind score, and temperature score.
+    def total_location_score
+      cloud_cover_score + percent_rain_score + wind_score + temperature_score
+    end
+
+    def cloud_cover_score
+      @forecast_today.cloudCover * SCORE_WEIGHT
+    end
+
+    def percent_rain_score
+      @forecast_today.precipProbability * SCORE_WEIGHT
+    end
+
+    def wind_score
+      wind_speed = @forecast_today.windSpeed
+      max_wind_speed = 15.to_f
+      if wind_speed == 0
+        SCORE_WEIGHT
+      elsif wind_speed < max_wind_speed
+        ((max_wind_speed - wind_speed) / max_wind_speed) * SCORE_WEIGHT
+      else
+        0
+      end
+    end
+
+    def temperature_score
+      max_temperature = @forecast_today.temperatureMax
+
+      if max_temperature > 67 && max_temperature < 77
+        SCORE_WEIGHT
+      elsif max_temperature > 55 && max_temperature < 67 || max_temperature > 77 && max_temperature < 85
+        SCORE_WEIGHT.to_f / 2
+      else
+        SCORE_WEIGHT.to_f / 4
+      end
+    end
+  end
+end

data/lib/weather_judge.rb

@@ -0,0 +1,20 @@
+require "weather_judge/version"
+require 'forecast_io'
+require 'weather_judge/weather_data'
+require 'weather_judge/configuration'
+
+module WeatherJudge
+  extend Configuration
+
+  class << self
+
+    # Retrieves WeatherData object for today's forecast given latitude and longitude.
+    def run(latitude, longitude)
+      ForecastIO.api_key = WeatherJudge.forecast_io_api_key
+      forecast = ForecastIO.forecast(latitude, longitude, params: { exclude: 'hourly,minutely,alerts,flags'})
+      @forecast_today = forecast.daily.data.first
+
+      WeatherData.new(@forecast_today)
+    end
+  end
+end

data/weather_judge.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'weather_judge/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "weather_judge"
+  spec.version       = WeatherJudge::VERSION
+  spec.authors       = ["Makoto Scott-Hinkle"]
+  spec.email         = ["makoto.scotthinkle@gmail.com"]
+  spec.homepage      = "https://github.com/makotogitdev/weather-judge"
+
+  spec.summary       = %q{Scores weather forecast on given coordinates.}
+  spec.description   = %q{This gem gives a score to given coordinate's weather forecast. It uses Forecast.IO as data source.}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: weather_judge
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Makoto Scott-Hinkle
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: This gem gives a score to given coordinate's weather forecast. It uses
+  Forecast.IO as data source.
+email:
+- makoto.scotthinkle@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/weather_judge.rb
+- lib/weather_judge/configuration.rb
+- lib/weather_judge/version.rb
+- lib/weather_judge/weather_data.rb
+- weather_judge.gemspec
+homepage: https://github.com/makotogitdev/weather-judge
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Scores weather forecast on given coordinates.
+test_files: []