geonames_api 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Sean Devine
+
+MIT License
+
+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,75 @@
+# GeoNames API
+
+This is a lightweight client for the [GeoNames](http://www.geonames.org) API. Huge thanks to them for such a great service!
+
+There are many GeoNames API clients. BUT, most are rewritten versions of a Java API whose interface is a little funny =|
+
+This is a simplified ruby implementation that does not implement the entire API. But, its lightweight and has a nice interface and will be easy to extend :)
+
+The gem was written by [@barelyknown](http://twitter.com/barelyknown).
+
+## Getting Started
+
+Add this line to your application's Gemfile:
+
+    gem 'geonames_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install geonames_api
+
+## Usage
+
+### FYI
+
+GeoNamesAPI uses conventions similar to Rails' ActiveRecord. If you add any features, please stick to `find` and `all` as the core query methods.
+
+The data is converted into the type implied by the content by default. If that isn't sufficient, let's create something more explicit for the exceptions.
+
+The GeoNamesAPI classes include getters and setters that are the GeoNames API field names converted dynamically to more rubyish names using Rails' ActiveSupport `underscore` method. If the API ever changes, the attributes of the classes will change.
+
+### Configuration
+
+The gem is setup to use the `demo` user account by default. You'll need to provide your own credentials for anything but a simple set of test searches.
+
+    > GeoNamesAPI.username = "yourusername@yourdomain.com"
+    > GeoNamesAPI.lang = :en
+    
+For a complete list of the config options, take a look at the `geonames_api.rb` file.
+
+### Country
+
+The geonames api uses the ISO code of the country as its natural key. 
+
+    > GeoNamesAPI::Country.new("US").find
+    
+    => #<GeoNamesAPI::Country:0x007fd43503dfc0 @country_code="US", @country_name="United States", @currency_code="USD", @fips_code="US", @iso_numeric=840, @north=49.388611, @capital="Washington", @continent_name="North America", @area_in_sq_km=9629091.0, @languages="en-US,es-US,haw,fr", @iso_alpha3="USA", @continent="NA", @south=24.544245, @east=-66.954811, @geoname_id=6252001, @west=-124.733253, @population=310232863>
+
+    > GeoNamesAPI::Country.all
+    
+    => ... array of GeoNamesAPI::Country instances
+
+### Weather
+
+The geonames api uses the latitude and longitude of the place as the parameters for its weather service.
+
+    > GeoNamesAPI::Weather.new(41.88,-87.68).find
+    
+    => #<GeoNamesAPI::Weather:0x007fab1c80dc10 @latitude=41.88, @longitude=-87.68, @weather_condition="n/a", @clouds="few clouds", @observation="KMDW 012051Z 28009KT 10SM FEW049 BKN070 11/M02 A2983 RMK AO2 SLP105 T01111022 55010", @wind_direction=280, @icao="KMDW", @sea_level_pressure=1010.5, @elevation=188, @country_code="US", @clouds_code="FEW", @lng=-87.75, @temperature=11.1, @dew_point="-2.2", @wind_speed=9, @humidity=39, @station_name="Chicago, Chicago Midway Airport", @datetime="2012-11-01 20:51:00", @lat=41.78333333333333>
+
+### Others
+
+The other services will be implemented as needed. In the mean time, feel free to contribute! Let's keep the style consistent.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+6. Thanks <3

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/geonames_api.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'geonames_api/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "geonames_api"
+  gem.version       = GeoNamesAPI::VERSION
+  gem.authors       = ["Sean Devine"]
+  gem.email         = ["barelyknown@icloud.com"]
+  gem.description   = %q{Simple ruby client for the GeoNames API to get free and easy geographic info.}
+  gem.summary       = %q{This is a lightweight client for the GeoNames API. Huge thanks to them for such a great service! There are many GeoNames API clients. BUT, most are rewritten versions of a Java API whose interface is a little funny =| This is a simplified ruby implementation that does not implement the entire API. But, its lightweight and has a nice interface and will be easy to extend :)}
+  gem.homepage      = "https://github.com/buytruckload/geonames_api"
+  gem.add_runtime_dependency "activesupport"
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/geonames_api.rb

@@ -0,0 +1,42 @@
+require 'open-uri'
+require 'json'
+require 'active_support/all'
+require "geonames_api/version"
+require "geonames_api/country"
+require "geonames_api/weather"
+
+module GeoNamesAPI
+  BASE_URL = "http://api.geonames.org/"
+  
+  def self.to_url_params(params)
+    "?" + params.collect { |key, value| "#{key}=#{value}" }.join("&")
+  end
+  
+  mattr_accessor :formatted
+  @@formatted = true
+  
+  mattr_accessor :lang
+  @@lang = :en
+  
+  mattr_accessor :username
+  @@username = "demo"
+  
+  mattr_accessor :style
+  @@style = :full
+  
+  def self.params
+    { formatted: formatted, lang: lang, username: username, style: style }
+  end
+  
+  def self.set_default_type(value)
+    case value
+    when /\A\d+\Z/
+      value.to_i
+    when /\A\d*\.\d*\Z/
+      value.to_f
+    else
+      value
+    end
+  end
+  
+end

data/lib/geonames_api/country.rb

@@ -0,0 +1,47 @@
+module GeoNamesAPI
+  class Country
+
+    METHOD = "countryInfoJSON"
+        
+    def self.all
+      JSON.load(open(url).read)["geonames"].collect do |response|
+        new.parse(response)
+      end
+    end
+    
+    attr_accessor :country_code
+    
+    def initialize(country_code=nil)
+      self.country_code = country_code
+    end 
+
+    def find
+      parse(JSON.load(open(url).read)["geonames"].first)
+      self
+    end
+    
+    def parse(response)
+      response.each do |key, value|
+        attr_name = key.underscore.to_sym
+        self.class.send(:attr_accessor, attr_name) unless respond_to? attr_name
+        value = GeoNamesAPI.set_default_type(value)
+        send("#{attr_name}=", value)
+      end 
+      self
+    end
+
+    def params
+      GeoNamesAPI.params.merge({ country: country_code })
+    end
+    
+    def url
+      self.class.url(params)
+    end
+        
+    def self.url(params={})
+      params = GeoNamesAPI.params.merge(params)
+      GeoNamesAPI::BASE_URL + METHOD + GeoNamesAPI.to_url_params(params)
+    end
+        
+  end
+end

data/lib/geonames_api/version.rb

@@ -0,0 +1,3 @@
+module GeoNamesAPI
+  VERSION = "0.0.1"
+end

data/lib/geonames_api/weather.rb

@@ -0,0 +1,35 @@
+module GeoNamesAPI
+  class Weather
+    METHOD = "findNearByWeatherJSON"
+    
+    attr_accessor :latitude, :longitude
+    
+    def initialize(latitude, longitude)
+      self.latitude, self.longitude = latitude, longitude
+    end
+    
+    def find
+      parse(JSON.load(open(url).read)["weatherObservation"])
+      self
+    end
+    
+    def parse(response)
+      response.each do |key, value|
+        attr_name = key.underscore.to_sym
+        self.class.send(:attr_accessor, attr_name) unless respond_to? attr_name
+        value = GeoNamesAPI.set_default_type(value)
+        send("#{attr_name}=", value)
+      end 
+      self
+    end
+    
+    def params
+      GeoNamesAPI.params.merge({ lat: latitude, lng: longitude })
+    end
+        
+    def url
+      GeoNamesAPI::BASE_URL + METHOD + GeoNamesAPI.to_url_params(params)
+    end
+
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: geonames_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sean Devine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple ruby client for the GeoNames API to get free and easy geographic
+  info.
+email:
+- barelyknown@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- geonames_api.gemspec
+- lib/geonames_api.rb
+- lib/geonames_api/country.rb
+- lib/geonames_api/version.rb
+- lib/geonames_api/weather.rb
+homepage: https://github.com/buytruckload/geonames_api
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: This is a lightweight client for the GeoNames API. Huge thanks to them for
+  such a great service! There are many GeoNames API clients. BUT, most are rewritten
+  versions of a Java API whose interface is a little funny =| This is a simplified
+  ruby implementation that does not implement the entire API. But, its lightweight
+  and has a nice interface and will be easy to extend :)
+test_files: []