Skip to content

Commit d31eb68

Browse files
author
Tyler King
committed
Updated CHANGELOG format, upgraded PHP Github Actions to v2
1 parent 2787ccd commit d31eb68

File tree

2 files changed

+102
-99
lines changed

2 files changed

+102
-99
lines changed

.github/workflows/ci.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ jobs:
99
strategy:
1010
max-parallel: 2
1111
matrix:
12-
php-versions: ['7.2', '7.4']
12+
php-versions: ['7.2', '7.4', '8.0']
1313

1414
name: PHP ${{ matrix.php-versions }}
1515

1616
steps:
1717
- name: Checkout
1818
uses: actions/checkout@v2
19-
19+
2020
- name: Setup PHP
21-
uses: shivammathur/setup-php@v1
21+
uses: shivammathur/setup-php@v2
2222
with:
2323
php-version: ${{ matrix.php-versions }}
2424
coverage: xdebug
@@ -39,7 +39,7 @@ jobs:
3939
run: composer run-script test
4040

4141
- name: Upload coverage results
42-
if: matrix.php-versions == '7.4'
42+
if: matrix.php-versions == '8.0'
4343
env:
4444
COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
4545
run: |

CHANGELOG.md

Lines changed: 98 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -1,172 +1,175 @@
11
# CHANGELOG
22

3-
# 10.0.0
3+
## 10.0.1
44

5-
+ Bump Guzzle to version 8 from 7 (#83)
5+
* Fix for Graph API limit calls not accessing the correct index for last call data
6+
## 10.0.0
67

7-
# 9.1.4
8+
* Bump Guzzle to version 8 from 7 (#83)
89

9-
+ Implemented toArray method, mainly used for Laravel integration
10+
## 9.1.4
1011

11-
# 9.1.3
12+
* Implemented toArray method, mainly used for Laravel integration
1213

13-
+ Fix to allow for overriding request type for data (#80)
14+
## 9.1.3
1415

15-
# 9.1.2
16+
* Fix to allow for overriding request type for data (#80)
1617

17-
+ Oauth error handling (#77).
18+
## 9.1.2
1819

19-
# 9.1.1
20+
* Oauth error handling (#77).
2021

21-
+ Implemented `Iterable` and `Countable` on `ResponseAccess`
22-
+ Added methods `keys` and `values` to allow for getting keys and values easier
23-
+ Add JSON serilize method
22+
## 9.1.1
2423

25-
# 9.1.0
24+
* Implemented `Iterable` and `Countable` on `ResponseAccess`
25+
* Added methods `keys` and `values` to allow for getting keys and values easier
26+
* Add JSON serilize method
2627

27-
+ Rate limiting for REST has been improved to use a moving window method
28-
+ `Sleep` deferrer now returns a float for the time microtime
29-
+ `Memory` store now has a `reset` method to support the new rate limiting
30-
+ `Memory` now accepts more then two values to support the new rate limiting
28+
## 9.1.0
3129

32-
# 9.0.0
30+
* Rate limiting for REST has been improved to use a moving window method
31+
* `Sleep` deferrer now returns a float for the time microtime
32+
* `Memory` store now has a `reset` method to support the new rate limiting
33+
* `Memory` now accepts more then two values to support the new rate limiting
34+
35+
## 9.0.0
3336

3437
*Contains breaking changes*; Consult `UPGRADING.md`.
3538

36-
+ Library refactored and split up, no longer one file
37-
+ Auth header handling moved into Guzzle middleware
38-
+ API versioning handler moved into Guzzle middleware
39-
+ Rate limiting improved and now available for GraphQL
40-
+ Options moved into its own configuration class
41-
+ "Retry" ability now built-in via `guzzle_retry_middleware` which respects Shopify's 'X-Retry-After' header
42-
+ API responses are now mapped into a response class which can be accessed as an array or object
43-
+ Storage of how/where rate limits, request times, and others are now changable with the `StateStorage` interface, and a default in-memory storage class provided
44-
+ Both GraphQL and REST success and error returns have been normalized
39+
* Library refactored and split up, no longer one file
40+
* Auth header handling moved into Guzzle middleware
41+
* API versioning handler moved into Guzzle middleware
42+
* Rate limiting improved and now available for GraphQL
43+
* Options moved into its own configuration class
44+
* "Retry" ability now built-in via `guzzle_retry_middleware` which respects Shopify's 'X-Retry-After' header
45+
* API responses are now mapped into a response class which can be accessed as an array or object
46+
* Storage of how/where rate limits, request times, and others are now changable with the `StateStorage` interface, and a default in-memory storage class provided
47+
* Both GraphQL and REST success and error returns have been normalized
4548

46-
# 8.2.0
49+
## 8.2.0
4750

48-
+ Added `bodyArray` to response object of rest and graph, this is the same as `body` except instead of a stdClass being returned, its an array.
51+
* Added `bodyArray` to response object of rest and graph, this is the same as `body` except instead of a stdClass being returned, its an array.
4952

50-
# 8.1.0
53+
## 8.1.0
5154

52-
+ Added response to error callback function (#64)
53-
+ Allow for additional client creation options (#65)
55+
* Added response to error callback function (#64)
56+
* Allow for additional client creation options (#65)
5457

55-
# 8.0.0
58+
## 8.0.0
5659

57-
+ Added return types to all functions.
58-
+ Added async support for GraphQL via `graphAsync`.
59-
+ Added support for call to `/admin/oauth/access_scopes.json`.
60+
* Added return types to all functions.
61+
* Added async support for GraphQL via `graphAsync`.
62+
* Added support for call to `/admin/oauth/access_scopes.json`.
6063

61-
# 6.1.2
64+
## 6.1.2
6265

63-
+ Fix for REST calls not properly building error object (#47).
66+
* Fix for REST calls not properly building error object (#47).
6467

65-
# 6.1.1
68+
## 6.1.1
6669

67-
+ Fixed `extractHeaderLink` for #45, to include both `next` and `previous`.
70+
* Fixed `extractHeaderLink` for #45, to include both `next` and `previous`.
6871

69-
# 6.1.0
72+
## 6.1.0
7073

71-
+ Adds support for `Link` header (#39)
74+
* Adds support for `Link` header (#39)
7275

73-
# 6.0.0
76+
## 6.0.0
7477

75-
+ Added ability to do Guzzle sync and async requests through Promises.
76-
+ `errors` now returns a boolean instead of an object. `body` now contains the error response.
78+
* Added ability to do Guzzle sync and async requests through Promises.
79+
* `errors` now returns a boolean instead of an object. `body` now contains the error response.
7780

78-
# 5.5.0
81+
## 5.5.0
7982

80-
+ Added ability to use custom headers in REST calls.
83+
* Added ability to use custom headers in REST calls.
8184

82-
# 5.4.0
85+
## 5.4.0
8386

84-
+ Added option to supply a PSR-compatible logger via `setLogger`.
87+
* Added option to supply a PSR-compatible logger via `setLogger`.
8588

86-
# 5.3.3
89+
## 5.3.3
8790

88-
+ Added matching to ignore certain oauth paths.
91+
* Added matching to ignore certain oauth paths.
8992

90-
# 5.3.2
93+
## 5.3.2
9194

92-
+ Added for for issue #24 in detection of what an authable request is.
95+
* Added for for issue #24 in detection of what an authable request is.
9396

94-
# 5.3.1
97+
## 5.3.1
9598

96-
+ Fixed merged in to prevent versioning on access token calls.
99+
* Fixed merged in to prevent versioning on access token calls.
97100

98-
# 5.3.0
101+
## 5.3.0
99102

100-
+ Added support for versioned API calls for both REST and GraphAPI
101-
+ New `setVersion(string $version)` method added, and new `getVersion()` method added
103+
* Added support for versioned API calls for both REST and GraphAPI
104+
* New `setVersion(string $version)` method added, and new `getVersion()` method added
102105

103-
# 5.2.0
106+
## 5.2.0
104107

105-
+ Added ability for `per-user` authentication. There is now ability to set/grab a user from authentication.
106-
+ `requestAndSetAccess(string $code)` method added which will automatically set the access token and user (if applicable) to the API instance for you as a helper method.
108+
* Added ability for `per-user` authentication. There is now ability to set/grab a user from authentication.
109+
* `requestAndSetAccess(string $code)` method added which will automatically set the access token and user (if applicable) to the API instance for you as a helper method.
107110

108-
# 5.1.0
111+
## 5.1.0
109112

110-
+ Added a `authRequest` middleware to Guzzle which handles adding all needed headers and checking required API keys to run those requests
111-
+ Fixed issue for redirect not working
113+
* Added a `authRequest` middleware to Guzzle which handles adding all needed headers and checking required API keys to run those requests
114+
* Fixed issue for redirect not working
112115

113-
# 5.0.0
116+
## 5.0.0
114117

115118
*Possible breaking release depending on how you handle errors*
116119

117-
+ 400-500 errors are now captured internally and accessible through the resulting object (#16)
118-
+ Middleware was added to the Guzzle requests to fix redirections (#16)
120+
* 400-500 errors are now captured internally and accessible through the resulting object (#16)
121+
* Middleware was added to the Guzzle requests to fix redirections (#16)
119122

120-
# 4.0.2
123+
## 4.0.2
121124

122-
+ Changes to the response of GraphQL calls to better check for errors.
125+
* Changes to the response of GraphQL calls to better check for errors.
123126

124-
# 4.0.1
127+
## 4.0.1
125128

126-
+ Update for more accurate timing
129+
* Update for more accurate timing
127130

128-
# 4.0.0
131+
## 4.0.0
129132

130-
+ Added rate limiting abilities (basic)
133+
* Added rate limiting abilities (basic)
131134

132-
# 3.0.3
135+
## 3.0.3
133136

134-
+ Fix for #13 for requests where call limit header is not always supplied
137+
* Fix for #13 for requests where call limit header is not always supplied
135138

136-
# 3.0.2
139+
## 3.0.2
137140

138-
+ Adjusted API to work better with Shopify's implementation of GraphQL (#10)
139-
+ `graph()` call now accepts two arguments, `graph(string $query, array $variables = [])`
141+
* Adjusted API to work better with Shopify's implementation of GraphQL (#10)
142+
* `graph()` call now accepts two arguments, `graph(string $query, array $variables = [])`
140143

141-
# Vesion 3.0.1
144+
## 3.0.1
142145

143-
+ Fix to obtaining access token
146+
* Fix to obtaining access token
144147

145-
# Version 3.0.0
148+
## 3.0.0
146149

147150
*Contains breaking changes*
148151

149152
To better the library, it has been reverted back to its original single-class form and backwards compatibile with 1.x.x
150153

151-
+ GraphQL and REST are all under one class
152-
+ `getApiCalls()` now takes two arguments, first being rest|graph, second being the key
153-
+ `rest()` is now for REST calls
154-
+ `graph()` is now for GraphQL calls
155-
+ `request()` is aliased to `rest()` for backward compatibility
154+
* GraphQL and REST are all under one class
155+
* `getApiCalls()` now takes two arguments, first being rest|graph, second being the key
156+
* `rest()` is now for REST calls
157+
* `graph()` is now for GraphQL calls
158+
* `request()` is aliased to `rest()` for backward compatibility
156159

157-
# Version 2.0.0
160+
## 2.0.0
158161

159162
*Contains breaking changes*
160163

161-
+ No longer a single file, it now namespaced under `OhmyBrew\ShopifyAPI`
162-
+ GraphQL is now introduced under `Osiset\ShopifyAPI\GraphAPI`
163-
+ REST is moved to `Osiset\ShopifyAPI\RestAPI`
164+
* No longer a single file, it now namespaced under `OhmyBrew\ShopifyAPI`
165+
* GraphQL is now introduced under `Osiset\ShopifyAPI\GraphAPI`
166+
* REST is moved to `Osiset\ShopifyAPI\RestAPI`
164167

165-
# Version 1.0.1
168+
## 1.0.1
166169

167-
+ Fixed issue #3 by @ncpope, for newly created stores (after December 2017) not accepting GET body
170+
* Fixed issue #3 by @ncpope, for newly created stores (after December 2017) not accepting GET body
168171

169-
# Version 1.0.0
172+
## 1.0.0
170173

171-
+ Basic API code implemented
172-
+ Tests completed with full coverage
174+
* Basic API code implemented
175+
* Tests completed with full coverage

0 commit comments

Comments
 (0)