open-weather 0.9.2 → 0.10.0

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/Gemfile

@@ -1,5 +1,5 @@
 source 'http://rubygems.org'
 
-gem 'httparty'
-gem 'addressable'
 gem 'rspec'
+gem 'vcr'
+gem 'webmock'

data/Gemfile.lock

@@ -1,13 +1,10 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.3.4)
+    addressable (2.3.6)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
     diff-lcs (1.2.2)
-    httparty (0.11.0)
-      multi_json (~> 1.0)
-      multi_xml (>= 0.5.2)
-    multi_json (1.7.3)
-    multi_xml (0.5.3)
     rspec (2.13.0)
       rspec-core (~> 2.13.0)
       rspec-expectations (~> 2.13.0)
@@ -16,11 +13,16 @@ GEM
     rspec-expectations (2.13.0)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.13.0)
+    safe_yaml (1.0.3)
+    vcr (2.9.2)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  addressable
-  httparty
   rspec
+  vcr
+  webmock

data/README.md

@@ -12,35 +12,61 @@ Add the following to your **Gemfile**
 
 ## Usage
 
-    require 'open_weather'
 
-    # current weather APIs
+### Current weather information API
 
-    # get current weather by city name
-    OpenWeather::Current.city("Cochin, IN")
+```ruby
+require 'open_weather'
 
-    # get current weather by city id
-    OpenWeather::Current.city_id("1273874")
+# get current weather by city name
+OpenWeather::Current.city("Cochin, IN")
 
-    # get current weather by geocode. (lat, lon)
-    OpenWeather::Current.geocode(9.94, 76.26)
+# get current weather by city id
+OpenWeather::Current.city_id("1273874")
 
-    # get the current weather in degrees celsius
-    OpenWeather::Current.city("Cochin, IN", units: 'metric')
+# get current weather by geocode. (lat, lon)
+OpenWeather::Current.geocode(9.94, 76.26)
 
-    # weather forecast APIs
+# get the current weather in degrees celsius
+OpenWeather::Current.city("Cochin, IN", units: 'metric')
+```
 
-    # get weather forecast by city name
-    OpenWeather::Forecast.city("Cochin, IN")
+Documentation about the current weather end-point:
+http://openweathermap.org/current
 
-    # get weather forecast by city name in fahrenheit
-    OpenWeather::Forecast.city("Cochin, IN", units: 'imperial')
 
-    # get weather forecast by city id
-    OpenWeather::Forecast.city_id("1273874")
+### Weather forecast API
+
+```ruby
+require 'open_weather'
+
+# get weather forecast by city name
+OpenWeather::Forecast.city("Cochin, IN")
+
+# get weather forecast by city name in fahrenheit
+OpenWeather::Forecast.city("Cochin, IN", units: 'imperial')
+
+# get weather forecast by city id
+OpenWeather::Forecast.city_id("1273874")
+
+# get weather forecast by geocode. (lat, lon)
+OpenWeather::Forecast.geocode(9.94, 76.26)
+```
+
+Doucumentation about the weather forecast end-point:
+http://openweathermap.org/forecast
+
+#### Using the API key
+
+```ruby
+# get current weather by city name
+options = { units: "metric", APPID: 1111111111 }
+OpenWeather::Current.city("Berlin, DE", options)
+```
+
+How to get an API key and tips for an effective usage of the API:
+http://openweathermap.org/appid
 
-    # get weather forecast by geocode. (lat, lon)
-    OpenWeather::Forecast.geocode(9.94, 76.26)
  
 ## Contributing 
 

data/lib/open_weather/base.rb

@@ -24,7 +24,7 @@ module OpenWeather
     private
 
     def extract_options!(options)
-      valid_options = [:lat, :lon, :city, :country, :id, :units]
+      valid_options = [:lat, :lon, :city, :country, :id, :units, :APPID]
       options.keys.each { |k| options.delete(k) unless valid_options.include?(k) }
 
       if options[:city] || options[:country]

data/lib/open_weather/version.rb

@@ -1,3 +1,3 @@
 module OpenWeather
-  VERSION = "0.9.2"
+  VERSION = "0.10.0"
 end

data/open_weather.gemspec

@@ -14,5 +14,7 @@ Gem::Specification.new do |gem|
   gem.executables          = gem.files.grep(/^bin/).map{ |f| File.basename(f) }
   gem.require_paths        = ["lib"]
   gem.add_development_dependency "rspec"
+  gem.add_development_dependency "vcr"
+  gem.add_development_dependency "webmock"
   gem.add_runtime_dependency 'json'
 end

data/spec/fixtures/cassettes/api/current_city_id_invalid.yml

@@ -0,0 +1,47 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.openweathermap.org/data/2.5/weather?q=,invalidid
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - api.openweathermap.org
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Thu, 28 Aug 2014 10:50:49 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Source:
+      - back
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Methods:
+      - GET, POST
+    body:
+      encoding: UTF-8
+      string: |
+        {"message":"Error: Not found city","cod":"404"}
+    http_version: 
+  recorded_at: Thu, 28 Aug 2014 10:50:48 GMT
+recorded_with: VCR 2.9.2

data/spec/fixtures/cassettes/api/current_city_id_valid.yml

@@ -0,0 +1,47 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.openweathermap.org/data/2.5/weather?id=1273874
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - api.openweathermap.org
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Thu, 28 Aug 2014 10:50:49 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Source:
+      - redis
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Methods:
+      - GET, POST
+    body:
+      encoding: UTF-8
+      string: |
+        {"coord":{"lon":76.26,"lat":9.94},"sys":{"message":0.8839,"country":"IN","sunrise":1409186753,"sunset":1409231181},"weather":[{"id":803,"main":"Clouds","description":"broken clouds","icon":"04d"}],"base":"cmc stations","main":{"temp":299.941,"temp_min":299.941,"temp_max":299.941,"pressure":1021.68,"sea_level":1023.32,"grnd_level":1021.68,"humidity":100},"wind":{"speed":4.91,"deg":311.006},"clouds":{"all":64},"dt":1409221397,"id":1273874,"name":"Cochin","cod":200}
+    http_version: 
+  recorded_at: Thu, 28 Aug 2014 10:50:48 GMT
+recorded_with: VCR 2.9.2

data/spec/fixtures/cassettes/api/current_city_imperial_valid.yml

@@ -0,0 +1,47 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.openweathermap.org/data/2.5/weather?q=,Cochin,%20In&units=imperial
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - api.openweathermap.org
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Thu, 28 Aug 2014 10:52:09 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Source:
+      - back
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Methods:
+      - GET, POST
+    body:
+      encoding: UTF-8
+      string: |
+        {"coord":{"lon":76.26,"lat":9.94},"sys":{"message":0.0316,"country":"India","sunrise":1409186752,"sunset":1409231181},"weather":[{"id":804,"main":"Clouds","description":"overcast clouds","icon":"04d"}],"base":"cmc stations","main":{"temp":79.96,"temp_min":79.96,"temp_max":79.96,"pressure":1020.95,"sea_level":1021.19,"grnd_level":1020.95,"humidity":99},"wind":{"speed":11.79,"deg":313.001},"clouds":{"all":88},"dt":1409222765,"id":1273874,"name":"Kochi","cod":200}
+    http_version: 
+  recorded_at: Thu, 28 Aug 2014 10:52:09 GMT
+recorded_with: VCR 2.9.2

data/spec/fixtures/cassettes/api/current_city_invalid.yml

@@ -0,0 +1,47 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.openweathermap.org/data/2.5/weather?q=,Cochiiiiiin,%20In
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - api.openweathermap.org
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Thu, 28 Aug 2014 10:50:49 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Source:
+      - back
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Methods:
+      - GET, POST
+    body:
+      encoding: UTF-8
+      string: |
+        {"message":"Error: Not found city","cod":"404"}
+    http_version: 
+  recorded_at: Thu, 28 Aug 2014 10:50:48 GMT
+recorded_with: VCR 2.9.2

data/spec/fixtures/cassettes/api/current_city_metric_valid.yml

@@ -0,0 +1,47 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.openweathermap.org/data/2.5/weather?q=,Cochin,%20In&units=metric
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - api.openweathermap.org
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Thu, 28 Aug 2014 10:50:49 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Source:
+      - back
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Methods:
+      - GET, POST
+    body:
+      encoding: UTF-8
+      string: |
+        {"coord":{"lon":76.26,"lat":9.94},"sys":{"message":0.0191,"country":"India","sunrise":1409186752,"sunset":1409231181},"weather":[{"id":804,"main":"Clouds","description":"overcast clouds","icon":"04d"}],"base":"cmc stations","main":{"temp":26.643,"temp_min":26.643,"temp_max":26.643,"pressure":1020.95,"sea_level":1021.19,"grnd_level":1020.95,"humidity":99},"wind":{"speed":5.46,"deg":313.001},"clouds":{"all":88},"dt":1409222627,"id":1273874,"name":"Kochi","cod":200}
+    http_version: 
+  recorded_at: Thu, 28 Aug 2014 10:50:49 GMT
+recorded_with: VCR 2.9.2

data/spec/fixtures/cassettes/api/current_city_valid.yml

@@ -0,0 +1,47 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.openweathermap.org/data/2.5/weather?q=,Cochin,%20In
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - api.openweathermap.org
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Thu, 28 Aug 2014 10:50:48 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Source:
+      - back
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Methods:
+      - GET, POST
+    body:
+      encoding: UTF-8
+      string: |
+        {"coord":{"lon":76.26,"lat":9.94},"sys":{"message":0.0191,"country":"India","sunrise":1409186752,"sunset":1409231181},"weather":[{"id":804,"main":"Clouds","description":"overcast clouds","icon":"04d"}],"base":"cmc stations","main":{"temp":299.793,"temp_min":299.793,"temp_max":299.793,"pressure":1020.95,"sea_level":1021.19,"grnd_level":1020.95,"humidity":99},"wind":{"speed":5.46,"deg":313.001},"clouds":{"all":88},"dt":1409222627,"id":1273874,"name":"Kochi","cod":200}
+    http_version: 
+  recorded_at: Thu, 28 Aug 2014 10:50:48 GMT
+recorded_with: VCR 2.9.2

data/spec/fixtures/cassettes/api/current_geocode_invalid.yml

@@ -0,0 +1,47 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.openweathermap.org/data/2.5/weather?lat=181&lon=181
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - api.openweathermap.org
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Thu, 28 Aug 2014 10:50:49 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Source:
+      - back
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Methods:
+      - GET, POST
+    body:
+      encoding: UTF-8
+      string: |
+        {"message":"Error: Not found city","cod":"404"}
+    http_version: 
+  recorded_at: Thu, 28 Aug 2014 10:50:48 GMT
+recorded_with: VCR 2.9.2