open-weather-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 49dda5814718454abaf2b857407b17e071a19f6d
+  data.tar.gz: b3037f267453d565228cf4357fcb01923b31f359
+SHA512:
+  metadata.gz: 1e980c13e0c064cc4861093438275f131abc1a30ad591f687ab272fef2a6d26d14a7bebc8aeebfb55b38a77b70bdb4f499c182e1ff6275742b8856a3c4ca0ddb
+  data.tar.gz: c3b5a7c89c8cbc4dd052fbb5e46627c841e9b87d66e5e0b214302c7f3048b57e2e7cc1aeb8b90c88123dd27df320ddab1a77f58c3a860c6753cd94f9550c8741

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+build/

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Wikiti
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,124 @@
+# OpenWeatherApi wrapper for Ruby
+
+<div align="center">
+![](doc/icon.png)
+<div align="left">
+
+Simple wrapper for Open Weather Map API.
+
+Please visit the this [link](http://openweathermap.org/api) for more information.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'open-weather-api'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install open-weather-api
+
+## Usage
+
+First, you need to init the API:
+
+### Rails
+
+```ruby
+# config/initializers/open-weather-api.rb
+
+Rails.configuration.open_weather_api = OpenWeatherAPI::API.new api_key: ENV['OPEN_WEATHER_API_KEY'], language: 'es', units: 'metric'
+```
+
+`language`, `default_country_code` and `metrics` are optional values, with defaults `'en'`, `nil` and `'metric'`.
+
+### Other
+
+```ruby
+open_weather_api = OpenWeatherAPI::API.new api_key: ENV['OPEN_WEATHER_API_KEY'], language: 'es', units: 'metric'
+# ...
+```
+
+----------------------------
+
+Finally, you can use the different resources of the API:
+
+**NOTE**: You can add manually any parameter you need for each request.
+
+### Current Weather
+
+By city name:
+
+````ruby
+json = open_weather_api.current city: 'Santa Cruz de Tenerife', country_code: 'es'
+````
+
+By city id:
+
+````ruby
+json = open_weather_api.current id: 6360638
+````
+
+By multiple cities ids:
+
+````ruby
+json = open_weather_api.current id: [6360638, 2511401]
+````
+
+By geolocation:
+
+````ruby
+json = open_weather_api.current lon: -16.20302, lat: 28.53924
+````
+
+By zipcode:
+
+````ruby
+json = open_weather_api.current zipcode: 38190, country_code: 'es'
+````
+
+By a geolocated rectangle:
+
+````ruby
+json = open_weather_api.current rectangle: { topleft: { lat: -16.3319, lon: 28.5046 }, bottomright: { lat: -16.1972, lon: 28.4400}, zoom: 10 }
+````
+
+By a geolocated circle (**WARNING**: Unexpected behaviour by API):
+
+````ruby
+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:
+
+````ruby
+open_weather_api.current city: 'Santa Cruz de Tenerife', country_code: 'es' do |json|
+  puts JSON.pretty_generate(json)
+end
+````
+
+For more information about the API, visit (http://openweathermap.org/current)[http://openweathermap.org/current].
+
+### Forecast
+
+TODO.
+
+## Authors ##
+
+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 ( http://github.com/wikiti/open-weather-api/fork )
+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

data/lib/open-weather-api.rb

@@ -0,0 +1,11 @@
+require 'open-weather-api/version'
+
+# Dependencies
+require 'uri'
+require 'rest-client'
+require 'json'
+
+# Main files
+require 'open-weather-api/resources/base_resource'
+require 'open-weather-api/resources/current'
+require 'open-weather-api/api'

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

@@ -0,0 +1,50 @@
+module OpenWeatherAPI
+  class API
+
+    attr_reader :api_key, :options
+    attr_accessor :default_language, :default_country_code, :default_units
+
+    def initialize(options = {})
+      @options = options
+      @api_key = options[:api_key] || options['api_key']
+      @default_language = options[:language] || options['language'] || 'en'
+      @default_country_code = options[:default_country_code] || options['default_country_code']
+      @default_units =  options[:units] || options['units'] || 'metric'
+    end
+
+    def current(**args, &block)
+      fetch_current.execute(**args, &block)
+    end
+
+    # Not yet implemented
+    def forecast(type = :hourly, **args, &block)
+      raise ArgumentError, "Invalid #{type} forecast type."
+
+      self.send("fetch_forecast_#{type}").execute(**args, &block)
+    end
+
+    def icon_url(icon_code)
+      "http://openweathermap.org/img/w/#{icon_code}.png"
+    end
+
+    private
+
+    VALID_FORECAST_TYPES = [:hourly, :daily]
+
+    def valid_forecast_type?(type)
+      VALID_FORECAST_TYPES.include? type.to_sym
+    end
+
+    def fetch_current
+      @current ||= Resources::Current.new self
+    end
+
+    def fetch_forecast_hourly
+      @forecast_hourly ||= Resources::ForecastHourly.new self
+    end
+
+    def fetch_forecast_daily
+      @forecast_daily ||= Resources::ForecastHourly.new self
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+module OpenWeatherAPI
+  module Resources
+    class Base
+
+      attr_reader :api_obj
+
+      def initialize(api_obj)
+        @api_obj = api_obj
+      end
+
+      def execute(**hash, &block)
+        @parameters = hash
+        setup_indifferent_access(@parameters)
+
+        response = request
+        raise "Invalid response." unless response.code == 200
+
+        json = JSON.parse(response.body)
+
+        return block.call(json) if block_given?
+        json
+      end
+
+      private
+
+      def request(type = :get)
+        RestClient.send type, base_url, params: build_params(@parameters), accept: :json
+      end
+
+      def base_url
+        'http://api.openweathermap.org/data/2.5/'
+      end
+
+      def setup_indifferent_access(sub_hash)
+        sub_hash.default_proc = proc{|h, k| h.key?(k.to_s) ? h[k.to_s] : nil}
+        sub_hash.each { |k, v| setup_indifferent_access(v) if v.is_a?(Hash) }
+      end
+
+      def build_params(parameters = {})
+        {
+          APPID: @api_obj.api_key,
+          lang:  @api_obj.default_language
+        }.merge(parameters)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,157 @@
+module OpenWeatherAPI
+  module Resources
+    class Current < Base    
+      private
+      
+      def base_url
+        return super + 'group'    if is_multiple_city_id?
+        return super + 'weather'  if is_city? || is_city_id? || is_geolocation? || is_zipcode?
+        return super + 'box/city' if is_bbox?
+        return super + 'find'     if is_circle?
+      end
+
+      def build_params(parameters = {})
+        super build_for_city || build_for_multiple || build_for_city_id || build_for_geolocation || build_for_zipcode || build_for_bbox || build_for_circle
+      end
+
+      # Basic city
+      # ------------------
+      
+      # For city
+      def is_city?
+        city != nil
+      end
+
+      def city
+        @parameters[:city]
+      end
+
+      def country_code
+        @parameters[:country_code] || @api_obj.default_country_code
+      end
+
+      def build_for_city
+        return { q: [city, country_code].compact.flatten.join(',') } if is_city?
+      end
+
+      # For city id
+      def is_city_id?
+        city_id != nil
+      end
+      
+      def is_multiple_city_id?
+        city_id.is_a? Array
+      end
+      
+      def city_id
+        @parameters[:id] || @parameters[:city_id]
+      end
+
+      def build_for_city_id
+        return { id: city_id } if is_city_id?
+      end
+
+      def build_for_multiple
+        return { id: city_id.compact.join(',') } if is_multiple_city_id?
+      end
+      
+      # For geolocation
+      def is_geolocation?
+        geolocation[:lat] != nil && geolocation[:lon] != nil
+      end
+
+      def geolocation
+        {
+          lat: latitude,
+          lon: longitude
+        }
+      end
+
+      def latitude
+        @parameters[:latitude] || @parameters[:lat]
+      end
+
+      def longitude
+        @parameters[:longitude] || @parameters[:lon]
+      end
+
+      def build_for_geolocation
+        return geolocation if is_geolocation?
+      end
+
+      # For zip code
+      def is_zipcode?
+        zipcode != nil
+      end
+
+      def zipcode
+        @parameters[:zipcode] || @parameters[:zip]
+      end
+
+      def build_for_zipcode
+        return { zip: [zipcode, country_code].compact.flatten.join(',') } if is_zipcode?
+      end
+
+      # Multiples cities
+      # ------------------
+
+      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
+
+      # Bounding box
+      def is_bbox?
+        bbox != nil
+      end
+
+      def bbox_top
+        [ bbox[:topleft][:lat], bbox[:topleft][:lon] ].join(',')
+      end
+
+      def bbox_bottom
+        [ bbox[:bottomright][:lat], bbox[:bottomright][:lon] ].join(',')
+      end
+
+      def bbox_zoom
+        bbox[:zoom] || bbox[:map_zoom] || 10
+      end
+
+      def bbox
+        @parameters[:box] || @parameters[:box] || @parameters[:rect] || @parameters[:rectangle]
+      end
+
+      def build_for_bbox
+        if is_bbox?
+          hash = { bbox: [bbox_top, bbox_bottom, bbox_zoom].join(',') }
+          hash[:cnt] = cities_count if cities_count
+          hash[:cluster] = cluster if cluster
+
+          hash
+        end
+      end
+
+      # Circle
+      def is_circle?
+        circle != nil
+      end
+
+      def circle
+        @parameters[:circle]
+      end
+
+      def build_for_circle
+        if is_circle?
+          hash = { lat: circle[:lat], lon: circle[:lon]}
+          hash[:cnt] = cities_count if cities_count
+          hash[:cluster] = cluster if cluster
+
+          hash
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+module OpenWeatherApi
+  VERSION = "0.0.1"
+end

data/open-weather-api.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'open-weather-api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "open-weather-api"
+  spec.version       = OpenWeatherApi::VERSION
+  spec.authors       = ["Wikiti"]
+  spec.email         = ["wikiti.doghound@gmail.com"]
+  spec.summary       = %q{Simple wrapper for Open Weather Map API}
+  spec.description   = %q{Simple wrapper for Open Weather Map API. The API description may be found here: http://openweathermap.org/api}
+  spec.homepage      = "https://gitlab.com/wikiti-random-stuff/open-weather-api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rest-client", "~> 1.8"
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: open-weather-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Wikiti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: 'Simple wrapper for Open Weather Map API. The API description may be
+  found here: http://openweathermap.org/api'
+email:
+- wikiti.doghound@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE.txt
+- README.md
+- doc/icon.png
+- lib/open-weather-api.rb
+- lib/open-weather-api/api.rb
+- lib/open-weather-api/resources/base_resource.rb
+- lib/open-weather-api/resources/current.rb
+- lib/open-weather-api/version.rb
+- open-weather-api.gemspec
+homepage: https://gitlab.com/wikiti-random-stuff/open-weather-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Simple wrapper for Open Weather Map API
+test_files: []
+has_rdoc: