forecast_io 1.1.0 → 1.2.0

data/CHANGELOG.md

@@ -1,9 +1,13 @@
 # CHANGELOG
 
-## 1.1.0
+## 1.2.0 (2013-07-03)
+
+* You can now customize the default parameters sent on each call. Thanks [@pat](https://github.com/pat).
+
+## 1.1.0 (2013-04-04)
 
 * Gem now uses [Faraday](https://github.com/lostisland/faraday) to allow for swapping of the underlying HTTP library. Thanks [@norbert](https://github.com/norbert).
 
-## 1.0.0
+## 1.0.0 (2013-03-27)
 
 * Initial release

data/README.md

@@ -34,7 +34,7 @@ Alternatively:
 Forecast::IO.api_key = 'this-is-your-api-key'
 ```
 
-You can then make requests to the `Forecast::IO.forecast(latitude, longitide, options = {})` method.
+You can then make requests to the `Forecast::IO.forecast(latitude, longitude, options = {})` method.
 
 Valid options in the `options` hash are:
 
@@ -96,6 +96,18 @@ Forecast::IO.connection = Faraday.new do |builder|
 end
 ```
 
+You can also customise the default parameters passed through on each API call:
+
+```ruby
+Forecast::IO.default_params = {units: 'si'}
+
+# or
+
+Forecast::IO.configure do |configuration|
+  configuration.default_params = {units: 'si'}
+end
+```
+
 ## Contributing to forecast_io
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/lib/forecast_io.rb

@@ -9,6 +9,8 @@ module Forecast
   module IO
     extend Configuration
 
+    self.default_params = {}
+
     class << self
       # Retrieve the forecast for a given latitude and longitude.
       #
@@ -19,11 +21,7 @@ module Forecast
         forecast_url = "#{Forecast::IO.api_endpoint}/forecast/#{Forecast::IO.api_key}/#{latitude},#{longitude}"
         forecast_url += ",#{options[:time]}" if options[:time]
 
-        forecast_response = if options[:params]
-          connection.get(forecast_url, options[:params])
-        else
-          connection.get(forecast_url)
-        end
+        forecast_response = get(forecast_url, options[:params])
 
         if forecast_response.success?
           return Hashie::Mash.new(MultiJson.load(forecast_response.body))
@@ -41,6 +39,14 @@ module Forecast
       def connection=(connection)
         @connection = connection
       end
+
+      private
+
+      def get(path, params = {})
+        params = Forecast::IO.default_params.merge(params || {})
+
+        connection.get(path, params)
+      end
     end
   end
 end

data/lib/forecast_io/configuration.rb

@@ -10,6 +10,9 @@ module Forecast
       # API key
       attr_writer :api_key
 
+      # Default parameters
+      attr_accessor :default_params
+
       # Yield self to be able to configure Forecast::IO with block-style configuration.
       #
       # Example:
@@ -32,4 +35,4 @@ module Forecast
       end
     end
   end
-end
+end

data/lib/forecast_io/version.rb

@@ -1,6 +1,6 @@
 module Forecast
   module IO
     # Current Forecast::IO version
-    VERSION = '1.1.0'
+    VERSION = '1.2.0'
   end
 end

data/spec/forecast_io/forecast_io_spec.rb

@@ -1,9 +1,15 @@
 require 'spec_helper'
 
 describe Forecast::IO do
+  describe '.default_params' do
+    it "defaults to an empty hash" do
+      Forecast::IO.default_params.should == {}
+    end
+  end
+
   describe '.forecast' do
     it 'should return a forecast for a given latitude, longitude' do
-      VCR.use_cassette('forecast_for_latitude_longitide', record: :once) do
+      VCR.use_cassette('forecast_for_latitude_longitude', record: :once) do
         Forecast::IO.api_key = 'this-is-an-api-key'
         forecast = Forecast::IO.forecast('37.8267','-122.423')
         forecast.should_not be_nil
@@ -15,7 +21,7 @@ describe Forecast::IO do
     end
 
     it 'should return a forecast for a given latitude, longitude and time' do
-      VCR.use_cassette('forecast_for_latitude_longitide_and_time') do
+      VCR.use_cassette('forecast_for_latitude_longitude_and_time') do
         Forecast::IO.api_key = 'this-is-an-api-key'
         forecast = Forecast::IO.forecast('37.8267','-122.423', time: Time.utc(2013, 3, 11, 4).to_i)
         forecast.should_not be_nil
@@ -27,7 +33,7 @@ describe Forecast::IO do
     end
 
     it 'should return a forecast for a given latitude, longitude and query params' do
-      VCR.use_cassette('forecast_for_latitude_longitide_and_query_params') do
+      VCR.use_cassette('forecast_for_latitude_longitude_and_query_params') do
         Forecast::IO.api_key = 'this-is-an-api-key'
         forecast = Forecast::IO.forecast('37.8267','-122.423', params: {units: 'si'})
         forecast.should_not be_nil
@@ -37,5 +43,70 @@ describe Forecast::IO do
         forecast.alerts.should be_nil
       end
     end
+
+    context 'unit tests' do
+      let(:faraday)  { double 'Faraday', get: response }
+      let(:response) { double 'Response', success?: true, body: '{}' }
+
+      before :each do
+        stub_const 'Faraday', stub(new: faraday)
+
+        Forecast::IO.stub api_key: 'abc123', connection: faraday
+      end
+
+      context 'without default parameters' do
+        before :each do
+          Forecast::IO.stub default_params: {}
+        end
+
+        it "sends through a standard request" do
+          faraday.should_receive(:get).with(
+            'https://api.forecast.io/forecast/abc123/1.2,3.4', {}
+          ).and_return response
+
+          Forecast::IO.forecast 1.2, 3.4
+        end
+
+        it "sends through provided parameters" do
+          faraday.should_receive(:get).with(
+            'https://api.forecast.io/forecast/abc123/1.2,3.4', {units: 'si'}
+          ).and_return response
+
+          Forecast::IO.forecast 1.2, 3.4, params: {units: 'si'}
+        end
+      end
+
+      context 'with default parameters' do
+        before :each do
+          Forecast::IO.stub default_params: {units: 'si'}
+        end
+
+        it "sends through the default parameters" do
+          faraday.should_receive(:get).with(
+            'https://api.forecast.io/forecast/abc123/1.2,3.4', {units: 'si'}
+          ).and_return response
+
+          Forecast::IO.forecast 1.2, 3.4
+        end
+
+        it "sends through the merged parameters" do
+          faraday.should_receive(:get).with(
+            'https://api.forecast.io/forecast/abc123/1.2,3.4',
+            {units: 'si', exclude: 'daily'}
+          ).and_return response
+
+          Forecast::IO.forecast 1.2, 3.4, params: {exclude: 'daily'}
+        end
+
+        it "overwrites default parameters when appropriate" do
+          faraday.should_receive(:get).with(
+            'https://api.forecast.io/forecast/abc123/1.2,3.4',
+            {units: 'imperial'}
+          ).and_return response
+
+          Forecast::IO.forecast 1.2, 3.4, params: {units: 'imperial'}
+        end
+      end
+    end
   end
 end

data/spec/forecast_io/version_spec.rb

@@ -2,6 +2,6 @@ require 'spec_helper'
 
 describe 'Forecast::IO::VERSION' do
   it 'should be the correct version' do
-    Forecast::IO::VERSION.should == '1.1.0'
+    Forecast::IO::VERSION.should == '1.2.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: forecast_io
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-04 00:00:00.000000000 Z
+date: 2013-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -143,9 +143,9 @@ files:
 - lib/forecast_io/configuration.rb
 - lib/forecast_io/version.rb
 - spec/cassettes/.keep
-- spec/cassettes/forecast_for_latitude_longitide.yml
-- spec/cassettes/forecast_for_latitude_longitide_and_query_params.yml
-- spec/cassettes/forecast_for_latitude_longitide_and_time.yml
+- spec/cassettes/forecast_for_latitude_longitude.yml
+- spec/cassettes/forecast_for_latitude_longitude_and_query_params.yml
+- spec/cassettes/forecast_for_latitude_longitude_and_time.yml
 - spec/forecast_io/configuration_spec.rb
 - spec/forecast_io/forecast_io_spec.rb
 - spec/forecast_io/version_spec.rb
@@ -164,7 +164,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -176553111951158824
+      hash: 2422846416094696437
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -173,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -176553111951158824
+      hash: 2422846416094696437
 requirements: []
 rubyforge_project: forecast_io
 rubygems_version: 1.8.25
@@ -182,9 +182,9 @@ specification_version: 3
 summary: forecast.io API wrapper in Ruby
 test_files:
 - spec/cassettes/.keep
-- spec/cassettes/forecast_for_latitude_longitide.yml
-- spec/cassettes/forecast_for_latitude_longitide_and_query_params.yml
-- spec/cassettes/forecast_for_latitude_longitide_and_time.yml
+- spec/cassettes/forecast_for_latitude_longitude.yml
+- spec/cassettes/forecast_for_latitude_longitude_and_query_params.yml
+- spec/cassettes/forecast_for_latitude_longitude_and_time.yml
 - spec/forecast_io/configuration_spec.rb
 - spec/forecast_io/forecast_io_spec.rb
 - spec/forecast_io/version_spec.rb