be-data-api 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gitignore +17 -0
- data/Gemfile +5 -0
- data/LICENSE.txt +22 -0
- data/README.md +42 -0
- data/Rakefile +1 -0
- data/be-data-api.gemspec +22 -0
- data/lib/be-data-api.rb +63 -0
- data/lib/be-data-api/version.rb +7 -0
- metadata +91 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2012 Simon Menke
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,42 @@
|
|
1
|
+
# Be::Data::Api
|
2
|
+
|
3
|
+
API client for [Data.be](http://api.data.be/)
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
gem 'be-data-api'
|
10
|
+
|
11
|
+
And then execute:
|
12
|
+
|
13
|
+
$ bundle
|
14
|
+
|
15
|
+
Or install it yourself as:
|
16
|
+
|
17
|
+
$ gem install be-data-api
|
18
|
+
|
19
|
+
## Usage
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'be-data-api'
|
23
|
+
|
24
|
+
client = Be::Data::Api.new(API_ID, API_KEY)
|
25
|
+
|
26
|
+
client.vat_valid?("882381185")
|
27
|
+
# => true
|
28
|
+
|
29
|
+
client.vat_status("882381185")
|
30
|
+
# => #<struct Be::Data::Api::VatStatus vat_clean="0882381185", vat_formatted="BE 0882.381.185", active=true, valid=true>
|
31
|
+
|
32
|
+
client.vat_basic("882381185")
|
33
|
+
# => #<struct Be::Data::Api::VatBasic vat_clean="0882381185", vat_formatted="BE 0882.381.185", active=true, valid=true, company_name="Mr.Henry", start_date="2006-07-03", language="nl", address_fr="Veldenstraat 14, , 2470 Retie", address_nl="Veldenstraat 14, , 2470 Retie">
|
34
|
+
```
|
35
|
+
|
36
|
+
## Contributing
|
37
|
+
|
38
|
+
1. Fork it
|
39
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
40
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
41
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
42
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
data/be-data-api.gemspec
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'be-data-api/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |gem|
|
7
|
+
gem.name = "be-data-api"
|
8
|
+
gem.version = Be::Data::Api::VERSION
|
9
|
+
gem.authors = ["Simon Menke"]
|
10
|
+
gem.email = ["simon.menke@gmail.com"]
|
11
|
+
gem.description = %q{Data.be is the first api provider for Belgian Business Information.}
|
12
|
+
gem.summary = %q{Data.be API client}
|
13
|
+
gem.homepage = "http://github.com/fd/be-data-api"
|
14
|
+
|
15
|
+
gem.files = `git ls-files`.split($/)
|
16
|
+
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
|
17
|
+
gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
|
18
|
+
gem.require_paths = ["lib"]
|
19
|
+
|
20
|
+
gem.add_runtime_dependency 'multi_json'
|
21
|
+
gem.add_runtime_dependency 'excon'
|
22
|
+
end
|
data/lib/be-data-api.rb
ADDED
@@ -0,0 +1,63 @@
|
|
1
|
+
require "be-data-api/version"
|
2
|
+
require 'multi_json'
|
3
|
+
require 'excon'
|
4
|
+
|
5
|
+
module Be
|
6
|
+
module Data
|
7
|
+
class Api
|
8
|
+
|
9
|
+
def initialize(api_id, api_key)
|
10
|
+
@conn = Excon.new("https://api.data.be", :query => { "api_id" => api_id, "api_key" => api_key })
|
11
|
+
end
|
12
|
+
|
13
|
+
# API DOC: http://api.data.be/#validity
|
14
|
+
# @example
|
15
|
+
# Be::Data::Api.new(...).vat_valid? "844044609"
|
16
|
+
# Be::Data::Api.new(...).vat_valid? "0844.044.609"
|
17
|
+
# Be::Data::Api.new(...).vat_valid? "BE-0844-044-609"
|
18
|
+
def vat_valid?(vat_number)
|
19
|
+
response = get("/1.0/vat/#{vat_number}/validity")
|
20
|
+
p response
|
21
|
+
return !!response["valid"]
|
22
|
+
end
|
23
|
+
|
24
|
+
# API DOC: http://api.data.be/#status
|
25
|
+
# @example
|
26
|
+
# Be::Data::Api.new(...).vat_status "844044609"
|
27
|
+
# Be::Data::Api.new(...).vat_status "0844.044.609"
|
28
|
+
# Be::Data::Api.new(...).vat_status "BE-0844-044-609"
|
29
|
+
def vat_status(vat_number)
|
30
|
+
response = get("/1.0/vat/#{vat_number}/status")
|
31
|
+
return VatStatus.new(response['vat-clean'], response['vat-formatted'], !!response['active'], !!response['valid'])
|
32
|
+
end
|
33
|
+
class VatStatus < Struct.new(:vat_clean, :vat_formatted, :active, :valid) ; end
|
34
|
+
|
35
|
+
# API DOC: http://api.data.be/#basic
|
36
|
+
# @example
|
37
|
+
# Be::Data::Api.new(...).vat_status "844044609"
|
38
|
+
# Be::Data::Api.new(...).vat_status "0844.044.609"
|
39
|
+
# Be::Data::Api.new(...).vat_status "BE-0844-044-609"
|
40
|
+
def vat_basic(vat_number)
|
41
|
+
response = get("/1.0/vat/#{vat_number}/basic")
|
42
|
+
return VatBasic.new(response['vat-clean'], response['vat-formatted'], !!response['active'], !!response['valid'],
|
43
|
+
response['company-name'], response['start-date'], response['language'], response['address-fr'],
|
44
|
+
response['address-nl'])
|
45
|
+
end
|
46
|
+
class VatBasic < Struct.new(:vat_clean, :vat_formatted, :active, :valid, :company_name, :start_date, :language, :address_fr, :address_nl)
|
47
|
+
end
|
48
|
+
|
49
|
+
private
|
50
|
+
|
51
|
+
def get(path)
|
52
|
+
response = @conn.get(:path => path)
|
53
|
+
response = MultiJson.decode(response.body)
|
54
|
+
if response['success'] == true
|
55
|
+
return response['data']
|
56
|
+
else
|
57
|
+
raise "Be::Data::Api.call failed: #{response.inspect}"
|
58
|
+
end
|
59
|
+
end
|
60
|
+
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
metadata
ADDED
@@ -0,0 +1,91 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: be-data-api
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Simon Menke
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2012-11-09 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: multi_json
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ! '>='
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: '0'
|
22
|
+
type: :runtime
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ! '>='
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '0'
|
30
|
+
- !ruby/object:Gem::Dependency
|
31
|
+
name: excon
|
32
|
+
requirement: !ruby/object:Gem::Requirement
|
33
|
+
none: false
|
34
|
+
requirements:
|
35
|
+
- - ! '>='
|
36
|
+
- !ruby/object:Gem::Version
|
37
|
+
version: '0'
|
38
|
+
type: :runtime
|
39
|
+
prerelease: false
|
40
|
+
version_requirements: !ruby/object:Gem::Requirement
|
41
|
+
none: false
|
42
|
+
requirements:
|
43
|
+
- - ! '>='
|
44
|
+
- !ruby/object:Gem::Version
|
45
|
+
version: '0'
|
46
|
+
description: Data.be is the first api provider for Belgian Business Information.
|
47
|
+
email:
|
48
|
+
- simon.menke@gmail.com
|
49
|
+
executables: []
|
50
|
+
extensions: []
|
51
|
+
extra_rdoc_files: []
|
52
|
+
files:
|
53
|
+
- .gitignore
|
54
|
+
- Gemfile
|
55
|
+
- LICENSE.txt
|
56
|
+
- README.md
|
57
|
+
- Rakefile
|
58
|
+
- be-data-api.gemspec
|
59
|
+
- lib/be-data-api.rb
|
60
|
+
- lib/be-data-api/version.rb
|
61
|
+
homepage: http://github.com/fd/be-data-api
|
62
|
+
licenses: []
|
63
|
+
post_install_message:
|
64
|
+
rdoc_options: []
|
65
|
+
require_paths:
|
66
|
+
- lib
|
67
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
68
|
+
none: false
|
69
|
+
requirements:
|
70
|
+
- - ! '>='
|
71
|
+
- !ruby/object:Gem::Version
|
72
|
+
version: '0'
|
73
|
+
segments:
|
74
|
+
- 0
|
75
|
+
hash: -487953128715518480
|
76
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
77
|
+
none: false
|
78
|
+
requirements:
|
79
|
+
- - ! '>='
|
80
|
+
- !ruby/object:Gem::Version
|
81
|
+
version: '0'
|
82
|
+
segments:
|
83
|
+
- 0
|
84
|
+
hash: -487953128715518480
|
85
|
+
requirements: []
|
86
|
+
rubyforge_project:
|
87
|
+
rubygems_version: 1.8.23
|
88
|
+
signing_key:
|
89
|
+
specification_version: 3
|
90
|
+
summary: Data.be API client
|
91
|
+
test_files: []
|