Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v1.1.0 #7

Merged
merged 21 commits into from
Oct 5, 2020
Merged

v1.1.0 #7

merged 21 commits into from
Oct 5, 2020

Conversation

vpnagraj
Copy link
Owner

@vpnagraj vpnagraj commented Oct 5, 2020

series of changes for the v1.1.0 release ... from NEWS.md:

This release includes a number of new features, more robust checks and internal logic, and many improvements to package documentation. Most significantly, this version introduces support for the Cross-Site Request Forgery (CSRF) token in OpenRefine API requests, which is required in certain API calls as of OpenRefine v3.3. This feature is now included in rrefine but operates internally and should be invisible to users. For more information the OpenRefine CSRF protection see: https://github.com/OpenRefine/OpenRefine/wiki/Changes-for-3.3#csrf-protection-changes

New Features

  • The refine_metadata() function is now exported and user-facing.
  • Users can now specify other hosts and/or ports for a running OpenRefine instance (default is still http://127.0.0.1:3333)
  • The refine_upload() function now checks file format based on extension, and allows both .csv and .tsv files to be uploaded.
  • Successful calls to refine_upload(..., open.browser=TRUE) will now redirect the user to the newly created project in the OpenRefine instance.
  • When exporting project data, users can now specify 'tsv' or 'csv' export format. Both will return a tibble with the data in R.
  • Messaging to the user is now more accurate and informative; messages include the given project id/name for the operation where appropriate.
  • The refine_upload() and refine_delete() functions now confirm success of operations by comparing metadata before/after POST requests.
  • The API to construct queries to OpenRefine is now standardized in the refine_query() internal helper function.
  • More robust documentation (inline and user-facing), including descriptions of return values and references to OpenRefine API endpoints used.
  • The refine_id() helper function now validates "project.id" against list of project ids in the running instance.
  • Added news.md to track release notes!

Bug Fixes

  • Calls to refine_delete() and refine_upload() now generate a CSFR token internally.

Tests

Tested with OpenRefine 3.2, 3.3, and 3.4.1 running on Linux and Mac OSX.

@vpnagraj vpnagraj merged commit 21b4cea into master Oct 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant