kvk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 16a53a6958e633c18b014d6200d7cbadfbeece75
+  data.tar.gz: 78705643d2f5e83ddbe665f4d3286077a611d4ed
+SHA512:
+  metadata.gz: 55f567bc4c6e0524615f7b5491c17e4b0ca003d74d694628035397feb511c444840f1e5a9f3b4a57d3c24e2a99e06f8d5ae212b6d9321e7f37b5ac9c9d843c21
+  data.tar.gz: 62dbecb977a4b388f373e763167ae30423d7e93829818f940bb33e703f626cb0fe9e84e3c113742c9cca318d6fced214043e17ef175924cdc1ad99e6b983c1dc

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Stephan Meijer
+
+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/lib/kvk/gem.rb

@@ -0,0 +1,69 @@
+##
+# This module represents a wrapper for the KVK API.
+module KVK
+
+  ##
+  # Custom HTTP Client Error.
+  #
+  # Throw this if HTTP STATUS CODE indicates an error. (>= 400)
+  class HTTPClientError < StandardError; end
+
+  ##
+  # Request a list with companies using the string +query+.
+  # +query+ contains the keywords to search with.
+  #
+  # This function requests all companies according to the keywords in the strings +query+,
+  # and returns a hash.
+  #
+  # * *Args*      :
+  #   - +query+ -> keywords to search with in the OpenKVK API
+  # * *Returns*   :
+  #   - search results (with type Hash)
+  # * *Raises*    :
+  #   - +SocketError+ -> if OpenKVK changed their hostname without telling people
+  #   - +HTTPClientError+ -> if HTTP STATUS CODE equals or is higher than 400
+  def search(query)
+    JSON.parse(get(query))["resultatenHR"]
+  end
+
+  private
+
+    ##
+    # Magic happens here. This function requests a JSON document, and returns it.
+    #
+    # * *Args*    :
+    #   - +query+ -> keywords to search with in the OpenKVK API
+    #   - +protocol+ -> protocol to use, currently only support for HTTP
+    #   - +host+ -> hostname of our API, might change once in a while
+    # * *Returns* :
+    #   - String with searchresults in JSON
+    # * *Raises*  :
+    #   - +SocketError+ -> if OpenKVK changed their hostname without telling people
+    #   - +HTTPClientError+ -> if HTTP STATUS CODE equals or is higher than 400
+    def get(query, protocol="http", host="zoeken.kvk.nl", 
+file="Address.ashx?q=")
+      # Use 'net/http' to request. Avoid as many depencies as possible.
+      url = URI.parse(
+         protocol +
+         "://" +
+         host +
+         "/" +
+         file +
+         CGI::escape(query)
+       )
+
+       # HTTP magic happens here.
+       req = Net::HTTP::Get.new(url.to_s)
+       res = Net::HTTP.start(url.host, url.port) do |http|
+         http.request(req)
+       end
+
+      # If HTTP STATUS not OK (STATUS >= 400), raise error.
+      raise(HTTPClientError, "Status code " + res.code) if res.code.to_i >= 400
+
+       res.body
+    end
+
+  module_function :search, :get
+
+end

data/lib/kvk/version.rb

@@ -0,0 +1,11 @@
+module KVK
+  def version
+    major = 0
+    minor = 0
+    tiny  = 1
+
+    [major, minor, tiny].join('.')
+  end
+
+  module_function :version
+end

data/lib/kvk.rb

@@ -0,0 +1,6 @@
+require 'net/http'
+require 'json'
+require 'cgi'
+
+require 'kvk/version'
+require 'kvk/gem'

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: kvk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stephan Meijer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-14 00:00:00.000000000 Z
+dependencies: []
+description: "  Simple KVK API wrapper.\n"
+email: me@stephanmeijer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/kvk.rb
+- lib/kvk/gem.rb
+- lib/kvk/version.rb
+homepage: http://github.com/StephanMeijer/kvk-ruby
+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
+signing_key: 
+specification_version: 4
+summary: A simple KVK wrapper.
+test_files: []