locus 0.1.0

data/lib/locus.rb

@@ -0,0 +1,17 @@
+# coding: utf-8
+require 'yaml'
+require 'active_support/core_ext/module/attribute_accessors.rb'
+
+require 'locus/version'
+require 'locus/railtie' if defined?(Rails)
+
+require 'locus/place'
+
+# Locus.
+module Locus
+  mattr_accessor :zip_path, :default_country
+
+  self.zip_path =
+    File.expand_path(File.join('..', 'data', 'zipcodes.yml'), __FILE__)
+  self.default_country = :de
+end

data/lib/locus/place.rb

@@ -0,0 +1,43 @@
+# coding: utf-8
+
+module Locus
+  class Place
+    attr_accessor :country, :postal_code, :state_code
+
+    def initialize(attributes = {})
+      attributes.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+
+    # Find a place by postal code and country.
+    #
+    # @param postal_code [String] The postal code.
+    # @param country [Symbol] Country symbol.
+    #
+    # @example
+    #   Locus::Place.find_by_postal_code '12053', :de  # => 'BE'
+    #
+    # @return [Place] The {Place} or nil.
+    def self.find_by_postal_code(postal_code, country = Locus.default_country)
+      return nil unless state_code = state_code(postal_code, country)
+      self.new(country: country,
+               postal_code: postal_code,
+               state_code: state_code)
+    end
+
+    private
+
+      # Get the state code for a given postal code and country.
+      #
+      # @return [String] The state code or nil.
+      def self.state_code(postal_code, country)
+        return nil unless country = places[country]
+        country[postal_code]
+      end
+
+      def self.places
+        @places ||= YAML.load_file Locus.zip_path
+      end
+  end
+end

data/lib/locus/railtie.rb

@@ -0,0 +1,10 @@
+require 'locus'
+require 'rails'
+
+module Locus
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'locus/tasks/geonames.rake'
+    end
+  end
+end

data/lib/locus/tasks/geonames.rake

@@ -0,0 +1,26 @@
+# coding: utf-8
+require 'yaml'
+
+namespace :locus do
+  namespace :import do
+
+    unless Rake::Task.task_defined?('locus:import:zip')
+      desc 'import geonames zip code db and convert it to yaml'
+      task :zip, :output, :input do |task, args|
+        input_files = args.input.split(' ')
+
+        result = input_files.map do |file|
+          country = nil
+          codes = IO.readlines(file).map do |line|
+            line = line.split("\t")
+            country ||= line[0].downcase.to_sym
+            { line[1] => line[4] }
+          end.reduce(:merge)
+          { country => codes }
+        end.reduce(:merge)
+
+        IO.write(args.output, result.to_yaml)
+      end
+    end
+  end
+end

data/lib/locus/version.rb

@@ -0,0 +1,3 @@
+module Locus
+  VERSION = '0.1.0'
+end

data/locus.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'locus/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'locus'
+  gem.version       = Locus::VERSION
+  gem.authors       = ['Gebhard Wöstemeyer']
+  gem.email         = ['g.woestemeyer@gmail.com']
+  gem.description   = 'The gem uses the downloadable geonames.org database for retrieving additional information about postal codes'
+  gem.summary       = 'Information about postal codes'
+  gem.homepage      = 'https://github.com/gewo/locus/'
+  gem.license       = 'MIT'
+
+  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{^spec/})
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'activesupport'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'coveralls'
+end

data/spec/place_spec.rb

@@ -0,0 +1,36 @@
+# coding: utf-8
+require 'spec_helper'
+
+module Locus
+  describe Place do
+    describe '#find_by_postal_code' do
+      it 'returns nil when postal_code does not exist' do
+        Place.find_by_postal_code('12345', :de).should be_nil
+      end
+
+      it 'returns nil when given an invalid country' do
+        Place.find_by_postal_code('12345', :wunderland).should be_nil
+      end
+
+      context 'given valid input' do
+        subject { Place.find_by_postal_code('12053', :de) }
+        it { should be_a Place }
+        its(:country) { should == :de }
+        its(:postal_code) { should == '12053' }
+        its(:state_code) { should == 'BE' }
+      end
+
+      context 'default_country' do
+        subject { Place.find_by_postal_code('12053') }
+        its(:country) { should == :de }
+
+        context 'when changed' do
+          before { Locus.default_country = :ch }
+          after { Locus.default_country = :de }
+          it { should be_nil }
+          it { Place.find_by_postal_code('4243').state_code.should == 'BL' }
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+require 'simplecov'
+require 'coveralls'
+
+# puts SimpleCov.formatter.inspect
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.at_exit do
+  File.open(File.join(SimpleCov.coverage_path, 'percent.txt'), 'w') do |f|
+    f.write SimpleCov.result.covered_percent
+  end
+  SimpleCov.result.format!
+end
+SimpleCov.start
+
+# Coveralls.wear!
+
+require 'locus'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: locus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gebhard Wöstemeyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The gem uses the downloadable geonames.org database for retrieving additional
+  information about postal codes
+email:
+- g.woestemeyer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/data/zipcodes.yml
+- lib/locus.rb
+- lib/locus/place.rb
+- lib/locus/railtie.rb
+- lib/locus/tasks/geonames.rake
+- lib/locus/version.rb
+- locus.gemspec
+- spec/place_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/gewo/locus/
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Information about postal codes
+test_files:
+- spec/place_spec.rb
+- spec/spec_helper.rb