valbn 0.1.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.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 9a9a620d978952f93077f241878af566e990c367
4
+ data.tar.gz: 79e2c32daf08ff40f76ffa109b862574bb444808
5
+ SHA512:
6
+ metadata.gz: ccec2d937399f96dcddcd4d38a836d0914d824f101fb725fe2854c6758f0903197904b72f0fb801d453e4dda1f847ac6a37a4194bff7fa450e29e2141620fc27
7
+ data.tar.gz: 3ad122a4f8f3d5a162039327e94ceabac6786d491eb67997e2878c79b59eb227626b73af010d666aaa473f89279614c43db8472e82d1f77cc7cce76907fbf4d2
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.1.1
4
+ before_install: gem install bundler -v 1.11.2
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at vidadelaempresa@gmail.com. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in valbn.gemspec
4
+ gemspec
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2018 xxswingxx
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,109 @@
1
+ # Valbn
2
+
3
+ Valbn is just a simple interface to check business numbers (currently supports EU countries, Australia and New Zealand) by using [valvat](https://github.com/yolk/valvat), [valabn](https://github.com/quaderno/valabn) and [valnzbn](https://github.com/quaderno/valnzbn). So instead, doing this in your app:
4
+
5
+ ```ruby
6
+ require 'valvat'
7
+ require 'valabn'
8
+ require 'valnzbn'
9
+
10
+ if country.in? EUROPEAN_COUNTRIES
11
+ Valvat.new(number).exists?
12
+ elsif country == 'AU'
13
+ Valabn.new(number).exists?
14
+ elsif country == 'NZ'
15
+ Valnzbn.new(number).exists?
16
+ end
17
+ ```
18
+
19
+ you can do this:
20
+
21
+ ```ruby
22
+ Valbn.new(number, country).exists?
23
+ ```
24
+
25
+
26
+ ## Installation
27
+
28
+ Add this line to your application's Gemfile:
29
+
30
+ ```ruby
31
+ gem 'valbn'
32
+ ```
33
+
34
+ And then execute:
35
+
36
+ $ bundle
37
+
38
+ Or install it yourself as:
39
+
40
+ $ gem install valbn
41
+
42
+ Please keep in mind that you'll also need to install the gems for each specific service you want to use(`valvat`, `valabn` or `valnzbn`).
43
+
44
+ ## Usage
45
+
46
+ First you need to initialize the gem to check to which services you want to validate.
47
+
48
+ ```ruby
49
+ require 'valbn'
50
+
51
+ Valbn.configure do |config|
52
+ config.vatmoss = true # Via valvat
53
+ config.abn = true # Via valabn
54
+ config.nzbn = true # Via valnzbn
55
+
56
+ Valabn::Lookup.configure do |config|
57
+ config.guid = ABN_GUID
58
+ end
59
+
60
+ Valnzbn::Lookup.configure do |config|
61
+ config.access_token = NZBN_ACCESS_TOKEN
62
+ end
63
+ end
64
+ ```
65
+
66
+ After that you can use:
67
+
68
+ ```ruby
69
+ number = '9429033558257'
70
+ country = 'NZ'
71
+
72
+ business_number = Valbn.new(number, country)
73
+
74
+ business_number.exists? # => True, false or nil
75
+ business_number.exists?(detail: true) # => Hash or nil
76
+ business_number.exists?(formatted: true) # => Hash or nil
77
+ ```
78
+
79
+ The options `detail` and `formatted` returns a `Hash` with extra information about the requested business number. When `detail` is set the format will be the API-specific format but if you select `formatted`, the resulting hash will be normalized as:
80
+
81
+ ```ruby
82
+ {
83
+ original_format: {…}, # The original response as returned with "detail: true"
84
+ name: 'Company name',
85
+ street_line_1: 'Street line 1',
86
+ street_line_2: 'Street line 2',
87
+ region: 'Region',
88
+ city: 'City',
89
+ postal_code: 'postal-code'
90
+ }
91
+ ```
92
+
93
+ Please note that not all the fields can be filled as they depends on the values returned by each API.
94
+
95
+ ## Development
96
+
97
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
98
+
99
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
100
+
101
+ ## Contributing
102
+
103
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/valbn. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
104
+
105
+
106
+ ## License
107
+
108
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
109
+
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "valbn"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,116 @@
1
+ require "valbn/version"
2
+ require 'countries'
3
+
4
+ class Valbn
5
+
6
+ EU_COUNTRIES = ISO3166::Country.find_all_countries_by_in_eu?(true).map(&:alpha2)
7
+
8
+ def self.vatmoss=(value)
9
+ @@vatmoss = value # Valvat
10
+ value ? require('valvat') : false
11
+ rescue
12
+ raise StandardError, 'WARNING: Valvat not found. Please run `gem install valvat`.'
13
+ end
14
+
15
+ def self.abn=(value)
16
+ @@abn = value # Valabn
17
+ value ? require('valabn') : false
18
+ rescue
19
+ raise StandardError, 'WARNING: Valnzbn not found. Please run `gem install valabn`.'
20
+ end
21
+
22
+ def self.nzbn=(value)
23
+ @@abn = value # Valnzbn
24
+ value ? require('valnzbn') : false
25
+ rescue
26
+ raise StandardError, 'WARNING: Valnzbn not found. Please run `gem install valnzbn`.'
27
+ end
28
+
29
+ def self.configure
30
+ yield self
31
+ end
32
+
33
+ def initialize(number, country)
34
+ @country = country
35
+ number = number.to_s.gsub(/\W/, '').upcase
36
+
37
+ if EU_COUNTRIES.include?(country)
38
+ vat_country = Valvat::Utils.iso_country_to_vat_country(country)
39
+ number = "#{vat_country}#{number}" unless !!(number =~ /^#{vat_country}[A-Z0-9]+/) # add the country code if it does not exist
40
+ end
41
+
42
+ @number = number
43
+ end
44
+
45
+ def exists?(options = {})
46
+ options[:detail] = options[:formatted]
47
+
48
+ case @country
49
+ when *EU_COUNTRIES
50
+ if defined?(Valvat) == 'constant'
51
+ result = Valvat.new(@number).exists?(options)
52
+
53
+ if options[:formatted] == true && !result.nil? && result.is_a?(Hash)
54
+ result = {
55
+ original_format: result,
56
+ name: result[:name],
57
+ street_line_1: result[:address]
58
+ }
59
+ end
60
+ else
61
+ raise StandardError, 'WARNING: Valvat not found. Please run `gem install valvat`.'
62
+ end
63
+ when 'AU'
64
+ if defined?(Valvat) == 'constant'
65
+ result = Valabn.new(@number).exists?(options)
66
+
67
+ if options[:formatted] == true && !result.nil? && result.is_a?(Hash)
68
+ begin
69
+ business = result[:search_by_ab_nv201408_response][:abr_payload_search_results][:response][:business_entity201408]
70
+ rescue
71
+ business = {}
72
+ end
73
+
74
+ result = {
75
+ original_format: result,
76
+ name: (business[:main_name] || {})[:organisation_name],
77
+ region: (business[:main_business_physical_address] || {})[:state_code],
78
+ postal_code: (business[:main_business_physical_address] || {})[:postcode]
79
+ }
80
+ end
81
+ else
82
+ raise StandardError, 'WARNING: Valnzbn not found. Please run `gem install valabn`.'
83
+ end
84
+ when 'NZ'
85
+ if defined?(Valnzbn) == 'constant'
86
+ result = Valnzbn.new(@number).exists?(options)
87
+ if options[:formatted] == true && !result.nil? && result.is_a?(Hash)
88
+ address = result[:registeredAddress] || [{}]
89
+
90
+ result = {
91
+ original_format: result,
92
+ name: result[:entityName],
93
+ street_line_1: address.first[:address1],
94
+ street_line_2: address.first[:address2],
95
+ city: address.first[:address3],
96
+ postal_code: address.first[:postCode]
97
+ }
98
+ end
99
+ else
100
+ raise StandardError, 'WARNING: Valnzbn not found. Please run `gem install valnzbn`.'
101
+ end
102
+ end
103
+
104
+ result
105
+ end
106
+ alias_method :exist?, :exists?
107
+
108
+ def iso_country_code
109
+ case @country
110
+ when *EU_COUNTRIES
111
+ Valvat.new(@number).iso_country_code
112
+ else
113
+ @country
114
+ end
115
+ end
116
+ end
@@ -0,0 +1,3 @@
1
+ class Valbn
2
+ VERSION = "0.1.1"
3
+ end
@@ -0,0 +1,26 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'valbn/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "valbn"
8
+ spec.version = Valbn::VERSION
9
+ spec.authors = ["xxswingxx"]
10
+ spec.email = ["vidadelaempresa@gmail.com"]
11
+
12
+ spec.summary = %q{Common interface for several business number validators: Valvat, Valabn, Valnzbn}
13
+ spec.description = %q{Common interface for several business number validators: Valvat, Valabn, Valnzbn}
14
+ spec.homepage = 'https://github.com/quaderno/valbn'
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.bindir = "exe"
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_development_dependency "countries"
23
+ spec.add_development_dependency "bundler", "~> 1.11"
24
+ spec.add_development_dependency "rake", "~> 10.0"
25
+ spec.add_development_dependency "rspec", "~> 3.0"
26
+ end
metadata ADDED
@@ -0,0 +1,115 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: valbn
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.1
5
+ platform: ruby
6
+ authors:
7
+ - xxswingxx
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2018-02-14 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: countries
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.11'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.11'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.0'
69
+ description: 'Common interface for several business number validators: Valvat, Valabn,
70
+ Valnzbn'
71
+ email:
72
+ - vidadelaempresa@gmail.com
73
+ executables: []
74
+ extensions: []
75
+ extra_rdoc_files: []
76
+ files:
77
+ - ".gitignore"
78
+ - ".rspec"
79
+ - ".travis.yml"
80
+ - CODE_OF_CONDUCT.md
81
+ - Gemfile
82
+ - LICENSE.txt
83
+ - README.md
84
+ - Rakefile
85
+ - bin/console
86
+ - bin/setup
87
+ - lib/valbn.rb
88
+ - lib/valbn/version.rb
89
+ - valbn.gemspec
90
+ homepage: https://github.com/quaderno/valbn
91
+ licenses:
92
+ - MIT
93
+ metadata: {}
94
+ post_install_message:
95
+ rdoc_options: []
96
+ require_paths:
97
+ - lib
98
+ required_ruby_version: !ruby/object:Gem::Requirement
99
+ requirements:
100
+ - - ">="
101
+ - !ruby/object:Gem::Version
102
+ version: '0'
103
+ required_rubygems_version: !ruby/object:Gem::Requirement
104
+ requirements:
105
+ - - ">="
106
+ - !ruby/object:Gem::Version
107
+ version: '0'
108
+ requirements: []
109
+ rubyforge_project:
110
+ rubygems_version: 2.6.11
111
+ signing_key:
112
+ specification_version: 4
113
+ summary: 'Common interface for several business number validators: Valvat, Valabn,
114
+ Valnzbn'
115
+ test_files: []