airvisual_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 99cb795e5895323f25820f36add9b3062e9a6743640990748577d69e22e831e6
+  data.tar.gz: c5d9f6ad94f00bb8a792f477a517b8bf7fa1e3c2acdfc38c24ed5aeafd5f92b7
+SHA512:
+  metadata.gz: fb9c75b057e4cdb898e06fcd9719efabe42c4f71b45a2278ccdba53a0c97cb3ff7d5ff2a7f8b828438de151328427a1aa2101b8cdda201c2b7124bec1209b237
+  data.tar.gz: 384008d2e42b04397f970e98f493e6177dad22a11997d708ba9ea94dcf2c7f77c713ed8efcb98e9a5b4b53fb470f2208d9ce867679a853c30c3963023730b550

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in airvisual_api.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    airvisual_api (0.1.0)
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.1104)
+    multi_xml (0.6.0)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  airvisual_api!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,36 @@
+# AirvisualApi
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/airvisual_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'airvisual_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install airvisual_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/airvisual_api.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/airvisual_api.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/airvisual_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "airvisual_api"
+  spec.version       = AirVisualApi::VERSION
+  spec.authors       = ["Joey Ferguson"]
+  spec.email         = ["fergmastaflex@gmail.com"]
+
+  spec.summary       = 'Ruby wrapper for IQAir\'s AirVisual API'
+  spec.description   = 'A Ruby interface to retrieve air quality data from the AirVisual API based on various location types'
+  spec.homepage      = "http://github.com/airvisual_api"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "http://github.com/airvisual_api"
+  spec.metadata["changelog_uri"] = "http://github.com/airvisual_api"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'rspec'
+
+  spec.add_runtime_dependency 'httparty'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "airvisual_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/airvisual_api.rb

@@ -0,0 +1,8 @@
+require "airvisual_api/version"
+require 'airvisual_api/client'
+require 'airvisual_api/city'
+
+module AirVisualApi
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/airvisual_api/city.rb

@@ -0,0 +1,31 @@
+module AirVisualApi
+  class City
+    # For MVP and prototyping, I'm just going to send back raw
+    # HTTParty responses to the main app. Further iterations
+    # will see better response parsing and humanizing
+    # some of the key names. I can't stand abbreviation
+    # and jargon.
+
+    def nearest_city_by_gps(latitude:, longitude:)
+      # coercing to float to ensure proper formatting
+      # this should probably be a little smarter with some
+      # regex checking coupled with some ruby errors, but
+      # for time and prototyping sake I'm just going to coerce
+      latitude = latitude.to_f
+      longitude = longitude.to_f
+      client.get(url: "/nearest_city?lat=#{latitude}&lon=#{longitude}")
+    end
+
+    # Only going to support American states for an MVP
+    # Typical American exceptionalism, amirite? ;)
+    def city_by_name_and_state(city:, state:)
+      client.get(url: "/city?city=#{city}&state=#{state}&country=USA")
+    end
+
+  private
+
+    def client
+      @client ||= AirVisualApi::Client.new
+    end
+  end
+end

data/lib/airvisual_api/client.rb

@@ -0,0 +1,24 @@
+require 'httparty'
+
+module AirVisualApi
+  class Client
+    BASE_URI = 'http://api.airvisual.com/v2'
+
+    def initialize(api_key: ENV['AIRVISUAL_API_KEY'])
+      # defaults to env variable but can be specified
+      @api_key = api_key
+    end
+
+    def get(url:)
+      HTTParty.get(BASE_URI + url + key_param)
+    end
+
+  private
+
+    attr_reader :api_key
+
+    def key_param
+      "&key=#{api_key}"
+    end
+  end
+end

data/lib/airvisual_api/version.rb

@@ -0,0 +1,3 @@
+module AirVisualApi
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: airvisual_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joey Ferguson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby interface to retrieve air quality data from the AirVisual API
+  based on various location types
+email:
+- fergmastaflex@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- airvisual_api.gemspec
+- bin/console
+- bin/setup
+- lib/airvisual_api.rb
+- lib/airvisual_api/city.rb
+- lib/airvisual_api/client.rb
+- lib/airvisual_api/version.rb
+homepage: http://github.com/airvisual_api
+licenses: []
+metadata:
+  homepage_uri: http://github.com/airvisual_api
+  source_code_uri: http://github.com/airvisual_api
+  changelog_uri: http://github.com/airvisual_api
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for IQAir's AirVisual API
+test_files: []