IQAir_AirVisual

A client for the IQAir AirVisual API.

This is an unofficial project and still a work in progress (WIP) ... more to come soon.

For API documentation see: https://api-docs.iqair.com/?version=latest

Add this line to your application's Gemfile:

gem 'iqair_airvisual'

And then execute:

$ bundle

Or install it yourself as:

$ gem install iqair_airvisual

  require 'iqair_airvisual'
  client  = IQAir_AirVisual::Client.new(api_key: 'API key from website')

  client.countries()

• Countries
• States
• Cities
• Nearest City (IP Geo-locate)
• Nearest City (GPS Coordinates)
• Nearest City (Name)

Other endpoints have not been implemented.

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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.

To run tests execute:

$ rake test

Bug reports and pull requests are welcome on GitHub at https://github.com/trex22/iqair_airvisual. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the IQAir_AirVisual: project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.