[PATCH 0/2] cloudflare-cli and dependency JSON.sh

Done

Details

5 participants

Sarah Morgensen
Ludovic Courtès
Maxim Cournoyer
Stephen Paul Weber
zimoun

Owner: unassigned

Submitted by: Stephen Paul Weber

Severity: normal

Stephen Paul Weber wrote on 25 Sep 2021 03:38

Recipients:(address . guix-patches@gnu.org)

Message-ID:20210925013848.GA2384@singpolyma-beefy.lan

This series submits two new packages: cloudflare-cli and its dependency JSON.sh

Stephen Paul Weber wrote on 25 Sep 2021 03:39

[PATCH 2/2] gnu: Add cloudflare-cli

Recipients:(address . 50793@debbugs.gnu.org)(name . Stephen Paul Weber)(address . singpolyma@singpolyma.net)

Message-ID:20210925013934.2763-2-singpolyma@singpolyma.net

* gnu/packages/dns.scm (cloudflare-cli): New variable.

---

gnu/packages/dns.scm | 52 ++++++++++++++++++++++++++++++++++++++++++++

1 file changed, 52 insertions(+)

Toggle diff (84 lines)diff --git a/gnu/packages/dns.scm b/gnu/packages/dns.scm
index 45e250138e..9e68d76a93 100644
--- a/gnu/packages/dns.scm
+++ b/gnu/packages/dns.scm
@@ -42,6 +42,7 @@
   #:use-module (gnu packages bash)
   #:use-module (gnu packages certs)
   #:use-module (gnu packages check)
+  #:use-module (gnu packages curl)
   #:use-module (gnu packages databases)
   #:use-module (gnu packages documentation)
   #:use-module (gnu packages compression)
@@ -69,6 +70,7 @@
   #:use-module (gnu packages python)
   #:use-module (gnu packages python-xyz)
   #:use-module (gnu packages ragel)
+  #:use-module (gnu packages serialization)
   #:use-module (gnu packages shells)
   #:use-module (gnu packages sphinx)
   #:use-module (gnu packages swig)
@@ -82,11 +84,61 @@
   #:use-module (guix download)
   #:use-module (guix git-download)
   #:use-module (guix utils)
+  #:use-module (guix build-system copy)
   #:use-module (guix build-system glib-or-gtk)
   #:use-module (guix build-system gnu)
   #:use-module (guix build-system meson)
   #:use-module (guix build-system trivial))
 
+(define-public cloudflare-cli
+  (package
+    (name "cloudflare-cli")
+    (version "2d986d3")
+    (source
+     (origin
+       (method git-fetch)
+       (uri (git-reference
+             (url "https://github.com/earlchew/cloudflare-cli")
+             (commit version)))
+       (file-name (git-file-name name version))
+       (sha256
+        (base32
+         "0f86g6n86kwykl3jnhqjrdfy8ybkp03ghr3dlr70q2552qw4axw2"))))
+    (build-system copy-build-system)
+    (arguments
+     `(#:install-plan '(("cloudflare-cli" "bin/") ("cloudflare-cli.sh" "bin/"))
+       #:phases
+       (modify-phases %standard-phases
+         (add-after 'unpack 'find-jsonsh
+           (lambda* (#:key inputs #:allow-other-keys)
+             (substitute* "cloudflare-cli.sh"
+               (("\\$\\{0%/\\*\\}/jsonsh")
+                (string-append (assoc-ref inputs "JSON.sh") "/bin/JSON.sh")))
+             #t))
+         (add-after 'install 'wrap-program
+           (lambda* (#:key inputs outputs #:allow-other-keys)
+             (wrap-program (string-append (assoc-ref outputs "out") "/bin/cloudflare-cli")
+               `("PATH" ":" prefix
+                 (,(string-join
+                    (map (lambda (in) (string-append (assoc-ref inputs in) "/bin"))
+                         '("grep" "curl" "coreutils"))
+                    ":")))))))))
+    (inputs
+     `(("bash-minimal" ,bash-minimal)
+       ("coreutils" ,coreutils)
+       ("curl" ,curl)
+       ("grep" ,grep)
+       ("JSON.sh" ,JSON.sh)))
+    (synopsis
+      "CLI to edit Cloudflare DNS records")
+    (description
+      "This command line tool to update Cloudfare DNS records is useful in the
+following scenarios:
+* Keeping dynamic DNS records up to date
+* Updating DNS records as part of the ACME DNS-01 protocol")
+    (home-page "https://github.com/earlchew/cloudflare-cli")
+    (license license:expat)))
+
 (define-public ldns
   (package
     (name "ldns")
-- 
2.20.1

Stephen Paul Weber wrote on 25 Sep 2021 03:39

[PATCH 1/2] gnu: Add JSON.sh

Recipients:(address . 50793@debbugs.gnu.org)(name . Stephen Paul Weber)(address . singpolyma@singpolyma.net)

Message-ID:20210925013934.2763-1-singpolyma@singpolyma.net

* gnu/packages/serialization.scm (JSON.sh): New variable.

---

gnu/packages/serialization.scm | 45 ++++++++++++++++++++++++++++++++++

1 file changed, 45 insertions(+)

Toggle diff (69 lines)diff --git a/gnu/packages/serialization.scm b/gnu/packages/serialization.scm
index 196141ace8..f5677d9e5f 100644
--- a/gnu/packages/serialization.scm
+++ b/gnu/packages/serialization.scm
@@ -34,10 +34,13 @@
   #:use-module (guix git-download)
   #:use-module (guix utils)
   #:use-module (guix build-system cmake)
+  #:use-module (guix build-system copy)
   #:use-module (guix build-system gnu)
   #:use-module (guix build-system python)
   #:use-module (gnu packages)
   #:use-module (gnu packages autotools)
+  #:use-module (gnu packages base)
+  #:use-module (gnu packages bash)
   #:use-module (gnu packages boost)
   #:use-module (gnu packages check)
   #:use-module (gnu packages compression)
@@ -458,6 +461,48 @@ it a convenient format to store user input files.")
                (base32
                 "1180ln8blrb0mwzpcf78k49hlki6di65q77rsvglf83kfcyh4d7z"))))))
 
+(define-public JSON.sh
+  (package
+    (name "JSON.sh")
+    (version "0d5e5c7")
+    (source
+     (origin
+       (method git-fetch)
+       (uri (git-reference
+             (url "https://github.com/dominictarr/JSON.sh")
+             (commit version)))
+       (file-name (git-file-name name version))
+       (sha256
+        (base32
+         "14lxvp5xbdk0dcwkjbdp098z1108j8z48zaibndh4i731kkcz43i"))))
+    (build-system copy-build-system)
+    (arguments
+     `(#:install-plan '(("JSON.sh" "bin/"))
+       #:phases
+       (modify-phases %standard-phases
+         (add-before 'install 'check
+           (lambda _
+             (invoke "./all-tests.sh")
+             #t))
+         (add-after 'install 'wrap-program
+           (lambda* (#:key inputs outputs #:allow-other-keys)
+             (wrap-program (string-append (assoc-ref outputs "out") "/bin/JSON.sh")
+               `("PATH" ":" prefix
+                 (,(string-join
+                    (map (lambda (in) (string-append (assoc-ref inputs in) "/bin"))
+                         '("grep" "coreutils"))
+                    ":")))))))))
+    (inputs
+     `(("bash-minimal" ,bash-minimal)
+       ("grep" ,grep)
+       ("coreutils" ,coreutils)))
+    (synopsis
+      "Pipeable JSON parser written in shell")
+    (description
+      "JSON parser written in shell, compatible with ash, bash, dash and zsh")
+    (home-page "https://github.com/dominictarr/JSON.sh")
+    (license license:asl2.0)))
+
 (define-public capnproto
   (package
     (name "capnproto")
-- 
2.20.1

Sarah Morgensen wrote on 25 Sep 2021 04:58

Recipients:(name . Stephen Paul Weber)(address . singpolyma@singpolyma.net)(address . 50793@debbugs.gnu.org)

Message-ID:86k0j5wecb.fsf@mgsn.dev

Hi,

Thanks for the patches! Just a couple quick comments:

Stephen Paul Weber <singpolyma@singpolyma.net> writes:

Toggle quote (31 lines)> * gnu/packages/serialization.scm (JSON.sh): New variable.
> ---
>  gnu/packages/serialization.scm | 45 ++++++++++++++++++++++++++++++++++
>  1 file changed, 45 insertions(+)
>
> diff --git a/gnu/packages/serialization.scm b/gnu/packages/serialization.scm
> index 196141ace8..f5677d9e5f 100644
> --- a/gnu/packages/serialization.scm
> +++ b/gnu/packages/serialization.scm
> @@ -34,10 +34,13 @@
>    #:use-module (guix git-download)
>    #:use-module (guix utils)
>    #:use-module (guix build-system cmake)
> +  #:use-module (guix build-system copy)
>    #:use-module (guix build-system gnu)
>    #:use-module (guix build-system python)
>    #:use-module (gnu packages)
>    #:use-module (gnu packages autotools)
> +  #:use-module (gnu packages base)
> +  #:use-module (gnu packages bash)
>    #:use-module (gnu packages boost)
>    #:use-module (gnu packages check)
>    #:use-module (gnu packages compression)
> @@ -458,6 +461,48 @@ it a convenient format to store user input files.")
>                 (base32
>                  "1180ln8blrb0mwzpcf78k49hlki6di65q77rsvglf83kfcyh4d7z"))))))
>  
> +(define-public JSON.sh
> +  (package
> +    (name "JSON.sh")

I can't find a rule for this per se, but it's convention that package

names to be lowercase (and for the variable name to match).

Toggle quote (2 lines)

> + (version "0d5e5c7")

Since this isn't a tagged version, this should follow the 'git-version'

pattern (search for usages of 'git-version' for examples).

Toggle quote (20 lines)> +    (source
> +     (origin
> +       (method git-fetch)
> +       (uri (git-reference
> +             (url "https://github.com/dominictarr/JSON.sh")
> +             (commit version)))
> +       (file-name (git-file-name name version))
> +       (sha256
> +        (base32
> +         "14lxvp5xbdk0dcwkjbdp098z1108j8z48zaibndh4i731kkcz43i"))))
> +    (build-system copy-build-system)
> +    (arguments
> +     `(#:install-plan '(("JSON.sh" "bin/"))
> +       #:phases
> +       (modify-phases %standard-phases
> +         (add-before 'install 'check
> +           (lambda _
> +             (invoke "./all-tests.sh")
> +             #t))

Check phases should respect #:tests?, like so:

(lambda* (#:key tests? #:allow-other-keys)

(when tests?

[...]))

Also, it doesn't hurt, but phases no longer have to end in #t. :)

Toggle quote (8 lines)

> + (add-after 'install 'wrap-program

> + (lambda* (#:key inputs outputs #:allow-other-keys)

> + (wrap-program (string-append (assoc-ref outputs "out") "/bin/JSON.sh")

> + `("PATH" ":" prefix

> + (,(string-join

> + (map (lambda (in) (string-append (assoc-ref inputs in) "/bin"))

> + '("grep" "coreutils"))

Does this script actually use coreutils? On the other hand, it looks

like it does use gawk and sed.

Toggle quote (10 lines)> +                    ":")))))))))
> +    (inputs
> +     `(("bash-minimal" ,bash-minimal)
> +       ("grep" ,grep)
> +       ("coreutils" ,coreutils)))
> +    (synopsis
> +      "Pipeable JSON parser written in shell")
> +    (description
> +      "JSON parser written in shell, compatible with ash, bash, dash and zsh")

This is a bit nit-picky since it's just a dependency, but descriptions

should use full sentences, and be a bit more descriptive than this (see

"Synopses and Descriptions" in the Guix manual).

Toggle quote (3 lines)

> + (home-page "https://github.com/dominictarr/JSON.sh")

> + (license license:asl2.0)))

This is actually dual-licensed with expat, so:

(license (list license:expat license:asl2.0))

Could you please send an updated patch?

Sarah

Sarah Morgensen wrote on 25 Sep 2021 04:58

Re: [bug#50793] [PATCH 2/2] gnu: Add cloudflare-cli

Recipients:(name . Stephen Paul Weber)(address . singpolyma@singpolyma.net)(address . 50793@debbugs.gnu.org)

Message-ID:86ilypwec1.fsf@mgsn.dev

Hi,

I've (naturally) got a few suggestions for this one, too.

Stephen Paul Weber <singpolyma@singpolyma.net> writes:

Toggle quote (40 lines)> * gnu/packages/dns.scm (cloudflare-cli): New variable.
> ---
>  gnu/packages/dns.scm | 52 ++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 52 insertions(+)
>
> diff --git a/gnu/packages/dns.scm b/gnu/packages/dns.scm
> index 45e250138e..9e68d76a93 100644
> --- a/gnu/packages/dns.scm
> +++ b/gnu/packages/dns.scm
> @@ -42,6 +42,7 @@
>    #:use-module (gnu packages bash)
>    #:use-module (gnu packages certs)
>    #:use-module (gnu packages check)
> +  #:use-module (gnu packages curl)
>    #:use-module (gnu packages databases)
>    #:use-module (gnu packages documentation)
>    #:use-module (gnu packages compression)
> @@ -69,6 +70,7 @@
>    #:use-module (gnu packages python)
>    #:use-module (gnu packages python-xyz)
>    #:use-module (gnu packages ragel)
> +  #:use-module (gnu packages serialization)
>    #:use-module (gnu packages shells)
>    #:use-module (gnu packages sphinx)
>    #:use-module (gnu packages swig)
> @@ -82,11 +84,61 @@
>    #:use-module (guix download)
>    #:use-module (guix git-download)
>    #:use-module (guix utils)
> +  #:use-module (guix build-system copy)
>    #:use-module (guix build-system glib-or-gtk)
>    #:use-module (guix build-system gnu)
>    #:use-module (guix build-system meson)
>    #:use-module (guix build-system trivial))
>  
> +(define-public cloudflare-cli
> +  (package
> +    (name "cloudflare-cli")
> +    (version "2d986d3")

Please use the 'git-version' pattern as I mentioned in the other patch.

Toggle quote (29 lines)> +    (source
> +     (origin
> +       (method git-fetch)
> +       (uri (git-reference
> +             (url "https://github.com/earlchew/cloudflare-cli")
> +             (commit version)))
> +       (file-name (git-file-name name version))
> +       (sha256
> +        (base32
> +         "0f86g6n86kwykl3jnhqjrdfy8ybkp03ghr3dlr70q2552qw4axw2"))))
> +    (build-system copy-build-system)
> +    (arguments
> +     `(#:install-plan '(("cloudflare-cli" "bin/") ("cloudflare-cli.sh" "bin/"))
> +       #:phases
> +       (modify-phases %standard-phases
> +         (add-after 'unpack 'find-jsonsh
> +           (lambda* (#:key inputs #:allow-other-keys)
> +             (substitute* "cloudflare-cli.sh"
> +               (("\\$\\{0%/\\*\\}/jsonsh")
> +                (string-append (assoc-ref inputs "JSON.sh") "/bin/JSON.sh")))
> +             #t))
> +         (add-after 'install 'wrap-program
> +           (lambda* (#:key inputs outputs #:allow-other-keys)
> +             (wrap-program (string-append (assoc-ref outputs "out") "/bin/cloudflare-cli")
> +               `("PATH" ":" prefix
> +                 (,(string-join
> +                    (map (lambda (in) (string-append (assoc-ref inputs in) "/bin"))
> +                         '("grep" "curl" "coreutils"))

I don't think this uses anything from coreutils either, but I just took

a quick look.

Toggle quote (15 lines)> +                    ":")))))))))
> +    (inputs
> +     `(("bash-minimal" ,bash-minimal)
> +       ("coreutils" ,coreutils)
> +       ("curl" ,curl)
> +       ("grep" ,grep)
> +       ("JSON.sh" ,JSON.sh)))
> +    (synopsis
> +      "CLI to edit Cloudflare DNS records")
> +    (description
> +      "This command line tool to update Cloudfare DNS records is useful in the
> +following scenarios:
> +* Keeping dynamic DNS records up to date
> +* Updating DNS records as part of the ACME DNS-01 protocol")

Could you update this description to use sentences rather than bullets

(and, preferably, use active rather than passive verbiage)?

(If you do ever need to write a list in the description, you can use

@itemize (info "(texinfo) Lists and Tables"); see other packages for

examples.)

Toggle quote (7 lines)

> + (home-page "https://github.com/earlchew/cloudflare-cli")

> + (license license:expat)))

> +

> (define-public ldns

> (package

> (name "ldns")

Thank you!

Sarah

Stephen Paul Weber wrote on 26 Sep 2021 03:08

Re: [bug#50793] [PATCH 1/2] gnu: Add JSON.sh

Recipients:(name . Sarah Morgensen)(address . iskarian@mgsn.dev)(address . 50793@debbugs.gnu.org)

Message-ID:20210926010827.GA16766@singpolyma-beefy.lan

Toggle quote (7 lines)

>> +(define-public JSON.sh

>> + (package

>> + (name "JSON.sh")

>I can't find a rule for this per se, but it's convention that package

>names to be lowercase (and for the variable name to match).

Ok. Should I keep the . for "json.sh" or go with "jsonsh" ? Should I change the

script/command name to match?

Toggle quote (5 lines)

>> + (version "0d5e5c7")

>Since this isn't a tagged version, this should follow the 'git-version'

>pattern (search for usages of 'git-version' for examples).

Will do.

Toggle quote (11 lines)>> +         (add-before 'install 'check
>> +           (lambda _
>> +             (invoke "./all-tests.sh")
>> +             #t))
>
>Check phases should respect #:tests?, like so:
>
>  (lambda* (#:key tests? #:allow-other-keys)
>    (when tests?
>      [...]))

Toggle quote (4 lines)

>> + '("grep" "coreutils"))

>Does this script actually use coreutils?

It uses printf

Toggle quote (2 lines)

> On the other hand, it looks >like it does use gawk

gawk is only used if egrep is not present

Toggle quote (2 lines)

> and sed.

Missed this, will add.

Stephen Paul Weber wrote on 26 Sep 2021 03:21

Re: [bug#50793] [PATCH 2/2] gnu: Add cloudflare-cli

Recipients:(name . Sarah Morgensen)(address . iskarian@mgsn.dev)(address . 50793@debbugs.gnu.org)

Message-ID:20210926012149.GB16766@singpolyma-beefy.lan

Toggle quote (5 lines)

>> + '("grep" "curl" "coreutils"))

>I don't think this uses anything from coreutils either, but I just took

>a quick look.

printf again

Stephen Paul Weber wrote on 26 Sep 2021 03:29

[PATCH v2 1/2] gnu: Add JSON.sh

Recipients:(address . 50793@debbugs.gnu.org)(name . Stephen Paul Weber)(address . singpolyma@singpolyma.net)

Message-ID:20210926012946.621-1-singpolyma@singpolyma.net

* gnu/packages/serialization.scm (JSON.sh): New variable.

---

gnu/packages/serialization.scm | 51 ++++++++++++++++++++++++++++++++++

1 file changed, 51 insertions(+)

Toggle diff (75 lines)diff --git a/gnu/packages/serialization.scm b/gnu/packages/serialization.scm
index 196141ace8..b8cdfdc048 100644
--- a/gnu/packages/serialization.scm
+++ b/gnu/packages/serialization.scm
@@ -34,10 +34,13 @@
   #:use-module (guix git-download)
   #:use-module (guix utils)
   #:use-module (guix build-system cmake)
+  #:use-module (guix build-system copy)
   #:use-module (guix build-system gnu)
   #:use-module (guix build-system python)
   #:use-module (gnu packages)
   #:use-module (gnu packages autotools)
+  #:use-module (gnu packages base)
+  #:use-module (gnu packages bash)
   #:use-module (gnu packages boost)
   #:use-module (gnu packages check)
   #:use-module (gnu packages compression)
@@ -458,6 +461,54 @@ it a convenient format to store user input files.")
                (base32
                 "1180ln8blrb0mwzpcf78k49hlki6di65q77rsvglf83kfcyh4d7z"))))))
 
+(define-public json.sh
+  (let ((commit "0d5e5c77365f63809bf6e77ef44a1f34b0e05840")
+        (revision "1"))
+    (package
+      (name "json.sh")
+      (version (git-version "0.0.0" revision commit))
+      (source
+       (origin
+         (method git-fetch)
+         (uri (git-reference
+               (url "https://github.com/dominictarr/JSON.sh")
+               (commit commit)))
+         (file-name (git-file-name name version))
+         (sha256
+          (base32
+           "14lxvp5xbdk0dcwkjbdp098z1108j8z48zaibndh4i731kkcz43i"))))
+      (build-system copy-build-system)
+      (arguments
+       `(#:install-plan '(("JSON.sh" "bin/"))
+         #:phases
+         (modify-phases %standard-phases
+           (add-before 'install 'check
+             (lambda* (#:key tests? #:allow-other-keys)
+               (when tests? (invoke "./all-tests.sh"))
+               #t))
+           (add-after 'install 'wrap-program
+             (lambda* (#:key inputs outputs #:allow-other-keys)
+               (wrap-program (string-append (assoc-ref outputs "out") "/bin/JSON.sh")
+                 `("PATH" ":" prefix
+                   (,(string-join
+                     (map (lambda (in) (string-append (assoc-ref inputs in) "/bin"))
+                          '("grep" "sed" "coreutils"))
+                      ":"))))
+                #t)))))
+      (inputs
+       `(("bash-minimal" ,bash-minimal)
+         ("grep" ,grep)
+         ("sed" ,sed)
+         ("coreutils" ,coreutils)))
+      (synopsis
+        "Pipeable JSON parser written in shell")
+      (description
+        "A JSON parser written in shell, compatible with ash, bash, dash and zsh.
+Pipe json to it, and it traverses the json objects and prints out the path to
+the current object (as a JSON array) and then the object, without whitespace.")
+      (home-page "https://github.com/dominictarr/JSON.sh")
+      (license (list license:expat license:asl2.0)))))
+
 (define-public capnproto
   (package
     (name "capnproto")
-- 
2.20.1

Stephen Paul Weber wrote on 26 Sep 2021 03:29

[PATCH v2 2/2] gnu: Add cloudflare-cli

Recipients:(address . 50793@debbugs.gnu.org)(name . Stephen Paul Weber)(address . singpolyma@singpolyma.net)

Message-ID:20210926012946.621-2-singpolyma@singpolyma.net

* gnu/packages/dns.scm (cloudflare-cli): New variable.

---

gnu/packages/dns.scm | 54 ++++++++++++++++++++++++++++++++++++++++++++

1 file changed, 54 insertions(+)

Toggle diff (86 lines)diff --git a/gnu/packages/dns.scm b/gnu/packages/dns.scm
index 45e250138e..d9ef88af99 100644
--- a/gnu/packages/dns.scm
+++ b/gnu/packages/dns.scm
@@ -42,6 +42,7 @@
   #:use-module (gnu packages bash)
   #:use-module (gnu packages certs)
   #:use-module (gnu packages check)
+  #:use-module (gnu packages curl)
   #:use-module (gnu packages databases)
   #:use-module (gnu packages documentation)
   #:use-module (gnu packages compression)
@@ -69,6 +70,7 @@
   #:use-module (gnu packages python)
   #:use-module (gnu packages python-xyz)
   #:use-module (gnu packages ragel)
+  #:use-module (gnu packages serialization)
   #:use-module (gnu packages shells)
   #:use-module (gnu packages sphinx)
   #:use-module (gnu packages swig)
@@ -82,11 +84,63 @@
   #:use-module (guix download)
   #:use-module (guix git-download)
   #:use-module (guix utils)
+  #:use-module (guix build-system copy)
   #:use-module (guix build-system glib-or-gtk)
   #:use-module (guix build-system gnu)
   #:use-module (guix build-system meson)
   #:use-module (guix build-system trivial))
 
+(define-public cloudflare-cli
+  (let ((commit "2d986d3ec1b0e3158c4bd40e8918947cb74aa392")
+        (revision "1"))
+    (package
+      (name "cloudflare-cli")
+      (version (git-version "0.0.0" revision commit))
+      (source
+       (origin
+         (method git-fetch)
+         (uri (git-reference
+               (url "https://github.com/earlchew/cloudflare-cli")
+               (commit commit)))
+         (file-name (git-file-name name version))
+         (sha256
+          (base32
+           "0f86g6n86kwykl3jnhqjrdfy8ybkp03ghr3dlr70q2552qw4axw2"))))
+      (build-system copy-build-system)
+      (arguments
+       `(#:install-plan '(("cloudflare-cli" "bin/") ("cloudflare-cli.sh" "bin/"))
+         #:phases
+         (modify-phases %standard-phases
+           (add-after 'unpack 'find-jsonsh
+             (lambda* (#:key inputs #:allow-other-keys)
+               (substitute* "cloudflare-cli.sh"
+                 (("\\$\\{0%/\\*\\}/jsonsh")
+                  (string-append (assoc-ref inputs "json.sh") "/bin/JSON.sh")))
+               #t))
+           (add-after 'install 'wrap-program
+             (lambda* (#:key inputs outputs #:allow-other-keys)
+               (wrap-program (string-append (assoc-ref outputs "out") "/bin/cloudflare-cli")
+                 `("PATH" ":" prefix
+                   (,(string-join
+                      (map (lambda (in) (string-append (assoc-ref inputs in) "/bin"))
+                           '("grep" "curl" "coreutils"))
+                      ":"))))
+               #t)))))
+      (inputs
+       `(("bash-minimal" ,bash-minimal)
+         ("coreutils" ,coreutils)
+         ("curl" ,curl)
+         ("grep" ,grep)
+         ("json.sh" ,json.sh)))
+      (synopsis
+        "CLI to edit Cloudflare DNS records")
+      (description
+        "This command line tool to update Cloudfare DNS records is useful for tasks
+such as updating dynamic DNS records or updating DNS records for the ACME DNS-01
+protocol.")
+      (home-page "https://github.com/earlchew/cloudflare-cli")
+      (license license:expat))))
+
 (define-public ldns
   (package
     (name "ldns")
-- 
2.20.1

Sarah Morgensen wrote on 26 Sep 2021 05:02

Re: [bug#50793] [PATCH 1/2] gnu: Add JSON.sh

Recipients:(name . Stephen Paul Weber)(address . singpolyma@singpolyma.net)(address . 50793@debbugs.gnu.org)

Message-ID:86o88gujid.fsf@mgsn.dev

Hi,

Stephen Paul Weber <singpolyma@singpolyma.net> writes:

Toggle quote (10 lines)>>> +(define-public JSON.sh
>>> +  (package
>>> +    (name "JSON.sh")
>>
>>I can't find a rule for this per se, but it's convention that package
>>names to be lowercase (and for the variable name to match).
>
> Ok. Should I keep the . for "json.sh" or go with "jsonsh" ?  Should I change the
> script/command name to match?

I'd keep the dot in the package name. We don't want to modify the

actual script name in the package, though (we try to leave the actual

contents of packages as unmodified as possible).

Toggle quote (7 lines)

>>> + '("grep" "coreutils"))

>>Does this script actually use coreutils?

> It uses printf

'printf' should just be calling the shell builtin:

Toggle snippet (4 lines)

$ type printf

printf is a shell builtin

Sarah

Stephen Paul Weber wrote on 27 Sep 2021 01:32

Recipients:(name . Sarah Morgensen)(address . iskarian@mgsn.dev)(address . 50793@debbugs.gnu.org)

Message-ID:20210926233224.GB2089@singpolyma-beefy.lan

Toggle quote (7 lines)

>'printf' should just be calling the shell builtin:

>--8<---------------cut here---------------start------------->8---

>$ type printf

>printf is a shell builtin

>--8<---------------cut here---------------end--------------->8---

Oh of course, silly me, I'll submit a version without coreutils input.

Stephen Paul Weber wrote on 27 Sep 2021 01:35

[PATCH v3 2/2] gnu: Add cloudflare-cli

Recipients:(address . 50793@debbugs.gnu.org)

Message-ID:20210926233513.3710-2-singpolyma@singpolyma.net

* gnu/packages/dns.scm (cloudflare-cli): New variable.

---

gnu/packages/dns.scm | 53 ++++++++++++++++++++++++++++++++++++++++++++

1 file changed, 53 insertions(+)

Toggle diff (85 lines)diff --git a/gnu/packages/dns.scm b/gnu/packages/dns.scm
index 45e250138e..3b0da466f5 100644
--- a/gnu/packages/dns.scm
+++ b/gnu/packages/dns.scm
@@ -42,6 +42,7 @@
   #:use-module (gnu packages bash)
   #:use-module (gnu packages certs)
   #:use-module (gnu packages check)
+  #:use-module (gnu packages curl)
   #:use-module (gnu packages databases)
   #:use-module (gnu packages documentation)
   #:use-module (gnu packages compression)
@@ -69,6 +70,7 @@
   #:use-module (gnu packages python)
   #:use-module (gnu packages python-xyz)
   #:use-module (gnu packages ragel)
+  #:use-module (gnu packages serialization)
   #:use-module (gnu packages shells)
   #:use-module (gnu packages sphinx)
   #:use-module (gnu packages swig)
@@ -82,11 +84,62 @@
   #:use-module (guix download)
   #:use-module (guix git-download)
   #:use-module (guix utils)
+  #:use-module (guix build-system copy)
   #:use-module (guix build-system glib-or-gtk)
   #:use-module (guix build-system gnu)
   #:use-module (guix build-system meson)
   #:use-module (guix build-system trivial))
 
+(define-public cloudflare-cli
+  (let ((commit "2d986d3ec1b0e3158c4bd40e8918947cb74aa392")
+        (revision "1"))
+    (package
+      (name "cloudflare-cli")
+      (version (git-version "0.0.0" revision commit))
+      (source
+       (origin
+         (method git-fetch)
+         (uri (git-reference
+               (url "https://github.com/earlchew/cloudflare-cli")
+               (commit commit)))
+         (file-name (git-file-name name version))
+         (sha256
+          (base32
+           "0f86g6n86kwykl3jnhqjrdfy8ybkp03ghr3dlr70q2552qw4axw2"))))
+      (build-system copy-build-system)
+      (arguments
+       `(#:install-plan '(("cloudflare-cli" "bin/") ("cloudflare-cli.sh" "bin/"))
+         #:phases
+         (modify-phases %standard-phases
+           (add-after 'unpack 'find-jsonsh
+             (lambda* (#:key inputs #:allow-other-keys)
+               (substitute* "cloudflare-cli.sh"
+                 (("\\$\\{0%/\\*\\}/jsonsh")
+                  (string-append (assoc-ref inputs "json.sh") "/bin/JSON.sh")))
+               #t))
+           (add-after 'install 'wrap-program
+             (lambda* (#:key inputs outputs #:allow-other-keys)
+               (wrap-program (string-append (assoc-ref outputs "out") "/bin/cloudflare-cli")
+                 `("PATH" ":" prefix
+                   (,(string-join
+                      (map (lambda (in) (string-append (assoc-ref inputs in) "/bin"))
+                           '("grep" "curl"))
+                      ":"))))
+               #t)))))
+      (inputs
+       `(("bash-minimal" ,bash-minimal)
+         ("curl" ,curl)
+         ("grep" ,grep)
+         ("json.sh" ,json.sh)))
+      (synopsis
+        "CLI to edit Cloudflare DNS records")
+      (description
+        "This command line tool to update Cloudfare DNS records is useful for tasks
+such as updating dynamic DNS records or updating DNS records for the ACME DNS-01
+protocol.")
+      (home-page "https://github.com/earlchew/cloudflare-cli")
+      (license license:expat))))
+
 (define-public ldns
   (package
     (name "ldns")
-- 
2.20.1

Stephen Paul Weber wrote on 27 Sep 2021 01:35

[PATCH v3 1/2] gnu: Add JSON.sh

Recipients:(address . 50793@debbugs.gnu.org)

Message-ID:20210926233513.3710-1-singpolyma@singpolyma.net

* gnu/packages/serialization.scm (JSON.sh): New variable.

---

gnu/packages/serialization.scm | 50 ++++++++++++++++++++++++++++++++++

1 file changed, 50 insertions(+)

Toggle diff (74 lines)diff --git a/gnu/packages/serialization.scm b/gnu/packages/serialization.scm
index 196141ace8..07ce5f2537 100644
--- a/gnu/packages/serialization.scm
+++ b/gnu/packages/serialization.scm
@@ -34,10 +34,13 @@
   #:use-module (guix git-download)
   #:use-module (guix utils)
   #:use-module (guix build-system cmake)
+  #:use-module (guix build-system copy)
   #:use-module (guix build-system gnu)
   #:use-module (guix build-system python)
   #:use-module (gnu packages)
   #:use-module (gnu packages autotools)
+  #:use-module (gnu packages base)
+  #:use-module (gnu packages bash)
   #:use-module (gnu packages boost)
   #:use-module (gnu packages check)
   #:use-module (gnu packages compression)
@@ -458,6 +461,53 @@ it a convenient format to store user input files.")
                (base32
                 "1180ln8blrb0mwzpcf78k49hlki6di65q77rsvglf83kfcyh4d7z"))))))
 
+(define-public json.sh
+  (let ((commit "0d5e5c77365f63809bf6e77ef44a1f34b0e05840")
+        (revision "1"))
+    (package
+      (name "json.sh")
+      (version (git-version "0.0.0" revision commit))
+      (source
+       (origin
+         (method git-fetch)
+         (uri (git-reference
+               (url "https://github.com/dominictarr/JSON.sh")
+               (commit commit)))
+         (file-name (git-file-name name version))
+         (sha256
+          (base32
+           "14lxvp5xbdk0dcwkjbdp098z1108j8z48zaibndh4i731kkcz43i"))))
+      (build-system copy-build-system)
+      (arguments
+       `(#:install-plan '(("JSON.sh" "bin/"))
+         #:phases
+         (modify-phases %standard-phases
+           (add-before 'install 'check
+             (lambda* (#:key tests? #:allow-other-keys)
+               (when tests? (invoke "./all-tests.sh"))
+               #t))
+           (add-after 'install 'wrap-program
+             (lambda* (#:key inputs outputs #:allow-other-keys)
+               (wrap-program (string-append (assoc-ref outputs "out") "/bin/JSON.sh")
+                 `("PATH" ":" prefix
+                   (,(string-join
+                     (map (lambda (in) (string-append (assoc-ref inputs in) "/bin"))
+                          '("grep" "sed"))
+                      ":"))))
+                #t)))))
+      (inputs
+       `(("bash-minimal" ,bash-minimal)
+         ("grep" ,grep)
+         ("sed" ,sed)))
+      (synopsis
+        "Pipeable JSON parser written in shell")
+      (description
+        "A JSON parser written in shell, compatible with ash, bash, dash and zsh.
+Pipe json to it, and it traverses the json objects and prints out the path to
+the current object (as a JSON array) and then the object, without whitespace.")
+      (home-page "https://github.com/dominictarr/JSON.sh")
+      (license (list license:expat license:asl2.0)))))
+
 (define-public capnproto
   (package
     (name "capnproto")
-- 
2.20.1

Ludovic Courtès wrote on 13 Oct 2021 11:05

Re: bug#50793: [PATCH 0/2] cloudflare-cli and dependency JSON.sh

Recipients:(name . Stephen Paul Weber)(address . singpolyma@singpolyma.net)

Message-ID:87czo9s3b4.fsf_-_@gnu.org

Hi,

Stephen Paul Weber <singpolyma@singpolyma.net> skribis:

Toggle quote (2 lines)

> * gnu/packages/serialization.scm (JSON.sh): New variable.

Applied with the cosmetic changes below.

Thanks,

Ludo’.

Toggle diff (34 lines)diff --git a/gnu/packages/serialization.scm b/gnu/packages/serialization.scm
index 07ce5f2537..e24ef973b5 100644
--- a/gnu/packages/serialization.scm
+++ b/gnu/packages/serialization.scm
@@ -462,7 +462,7 @@ (define-public jsoncpp-for-tensorflow
                 "1180ln8blrb0mwzpcf78k49hlki6di65q77rsvglf83kfcyh4d7z"))))))
 
 (define-public json.sh
-  (let ((commit "0d5e5c77365f63809bf6e77ef44a1f34b0e05840")
+  (let ((commit "0d5e5c77365f63809bf6e77ef44a1f34b0e05840") ;no releases
         (revision "1"))
     (package
       (name "json.sh")
@@ -499,14 +499,14 @@ (define-public json.sh
        `(("bash-minimal" ,bash-minimal)
          ("grep" ,grep)
          ("sed" ,sed)))
-      (synopsis
-        "Pipeable JSON parser written in shell")
+      (synopsis "Pipeable JSON parser written in shell")
       (description
-        "A JSON parser written in shell, compatible with ash, bash, dash and zsh.
-Pipe json to it, and it traverses the json objects and prints out the path to
-the current object (as a JSON array) and then the object, without whitespace.")
+        "This package provides a JSON parser written in shell, compatible with
+ash, Bash, Dash and Zsh.  Pipe JSON to it, and it traverses the JSON objects
+and prints out the path to the current object (as a JSON array) and then the
+object, without whitespace.")
       (home-page "https://github.com/dominictarr/JSON.sh")
-      (license (list license:expat license:asl2.0)))))
+      (license (list license:expat license:asl2.0))))) ;dual-licensed
 
 (define-public capnproto
   (package

Ludovic Courtès wrote on 13 Oct 2021 11:08

Recipients:(name . Stephen Paul Weber)(address . singpolyma@singpolyma.net)

Message-ID:878ryxs35m.fsf_-_@gnu.org

Stephen Paul Weber <singpolyma@singpolyma.net> skribis:

Toggle quote (2 lines)

> * gnu/packages/dns.scm (cloudflare-cli): New variable.

Applied. Thank you, and thanks Sarah!

Ludo’.

Closed

Maxim Cournoyer wrote on 13 Oct 2021 21:03

Re: [bug#50793] [PATCH 0/2] cloudflare-cli and dependency JSON.sh

Recipients:(name . Ludovic Courtès)(address . ludo@gnu.org)

Message-ID:87lf2wwxvg.fsf@gmail.com

Hello!

Ludovic Courtès <ludo@gnu.org> writes:

Toggle quote (8 lines)

> Hi,

> Stephen Paul Weber <singpolyma@singpolyma.net> skribis:

>> * gnu/packages/serialization.scm (JSON.sh): New variable.

> Applied with the cosmetic changes below.

Didn't we have some coding style preferring hyphens over '.' ? I can't

find any of this in our manual, but ISTR that there were some commits

made to adjust package names that had '.' in them.

Thanks!

zimoun wrote on 14 Oct 2021 10:54

Recipients:(name . Maxim Cournoyer)(address . maxim.cournoyer@gmail.com)

Message-ID:86v920q94p.fsf@gmail.com

Hi,

On Wed, 13 Oct 2021 at 15:03, Maxim Cournoyer <maxim.cournoyer@gmail.com> wrote:

Toggle quote (4 lines)

> Didn't we have some coding style preferring hyphens over '.' ? I can't

> find any of this in our manual, but ISTR that there were some commits

> made to adjust package names that had '.' in them.

Yes, the implicit rule of thumb is to prefer hyphens ’-’ over dot ’.’

for naming variable. Indeed, I do not find neither this in manual.

Is it better to add a lint checker? Or just add an item to

https://guix.gnu.org/manual/devel/en/guix.html#Submitting-Patches

Cheers,

simon

Maxim Cournoyer wrote on 15 Oct 2021 05:26

Recipients:(name . zimoun)(address . zimon.toutoune@gmail.com)

Message-ID:87h7djnf3o.fsf@gmail.com

Hello Simon,

zimoun <zimon.toutoune@gmail.com> writes:

Toggle quote (15 lines)> Hi,
>
> On Wed, 13 Oct 2021 at 15:03, Maxim Cournoyer <maxim.cournoyer@gmail.com> wrote:
>
>> Didn't we have some coding style preferring hyphens over '.' ?  I can't
>> find any of this in our manual, but ISTR that there were some commits
>> made to adjust package names that had '.' in them.
>
> Yes, the implicit rule of thumb is to prefer hyphens ’-’ over dot ’.’
> for naming variable.  Indeed, I do not find neither this in manual.
>
> Is it better to add a lint checker?  Or just add an item to
>
> <https://guix.gnu.org/manual/devel/en/guix.html#Submitting-Patches>

I'd say both! Were you volunteering to add it? :-)

Thanks,

Maxim

Ludovic Courtès wrote on 15 Oct 2021 17:28

Recipients:(name . Maxim Cournoyer)(address . maxim.cournoyer@gmail.com)

Message-ID:87bl3qi9z0.fsf@gnu.org

Hi,

Maxim Cournoyer <maxim.cournoyer@gmail.com> skribis:

Toggle quote (14 lines)> Ludovic Courtès <ludo@gnu.org> writes:
>
>> Hi,
>>
>> Stephen Paul Weber <singpolyma@singpolyma.net> skribis:
>>
>>> * gnu/packages/serialization.scm (JSON.sh): New variable.
>>
>> Applied with the cosmetic changes below.
>
> Didn't we have some coding style preferring hyphens over '.' ?  I can't
> find any of this in our manual, but ISTR that there were some commits
> made to adjust package names that had '.' in them.

Ah, I wasn’t sure, but I can change it to a hyphen.

Thanks!

Ludo’.

Your comment

This issue is archived.

To comment on this conversation send an email to 50793@debbugs.gnu.org

To respond to this issue using the mumi CLI, first switch to it

mumi current 50793

Then, you may apply the latest patchset in this issue (with sign off)

mumi am -- -s

Or, compose a reply to this issue

mumi compose

Or, send patches to this issue

mumi send-email *.patch

is:open	open issues
is:done	closed issues
submitter:<who>	search issue submitter
author:<who>	search by message author
date:yesterday..now	search by issue date
mdate:3m..2d	search by message date