open-weather-api 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82b4f646f8ec4c9b78170ef8ae612323828e46a4
-  data.tar.gz: 63205323ef368b5682d0222c1827bb7d308e3422
+  metadata.gz: dcd2a1c29774ef26c4a0b443e44f2649485a8f51
+  data.tar.gz: f8b4a8fc6668ee26393366a6df94bd4dd339b1d8
 SHA512:
-  metadata.gz: 1c7cfb721767d05e059e40282982579f637829e7d78607b577a630f28889fd91551ba89933f52b9cf49b824354807f43a9681f56ee2eb9c4e17066610a941e5f
-  data.tar.gz: fa98ab5bd8d849332a1e0b6f3c0b831fdb52ac5ee5b8f6118624ff10567026d0c52e3503293d80124e0b7023882ebdc705456a8aa31bbbacdcea26b8b4e5b972
+  metadata.gz: 4eb042521d7463a6e7d095a2f05065d451ad794b8ed2f8a0b3c553a61d1cf19d4786cb12a042a5e9d5072e66d9cd95b7a1e8ced2ff5ecfa9424972614f9a8047
+  data.tar.gz: 63dda9940489f441c7ecff1d980712bbc80cd5430082969ff6e6ce789d87395efca167f9e4357bc3e6e9aea42ecc9b1009ac6b45f00acb7074f53c8c4bbfc7c2

data/README.md

@@ -49,7 +49,7 @@ Outside of the configuration file, you can access the `api` object as follows:
 Rails.configuration.open_weather_api
 ````
 
-### Other
+### Generic
 
 ```ruby
 open_weather_api = OpenWeatherAPI::API.new api_key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", default_language: 'es', default_units: 'metric', default_country_code: 'es'
@@ -60,8 +60,6 @@ open_weather_api = OpenWeatherAPI::API.new api_key: "xxxxxxxxxxxxxxxxxxxxxxxxxxx
 
 Finally, you can use the different resources of the API:
 
-**NOTE**: You can add manually any parameter you need for each request, and they will override the computed parameters.
-
 ### Current Weather
 
 By city name:
@@ -106,19 +104,31 @@ By a geolocated circle (**WARNING**: Unexpected behaviour by API):
 json = open_weather_api.current circle: { lat: -16.3319, lon: 28.5046 }, cities_count: 2
 ````
 
-You can also use ruby blocks to handle the response:
+For more information about the API, visit [http://openweathermap.org/current](http://openweathermap.org/current).
+
+### Forecast
+
+#### Hourly (actually, every 3 hours, up to 5 days)
+
+By city name:
 
 ````ruby
-json = open_weather_api.current city: 'Santa Cruz de Tenerife', country_code: 'es' do |json|
-  puts JSON.pretty_generate(json)
-end
+json = open_weather_api.forecast :hourly, city: 'Santa Cruz de Tenerife', country_code: 'es'
 ````
 
-For more information about the API, visit [http://openweathermap.org/current](http://openweathermap.org/current).
+By city id:
 
-### Forecast
+````ruby
+json = open_weather_api.forecast :hourly, id: 6360638
+````
 
-TODO.
+By geolocation:
+
+````ruby
+json = open_weather_api.forecast :hourly, lon: -16.20302, lat: 28.53924
+````
+
+For more information about the API, visit [http://openweathermap.org/forecast5](http://openweathermap.org/forecast5).
 
 ### Other
 
@@ -130,6 +140,28 @@ open_weather_api.current city: 'Santa Cruz de Tenerife', country_code: 'es' do |
 end
 ````
 
+You can add manually any parameter you need for each request, and they will override the computed parameters:
+
+````ruby
+open_weather_api.current city: 'Balashikha', country_code: "ru", lang: "ru"
+````
+
+Also, you can define the response format with the `:mode` parameters. Valid formats are `:json` (returns a `Hash`), `:xml` and `:html` (both return a `String`):
+
+````ruby
+open_weather_api.current city: 'Santa Cruz de Tenerife', mode: :xml do |xml_str|
+  puts "XML data: #{xml_str}"
+end
+````
+
+You can use ruby blocks to handle the response:
+
+````ruby
+open_weather_api.current city: 'Santa Cruz de Tenerife', country_code: 'es', mode: :json do |json|
+  puts JSON.pretty_generate(json)
+end
+````
+
 ## Authors ##
 
 This project has been developed by:
@@ -142,6 +174,7 @@ This project has been developed by:
 
 1. Fork it ( [https://gitlab.com/wikiti-random-stuff/open-weather-api/fork/new](https://gitlab.com/wikiti-random-stuff/open-weather-api/fork/new) )
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Run tests (`rake test`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Merge Request

data/lib/open-weather-api.rb

@@ -8,6 +8,7 @@ require 'json'
 # Main files
 require 'open-weather-api/resources/base'
 require 'open-weather-api/resources/current'
+require 'open-weather-api/resources/forecast_hourly'
 require 'open-weather-api/resources/handlers/base'
 require 'open-weather-api/resources/handlers/current'
 require 'open-weather-api/config'

data/lib/open-weather-api/api.rb

@@ -1,6 +1,8 @@
 module OpenWeatherAPI
   class API
 
+    VERSION = "2.5"
+
     attr_accessor :api_key, :default_language, :default_country_code, :default_units
 
     def initialize(options = {})
@@ -16,8 +18,6 @@ module OpenWeatherAPI
 
     # Not yet implemented
     def forecast(type = :hourly, **args, &block)
-      raise ArgumentError, "Invalid #{type} forecast type."
-
       self.send("fetch_forecast_#{type}").execute(**args, &block)
     end
 

data/lib/open-weather-api/resources/base.rb

@@ -13,24 +13,38 @@ module OpenWeatherAPI
         setup_indifferent_access(@parameters)
 
         # Let's use json
-        execute_json **hash, &block
+        response = RestClient.send :get, base_url, params: build_params(@parameters)
+        raise "Invalid response." unless response.code == 200
+
+        # Handle the response format 
+        response = self.send "handle_response_#{mode}", response
+
+        # Handle the block
+        return block.call(response) if block_given?
+        response
       end
 
       private
 
-      def execute_json(**hash, &block)
-        response = RestClient.send :get, base_url, params: build_params(@parameters), accept: :json
-        raise "Invalid response." unless response.code == 200
+      def mode
+        (@parameters[:mode] || 'json').to_s.to_sym
+      end
 
+      def handle_response_json(response)
         json = JSON.parse(response.body)
         setup_indifferent_access(json)
+      end
+
+      def handle_response_xml(response)
+        response.body
+      end
 
-        return block.call(json) if block_given?
-        json
+      def handle_response_html(response)
+        response.body
       end
 
       def base_url
-        'http://api.openweathermap.org/data/2.5/'
+        "http://api.openweathermap.org/data/#{API::VERSION || '2.5'}/"
       end
 
       def setup_indifferent_access(sub_hash)

data/lib/open-weather-api/resources/forecast_hourly.rb

@@ -0,0 +1,28 @@
+module OpenWeatherAPI
+  module Resources
+    class ForecastHourly < Base
+
+      def base_url
+        return super + 'forecast'
+      end
+
+      def build_params(parameters = {})
+        super [city, city_id, geolocation].each{ |h| break h.handle if h.can? }
+      end
+
+      # Simple handlers
+      def city
+        City.new @api_obj, @parameters
+      end
+
+      def city_id
+        CityID.new @api_obj, @parameters
+      end
+
+      def geolocation
+        Geolocation.new @api_obj, @parameters
+      end
+
+    end
+  end
+end

data/lib/open-weather-api/resources/handlers/base.rb

@@ -45,5 +45,53 @@ module OpenWeatherAPI
       end
 
     end
+
+    class City < QueryHandler
+      private
+
+      def build
+        { q: [value, country_code].compact.flatten.join(',') }
+      end
+      
+      def value
+        @parameters[:city]
+      end
+    end
+
+    class CityID < QueryHandler
+      def multiple?
+        value.is_a? Array
+      end
+
+      private
+
+      def build
+        { id: [value].flatten.compact.join(',') }
+      end
+
+      def value
+        @parameters[:id] || @parameters[:city_id]
+      end
+    end
+
+    class Geolocation < QueryHandler
+      def can?
+        latitude != nil && longitude != nil
+      end
+
+      private
+
+      def build
+        { lat: latitude, lon: longitude }
+      end
+
+      def latitude
+        @parameters[:latitude] || @parameters[:lat]
+      end
+
+      def longitude
+        @parameters[:longitude] || @parameters[:lon]
+      end
+    end
   end
 end

data/lib/open-weather-api/resources/handlers/current.rb

@@ -4,54 +4,6 @@ module OpenWeatherAPI
     class Current
       private
 
-      class City < QueryHandler
-        private
-        
-        def build
-          { q: [value, country_code].compact.flatten.join(',') }
-        end
-        
-        def value
-          @parameters[:city]
-        end
-      end
-
-      class CityID < QueryHandler
-        def multiple?
-          value.is_a? Array
-        end
-
-        private
-
-        def build
-          { id: [value].flatten.compact.join(',') }
-        end
-
-        def value
-          @parameters[:id] || @parameters[:city_id]
-        end
-      end
-
-      class Geolocation < QueryHandler
-        def can?
-          latitude != nil && longitude != nil
-        end
-
-        private
-
-        def build
-          { lat: latitude, lon: longitude }
-        end
-
-        def latitude
-          @parameters[:latitude] || @parameters[:lat]
-        end
-
-        def longitude
-          @parameters[:longitude] || @parameters[:lon]
-        end
-      end
-
       class Zipcode < QueryHandler
         private
 

data/lib/open-weather-api/version.rb

@@ -1,3 +1,3 @@
 module OpenWeatherAPI
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/spec/current_weather_spec.rb

@@ -39,5 +39,13 @@ describe OpenWeatherAPI::API do
 
       expect(json1).to eq(json2)
     end
+
+    it 'works with xml format' do
+      expect(api.current(city: 'Santa Cruz de Tenerife', mode: :xml)).not_to be_nil
+    end
+
+    it 'works with html format' do
+      expect(api.current(city: 'Santa Cruz de Tenerife', mode: :html)).not_to be_nil
+    end
   end
 end

data/spec/forecast_hourly_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe OpenWeatherAPI::API do
+  describe 'When fetching hourly forecast weather' do
+    let(:api) { OpenWeatherAPI::API.new( api_key: ENV['OPEN_WEATHER_API_KEY'], default_language: 'es', default_country_code: 'es' ) }
+
+    it 'should retrieve data by city name' do
+      expect(api.forecast(:hourly, city: 'Santa Cruz de Tenerife')[:cod].to_i).to eq(200)
+    end
+
+    it 'should retrieve data by city id' do
+      expect(api.forecast(:hourly, id: 6360638)[:cod].to_i).to eq(200)
+    end
+
+    it 'should retrieve data by geolocation' do
+      expect(api.forecast(:hourly, lon: -16.20302, lat: 28.53924)[:cod].to_i).to eq(200)
+    end
+
+    it 'works with a given block' do
+      json1, json2 = nil
+      json1 = api.forecast(:hourly, city: 'Santa Cruz de Tenerife') { |json| json2 = json }
+
+      expect(json1).to eq(json2)
+    end
+
+    it 'works with xml format' do
+      expect(api.forecast(:hourly, city: 'Santa Cruz de Tenerife', mode: :xml)).not_to be_nil
+    end
+
+    it 'works with html format' do
+      expect(api.forecast(:hourly, city: 'Santa Cruz de Tenerife', mode: :html)).not_to be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+raise "You MUST setup 'OPEN_WEATHER_API_KEY' env variable before running tests!" unless ENV['OPEN_WEATHER_API_KEY']
+
 require 'bundler/setup'
 Bundler.setup
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: open-weather-api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Wikiti
@@ -71,12 +71,14 @@ files:
 - lib/open-weather-api/config.rb
 - lib/open-weather-api/resources/base.rb
 - lib/open-weather-api/resources/current.rb
+- lib/open-weather-api/resources/forecast_hourly.rb
 - lib/open-weather-api/resources/handlers/base.rb
 - lib/open-weather-api/resources/handlers/current.rb
 - lib/open-weather-api/version.rb
 - open-weather-api.gemspec
 - rakefile
 - spec/current_weather_spec.rb
+- spec/forecast_hourly_spec.rb
 - spec/spec_helper.rb
 homepage: https://gitlab.com/wikiti-random-stuff/open-weather-api
 licenses:
@@ -104,5 +106,6 @@ specification_version: 4
 summary: Simple wrapper for Open Weather Map API
 test_files:
 - spec/current_weather_spec.rb
+- spec/forecast_hourly_spec.rb
 - spec/spec_helper.rb
 has_rdoc: