GNU bug report logs - #50420
[PATCH 0/2] Add sendgmail.

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 50420 in the body.
You can then email your comments to 50420 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Philip McGrath <philip <at> philipmcgrath.com>
To: guix-patches <at> gnu.org
Cc: Philip McGrath <philip <at> philipmcgrath.com>
Subject: [PATCH 0/2] Add sendgmail.
Date: Mon,  6 Sep 2021 01:36:07 -0400

This patch series adds `sendgmail`, a tool for using `git send-email`
with Gmail accounts via OAuth2 authentication.

Philip McGrath (2):
  gnu: Add go-cloud-google-com-go-compute-metadata.
  gnu: Add go-github-com-google-gmail-oauth2-tools-go-sendgmail.

 gnu/packages/golang.scm | 62 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)

-- 
2.30.2

Message #8 received at 50420 <at> debbugs.gnu.org (full text, mbox):

From: Philip McGrath <philip <at> philipmcgrath.com>
To: 50420 <at> debbugs.gnu.org
Cc: Philip McGrath <philip <at> philipmcgrath.com>
Subject: [PATCH 1/2] gnu: Add go-cloud-google-com-go-compute-metadata.
Date: Mon,  6 Sep 2021 01:37:51 -0400

* gnu/packages/golang.scm (go-cloud-google-com-go-compute-metadata): New
variable.
---
 gnu/packages/golang.scm | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/gnu/packages/golang.scm b/gnu/packages/golang.scm
index b6e8b84749..7980859b26 100644
--- a/gnu/packages/golang.scm
+++ b/gnu/packages/golang.scm
@@ -2754,6 +2754,33 @@ developers to use @code{http} methods explicitly and in a way that's consistent
 with the HTTP protocol definition.")
     (license license:expat)))
 
+(define-public go-cloud-google-com-go-compute-metadata
+  (package
+    (name "go-cloud-google-com-go-compute-metadata")
+    (version "0.81.0")
+    (source
+     (origin
+       (method git-fetch)
+       (uri (git-reference
+             (url "https://github.com/googleapis/google-cloud-go")
+             (commit (string-append "v" version))))
+       (file-name (git-file-name name version))
+       (sha256
+        (base32
+         "15jgynqb5pbxqbj3a7ii970yn4srsw1dbxzxnhpkfkmplalpgyh3"))))
+    (build-system go-build-system)
+    (arguments
+     '(#:unpack-path "cloud.google.com/go"
+       #:import-path "cloud.google.com/go/compute/metadata"))
+    (home-page
+     "https://pkg.go.dev/cloud.google.com/go/compute/metadata")
+    (synopsis
+     "Go wrapper for Google Compute Engine metadata service")
+    (description
+     "This package provides access to Google Compute Engine (GCE) metadata and
+API service accounts for Go.")
+    (license license:asl2.0)))
+
 (define-public go-github-com-google-cadvisor
   (let ((commit "2ed7198f77395ee9a172878a0a7ab92ab59a2cfd")
         (revision "0"))
-- 
2.30.2

Message #11 received at 50420 <at> debbugs.gnu.org (full text, mbox):

From: Philip McGrath <philip <at> philipmcgrath.com>
To: 50420 <at> debbugs.gnu.org
Cc: Philip McGrath <philip <at> philipmcgrath.com>
Subject: [PATCH 2/2] gnu: Add
 go-github-com-google-gmail-oauth2-tools-go-sendgmail.
Date: Mon,  6 Sep 2021 01:37:52 -0400

* gnu/packages/golang.scm
(go-github-com-google-gmail-oauth2-tools-go-sendgmail): New variable.
---
 gnu/packages/golang.scm | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/gnu/packages/golang.scm b/gnu/packages/golang.scm
index 7980859b26..214365c73b 100644
--- a/gnu/packages/golang.scm
+++ b/gnu/packages/golang.scm
@@ -2781,6 +2781,41 @@ with the HTTP protocol definition.")
 API service accounts for Go.")
     (license license:asl2.0)))
 
+(define-public go-github-com-google-gmail-oauth2-tools-go-sendgmail
+  (let ((commit "e3229155a4037267ce40f1a3a681f53221aa4d8d")
+        (revision "0"))
+    (package
+      (name "go-github-com-google-gmail-oauth2-tools-go-sendgmail")
+      (version (git-version "0.0.0" revision commit))
+      (source
+       (origin
+         (method git-fetch)
+         (uri (git-reference
+               (url "https://github.com/google/gmail-oauth2-tools")
+               (commit commit)))
+         (file-name (git-file-name name version))
+         (sha256
+          (base32
+           "1cxpkiaajhq1gjsg47r2b5xgck0r63pvkyrkm7af8c8dw7fyn64f"))))
+      (propagated-inputs
+       `(("go-golang-org-x-oauth2" ,go-golang-org-x-oauth2)
+         ("go-cloud-google-com-go-compute-metadata"
+          ,go-cloud-google-com-go-compute-metadata)))
+      (build-system go-build-system)
+      (arguments
+       '(#:unpack-path "github.com/google/gmail-oauth2-tools"
+         #:import-path "github.com/google/gmail-oauth2-tools/go/sendgmail"))
+      (home-page
+       "https://github.com/google/gmail-oauth2-tools/tree/master/go/sendgmail")
+      (synopsis
+       "Sendmail-compatible tool for using Gmail with @code{git send-email}")
+      (description
+       "The @command{sendgmail} command provides a minimal sendmail-compatible
+front-end that connects to Gmail using OAuth2.  It is specifically designed
+for use with @code{git send-email}.  The command needs a Gmail API key to
+function.")
+      (license license:asl2.0))))
+
 (define-public go-github-com-google-cadvisor
   (let ((commit "2ed7198f77395ee9a172878a0a7ab92ab59a2cfd")
         (revision "0"))
-- 
2.30.2

Message #16 received at 50420-done <at> debbugs.gnu.org (full text, mbox):

From: Ludovic Courtès <ludo <at> gnu.org>
To: Philip McGrath <philip <at> philipmcgrath.com>
Cc: 50420-done <at> debbugs.gnu.org
Subject: Re: bug#50420: [PATCH 0/2] Add sendgmail.
Date: Tue, 14 Sep 2021 11:32:08 +0200

Hi,

Philip McGrath <philip <at> philipmcgrath.com> skribis:

>   gnu: Add go-cloud-google-com-go-compute-metadata.
>   gnu: Add go-github-com-google-gmail-oauth2-tools-go-sendgmail.

Applied, thanks!

Perhaps the 2nd package could be called just “sendgmail” since it
provides a CLI?

Thanks,
Ludo’.

Message #19 received at 50420-done <at> debbugs.gnu.org (full text, mbox):

From: Philip McGrath <philip <at> philipmcgrath.com>
To: Ludovic Courtès <ludo <at> gnu.org>
Cc: 50420-done <at> debbugs.gnu.org
Subject: Re: bug#50420: [PATCH 0/2] Add sendgmail.
Date: Thu, 23 Sep 2021 05:59:44 -0400

On 9/14/21 5:32 AM, Ludovic Courtès wrote:
> Hi,
> 
> Philip McGrath <philip <at> philipmcgrath.com> skribis:
> 
>>    gnu: Add go-cloud-google-com-go-compute-metadata.
>>    gnu: Add go-github-com-google-gmail-oauth2-tools-go-sendgmail.
> 
> Applied, thanks!
> 
> Perhaps the 2nd package could be called just “sendgmail” since it
> provides a CLI?

That would make sense to me: I'm not sure what the general rule is for 
breaking out of the language-specific naming conventions, and I'm not a 
Go programmer, but 
“go-github-com-google-gmail-oauth2-tools-go-sendgmail” seemed especially 
egregiously long.

The sengmail utility is recommended in 
<https://git-send-email.io/#step-2> (by the SourceHut developers). There 
are some things I don't like about it, but it seems better than other 
approaches I've tried, like configuring an MTA with (even more) ambient 
authority.

It might also be nice (or it might not) to apply one of the three pull 
requests since 2019 to support non-"@gmail.com" addresses (e.g. for work 
or school, from what has variously been known as Google Workspace, G 
Suite, or Google Apps for Your Domain). Indeed, the upstream repository 
has not been updated at all since 2019 ... I used 
<https://github.com/google/gmail-oauth2-tools/pull/37> via a package 
transformation to submit this patch series, whereupon I discovered I 
wasn't the first person to have this idea.

-Philip

Message #22 received at 50420-done <at> debbugs.gnu.org (full text, mbox):

From: Leo Famulari <leo <at> famulari.name>
To: Philip McGrath <philip <at> philipmcgrath.com>
Cc: Ludovic Courtès <ludo <at> gnu.org>,
 50420-done <at> debbugs.gnu.org
Subject: Re: [bug#50420] [PATCH 0/2] Add sendgmail.
Date: Thu, 23 Sep 2021 14:42:46 -0400

On Thu, Sep 23, 2021 at 05:59:44AM -0400, Philip McGrath wrote:
> That would make sense to me: I'm not sure what the general rule is for
> breaking out of the language-specific naming conventions, and I'm not a Go
> programmer, but “go-github-com-google-gmail-oauth2-tools-go-sendgmail”
> seemed especially egregiously long.

In general, end-user applications (like a CLI program) can use a simple
name like 'sendgmail', which is what users expect.

Libraries, on the other hand, should use the long name. For Go, this
should match the "import path" of the program, with slashes changed to
hyphens, plus a "go-" prefix.

Internally to Go software, the "import path" is the true name of the
program:

https://golang.org/doc/gopath_code#ImportPaths

For example, there could be multiple Go libraries named 'sendgmail', but
Go software distinguishes them by including their network location in
the name.

We could invent another naming system, but Go naming is already so
complicated that I think it's worth trying to match the internal "import
path" names.

Message #25 received at 50420 <at> debbugs.gnu.org (full text, mbox):

From: Sarah Morgensen <iskarian <at> mgsn.dev>
To: Leo Famulari <leo <at> famulari.name>
Cc: Ludovic Courtès <ludo <at> gnu.org>, 50420 <at> debbugs.gnu.org,
 Philip McGrath <philip <at> philipmcgrath.com>
Subject: Re: [bug#50420] [PATCH 0/2] Add sendgmail.
Date: Thu, 23 Sep 2021 12:40:24 -0700

Hi all,

Leo Famulari <leo <at> famulari.name> writes:

> On Thu, Sep 23, 2021 at 05:59:44AM -0400, Philip McGrath wrote:
>> That would make sense to me: I'm not sure what the general rule is for
>> breaking out of the language-specific naming conventions, and I'm not a Go
>> programmer, but “go-github-com-google-gmail-oauth2-tools-go-sendgmail”
>> seemed especially egregiously long.
>
> In general, end-user applications (like a CLI program) can use a simple
> name like 'sendgmail', which is what users expect.
>
> Libraries, on the other hand, should use the long name. For Go, this
> should match the "import path" of the program, with slashes changed to
> hyphens, plus a "go-" prefix.
>
> Internally to Go software, the "import path" is the true name of the
> program:
>
> https://golang.org/doc/gopath_code#ImportPaths
>
> For example, there could be multiple Go libraries named 'sendgmail', but
> Go software distinguishes them by including their network location in
> the name.
>
> We could invent another naming system, but Go naming is already so
> complicated that I think it's worth trying to match the internal "import
> path" names.

For what it's worth, I concur, especially since the importer won't see a
package with an "incorrect" name, so we may end up with duplicates.

In the rare case that a module contains both a library and commands, the
command package can inherit from the library package, and set
`#:install-source? #f' (and #:import-path, if necessary).

--
Sarah

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.