omniva-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 71d2e3bd02bd35dd6312775f2e2f0e7a991cf3ff
+  data.tar.gz: cdedba8d0000eefe31f72e43836ebecd25844241
+SHA512:
+  metadata.gz: 67d74a8011424c3f397c1f4f26ccc718e97e1779c431d7c330bdb4746ad529493800e6c0c8c9749286b835223934a0eb66ef2493ac9612870248698503a7837a
+  data.tar.gz: fd3aaef3a626f7f90822c5b9cff928c0757ab08e462bc41d76574f46d96fd981f12524b816fb956de7dff0042f1ffda34ef9f3e5e6da5ac0a0bfd1901e3405d3

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.gem
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Desk Rock
+
+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,135 @@
+# Omniva::API
+
+A ruby gem to access Estonian postal service address API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniva-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniva-api
+
+## Usage
+
+```` ruby
+# Configuration
+Omniva::API.configure do |config|
+  config.wsdl = 'wsdl_url'
+  config.key = 'secret_key'
+end
+
+# Initial data query (counties)
+Omniva::API.call
+# =>
+[
+  {
+                          :aid => "37",
+                         :tase => "A1",
+                       :ads_id => "370000000000000000000000000000000",
+                 :maakond_ehak => "0037",
+                      :maakond => "Harju maakond",
+              :omavalitus_ehak => "0000",
+              :omavalitus_liik => nil,
+                   :omavalitus => nil,
+            :asustusyksus_ehak => "0000",
+            :asustusyksus_liik => nil,
+                 :asustusyksus => nil,
+               :vaikekoht_liik => nil,
+                    :vaikekoht => nil,
+             :liikluspind_liik => nil,
+                  :liikluspind => nil,
+                      :nimetus => nil,
+               :aadressinumber => nil,
+                :korterinumber => nil,
+                   :sihtnumber => nil,
+                      :staatus => nil,
+                      :aadress => "Eesti Vabariik, Harju maakond",
+                  :nimekapi_nr => nil,
+    :juurdepaasupunkt_nimekiri => nil
+  }, {
+    ...
+  }
+]
+
+# Call with parameters
+Omniva::API.call(nimetus: 'Tallinn')
+# =>
+[
+  {
+                          :aid => "1905378",
+                         :tase => "A3",
+                       :ads_id => "377840176000000000000000000000000",
+                 :maakond_ehak => "0037",
+                      :maakond => "Harju maakond",
+              :omavalitus_ehak => "0784",
+              :omavalitus_liik => "linn",
+                   :omavalitus => "Tallinn",
+            :asustusyksus_ehak => "0176",
+            :asustusyksus_liik => "linnaosa",
+                 :asustusyksus => "Haabersti linnaosa",
+               :vaikekoht_liik => nil,
+                    :vaikekoht => nil,
+             :liikluspind_liik => nil,
+                  :liikluspind => nil,
+                      :nimetus => nil,
+               :aadressinumber => nil,
+                :korterinumber => nil,
+                   :sihtnumber => nil,
+                      :staatus => nil,
+                      :aadress => "Eesti Vabariik, Harju maakond, Tallinn, Haabersti linnaosa",
+                  :nimekapi_nr => nil,
+    :juurdepaasupunkt_nimekiri => nil
+  }, {
+    ...
+  }
+]
+
+Omniva::API.call(aid: 37)
+# =>
+[
+  {
+                          :aid => "112",
+                         :tase => "A2",
+                       :ads_id => "371120000000000000000000000000000",
+                 :maakond_ehak => "0037",
+                      :maakond => "Harju maakond",
+              :omavalitus_ehak => "0112",
+              :omavalitus_liik => "vald",
+                   :omavalitus => "Aegviidu vald",
+            :asustusyksus_ehak => "0000",
+            :asustusyksus_liik => nil,
+                 :asustusyksus => nil,
+               :vaikekoht_liik => nil,
+                    :vaikekoht => nil,
+             :liikluspind_liik => nil,
+                  :liikluspind => nil,
+                      :nimetus => nil,
+               :aadressinumber => nil,
+                :korterinumber => nil,
+                   :sihtnumber => nil,
+                      :staatus => nil,
+                      :aadress => "Eesti Vabariik, Harju maakond, Aegviidu vald",
+                  :nimekapi_nr => nil,
+    :juurdepaasupunkt_nimekiri => nil
+  }, {
+
+  }
+]
+````
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/omniva-api/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/lib/omniva/api.rb

@@ -0,0 +1,13 @@
+require 'omniva/api/version'
+require 'omniva/api/configuration'
+require 'omniva/api/client'
+
+module Omniva
+  module API
+    InvalidConfiguration = Class.new(StandardError)
+
+    def self.call(data = nil)
+      Client.call(data)
+    end
+  end
+end

data/lib/omniva/api/client.rb

@@ -0,0 +1,40 @@
+require 'savon'
+
+module Omniva
+  module API
+    class Client
+      def self.call(data = nil)
+        validate_config
+        data ||= initial_request
+        client = Savon.client(wsdl: Omniva::API.config[:wsdl])
+        auth = { authPhrase: Omniva::API.config[:key] }
+        response = client.call :single_address1, attributes: auth, message: data
+        parsed_response(response)
+      end
+
+      def self.validate_config
+        messages = {
+          wsdl: 'WSDL is missing',
+          key: 'Key is missing'
+        }
+
+        messages.each do |key, value|
+          fail InvalidConfiguration, value if Omniva::API.config[key].blank?
+        end
+      end
+
+      def self.parsed_response(response)
+        unwrapped =
+          response
+          .to_hash
+          .fetch(:single_address_response)
+          .fetch(:aadress_komponent_nimekiri)
+        unwrapped ? unwrapped.fetch(:aadress_komponent) : nil
+      end
+
+      def self.initial_request
+        { nimetus: 'Eesti' }
+      end
+    end
+  end
+end

data/lib/omniva/api/configuration.rb

@@ -0,0 +1,20 @@
+module Omniva
+  module API
+    Configuration = Struct.new(:wsdl, :key) do
+      def initialize
+        self.wsdl = nil
+        self.key = nil
+      end
+    end
+
+    def self.configure
+      @config = Configuration.new
+      yield(@config) if block_given?
+      @config
+    end
+
+    def self.config
+      @config || configure
+    end
+  end
+end

data/lib/omniva/api/version.rb

@@ -0,0 +1,5 @@
+module Omniva
+  module API
+    VERSION = '0.0.1'
+  end
+end

data/omniva-api.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniva/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'omniva-api'
+  spec.version       = Omniva::API::VERSION
+  spec.authors       = ['Stanislav Gorski']
+  spec.email         = ['stanislav.gorski@gmail.com']
+  spec.summary       = %q{Estonian postal service address API gem}
+  spec.description   = %q{A ruby gem to access Estonian postal service address API}
+  spec.homepage      = ''
+  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 = %w(lib)
+
+  spec.add_dependency 'savon', '~> 2.8.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'awesome_print', '~> 1.6'
+  spec.add_development_dependency 'pry', '~> 0.10.0'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: omniva-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stanislav Gorski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: A ruby gem to access Estonian postal service address API
+email:
+- stanislav.gorski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniva/api.rb
+- lib/omniva/api/client.rb
+- lib/omniva/api/configuration.rb
+- lib/omniva/api/version.rb
+- omniva-api.gemspec
+homepage: ''
+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.2
+signing_key: 
+specification_version: 4
+summary: Estonian postal service address API gem
+test_files: []