cpr-client 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 370bb6e5adf2275a7517d5cd4e16a7a3238f6a8c
+  data.tar.gz: f343164a5508cfa3e94fd493fce9402c08c93de5
+SHA512:
+  metadata.gz: 23fabf0b46d29328714286fc0679d44eca2389d1310123c81e851e49a2cdf7978d40cee6119d667972a1804ef982b0750d9b3a9611c31f60c8b037adeca36f5f
+  data.tar.gz: a6920f3334801db2193dd894ec4f11f2db0e975cdc4ea376121b0be11b4e4e07b1356d0bd627a4b31376992da62e6c9a748e3adbb3c2ea841d1d13454d0c0424

data/README.md

@@ -0,0 +1,20 @@
+CPR Client
+===
+
+A client for looking up people in the CPR registry (as a private company).
+It is backed by HTTPClient.
+
+```ruby
+# The client is connecting to the demo environment
+client = CPRClient.new(username, password, true)
+record = client.lookup('0707614285')
+
+if record.nil?
+  puts "The record was not found"
+elsif record.protected?
+  puts "The record has name and address protection"
+else
+  puts record[:adrnvn]
+  puts record[:adrnvn, :t]
+end
+```

data/lib/cpr_client.rb

@@ -0,0 +1,20 @@
+require 'cpr_client/client'
+require 'cpr_client/record'
+require 'cpr_client/errors'
+require 'cpr_client/version'
+
+module CPRClient
+
+  ENDPOINT_DEMO = 'https://gctp-demo.cpr.dk/cpr-online-gctp/gctp'
+  ENDPOINT_PROD = 'https://gctp.cpr.dk/cpr-online-gctp/gctp'
+
+  # Returns a new Client.
+  #
+  # @param user your cpr username
+  # @param pass your current cpr password
+  # @param demo use demo endpoint
+  def self.new(user, pass, demo = false)
+    Client.new(user, pass, demo ? ENDPOINT_DEMO : ENDPOINT_PROD)
+  end
+
+end

data/lib/cpr_client/client.rb

@@ -0,0 +1,131 @@
+require 'httpclient'
+require 'nokogiri'
+require 'cpr_client/record'
+require 'cpr_client/errors'
+require 'cpr_client/version'
+
+module CPRClient
+
+  class Client
+
+    # Returns a new Client.
+    #
+    # @param user your cpr username
+    # @param pass your current cpr password
+    # @param endpoint the full URI to the cpr gctp service
+    def initialize(user, pass, endpoint)
+      @user, @pass, @endpoint = user, pass, endpoint
+      @http = HTTPClient.new(
+          agent_name: "CPRClient/#{CPRClient::VERSION}",
+          default_header: { 'Content-Type' => 'text/xml' }
+      )
+    end
+
+    # Returns a Record object or nil if the record could not be found.
+    # If the client is not logged in, a login is performed before a retry.
+    #
+    # The cpr parameter is stripped of any non-digits.
+    #
+    # @param cpr a string
+    # @return a #Record or nil if no record was found
+    def lookup(cpr)
+      xml_doc = post_auto_login(stamp_body(digits(cpr)))
+      case receipt_code(xml_doc)
+        when 0
+          Record.new(xml_doc)
+        when 172, 52
+          nil
+        else
+          raise ClientError, "Unexpected STAMP resp: #{xml_doc}"
+      end
+    end
+
+    alias_method :stamp, :lookup
+
+    # Performs login for client.
+    #
+    # @return true
+    # @raise LoginError if login failed
+    def login
+      code = receipt_code(post(login_body))
+      code == 900 or raise LoginError, code
+    end
+
+    protected
+
+    # Returns the gctp status code of the given xml_doc.
+    #
+    # If a receipt is not preset then -1 is returned.
+    #
+    # @param xml_doc a Nokogiri::XML object
+    # @return a Fixnum gctp status code
+    def receipt_code(xml_doc)
+      node = xml_doc && xml_doc.at_css('Kvit')
+      node && node['v'] ? node['v'].to_i : -1
+    end
+
+    # Removes all non digit characters from string
+    def digits(arg)
+      arg.to_s.gsub(/\D+/,'')
+    end
+
+    # Posts xml to the server.
+    #
+    # A login is performed if the client is not logged in,
+    # or if the login is expired.
+    #
+    # @param body a string of xml
+    # @return a Nokogiri::XML object
+    # @raise ClientError if the response status was not 200
+    # @raise LoginError if login failed
+    def post_auto_login(body)
+      xml_doc = post(body)
+      xml_doc = login && post(body) if receipt_code(xml_doc) == 901
+      xml_doc
+    end
+
+    # Posts a request to the service with xml as content type.
+    #
+    # @param body a string of xml
+    # @return a Nokogiri::XML object
+    # @raise ClientError if the response status was not 200
+    def post(body)
+      resp = @http.post(@endpoint, body)
+      raise ClientError, 'Bad response' if resp.status != 200
+      Nokogiri::XML(resp.body)
+    end
+
+    private
+
+    def login_body
+      <<-DATA
+      <?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
+      <root xmlns="http://www.cpr.dk">
+        <Gctp v=”1.0”>
+          <Sik function="signon" userid="#{@user}"  password="#{@pass}"/>
+        </Gctp>
+      </root>
+      DATA
+    end
+
+    def stamp_body(cpr)
+      <<-DATA
+      <?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
+      <root xmlns="http://www.cpr.dk">
+        <Gctp v="1.0">
+          <System r="CprSoeg">
+            <Service r="STAMP">
+              <CprServiceHeader r="STAMP">
+                <Key>
+                  <Field r="PNR" v="#{cpr}"/>
+                </Key>
+              </CprServiceHeader>
+            </Service>
+          </System>
+        </Gctp>
+      </root>
+      DATA
+    end
+
+  end
+end

data/lib/cpr_client/errors.rb

@@ -0,0 +1,19 @@
+module CPRClient
+
+  class ClientError < StandardError; end
+
+  class LoginError < ClientError
+
+    attr_reader :code
+
+    # Returns a new instance of LoginError.
+    #
+    # @param code login error code
+    def initialize(code)
+      @code = code
+      super("CPRClient login failed [#{code}]")
+    end
+
+  end
+
+end

data/lib/cpr_client/record.rb

@@ -0,0 +1,63 @@
+module CPRClient
+  class Record
+
+    attr_reader :timestamp, :fields
+
+    # Returns a new Response.
+    #
+    # @param xml_doc a Nokogiri::XML object
+    def initialize(xml_doc)
+      @timestamp = xml_doc.at_css("CprServiceHeader[r='STAMP']")['ts']
+      @fields    = extract_fields(xml_doc)
+    end
+
+    # Gets the value of a field with the given name.
+    #
+    # @param name the name of the target field.
+    # @param value the name of the value attribute
+    def get(name, value = 'v')
+      field = @fields[name.to_s.upcase]
+      field[value.to_s.downcase] if field
+    end
+
+    alias_method :[], :get
+
+    # Returns true if the person has name/address protection.
+    #
+    # @return true if protected, false otherwise
+    def protected?
+      get(:beskyt) == '1'
+    end
+
+    # Returns the birthday as Date.
+    #
+    # @return Date with date of birth
+    def birthday
+      Date.parse(get(:foeddato))
+    end
+
+    # Returns the record's address if present.
+    #
+    # The address will be a string of the fields
+    # STADR, POSTNR and POSTNR's t attribute.
+    #
+    # Fx. Boulevarden 101,1 mf, 6800 Varde
+    #
+    # @return string with address or nil
+    def address
+      values = [ get(:stadr), get(:postnr), get(:postnr, :t) ]
+      '%s, %s %s' % values if values.all?
+    end
+
+    private
+
+    def extract_fields(xml_doc)
+      Hash[xml_doc.css("Praes[r='STAMPNR'] Field").reduce([]) { |a, f|
+        attrs = Hash[f.keys.zip(f.values)]
+        key = attrs.delete('r')
+        attrs.empty? ? a : a << [key, attrs]
+      }]
+    end
+
+  end
+end

data/lib/cpr_client/version.rb

@@ -0,0 +1,3 @@
+module CPRClient
+  VERSION = '0.0.2'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: cpr-client
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Michael Andersen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: Client for making requests to the CPR registry (as a private company)
+email: michael@aion.dk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/cpr_client.rb
+- lib/cpr_client/client.rb
+- lib/cpr_client/errors.rb
+- lib/cpr_client/record.rb
+- lib/cpr_client/version.rb
+homepage: http://assemblyvoting.dk
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: CPR Client
+test_files: []
+has_rdoc: