valbn 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a9a620d978952f93077f241878af566e990c367
+  data.tar.gz: 79e2c32daf08ff40f76ffa109b862574bb444808
+SHA512:
+  metadata.gz: ccec2d937399f96dcddcd4d38a836d0914d824f101fb725fe2854c6758f0903197904b72f0fb801d453e4dda1f847ac6a37a4194bff7fa450e29e2141620fc27
+  data.tar.gz: 3ad122a4f8f3d5a162039327e94ceabac6786d491eb67997e2878c79b59eb227626b73af010d666aaa473f89279614c43db8472e82d1f77cc7cce76907fbf4d2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.1
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at vidadelaempresa@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in valbn.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 xxswingxx
+
+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.md

@@ -0,0 +1,109 @@
+# Valbn
+
+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:
+
+```ruby
+  require 'valvat'
+  require 'valabn'
+  require 'valnzbn'
+
+  if country.in? EUROPEAN_COUNTRIES
+    Valvat.new(number).exists?
+  elsif country == 'AU'
+    Valabn.new(number).exists?
+  elsif country == 'NZ'
+    Valnzbn.new(number).exists?
+  end
+```
+
+you can do this:
+
+```ruby
+  Valbn.new(number, country).exists?
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'valbn'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install valbn
+
+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`).
+
+## Usage
+
+First you need to initialize the gem to check to which services you want to validate.
+
+```ruby
+require 'valbn'
+
+Valbn.configure do |config|
+  config.vatmoss = true # Via valvat
+  config.abn = true # Via valabn
+  config.nzbn = true # Via valnzbn
+
+  Valabn::Lookup.configure do |config|
+    config.guid = ABN_GUID
+  end
+
+  Valnzbn::Lookup.configure do |config|
+    config.access_token = NZBN_ACCESS_TOKEN
+  end
+end
+```
+
+After that you can use:
+
+```ruby
+number = '9429033558257'
+country = 'NZ'
+
+business_number = Valbn.new(number, country)
+
+business_number.exists? # => True, false or nil
+business_number.exists?(detail: true) # => Hash or nil
+business_number.exists?(formatted: true) # => Hash or nil
+```
+
+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:
+
+```ruby
+{
+  original_format: {…}, # The original response as returned with "detail: true"
+  name: 'Company name',
+  street_line_1: 'Street line 1',
+  street_line_2: 'Street line 2',
+  region: 'Region',
+  city: 'City',
+  postal_code: 'postal-code'
+}
+```
+
+Please note that not all the fields can be filled as they depends on the values returned by each API.
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "valbn"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/valbn.rb

@@ -0,0 +1,116 @@
+require "valbn/version"
+require 'countries'
+
+class Valbn
+
+  EU_COUNTRIES = ISO3166::Country.find_all_countries_by_in_eu?(true).map(&:alpha2)
+
+  def self.vatmoss=(value)
+    @@vatmoss = value # Valvat
+    value ? require('valvat') : false
+  rescue
+    raise StandardError, 'WARNING: Valvat not found. Please run `gem install valvat`.'
+  end
+
+  def self.abn=(value)
+    @@abn = value # Valabn
+    value ? require('valabn') : false
+  rescue
+    raise StandardError, 'WARNING: Valnzbn not found. Please run `gem install valabn`.'
+  end
+
+  def self.nzbn=(value)
+    @@abn = value # Valnzbn
+    value ? require('valnzbn') : false
+  rescue
+    raise StandardError, 'WARNING: Valnzbn not found. Please run `gem install valnzbn`.'
+  end
+
+  def self.configure
+    yield self
+  end
+
+  def initialize(number, country)
+    @country = country
+    number = number.to_s.gsub(/\W/, '').upcase
+
+    if EU_COUNTRIES.include?(country)
+      vat_country = Valvat::Utils.iso_country_to_vat_country(country)
+      number = "#{vat_country}#{number}" unless !!(number =~ /^#{vat_country}[A-Z0-9]+/) # add the country code if it does not exist
+    end
+
+    @number = number
+  end
+
+  def exists?(options = {})
+    options[:detail] = options[:formatted]
+
+    case @country
+    when *EU_COUNTRIES
+      if defined?(Valvat) == 'constant'
+        result = Valvat.new(@number).exists?(options)
+
+        if options[:formatted] == true && !result.nil? && result.is_a?(Hash)
+          result = {
+            original_format: result,
+            name: result[:name],
+            street_line_1: result[:address]
+          }
+        end
+      else
+        raise StandardError, 'WARNING: Valvat not found. Please run `gem install valvat`.'
+      end
+    when 'AU'
+      if defined?(Valvat) == 'constant'
+        result = Valabn.new(@number).exists?(options)
+
+        if options[:formatted] == true && !result.nil? && result.is_a?(Hash)
+          begin
+            business = result[:search_by_ab_nv201408_response][:abr_payload_search_results][:response][:business_entity201408]
+          rescue
+            business = {}
+          end
+
+          result = {
+            original_format: result,
+            name: (business[:main_name] || {})[:organisation_name],
+            region: (business[:main_business_physical_address] || {})[:state_code],
+            postal_code: (business[:main_business_physical_address] || {})[:postcode]
+          }
+        end
+      else
+        raise StandardError, 'WARNING: Valnzbn not found. Please run `gem install valabn`.'
+      end
+    when 'NZ'
+      if defined?(Valnzbn) == 'constant'
+        result = Valnzbn.new(@number).exists?(options)
+        if options[:formatted] == true && !result.nil? && result.is_a?(Hash)
+          address = result[:registeredAddress] || [{}]
+
+          result = {
+            original_format: result,
+            name: result[:entityName],
+            street_line_1: address.first[:address1],
+            street_line_2: address.first[:address2],
+            city: address.first[:address3],
+            postal_code: address.first[:postCode]
+          }
+        end
+      else
+        raise StandardError, 'WARNING: Valnzbn not found. Please run `gem install valnzbn`.'
+      end
+    end
+
+    result
+  end
+  alias_method :exist?, :exists?
+
+  def iso_country_code
+    case @country
+    when *EU_COUNTRIES
+      Valvat.new(@number).iso_country_code
+    else
+      @country
+    end
+  end
+end

data/lib/valbn/version.rb

@@ -0,0 +1,3 @@
+class Valbn
+  VERSION = "0.1.1"
+end

data/valbn.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'valbn/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "valbn"
+  spec.version       = Valbn::VERSION
+  spec.authors       = ["xxswingxx"]
+  spec.email         = ["vidadelaempresa@gmail.com"]
+
+  spec.summary       = %q{Common interface for several business number validators: Valvat, Valabn, Valnzbn}
+  spec.description   = %q{Common interface for several business number validators: Valvat, Valabn, Valnzbn}
+  spec.homepage      = 'https://github.com/quaderno/valbn'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "countries"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: valbn
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- xxswingxx
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: countries
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'Common interface for several business number validators: Valvat, Valabn,
+  Valnzbn'
+email:
+- vidadelaempresa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/valbn.rb
+- lib/valbn/version.rb
+- valbn.gemspec
+homepage: https://github.com/quaderno/valbn
+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.6.11
+signing_key: 
+specification_version: 4
+summary: 'Common interface for several business number validators: Valvat, Valabn,
+  Valnzbn'
+test_files: []