skra-geo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 54539d0fd651a0e9ecda8eb8af3f47bbfdce0f72
+  data.tar.gz: 046db7317d618107fc75ecc9d7179fa79b0bea32
+SHA512:
+  metadata.gz: 4b7f51c3ef2f7b022dd46c1b6196f790d7a77be1b1bc35495cb578f00c5b94af224af2aefd437b802bf9a2f399414ba89cbfe83a2ff95c523218b99f819c9ba8
+  data.tar.gz: ec334d91375ee1c875781e36fced7958535f6bb3003bb8625c557465f71e909a9a8390cbb2f74778ffdf81c65168fb7b8ff869dc227bbb2b5c8eab91cfc74013

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/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Aitor García
+
+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,111 @@
+# Skra::Geo
+
+Skra::Geo is a thin ruby wrapper to query WFS API of the [Icelandic National Registry](http://www.skra.is) Geoserver.
+Its main goal is to provide easy access to geo information of every parcel in Iceland, thus making trivial the implementation
+of features like geolocation.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'skra-geo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install skra-geo
+
+## Usage
+
+```ruby
+> bundle console
+>> Skra::Geo.landnr(100404) # Looking up by landnr (Parcel ID)
+ [
+    {"type"=>"Feature", "id"=>"VSTADF.fid-51fadf5a_144745fbcac_-1eb7", "geometry"=>{"type"=… data skipped …4)", "HUSMERKING"=>"13"}},
+    {"type"=>"Feature", "id"=>"VSTADF.fid-51fadf5a_144745fbcac_-1eb6", "geometry"=>{"type"=… data skipped …4)", "HUSMERKING"=>"1"}}
+  ]
+```
+
+Althought landnr (Parcel ID) is one the most usual ids for querying the server, it's also possible to query the server by different properties:
+
+* Looking up by heinum (Property ID)
+```ruby
+>> Skra::Geo.heinum(1008773) # Looking up by heinum (Property ID)
+```
+
+* Looking up by street name
+```ruby
+>> Skra::Geo.street('Holtsgata') # All streets in Iceland with that name
+>> Skra::Geo.street('Holtsgata', 13) # All buildings No. 13 in Holtsgata streets in Iceland
+>> Skra::Geo.street('Holtsgata', 13, 101) # Building No. 13 in Holtsgata streets in postcode 101 (Reykjavík)
+>> Skra::Geo.street('Holtsgötu', 13, 101, {:dative => true}) # dative version of the name street (useful in icelandic)
+```
+
+* Or even more freely by any property using the ```Skra::Geo#query``` method
+```ruby
+>> Skra::Geo.query([{:name => :POSTNR, :value => 101}]) # All features in postcode 101
+```
+
+## Data
+
+A feature returned by the server will have the following structure:
+```json
+[
+  {
+    "type": "Feature",
+    "id": "VSTADF.fid-51fadf5a_144745ff88d_-259b",
+    "geometry": {
+      "type": "Point",
+      "coordinates": [
+        356227.738636364,
+        408530.288636364
+      ]
+    },
+    "geometry_name": "HNIT",
+    "properties": {
+      "HNITNUM": 10019748,
+      "SVFNR": "0000",
+      "LANDNR": 100404,
+      "HEINUM": 1008773,
+      "MATSNR": null,
+      "POSTNR": 101,
+      "HEITI_NF": "Holtsgata",
+      "HEITI_TGF": "Holtsgötu",
+      "HUSNR": 13,
+      "BOKST": null,
+      "VIDSK": null,
+      "SERHEITI": null,
+      "DAGS_INN": "2007-09-07",
+      "DAGS_LEIDR": "2010-01-08",
+      "GAGNA_EIGN": "Fasteignaskrá Íslands",
+      "TEGHNIT": 0,
+      "YFIRFARID": 0,
+      "YFIRF_HEITI": null,
+      "ATH": null,
+      "NAKV_XY": null,
+      "NOTNR": 956,
+      "LM_HEIMILISFANG": "Holtsgata 13  (100404)",
+      "VEF_BIRTING": "Holtsgata 13  (100404)",
+      "HUSMERKING": "13"
+    }
+  }
+]
+```
+
+Geometry coordinates are returned in [ISNET93](https://is.wikipedia.org/wiki/ISNET93) and they usually need conversion to something more standard (like [WGS84](https://en.wikipedia.org/wiki/World_Geodetic_System)) to be used.
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/skra-geo/fork )
+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
+
+## Kudos
+
+This library was extracted from the work made by [Linking Paths](http://www.linkingpaths.com) during the first hackathon organized by [Open Knowledge Foundation Iceland](https://www.facebook.com/OKFNis). Documentation on the actual functionaly of the server was researched from [geoserver.org](http://docs.geoserver.org/stable/en/user/services/wfs/reference.html#operations) and previous work on the python library [fasteignamat-functions](https://github.com/pallih/fasteignamat-functions) was checked as reference.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/skra/geo.rb

@@ -0,0 +1,64 @@
+require "httparty"
+
+require "skra/geo/version"
+
+module Skra
+  module Geo
+    include HTTParty
+    base_uri 'geo.skra.is'
+    def self.defaults
+      {
+        :service => :wfs,
+        :version => "1.1.0",
+        :request => 'GetFeature',
+        :typename => 'fasteignaskra:VSTADF',
+        :outputformat => 'json'
+      }
+    end
+
+    def self.query(filter, options={})
+      get_features(filter, options)
+    end
+
+    def self.heinum(id, options={})
+      get_features([{:name => :HEINUM, :value => id}], options)
+    end
+
+    def self.landnr(id, options={})
+      get_features([{:name => :LANDNR, :value => id}], options)
+    end
+
+    def self.street(name, number=nil, postcode=nil, options={})
+      property = options.delete(:dative) ? :HEITI_TGF : :HEITI_NF
+      filter = [
+        {:name => property, :value => name}
+      ]
+      filter << {:name => :HUSNR,  :value => number}   if number
+      filter << {:name => :POSTNR, :value => postcode} if postcode
+      get_features(filter, options)
+    end
+
+
+    protected
+
+    def self.get_features(filter, options)
+      query  = defaults.merge(options)
+      wfs_filter = build_wfs_filter(filter)
+      response = post('/geoserver/wfs', { :query => query.merge(wfs_filter) })
+      query[:outputformat] == 'json' ? response["features"] : response
+    end
+
+    def self.build_wfs_filter(properties=[])
+      conditions = properties.map do |condition|
+        <<-eos
+          <PropertyIsLike wildCard="*" singleChar="#" escapeChar="!">
+            <PropertyName>fasteignaskra:#{condition[:name]}</PropertyName>
+            <Literal>#{condition[:value]}</Literal>
+          </PropertyIsLike>
+        eos
+      end.join
+      conditions = "<And>#{conditions}</And>" if properties.size > 1
+      properties.size > 0 ? { :filter => "<Filter>#{conditions}</Filter>" } : {}
+    end
+  end
+end

data/lib/skra/geo/version.rb

@@ -0,0 +1,5 @@
+module Skra
+  module Geo
+    VERSION = "0.0.1"
+  end
+end

data/skra-geo.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'skra/geo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "skra-geo"
+  spec.version       = Skra::Geo::VERSION
+  spec.authors       = ["Aitor García"]
+  spec.email         = ["aitor@linkingpaths.com"]
+  spec.summary       = %q{Skra::Geo is a thin ruby wrapper to query WFS API of the [Icelandic National Registry](http://www.skra.is) Geoserver.}
+  spec.homepage      = "https://github.com/linkingpaths/skra-geo"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency('httparty', [">= 0.13.0"])
+
+end

data/spec/skra/geo_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Skra::Geo do
+  it 'should have a version number' do
+    Skra::Geo::VERSION.should_not be_nil
+  end
+
+
+  describe "search based on landnr" do
+    it "should return the feature for that landnr (Parcel ID)" do
+      results = Skra::Geo.landnr(100404)
+      results[0]["properties"]["LANDNR"].should == 100404
+      results[0]["properties"]["HEITI_NF"].should == "Holtsgata"
+    end
+  end
+
+  describe "search based on heinum" do
+    it "should return the feature for that heinum (Property ID)" do
+      results = Skra::Geo.heinum(1008773)
+      results.size.should == 1
+      results[0]["properties"]["HEINUM"].should == 1008773
+      results[0]["properties"]["HEITI_NF"].should == "Holtsgata"
+    end
+  end
+
+  describe "search based on a street" do
+
+    it "should return features for all streets in Iceland with that name" do
+      results = Skra::Geo.street('Holtsgata')
+      results.size.should > 1
+      results.map{|result| result["properties"]["POSTNR"]}.should include(101)
+    end
+
+    it "should return features for all streets in Iceland using a name in dative" do
+      results = Skra::Geo.street('Holtsgötu', nil, nil, {:dative => true})
+      results.size.should > 1
+      results.map{|result| result["properties"]["POSTNR"]}.should include(101)
+    end
+
+    it "should return features for a given street+number" do
+      results = Skra::Geo.street('Holtsgata', 13)
+      results.size.should > 1
+    end
+
+    it "should return features for a given street+number+postcode" do
+      results = Skra::Geo.street('Holtsgata', 13, 101)
+      results.size.should == 1
+      results[0]["properties"]["HEINUM"].should == 1008773
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'skra/geo'

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: skra-geo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aitor García
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+description: 
+email:
+- aitor@linkingpaths.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/skra/geo.rb
+- lib/skra/geo/version.rb
+- skra-geo.gemspec
+- spec/skra/geo_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/linkingpaths/skra-geo
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Skra::Geo is a thin ruby wrapper to query WFS API of the [Icelandic National
+  Registry](http://www.skra.is) Geoserver.
+test_files:
+- spec/skra/geo_spec.rb
+- spec/spec_helper.rb