darksky 1.0.3 → 1.0.4

data/CHANGELOG.markdown

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 1.0.4
+
+* Added `brief_forecast` API endpoint to return a brief forecast for the latitude and longitude.
+
 ## 1.0.3
 
 * Added `interesting` API endpoint to return a list of interesting storms happening right now.

data/README.markdown

@@ -16,11 +16,14 @@ gem 'darksky'
 ## Usage
 
 ```ruby
-darksky = Darksky::API.new('d41d8cd98f00b204e9800998ecf8427e')
+darksky = Darksky::API.new('this-is-your-dark-sky-api-key')
 
 # Returns a forecast for the next hour at a given location.
 forecast = darksky.forecast('42.7243','-73.6927')
 
+# Returns a brief forecast for the next hour at a given location.
+brief_forecast = darksky.brief_forecast('42.7243','-73.6927')
+
 # Returns forecasts for a collection of arbitrary points.
 precipitation = darksky.precipitation(['42.7','-73.6',1325607100,'42.0','-73.0',1325607791])
 

data/lib/darksky/api.rb

@@ -24,6 +24,16 @@ module Darksky
       JSON.parse(response.body) if response.code == 200
     end
 
+    # Returns a brief forecast for the next hour at a given location.
+    #
+    # @param latitude [String] Latitude in decimal degrees.
+    # @param longitude [String] Longitude in decimal degrees.
+    # @param option [Hash] (Optional) Options to be passed to the Typhoeus::Request
+    def brief_forecast(latitude, longitude, options = {})
+      response = Typhoeus::Request.get("#{DARKSKY_API_URL}/brief_forecast/#{@api_key}/#{latitude},#{longitude}", DEFAULT_OPTIONS.dup.merge(options))
+      JSON.parse(response.body) if response.code == 200
+    end
+
     # Returns forecasts for a collection of arbitrary points.
     #
     # @param latitudes_longitudes_times [Array] Triplets of latitude, longitude and time. Example: ['42.7','-73.6',1325607100,'42.0','-73.0',1325607791]

data/lib/darksky/version.rb

@@ -1,3 +1,3 @@
 module Darksky
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/spec/cassettes/brief_forecast.yml

@@ -0,0 +1,28 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.darkskyapp.com/v1/brief_forecast/this-is-your-dark-sky-api-key/42.7243,-73.6927
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Powered-By:
+      - Express
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '95'
+      Connection:
+      - keep-alive
+    body:
+      encoding: ASCII-8BIT
+      string: ! '{"isPrecipitating":false,"minutesUntilChange":0,"currentSummary":"clear","hourSummary":"clear"}'
+    http_version: '1.1'
+  recorded_at: Fri, 16 Mar 2012 20:19:37 GMT
+recorded_with: VCR 2.0.0

data/spec/darksky/api_spec.rb

@@ -13,6 +13,16 @@ describe Darksky::API do
     end
   end
 
+  describe '#brief_forecast' do
+    it 'should return a valid brief forecast for a latitude and longitude' do    
+      VCR.use_cassette('brief_forecast', :record => :once) do
+        forecast = darksky_api.brief_forecast('42.7243','-73.6927')
+        forecast['currentSummary'].should == 'clear'
+        forecast['hourSummary'].should == 'clear'
+      end
+    end
+  end
+
   describe '#precipitation' do
     it 'should return forecasts for a collection of arbitrary points' do
       VCR.use_cassette('precipitation', :record => :once) do

data/spec/darksky/version_spec.rb

@@ -2,6 +2,6 @@ require 'spec_helper'
 
 describe Darksky::VERSION do
   it 'should be the correct version' do
-    Darksky::VERSION.should == '1.0.3'
+    Darksky::VERSION.should == '1.0.4'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: darksky
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-16 00:00:00.000000000 Z
+date: 2012-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
-  requirement: &70289250869220 !ruby/object:Gem::Requirement
+  requirement: &2153405100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70289250869220
+  version_requirements: *2153405100
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70289250868760 !ruby/object:Gem::Requirement
+  requirement: &2153404240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70289250868760
+  version_requirements: *2153404240
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70289250868320 !ruby/object:Gem::Requirement
+  requirement: &2153403480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70289250868320
+  version_requirements: *2153403480
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70289250867900 !ruby/object:Gem::Requirement
+  requirement: &2153402800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70289250867900
+  version_requirements: *2153402800
 description: Ruby gem for retrieving data from the Dark Sky API
 email:
 - me@davidczarnecki.com
@@ -73,6 +73,7 @@ files:
 - lib/darksky.rb
 - lib/darksky/api.rb
 - lib/darksky/version.rb
+- spec/cassettes/brief_forecast.yml
 - spec/cassettes/forecast.yml
 - spec/cassettes/interesting.yml
 - spec/cassettes/precipitation.yml
@@ -93,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3864416475470659420
+      hash: -2762731968026929372
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -102,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3864416475470659420
+      hash: -2762731968026929372
 requirements: []
 rubyforge_project: darksky
 rubygems_version: 1.8.10
@@ -110,6 +111,7 @@ signing_key:
 specification_version: 3
 summary: Ruby gem for retrieving data from the Dark Sky API
 test_files:
+- spec/cassettes/brief_forecast.yml
 - spec/cassettes/forecast.yml
 - spec/cassettes/interesting.yml
 - spec/cassettes/precipitation.yml