geonames_api 0.0.6 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e01b04a032c053533c4b76638fc31b4777f5b8e
+  data.tar.gz: bd3e6b7a88b1376282220737a1d2870046db9af4
+SHA512:
+  metadata.gz: f175f17720e7a8e6b3b404320593f1f7a2a6841d0c63bae16b95d6f5dc4c40a779b8e0b95f4902ea93da69f280b98718ce25ed2722b2586e0084057fbffc4e27
+  data.tar.gz: 088b25cd53a9c1533aa67df6b11d709020c45d67514911384859ef1b7fa28aeef94b10c490197e559b8ab9e43bbe942bdc3f4a5bb35702bd67d7d099165ecc63

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+.rvmrc
 .yardoc
 Gemfile.lock
 InstalledFiles
@@ -15,3 +16,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+test.log

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+# - 1.8.7 is not supported due to a 1.9-style hash in geonames_api.rb :\
+
+script: GEONAMES_USER=geonames_api_ci bundle exec rake --trace

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+## 0.1.0
+
+### New features:
+
+* When the GeoNames API returns a database or server timeout, your request
+  will be retried at most ```GeoNamesAPI.retries``` times. Default is 2, and
+  the delay between requests is at most ```GeoNamesAPI.max_sleep_time_between_retries```
+  (which defaults to 5 seconds).
+
+* Several endpoints accept multiple param sets, and the order of the parameters
+  is not always in the order or priority, so ```find``` and ```all``` and ```where```
+  now also accept a parameter hash.
+
+* ```GeoNamesAPI::Hierarchy``` is now an Enumerable of ```GeoName``` instances, as
+  all responses will have an ordered set of those entity types.
+
+* URL parameters are properly encoded now.
+
+* For paid users, set ```GeoNamesAPI.token``` and set the ```GeoNamesAPI.url```
+  to the ```https``` endpoint.
+
+* Callers can rescue on ```GeoNamesAPI::InvalidParameter``` and ```GeoNamesAPI::InvalidInput``` now.
+
+* GeoNamesAPI.formatted was deleted. The consumer shouldn't care if the JSON response
+  was pretty-printed.
+
+* Timezones, AlternateNames, and GeoName entities are encoded as class instances now
+

data/README.md

@@ -1,12 +1,23 @@
 # GeoNames API
 
+[![Build Status](https://secure.travis-ci.org/mceachen/geonames_api.png?branch=master)](http://travis-ci.org/mceachen/geonames_api)
+[![Code Climate](https://codeclimate.com/github/mceachen/geonames_api.png)](https://codeclimate.com/github/mceachen/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).
+The gem was originally written by [@barelyknown](http://twitter.com/barelyknown).
+
+This fork adds
+* automatic retries on timeout,
+* properly encoded url parameters,
+* support for paid users (with https and API tokens)
+* more consistent ```find``` and ```where``` methods across endpoints
+* Timezone, AlternateName, and GeoName entries properly encoded in results
+* better test coverage, Travis CI, and CodeClimate integration
 
 ## Getting Started
 
@@ -184,4 +195,4 @@ The other services will be implemented as needed. In the mean time, feel free to
 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
+6. Thanks <3

data/Rakefile

@@ -1 +1,14 @@
 require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec

data/geonames_api.gemspec

@@ -6,17 +6,19 @@ 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.authors       = ["Sean Devine", "Matthew McEachen"]
+  gem.email         = ["barelyknown@icloud.com", "matthew-github@mceachen.org"]
   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.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, it's 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.add_runtime_dependency "tzinfo"
   gem.add_runtime_dependency "zipruby"
-  
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+
   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

@@ -3,34 +3,45 @@ require 'json'
 require 'csv'
 require 'active_support/all'
 require 'zipruby'
-require "geonames_api/version"
-require "geonames_api/hash"
-require "geonames_api/error"
-require "geonames_api/object"
-require "geonames_api/country"
-require "geonames_api/weather"
-require "geonames_api/time_zone"
-require "geonames_api/wikipedia"
 
 module GeoNamesAPI
-  
+
   mattr_accessor :url
-  @@url = "http://api.geonames.org/"
+  self.url = 'http://api.geonames.org/'
 
-  mattr_accessor :formatted
-  @@formatted = true
-  
   mattr_accessor :lang
-  @@lang = :en
+  self.lang = :en
   
   mattr_accessor :username
-  @@username = "demo"
-  
+  self.username = 'demo'
+
+  mattr_accessor :token
+  self.token = nil
+
   mattr_accessor :style
-  @@style = :full
-  
+  self.style = :full
+
+  mattr_accessor :logger
+  self.logger = nil
+
+  mattr_accessor :retries
+  self.retries = 3
+
+  mattr_accessor :max_sleep_time_between_retries
+  self.max_sleep_time_between_retries = 5
+
   def self.params
-    { formatted: formatted, lang: lang, username: username, style: style }
+    {
+      lang: lang,
+      username: username,
+      token: token,
+      style: style
+    }.delete_if{ |k, v| v.blank? }
   end
     
 end
+
+Dir[File.dirname(__FILE__) + '/geonames_api/*.rb'].each do |file|
+  tgt = File.basename(file, File.extname(file))
+  GeoNamesAPI.autoload tgt.camelize, "geonames_api/#{tgt}"
+end

data/lib/geonames_api/alternate_names.rb

@@ -0,0 +1,54 @@
+module GeoNamesAPI
+  # Arrays of Geoname instances are returned by `Hierarchy.find`
+  class AlternateNames
+
+    def initialize(alternate_names_array)
+      @name_by_lang = {}
+      alternate_names_array.each do |hash|
+        @name_by_lang[hash['lang']] = hash['name']
+      end
+    end
+
+    def [](lang)
+      @name_by_lang[lang]
+    end
+  end
+end
+
+=begin
+Expected input:
+[
+  {
+    "name": "els Abruços",
+    "lang": "ca"
+  },
+  {
+    "name": "Abruzzen",
+    "lang": "de"
+  },
+  {
+    "name": "Abruzzo",
+    "lang": "en"
+  },
+  {
+    "name": "Los Abruzos",
+    "lang": "es"
+  },
+  {
+    "name": "Abruzzes",
+    "lang": "fr"
+  },
+  {
+    "name": "Abruzzo",
+    "lang": "it"
+  },
+  {
+    "name": "http://en.wikipedia.org/wiki/Abruzzo",
+    "lang": "link"
+  },
+  {
+    "name": "Abruzzen",
+    "lang": "nl"
+  }
+]
+=end

data/lib/geonames_api/base.rb

@@ -0,0 +1,92 @@
+require 'cgi'
+
+module GeoNamesAPI
+  class Base < Entity
+
+    def self.find(*names_or_params)
+      result = where(name_params(names_or_params))
+      if result
+        endpoint_returns_list? ? result.first : result
+      end
+    end
+
+    def self.all(*names_or_params)
+      result = where(name_params(names_or_params))
+      if result
+        endpoint_returns_list? ? result : [result]
+      end
+    end
+
+    def self.where(params={})
+      retries_remaining = GeoNamesAPI.retries
+      url = url(params)
+      begin
+        response = make_request(url)
+        unless response.empty?
+          parse_response(response, params)
+        end
+      rescue Timeout => e
+        if retries_remaining > 0
+          retries_remaining -= 1
+          puts "retrying!"
+          sleep rand * GeoNamesAPI.max_sleep_time_between_retries
+          retry
+        else
+          raise e
+        end
+      end
+    end
+
+    def self.make_request(url)
+      JSON.load(open(url).read)
+    end
+
+    private_class_method :make_request
+
+    KEYS = %w(streetSegment geonames)
+
+    def self.parse_response(response, request_params)
+      GeoNamesAPI.logger.info "GEONAMES RESPONSE (#{Time.now}): #{response}" if GeoNamesAPI.logger
+      if (status = response['status'])
+        raise Error.from_status(status)
+      end
+      new(response, request_params)
+    end
+
+    private_class_method :parse_response
+
+    def self.url(params={})
+      endpoint = GeoNamesAPI.url + self::METHOD + params_to_url(GeoNamesAPI.params.merge(params))
+      GeoNamesAPI.logger.info "GEONAMES REQUEST (#{Time.now}): #{endpoint}" if GeoNamesAPI.logger
+      endpoint
+    end
+
+    private_class_method :url
+
+    def self.name_params(names)
+      return names.first if names.first.is_a? Hash
+      params, n = {}, 0
+      if names.any?
+        [self::FIND_PARAMS].flatten.each { |i| params[i] = names[n]; n+= 1 }
+      end
+      params.delete_if { |k, v| v.blank? }
+    end
+
+    private_class_method :name_params
+
+    def self.params_to_url(params={})
+      esc_params = params.map do |key, value|
+        "#{esc(key)}=#{esc(value)}"
+      end
+      "?#{esc_params.join('&')}"
+    end
+
+    private_class_method :params_to_url
+
+    def self.esc(str)
+      CGI::escape(str.to_s)
+    end
+
+    private_class_method :esc
+  end
+end

data/lib/geonames_api/children.rb

@@ -0,0 +1,85 @@
+module GeoNamesAPI
+  class Children < ListEndpoint
+
+    METHOD = "childrenJSON"
+    FIND_PARAMS = %w(geonameId)
+
+  end
+end
+
+=begin
+{
+  "totalResultsCount": 20,
+  "geonames": [
+    {
+      "alternateNames": [
+        {
+          "name": "els Abruços",
+          "lang": "ca"
+        },
+        {
+          "name": "Abruzzen",
+          "lang": "de"
+        },
+        {
+          "name": "Abruzzo",
+          "lang": "en"
+        },
+        {
+          "name": "Los Abruzos",
+          "lang": "es"
+        },
+        {
+          "name": "Abruzzes",
+          "lang": "fr"
+        },
+        {
+          "name": "Abruzzo",
+          "lang": "it"
+        },
+        {
+          "name": "http://en.wikipedia.org/wiki/Abruzzo",
+          "lang": "link"
+        },
+        {
+          "name": "Abruzzen",
+          "lang": "nl"
+        }
+      ],
+      "countryName": "Italy",
+      "adminCode1": "01",
+      "lng": "13.75",
+      "adminName2": "",
+      "fcodeName": "first-order administrative division",
+      "adminName3": "",
+      "timezone": {
+        "dstOffset": 2,
+        "gmtOffset": 1,
+        "timeZoneId": "Europe/Rome"
+      },
+      "adminName4": "",
+      "adminName5": "",
+      "bbox": {
+        "south": 41.68307876586914,
+        "east": 14.783888816833496,
+        "north": 42.8957405090332,
+        "west": 13.019405364990234
+      },
+      "name": "Abruzzo",
+      "fcode": "ADM1",
+      "geonameId": 3183560,
+      "lat": "42.25",
+      "population": 1338898,
+      "adminName1": "Abruzzo",
+      "countryId": "3175395",
+      "adminId1": "3183560",
+      "fclName": "country, state, region,...",
+      "countryCode": "IT",
+      "wikipediaURL": "",
+      "toponymName": "Regione Abruzzo",
+      "fcl": "A",
+      "numberOfChildren": 4,
+      "continentCode": "EU"
+    },
+
+=end

data/lib/geonames_api/city.rb

@@ -0,0 +1,8 @@
+module GeoNamesAPI
+  class City < ListEndpoint
+
+    METHOD = "citiesJSON"
+    FIND_PARAMS = %w(north south east west maxRows)
+
+  end
+end

data/lib/geonames_api/country.rb

@@ -1,8 +1,8 @@
 module GeoNamesAPI
-  class Country < GeoNamesAPI::Object
+  class Country < ListEndpoint
 
     METHOD = "countryInfoJSON"
-    ID = "country"
+    FIND_PARAMS = %w(country)
 
     EXPORT_BASE_URL = "http://download.geonames.org/export/zip/"
     EXPORT_HEADERS = %W(country_code postal_code place_name admin_name1 admin_code1 admin_name2 admin_code2 admin_name3 admin_code3 latitude longitude accuracy)
@@ -18,14 +18,14 @@ module GeoNamesAPI
       end
       csv
     end
-    
+
     def postal_code_csv
       CSV.parse(postal_code_export, headers: true, col_sep: "\t", header_converters: :symbol, encoding: "ISO8859-1")
     end
-    
+
     def postal_code_export_url
       EXPORT_BASE_URL + country_code + ".zip"
     end
-    
+
   end
-end
+end