geonames_api 0.1.1 → 0.1.2

data/.gitignore

@@ -15,5 +15,6 @@ rdoc
 spec/reports
 test/tmp
 test/version_tmp
-tmp
 test.log
+tmp/*.*
+.DS_Store

data/README.md

@@ -1,7 +1,7 @@
 # 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)
+[![Build Status](https://secure.travis-ci.org/buytruckload/geonames_api.png?branch=master)](http://travis-ci.org/buytruckload/geonames_api)
+[![Code Climate](https://codeclimate.com/repos/52a4b4c513d63712180028d4/badges/33cf2af8b28c4cb66098/gpa.png)](https://codeclimate.com/repos/52a4b4c513d63712180028d4/feed)
 
 This is a lightweight client for the [GeoNames](http://www.geonames.org) API. Huge thanks to them for such a great service!
 
@@ -11,16 +11,6 @@ This is a simplified ruby implementation that does not implement the entire API.
 
 ## 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
@@ -190,6 +180,8 @@ A number of nice features were added by [@mrm](http://twitter.com/mrm) including
 * Timezone, AlternateName, and GeoName entries properly encoded in results
 * better test coverage, Travis CI, and CodeClimate integration
 
+To contribute:
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/geonames_api.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |gem|
   
   gem.add_runtime_dependency "activesupport"
   gem.add_runtime_dependency "tzinfo"
-  gem.add_runtime_dependency "zipruby"
+  gem.add_runtime_dependency "rubyzip"
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
 

data/lib/geonames_api.rb

@@ -2,7 +2,7 @@ require 'open-uri'
 require 'json'
 require 'csv'
 require 'active_support/all'
-require 'zipruby'
+require 'zip'
 
 module GeoNamesAPI
 
@@ -25,10 +25,10 @@ module GeoNamesAPI
   self.logger = nil
 
   mattr_accessor :retries
-  self.retries = 3
+  self.retries = 5
 
   mattr_accessor :max_sleep_time_between_retries
-  self.max_sleep_time_between_retries = 5
+  self.max_sleep_time_between_retries = 10
 
   def self.params
     {

data/lib/geonames_api/base.rb

@@ -28,7 +28,6 @@ module GeoNamesAPI
       rescue Timeout => e
         if retries_remaining > 0
           retries_remaining -= 1
-          puts "retrying!"
           sleep rand * GeoNamesAPI.max_sleep_time_between_retries
           retry
         else

data/lib/geonames_api/country.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 module GeoNamesAPI
   class Country < ListEndpoint
 
@@ -8,21 +10,61 @@ module GeoNamesAPI
     EXPORT_HEADERS = %W(country_code postal_code place_name admin_name1 admin_code1 admin_name2 admin_code2 admin_name3 admin_code3 latitude longitude accuracy)
 
     def postal_code_export
-      zip_data = open(postal_code_export_url) { |f| f.binmode; f.read }
-      stream = lambda { return zip_data.slice!(0, 256) }
-      csv = EXPORT_HEADERS.join("\t") + "\n"
-      Zip::Archive.open_buffer(stream) do |archive|
-        archive.each do |f|
-          csv << f.read if f.name =~ /\A#{country_code}/
-        end
-      end
-      csv
+      download_archive
+      extract_file
+      create_csv
     end
 
     def postal_code_csv
       CSV.parse(postal_code_export, headers: true, col_sep: "\t", header_converters: :symbol, encoding: "ISO8859-1")
     end
 
+  private
+
+    def download_archive
+      File.open(export_directory.to_s + "/export.zip", "wb") do |f|
+        open(postal_code_export_url, "rb") do |export|
+          f.write export.read
+        end
+      end
+    end
+
+    def extract_file
+      Zip::File.foreach(export_directory.to_s + "/export.zip") do |f|  
+        File.delete(extract_file_name) if File.exist?(extract_file_name)
+        f.extract(extract_file_name) if f.name =~ /\A#{country_code}/
+      end
+    end
+
+    def create_csv
+      File.open(csv_file_name, "wb") do |f|
+        f.write EXPORT_HEADERS.join("\t") + "\n"
+        f.write File.open(extract_file_name, "r").read
+      end
+      File.open(csv_file_name, "r").read
+    end
+
+    def extract_file_name
+      export_directory + "/tmp.txt"
+    end
+
+    def csv_file_name
+      export_directory + "/#{country_code}.txt"
+    end
+
+    # if rails is defined use the rails tmp directory to ensure
+    # compatability with heroku
+    def export_directory
+      directory = if defined?(Rails)
+        Rails.root.join("tmp","geonames_api").to_s
+      else
+        File.expand_path("../../../tmp", __FILE__)
+      end
+      FileUtils.mkdir(directory) unless File.directory?(directory)
+      FileUtils.chmod_R(0777, directory)
+      directory
+    end
+
     def postal_code_export_url
       EXPORT_BASE_URL + country_code + ".zip"
     end

data/lib/geonames_api/entity.rb

@@ -24,8 +24,8 @@ module GeoNamesAPI
       aliases = []
       value = @response[key]
       parsed_value = case (key)
-        when 'geonames', 'streetSegment'
-          aliases = [:geonames, :results]
+        when 'geonames', 'streetSegment', 'postalcodes'
+          aliases = [:geonames, :results, :postalcodes]
           value.map { |ea| self.class.new(ea) }
         when 'alternateNames'
           AlternateNames.new(value)

data/lib/geonames_api/error.rb

@@ -2,27 +2,51 @@ module GeoNamesAPI
   class Error < StandardError
     # See http://www.geonames.org/export/webservice-exception.html
     def self.from_status(status)
-      val = status['value'].to_i
-      error_type = case val
-        when 12, 13, 22
-          Timeout
-        when 14
-          InvalidParameter
-        when 21
-          InvalidInput
-        else
-          Error
+      error_code = status['value'].to_i
+      error_class = for_error_code(error_code) || self
+      raise error_class, "#{status['message']} (#{error_code})"
+    end
+
+    def self.for_error_code(error_code)
+      @lookup ||= subclasses.reduce({}) do |h, subclass|
+        subclass::ERROR_CODES.each { |ea| h[ea] = subclass }
+        h
       end
-      raise error_type, "#{status['message']} (#{val})"
+      @lookup[error_code]
     end
   end
 
+  class AuthorizationException < Error
+    ERROR_CODES = [10]
+  end
+  class RecordDoesNotExist < Error
+    ERROR_CODES = [11]
+  end
   class Timeout < Error
+    ERROR_CODES = [13, 22]
   end
-
   class InvalidParameter < Error
+    ERROR_CODES = [14]
   end
-
-  class InvalidInput < Error
+  class NoResultFound < Error
+    ERROR_CODES = [15]
+  end
+  class DuplicateException < Error
+    ERROR_CODES = [16]
+  end
+  class PostalCodeNotFound < Error
+    ERROR_CODES = [17]
+  end
+  class DailyLimitExceeded < Error
+    ERROR_CODES = [18]
+  end
+  class HourlyLimitExceeded < Error
+    ERROR_CODES = [19]
+  end
+  class WeeklyLimitExceeded < Error
+    ERROR_CODES = [20]
+  end
+  class ServiceNotImplemented < Error
+    ERROR_CODES = [23]
   end
 end

data/lib/geonames_api/neighbourhood.rb

@@ -0,0 +1,38 @@
+module GeoNamesAPI
+  class Neighbourhood < SingletonEndpoint
+    METHOD = 'neighbourhoodJSON'
+    FIND_PARAMS = %w(lat lng)
+
+    def hierarchy
+      %w{countryName adminName1 adminName2 city name}.map do |ea|
+        @neighbourhood[ea]
+      end
+    end
+  end
+end
+
+=begin
+
+{
+  "neighbourhood": {
+    "countryName": "United States",
+    "adminName1": "New York",
+    "adminName2": "New York County",
+    "city": "New York City-Manhattan",
+    "name": "Central Park",
+    "adminCode2": "061",
+    "adminCode1": "NY",
+    "countryCode": "US"
+  }
+}
+
+or
+
+{
+  "status": {
+    "message": "we are afraid we could not find a neighbourhood for latitude and longitude :XXX, YYYY",
+    "value": 15
+  }
+}
+
+=end

data/lib/geonames_api/version.rb

@@ -1,3 +1,3 @@
 module GeoNamesAPI
-  VERSION = Gem::Version.new('0.1.1')
+  VERSION = Gem::Version.new('0.1.2')
 end

data/spec/geonames_api/country_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+module GeoNamesAPI
+  describe Country do
+
+    subject do
+      described_class.find "CA"
+    end
+
+    it "can download and unpack the csv" do
+      expect(subject.postal_code_csv.size).to be > 0
+    end
+
+  end
+end

data/spec/geonames_api/neighbourhood_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe GeoNamesAPI::Neighbourhood do
+  describe "::find" do
+    it "should find NYC" do
+      result = GeoNamesAPI::Neighbourhood.find(lat: 40.78343, lng: -73.96625)
+      result.hierarchy.should == ["United States", "New York", "New York County", "New York City-Manhattan", "Central Park"]
+    end
+
+    it "should not find streets outside of the US" do
+      proc { GeoNamesAPI::Neighbourhood.find(0, 0) }.should raise_error GeoNamesAPI::Error
+    end
+  end
+end

data/spec/geonames_api/place_search_spec.rb

@@ -28,8 +28,9 @@ describe GeoNamesAPI::PlaceSearch do
 
   describe "#next_page" do
     it "should grab the next page of results from the same search" do
-      big_search = GeoNamesAPI::PlaceSearch.where(name: 'columbus', maxRows: 9)
-      search_pg1 = GeoNamesAPI::PlaceSearch.where(name: 'columbus', maxRows: 3)
+      # the paging with 'columbus' sometimes doesn't match across the 3 pages.
+      big_search = GeoNamesAPI::PlaceSearch.where(name: 'goleta', maxRows: 9)
+      search_pg1 = GeoNamesAPI::PlaceSearch.where(name: 'goleta', maxRows: 3)
       search_pg2 = search_pg1.next_page
       search_pg3 = search_pg2.next_page
       search_pg1.size.should == 3

data/spec/geonames_api/retry_spec.rb

@@ -1,27 +1,25 @@
 require 'spec_helper'
 
 describe GeoNamesAPI::Base do
-  TIMEOUT = JSON.load <<-JSON
-    {
-      "status": {
-        "message": "ERROR: canceling statement due to statement timeout",
-        "value": 13
-      }
-    }
-  JSON
-
-  # This is not a correct, complete response, but that's not relevant to the spec:
-  EXAMPLE_RESPONSE = JSON.load <<-JSON
-    {"geonames": [{ "name": "Earth" }]}
-  JSON
-
-  describe "::find" do
+  describe "retries" do
     before :each do
       GeoNamesAPI.max_sleep_time_between_retries = 0
+      @timeout = JSON.load <<-JSON
+        {
+          "status": {
+            "message": "ERROR: canceling statement due to statement timeout",
+            "value": 13
+          }
+        }
+      JSON
+      # This is not a correct, complete response, but that's not relevant to the spec:
+      @response = JSON.load <<-JSON
+        {"geonames": [{ "name": "Earth" }]}
+      JSON
     end
 
     it "retries when geonames returns timeout errors" do
-      GeoNamesAPI::Hierarchy.stub(:make_request).and_return(TIMEOUT, EXAMPLE_RESPONSE)
+      GeoNamesAPI::Hierarchy.stub(:make_request).and_return(@timeout, @response)
       hierarchy = GeoNamesAPI::Hierarchy.find(6295630)
       earth = hierarchy.first
       earth.should be_present
@@ -29,7 +27,7 @@ describe GeoNamesAPI::Base do
     end
 
     it "fails when geonames returns timeout errors too many times" do
-      GeoNamesAPI::Hierarchy.stub(:make_request).and_return(TIMEOUT, TIMEOUT, EXAMPLE_RESPONSE)
+      GeoNamesAPI::Hierarchy.stub(:make_request).and_return(@timeout, @timeout, @response)
       GeoNamesAPI.retries = 1
       proc { GeoNamesAPI::Hierarchy.find(6295630) }.should raise_error GeoNamesAPI::Timeout
     end

data/spec/spec_helper.rb

@@ -12,4 +12,6 @@ RSpec.configure do |config|
     GeoNamesAPI.username = name if name.present?
   end
   GeoNamesAPI.logger = Logger.new("test.log")
+  GeoNamesAPI.retries = 10
+  GeoNamesAPI.max_sleep_time_between_retries = 60
 end

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: geonames_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
+  prerelease: 
 platform: ruby
 authors:
 - Sean Devine
@@ -9,76 +10,86 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-08 00:00:00.000000000 Z
+date: 2014-01-03 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'
 - !ruby/object:Gem::Dependency
   name: tzinfo
   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'
 - !ruby/object:Gem::Dependency
-  name: zipruby
+  name: rubyzip
   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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   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
@@ -114,6 +125,7 @@ files:
 - lib/geonames_api/hierarchy.rb
 - lib/geonames_api/list_endpoint.rb
 - lib/geonames_api/nearby_postal_code.rb
+- lib/geonames_api/neighbourhood.rb
 - lib/geonames_api/place.rb
 - lib/geonames_api/place_name.rb
 - lib/geonames_api/place_search.rb
@@ -125,8 +137,10 @@ files:
 - lib/geonames_api/weather.rb
 - lib/geonames_api/weather_i_c_a_o.rb
 - lib/geonames_api/wikipedia.rb
+- spec/geonames_api/country_spec.rb
 - spec/geonames_api/country_subdivision_spec.rb
 - spec/geonames_api/hierarchy_spec.rb
+- spec/geonames_api/neighbourhood_spec.rb
 - spec/geonames_api/place_name_spec.rb
 - spec/geonames_api/place_search_spec.rb
 - spec/geonames_api/place_spec.rb
@@ -136,34 +150,37 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/buytruckload/geonames_api
 licenses: []
-metadata: {}
 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: 2.0.3
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+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, it's lightweight
   and has a nice interface and will be easy to extend :)
 test_files:
+- spec/geonames_api/country_spec.rb
 - spec/geonames_api/country_subdivision_spec.rb
 - spec/geonames_api/hierarchy_spec.rb
+- spec/geonames_api/neighbourhood_spec.rb
 - spec/geonames_api/place_name_spec.rb
 - spec/geonames_api/place_search_spec.rb
 - spec/geonames_api/place_spec.rb
@@ -171,3 +188,4 @@ test_files:
 - spec/geonames_api/street_spec.rb
 - spec/geonames_api/weather_icao_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: feb56410dfb4499eaac158048e1950c760ea4215
-  data.tar.gz: b10b25b67f681f847c7fe42ad263009ee366b25c
-SHA512:
-  metadata.gz: f92de847f4285eb1ae61a61c03e9429b39ab3ea423291ab669e30c16a59656a1d9ae0ae1570ffc274ed5db930efb00dbd28bc5268adf55d9fea562c70665540d
-  data.tar.gz: 40439223d27f035a99fbe37f02489f47c4c449a4e373d51086bcbb5575522de39bfc0c50ca772906208b6e1e3c6ae57efd8d148cf9a41dd746a3752931816516