geo_locator 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfd06ba8440f46c6dbbd48128b012121bdd1e517
-  data.tar.gz: 980b5ed4d134c8cf3fc4582346a49c217e3d362c
+  metadata.gz: 0a7d11b260f776e20225709d37d0d9084ea1fe75
+  data.tar.gz: f07c259078e44c84cb8e9c624ffd858ba8110bad
 SHA512:
-  metadata.gz: 7193cd9ed44f91478093be647a05bae95a7b0f9a7492cbd15d07a519803e371055295a900728afc3e8cb643bc3f772aa923a17d5105308105f6b37b97b6f4bb8
-  data.tar.gz: 9147ce9a35b32d3ebe1c5ee80e6dbfe34ea6678ef3891c4ccc63c58461ad9343371b430078460fb37e5c26cd61623cfb492c87d73c40704a13e2c5f5f5604b27
+  metadata.gz: 93e61b7523ca92577c4410e60d73b3dabe830c8e981248e2f95b20d09f17b45c4bc25a347aa6ada2b4cddff9c89c31d0dfb7df17feacd876a90b269f34d23784
+  data.tar.gz: 6edc764a8dadc54bad9968a80c31dc83b5bf328ac8f7696f8cfda8ca685cb3b6f4f4e5d4c50662a777a8baf7fd782dfe36e1bb4879657003d2b34ffa8610beb5

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Rakefile

@@ -1 +1,38 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :release => :check_database # ensure that there is a database before releasing
+
+task :check_database do
+  raise "Database does not exist!" unless File.exist?(File.expand_path("geo_locator.sqlite3", File.dirname(__FILE__)))
+end
+
+task :create_database do
+  require "sqlite3"
+
+  database_name = "geo_locator.sqlite3"
+  plz_tab_url = "http://fa-technik.adfc.de/code/opengeodb/PLZ.tab"
+  raw_plz_tab = Net::HTTP.get(URI(plz_tab_url))
+  plz_tab = raw_plz_tab
+    .split("\n")
+    .delete_if { |line| line[0] == "#" }
+    .map! { |line| line.split("\t") }
+
+  unless File.exist?(File.expand_path(database_name, File.dirname(__FILE__)))
+    db = SQLite3::Database.new(database_name)
+    db.execute("CREATE TABLE IF NOT EXISTS locations(loc_id INTEGER PRIMARY KEY, zip_code INTEGER, lon REAL, lat REAL, location TEXT)")
+    db.execute("CREATE UNIQUE INDEX 'loc_id_UNIQUE' ON 'locations' ('loc_id')")
+    db.execute("CREATE INDEX 'location' ON 'locations' ('location')")
+    db.execute("CREATE INDEX 'zip_code' ON 'locations' ('zip_code')")
+
+    plz_tab.each do |line|
+      db.execute("INSERT INTO locations VALUES(#{line[0]}, #{line[1]}, #{line[2]}, #{line[3]}, '#{line[4]}')")
+    end
+  else
+    puts "Database already exists!"
+  end
+end
+task :create_db => :create_database # alias for the command line

data/geo_locator.gemspec

@@ -17,6 +17,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "sqlite3", "~> 1.3.9"
+
   spec.add_development_dependency "bundler",               "~> 1.5"
   spec.add_development_dependency "pry",                   "~> 0.9.12.4"
   spec.add_development_dependency "pry-nav",               "~> 0.2.3"

data/lib/geo_locator/version.rb

@@ -1,3 +1,3 @@
-module GeoLocator
-  VERSION = "0.0.1"
+class GeoLocator
+  VERSION = "0.0.2"
 end

data/lib/geo_locator.rb

@@ -1,5 +1,52 @@
-require "geo_locator/version"
+require "sqlite3"
+
+class GeoLocator
+  require "geo_locator/version"
+
+  class << self
+    private
+    def _locate(options = {})
+      unless db = (options[:db] || options["db"])
+        raise ArgumentError, "Options do not contain a db connection!"
+      end
+
+      location = options[:location] || options["location"]
+      zip_code = options[:zip_code] || options["zip_code"]
+
+      unless location || zip_code
+        raise ArgumentError, "Options do not contains neither location nor zip_code!"
+      end
+
+      options[:format] = :hash unless options[:format] || options["format"]
+
+      db_result = db.execute("SELECT lat, lon FROM locations WHERE #{location ? 'location LIKE \'' + location + '\'' : ''} #{location && zip_code ? 'AND' : ''} #{zip_code ? 'zip_code = \'' + zip_code.to_s + '\'' : ''}")
+
+      db_result.map! do |row|
+        lat = row[0]
+        lon = row[1]
+
+        case options[:format]
+          when :array  then [lon, lat] # order conforms to GeoJSON and is supported as such be elasticsearch
+          when :hash   then { lat: lat, lon: lon  }
+          when :string then "#{lat},#{lon}"
+        end
+      end
+    end
+  end
+
+  def self.locate(options = {})
+  end
+
+  def initialize(options = {})
+    @db = SQLite3::Database.open(File.expand_path("../geo_locator.sqlite3", File.dirname(__FILE__)))
+    @format = options[:format] || options["format"] || :hash
+  end
+
+  def locate(options = {})
+    options[:db] = @db
+    options[:format] = options[:format] || options["format"] || @format
+
+    self.class.send(:_locate, options)
+  end
 
-module GeoLocator
-  # Your code goes here...
 end

data/spec/geo_locator_spec.rb

@@ -0,0 +1,57 @@
+require_relative "./spec_helper"
+
+describe GeoLocator do
+  let(:database_path) { File.expand_path("./geo_locator_test.sqlite3", File.dirname(__FILE__)) }
+
+  it "is a class" do
+    expect(GeoLocator.class).to be(Class)
+  end
+
+  describe ".locate" do
+    it "is a class level proxy for the class method _locate without the need for instantiation" do
+      expect(GeoLocator).to respond_to(:locate)
+    end
+  end
+
+  describe ".new" do
+    let(:geo_locator) { GeoLocator.new }
+
+    it "creates an instance of GeoLocator to memoize the internal database connection" do
+      expect(geo_locator).to be_a(GeoLocator)
+    end
+
+    describe "#locate" do
+      it "is an instance level proxy for the class method _locate" do
+        expect(geo_locator).to respond_to(:locate)
+      end
+    end
+  end
+
+  #
+  # private methods used internally
+  #
+  describe "._locate" do
+    let(:db) { SQLite3::Database.open(database_path) }
+
+    it "is a private class method used internally by the various locate methods" do
+      expect(GeoLocator.private_methods.include?(:_locate)).to eq(true)
+      expect { GeoLocator._locate }.to raise_error(NoMethodError)
+    end
+
+    it "expects a sqlite3 database named geo_locator.sqlite3 in the gems root dir" do
+      #true # expect(File.exist?(File.expand_path("../geo_locator.sqlite3", File.dirname(__FILE__)))).to eq(true)
+    end
+
+    it "needs to be called with a database connection" do
+      expect { GeoLocator.send(:_locate) }.to raise_error(ArgumentError)
+    end
+
+    it "returns a array of geo locations if only db and zip_code is given" do
+      expect(GeoLocator.send(:_locate, db: db, zip_code: 33100)).to eq([{:lat=>51.7240488542403, :lon=>8.82975311690181}])
+    end
+
+    it "returns a array of geo locations if only db and location is given" do
+      expect(GeoLocator.send(:_locate, db: db, location: "Schwerin")).to eq([{:lat=>53.6247393347882, :lon=>11.4081221498717}, {:lat=>53.6577581258256, :lon=>11.4356781728688}, {:lat=>53.6517809563862, :lon=>11.3497453888959}, {:lat=>53.6360865636739, :lon=>11.3920850320353}, {:lat=>53.6021672992816, :lon=>11.4110439798182}, {:lat=>53.5808291697605, :lon=>11.4498483787143}])
+    end
+  end 
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require "geo_locator"
+require "pry"
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+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
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: geo_locator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Michael Sievers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-15 00:00:00.000000000 Z
+date: 2014-05-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.9
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -116,13 +130,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - geo_locator.gemspec
+- geo_locator.sqlite3
 - lib/geo_locator.rb
 - lib/geo_locator/version.rb
+- spec/geo_locator_spec.rb
+- spec/geo_locator_test.sqlite3
+- spec/spec_helper.rb
 homepage: https://github.com/msievers/geo_locator
 licenses:
 - MIT
@@ -147,4 +166,7 @@ rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: A ruby gem for translating geo informations (e.g. zip code) to geo locations.
-test_files: []
+test_files:
+- spec/geo_locator_spec.rb
+- spec/geo_locator_test.sqlite3
+- spec/spec_helper.rb