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

changed endpoints in metadata api 2.0 #77

Merged
merged 3 commits into from
Feb 23, 2024

Conversation

charlottekostelic
Copy link
Contributor

@charlottekostelic charlottekostelic commented Feb 22, 2024

  • added W503 (line break before binary operator) to flake8 per-file-ignores for tests
  • added new base url for Metadata API 2.0
  • changed get_full_bib:
    • changed response_format options to allow for MARCXML and MARC21
  • changed holding_get_status to get_institution_holdings
    • changed args based on updated endpoint
  • changed holding_set and holding_unset
    • added new, separate endpoints for each method
    • removed args based on changes to endpoints
  • changed search_current_control_numbers to get_current_oclc_number
    • removed response_format as arg and changed default to application/json
  • refactored tests based on changes to methods
  • removed stale token tests for the above methods

Copy link
Member

@klinga klinga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great @charlottekostelic. I included two or three small suggestions. See below.

bookops_worldcat/metadata_api.py Show resolved Hide resolved
bookops_worldcat/metadata_api.py Show resolved Hide resolved
bookops_worldcat/metadata_api.py Show resolved Hide resolved
bookops_worldcat/metadata_api.py Show resolved Hide resolved
bookops_worldcat/metadata_api.py Show resolved Hide resolved
bookops_worldcat/metadata_api.py Show resolved Hide resolved
@charlottekostelic charlottekostelic merged commit c493886 into releases/v1.0.0 Feb 23, 2024
6 checks passed
@charlottekostelic charlottekostelic deleted the changed-endpoints branch February 23, 2024 19:09
charlottekostelic added a commit that referenced this pull request Mar 26, 2024
* move cov & pytest config to pyproject.toml

* remove temp file

* remove pytest-recording

* add py311

* dependencies updates

* drop py3.7

* copy main config

* drop py3.7

* add requests to dev dependencies

* fix missing dependencies

* dependencies final update

* version bump to 1.0.0

* adds all dependencies

* add py3.12

* typing cleanup & tests refactoring

* Authentication updates (#69)

* ingnore E501 in tests

* add types-requests to dev dependencies

* scopes as str

* scopes as str & types cleanup

* dev dependencies moved to tool.poetry.group.dev.dependencies section

* token_expires_at as datetime obj

* token_expires_at as datetime

* changed utcnow to now(timezone.utc) (#71)

* Ocn-parsing-refactor (#72)

* prep_oclc_numbe_strr refactor

* oclcNumber stripped

* verification refactor

* utc fixes (#73)

* fixed datetime type errors

* moved datetime edits to _hasten_expiration_time

* Errors-refactor (#74)

* removed WorldcatSessionError

* incorrect AttributeError replaced with TypeError

* replaces WorldcatAuthorizationError with TypeError and ValueError for configuration

* removed unused WorldcatAuthorizationError import

* removed unused WorldcatRequestError import

* added safe decoding for bytes-str

* ignore F401

* None type added to possible timeout types

* added type ingnore

* removed unused InvalidOclcNumber import & typing fixes

* changed endpoints in metadata api 2.0 (#77)

* changed endpoints in metadata api 2.0

* fixed tests with typos

* changed response_format default in get_full_bib

* Changed search endpoints (#78)

* changed search endpoints in metadata api 2.0

* fixed types

* fixed spacing and indentation

* type hint fixes and refactored test

* Removed principalID and principalIDNS from token requests (#79)

* removed unnecessary params from token requests

* fixed docstring

* MetadataSession cleanup (#80)

* reordered methods in MetadataSession

* removed obsolete 409 error handling from query.py

* simplified changes

* added new api endpoints (#81)

* added new api endpoints

* added tests

* added test

* added to doc string, fixed typos (#82)

@charlottekostelic This is something that should be brought to users attention in the documentation. Will create an issue as a reminder.
Besides that, looks good. Thanks!

* Query updates (#84)

* work in progress

* added retries to query

* removed test with stale token

* added stale token test back in

* added stale token test back in

* moved retries to _session module, added tests

* added retry status_forcelist tests

* added custom adapter test

* changed default retry behavior

* added another test

* more testing

* Reordered metadata methods (#85)

* renamed/reordered metadata_api methods

* fixed optional/required args, added to doc strings

* fixed default values to match API defaults

* fixed error in live test

* dev status update to 5, removes py3.7 & adds py3.11 & py3.12 (#87)

* Update docs (#88)

* reorganized docs, added mkdocs-material theme

* added css for NYPL colors

* reorganized docs, added examples

* changed structure of docs, added to docs

* changed snake case to camel case in args

* typo fixes

* added contributing.md, python versions for black

* added 1.0 to changelog, migration section in docs

* Added migration section to README

* typo fixes, link fixes

* added py.typed file

* fixed links, made edits per PR 88

* added mkdocstrings, removed mkapi, doc edits (#91)

* edited changelog

* pyproject.toml edits

* update unit-tests.yaml

* fixed unit-tests.yaml

* unit-tests.yaml indentation issues

---------

Co-authored-by: klinga <klingaroo@gmail.com>
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.

2 participants