Merge pull request #230 from Aaylor/fix-deprecated-authentication-method

Deprecated authentication method
mirage · Feb 7, 2020 · 23ee7b6 · 23ee7b6
2 parents ce312f1 + df8b991
commit 23ee7b6
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 19 deletions.
diff --git a/lib/github_core.ml b/lib/github_core.ml
@@ -489,25 +489,29 @@ module Make(Env : Github_s.Env)(Time : Github_s.Time)(CL : Cohttp_lwt.S.Client)
     let error err = Err err
     let response r = Response r
     let request ?token ?(params=[]) ({ uri; _ } as req) reqfn =
-      let uri = Uri.add_query_params' uri begin match token with
-        | None -> params
-        | Some token -> ("access_token", token)::params
-      end in Request ({req with uri}, reqfn)
+      let uri = Uri.add_query_params' uri params in
+      Request ({req with uri}, reqfn)
 
-    let add_ua hdrs ua =
-      let hdrs = C.Header.prepend_user_agent hdrs (user_agent^" "^C.Header.user_agent) in
-      match ua with
-        | None -> hdrs
-        | Some ua -> C.Header.prepend_user_agent hdrs ua
+    let prepare_headers state headers =
+      (* Add User-Agent *)
+      let headers =
+        C.Header.prepend_user_agent
+          headers
+          (user_agent^" "^C.Header.user_agent)
+      in
+      let headers =
+        match state.user_agent with
+        | None -> headers
+        | Some ua -> C.Header.prepend_user_agent headers ua
+      in
+      (* Add access token *)
+      match state.token with
+      | None -> headers
+      | Some token -> C.Header.add headers "Authorization" ("token " ^ token)
 
     let prepare_request state ({ headers; uri; _} as req) =
       { req with
-        headers=add_ua headers state.user_agent;
-        uri=if List.mem_assoc "access_token" (Uri.query req.uri)
-            then uri
-            else match state.token with
-              | Some token -> Uri.add_query_param' uri ("access_token",token)
-              | None -> uri
+        headers=prepare_headers state headers;
       }
 
     let rec bind fn x = fun state -> x state >>= function
@@ -805,17 +809,22 @@ module Make(Env : Github_s.Env)(Time : Github_s.Time)(CL : Cohttp_lwt.S.Client)
     let code_handler ~expected_code handler =
       (fun (res,_) -> C.Response.status res = expected_code), handler
 
-    (* Add the correct mime-type header *)
-    let realize_headers ?(media_type="application/vnd.github.v3+json") headers =
-      C.Header.add_opt headers "accept" media_type
+    (* Add the correct mime-type header and the authentication token. *)
+    let realize_headers
+        ?token ?(media_type="application/vnd.github.v3+json")
+        headers =
+      let headers = C.Header.add_opt headers "accept" media_type in
+      match token with
+      | None -> headers
+      | Some token -> C.Header.add headers "Authorization" ("token " ^ token)
 
     let idempotent meth
         ?(rate=Core) ?media_type ?headers ?token ?params ~fail_handlers ~expected_code ~uri
         fn =
       fun state -> Lwt.return
         (state,
          (Monad.(request ?token ?params
-                   {meth; uri; headers=realize_headers ?media_type headers; body=""})
+                   {meth; uri; headers=realize_headers ?token ?media_type headers; body=""})
             (request ~rate ~token
                ((code_handler ~expected_code fn)::fail_handlers))))
 

diff --git a/lib/github_s.mli b/lib/github_s.mli
@@ -262,7 +262,12 @@ module type Github = sig
       tokens} and
       {{:https://help.github.com/articles/creating-an-access-token-for-command-line-use/}"personal
       tokens"}.
+
+      Note: the OAuth Authorizations API has been deprecated by GitHub.
+
       @see <https://developer.github.com/v3/oauth_authorizations/> OAuth Authorizations API
+      @see <https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api/#deprecating-and-adding-endpoints-for-the-oauth-authorizations-and-oauth-applications-apis>
+      for the OAuth Authorizations deprecation.
   *)
   module Token : sig
     type t