forecast_io 1.0.0 → 1.1.0

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 1.1.0
+
+* 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
 
 * Initial release

data/README.md

@@ -38,39 +38,64 @@ 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.
-  * `:si` - Return the API response in SI units, rather than the default Imperial units.
+  * `:units` - Return the API response in SI units, rather than the default Imperial units.
+  * `:exclude` - "Exclude some number of data blocks from the API response. This is useful for reducing latency and saving cache space. [blocks] should be a comma-delimeted list (without spaces) of any of the following: currently, minutely, hourly, daily, alerts, flags." (via [v2 docs](https://developer.forecast.io/docs/v2#changelog))
 
 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: {si: true})
+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. We will use typhoeus as an example.
+
+Make sure to include the typhoeus gem in your `Gemfile`:
+
+```ruby
+gem 'typhoeus'
+```
+
+```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

data/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

data/lib/forecast_io.rb

@@ -3,7 +3,7 @@ require 'forecast_io/version'
 
 require 'hashie'
 require 'multi_json'
-require 'typhoeus'
+require 'faraday'
 
 module Forecast
   module IO
@@ -20,15 +20,27 @@ module Forecast
         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

data/lib/forecast_io/version.rb

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

data/spec/cassettes/forecast_for_latitude_longitide_and_query_params.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.forecast.io/forecast/this-is-an-api-key/37.8267,-122.423?si=true
+    uri: https://api.forecast.io/forecast/this-is-an-api-key/37.8267,-122.423?units=si
     body:
       encoding: US-ASCII
       string: ''

data/spec/forecast_io/forecast_io_spec.rb

@@ -17,7 +17,7 @@ describe Forecast::IO do
     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
@@ -29,7 +29,7 @@ describe Forecast::IO do
     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
         Forecast::IO.api_key = 'this-is-an-api-key'
-        forecast = Forecast::IO.forecast('37.8267','-122.423', params: {si: true})
+        forecast = Forecast::IO.forecast('37.8267','-122.423', params: {units: 'si'})
         forecast.should_not be_nil
         forecast.latitude.should == 37.8267
         forecast.longitude.should == -122.423
@@ -38,4 +38,4 @@ describe Forecast::IO do
       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.0.0'
+    Forecast::IO::VERSION.should == '1.1.0'
   end
 end

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ require 'forecast_io'
 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'
@@ -11,6 +12,8 @@ VCR.configure do |c|
   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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: forecast_io
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-27 00:00:00.000000000 Z
+date: 2013-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: typhoeus
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -107,6 +107,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: forecast.io API wrapper in Ruby
 email:
 - me@davidczarnecki.com
@@ -148,7 +164,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4509173212901527585
+      hash: -176553111951158824
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -157,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4509173212901527585
+      hash: -176553111951158824
 requirements: []
 rubyforge_project: forecast_io
 rubygems_version: 1.8.25