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

Expose Customized Publish Popup Message through API-Publish #3156

Closed
shlake opened this issue Jun 2, 2016 · 7 comments
Closed

Expose Customized Publish Popup Message through API-Publish #3156

shlake opened this issue Jun 2, 2016 · 7 comments

Comments

@shlake
Copy link
Contributor

shlake commented Jun 2, 2016

UVa has a configured popup message (thanks to the resolution of the following issue: #2833).

Our configured popup message needs to pass through when a "publish" request is sent via the API. For UVa, it is OK to expose this popup without an API token.

@pdurbin
Copy link
Member

pdurbin commented Jun 6, 2016

@jacksonokuhn and I discussed this issue briefly on Friday as I was heading out the door and he seemed eager to work on it, which is fantastic, so I'm assigning it to him.

On a dev box we want curl http://localhost:8080/api/system/settings/:DatasetPublishPopupCustomText (no authentication) to return a JSON representation of that database setting.

The API endpoint should be documented in the API Guide on the "native" page under a new "System" heading.

A REST Assured test should be included to exercise and validate the code: http://bl.ocks.org/pdurbin/raw/814fd29916749523db9a

See also CenterForOpenScience/osf.io#5344 about how the reason for this feature is so that https://dataverse.lib.virginia.edu can be integrated with https://osf.io , a very noble cause! 😄

As I was saying to @djbrooke I'll probably take the pull request for this issue (once it exists) and merge it with the branch from pull request #3137 for deployment to https://dev1.dataverse.org so that @shlake and @mfraezz can test both changes at once.

I'm sort of wondering how often @shlake intends to change the text and how often @mfraezz will configure OSF to poll for it. I assume the text won't change very often. Unfortunately, there's no "last updated" column on the setting table: http://phoenix.dataverse.org/schemaspy/latest/tables/setting.html T-T . Adding this is out of scope for this issue, I'd say.

@jacksonokuhn jacksonokuhn mentioned this issue Jun 9, 2016
11 tasks
jacksonokuhn added a commit to jacksonokuhn/dataverse that referenced this issue Jun 10, 2016
@jacksonokuhn jacksonokuhn mentioned this issue Jun 10, 2016
11 tasks
jacksonokuhn added a commit to jacksonokuhn/dataverse that referenced this issue Jun 10, 2016
jacksonokuhn added a commit to jacksonokuhn/dataverse that referenced this issue Jun 10, 2016
pdurbin added a commit that referenced this issue Jun 13, 2016
For example:

mvn test -Dtest=SysIT -Ddataverse.test.baseurl='https://dev1.dataverse.org'
@pdurbin
Copy link
Member

pdurbin commented Jun 13, 2016

@shlake thanks for opening this issue. At CenterForOpenScience/osf.io#5344 (comment) I'm asking if you can help us test a fix by @jacksonokuhn on a dev server.

Either way, I'll go ahead and pass this issue to QA. @kcondon you can test the fix in isolation at #3166 or combined with the SWORD auth bug fix in #3167

@kcondon
Copy link
Contributor

kcondon commented Jul 19, 2016

Leaving in QA but removing my name until I get pull request.

@pdurbin
Copy link
Member

pdurbin commented Jul 26, 2016

We discussed the pull request at #3166 and decided to use "info" rather than "system" in the URL of this API endpoint. I just created a new pull request at #3219 to address this change.

Passing to QA.

@djbrooke djbrooke added this to the 4.5 milestone Jul 26, 2016
@kcondon
Copy link
Contributor

kcondon commented Jul 27, 2016

Reassign it to the person and say it needs CR before QA as was agreed upon by the team, move it back into the development column

@pdurbin
Copy link
Member

pdurbin commented Jul 27, 2016

@scolapasta please code review pull request #3219 and if you're ok with how it looks, please move this issue through the pipeline to QA.

@pdurbin pdurbin assigned scolapasta and unassigned pdurbin Jul 27, 2016
@scolapasta scolapasta removed their assignment Jul 27, 2016
pdurbin added a commit that referenced this issue Jul 28, 2016
We don't want this integration test to execute on build because it has
dependencies on Glassfish, Postgres, etc. We'll kick it off post-deploy.
@kcondon
Copy link
Contributor

kcondon commented Jul 28, 2016

The actual command is: curl http://localhost:8080/api/info/settings/:DatasetPublishPopupCustomText

The solution is instead of displaying this tou during a publish api call, instead make the tou text accessible by the above api call so the OSF/DV integration and implement business rules of fetching, displaying, and requiring agreement to the custom tou.

Docs are also in place.

@kcondon kcondon closed this as completed Jul 28, 2016
kcondon added a commit that referenced this issue Jul 28, 2016
Expose :DatasetPublishPopupCustomText via API #3156
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

6 participants