rb_wunderground 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in rb_wunderground.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2012 Robert J Samson
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,72 @@
1
+ # RbWunderground
2
+
3
+ A simple wrapper for the Weather Underground API that returns a Hashie::Mash for convenience.
4
+
5
+ TODO: Write more tests, add ability to search multiple features in one query.
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ gem 'rb_wunderground'
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install rb_wunderground
20
+
21
+ ## Usage
22
+ To get started, create a new instance of RbWunderground::Base with your Weather Underground API key.
23
+
24
+ ```ruby
25
+ w = RbWundergound::Base.new('API_KEY')
26
+ ```
27
+
28
+ The following is available through the Weather Underground's JSON API:
29
+
30
+ ```
31
+ alerts
32
+ almanac
33
+ astronomy
34
+ conditions
35
+ currenthurricaine
36
+ forecast
37
+ forecast10day
38
+ geolookup
39
+ history_YYYMMDD
40
+ hourly
41
+ hourly10day
42
+ planner_MMDDMMDD
43
+ rawtide
44
+ tide
45
+ webcams
46
+ yesterday
47
+ ```
48
+
49
+ These queries are available as methods with a location passed to each in a format accepted by Weather Underground and return a Hashie::Mash of the JSON results.
50
+
51
+ ```ruby
52
+ w = RbWundergound::Base.new('API_KEY')
53
+ # Location by Zip Code
54
+ forecast = w.forecast('12207')
55
+ # Location by US State and City
56
+ forecast = w.forecast('NY/Albany')
57
+ # Location by Country and City
58
+ forecast = w.forecast('England/London')
59
+ # Location by airport code
60
+ forecast = w.forecast('KALB')
61
+ # Historical info for a date
62
+ history = w.history('12207')
63
+
64
+ ```
65
+
66
+ ## Contributing
67
+
68
+ 1. Fork it
69
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
70
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
71
+ 4. Push to the branch (`git push origin my-new-feature`)
72
+ 5. Create new Pull Request
data/Rakefile ADDED
@@ -0,0 +1 @@
1
+ require "bundler/gem_tasks"
@@ -0,0 +1,45 @@
1
+ require 'json'
2
+ require 'httparty'
3
+ require 'hashie'
4
+
5
+ module RbWunderground
6
+ class Base
7
+ FEATURES = %w[conditions forecast forecast10day almanac hourly hourly10day alerts astronomy tide yesterday currenthurricaine geolookup rawtide webcams]
8
+
9
+ attr_reader :api_key
10
+ attr_reader :format
11
+
12
+ def initialize(key)
13
+ @api_key = key
14
+ @format = ".json"
15
+ end
16
+
17
+ def base_url
18
+ "http://api.wunderground.com/api/#{api_key}/"
19
+ end
20
+
21
+ FEATURES.each do |name|
22
+ define_method(name) do |arg|
23
+ url = base_url + name + "/q/" + arg + format
24
+ fetch_result(url)
25
+ end
26
+ end
27
+
28
+ def method_missing(name, *args, &block)
29
+ if name =~ /^history_(.+)$/ || name =~ /^planner_(.+)$/
30
+ url = base_url + name.to_s + "/q/" + args[0] + format
31
+ fetch_result(url)
32
+ else
33
+ super
34
+ end
35
+ end
36
+
37
+ def fetch_result(url)
38
+ response = HTTParty.get(url)
39
+ Hashie::Mash.new(JSON.parse(response.body))
40
+ end
41
+ private :fetch_result
42
+
43
+ end
44
+
45
+ end
@@ -0,0 +1,3 @@
1
+ module RbWunderground
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,2 @@
1
+ require "rb_wunderground/version"
2
+ require "rb_wunderground/base"
@@ -0,0 +1,23 @@
1
+ # -*- encoding: utf-8 -*-
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'rb_wunderground/version'
5
+
6
+ Gem::Specification.new do |gem|
7
+ gem.name = "rb_wunderground"
8
+ gem.version = RbWunderground::VERSION
9
+ gem.authors = ["Robert J Samson"]
10
+ gem.email = ["rjsamson@me.com"]
11
+ gem.description = %q{A simple wrapper for the Weather Underground JSON API}
12
+ gem.summary = %q{A simple wrapper for the Weather Underground JSON API}
13
+ gem.homepage = ""
14
+
15
+ gem.add_runtime_dependency "json", "~> 1.7"
16
+ gem.add_runtime_dependency "httparty", "~> 0.9"
17
+ gem.add_development_dependency "rspec", "~> 2.11"
18
+
19
+ gem.files = `git ls-files`.split($/)
20
+ gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
21
+ gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
22
+ gem.require_paths = ["lib"]
23
+ end
@@ -0,0 +1,17 @@
1
+ require 'rb_wunderground'
2
+
3
+ describe RbWunderground::Base do
4
+
5
+ describe "initialization" do
6
+ before { @w = RbWunderground::Base.new('fake_api_key') }
7
+
8
+ it "sets the API key on initialization" do
9
+ @w.api_key.should eql('fake_api_key')
10
+ end
11
+
12
+ it "has a base url containing the API key" do
13
+ @w.base_url.should eql("http://api.wunderground.com/api/fake_api_key/")
14
+ end
15
+ end
16
+
17
+ end
metadata ADDED
@@ -0,0 +1,104 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: rb_wunderground
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - Robert J Samson
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2012-12-12 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: json
16
+ requirement: !ruby/object:Gem::Requirement
17
+ none: false
18
+ requirements:
19
+ - - ~>
20
+ - !ruby/object:Gem::Version
21
+ version: '1.7'
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - ~>
28
+ - !ruby/object:Gem::Version
29
+ version: '1.7'
30
+ - !ruby/object:Gem::Dependency
31
+ name: httparty
32
+ requirement: !ruby/object:Gem::Requirement
33
+ none: false
34
+ requirements:
35
+ - - ~>
36
+ - !ruby/object:Gem::Version
37
+ version: '0.9'
38
+ type: :runtime
39
+ prerelease: false
40
+ version_requirements: !ruby/object:Gem::Requirement
41
+ none: false
42
+ requirements:
43
+ - - ~>
44
+ - !ruby/object:Gem::Version
45
+ version: '0.9'
46
+ - !ruby/object:Gem::Dependency
47
+ name: rspec
48
+ requirement: !ruby/object:Gem::Requirement
49
+ none: false
50
+ requirements:
51
+ - - ~>
52
+ - !ruby/object:Gem::Version
53
+ version: '2.11'
54
+ type: :development
55
+ prerelease: false
56
+ version_requirements: !ruby/object:Gem::Requirement
57
+ none: false
58
+ requirements:
59
+ - - ~>
60
+ - !ruby/object:Gem::Version
61
+ version: '2.11'
62
+ description: A simple wrapper for the Weather Underground JSON API
63
+ email:
64
+ - rjsamson@me.com
65
+ executables: []
66
+ extensions: []
67
+ extra_rdoc_files: []
68
+ files:
69
+ - .gitignore
70
+ - Gemfile
71
+ - LICENSE.txt
72
+ - README.md
73
+ - Rakefile
74
+ - lib/rb_wunderground.rb
75
+ - lib/rb_wunderground/base.rb
76
+ - lib/rb_wunderground/version.rb
77
+ - rb_wunderground.gemspec
78
+ - spec/rb_wunderground_spec.rb
79
+ homepage: ''
80
+ licenses: []
81
+ post_install_message:
82
+ rdoc_options: []
83
+ require_paths:
84
+ - lib
85
+ required_ruby_version: !ruby/object:Gem::Requirement
86
+ none: false
87
+ requirements:
88
+ - - ! '>='
89
+ - !ruby/object:Gem::Version
90
+ version: '0'
91
+ required_rubygems_version: !ruby/object:Gem::Requirement
92
+ none: false
93
+ requirements:
94
+ - - ! '>='
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ requirements: []
98
+ rubyforge_project:
99
+ rubygems_version: 1.8.24
100
+ signing_key:
101
+ specification_version: 3
102
+ summary: A simple wrapper for the Weather Underground JSON API
103
+ test_files:
104
+ - spec/rb_wunderground_spec.rb