gannet 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a3eca4434ca9beeac5cd3ae2e986a64d4990e98d5b15163e915e99dcd565ec94
+  data.tar.gz: 242172efd7f5c462de4d7992e0cf0245aea81a8753309ffd94acd0c3b0882e0c
+SHA512:
+  metadata.gz: b5ce39b3649a74c3b9d88c36fbb0ae07699267d358ab42a7d683dfc73ab50061e23d9d7975595e914eab5f181b03aeaf1876fa52dfda5e0b381f6192300de067
+  data.tar.gz: 87f92f54b27f1d030638565ca0f94c63cabcd25ace01817d96b62b7ad72ba819082978c202462dfc10d63b8aa0cefa882c2bf7f4da416610ce84fe113a7741f1

data/.gitignore

@@ -0,0 +1,9 @@
+# Mac nonsense
+.DS_Store
+
+# Don't checkin Gemfile.lock
+# See: http://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/
+Gemfile.lock
+
+# Ignore any created gems
+gannet-*

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2020 John Akers
+
+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,38 @@
+# Gannet
+
+A RubyGem wrapp for [AirNow's API](https://docs.airnowapi.org/)
+
+### Installation
+
+```rb
+gem install gannet
+```
+
+or in your Gemfile...
+
+```rb
+gem 'gannet'
+```
+
+### Configuration
+
+You will need to set your AirNow `api_key`  before making requests. You can get one [here](https://docs.airnowapi.org/account/request).
+
+```rb
+Gannet.configure do |c|
+  c.api_key = 'YOUR_API_KEY'
+end
+```
+
+### Usage / Examples (TODO)
+
+Once configured, you have access to the below methods. They correspond to the available endpoints, listed on AirNow's API.
+
+```rb
+query = { zipCode: 94118 }
+Gannet::WebServices.forecast_zip_code(query)
+
+# ... In Progress
+```
+
+Full documentation on what can be in `query` can be found in AirNow's API documentation [here](https://docs.airnowapi.org/)

data/gannet.gemspec

@@ -0,0 +1,24 @@
+$LOAD_PATH.push(File.expand_path('../lib', __FILE__))
+
+require 'gannet/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'gannet'
+  s.version     = Gannet::VERSION
+  s.authors     = ['John Akers']
+  s.homepage    = 'https://github.com/johnakers/gannet'
+  s.summary     = 'Wrapper for AirNow'
+  s.description = 'RubyGem for AirNow, in order to get air quality information'
+  s.licenses    = ['MIT']
+  s.require_paths = ['lib']
+
+  #
+  s.add_dependency('httparty', '~> 0.18.1')
+
+  #
+  s.add_development_dependency('rspec', '~> 3.9.0')
+  s.add_development_dependency('pry', '~> 0.13.1')
+
+  # files
+  s.files = `git ls-files`.split("\n")
+end

data/lib/gannet.rb

@@ -0,0 +1,18 @@
+# gems
+require 'httparty'
+
+# files
+require 'gannet/version'
+require 'gannet/configuration'
+require 'gannet/web_services/forecast_zip_code'
+
+module Gannet
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+end

data/lib/gannet/configuration.rb

@@ -0,0 +1,10 @@
+module Gannet
+  class Configuration
+    attr_reader :url
+    attr_accessor :api_key
+
+    def initialize
+      @url = 'https://www.airnowapi.org'
+    end
+  end
+end

data/lib/gannet/version.rb

@@ -0,0 +1,3 @@
+module Gannet
+  VERSION = '0.0.0'
+end

data/lib/gannet/web_services/forecast_zip_code.rb

@@ -0,0 +1,9 @@
+module Gannet
+  module WebServices
+    def self.forecast_zip_code(params)
+      url = "#{Gannet.configuration.url}/aq/forecast/zipCode"
+      query = params.merge(API_KEY: Gannet.configuration.api_key)
+      HTTParty.get(url, query: query)
+    end
+  end
+end

data/spec/gannet/web_services/forecast_zip_code_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+RSpec.describe Gannet::WebServices do
+  describe '.forecast_zip_code' do
+    let(:query) do
+      {
+        format: 'application/json',
+        zipCode: 94118
+      }
+    end
+
+    let(:forecast_zip_code_response) do
+      double(
+        code: 200,
+        parsed_response: [
+          {
+            'DateIssue' => '2020-10-10 ',
+            'DateForecast' => '2020-10-11 ',
+            'ReportingArea' => 'San Francisco',
+            'StateCode' => 'CA',
+            'Latitude' => 37.75,
+            'Longitude' => -122.43,
+            'ParameterName' => 'PM2.5',
+            'AQI' => 89,
+            'Category' => {
+              'Number' => 2,
+              'Name' => 'Moderate'
+            },
+            'ActionDay' => false
+          }
+        ]
+      )
+    end
+
+    before do
+      allow(HTTParty).to receive(:get).
+        and_return(forecast_zip_code_response)
+
+      Gannet.configure { |c| c.api_key = 'mock_api_key' }
+    end
+
+    it 'returns the current forecaset by zip code' do
+      expect(HTTParty).to receive(:get).
+        with(
+          "#{Gannet.configuration.url}/aq/forecast/zipCode",
+          query: query.merge(API_KEY: Gannet.configuration.api_key)
+        ).
+        and_return(forecast_zip_code_response)
+
+      Gannet::WebServices.forecast_zip_code(query)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'pry'
+require 'gannet'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: gannet
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- John Akers
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+description: RubyGem for AirNow, in order to get air quality information
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- gannet.gemspec
+- lib/gannet.rb
+- lib/gannet/configuration.rb
+- lib/gannet/version.rb
+- lib/gannet/web_services/forecast_zip_code.rb
+- spec/gannet/web_services/forecast_zip_code_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/johnakers/gannet
+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: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Wrapper for AirNow
+test_files: []