brreg_grunndata 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c7872a9ecab4f94b66773b90b69ce5cd11e8a17
+  data.tar.gz: f9dbec572665afcd6cfde816734b58d611efefd9
+SHA512:
+  metadata.gz: 1e029e32e64679064bc986579f7575487a49848af27702ac5890d3d9ad82cb052c79685b3d80069069921019b49397839f05c6b4f676d686bfb77b233857bea1
+  data.tar.gz: eab73cef78ce031e4abed34beb5143d3d6d887392e4cb1cc1127d29fb8d5e2dade4cd2ee64a6b523eae75d64c67f153fd98e42a4e48c31cb0f3409181c5121e2

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.envrc

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 100
+
+AllCops:
+  TargetRubyVersion: 2.3

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at thhermansen@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in brreg_grunndata.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Thorbjørn Hermansen
+
+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,90 @@
+# BRREG / Enhetsregisteret Grunndata
+
+Ruby wrapper for brreg / enhetsregisteret's [soap web service](https://www.brreg.no/produkter-og-tjenester/bestille/tilgang-til-enhetsregisteret-via-web-services/).
+
+[![Build Status](https://snap-ci.com/gramo-org/brreg_grunndata/branch/master/build_image)](https://snap-ci.com/gramo-org/brreg_grunndata/branch/master)
+
+# Usage
+
+This lib exposes a couple of ways getting data from BRREG. You can either use
+the `Client` directly which gives direct access to response, it's `#message` (data)
+and `#header` (BRREG's status and sub statuses) or you can use the `Service`
+which returns data put in predefined types.
+
+## How to use the client
+
+```ruby
+# Configure and create a client
+config = BrregGrunndata::Configuration.new userid: 'x', password: 'y'
+client = BrregGrunndata::Client.new configuration: config
+
+# Make a request and get a response
+#
+# Calling an operation may raise an error, for instance if you
+# are no authenticated.
+response = client.hent_basisdata_mini orgnr: '123456789'
+
+# The response has two main methods
+# header() returns brreg's "responseHeader"
+header = response.header
+header.main_status    # An integer
+header.sub_statuses   # An array of hashes, contains code (int) and message.
+
+# message() contains the message. It has different data
+# corresponding to the operation you called.
+#
+# Calling message may raise an error, for instance if no
+# message is found in the response. You should inspect the
+# header before asking for a message.
+message = response.message # Returns a hash
+```
+
+## How to use the service
+
+```ruby
+# You need to have an initialized client, see "How to use the client" above.
+service = BrregGrunndata::Service.new client: client
+
+# Get data for a given org number. Will return either the organization or null
+# If an error occurs an error will be raised
+organization = service.hent_basisdata_mini orgnr: '123456789'
+
+organization.orgnr                    # Not surprisingly the organization number
+organization.name                     # The name of this organization
+organization.business_address         # An address object, responds to street etc.
+organization.organizational_form.name # ENK, ASA, etc
+# ..etc
+```
+
+### Merge data from different soap operations
+
+```ruby
+# Some data are fetched from other soap operations
+organization = service.hent_basisdata_mini orgnr: '123456789'
+
+organization.telephone_number   # nil
+organization.email              # nil
+
+merged_organization = organization.merge service.hent_kontaktdata orgnr: '123456789'
+merged_organization.telephone_number  # 77 66 55 44
+merged_organization.email             # 'email@example.com'
+```
+
+### Get data efficiently
+
+Data for one organization is spread over multiple operations.
+If you want you can use `#service.run_concurrently` to use threads
+and execute different operations at the same time. Data returned from
+each service will be `#merge`-ed  together.
+
+```ruby
+operations = [:hent_basisdata_mini, :hent_kontaktdata]
+organization = service.run_concurrently operations, orgnr: '123456789'
+
+organization.name           # Filled from operation hent_basisdata_mini
+organization.mobile_number  # Filled from operation hent_kontaktdata
+```
+
+# Web service documentation
+For a better understanding of what to expect of `response.header`
+and `response.message` please take a look at [this page from brreg](https://www.brreg.no/produkter-og-tjenester/bestille/tilgang-til-enhetsregisteret-via-web-services/teknisk-beskrivelse-web-services/grunndataws/).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'brreg_grunndata'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+
+#
+#  Easy access to a brreg client from within the console
+#
+# If you have  credentials set in ENV all you should need to do
+# in the console is:
+#
+# client.hent_basisdata_mini orgnr: 'xyz' OR
+# c.hent_basisdata_mini orgnr: 'xyz'
+#
+def client(debug: false, userid: nil, password: nil)
+  config = {
+    userid: userid || ENV['BRREG_USERNAME'],
+    password: password || ENV['BRREG_PASSWORD']
+  }
+
+  if debug
+    config[:logger] = Logger.new(STDOUT)
+    config[:log_level] = :debug
+  end
+
+  BrregGrunndata::Client.new configuration: BrregGrunndata::Configuration.new(config)
+end
+alias c client
+
+def service(debug: false, userid: nil, password: nil)
+  BrregGrunndata::Service.new client: client(debug: debug, userid: userid, password: password)
+end
+alias s service
+
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/brreg_grunndata.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'brreg_grunndata/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'brreg_grunndata'
+  spec.version       = BrregGrunndata::VERSION
+  spec.authors       = ['Thorbjørn Hermansen']
+  spec.email         = ['thhermansen@gmail.com']
+
+  spec.summary       = %(Access BRREG's grunndata)
+  spec.description   = %(Access BRREG's grunndata)
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'savon', '~> 2.11'
+  spec.add_dependency 'dry-struct', '~> 0.1.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 2.3.0'
+  spec.add_development_dependency 'pry'
+end

data/lib/brreg_grunndata.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'brreg_grunndata/version'
+
+require_relative 'brreg_grunndata/error'
+require_relative 'brreg_grunndata/configuration'
+require_relative 'brreg_grunndata/client'
+require_relative 'brreg_grunndata/service'
+
+module BrregGrunndata
+end

data/lib/brreg_grunndata/client.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+require 'savon'
+
+require_relative 'client/response'
+require_relative 'client/response_validator'
+require_relative 'client/sok_enhet_query_to_xml'
+
+module BrregGrunndata
+  # Brreg client to access brreg's data
+  #
+  # This is a thin wrapper around BRREG's soap API using
+  # Savon to communicate.
+  #
+  # Compared to simply use savon directly use of this client offers:
+  #   - Unwrap the return value (which is a XML string)
+  #   - Handle common errors
+  #   - Has a clear interface of the soap operations we support.
+  #
+  # @see Service
+  class Client
+    # Raised when we have a timeout error
+    class TimeoutError < Error; end
+
+    def initialize(configuration:, service: nil)
+      @configuration = configuration
+      @service = service || build_savon_service
+    end
+
+    # Get basic mini data of an organization
+    #
+    # Arguments
+    #   orgnr   - The orgnr you are searching for
+    #
+    # @return BrregGrunndata::Response
+    def hent_basisdata_mini(orgnr:)
+      call :hent_basisdata_mini, orgnr: orgnr
+    end
+
+    # Get contact information for an organization
+    #
+    # Arguments
+    #   orgnr   - The orgnr you are searching for
+    #
+    # @return BrregGrunndata::Response
+    def hent_kontaktdata(orgnr:)
+      call :hent_kontaktdata, orgnr: orgnr
+    end
+
+    # Search for an organization
+    #
+    # Makes it possible to find an organization from name
+    #
+    # NOTE
+    # ==================
+    # The response.message you get back seems to be a document of it's own,
+    # with header, some info about the search, and the hits.
+    #
+    # We may choose to do something with this message response in the
+    # future, or make this easier to use on the service level.
+    #
+    # Currently its structure is something like:
+    #
+    # <BrAixXmlResponse ResponseType="BrErfrTreffliste">
+    #   <BrAixResponseHeader>
+    #     <ReturStatus>0</ReturStatus>
+    #     <TimeStamp>2016-12-04T20:03:09</TimeStamp>
+    #     <ElapsedTime>168</ElapsedTime>
+    #     <AntallTreff>61</AntallTreff>
+    #   </BrAixResponseHeader>
+    #   <Sokeverdier>
+    #     <BrSokeStreng>STATOIL ASA</BrSokeStreng>
+    #     <OrgForm>ALLE</OrgForm>
+    #     <Fylke Fylkesnr="0">ALLE</Fylke>
+    #     <Kommune Kommunenr="0">ALLE</Kommune>
+    #     <Slettet>N</Slettet>
+    #     <MedUnderenheter>true</MedUnderenheter>
+    #     <MaxTreffReturneres>100</MaxTreffReturneres>
+    #     <ReturnerIngenHvisMax>true</ReturnerIngenHvisMax>
+    #   </Sokeverdier>
+    #   <BrErfrTreffliste Antall="61">
+    #     <BrErfrTrefflisteElement>
+    #       <Orgnr>873152362</Orgnr>
+    #       <OrgNavn>STATOIL ASA AVD KONTOR BERGEN</OrgNavn>
+    #       <Sted>5254 SANDSLI</Sted>
+    #       <Score>100</Score>
+    #       <OrgForm>BEDR</OrgForm>
+    #     </BrErfrTrefflisteElement>
+    #
+    # ...
+    #
+    #
+    # Arguments
+    #   query             -   Your search string / query goes here
+    #   first             -   How many do you want to get in return? (the limit)
+    #   include_no_if_max -   Do you want zero results if your search yields more
+    #                         results than the first X you asked for? I don't know
+    #                         why you would want that.
+    #   with_subdivision  -   Do you want to include organization form BEDR og AAFY
+    #                         when you search?
+    # @return BrregGrunndata::Response
+    def sok_enhet(query:, first: 100, include_no_if_max: false, with_subdivision: true)
+      call :sok_enhet, search_request!: SokEnhetQueryToXml.new(
+        query,
+        first: first,
+        include_no_if_max: include_no_if_max,
+        with_subdivision: with_subdivision
+      ).cdata
+    end
+
+    # Gets extended information about an organization
+    #
+    # This returns information regarding organization is
+    # "Foretaksregisteret", "Merverdiavgiftsregisteret", or "konkursbehandling"
+    #
+    # Arguments
+    #   orgnr   - The orgnr you are searching for
+    #
+    # @return BrregGrunndata::Response
+    def hent_saerlige_opplysninger(orgnr:)
+      call :hent_saerlige_opplysninger, orgnr: orgnr
+    end
+
+    # Gets information from "Tilknyttet registeret"
+    #
+    # Contains information about "naeringskode", "sektorkode", "ansvarskapital"
+    # and number of employees
+    #
+    # Arguments
+    #   orgnr   - The orgnr you are searching for
+    #
+    # @return BrregGrunndata::Response
+    def hent_opplysninger_tilknyttet_register(orgnr:)
+      call :hent_oppl_tilkn_register, orgnr: orgnr
+    end
+
+    private
+
+    attr_reader :configuration, :service
+
+    # Calls the operation in soap service. Message will include credentials
+    #
+    # Arguments
+    #   operation   - The name of the operation, ex :hent_basisdata_mini
+    #   message     - The message to be sent to the operation.
+    #                 Credentials will be merged before message is sent.
+    def call(operation, message)
+      savon_response = service.call operation, message: message.merge(credentials)
+
+      ResponseValidator.new(
+        Response.new(savon_response)
+      ).raise_error_or_return_response!
+    rescue ::Net::ReadTimeout
+      raise TimeoutError
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def build_savon_service
+      options = {
+        open_timeout: configuration.open_timeout,
+        read_timeout: configuration.read_timeout,
+        wsdl: configuration.wsdl
+      }
+
+      if configuration.logger
+        options[:logger] = configuration.logger
+        options[:log_level] = configuration.log_level
+        options[:log] = true
+      end
+
+      Savon.client options
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def credentials
+      {
+        userid: configuration.userid,
+        password: configuration.password
+      }
+    end
+  end
+end