Update to v0.1.2

Author: StevenMMortimer

DESCRIPTION

@@ -1,16 +1,19 @@
 Package: rdfp
-Title: DoubleClick for Publishers API from R
-Version: 0.1.1.9000
-Date: 2018-03-29
-Description: An implementation of Google's DoubleClick for Publishers API in R. 
+Title: An Implementation of the 'DoubleClick for Publishers' API
+Version: 0.1.2
+Date: 2018-04-07
+Description: An implementation of Google's 'DoubleClick for Publishers' (DFP) API 
+    <https://developers.google.com/doubleclick-publishers/docs/start>. 
     This package is automatically compiled from the API WSDLs (Web Service Description 
     Language) files to dictate how the API is structured. Theoretically, all API 
     actions are possible using this package; however, care must be taken to format 
-    the inputs correctly and parse the outputs correctly as well. See Google's DFP 
-    API reference and the rdfp pkgdown website for more information, documentation 
-    and examples.
+    the inputs correctly and parse the outputs correctly as well. Please see Google's 
+    DFP API reference and this package's website <https://stevenmmortimer.github.io/rdfp/> 
+    for more information, documentation, and examples.
 Authors@R: c(
-    person(c("Steven", "M."), "Mortimer", , "[email protected]", c("aut", "cre"))
+    person(c("Steven", "M."), "Mortimer", , "[email protected]", c("aut", "cre")),
+    person("Jennifer", "Bryan", , "[email protected]", c("ctb")),
+    person("Joanna", "Zhao", , "[email protected]", c("ctb"))
     )
 URL: https://github.com/StevenMMortimer/rdfp
 BugReports: https://github.com/StevenMMortimer/rdfp/issues
@@ -34,7 +37,8 @@ Imports:
 Suggests:
     knitr,
     testthat,
-    rmarkdown
+    rmarkdown,
+    here
 RoxygenNote: 6.0.1
 Collate: 
     'ActivityGroupService.R'

LICENSE

@@ -1,52 +1,2 @@
-MIT License
-
-Copyright (c) 2018 Steven M. Mortimer
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
-The rdfp package includes other open source software components. The following
-is a list of these components (full copies of the license agreements used by
-these components are included below):
-
- - googlesheets, https://github.com/jennybc/googlesheets
- 
-
-googlesheets License
-----------------------------------------------------------------------
-The MIT License (MIT)
-
-Copyright (c) 2017 Jennifer Bryan, Joanna Zhao
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+YEAR: 2018
+COPYRIGHT HOLDER: Steven M. Mortimer

NEWS.md

@@ -1,19 +1,17 @@
-## rdfp 0.1.1.9000
+## rdfp 0.1.2 [release](https://github.com/StevenMMortimer/rdfp/releases/tag/v0.1.2)
 
 ### Features
 
   * `dfp_report_url_to_dataframe()` now returns a `tbl_df` object for better 
   printing and casted data types
-  * Simplified `dfp_select()` so that it automatically uses `dfp_select_parse()` 
+  * Simplify `dfp_select()` so that it automatically uses `dfp_select_parse()` 
   to format the result into a `tbl_df`
-  * Added `dfp_date_as_list()` that will convert a date or datetime representation 
-  in R to the required list format for submission to DFP  
-  * Started to add some examples to functions so that the inline documentation 
+  * Add `dfp_date_as_list()` that will convert a date or datetime representation 
+  in R to the required list format for submission to DFP
+  * Add examples to functions so that the inline documentation 
   gives a better idea of how to make it work in R
-
-### Bug Fixes
-
-  * Nothing yet! 
+  * Add `addtl_scopes` arugment to `dfp_auth()` so that users can create token that 
+  can be used with other R packages to connect to other Google services
 
 ---
 

R/dfp_auth.R

@@ -9,7 +9,7 @@
 #    of allowing httr to refresh if 401 error occurs
 #  - renamed the function gs_auth to dfp_auth to be consistent with package endpoint
 
-# Copyright (c) 2015 Jennifer Bryan, Joanna Zhao
+# Copyright (c) 2017 Jennifer Bryan, Joanna Zhao
 
 # Licensed under MIT license.
 
@@ -55,9 +55,9 @@ is_legit_token <- function(x, verbose = FALSE) {
 #' Authorize \code{rdfp} to access your Google user data. You will be
 #' directed to a web browser, asked to sign in to your Google account, and to
 #' grant \code{rdfp} access to user data for Double Click for Publishers. 
-#' These user credentials are cached in a file named
-#' \code{.httr-oauth} in the current working directory, from where they can be
-#' automatically refreshed, as necessary.
+#' These user credentials are cached in a file named \code{.httr-oauth} in 
+#' the current working directory, from where they can be automatically refreshed, 
+#' as necessary.
 #'
 #' Most users, most of the time, do not need to call this function
 #' explicitly -- it will be triggered by the first action that
@@ -77,7 +77,7 @@ is_legit_token <- function(x, verbose = FALSE) {
 #'
 #' In a call to \code{dfp_auth}, the user can provide the token, app key and
 #' secret explicitly and can dictate whether credentials will be cached in
-#' \code{.httr_oauth}. They must be specified.
+#' \code{.httr-oauth}. They must be specified.
 #'
 #' To set options in a more persistent way, predefine one or more of
 #' them with lines like this in a \code{.Rprofile} file:
@@ -101,6 +101,10 @@ is_legit_token <- function(x, verbose = FALSE) {
 #'   want to wipe the slate clean and re-authenticate with the same or different
 #'   Google account. This deletes the \code{.httr-oauth} file in current working
 #'   directory.
+#' @param addtl_scopes character, strings that indicate additional Google services 
+#' the client should authorize. Use this when trying to generate a token that will 
+#' work to authenticate to other packages using Google services, such as the googlesheets 
+#' package or RGoogleAnalytics package.
 #' @param key,secret the "Client ID" and "Client secret" for the application
 #' @param cache logical indicating if \code{rdfp} should cache
 #'   credentials in the default cache file \code{.httr-oauth}
@@ -111,6 +115,15 @@ is_legit_token <- function(x, verbose = FALSE) {
 #' @export
 dfp_auth <- function(token = NULL,
                      new_user = FALSE,
+                     addtl_scopes = c("https://spreadsheets.google.com/feeds",
+                                      "https://www.googleapis.com/auth/drive",
+                                      "https://www.googleapis.com/auth/spreadsheets",
+                                      "https://www.googleapis.com/auth/presentations",
+                                      "https://www.googleapis.com/auth/analytics",
+                                      "https://www.googleapis.com/auth/yt-analytics.readonly",
+                                      "https://www.googleapis.com/auth/gmail.readonly", 
+                                      "https://www.googleapis.com/auth/gmail.compose", 
+                                      "https://www.googleapis.com/auth/gmail.send"),
                      key = getOption("rdfp.client_id"),
                      secret = getOption("rdfp.client_secret"),
                      cache = getOption("rdfp.httr_oauth_cache"), 
@@ -124,6 +137,10 @@ dfp_auth <- function(token = NULL,
   if(is.null(token)) {
 
     scope_list <- c("https://www.googleapis.com/auth/dfp")
+    if(!missing(addtl_scopes)){
+      addtl_scopes <- match.arg(addtl_scopes, several.ok = TRUE)
+      scope_list <- c(scope_list, addtl_scopes)
+    }
 
     rdfp_app <- httr::oauth_app("google", key = key, secret = secret)
 

R/dfp_utils.R

@@ -95,7 +95,7 @@ dfp_date_to_list <- function(this_date,
   which_daytime <- match.arg(daytime)
 
   if(ensure_today_works & (difftime(this_date, (Sys.time()+hours(1))) < 0)){
-    warning("The date provided is not at least 1 hour into the future. Setting to one hour after now.")
+    message("The date provided is not at least 1 hour into the future. Setting to one hour after now.")
     this_date <- Sys.time() + hours(1)
   }  
 
@@ -106,7 +106,7 @@ dfp_date_to_list <- function(this_date,
   } else {
     this_hour <- hour(this_date)
     this_minute <- minute(this_date)
-    this_second <- second(this_date)
+    this_second <- round(second(this_date), 0)
   }
 
   x <- list(date=list(year = year(this_date),

README.Rmd

@@ -28,8 +28,7 @@ inventory, create orders, pull reports, and more!
   * [Installation](#installation)
   * [Vignettes](#vignettes)
   * [Usage](#usage)
-    * [Functions](#functions)
-    * [Set API Version](#set-api-version)
+    * [Set API Version](#load-package-and-set-api-version)
     * [Authenticate](#authenticate)
     * [Get Current User Info](#get-current-user-info)
     * [Pull a LineItem](#pull-a-lineitem)
@@ -40,8 +39,9 @@ inventory, create orders, pull reports, and more!
 ## Installation
 
 ```{r, eval = FALSE}
-# this package is currently not on CRAN, so it should be installed from GitHub
-# install.packages("devtools")
+install.packages("devtools")
+
+# or to get the latest version available on GitHub
 devtools::install_github("StevenMMortimer/rdfp")
 ```
 
@@ -61,8 +61,6 @@ more detailed examples on usage.
 
 ## Usage  
 
-### Functions
-
 All functions start with `dfp_` so that you can easily identify DFP-specific 
 operations and use tab completion in RStudio. Most **rdfp** functions will 
 return a `data.frame` or `list` parsed from the XML returned in the SOAP response.
@@ -94,25 +92,25 @@ your browswer will pop open and you will interactively authenticate.
 
 The package has other options like a client\_id and client\_secret where you can 
 connect using your own API client instead of the package default. Using your own 
-client requires setting one up in the [Google Developers Console] 
-(https://console.developers.google.com).
+client requires setting one up in the 
+[Google Developers Console](https://console.developers.google.com).
 
 ```{r eval = FALSE}
 options(rdfp.network_code = "12345678")
 options(rdfp.application_name = "MyApp")
 options(rdfp.client_id = "012345678901-99thisisatest99.apps.googleusercontent.com")
 options(rdfp.client_secret = "Th1s1sMyC1ientS3cr3t")
 
-# this function will use the options set above and 
-# cache an OAuth token in the working directory
+# dfp_auth will use the options above and cache an OAuth token in the working directory
 # the token will be refreshed when necessary
 dfp_auth()
 ```
 
 ```{r auth, include = FALSE}
-token_path <- file.path(".", "tests", "testthat", "rdfp_token.rds")
+library(here)
+token_path <- here("tests", "testthat", "rdfp_token.rds")
 suppressMessages(dfp_auth(token = token_path, verbose = FALSE))
-options_path <- file.path(".", "tests", "testthat", "rdfp_options.rds")
+options_path <- here("tests", "testthat", "rdfp_options.rds")
 rdfp_options <- readRDS(options_path)
 options(rdfp.network_code = rdfp_options$network_code)
 ```

README.md

@@ -14,8 +14,7 @@ Table of Contents
 -   [Installation](#installation)
 -   [Vignettes](#vignettes)
 -   [Usage](#usage)
-    -   [Functions](#functions)
-    -   [Set API Version](#set-api-version)
+    -   [Set API Version](#load-package-and-set-api-version)
     -   [Authenticate](#authenticate)
     -   [Get Current User Info](#get-current-user-info)
     -   [Pull a LineItem](#pull-a-lineitem)
@@ -27,8 +26,9 @@ Installation
 ------------
 
 ``` r
-# this package is currently not on CRAN, so it should be installed from GitHub
-# install.packages("devtools")
+install.packages("devtools")
+
+# or to get the latest version available on GitHub
 devtools::install_github("StevenMMortimer/rdfp")
 ```
 
@@ -48,8 +48,6 @@ The README below outlines the package functionality, but review the vignettes fo
 Usage
 -----
 
-### Functions
-
 All functions start with `dfp_` so that you can easily identify DFP-specific operations and use tab completion in RStudio. Most **rdfp** functions will return a `data.frame` or `list` parsed from the XML returned in the SOAP response.
 
 ### Load Package and Set API Version
@@ -69,16 +67,15 @@ options(rdfp.version = "v201711")
 
 To authenticate you will first need to specify the `network_code` of the DFP instance you'd like to connect to. This is the only required option that the user must specify when using the **rdfp** package. After setting the `network_code` all you need to do is run `dfp_auth()`. If you already have a cached `.httr-oauth` file in the current working directory, then the token will be loaded and refreshed if necessary. Otherwise, your browswer will pop open and you will interactively authenticate.
 
-The package has other options like a client\_id and client\_secret where you can connect using your own API client instead of the package default. Using your own client requires setting one up in the \[Google Developers Console\] (<https://console.developers.google.com>).
+The package has other options like a client\_id and client\_secret where you can connect using your own API client instead of the package default. Using your own client requires setting one up in the [Google Developers Console](https://console.developers.google.com).
 
 ``` r
 options(rdfp.network_code = "12345678")
 options(rdfp.application_name = "MyApp")
 options(rdfp.client_id = "012345678901-99thisisatest99.apps.googleusercontent.com")
 options(rdfp.client_secret = "Th1s1sMyC1ientS3cr3t")
 
-# this function will use the options set above and 
-# cache an OAuth token in the working directory
+# dfp_auth will use the options above and cache an OAuth token in the working directory
 # the token will be refreshed when necessary
 dfp_auth()
 ```
@@ -139,20 +136,20 @@ request_data <- list(reportJob=list(reportQuery=list(dimensions='MONTH_AND_YEAR'
 # if you would like more control, see the example below which moves through each step in the process
 report_data <- dfp_full_report_wrapper(request_data)
 report_data[,c('Dimension.MONTH_AND_YEAR', 'Dimension.AD_UNIT_ID', 'Column.AD_SERVER_CLICKS')]
-#> # A tibble: 25 x 3
+#> # A tibble: 27 x 3
 #>    Dimension.MONTH_AND_YEAR Dimension.AD_UNIT_ID Column.AD_SERVER_CLICKS
 #>    <chr>                                   <dbl>                   <dbl>
-#>  1 2018-03                            133765096.                   1778.
-#>  2 2018-03                            133765216.                    422.
-#>  3 2018-03                            133765336.                    642.
-#>  4 2018-03                            133765456.                   2176.
-#>  5 2018-03                            142461136.                     91.
-#>  6 2018-03                            133765576.                  17581.
-#>  7 2018-03                            133765696.                    945.
-#>  8 2018-03                            133765936.                  18171.
-#>  9 2018-03                            142461016.                    312.
-#> 10 2018-03                            143543776.                   1496.
-#> # ... with 15 more rows
+#>  1 2018-04                            133765096.                   1815.
+#>  2 2018-04                            133765216.                    452.
+#>  3 2018-04                            133765336.                    652.
+#>  4 2018-04                            133765456.                   2247.
+#>  5 2018-04                            142461136.                     88.
+#>  6 2018-04                            133765576.                  17440.
+#>  7 2018-04                            133765696.                    961.
+#>  8 2018-04                            133765936.                  17514.
+#>  9 2018-04                            142461016.                    324.
+#> 10 2018-04                            143543776.                   1348.
+#> # ... with 17 more rows
 ```
 
 Credits

_pkgdown.yml

@@ -3,7 +3,7 @@ url: https://stevenmmortimer.github.io/rdfp/
 template:
   params:
     bootswatch: spacelab
-    ganalytics: UA-98603021-1
+    ganalytics: UA-98603021-2
 
 home:
   strip_header: true
@@ -12,6 +12,7 @@ navbar:
   type: default
   left:
     - text: "Articles"
+      icon: fas fa-book
       menu: 
       -  text: Administrative Tasks
          href: articles/administrative-tasks.html
@@ -24,11 +25,14 @@ navbar:
       -  text: Pulling Reports
          href: articles/pulling-reports.html
     - text: Reference
+      icon: fa-file-code-o
       href: reference/index.html
     - text: News
+      icon: fa-newspaper-o
       href: news/index.html
   right:
-    - icon: fa-github fa-lg
+    - text: GitHub
+      icon: fa-github fa-lg
       href: https://github.com/StevenMMortimer/rdfp
 
 reference: