naming Convention for API modules

srchulo has asked for the wisdom of the Perl Monks concerning the following question:

Hi Monks,

I'm creating a perl module that is essentially just a wrapper for an HTTPS API. I've seen several different naming styles for perl modules that interface with APIs, such as WebService::Rackspace::CloudFiles, Net::Stripe, or just PX::API (and I'm sure there are many more). My question is, is there a best way to name API wrapper modules that's most appropriate? Or more fitting based on what kind of API it is? Or is it just purely preference? Thanks! Just wanting to make sure I do the perl convention if there is one before I put this up on CPAN :)

Comment on naming Convention for API modules

Replies are listed 'Best First'.
Re: naming Convention for API modules by tobyink (Canon) on Jul 13, 2013 at 21:52 UTC
There isn't really an established convention. I'd say focus first on what your module does, rather than how it does it. If it allows you to find the nearest Pizza Hut to a given latitude, longitude pair, end users probably don't much care about whether it's using a web service to do it, whether it just bundles a SQLite database with the co-ordinates of every Pizza Hut branch in the world, or whether it uses Jedi mind tricks. Call it Pizza::Hut::Finder, not WebService::JSON::PizzaHutDotCom. `package Cow { use Moo; has name => (is => 'lazy', default => sub { 'Mooington' }) } say Cow->new->name`	[reply]
Re: naming Convention for API modules by kcott (Archbishop) on Jul 14, 2013 at 09:14 UTC
G'day srchulo, Here's some links you may find useful: PAUSE (The [Perl programming] Authors Upload Server) has information related to this. The most directly relevant is probably: On The Naming of Modules. perlmodlib - Modules: Creation, Use, and Abuse has, under Guidelines for Module Creation, a "Select a name for the module" section. perlmodstyle - BEFORE YOU START WRITING A MODULE: What's in a name? perlnewmod - Step-by-step: Preparing the ground has a "Choose a name" entry. Beyond the specific `perlmod` manpage sections I've linked to, you may find useful information in other parts of those documents. -- Ken	[reply] [d/l]