Updates to loginBF() to support self signed SSL certificates.

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: abettor
 Title: R bindings to Betfair API-NG
-Version: 0.1.1
-Date: 2014-12-15
+Version: 0.1.2
+Date: 2014-12-21
 Authors@R: as.person(c("Phill Clarke <phill@starkingdom.co.uk> [aut, cre]"))
 Description: An R package for connecting to the online betting exchange,
     Betfair, via their API-NG product using JSON-RPC. The package user can

R/loginBF.R

@@ -22,6 +22,13 @@
 #'   defined. See Examples.
 #' @param applicationKey Character string containing Betfair application key and
 #'   must be defined. See Examples.
+#' @param sslVerify Boolean. This argument defaults to TRUE and is optional. In
+#'   some cases, where users have a self signed SSL Certificate, for example
+#'   they may be behind a proxy server, Betfair will fail login with "SSL
+#'   certificate problem: self signed certificate in certificate chain". If this
+#'   error occurs you may set sslVerify to FALSE. This does open a small
+#'   security risk of a man-in-the-middle intercepting your login credentials.
+#'   See Examples.
 #' @return Response from Betfair will be stored in {loginReturn}. Examples of
 #'   login responses for the JSON API interactive endpoint can be found here:
 #'
@@ -44,16 +51,24 @@
 #'         password = "YourBetfairPassword",
 #'         applicationKey = "YourBetfairAppKey"
 #'         )
+#'
+#' # Login with self signed SSL Certificate
+#' loginBF(username = "YourBetfairUsername",
+#'         password = "YourBetfairPassword",
+#'         applicationKey = "YourBetfairAppKey",
+#'         sslVerify = FALSE
+#'         )
+#'
 #' }
 #'
 
-loginBF <- function(username, password, applicationKey){
+loginBF <- function(username, password, applicationKey, sslVerify = TRUE){
 
     credentials <- paste("username=",username,"&password=",password,sep="")
 
     headersLogin <- list('Accept' = 'application/json', 'X-Application' = applicationKey)
 
-    loginReturn <- RCurl::postForm("https://identitysso.betfair.com/api/login", .opts=list(postfields=credentials, httpheader=headersLogin))
+    loginReturn <- RCurl::postForm("https://identitysso.betfair.com/api/login", .opts=list(postfields=credentials, httpheader=headersLogin, ssl.verifypeer = sslVerify))
 
     authenticationKey <- jsonlite::fromJSON(loginReturn)
 

README.md

@@ -52,7 +52,9 @@ Each function contains documented descriptions for their use and all supported a
 
 This package is under active development.
 
-Current Version: 0.1.1
+Current Version: 0.1.2
+
+See [current release notes](https://github.com/phillc73/abettor/releases) for more details.
 
 ### Issues
 

man/loginBF.Rd

@@ -4,7 +4,7 @@
 \alias{loginBF}
 \title{Login to Betfair, interactive end point.}
 \usage{
-loginBF(username, password, applicationKey)
+loginBF(username, password, applicationKey, sslVerify = TRUE)
 }
 \arguments{
 \item{username}{Character string containing Betfair username and must be
@@ -15,6 +15,14 @@ defined. See Examples.}
 
 \item{applicationKey}{Character string containing Betfair application key and
 must be defined. See Examples.}
+
+\item{sslVerify}{Boolean. This argument defaults to TRUE and is optional. In
+some cases, where users have a self signed SSL Certificate, for example
+they may be behind a proxy server, Betfair will fail login with "SSL
+certificate problem: self signed certificate in certificate chain". If this
+error occurs you may set sslVerify to FALSE. This does open a small
+security risk of a man-in-the-middle intercepting your login credentials.
+See Examples.}
 }
 \value{
 Response from Betfair will be stored in {loginReturn}. Examples of
@@ -59,6 +67,14 @@ loginBF(username = "YourBetfairUsername",
         password = "YourBetfairPassword",
         applicationKey = "YourBetfairAppKey"
         )
+
+# Login with self signed SSL Certificate
+loginBF(username = "YourBetfairUsername",
+        password = "YourBetfairPassword",
+        applicationKey = "YourBetfairAppKey",
+        sslVerify = FALSE
+        )
+
 }
 }