diff mbox

Patch: Add package definition for ruby-net-http-digest-auth

Message ID CALjrZwbSDhNLCT6NFV1iipRwq28EdGJSv9Hj8KKNjPQBUjwBaw@mail.gmail.com
State New
Headers show

Commit Message

Frederick Muriithi Nov. 11, 2016, 4:48 p.m. UTC
I have added a package definition for ruby-net-http-digest-auth and
created the patch.

Please find it attached.

Comments

Pjotr Prins Nov. 13, 2016, 2:36 p.m. UTC | #1
Hi Fred,

Thank you for your first package! It is a simple one, so mostly looks
good to me. The synopsis and descr will need a little work:

On Fri, Nov 11, 2016 at 07:48:41PM +0300, Frederick Muriithi wrote:
> I have added a package definition for ruby-net-http-digest-auth and
> created the patch.
> 
> Please find it attached.
> 
> -- 
> Frederick M. Muriithi

> From 74daa07591f97fe9eb149781f3102490d5b93c71 Mon Sep 17 00:00:00 2001
> From: Muriithi Frederick Muriuki <fredmanglis@gmail.com>
> Date: Fri, 11 Nov 2016 19:39:48 +0300
> Subject: [PATCH 2/2] gnu: ruby-net-http-digest-auth: Add new package
> 
> * gnu/packages/ruby.scm (ruby-net-http-digest-auth): Added a new
> package definition
> ---
>  gnu/packages/ruby.scm | 28 ++++++++++++++++++++++++++++
>  1 file changed, 28 insertions(+)
> 
> diff --git a/gnu/packages/ruby.scm b/gnu/packages/ruby.scm
> index 42beda3..380777a 100644
> --- a/gnu/packages/ruby.scm
> +++ b/gnu/packages/ruby.scm
> @@ -4179,3 +4179,31 @@ patterns.")
>  libraries for compiling Ruby native extensions.")
>      (home-page "https://github.com/ruby-gnome2/pkg-config")
>      (license license:lgpl2.0+)))
> +
> +(define-public ruby-net-http-digest-auth
> +  (package
> +    (name "ruby-net-http-digest-auth")
> +    (version "1.4")
> +    (source
> +     (origin
> +       (method url-fetch)
> +       (uri (rubygems-uri "net-http-digest_auth" version))
> +       (sha256
> +        (base32
> +         "14801gr34g0rmqz9pv4rkfa3crfdbyfk6r48vpg5a5407v0sixqi"))))
> +    (build-system ruby-build-system)
> +    (inputs
> +     `(("ruby-hoe" ,ruby-hoe)))
> +    (synopsis
> +     "One implementation of RFC 2617 - Digest Access Authentication")

If you look at other synopses in ruby.scm how would you simplify this
one? I think it can be described as "Secure authentication library for
http based on RFC 2617" so you anyone can understand what it is. 

> +    (description
> +     "An implementation of RFC 2617 - Digest Access Authentication.  At this time
> +the gem does not drop in to Net::HTTP and can be used for with other HTTP
> +clients.
> +
> +In order to use net-http-digest_auth you'll need to perform some request
> +wrangling on your own.  See the class documentation at Net::HTTP::DigestAuth
> +for an example.")

I think this can be simplified too and be done in one paragraph. If
compared with other descriptions, what do you propose?

The goal of the description is to add information to the synopsis - so
anyone who wants to know more about a package can read that. Compare
with existing package descriptions.

> +    (home-page
> +     "http://github.com/drbrain/net-http-digest_auth")
> +    (license license:expat)))

Pj.
diff mbox

Patch

From 74daa07591f97fe9eb149781f3102490d5b93c71 Mon Sep 17 00:00:00 2001
From: Muriithi Frederick Muriuki <fredmanglis@gmail.com>
Date: Fri, 11 Nov 2016 19:39:48 +0300
Subject: [PATCH 2/2] gnu: ruby-net-http-digest-auth: Add new package

* gnu/packages/ruby.scm (ruby-net-http-digest-auth): Added a new
package definition
---
 gnu/packages/ruby.scm | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/gnu/packages/ruby.scm b/gnu/packages/ruby.scm
index 42beda3..380777a 100644
--- a/gnu/packages/ruby.scm
+++ b/gnu/packages/ruby.scm
@@ -4179,3 +4179,31 @@  patterns.")
 libraries for compiling Ruby native extensions.")
     (home-page "https://github.com/ruby-gnome2/pkg-config")
     (license license:lgpl2.0+)))
+
+(define-public ruby-net-http-digest-auth
+  (package
+    (name "ruby-net-http-digest-auth")
+    (version "1.4")
+    (source
+     (origin
+       (method url-fetch)
+       (uri (rubygems-uri "net-http-digest_auth" version))
+       (sha256
+        (base32
+         "14801gr34g0rmqz9pv4rkfa3crfdbyfk6r48vpg5a5407v0sixqi"))))
+    (build-system ruby-build-system)
+    (inputs
+     `(("ruby-hoe" ,ruby-hoe)))
+    (synopsis
+     "One implementation of RFC 2617 - Digest Access Authentication")
+    (description
+     "An implementation of RFC 2617 - Digest Access Authentication.  At this time
+the gem does not drop in to Net::HTTP and can be used for with other HTTP
+clients.
+
+In order to use net-http-digest_auth you'll need to perform some request
+wrangling on your own.  See the class documentation at Net::HTTP::DigestAuth
+for an example.")
+    (home-page
+     "http://github.com/drbrain/net-http-digest_auth")
+    (license license:expat)))
-- 
2.1.4