📒 YellowPages

Look up merchants from their Stripe MID

Installation

Add this line to your application's Gemfile:

gem 'yellow_pages', git: 'https://github.com/hackclub/yellow_pages'

It is recommended to pin the version to a commit hash to ensure stability.

Usage

require 'yellow_pages'

merchant = YellowPages::Merchant.lookup(network_id: '1234567890')
#=> #<YellowPages::Merchant:0x0000000105dd49c8 @network_id="1234567890">
merchant.name
#=> "Rocket Rides"

For the latest docs (main branch), please see https://yellowpages.bank.engineering/

Configurations

At the moment, this gems only supports one configuration:

YellowPages.missing_merchant_reporter = ->(network_id) do
  puts "Merchant with network_id #{network_id} not found"
  ErrorReporter.notify("Merchant with network_id #{network_id} not found")
end

Key	Description	Default
missing_merchant_reporter	An optional method that is called when a merchant is not found in the dataset during a lookup. Takes in one argument, the network_id of the missing merchant.	nil

Development

After checking out the repo, run bin/setup to install dependencies. 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.

We're using YARD for documentation generation. To build, run yard. To run the developement server, run yard server -r

Contributing

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

License

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