Initial R client code

.Rbuildignore

+^.*\.Rproj$
+^\.Rproj\.user$

.gitignore

+.Rproj.user
+.Rhistory
+.RData
+.Ruserdata
+man

DESCRIPTION

+Package: genesysr
+Title: R client for Genesys PGR (www.genesys-pgr.org)
+Version: 0.1
+Authors@R: person("Matija", "Obreza", email = "matija.obreza@croptrust.org",
+                  role = c("aut", "cre"))
+Description: Selected Genesys API calls implemented in R.
+  Allows for authentication and exposes common API calls.
+Depends: R (>= 3.1.0)
+License: Apache License 2.0
+LazyData: true
+Imports:
+  httr
+RoxygenNote: 6.0.1

LICENSE

+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

NAMESPACE

+# Generated by roxygen2: do not edit by hand
+
+export(api_url)
+export(authorization)
+export(client_login)
+export(fetch_accessions)
+export(filter_DOI)
+export(filter_ORIGCTY)
+export(filter_SAMPSTAT)
+export(mcpd_filter)
+export(me)
+export(print_setup)
+export(setup)
+export(setup_production)
+export(setup_sandbox)
+export(user_login)

R/api-client.R

+# Copyright 2018 Global Crop Diversity Trust
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+.genesysEnv <- new.env(parent = emptyenv())
+
+#' Configure package defaults
+.onLoad <- function(libname, pkgname) {
+  setup_production()
+}
+
+#' Setup for Genesys Production
+#'
+#' Use the Genesys R Client with \link{https://www.genesys-pgr.org} requiring \code{\link{user_login}}
+#'
+#' @export
+setup_production <- function() {
+  setup(server = "https://www.genesys-pgr.org", client_id = "oHgJR.NjcdJAIB175gBDbuLEK3@www.genesys-pgr.org", client_secret = "public")
+}
+
+#' Setup for Genesys Sandbox
+#'
+#' Use the Genesys R Client with \link{https://sandbox.genesys-pgr.org} requiring \code{\link{user_login}}
+#'
+#' @export
+setup_sandbox <- function() {
+  setup(server = "https://sandbox.genesys-pgr.org", client_id = "cCS6e.BAn9u2WkhIwgxBLxOVqZ@sandbox.genesys-pgr.org", client_secret = NULL)
+}
+
+#' Configure the Genesys environment
+#'
+#' @param server Server base URL (e.g. \link{https://www.genesys-pgr.org} or \link{https://sandbox.genesys-pgr.org})
+#' @param client_id OAuth client ID
+#' @param client_secret OAuth client secret
+#'
+#' @export
+#' @seealso See utility methods \code{\link{setup_production}}, \code{\link{setup_sandbox}}
+#'
+#' @examples
+#'   # Link with sandbox
+#'   setup_sandbox()
+#'
+setup <- function(server = NULL, client_id = NULL, client_secret = NULL) {
+  assign("server", server, envir = .genesysEnv)
+  assign("client_id", client_id, envir = .genesysEnv)
+  assign("client_secret", client_secret, envir = .genesysEnv)
+}
+
+#' Print Genesys client configuration
+#'
+#' @export
+print_setup <- function() {
+  message(paste("Genesys URL:", .genesysEnv$server))
+  message(paste("Client ID:", .genesysEnv$client_id))
+  message(paste("Client secret:", .genesysEnv$client_secret))
+}
+
+#' Provide OAuth2 token to use for authorization with Genesys
+#'
+#' @seealso \code{\link{login}}
+#' @export
+authorization <- function(authorization) {
+  assign("Authorization", authorization, envir = .genesysEnv)
+  message(paste('Genesys Authorization:', authorization))
+}
+
+#' Login to Genesys as a user
+#'
+#' The authorization URL will open in a browser, ask the user to grant
+#' permissions to R and the verification code must be copy-pasted after
+#' you grant access to the client.
+#'
+#' @seealso \code{\link{setup}}
+#'
+#' @export
+user_login <- function() {
+  url <- paste0(.genesysEnv$server, "/oauth/authorize")
+  browseURL(httr::modify_url(url, query = list(
+    client_id = .genesysEnv$client_id, client_secret = .genesysEnv$client_secret,
+    redirect_uri = "oob",
+    scope = "read",
+    response_type= "code"
+    )))
+
+  code <- readline("Enter the authorization code: ");
+
+  url <- paste0(.genesysEnv$server, "/oauth/token")
+  resp <- httr::POST(url, body = list(
+    client_id = .genesysEnv$client_id, client_secret = .genesysEnv$client_secret,
+    redirect_uri = "oob",
+    grant_type = "authorization_code", code = code
+    ), encode = "form")
+
+  if (httr::http_type(resp) != "application/json" || httr::status_code(resp) != 200) {
+    stop(paste("API did not return json", httr::content(resp, "text")), call. = FALSE)
+  }
+
+  parsed <- jsonlite::fromJSON(httr::content(resp, "text"), simplifyVector = FALSE)
+
+  authorization(paste("Bearer", parsed$access_token))
+
+  invisible(structure(
+    parsed,
+    class = "genesys_auth"
+  ))
+}
+
+
+#' Login to Genesys as a service client (system-to-system)
+#'
+#' The client must be enabled for Client Credential grant on Genesys.
+#'
+#' @seealso \code{\link{setup}}
+#'
+#' @export
+client_login <- function() {
+  url <- paste0(.genesysEnv$server, "/oauth/token")
+  resp <- httr::POST(url, body = list(
+    client_id = .genesysEnv$client_id, client_secret = .genesysEnv$client_secret,
+    grant_type = "client_credentials"
+  ), encode = "form")
+
+  if (httr::http_type(resp) != "application/json" || httr::status_code(resp) != 200) {
+    stop("API did not return json", call. = FALSE)
+  }
+
+  parsed <- jsonlite::fromJSON(httr::content(resp, "text"), simplifyVector = FALSE)
+
+  authorization(paste("Bearer", parsed$access_token))
+
+  invisible(structure(
+    parsed,
+    class = "genesys_auth"
+  ))
+}
+
+
+api_call <- function(path, method = "get", server = GENESYS_SERVER) {
+  resp <- httr::GET(api_url(path), httr::add_headers(
+    Authorization = .genesysEnv$Authorization
+    )
+  )
+  resp
+  if (httr::http_type(resp) != "application/json") {
+    stop("API did not return json", call. = FALSE)
+  }
+  # return(resp)
+  parsed <- jsonlite::fromJSON(httr::content(resp, "text"), simplifyVector = FALSE)
+  return(parsed)
+}
+
+
+#' Get full Genesys API URL for a specific path
+#'
+#' @param path
+#'
+#' @return Absolute URL to an API call
+#' @export
+#'
+#' @examples
+#'  api_url("/me")
+api_url <- function(path) {
+  paste0(.genesysEnv$server, "/api/v0", path)
+}
+
+get <- function(path, query = NULL) {
+  resp <- httr::GET(api_url(path), httr::add_headers(
+    Authorization = .genesysEnv$Authorization
+  ))
+  if (httr::http_type(resp) != "application/json") {
+    stop("API did not return json", call. = FALSE)
+  }
+  resp
+}
+
+post <- function(path, query = NULL, body) {
+  resp <- httr::POST(api_url(path), httr::add_headers(
+    Authorization = .genesysEnv$Authorization,
+    "Content-Type" = "application/json"
+  ), body = jsonlite::toJSON(body))
+  if (httr::http_type(resp) != "application/json") {
+    stop("API did not return json", call. = FALSE)
+  }
+  resp
+}

R/filters.R

+# Copyright 2018 Global Crop Diversity Trust
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+#' Make or adjust filter using MCPD terminology
+#'
+#' See FAO/Bioversity Multi-Crop Passport Descriptors.
+#'
+#' @param filter Existing filters (or blank list if not provided)
+#' @param ORIGCTY Country of origin
+#' @param SAMPSTAT Biological status of sample
+#'
+#' @examples
+#'  # Filter accessions from Mexico and Slovenia
+#'  mcpd_filter(ORIGCTY = c("MEX", "SVN"))
+#'
+#'
+#' @export
+mcpd_filter <- function(filter = list(), DOI = NULL, ORIGCTY = NULL, SAMPSTAT = NULL) {
+  f <- c(filter)
+
+  f <- filter_DOI(f, DOI)
+  f <- filter_ORIGCTY(f, ORIGCTY)
+  f <- filter_SAMPSTAT(f, SAMPSTAT)
+
+  f
+}
+
+#' Add filter on accession DOI
+#' @export
+filter_DOI <- function(filter = list(), DOI) {
+  f <- c(filter)
+  if (!is.null(DOI)) {
+    f$doi = c(f$doi, DOI)
+  }
+  f
+}
+
+#' Add filter on Country of origin of material
+#' @export
+filter_ORIGCTY <- function(filter = list(), ORIGCTY) {
+  f <- c(filter)
+  if (!is.null(ORIGCTY)) {
+    f$orgCty.iso3 = c(f$orgCty.iso3, ORIGCTY)
+  }
+  f
+}
+
+#' Add filter on Biological status of sample
+#' @export
+filter_SAMPSTAT <- function(filter = list(), SAMPSTAT) {
+  f <- c(filter)
+  if (!is.null(SAMPSTAT)) {
+    f$sampStat = c(f$sampStat, SAMPSTAT)
+  }
+  f
+}

R/genesys.R

+# Copyright 2018 Global Crop Diversity Trust
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+#' Who am i?
+#'
+#' @export
+me <- function() {
+  resp <- api_call("/me")
+  message(jsonlite::toJSON(resp, pretty = TRUE))
+  invisible(resp)
+}
+
+#' Fetch accession passport data
+#'
+#' @param filters an R \code{structure} with Genesys filters
+#' @param size number of records to load per page (page size)
+#' @param page the page index (0-based)
+#'
+#' @seealso \code{\link{mcpd_filter}}
+#'
+#' @examples
+#'   # Retrieve accession data by DOI
+#'   accessions <- fetch_accessions(mcpd_filter(DOI = c("10.1010/DUMMY", "10.1010/DUNNY")))
+#'
+#' @export
+#' @return Paged data structure
+fetch_accessions <- function(filters = list(), page = 0, size = 100) {
+  resp <- post(path = "/acn/filter", query=list(p = page, s = size), body = filters)
+  jsonlite::fromJSON(httr::content(resp, "text"), simplifyVector = FALSE)
+}

genesys-R-client.Rproj

+Version: 1.0
+
+RestoreWorkspace: No
+SaveWorkspace: No
+AlwaysSaveHistory: No
+
+EnableCodeIndexing: Yes
+UseSpacesForTab: Yes
+NumSpacesForTab: 2
+Encoding: UTF-8
+
+RnwWeave: Sweave
+LaTeX: pdfLaTeX
+
+BuildType: Package
+PackageUseDevtools: Yes
+PackageInstallArgs: --no-multiarch --with-keep.source
+PackageRoxygenize: rd,collate,namespace