openkvk-wrapper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6d980713a9ba9556e9f19c60b1966c38602a8068
+  data.tar.gz: 1337f301113f259b57596f07e9913591fa93d151
+SHA512:
+  metadata.gz: 6343dc38cd6582fb75f17b06b3034e613431dd203706edda103becc8d732147135f6151210482df84d595d9099af080d732b78f580c69265686febfd22533020
+  data.tar.gz: 20fa1a9550598e423b0007effbcf0f755c3d6e229b9a25389d14e7d328d3ea8ae1dcc7b538d33e9dc0833ef0e445b052edc46a43faed86c844a2e7b03eb937fc

data/lib/openkvk.rb

@@ -0,0 +1,71 @@
+require 'net/http'
+require 'json'
+require 'cgi'
+
+##
+# This module represents a wrapper for the Openkvk.nl API.
+module OpenKVK
+
+  ##
+  # 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))
+  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="officieel.openkvk.nl")
+      # Use 'net/http' to request. Avoid as many depencies as possible.
+      url = URI.parse(
+         protocol +
+         "://" +
+         host +
+         "/" +
+         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

metadata

@@ -0,0 +1,44 @@
+--- !ruby/object:Gem::Specification
+name: openkvk-wrapper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- StephanMeijer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-13 00:00:00.000000000 Z
+dependencies: []
+description: A simple wrapper for the OpenKVK API.
+email: me@stephanmeijer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/openkvk.rb
+homepage: http://rubygems.org/gems/openkvk-wrapper
+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.6
+signing_key: 
+specification_version: 4
+summary: Wrapper for openkvk.nl
+test_files: []