(WIP) Sepomex::Client its a ruby gem built with flexirest and rest-client to consume a Rails API containing all Mexico Zipcodes
Add this line to your application's Gemfile:
gem 'sepomex-client'
And then execute:
$ bundle
Or install it yourself as:
$ gem install sepomex-client
You can run queries as:
# Gets all Zipcodes
Sepomex::Client::Zipcode.all
# Gets a Zipcode based on a neighborhood name
Sepomex::Client::Zipcode.find_by_neighborhood('Lomas Verdes')
TODO: Add More Examples
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 tags, and push the .gem
file to rubygems.org.
Bug reports and pull requests are welcome on Gitlab at https://gitlab.com/aromaron/sepomex-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the Sepomex::Client project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.