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

feat: add setServiceUrl method as a setter for the serviceUrl property #41

Merged
merged 1 commit into from
Sep 10, 2019

Conversation

dpopp07
Copy link
Member

@dpopp07 dpopp07 commented Sep 10, 2019

Also...

  • Change url to serviceUrl
  • Validate that serviceUrl is set in the sendRequest method
  • Make "auth type" case-insensitive
  • Throw an error for unsupported "auth types" - only default to 'iam' when no "auth type" is provided

BREAKING CHANGE: The internal property url no longer exists on the baseOptions object, it has been renamed to serviceUrl

Tests and migration guide updated.

…perty

* Change `url` to `serviceUrl`
* Validate that `serviceUrl` is set in the `sendRequest` method
* Make "auth type" case-insensitive
* Throw an error for unsupported "auth types" - only default to 'iam' when no "auth type" is provided

BREAKING CHANGE: The internal property `url` no longer exists on the `baseOptions` object, it has been renamed to `serviceUrl`
@dpopp07 dpopp07 requested review from padamstx and mediumTaj and removed request for padamstx and mediumTaj September 10, 2019 16:17
@CLAassistant
Copy link

CLAassistant commented Sep 10, 2019

CLA assistant check
All committers have signed the CLA.

@codecov
Copy link

codecov bot commented Sep 10, 2019

Codecov Report

Merging #41 into release-candidate-v1 will increase coverage by 0.08%.
The diff coverage is 100%.

Impacted file tree graph

@@                   Coverage Diff                    @@
##           release-candidate-v1      #41      +/-   ##
========================================================
+ Coverage                 95.88%   95.96%   +0.08%     
========================================================
  Files                        23       23              
  Lines                       583      595      +12     
  Branches                    127      131       +4     
========================================================
+ Hits                        559      571      +12     
  Misses                       23       23              
  Partials                      1        1
Impacted Files Coverage Δ
lib/requestwrapper.ts 85.18% <100%> (+0.33%) ⬆️
auth/utils/get-authenticator-from-environment.ts 100% <100%> (ø) ⬆️
lib/base_service.ts 100% <100%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ddcccfd...3278ddf. Read the comment docs.

Copy link
Member

@padamstx padamstx left a comment

Choose a reason for hiding this comment

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

LGTM

@dpopp07 dpopp07 merged commit f425a33 into release-candidate-v1 Sep 10, 2019
@dpopp07 dpopp07 deleted the parameterized-url-changes branch September 10, 2019 18:03
mkistler pushed a commit that referenced this pull request Sep 17, 2019
…perty (#41)

* Change `url` to `serviceUrl`
* Validate that `serviceUrl` is set in the `sendRequest` method
* Make "auth type" case-insensitive
* Throw an error for unsupported "auth types" - only default to 'iam' when no "auth type" is provided

BREAKING CHANGE: The internal property `url` no longer exists on the `baseOptions` object, it has been renamed to `serviceUrl`
dpopp07 added a commit that referenced this pull request Oct 3, 2019
…perty (#41)

* Change `url` to `serviceUrl`
* Validate that `serviceUrl` is set in the `sendRequest` method
* Make "auth type" case-insensitive
* Throw an error for unsupported "auth types" - only default to 'iam' when no "auth type" is provided

BREAKING CHANGE: The internal property `url` no longer exists on the `baseOptions` object, it has been renamed to `serviceUrl`
dpopp07 added a commit that referenced this pull request Oct 3, 2019
…perty (#41)

* Change `url` to `serviceUrl`
* Validate that `serviceUrl` is set in the `sendRequest` method
* Make "auth type" case-insensitive
* Throw an error for unsupported "auth types" - only default to 'iam' when no "auth type" is provided

BREAKING CHANGE: The internal property `url` no longer exists on the `baseOptions` object, it has been renamed to `serviceUrl`
ibm-devx-automation pushed a commit that referenced this pull request Oct 3, 2019
# [1.0.0](v0.3.6...v1.0.0) (2019-10-03)

### Bug Fixes

* Move check for serviceUrl to createRequest ([#47](#47)) ([6f04739](6f04739))
* parse result from response in token managers ([6bbe423](6bbe423))
* provide bundlers alternate file for browser support ([#58](#58)) ([88a9d16](88a9d16))

### Build System

* drop support for Node versions 6 and 8 ([#33](#33)) ([d47c737](d47c737))

### Code Refactoring

* look for credentials file in working dir before home dir ([#46](#46)) ([c5556de](c5556de))
* return detailed response as second callback argument ([#34](#34)) ([dc24154](dc24154))

### Features

* add `setServiceUrl` method as a setter for the `serviceUrl` property ([#41](#41)) ([cfb188f](cfb188f))
* add specific error handling for SSL errors with cloud private instances ([#54](#54)) ([056ec9a](056ec9a))
* export `UserOptions` interface from the BaseService ([#50](#50)) ([4f0075a](4f0075a))
* implement new authenticators to handle sdk authentication ([#37](#37)) ([f876b6d](f876b6d))
* refactor core to use Promises instead of callbacks ([#55](#55)) ([9ec8afd](9ec8afd))

### BREAKING CHANGES

* None of the authenticators or request methods take callbacks as arguments anymore - they return Promises instead.
* Users that have credential files in both the working directory and the home directory will see a change in which one is used.
* The internal property `url` no longer exists on the `baseOptions` object, it has been renamed to `serviceUrl`
* The old style of passing credentials to the base service will no longer work. An Authenticator instance MUST be passed in to the base service constructor.
* token managers no longer support user access tokens. use BearerTokenAuthenticator instead
* The class names of the token managers have changed.
* `Icp4dTokenManagerV1` renamed to `Cp4dTokenManager`
* `IamTokenManagerV1` renamed to `IamTokenManager`
* `JwtTokenManagerV1` renamed to `JwtTokenManager`
* The public method `setAuthorizationInfo` is renamed to `setClientIdAndSecret`
* The response body is no longer the 2nd callback argument, the detailed response is. The body is located under the `result` property. The `data` property is removed.
* This SDK may no longer work with applications running on Node 6 or 8.
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.

3 participants