Merge pull request #1 from norbert/faraday

Replace Typhoeus with Faraday

Author: czarneckid

README.md

@@ -38,7 +38,7 @@ You can then make requests to the `Forecast::IO.forecast(latitude, longitide, op
 
 Valid options in the `options` hash are:
 
-* `:time` - UNIX time in seconds since the Unix epoch.
+* `:time` - Unix time in seconds.
 * `:params` - Query parameters that can contain the following:
   * `:jsonp` - JSONP callback.
   * `:units` - Return the API response in SI units, rather than the default Imperial units.
@@ -47,31 +47,49 @@ Valid options in the `options` hash are:
 Get the current forecast:
 
 ```ruby
-forecast = Forecast::IO.forecast('37.8267','-122.423')
+forecast = Forecast::IO.forecast(37.8267, -122.423)
 ```
 
 Get the current forecast at a given time:
 
 ```ruby
-forecast = Forecast::IO.forecast('37.8267','-122.423', time: Time.new(2013, 3, 11).to_i)
+forecast = Forecast::IO.forecast(37.8267, -122.423, time: Time.new(2013, 3, 11).to_i)
 ```
 
 Get the current forecast and use SI units:
 
 ```ruby
-forecast = Forecast::IO.forecast('37.8267','-122.423', params: {units: 'si'})
+forecast = Forecast::IO.forecast(37.8267, -122.423, params: { units: 'si' })
 ```
 
 The `forecast(...)` method will return a response that you can interact with in a more-friendly way, such as:
 
 ```ruby
-forecast = Forecast::IO.forecast('37.8267','-122.423')
+forecast = Forecast::IO.forecast(37.8267, -122.423)
 forecast.latitude
 forecast.longitude
 ```
 
 Please refer to the [forecast.io](https://developer.darkskyapp.com/docs/v2) API documentation for more information on the full response properties.
 
+The HTTP requests are made with [Faraday](https://github.com/lostisland/faraday), which uses `Net::HTTP` by default. Changing the adapter is easy:
+
+```ruby
+require 'typhoeus/adapters/faraday'
+
+Faraday.default_adapter = :typhoeus
+```
+
+Alternatively:
+
+```ruby
+require 'typhoeus/adapters/faraday'
+
+Forecast::IO.connection = Faraday.new do |builder|
+  builder.adapter :typhoeus
+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

forecast_io.gemspec

@@ -19,11 +19,12 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency('typhoeus')
+  s.add_dependency('faraday')
   s.add_dependency('multi_json')
   s.add_dependency('hashie')
 
   s.add_development_dependency('rake')
   s.add_development_dependency('rspec')
   s.add_development_dependency('vcr')
+  s.add_development_dependency('typhoeus')
 end

lib/forecast_io.rb

@@ -3,7 +3,7 @@
 
 require 'hashie'
 require 'multi_json'
-require 'typhoeus'
+require 'faraday'
 
 module Forecast
   module IO
@@ -20,15 +20,27 @@ def forecast(latitude, longitude, options = {})
         forecast_url += ",#{options[:time]}" if options[:time]
 
         forecast_response = if options[:params]
-          Typhoeus::Request.get(forecast_url, params: options[:params])
+          connection.get(forecast_url, options[:params])
         else
-          Typhoeus::Request.get(forecast_url)
+          connection.get(forecast_url)
         end
 
         if forecast_response.success?
           return Hashie::Mash.new(MultiJson.load(forecast_response.body))
         end
       end
+
+      # Build or get an HTTP connection object.
+      def connection
+        @connection ||= Faraday.new
+      end
+
+      # Set an HTTP connection object.
+      #
+      # @param connection Connection object to be used.
+      def connection=(connection)
+        @connection = connection
+      end
     end
   end
 end

spec/forecast_io/forecast_io_spec.rb

@@ -17,7 +17,7 @@
     it 'should return a forecast for a given latitude, longitude and time' do
       VCR.use_cassette('forecast_for_latitude_longitide_and_time') do
         Forecast::IO.api_key = 'this-is-an-api-key'
-        forecast = Forecast::IO.forecast('37.8267','-122.423', time: Time.new(2013, 3, 11).to_i)
+        forecast = Forecast::IO.forecast('37.8267','-122.423', time: Time.utc(2013, 3, 11, 4).to_i)
         forecast.should_not be_nil
         forecast.latitude.should == 37.8267
         forecast.longitude.should == -122.423
@@ -38,4 +38,4 @@
       end
     end
   end
-end
+end

spec/spec_helper.rb

@@ -4,13 +4,16 @@
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 require 'vcr'
+require 'typhoeus/adapters/faraday'
 
 VCR.configure do |c|
   c.cassette_library_dir = 'spec/cassettes'
   c.hook_into :typhoeus
   c.allow_http_connections_when_no_cassette = false
 end
 
+Faraday.default_adapter = :typhoeus
+
 RSpec.configure do |config|
   config.before(:each) do
     Forecast::IO.api_key = nil