Skip to content

causztic/is_uen

Repository files navigation

IsUen

Gem Version

Simple gem to check whether a UEN has a valid format and date.

Format is obtained from https://www.uen.gov.sg/ueninternet/faces/pages/admin/aboutUEN.jspx, last updated/reviewed on 08 Jan 2018.

Installation

Add this line to your application's Gemfile:

gem 'is_uen'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install is_uen

Usage

IsUen.uen?('12345678A') # business? || company? || new_uen?
IsUen.business?('12345678A')
IsUen.company?('123456789A')
IsUen.new_uen?('T12GB1234X')

The library also provides convenience functions to check for a specific entity type (obtain the full list here).

IsUen.ll?('T12LL1234X') # returns true
IsUen.lp?('T12AA1234X') # returns false

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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 the created tag, and push the .gem file to rubygems.org.

Caveats

This gem does not verify the existence of UENs.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/causztic/is_uen.

License

The gem is available as open source under the terms of the MIT License.

About

Simple gem to check whether a UEN has a valid format and date

Resources

License

Stars

Watchers

Forks

Packages

No packages published