forecast 0.0.7 → 0.0.8

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MmVhOTY5N2E5MTc3N2Y5NzBlZGIxNGQ5NWJiYjE2MjAwOTM1NWJhNA==
-  data.tar.gz: !binary |-
-    ZjFiMjJiMzIwMjQyNzQxNmI5NWNjMWUzYWU1NzExNzVjZGNhNmJkOQ==
+SHA1:
+  metadata.gz: 7bedac729e0633e851903429abe9b90e389bf394
+  data.tar.gz: 0ee0e0f0ca1791b76cb5e85623b524f3bb3b8d6d
 SHA512:
-  metadata.gz: !binary |-
-    ZDBmNjUwYjgzZjQxNjVmNjhhZGZjMGJlOTA3MGUzODZhZWM1OTM3OTQ0ZTYx
-    OTI0OGJjODA1MTIxNjVlYjgxNDEyZThmZmM4Mzc5NzdhYWRlZTExYTMzNTc5
-    MzdjNzc2ZmViOTAwY2Q0ODFkZWY0YTdhN2RlMWJjMWUwN2JiMDg=
-  data.tar.gz: !binary |-
-    YTJhODdhMTI3OTU2Yzk4ZTY4MjAxNDAxYTRlZDE5ODA4ZTRkZDhlM2JjNTNk
-    ZmNiNzIxODA0YjlmOTQ3YWE2MzNlMTU5NDQwYjFmYWZiOGY3ODM3NTAwYzM0
-    MjAyN2FjM2UwMTk3MTg0NjYwZTMwZWY4ZGRiMDA0MDI3NDY5MWM=
+  metadata.gz: 10567a96c75d32e09fcc00f6d4ffdefcc8e56ae932b8245f2918473f82c9ca32c39afcd2ea16cf8167e50c3d995a9571c59b2bbcea02db77c8cf3f919abd5c2c
+  data.tar.gz: 7ec7db3da9a5faa99e42abe359fab5a8760b3296cbd721e58b128bd6d65d3d0001ee0bba6d386f78dc376df9d4acfeb28f5c0aa47230e5ca8bd106f11ea5bd7f

data/.gitignore

@@ -16,4 +16,14 @@ test/tmp
 test/version_tmp
 tmp
 .README.md.html
-dump.rdb
+dump.rdb
+
+# Eclipse
+.project
+
+# GFM Preview
+.README.md.html
+.CHANGELOG.md.html
+
+# API Test keys
+api_keys.txt

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+forecast
+--------
+
+> Changelog
+
+## Master
+
+## Enhancements
+
+* Basic command line interface
+* Added forecast.io adapter
+* Improved auto-mapping of conditions 
+
+## Bugfix
+
+* Fixed missing string conversion in average temperature
+* Fixed cache inconsistencies by caching http response instead of results
+
+## Deprecation
+
+* Removed option `prefix` from cache
+* Renamed method current to currently
+* Changed default scale to `celsius`
+
+## v0.0.7
+
+* Initial release introducing core-functionality

data/README.md

@@ -1,19 +1,148 @@
 forecast
 ========
 
-A Forecast-Multi-API-Wrapper with a unified model and integrated caching
+> Forecast Multi-API-Wrapper with unified model and integrated caching
 
+## API Support
 
-Integrating with rails
-----------------------
+* Open Weather Map
+* Yahoo RSS
+* Forecast.io
+* Wunderground
 
-#### Quick start
 
-Add weather-icons theme to your stylesheets from cdn
+## Fetch
+
+#### Forecast.current( latitude, longitude )
+Get the current weather for a specified location
+```ruby
+forecast = Forecast.current(54.9999, 9.534)
+```
+
+#### Forecast.hourly( latitude, longitude )
+Get hourly forecasts for a specified location
+```ruby
+forecasts = Forecast.hourly(54.9999, 9.534)
+```
+
+
+#### Forecast.daily( latitude, longitude )
+Get daily forecasts for a specified location
+```ruby
+forecasts = Forecast.daily(54.9999, 9.534)
+```
+
+### Collections
+
+#### ForecastCollection.select_time( date )
+Fetches forecast for the specified date from a collection.
+```ruby
+forecast = Forecast.daily(54.9999, 9.534).select_time(Time.now + (24 * 60 * 60) * 2)
+```
+
+## Model
+
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td>condition</td>
+    <td>Condition string identifier.</td>
+  </tr>
+  <tr>
+    <td>time</td>
+    <td>DateTime of the forecast</td>
+  </tr>
+  <tr>
+    <td>icon</td>
+    <td>Returns icon identifier</td>
+  </tr>
+  <tr>
+    <td>latitude</td>
+    <td>Location coordinate latitude</td>
+  </tr>
+  <tr>
+    <td>longitude</td>
+    <td>Location coordinate longitude</td>
+  </tr>
+  <tr>
+    <td>temperature</td>
+    <td>Temperature</td>
+  </tr>
+  <tr>
+    <td>temperature_min</td>
+    <td>Minimum Temperature</td>
+  </tr>
+  <tr>
+    <td>temperature_max</td>
+    <td>Maximum Temperature</td>
+  </tr>
+</table>
+
+
+## Conditions
+
+<table>
+  <tr>
+    <th>Code</th>
+    <th>Name</th>
+  </tr>
+  <tr>
+    <td>100</td>
+    <td>Clear</td>
+  </tr>
+  <tr>
+    <td>200</td>
+    <td>Partly Cloudy</td>
+  </tr>
+  <tr>
+    <td>210</td>
+    <td>Cloudy</td>
+  </tr>
+  <tr>
+    <td>220</td>
+    <td>Mostly Cloudy</td>
+  </tr>
+  <tr>
+    <td>300</td>
+    <td>Light Rain</td>
+  </tr>
+  <tr>
+    <td>310</td>
+    <td>Rain</td>
+  </tr>
+  <tr>
+    <td>320</td>
+    <td>Heavy Rain</td>
+  </tr>
+  <tr>
+    <td>400</td>
+    <td>Light Snow</td>
+  </tr>
+  <tr>
+    <td>410</td>
+    <td>Snow</td>
+  </tr>
+  <tr>
+    <td>500</td>
+    <td>Storm</td>
+  </tr>
+</table>
+
+
+## Themes
+Bundled with the plugin is an icon-mapping for [weather_icons](http://erikflowers.github.io/weather-icons/)
+
+## Rails Integration
+
+##### Add weather-icons theme to your stylesheets
 ```erb
 <%= stylesheet_link_tag "http://cdnjs.cloudflare.com/ajax/libs/weather-icons/1.2/css/weather-icons.css", media: "all", "data-turbolinks-track" => true %>
 ```
-Create a forecast-helper
+
+##### Create a forecast-helper
 ```ruby
 module ApplicationHelper
   def forecast(latitude, longitude, date)
@@ -23,10 +152,69 @@ module ApplicationHelper
 end
 ```
 
-Create a view
+##### Create a view
 ```erb
 <h1>Forecast Test</h1>
 <p>
   The weather of tomorrow in New York: <%= forecast(41.145495, -73.994901, Time.now + 60*60*24) %>
 </p>
-```
+```
+
+#### Example Configuration
+
+```ruby
+# config/initializers/forecast.rb
+Forecast::configure do |config|
+  config.config_file = Rails.root.to_s + "/config/forecast.yml"
+  config.cache = {
+    expire: 1 * 60 * 60, 
+    url: "redis://xxx/"
+  }
+end
+```
+
+```yml
+# config/forecast.yml
+forecast:
+  temperature: celsius
+  theme: custom_theme
+  themes: 
+    custom_theme:
+      Clear: 'icon-clear'
+      Light Rain: 'icon-rain'
+      Rain: 'icon-rain'
+      Heavy Rain: 'icon-rain'
+      Partly Cloudy: 'icon-cloudy'
+      Cloudy: 'icon-cloudy'
+      Mostly Cloudy: 'icon-cloudy'
+      Light Snow: 'icon-snow'
+      Snow: 'icon-snow'
+      Heavy Snow: 'icon-snow'
+      Thunderstorm: 'icon-thunderstorm'
+```
+
+## Command Line Interface
+
+```cli
+Usage: forecast COMMAND [OPTIONS]
+
+Commands
+     current: get current weather
+     daily: get daily forecasts
+     hourly: get hourly forecasts
+
+Options
+    -l, --location LAT,LNG           Location
+    -p, --provider PROVIDER          Supported API Providers: forecast_io, open_weather_map, wunderground, yahoo
+    -a, --api_key API_KEY            Apply an api key if neccessary
+    -s, --scale SCALE                Scale: one of celsius, fahrenheit or kelvin
+```
+
+## Run Tests
+To run the tests execute `rspec spec` from the command line
+```cli
+rspec spec
+```
+
+## Changelog
+See the [Changelog](CHANGELOG.md) for recent enhancements, bugfixes and deprecations.

data/bin/forecast

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'forecast'
+require 'optparse'
+require 'ostruct'
+
+# Get Constants
+providers = Dir.glob(lib + '/forecast/adapters/*.*').map{ |f| File.basename(f, '_adapter.rb') };
+
+# Parse Arguments
+options = OpenStruct.new
+optparser = OptionParser.new do |opt|
+  opt.banner = "Usage: forecast COMMAND [OPTIONS]"
+  opt.separator  ""
+  opt.separator  "Commands"
+  opt.separator  "     current: get current weather [default]"
+  opt.separator  "     daily: get daily forecasts"
+  opt.separator  "     hourly: get hourly forecasts"
+  opt.separator  ""
+  opt.separator  "Options"
+
+  opt.on('-l', '--location LAT,LNG', 'Location [required]') { |o| options.location = o }
+  opt.on('-p', '--provider PROVIDER', 'Supported API Providers: ' + Forecast::PROVIDERS.join(', ')) { |p| options.provider = p }
+  opt.on('-a', '--api_key API_KEY', 'Apply an api key if neccessary') { |a| options.api_key = a }
+  opt.on('-s', '--scale SCALE', 'Scale: one of celsius, fahrenheit or kelvin') { |s| options.scale = s }
+  opt.on('-h', '--help', 'Displays Help') do
+    puts opt
+    exit
+  end
+end
+
+optparse = optparser.parse!
+
+# Init command
+command = ARGV.shift
+
+# Use current as default command if a location has specified
+if !command && options.location.nil?
+  puts optparser.to_s
+  exit
+else
+  command = 'current'
+end
+
+# Show errors on missing mandatory options
+mandatory = [:location]                            
+mandatory.each{ |param|      
+  if options[param].nil?
+    puts "#{param.capitalize} must be specified"              
+    exit
+  end
+}
+
+
+# Setup Options
+location = options.location.split(/,\s*/)
+latitude = location[0].to_f
+longitude = location[1].to_f
+
+# Configure Forecast
+Forecast.configure do |config|
+  config.scale = options.scale.to_sym if options.scale
+  config.provider = options.provider.to_sym if options.provider
+  if options.api_key
+    config.adapters||= {}
+    config.adapters[config.provider] = {
+      api_key: options.api_key
+    }
+  end
+end
+
+# Get forecasts
+forecasts  = []
+case command
+  when 'current'
+    forecasts = [Forecast.current(latitude, longitude)]
+  when 'daily'
+    forecasts = Forecast.daily(latitude, longitude)
+  when 'hourly'
+    forecasts = Forecast.hourly(latitude, longitude)
+  else
+end
+
+# Output
+forecasts.each do |forecast|
+  if forecast != nil
+    puts forecast.time.strftime("%F %T") + " | " + forecast.temperature.to_s + "° | " + forecast.condition.to_s
+  else
+    puts 'nil'
+  end
+end

data/forecast.gemspec

@@ -8,13 +8,14 @@ Gem::Specification.new do |spec|
   spec.version       = Forecast::VERSION
   spec.authors       = ["Rafael Nowrotek"]
   spec.email         = ["mail@benignware.com"]
-  spec.summary       = %q{A Forecast-Multi-API-Wrapper with a unified model and integrated caching}
-  spec.description   = %q{A Forecast-Multi-API-Wrapper with a unified model and integrated caching}
+  spec.summary       = %q{Forecast Multi-API-Wrapper with unified model and integrated caching}
+  spec.description   = %q{Forecast Multi-API-Wrapper with unified model and integrated caching}
   spec.homepage      = ""
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  #spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   = ["forecast"]  
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]