will_it_rain 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzhkYjU4ODhhYWFkZGE2MjE2NmU5YjhlZTZlYjhhYzU4YjBkNmNhMQ==
+  data.tar.gz: !binary |-
+    NWU2MjRjNzQ1ZTgxNDkxOWY5YTRkMzgzMWFjODJiZmUzZDY4MDlhOQ==
+SHA512:
+  metadata.gz: !binary |-
+    Y2UxZjFlMjYxNmZjZDg5YWQ0MWQwOTRiMjZlN2ExY2Y0YmJjNWE5NDZhMWU4
+    NTExNjI1MTU3MGZiMzEyNTFjZmY4NmMxNTBlZTUzNGU2YWJkYTRjMmU5Njk1
+    YzA5YjZjYTRjYzM0M2VmYmNiMjM3NGE5ZWRiNGM2Y2I5MGYwZGI=
+  data.tar.gz: !binary |-
+    NDAxMTFiZDBkMzg2MDc1YjRlZjFjMzM1NTJmMTdmNzExZmRkNGI4ZTA1YjYx
+    NjZjODBlYmE0NWIzMDU2NjZiN2E1MmEwN2IyMmY0NjUyNmZiZmVkMDRjYzRl
+    ZTlkMTQ4Nzc2YTE0YmViYmZjYTJlZmI2YjU0NjM3ZDgzZWJiNzc=

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--order random

data/.ruby-gemset

@@ -0,0 +1 @@
+will_it_rain

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.2.0
+env: RAKE_ENV=test RAILS_ENV=test
+before_install:
+  - 'gem install bundler'
+script:
+  - 'bundle exec rspec'
+notifications:
+  email:
+    recipients:
+      - humzashah+travis@gmail.com
+    on_success: never
+    on_failure: always

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Syed Humza Shah
+
+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,46 @@
+# Will It Rain?
+
+"Will It Rain?" uses [forecast_io](https://github.com/darkskyapp/forecast-ruby) to determine whether or not it will rain (precipitate, more specifically) at a particular location today. This gem was created primarily to isolate logic from a larger project. I hope it helps you in your weather-related Ruby application.
+
+## How does it work?
+
+Different data points are collected from the current day. For each data point, the [probability of precipitation](http://en.wikipedia.org/wiki/Probability_of_precipitation) is considered. If any data point exceeds the threshold, it is considered a "rain day."
+
+## Setup
+
+Add the following to your Gemfile and install:
+
+```ruby
+gem 'will_it_rain'
+```
+
+You will first need to signup on [forecast.io](http://forecast.io) and get an API key. You can set the key as a `FORECAST_IO_API_KEY` environment variable; alternatively you can set the API key in the following way:
+
+```ruby
+require 'forecast_io'
+ForecastIO.api_key = your_api_key
+```
+
+## Usage
+
+Find out if there is a chance of rain today:
+```ruby
+WillItRain.at_location?(latitude, longitude) # returns boolean
+```
+
+The above checks for rain-chances greater than 10% by default. Here is how you can check if chance of rain today is greater than 25%:
+```ruby
+WillItRain.at_location?(latitude, longitude, 25)
+```
+
+Get likelihood of precipitation along with percentage:
+```ruby
+WillItRain.with_chances(latitude, longitude) # returns {it_will_rain: boolean, chances: percentage_string}
+WillItRain.with_chances(latitude, longitude, 5) # compare with a value other than 10%
+```
+
+Get readable summaries of daily data points where precipitation probability exceeds 10%:
+```ruby
+WillItRain.get_summaries(latitude, longitude) # returns array of readable summaries
+WillItRain.get_summaries(latitude, longitude, 25) # adjust default threshold
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "will_it_rain"
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/config/initialize.rb

@@ -0,0 +1,7 @@
+%w{
+  faraday
+  forecast_io
+}.each do |name|
+  file_path = "./initializers/#{name}"
+  require_relative file_path
+end

data/config/initializers/faraday.rb

@@ -0,0 +1,2 @@
+require 'typhoeus/adapters/faraday'
+Faraday.default_adapter = :typhoeus

data/config/initializers/forecast_io.rb

@@ -0,0 +1,2 @@
+require "forecast_io"
+ForecastIO.api_key ||= ENV["FORECAST_IO_API_KEY"]

data/lib/will_it_rain.rb

@@ -0,0 +1,39 @@
+require "will_it_rain/version"
+require_relative "../config/initialize"
+require_relative "./will_it_rain/data_point"
+
+module WillItRain
+  module Default
+    THRESHOLD = 10
+    SUMMARY = "No chance of precipitation today."
+  end
+
+  module_function
+
+  def at_location?(latitude, longtitude, threshold=Default::THRESHOLD)
+    with_chances(latitude, longtitude, threshold)[:it_will_rain]
+  end
+
+  def with_chances(latitude, longtitude, threshold=Default::THRESHOLD)
+    dp = daily_data_points(latitude, longtitude).max_by(&:percentage)
+    {it_will_rain: dp.surpasses_threshold?(threshold), chances: "#{dp.percentage}%"}
+  end
+
+  def get_summaries(latitude, longtitude, threshold=Default::THRESHOLD)
+    data_points = daily_data_points(latitude, longtitude)
+
+    if data_points.any? { |dp| dp.surpasses_threshold?(threshold) }
+      data_points.map(&:summary).uniq
+    else
+      [Default::SUMMARY]
+    end
+  end
+
+  private
+  module_function
+
+  def daily_data_points(latitude, longtitude)
+    forecast = ForecastIO.forecast(latitude, longtitude)
+    forecast.daily.data.map { |dp| DataPoint.new(dp) }
+  end
+end

data/lib/will_it_rain/data_point.rb

@@ -0,0 +1,15 @@
+module WillItRain
+  class DataPoint
+    # percentage refers to likelihood of precipitation
+    attr_accessor :percentage, :summary
+
+    def initialize(data_point)
+      self.percentage = (100 * data_point.precipProbability).round(2)
+      self.summary = data_point.summary
+    end
+
+    def surpasses_threshold?(threshold)
+      percentage >= threshold
+    end
+  end
+end

data/lib/will_it_rain/version.rb

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

data/will_it_rain.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'will_it_rain/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "will_it_rain"
+  spec.version       = WillItRain::VERSION
+  spec.authors       = ["Syed Humza Shah"]
+  spec.email         = ["humzashah+github@gmail.com"]
+
+  spec.summary       = "Use Ruby to determine if it will rain today."
+  spec.homepage      = "https://github.com/humzashah/will_it_rain"
+  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.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency "bundler", ">= 1.7.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency "typhoeus"
+  spec.add_dependency "forecast_io"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: will_it_rain
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Syed Humza Shah
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.6
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: forecast_io
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- humzashah+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/initialize.rb
+- config/initializers/faraday.rb
+- config/initializers/forecast_io.rb
+- lib/will_it_rain.rb
+- lib/will_it_rain/data_point.rb
+- lib/will_it_rain/version.rb
+- will_it_rain.gemspec
+homepage: https://github.com/humzashah/will_it_rain
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Use Ruby to determine if it will rain today.
+test_files: []