# OWMO - OpenWeatherMap.Org Client API

Ruby client for openweathermap.org client API.  Currently only for current and forecast information.

[![Gem Version](https://badge.fury.io/rb/owmo.svg)](https://badge.fury.io/rb/owmo)

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'owmo'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install owmo

## Usage

You'll need and API key from OpenWeatherMap.org (http://openweathermap.org/appid).

Compelete examples can be found under owmo/examples.

----
### Quick Start

```ruby
require 'owmo'
api_key = "<api key here>"
weather = OWMO::Weather.new api_key
puts weather.get :current, city_name: "London,UK"
```

```ruby
require 'owmo'
api_key = "<api key here>"
OWMO::weather api_key do |weather|
    puts weather.get :forecast, city_name: "London,UK"
end
```
----
### Weather Information
#### Current weather data (http://openweathermap.org/current)
```ruby
puts weather.get :current, city_name: "London,UK"
```
#### 5 day weather forecast (http://openweathermap.org/forecast5)
```ruby
puts weather.get :forecast5, city_name: "London,UK"
```
#### 16 day weather forecast (http://openweathermap.org/forecast16)
```ruby
puts weather.get :forecast16, city_name: "London,UK"
```

----
### Query parameters

#### Geocode (required)
```ruby
# Geocode by City ID
puts weather.get :current, city_id: 5328041
puts weather.get :current, id: 5328041

# Geocode by City Name
puts weather.get :current, city_name: "Beverly Hills"
puts weather.get :current, q: "Beverly Hills"

# Geocode by Zip Code
puts weather.get :current, zip: 90210
puts weather.get :current, zip_code: 90210

# Geocode by Coordinance
puts weather.get :current, lon: -118.41, lat: 34.09
```

#### Mode
```ruby
# Response in JSON format (default)
puts weather.get :current, city_name: "London,UK"
puts weather.get :current, city_name: "London,UK", mode: :json

# Response in XML format
puts weather.get :current, city_name: "London,UK", mode: :xml

# Response in HTML format
puts weather.get :current, city_name: "London,UK", mode: :html
```

#### Units
```ruby
# Kelvin (default)
puts weather.get :current, city_name: "London,UK"

# Imperial
puts weather.get :current, city_name: "London,UK", units: :imperial

# Metric
puts weather.get :current, city_name: "London,UK", units: :metric
```

#### All
```ruby
query = {
  city_name: "London,UK",
  mode: 'json',
  units: 'imperial',
  lang: 'fr'
}

puts weather.get :current, query
```

----
## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/owmo.


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).