wunderground_api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53ad1a78186930a4840378aedd254231e4061cfd
+  data.tar.gz: 821a98fae030a151f1559183b54e923f2afb5ad7
+SHA512:
+  metadata.gz: a5dc3219fcdad728a3430ee7d97bc8886965ed573e6265fb800fa4c9db0fcd4dbf42f0365c1ad410f6ef461e9709a4770a85cfe291cc96c24bfe226c77a83f4d
+  data.tar.gz: 9ee0d993eb9786b3cb828dcc5cc2cf5ca05c04606512acab38812864d070ceeba6e6e22d78d652bde8764264a1adbac9321daf2c6ee0b1d85655eb0e3ca423a2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wunderground_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Josh Haywood
+
+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,81 @@
+# Wunderground
+
+Weather Underground API Wrapper. Curretly includes support for all data features.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wunderground_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wunderground_api
+
+## Usage
+
+You will need a Wunderground API Key available [here](https://www.wunderground.com/weather/api/).
+
+Configure your Wunderground to use the API key you receive.
+```ruby
+Wunderground.configure do |config|
+  config.api_key = ENV['WUNDERGROUND_API_KEY']
+end
+```
+
+### Data Objects
+
+Available data objects are alerts, **almanac**, **astronomy**, **conditions**, **currenthurricane**, **forecast**, **forecast10day**, **geolookup**, **history**, **hourly**, **hourly10day**, **planner**, **rawtide**, **satellite**, **tide**, **webcams**, and **yesterday**. More information about each of these data objects can be found in the [Wunderground API documentation](https://www.wunderground.com/weather/api/d/docs).
+
+To make a call for a data object where the arguments passed are the location parameters:
+
+```ruby
+Wunderground::Resources.almanac(zip: '10001')
+Wunderground::Resources.conditions(city: 'New York', state: 'NY')
+Wunderground::Resources.hourly10day(city: 'London', state: 'England')
+etc...
+```
+
+This will return a hash of the response body for the location provided. The schemas for the response objects can be found in the [Wunderground API documentation](https://www.wunderground.com/weather/api/d/docs).
+
+Calls can be chained by joining resources with `_and_`. This will allow you to make fewer HTTP requests when multiple endpoints are needed.
+
+```ruby
+Wunderground::Resources.almanac_and_forecast(zip: '10001')
+Wunderground::Resources.geolookup_and_conditions(city: 'New York', state: 'NY')
+Wunderground::Resources.alerts_and_conditions_and_hourly10day(city: 'London', state: 'England')
+etc...
+```
+
+### Locations
+
+There are several ways to provide the location for the data object you wish to retrieve:
+- Zip Code `(zip: '10001')`
+- US City/State `(city: 'New York', state: 'NY')`
+- International City/Country `(city: 'London', country: 'England')`
+- Airport Code `(airport: 'LGA')`
+- Latitude/Longitude `(lat: '40.748817', long: '-73.985428')`
+- Private Weather Station Code `(pws: B12E942)`
+- AutoIP Detection `(autoip: true)`
+
+## 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/johaywood/wunderground.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wunderground"
+
+# 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

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/wunderground/client.rb

@@ -0,0 +1,9 @@
+module Wunderground
+  class Client
+
+    def self.get(url, *options)
+      uri = URI(Wunderground.domain + url)
+      Net::HTTP.get_response(uri)
+    end
+  end # Client
+end # Wunderground

data/lib/wunderground/configuration.rb

@@ -0,0 +1,36 @@
+module Wunderground
+  module Configuration
+    VALID_CONNECTION_KEYS = [:domain, :user_agent, :method].freeze
+    VALID_OPTIONS_KEYS    = [:api_key, :format].freeze
+    VALID_CONFIG_KEYS     = VALID_CONNECTION_KEYS + VALID_OPTIONS_KEYS
+
+    DEFAULT_DOMAIN      = "http://api.wunderground.com/".freeze
+    DEFAULT_USER_AGENT  = "Wunderground Ruby Gem #{Wunderground::VERSION}".freeze
+    DEFAULT_API_KEY     = "default_api_key"
+
+    DEFAULT_METHOD       = :get
+    DEFAULT_FORMAT       = :json
+
+    # Build accessor methods for every config option
+    attr_accessor *VALID_CONFIG_KEYS
+
+    # Make sure we have the default values set when we get 'extended'
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def reset
+      self.domain     = DEFAULT_DOMAIN
+      self.method     = DEFAULT_METHOD
+      self.user_agent = DEFAULT_USER_AGENT
+
+      self.api_key    = DEFAULT_API_KEY
+      self.format     = DEFAULT_FORMAT
+    end
+
+  end # Configuration
+end # Wunderground

data/lib/wunderground/location.rb

@@ -0,0 +1,32 @@
+module Wunderground
+  class Location
+    attr_accessor :state, :city, :country, :city, :zip, :airport, :lat, :long, :pws, :autoip
+
+    def initialize(options = {})
+      raise ArgumentError, "No Location Options Provided" if options.empty?
+      options.each do |key, value|
+        instance_variable_set("@#{key}".to_sym, value)
+      end
+    end
+
+    def location
+      if zip
+        zip
+      elsif state && city
+        "#{state}/#{city.gsub(' ', '_')}"
+      elsif country && city
+        "#{country.gsub(' ', '_')}/#{city.gsub(' ', '_')}"
+      elsif airport
+        airport
+      elsif lat && long
+        "#{lat},#{long}"
+      elsif pws
+        "pws:#{pws}"
+      elsif autoip
+        "autoip"
+      else
+        raise ArgumentError, "Invalid Location Options"
+      end
+    end
+  end
+end

data/lib/wunderground/resources.rb

@@ -0,0 +1,18 @@
+module Wunderground
+  module Resources
+
+    RESOURCES = [
+      :alerts, :almanac, :astronomy, :conditions,
+      :currenthurricane, :forecast, :forecast10day, :geolookup,
+      :history, :hourly, :hourly10day, :planner,
+      :rawtide, :satellite, :tide, :webcams, :yesterday
+    ]
+
+    def self.method_missing(sym, options = {})
+      queries = sym.to_s.split("_and_").map(&:to_sym)
+      location = Location.new(options).location
+      raise NoMethodError unless (queries - RESOURCES).empty?
+      JSON.parse Client.get("api/#{Wunderground.api_key}/#{queries.join("/")}/q/#{location}.json").body
+    end
+  end
+end

data/lib/wunderground/version.rb

@@ -0,0 +1,3 @@
+module Wunderground
+  VERSION = "0.1.1"
+end

data/lib/wunderground.rb

@@ -0,0 +1,12 @@
+require 'json'
+require 'net/http'
+
+require_relative "wunderground/version"
+require_relative "wunderground/configuration"
+require_relative "wunderground/client"
+require_relative "wunderground/resources"
+require_relative "wunderground/location"
+
+module Wunderground
+  extend Configuration
+end

data/wunderground.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wunderground/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wunderground_api"
+  spec.version       = Wunderground::VERSION
+  spec.authors       = ["Josh Haywood"]
+  spec.email         = ["josh.haywood@validic.com"]
+
+  spec.summary       = "API Wrapper for Wunderground"
+  spec.description   = "API Wrapper for Wunderground"
+  spec.homepage      = "https://github.com/johaywood/wunderground"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "vcr", "~> 3.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: wunderground_api
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Josh Haywood
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: API Wrapper for Wunderground
+email:
+- josh.haywood@validic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wunderground.rb
+- lib/wunderground/client.rb
+- lib/wunderground/configuration.rb
+- lib/wunderground/location.rb
+- lib/wunderground/resources.rb
+- lib/wunderground/version.rb
+- wunderground.gemspec
+homepage: https://github.com/johaywood/wunderground
+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.4.5
+signing_key: 
+specification_version: 4
+summary: API Wrapper for Wunderground
+test_files: []