Merge branch 'yonelacort-appid'

Author: coderhs

.rspec

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

Gemfile

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

Gemfile.lock

@@ -1,6 +1,9 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    addressable (2.3.6)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
     diff-lcs (1.2.2)
     rspec (2.13.0)
       rspec-core (~> 2.13.0)
@@ -10,9 +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
   rspec
+  vcr
+  webmock

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 
 

lib/open_weather/base.rb

@@ -24,7 +24,7 @@ def success?
     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]

lib/open_weather/version.rb

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

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