open-weather-api 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcd2a1c29774ef26c4a0b443e44f2649485a8f51
-  data.tar.gz: f8b4a8fc6668ee26393366a6df94bd4dd339b1d8
+  metadata.gz: 81a5a0437a5df3681e01d999042349f65a262edd
+  data.tar.gz: 58658dab6c7aae11b3946d73de3f61aabf3c32e0
 SHA512:
-  metadata.gz: 4eb042521d7463a6e7d095a2f05065d451ad794b8ed2f8a0b3c553a61d1cf19d4786cb12a042a5e9d5072e66d9cd95b7a1e8ced2ff5ecfa9424972614f9a8047
-  data.tar.gz: 63dda9940489f441c7ecff1d980712bbc80cd5430082969ff6e6ce789d87395efca167f9e4357bc3e6e9aea42ecc9b1009ac6b45f00acb7074f53c8c4bbfc7c2
+  metadata.gz: 81e3fcf7f66b33d7b64af4ba6d3ddab30b80c63cdfa37c31150b2bbff313c3c9aea6071ddb728ab09592acebb4da15db9346fd8283d9791717216b2a28de8a4c
+  data.tar.gz: d64654935917d1ef3342685b77edf356d14ea6f490e8a1da4e983736fe595cad4a9a26840b01fa7ef2948f6be66f40fb20b186b859e3ad665d4aecdd7060b1d1

data/CONTRIBUTING.md

@@ -0,0 +1,9 @@
+# Contributing
+
+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'`)
+	- Feel free to add yourself to *README.md*'s authors :smile:. 
+4. Run tests (`rake test`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Merge Request

data/README.md

@@ -106,9 +106,7 @@ json = open_weather_api.current circle: { lat: -16.3319, lon: 28.5046 }, cities_
 
 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)
+### Hourly forecast (actually, every 3 hours, up to 5 days)
 
 By city name:
 
@@ -130,6 +128,52 @@ 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).
 
+#### Daily forecast (up to 16 days)
+
+Same as above, but changing `:hourly` to `:daily`. Also, you must add the `:days` to the resquests. Default is `1`.
+
+By city name:
+
+````ruby
+json = open_weather_api.forecast :daily, city: 'Santa Cruz de Tenerife', country_code: 'es', days: 2
+````
+
+By city id:
+
+````ruby
+json = open_weather_api.forecast :daily, id: 6360638, days: 2
+````
+
+By geolocation:
+
+````ruby
+json = open_weather_api.forecast :daily, lon: -16.20302, lat: 28.53924, days: 2
+````
+
+For more information about the API, visit [http://openweathermap.org/forecast5](http://openweathermap.org/forecast5).
+
+### Historical data
+
+TODO
+
+### Weather stations
+
+TODO
+
+### UV index
+
+TODO
+
+### Raw requests
+
+You can also make your very own calls to the api:
+
+````ruby
+json = open_weather_api.raw 'route/to/my/resource', param1: 'param', param2: 'param', lang: 'es'
+````
+
+Note that it's not necessary to add `APPID` parameter to the call.
+
 ### Other
 
 Retrieve icon url:
@@ -143,7 +187,7 @@ 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"
+open_weather_api.current city: 'Balashikha', country_code: 'ru', lang: 'ru', mypara: 'param'
 ````
 
 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`):
@@ -168,13 +212,4 @@ This project has been developed by:
 
 | Avatar | Name | Nickname | Email |
 | ------- | ------------- | --------- | ------------------ |
-| ![](http://www.gravatar.com/avatar/2ae6d81e0605177ba9e17b19f54e6b6c.jpg?s=64)  | Daniel Herzog | Wikiti | [wikiti.doghound@gmail.com](mailto:wikiti.doghound@gmail.com)
-
-## Contributing
-
-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. Run tests (`rake test`)
-5. Push to the branch (`git push origin my-new-feature`)
-6. Create new Merge Request
+| ![](http://www.gravatar.com/avatar/2ae6d81e0605177ba9e17b19f54e6b6c.jpg?s=64)  | Daniel Herzog | Wikiti | [wikiti.doghound@gmail.com](mailto:wikiti.doghound@gmail.com) |

data/lib/open-weather-api.rb

@@ -5,11 +5,18 @@ require 'uri'
 require 'rest-client'
 require 'json'
 
-# Main files
+# Resources
 require 'open-weather-api/resources/base'
+require 'open-weather-api/resources/raw'
 require 'open-weather-api/resources/current'
 require 'open-weather-api/resources/forecast_hourly'
+
+# Handlers
 require 'open-weather-api/resources/handlers/base'
 require 'open-weather-api/resources/handlers/current'
+
+# Configuration
 require 'open-weather-api/config'
+
+# Main file
 require 'open-weather-api/api'

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

@@ -16,11 +16,16 @@ module OpenWeatherAPI
       fetch_current.execute(**args, &block)
     end
 
-    # Not yet implemented
     def forecast(type = :hourly, **args, &block)
+      raise "Invalid '#type' forecast type" unless valid_forecast_type?(type)
+
       self.send("fetch_forecast_#{type}").execute(**args, &block)
     end
 
+    def raw(path = "/", **args, &block)
+      fetch_raw.execute(path, **args, &block)
+    end
+
     def icon_url(icon_code)
       "http://openweathermap.org/img/w/#{icon_code}.png"
     end
@@ -33,6 +38,10 @@ module OpenWeatherAPI
       VALID_FORECAST_TYPES.include? type.to_sym
     end
 
+    def fetch_raw
+      @current ||= Resources::Raw.new self
+    end
+
     def fetch_current
       @current ||= Resources::Current.new self
     end

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

@@ -27,7 +27,11 @@ module OpenWeatherAPI
       private
 
       def mode
-        (@parameters[:mode] || 'json').to_s.to_sym
+        (@parameters[:mode] || :json).to_s.to_sym
+      end
+
+      def handle_response_raw(response)
+        response
       end
 
       def handle_response_json(response)

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

@@ -3,10 +3,10 @@ module OpenWeatherAPI
     class Current < Base
 
       def base_url
-        return super + 'group'    if city_id.multiple?
-        return super + 'weather'  if [city, city_id, geolocation, zipcode].any? { |h| h.can? }
-        return super + 'box/city' if bbox.can?
-        return super + 'find'     if circle.can?
+        return super + 'group/'    if city_id.multiple?
+        return super + 'weather/'  if [city, city_id, geolocation, zipcode].any? { |h| h.can? }
+        return super + 'box/city/' if bbox.can?
+        return super + 'find/'     if circle.can?
       end
 
       def build_params(parameters = {})
@@ -15,29 +15,29 @@ module OpenWeatherAPI
 
       # Simple handlers
       def city
-        City.new @api_obj, @parameters
+        Handlers::City.new @api_obj, @parameters
       end
 
       def city_id
-        CityID.new @api_obj, @parameters
+        Handlers::CityID.new @api_obj, @parameters
       end
 
       def geolocation
-        Geolocation.new @api_obj, @parameters
+        Handlers::Geolocation.new @api_obj, @parameters
       end
 
       def zipcode
-        Zipcode.new @api_obj, @parameters
+        Handlers::Zipcode.new @api_obj, @parameters
       end
 
       # Other handlers
       # ------------------
       def bbox
-        BoundingBox.new @api_obj, @parameters
+        Handlers::BoundingBox.new @api_obj, @parameters
       end
       
       def circle
-        Circle.new @api_obj, @parameters
+        Handlers::Circle.new @api_obj, @parameters
       end
 
     end

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

@@ -0,0 +1,19 @@
+module OpenWeatherAPI
+  module Resources
+    class ForecastDaily < ForecastHourly
+
+      def base_url
+        return super + 'daily/'
+      end
+
+      def build_params(parameters = {})
+        parameters.merge!(cnt: days)
+        super(parameters)
+      end
+
+      def days
+        @parameters[:days] || @parameters[:n_days] || @parameters[:cnt]  || @parameters[:count]
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@ module OpenWeatherAPI
     class ForecastHourly < Base
 
       def base_url
-        return super + 'forecast'
+        return super + 'forecast/'
       end
 
       def build_params(parameters = {})
@@ -12,15 +12,15 @@ module OpenWeatherAPI
 
       # Simple handlers
       def city
-        City.new @api_obj, @parameters
+        Handlers::City.new @api_obj, @parameters
       end
 
       def city_id
-        CityID.new @api_obj, @parameters
+        Handlers::CityID.new @api_obj, @parameters
       end
 
       def geolocation
-        Geolocation.new @api_obj, @parameters
+        Handlers::Geolocation.new @api_obj, @parameters
       end
 
     end

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

@@ -1,97 +1,99 @@
 module OpenWeatherAPI
   module Resources
+    module Handlers
 
-     class QueryHandler
-      def initialize(api_obj, parameters = {})
-        @api_obj = api_obj
-        @parameters = parameters
-      end
+      class QueryHandler
+        def initialize(api_obj, parameters = {})
+          @api_obj = api_obj
+          @parameters = parameters
+        end
 
-      def handle
-        build if can?
-      end
+        def handle
+          build if can?
+        end
 
-      def can?
-        value != nil
-      end
+        def can?
+          value != nil
+        end
 
-      private
+        private
 
-      def value
-        true
-      end
+        def value
+          true
+        end
 
-      def build
-        @parameters
-      end
+        def build
+          @parameters
+        end
 
-      def country_code
-        @parameters[:country_code] || @parameters[:cc] || @api_obj.default_country_code
-      end
+        def country_code
+          @parameters[:country_code] || @parameters[:cc] || @api_obj.default_country_code
+        end
 
-      def cities_count
-        @parameters[:count] || @parameters[:cnt] || @parameters[:cities_count]
-      end
+        def cities_count
+          @parameters[:count] || @parameters[:cnt] || @parameters[:cities_count]
+        end
 
-      def cluster
-        @parameters[:cluster] if @parameters[:cluster].to_s == 'yes' || @parameters[:cluster].to_s == 'no'
-      end
+        def cluster
+          @parameters[:cluster] if @parameters[:cluster].to_s == 'yes' || @parameters[:cluster].to_s == 'no'
+        end
 
-      def fill(hash)
-        hash[:cnt]     = cities_count if cities_count
-        hash[:cluster] = cluster if cluster
+        def fill(hash)
+          hash[:cnt]     = cities_count if cities_count
+          hash[:cluster] = cluster if cluster
 
-        hash
+          hash
+        end
       end
 
-    end
-
-    class City < QueryHandler
-      private
+      class City < QueryHandler
+        private
 
-      def build
-        { q: [value, country_code].compact.flatten.join(',') }
+        def build
+          { q: [value, country_code].compact.flatten.join(',') }
+        end
+        
+        def value
+          @parameters[:city]
+        end
       end
-      
-      def value
-        @parameters[:city]
-      end
-    end
 
-    class CityID < QueryHandler
-      def multiple?
-        value.is_a? Array
-      end
+      class CityID < QueryHandler
+        def multiple?
+          value.is_a? Array
+        end
 
-      private
+        private
 
-      def build
-        { id: [value].flatten.compact.join(',') }
-      end
+        def build
+          { id: [value].flatten.compact.join(',') }
+        end
 
-      def value
-        @parameters[:id] || @parameters[:city_id]
+        def value
+          @parameters[:id] || @parameters[:city_id]
+        end
       end
-    end
 
-    class Geolocation < QueryHandler
-      def can?
-        latitude != nil && longitude != nil
-      end
+      class Geolocation < QueryHandler
+        def can?
+          latitude != nil && longitude != nil
+        end
 
-      private
+        private
 
-      def build
-        { lat: latitude, lon: longitude }
-      end
+        def build
+          { lat: latitude, lon: longitude }
+        end
 
-      def latitude
-        @parameters[:latitude] || @parameters[:lat]
-      end
+        def latitude
+          @parameters[:latitude] || @parameters[:lat]
+        end
 
-      def longitude
-        @parameters[:longitude] || @parameters[:lon]
+        def longitude
+          @parameters[:longitude] || @parameters[:lon]
+        end
       end
+
     end
   end
 end

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

@@ -1,8 +1,6 @@
 module OpenWeatherAPI
   module Resources
-
-    class Current
-      private
+    module Handlers
 
       class Zipcode < QueryHandler
         private
@@ -51,6 +49,7 @@ module OpenWeatherAPI
           fill lat: value[:lat], lon: value[:lon]
         end
       end
+
     end
   end
 end

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

@@ -0,0 +1,15 @@
+module OpenWeatherAPI
+  module Resources
+    class Raw < Base
+
+      def execute(resource = '/', **args, &block)
+        @resource = resource
+        super(**args, &block)
+      end
+
+      def base_url
+        return super + @resource
+      end
+    end
+  end
+end

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

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

data/spec/forecast_daily_spec.rb

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

data/spec/raw_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe OpenWeatherAPI::API do
+  let(:api) { OpenWeatherAPI::API.new( api_key: ENV['OPEN_WEATHER_API_KEY'], default_language: 'es', default_country_code: 'es' ) }
+
+  describe 'When fetching raw rest requests with valid data' do
+    it 'should work' do
+      expect(api.raw("weather", q: 'Santa Cruz de Tenerife,ES')[:cod].to_i).to eq(200)
+    end
+  end
+
+  describe 'When fetching raw rest requests with invalid data' do
+    it 'should fail' do
+      expect { api.raw("undefined_resource", q: 'whatever', mode: :raw) }.to raise_error
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: open-weather-api
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Wikiti
@@ -62,6 +62,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -71,14 +72,18 @@ 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_daily.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/resources/raw.rb
 - lib/open-weather-api/version.rb
 - open-weather-api.gemspec
 - rakefile
 - spec/current_weather_spec.rb
+- spec/forecast_daily_spec.rb
 - spec/forecast_hourly_spec.rb
+- spec/raw_spec.rb
 - spec/spec_helper.rb
 homepage: https://gitlab.com/wikiti-random-stuff/open-weather-api
 licenses:
@@ -106,6 +111,8 @@ specification_version: 4
 summary: Simple wrapper for Open Weather Map API
 test_files:
 - spec/current_weather_spec.rb
+- spec/forecast_daily_spec.rb
 - spec/forecast_hourly_spec.rb
+- spec/raw_spec.rb
 - spec/spec_helper.rb
 has_rdoc: