Welcome to AddressSearcher! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/address_searcher. To experiment with that code, run bin/console for an interactive prompt.
Install the gem and add to the application's Gemfile by executing:
$ bundle add address_searcher
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install address_searcher
When you want to search address by zipcode, you get address info by using AddressSearcher as follows.
AddressSearcher.search_address("1000001")
In addition, when you also want to get full_address, you can use full_address option as follows.
AddressSearcher.search_address("1000001", full_address: true)
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 the created tag, and push the .gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/essei0-0/address_searcher. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the AddressSearcher project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.