openkvk 0.0.1

data/.gitignore

@@ -0,0 +1,12 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store
+._*
+coverage/*
+doc/*
+test.rb
+.yardoc
+.AppleDouble
+

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE.mkd

@@ -0,0 +1,7 @@
+Copyright (c) 2011 Zilverline / Daniël van Hoesel
+
+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.mkd

@@ -0,0 +1,45 @@
+OpenKVK: Ruby wrapper for the [OpenKVK api](http://api.openkvk.nl/)
+====================
+
+Installation
+------------
+	gem install openkvk
+
+Usage Examples
+--------------
+General:
+
+	require "openkvk"
+
+	company = OpenKVK.find("Zilverline B.V.", :count => :first)
+	company = OpenKVK.find("Zilverline").first
+	company = OpenKVK.find_by_bedrijfsnaam("Zilverline B.V.", :count => :first)
+	company = OpenKVK.find_by_kvk("343774520000", :count => :first)
+	company = OpenKVK.find(:conditions => ["bedrijfsnaam = 'Zilverline B.V.'", "kvk = '343774520000'"], :count => :first)
+	company = OpenKVK.find(:conditions => ["bedrijfsnaam = 'FooBar'", "kvk = '343774520000'"], :match => :any, :count => :first)
+	
+	puts company.bedrijfsnaam 
+	 #=> "Zilverline B.V."
+	puts company.kvk
+	 #=> "343774520000"
+	puts company.adres
+	 #=> "Molukkenstraat 200 E4"
+	puts company.plaats
+	 #=> "Amsterdam"
+	puts company.postcode
+	 #=> "1098TW"
+	puts company.type
+	 #=> "Hoofdvestiging"
+	puts company.website
+	 #=> nil
+
+Testing
+-------
+Run all tests:
+
+	rake
+
+Copyright
+---------
+Copyright (c) 2011 Zilverline / Daniël van Hoesel.
+See [LICENSE](https://github.com/zilverline/openkvk/blob/master/LICENSE.mkd) for details.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+namespace :doc do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['HISTORY.mkd', 'LICENSE.mkd', 'lib/**/*.rb']
+    task.options = [
+      '--protected',
+      '--output-dir', 'doc/yard',
+      '--markup', 'markdown',
+    ]
+  end
+end

data/lib/openkvk/api.rb

@@ -0,0 +1,38 @@
+require 'uri'
+require 'net/http'
+require 'json'
+require 'hashie/mash'
+
+module OpenKVK
+  class InvalidResponseException < Exception; end
+  
+  class API
+    class << self
+      def query(query)
+        #puts query
+        result = JSON.parse(get(query)).first["RESULT"]
+
+        records = []
+        result["ROWS"].each do |row|
+          records << Hashie::Mash.new(Hash[*result["HEADER"].zip(row).flatten])
+        end
+        records
+      end
+      
+      private
+      
+      def get(query)
+        begin
+          response = Net::HTTP.get_response(URI.parse("#{OpenKVK.host}json/#{URI.escape(query)}"))
+          if response.kind_of?(Net::HTTPRedirection)
+            response = Net::HTTP.get_response(URI.parse("#{OpenKVK.host}#{URI.escape(response["Location"])}"))
+          end
+          response.body
+        rescue Exception => e
+          raise InvalidResponseException.new("Couldn't get the response: #{$!}")
+        end
+      end
+
+    end
+  end
+end

data/lib/openkvk/configuration.rb

@@ -0,0 +1,36 @@
+module OpenKVK
+  # Defines constants and methods related to configuration
+  module Configuration
+    # An array of valid keys in the options hash when configuring an {OpenKVK::API}
+    VALID_OPTIONS_KEYS = [:host].freeze
+
+    # By default, set http://api.openkvk.nl/ as the server
+    DEFAULT_HOST = "http://api.openkvk.nl/".freeze
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.host = DEFAULT_HOST
+      self
+    end
+  end
+end

data/lib/openkvk/version.rb

@@ -0,0 +1,3 @@
+module OpenKVK
+  VERSION = "0.0.1"
+end

data/lib/openkvk.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../openkvk/configuration', __FILE__)
+require File.expand_path('../openkvk/api', __FILE__)
+
+module OpenKVK
+  extend Configuration
+    
+  class << self
+    def find(options={})
+      if options.is_a?(String)
+        options = {:conditions => ["bedrijfsnaam LIKE '%#{options}%'"]}
+      end
+      options = {:limit => 1000, :select => ["*"], :count => :all, :match_condition => :all}.merge(options)
+      
+      options[:limit] = 1 if options[:count] == :first
+      result = API.query("SELECT #{options[:select].join(", ")} FROM kvk WHERE #{options[:conditions].join(options[:match_condition] == :any ? " OR " : " AND ")} LIMIT #{options[:limit]}")
+      return result.first if options[:count] == :first
+      result
+    end
+    
+    %w{kvk bedrijfsnaam kvks adres postcode plaats type website}.each do |field|      
+      define_method("find_by_#{field}") do |value, options={}|
+        options = {:conditions => ["#{field} LIKE '%#{value}%'"]}.merge(options)
+        find(options)
+      end
+    end
+    
+  end
+  
+
+  
+end

data/openkvk.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "openkvk/version"
+
+Gem::Specification.new do |s|
+  s.add_development_dependency('bundler', '~> 1.0')
+  s.add_development_dependency('rake', '~> 0.8')
+  s.add_development_dependency('rspec', '~> 2.3')
+  s.add_development_dependency('mocha', '~> 0.9.10')
+  s.add_development_dependency('simplecov', '~> 0.3')
+  s.add_development_dependency('maruku', '~> 0.6')
+  s.add_development_dependency('yard', '~> 0.6')
+  s.add_development_dependency('hashie', '~> 1.0.0')
+  s.add_development_dependency('json', '~> 1.5.1')
+  
+  s.name        = "openkvk"
+  s.version     = OpenKVK::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Daniel van Hoesel"]
+  s.email       = ["daniel@zilverline.com"]
+  s.homepage    = "http://zilverline.com/"
+  s.summary     = %q{Ruby wrapper for the OpenKVK api}
+  s.description = %q{This is a ruby wrapper for the Dutch OpenKVK api}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/openkvk/api_spec.rb

@@ -0,0 +1,33 @@
+require 'uri'
+require 'net/http'
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe OpenKVK do
+  
+  describe ".get" do
+    it "should return an array with records" do
+      response = Hashie::Mash.new(:body => '[{"RESULT":{"TYPES":["bigint","varchar","int","int","varchar","varchar","varchar","varchar","varchar"],"HEADER":["kvk","bedrijfsnaam","kvks","sub","adres","postcode","plaats","type","website"],"ROWS":[["342838240000","Zilverline Beheer B.V.","34283824","0","Finsenstraat 56","1098RJ","Amsterdam","Hoofdvestiging",null],["343774520000","Zilverline B.V.","34377452","0","Molukkenstraat 200 E4","1098TW","Amsterdam","Hoofdvestiging",null]]}}]')
+      Net::HTTP.stubs(:get_response).returns(response)
+      
+      OpenKVK::API.query("SELECT * FROM kvk WHERE bedrijfsnaam LIKE '%Zilverline%' LIMIT 1000").size.should == 2
+    end
+    
+    it "should follow a redirect" do
+      response = Hashie::Mash.new(:Location => "new location", :body => '[{"RESULT":{"TYPES":["bigint","varchar","int","int","varchar","varchar","varchar","varchar","varchar"],"HEADER":["kvk","bedrijfsnaam","kvks","sub","adres","postcode","plaats","type","website"],"ROWS":[["342838240000","Zilverline Beheer B.V.","34283824","0","Finsenstraat 56","1098RJ","Amsterdam","Hoofdvestiging",null],["343774520000","Zilverline B.V.","34377452","0","Molukkenstraat 200 E4","1098TW","Amsterdam","Hoofdvestiging",null]]}}]')
+
+      response.stubs(:kind_of?).returns(Net::HTTPRedirection)
+      Net::HTTP.stubs(:get_response).returns(response)
+      
+      OpenKVK::API.query("SELECT * FROM kvk WHERE bedrijfsnaam LIKE '%Zilverline%' LIMIT 1000").size.should == 2
+    end
+    
+    it "should raise an exception when something goes wrong" do
+      Net::HTTP.stubs(:get_response).raises(Exception.new("test exception"))
+      lambda {
+        OpenKVK::API.query("SELECT * FROM kvk WHERE bedrijfsnaam LIKE '%Zilverline%' LIMIT 1000")
+      }.should raise_error OpenKVK::InvalidResponseException
+    end
+    
+  end
+  
+end

data/spec/openkvk_spec.rb

@@ -0,0 +1,105 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe OpenKVK do
+  
+  describe ".find" do
+    it "should find a company" do
+      expect_query("SELECT * FROM kvk WHERE bedrijfsnaam LIKE '%Zilverline%' LIMIT 1", '[{"RESULT":{"TYPES":["bigint","varchar","int","int","varchar","varchar","varchar","varchar","varchar"],"HEADER":["kvk","bedrijfsnaam","kvks","sub","adres","postcode","plaats","type","website"],"ROWS":[["343774520000","Zilverline B.V.","34377452","0","Molukkenstraat 200 E4","1098TW","Amsterdam","Hoofdvestiging",null]]}}]')
+
+      company = OpenKVK.find(:conditions => ["bedrijfsnaam LIKE '%Zilverline%'"], :count => :first)
+      company.bedrijfsnaam.should == "Zilverline B.V."
+      company.kvk.should == "343774520000"
+      company.adres.should == "Molukkenstraat 200 E4"
+      company.postcode.should == "1098TW"
+      company.plaats.should == "Amsterdam"
+      company.type.should == "Hoofdvestiging"
+      company.website.should be nil
+    end
+    
+    it "should find multiple companies" do
+      expect_query("SELECT * FROM kvk WHERE bedrijfsnaam LIKE '%Zilverline%' LIMIT 1000", '[{"RESULT":{"TYPES":["bigint","varchar","int","int","varchar","varchar","varchar","varchar","varchar"],"HEADER":["kvk","bedrijfsnaam","kvks","sub","adres","postcode","plaats","type","website"],"ROWS":[["342838240000","Zilverline Beheer B.V.","34283824","0","Finsenstraat 56","1098RJ","Amsterdam","Hoofdvestiging",null],["343774520000","Zilverline B.V.","34377452","0","Molukkenstraat 200 E4","1098TW","Amsterdam","Hoofdvestiging",null]]}}]')
+      
+      companies = OpenKVK.find("Zilverline")
+      companies.size.should == 2
+      
+      company = companies.last
+      company.bedrijfsnaam.should == "Zilverline B.V."
+    end
+    
+    it "should only return selected fields" do
+      expect_query("SELECT bedrijfsnaam FROM kvk WHERE bedrijfsnaam LIKE '%Zilverline%' LIMIT 1", '[{"RESULT":{"TYPES":["varchar"],"HEADER":["bedrijfsnaam"],"ROWS":[["Zilverline B.V."]]}}]')
+      
+      company = OpenKVK.find(:conditions => ["bedrijfsnaam LIKE '%Zilverline%'"], :count => :first, :select => [:bedrijfsnaam])
+      
+      company.bedrijfsnaam.should == "Zilverline B.V."
+      company.keys.should == %w{bedrijfsnaam}
+      
+      expect_query("SELECT bedrijfsnaam, kvk FROM kvk WHERE bedrijfsnaam LIKE '%Zilverline%' LIMIT 1", '[{"RESULT":{"TYPES":["varchar","bigint"],"HEADER":["bedrijfsnaam","kvk"],"ROWS":[["Zilverline B.V.","343774520000"]]}}]')
+      
+      company = OpenKVK.find(:conditions => ["bedrijfsnaam LIKE '%Zilverline%'"], :count => :first, :select => [:bedrijfsnaam, :kvk])
+      
+      company.bedrijfsnaam.should == "Zilverline B.V."
+      company.kvk.should == "343774520000"
+      company.keys.should == %w{bedrijfsnaam kvk}
+    end
+    
+    it "should find a company with multiple conditions" do
+      expect_query("SELECT * FROM kvk WHERE bedrijfsnaam LIKE '%Zilverline%' AND kvk = '343774520000' LIMIT 1", '[{"RESULT":{"TYPES":["bigint","varchar","int","int","varchar","varchar","varchar","varchar","varchar"],"HEADER":["kvk","bedrijfsnaam","kvks","sub","adres","postcode","plaats","type","website"],"ROWS":[["343774520000","Zilverline B.V.","34377452","0","Molukkenstraat 200 E4","1098TW","Amsterdam","Hoofdvestiging",null]]}}]')
+
+      company = OpenKVK.find(:conditions => ["bedrijfsnaam LIKE '%Zilverline%'", "kvk = '343774520000'"], :count => :first)
+      company.bedrijfsnaam.should == "Zilverline B.V."
+      company.kvk.should == "343774520000"
+    end
+    
+    it "should find a company with multiple conditions" do
+      expect_query("SELECT * FROM kvk WHERE bedrijfsnaam LIKE '%FooBar%' OR kvk = '343774520000' LIMIT 1", '[{"RESULT":{"TYPES":["bigint","varchar","int","int","varchar","varchar","varchar","varchar","varchar"],"HEADER":["kvk","bedrijfsnaam","kvks","sub","adres","postcode","plaats","type","website"],"ROWS":[["343774520000","Zilverline B.V.","34377452","0","Molukkenstraat 200 E4","1098TW","Amsterdam","Hoofdvestiging",null]]}}]')
+
+      company = OpenKVK.find(:conditions => ["bedrijfsnaam LIKE '%FooBar%'", "kvk = '343774520000'"], :match_condition => :any, :count => :first)
+      company.bedrijfsnaam.should == "Zilverline B.V."
+      company.kvk.should == "343774520000"
+    end
+  end
+  
+
+  describe ".find_by_bedrijfsnaam" do
+    it "should find a company" do
+      expect_query("SELECT * FROM kvk WHERE bedrijfsnaam LIKE '%Zilverline B.V.%' LIMIT 1", '[{"RESULT":{"TYPES":["bigint","varchar","int","int","varchar","varchar","varchar","varchar","varchar"],"HEADER":["kvk","bedrijfsnaam","kvks","sub","adres","postcode","plaats","type","website"],"ROWS":[["343774520000","Zilverline B.V.","34377452","0","Molukkenstraat 200 E4","1098TW","Amsterdam","Hoofdvestiging",null]]}}]')
+    
+      OpenKVK.find_by_bedrijfsnaam("Zilverline B.V.", :count => :first).bedrijfsnaam.should == "Zilverline B.V."
+    end
+  end
+  
+  describe ".find_by_kvk" do
+    it "should find a company" do
+      expect_query("SELECT * FROM kvk WHERE kvk LIKE '%343774520000%' LIMIT 1", '[{"RESULT":{"TYPES":["bigint","varchar","int","int","varchar","varchar","varchar","varchar","varchar"],"HEADER":["kvk","bedrijfsnaam","kvks","sub","adres","postcode","plaats","type","website"],"ROWS":[["343774520000","Zilverline B.V.","34377452","0","Molukkenstraat 200 E4","1098TW","Amsterdam","Hoofdvestiging",null]]}}]')
+    
+      OpenKVK.find_by_kvk("343774520000", :count => :first).bedrijfsnaam.should == "Zilverline B.V."
+    end
+  end
+  
+  describe ".host=" do
+    it "should set the host" do
+      OpenKVK.host = "http://api.openkvk.nl/"
+      OpenKVK.host.should == "http://api.openkvk.nl/"
+    end
+  end
+  
+  describe ".options" do
+    it "should return a hash with the current settings" do
+      OpenKVK.host = "test host"
+      OpenKVK.options == {:host => "test host"}
+    end
+  end
+
+  describe ".configure" do
+    OpenKVK::Configuration::VALID_OPTIONS_KEYS.each do |key|
+      it "should set the #{key}" do
+        OpenKVK.configure do |config|
+          config.send("#{key}=", key)
+          OpenKVK.send(key).should == key
+        end
+      end
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rspec'
+require 'simplecov'
+SimpleCov.start do
+  add_group 'OpenKVK', 'lib/openkvk'
+  add_group 'Specs', 'spec'
+  add_filter __FILE__
+end
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end
+
+def expect_query(sql, response)
+  OpenKVK::API.expects(:get).with(sql).returns(response)
+end
+
+load File.expand_path('../../lib/openkvk.rb', __FILE__)

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification 
+name: openkvk
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Daniel van Hoesel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-06 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.8"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.3"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.10
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.3"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: maruku
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.6"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.6"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+  type: :development
+  version_requirements: *id009
+description: This is a ruby wrapper for the Dutch OpenKVK api
+email: 
+- daniel@zilverline.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.mkd
+- README.mkd
+- Rakefile
+- lib/openkvk.rb
+- lib/openkvk/api.rb
+- lib/openkvk/configuration.rb
+- lib/openkvk/version.rb
+- openkvk.gemspec
+- spec/openkvk/api_spec.rb
+- spec/openkvk_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://zilverline.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the OpenKVK api
+test_files: 
+- spec/openkvk/api_spec.rb
+- spec/openkvk_spec.rb
+- spec/spec_helper.rb