nne_client 0.0.1

data/lib/nne_client.rb

@@ -0,0 +1,43 @@
+require 'config_newton'
+require 'savon'
+require "nne_client/version"
+require "nne_client/result_attributes"
+require "nne_client/fetch"
+require "nne_client/request"
+require "nne_client/search"
+require "nne_client/query"
+require "nne_client/question"
+require "nne_client/result"
+require "nne_client/result_set"
+require "nne_client/record_types/finance"
+require "nne_client/record_types/ownership"
+require "nne_client/record_types/subsidiary"
+require "nne_client/record_types/trade"
+
+HTTPI.adapter = :net_http
+
+# Namespace for the library
+module NNEClient
+  extend self
+  include ConfigNewton
+
+  class CompanyMissing < RuntimeError; end
+
+  config :access_key
+
+  # Where users start the interaction with the library.
+  #
+  # The query is hash with one or more of these keys:
+  #
+  # * :houseNo (string)
+  # * :name (string)
+  # * :nameStartsWith (boolean)
+  # * :street (string)
+  # * :zipCode (number)
+  # * :tdcId (number)
+  #
+  # @return [ResultSet] containing the results from the SOAP API
+  def search(query)
+    NNEClient::Search.new(query).result_set
+  end
+end

data/nne_client.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.unshift File.expand_path("../lib", __FILE__)
+require 'nne_client/version'
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jacob Atzen"]
+  gem.email         = ["jacob@incremental.dk"]
+  gem.description   = %q{Client library for the Navne & Numre Erhverv SOAP service}
+  gem.summary       = %q{A small library easing integration with NNE}
+  gem.homepage      = ""
+
+  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{^(test|spec|features)/})
+  gem.name          = "nne_client"
+  gem.require_paths = ["lib"]
+  gem.version       = NNEClient::VERSION
+  gem.add_dependency('savon', '~> 0.9.5')
+  gem.add_dependency('config_newton', '~> 0.1.1')
+  gem.add_development_dependency('vcr')
+  gem.add_development_dependency('fakeweb')
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency("equivalent-xml", "~> 0.2.9")
+end

data/spec/finance_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe NNEClient::Finance do
+  let(:hash) do
+     {
+       :contribution_ratio              => "26.02",
+       :net_outcome                     => "132718.0",
+       :stock                           => "136101.0",
+       :assets                          => "1729700.0",
+       :gross_profit                    => "789841.0",
+       :return_on_assets                => "13.13",
+       :"@xsi:type"                     => "ns0:Finance",
+       :credit_rating                   => {:"@xsi:type" => "xsd:string"},
+       :placings                        => "38837.0",
+       :trade_debitors                  => "23232.0",
+       :available_funds                 => "183991.0",
+       :income_before_income_tax        => "188944.0",
+       :share_holders_funds_of_interest => "78.96",
+       :current_assets                  => "770605.0",
+       :profit                          => "130000.0",
+       :turnover                        => "3034952.0",
+       :available_funds_ratio           => "74.48",
+       :link_pdf                        => Date.parse('2012-03-30'),
+       :shareholders_funds              => "168073.0",
+       :depreciations                   => "-37525.0",
+       :profit_for_the_year             => "132718.0",
+       :@id                             => "ID2",
+       :balance                         => "1729700.0",
+       :long_termed_liability           => "488133.0",
+       :short_termed_liability          => "1034657.0",
+       :fixed_assets                    => "959095.0",
+       :number_of_employees             => "1222",
+       :profit_ratio                    => "7.48",
+       :capacity_ratio                  => "1.4",
+       :lots_and_sites                  => "162650.0",
+       :solvency_ratio                  => "9.72",
+       :accounting_date                 => Date.parse('2012-03-30'),
+       :fixed_cost                      => "562808.0",
+       :published_date                  => Date.parse('2012-03-30'),
+       :year                            => "2011"
+     }
+  end
+
+  subject { NNEClient::Finance.new(hash) }
+
+  its(:accounting_date)                 { should == hash[:accounting_date] }
+  its(:assets)                          { should == hash[:assets] }
+  its(:available_funds)                 { should == hash[:available_funds] }
+  its(:available_funds_ratio)           { should == hash[:available_funds_ratio] }
+  its(:balance)                         { should == hash[:balance] }
+  its(:capacity_ratio)                  { should == hash[:capacity_ratio] }
+  its(:contribution_ratio)              { should == hash[:contribution_ratio] }
+  its(:credit_rating)                   { should be_nil }
+  its(:current_assets)                  { should == hash[:current_assets] }
+  its(:depreciations)                   { should == hash[:depreciations] }
+  its(:fixed_assets)                    { should == hash[:fixed_assets] }
+  its(:fixed_cost)                      { should == hash[:fixed_cost] }
+  its(:gross_profit)                    { should == hash[:gross_profit] }
+  its(:income_before_income_tax)        { should == hash[:income_before_income_tax] }
+  its(:link_pdf)                        { should == hash[:link_pdf] }
+  its(:long_termed_liability)           { should == hash[:long_termed_liability] }
+  its(:lots_and_sites)                  { should == hash[:lots_and_sites] }
+  its(:net_outcome)                     { should == hash[:net_outcome] }
+  its(:number_of_employees)             { should == hash[:number_of_employees] }
+  its(:placings)                        { should == hash[:placings] }
+  its(:profit)                          { should == hash[:profit] }
+  its(:profit_for_the_year)             { should == hash[:profit_for_the_year] }
+  its(:profit_ratio)                    { should == hash[:profit_ratio] }
+  its(:published_date)                  { should == hash[:published_date] }
+  its(:return_on_assets)                { should == hash[:return_on_assets] }
+  its(:share_holders_funds_of_interest) { should == hash[:share_holders_funds_of_interest] }
+  its(:shareholders_funds)              { should == hash[:shareholders_funds] }
+  its(:short_termed_liability)          { should == hash[:short_termed_liability] }
+  its(:solvency_ratio)                  { should == hash[:solvency_ratio] }
+  its(:stock)                           { should == hash[:stock] }
+  its(:trade_debitors)                  { should == hash[:trade_debitors] }
+  its(:turnover)                        { should == hash[:turnover] }
+  its(:year)                            { should == hash[:year] }
+end

data/spec/ownership_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe NNEClient::Ownership do
+  let(:ownership_hash) do
+    {
+      :country     => "Holland",
+      :"@xsi:type" => "ns0:Ownership",
+      :share       => "100            ",
+      :tdc_id      => "123",
+      :@id         => "ID2",
+      :name        => "Ingka Holding Scandinavia Bv"
+    }
+  end
+
+  subject { NNEClient::Ownership.new(ownership_hash) }
+
+  it            { should eq NNEClient::Ownership.new(ownership_hash) }
+  its(:share)   { should == '100' }
+  its(:name)    { should == ownership_hash[:name] }
+  its(:country) { should == ownership_hash[:country] }
+
+  describe "#company" do
+    let(:result)     { double(:result) }
+
+    it "knows how to fetch company information" do
+      NNEClient::Result.should_receive(:new).with(:tdc_id => '123') { result }
+      subject.company
+    end
+    it "knows how to fetch company information" do
+      NNEClient::Result.stub(:new) { result }
+      subject.company.should == result
+    end
+  end
+end

data/spec/result_spec.rb

@@ -0,0 +1,284 @@
+require 'spec_helper'
+
+describe NNEClient::Result do
+
+  let(:result_hash) do
+    {
+      :p_no          => "1015150161",
+      :fax           => {:"@xsi:type" => "xsd:string"},
+      :ad_protection => "0",
+      :tdc_id        => "202541543",
+      :"@xsi:type"   => "ns0:CompanyBasic",
+      :phone         => "26256502",
+      :company_id    => "4218680",
+      :official_name => "Incremental V/ Jacob Atzen",
+      :street        => "Bygmestervej 47 3 tv",
+      :zip_code      => "2400",
+      :company_type  => "PL",
+      :@id           => "ID4",
+      :cvr_no        => "31999529",
+      :district      => "København NV"
+    }
+  end
+
+  subject { NNEClient::Result.new(result_hash) }
+
+  its(:cvr_no)        { should == result_hash[:cvr_no] }
+  its(:p_no)          { should == result_hash[:p_no] }
+  its(:district)      { should == result_hash[:district] }
+  its(:official_name) { should == result_hash[:official_name] }
+  its(:phone)         { should == result_hash[:phone] }
+  its(:street)        { should == result_hash[:street] }
+  its(:zip_code)      { should == result_hash[:zip_code] }
+  its(:ad_protection) { should == result_hash[:ad_protection] }
+  it { should == NNEClient::Result.new(:tdc_id => '202541543') }
+
+  it "is unique based on tdc_id" do
+    [
+      NNEClient::Result.new(:tdc_id => '202541543'),
+      subject
+    ].uniq.size.should == 1
+  end
+
+  it "returns nil for a basic attribute that's a hash" do
+    result = NNEClient::Result.new(
+      result_hash.merge(:phone => {"@xsi:type" => 'xsd:string'})
+    )
+    result.phone.should be_nil
+  end
+
+  it "returns nil for an extended attribute that's a hash" do
+    soap_vcr('result_fetching_ext_attributes_email_hash') do
+      NNEClient.search(:tdcId => '101953776').first.email.should be_nil
+    end
+  end
+
+  it "raises CompanyMissing if tdc_id is unknown" do
+    soap_vcr('result_fetching_missing_company') do
+      expect {
+        NNEClient::Result.new(:tdc_id => '202177618').official_name
+      }.to raise_error(NNEClient::CompanyMissing)
+    end
+  end
+
+  context 'with only tdc_id' do
+    around(:each) do |example|
+      soap_vcr('result_fetching_basic_attributes') do
+        example.run
+      end
+    end
+
+    subject { NNEClient::Result.new(:tdc_id => '202541543') }
+
+    its(:cvr_no)        { should == result_hash[:cvr_no] }
+    its(:p_no)          { should == result_hash[:p_no] }
+    its(:district)      { should == result_hash[:district] }
+    its(:official_name) { should == result_hash[:official_name] }
+    its(:phone)         { should == result_hash[:phone] }
+    its(:street)        { should == result_hash[:street] }
+    its(:zip_code)      { should == result_hash[:zip_code] }
+    its(:ad_protection) { should == result_hash[:ad_protection] }
+  end
+
+  context "with extended info" do
+    context "with an access key" do
+      around(:each) do |example|
+        NNEClient.configure { |config| config.access_key = 'some key' }
+        soap_vcr('result_extended_info_with_access_key') do
+          example.run
+        end
+        NNEClient.configure { |config| config.access_key = nil }
+      end
+
+      its(:email)               { should == 'jacob@incremental.dk' }
+      its(:homepage)            { should be_nil }
+      its(:founded_year)        { should == '2009' }
+      its(:number_of_employees) { should == '0' }
+      its(:tdf_name)            { should == 'Incremental' }
+      its(:status_text)         { should == 'Selskabet er i normal drift.' }
+    end
+
+    context "without an access key" do
+      around(:each) do |example|
+        soap_vcr('result_extended_info') do
+          example.run
+        end
+      end
+
+      its(:email)               { should == 'jacob@incremental.dk' }
+      its(:homepage)            { should be_nil }
+      its(:founded_year)        { should == '2009' }
+      its(:number_of_employees) { should == '0' }
+      its(:tdf_name)            { should == 'Incremental' }
+      its(:status_text)         { should == 'Selskabet er i normal drift.' }
+    end
+  end
+
+  context "with a single trade" do
+    around(:each) do |example|
+      soap_vcr('result_trades') do
+        example.run
+      end
+    end
+
+    its(:trades) {
+      should eq [
+        NNEClient::Trade.new(
+          :primary => true,
+          :trade => 'Konsulentbistand vedrørende informationsteknologi',
+          :trade_code => '620200'
+        )
+      ]
+    }
+  end
+
+  context "with multiple trades" do
+    around(:each) do |example|
+      soap_vcr('result_multiple_trades') do
+        example.run
+      end
+    end
+
+    subject do NNEClient.search(:name => 'Dansk Supermarked').to_a[5] end
+
+    its(:trades) {
+      should include NNEClient::Trade.new(
+        :primary => true,
+        :trade => "Anden detailhandel fra ikke-specialiserede forretninger",
+        :trade_code => "471900"
+      )
+    }
+
+    its(:trades) {
+      should include NNEClient::Trade.new(
+        :primary => false,
+        :trade => "Discountforretninger",
+        :trade_code => "471130"
+      )
+    }
+  end
+
+  context "with no ownership information" do
+    around(:each) do |example|
+      soap_vcr('result_no_ownerships') do
+        example.run
+      end
+    end
+
+    subject { NNEClient::Result.new(result_hash) }
+
+    its(:ownerships) { should be_empty }
+  end
+
+  context "with single ownership" do
+    around(:each) do |example|
+      soap_vcr('result_single_ownership') do
+        example.run
+      end
+    end
+
+    subject { NNEClient.search(:name => 'Ikea').first }
+
+    its(:ownerships) {
+      should include NNEClient::Ownership.new(
+        :share => '100 ',
+        :name => 'Ingka Holding Scandinavia Bv',
+        :country => 'Holland'
+      )
+    }
+  end
+
+  context "with multiple ownership" do
+    around(:each) do |example|
+      soap_vcr('result_multiple_ownerships') do
+        example.run
+      end
+    end
+
+    subject { NNEClient.search(:tdcId => '100319964').first }
+
+    its(:ownerships) {
+      should include NNEClient::Ownership.new(
+        :share => '33 ',
+        :name => 'Henrik Harald Halberg',
+        :country => nil
+      )
+    }
+  end
+
+  context "with no subsidiaries" do
+    it "has no subsidiares" do
+      soap_vcr('result_no_subsidiaries') do
+        result = NNEClient.search(:tdcId => '100319964').first
+        result.subsidiaries.should be_empty
+      end
+    end
+  end
+
+  context "with a single subsidiary" do
+    it "returns the subsidiary" do
+      soap_vcr('result_single_subsidiary') do
+        NNEClient.search(:name => 'Ikea').first.subsidiaries.should eq [
+          NNEClient::Subsidiary.new(
+            :country => "Danmark",
+            :share => "100",
+            :name => "Ikea Ejendomme ApS"
+          )
+        ]
+      end
+    end
+  end
+
+  context 'with no finances' do
+    it "returns an empty array of finances" do
+      soap_vcr('result_no_finance') do
+        NNEClient.search(:name => 'Incremental').first.finances.should be_empty
+      end
+    end
+  end
+
+  context 'with a single finance record' do
+    it "has a finance record" do
+      soap_vcr('result_single_finance') do
+        records = NNEClient.search(:name => 'Etech').first.finances
+        records.map(&:year).should == ['2010']
+      end
+    end
+  end
+
+  context 'with multiple finance records' do
+    it "has several finance records" do
+      soap_vcr('result_multiple_finances') do
+        records = NNEClient.search(:name => 'Ikea').first.finances
+        records.map(&:year).should == ["2011", "2010", "2009", "2008", "2007"]
+      end
+    end
+  end
+
+  it "knows all names" do
+    soap_vcr('result_names') do
+      result = NNEClient::Result.new(:official_name => 'Name', :tdc_id => '100323228')
+      result.additional_names.should == [
+        "Tv Holbæk A/S",
+        "A/S Trykkeriet Nordvest",
+        "A/S Trykkeriet Nordvestsjælland",
+        "Nordvestsjællands Media Selskab A/S",
+        "Radio Holbæk A/S"
+      ]
+    end
+  end
+
+  it "will convert additional_names to an array" do
+    soap_vcr('result_additional_names_single') do
+      result = NNEClient::Result.new(:tdc_id => '101952996')
+      result.additional_names.should == [ 'Eb Flytning ApS' ]
+    end
+  end
+
+  it "is an empty array if no additinal names present" do
+    soap_vcr('result_names_empty') do
+      result = NNEClient::Result.new(:official_name => 'Name', :tdc_id => '202541543')
+      result.additional_names.should == []
+    end
+  end
+end

data/spec/search_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+require 'nne_client'
+
+describe NNEClient::Search do
+  describe 'a search with a single match' do
+    it 'finds the company' do
+      soap_vcr('search_lokalebasen') do
+        NNEClient::Search.new(:name => 'Lokalebasen').result_set.first.official_name.should == 'Lokalebasen.DK A/S'
+      end
+    end
+  end
+
+  describe 'a search with multiple matches' do
+    subject do
+      soap_vcr('search_lokale') do
+        NNEClient::Search.new(:name => 'Lokale').result_set
+      end
+    end
+
+    it 'finds the company' do
+      subject.first.official_name.should == 'Andelsselskabet De Lokale Boliger'
+    end
+
+    it 'knows the number of matches' do
+      subject.total.should == 124
+    end
+  end
+
+  describe 'asking for more results' do
+    subject do
+      soap_vcr('search_lokale_100') do
+        NNEClient::Search.new(:name => 'Lokale', :hits_per_page => 100).result_set
+      end
+    end
+
+    it 'finds the company' do
+      subject.first.official_name.should == 'Andelsselskabet De Lokale Boliger'
+    end
+
+    it 'fetches 100 records' do
+      subject.count.should == 100
+    end
+  end
+
+  describe "searching for something non existent" do
+    subject do
+      soap_vcr('search_for_noise') do
+        NNEClient::Search.new(:name => 'asdfasdfasdf').result_set
+      end
+    end
+
+    it 'has a total of 0 results' do
+      subject.total.should == 0
+    end
+
+    it 'fetches 0 records' do
+      subject.count.should == 0
+    end
+
+    it 'can iterate' do
+      expect { |block|
+        subject.each(&block)
+      }.not_to yield_control
+    end
+  end
+
+  describe 'with an access key' do
+    before(:each) do
+      NNEClient.configure { |config| config.access_key = 'some key' }
+    end
+
+    it 'finds the company' do
+      soap_vcr('search_lokalebasen_with_access_key') do
+        NNEClient::Search.new(:name => 'Lokalebasen').result_set.first.official_name.should == 'Lokalebasen.DK A/S'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'vcr'
+require 'equivalent-xml'
+require 'nne_client'
+
+HTTPI.log = false
+
+Savon.configure do |config|
+  config.log = false            # disable logging
+  config.log_level = :info      # changing the log level
+  # config.logger = Rails.logger  # using the Rails logger
+end
+
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/vcr_cassettes'
+  c.hook_into :fakeweb
+  c.register_request_matcher :soap_body_matcher do |request_1, request_2|
+    node_1 = Nokogiri::XML(request_1.body)
+    node_2 = Nokogiri::XML(request_2.body)
+    EquivalentXml.equivalent?(node_1, node_2, opts = { :element_order => true, :normalize_whitespace => false })
+  end
+end
+
+def soap_vcr(cassette_name)
+  VCR.use_cassette(cassette_name, :match_requests_on => [:soap_body_matcher]) do
+    yield
+  end
+end

data/spec/subsidiary_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe NNEClient::Subsidiary do
+  let(:subsidiary_hash) do
+    {
+      :country     => "Holland",
+      :"@xsi:type" => "ns0:Subsidiary",
+      :share       => "100            ",
+      :tdc_id      => "123",
+      :@id         => "ID2",
+      :name        => "Ingka Holding Scandinavia Bv"
+    }
+  end
+
+  subject { NNEClient::Subsidiary.new(subsidiary_hash) }
+
+  it            { should eq NNEClient::Subsidiary.new(subsidiary_hash) }
+  its(:share)   { should == '100' }
+  its(:name)    { should == subsidiary_hash[:name] }
+  its(:country) { should == subsidiary_hash[:country] }
+
+  describe "#company" do
+    let(:result)     { double(:result) }
+
+    it "knows how to fetch company information" do
+      NNEClient::Result.should_receive(:new).with(:tdc_id => '123') { result }
+      subject.company
+    end
+    it "knows how to fetch company information" do
+      NNEClient::Result.stub(:new) { result }
+      subject.company.should == result
+    end
+  end
+
+end
+

data/spec/trade_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe NNEClient::Trade do
+  let(:trade_hash) do
+    {
+      :"@xsi:type" => "ns0:Trade",
+      :primary     => true,
+      :trade_code  => "471900",
+      :@id         => "ID2",
+      :trade       => "Anden detailhandel fra ikke-specialiserede forretninger"
+    }
+  end
+
+  subject { NNEClient::Trade.new(trade_hash) }
+
+  it               { should be_primary }
+  it               { should eq NNEClient::Trade.new(trade_hash) }
+  its(:trade_code) { should == trade_hash[:trade_code] }
+  its(:trade)      { should == trade_hash[:trade] }
+
+end