WordPressKit offers a clean and simple WordPress.com and WordPress.org network API.
Home Page: http://www.wordpress.com
License: GNU General Public License v2.0
WordPressKit offers a clean and simple WordPress.com and WordPress.org API.
WordPressKit-iOS is available through CocoaPods. To install it, simply add the following line to your Podfile:
pod "WordPressKit"WordPressKit-iOS is available under the GPLv2 license. See the LICENSE file for more info.
Implement class AtomicAuthenticationServiceRemote with a method to perform a GET request to:
No parameters are required although the bearer token must be sent.
The return valuewill be JSON data looking like this:
{"url":"https://atomicdiegotravel.wpcomstaging.com",
"cookies" [{
"expires":1582858181,
"path":"/",
"domain":"atomicdiegotravel.wpcomstaging.com",
"name":"wordpress_logged_in_<some_value>",
"value":"<data_removed>"
}]}Parse this return data into a new object type named RemoteCookie and return it on success.
To accommodate setting and updating authors (see wordpress-mobile/WordPress-iOS#9015, wordpress-mobile/WordPress-iOS#16269) the Post Service should send an authorID if provided.
The authorID is not set as a POST parameter if provided by the RemotePost.
Implement the endpoint to fetch the recent campaign for dashboard card
Design ref - 1Osrn9gb2xLaKG6lIft3WC-fi-1461_9777
The content you are editing has changed. Please copy your edits and refresh the page.
We're having trouble rendering your tasklist, it's most likely has one of the following formatting errors:
- [ ] on a line by itself)The changes in #78 support more consistent locale handling within WordPressKit, but a few services still explicitly set the locale parameter.
At the time of this writing, the following services set locale explicitly:
AccountServiceRemoteRESTActivityServiceRemote - two methodsPlanServiceRemotePlanServiceRemote_ApiVersion1_3ReaderSiteSearchServiceRemoteTimeZoneServiceRemoteWordPressComServiceRemoteWe should be able to remove this and rely on the implicit framework behavior.
N/A
All devices & versions of WordPressKit, Xcode & iOS.
N/A
The default behavior of WordPressComRestApi appends a locale parameter to requests. To do so, it inspects & modifies the path of a given request if needed.
If a caller were to specify locale in the request parameters, however, the specified value is not properly de-duplicated. For example, composing a GET request with the default behavior enabled, passing locale : foo in the request parameters evinces a request with the following URL : https://public-api.wordpress.com/wpcom/v2/<path>?locale=en&locale=foo.
The client should inspect the parameters associated with the request, and de-duplicate those if necessary. It might be worth using URLComponents for this purpose.
We have a new domains suggestion parameter which replaces all other parameters. Now, we simply pass segment_id=INT and if it matches a blog type, we'll get .blog subdomains back (coffee.shop.blog) along with the normal wordpress.com subdomains (coffee.wordpress.com)
If it doesn't match a blog type, we'll simply get wordpress.com subdomains back.
It should be possible to easily log the nature of HTTP invocations, including performance metrics, request & response content, and the like. This should be limited in Production contexts to both respect user privacy and conserve log resources.
URLSessionTaskDelegate might provide a centralized location to intercept requests & responses, as well as performance metrics via URLSessionTaskMetrics.
At the moment, it is possible to inspect this information via manual debugging, but the logging in-place is not uniform. Performance metrics require manual instrumentation, as observed in this PR.
N/A
WordPressKit v4.0.0 & beforeN/A
To promote consistency across WordPress-iOS frameworks & to conform to recommended community standards, we should update this repository to include all of the following:
We should also modify the PR checks we have in place for consistency with WordPress-iOS (e.g., build checks, approval / merge requirements, etc.).
Log entries shouldn't include sensitive data like bearer tokens.
When logging in with social login the entire response object is dumped to the log and exposes the bearer token to the app's log file.
2019/04/27 12:57:11:934 Received Social Login Oauth response: {
data = {
"bearer_token" = "manually redacted by me for demo purposes";
"token_links" = (
"https://jetpack.com/remote-login.php?wpcom_remote_login=validate&wpcomid=xx&token=xx&host=https%3A%2F%2Fjetpack.com"
);
};
success = 1;
}
WordPressKit should compile successfully and work correctly.
WordPressKit does not compile successfully with Xcode 10.2. When attempting to build it, the following error is reported:
~WordPressKit-iOS/WordPressKit/PlanServiceRemote_ApiVersion1_3.swift:9:23: Method cannot be marked @objc because the type of the parameter 2 cannot be represented in Objective-C
In this case, the tuple is problematic. Because it is not currently possible to consume this method from Objective-C, removing the annotation is arguable not a breaking change.
WordPressKit workspace & attempt to build with Xcode Version 10.2 (10E125).WordPressKit v3.2.0 & beforeN/A
No error in the logs when loading the Plan screen.
It seems the parser is expecting int values for the prices but they should instead be doubles.
2020-03-04 15:56:59:708 Error parsing plans response for site dataCorrupted(Swift.DecodingError.Context(codingPath: [CodingKeys(stringValue: "rawPrice", intValue: nil)], debugDescription: "Parsed JSON number <9.5> does not fit in Int.", underlyingError: nil))
ℹ I want to add and use this Package
ℹ Add fails and reports an error, if you force it then xcode will not compile and you will not be able to remove any Packages, once removed Xcode will exit with an error
ℹ
ℹ Xcode 16.0Beta Download Links: https://developer.apple.com/services-account/download?path=/Developer_Tools/Xcode_16_beta/Xcode_16_beta.xip
Parameters argument of multipartPOST function should be included in the POST request.
Parameters are not included.
multipartPOST function is only used in the following places:
MediaServiceRemoteREST.uploadProgress (one item version, multiple items version)PostServiceRemoteREST.createPost with media (looks like this function is not currently being used)The easiest way to reproduce the bug is by adding items from the free photo library as they include as the caption value its photo credit in the upload parameters.
+ button.Free Photo Library.Add button.No.
As per p77Llu-byF-p2, v2 endpoints must pass _locale rather than locale. Prior versions should still use locale.
From the perspective of semantic versioning, implementing this may be a breaking change.
In the default case where appendsPreferredLanguageLocale is true, a localization identifier is added to requests with a key of locale. This needs to change based on the endpoint version.
Inspect a request constructed via WordPressKit and scrutinize the query string. Note the value locale is used for all endpoint versions.
All devices & versions of WordPressKit, Xcode & iOS.
N/A
The podfile should point to the latest version of the wpxmlrpc pod. Once updated, run pod install to update the podfile.lock. The podspec should become 4.6.0-beta.1
Request construction & execution should be separate concerns.
As discussed in #78, responsibilities for request construction are shared between both ServiceRemoteWordPressComREST & WordPressComRestApi. WordPressComRestApi currently executes requests.
We might benefit from the approach taken by our Woo counterparts.
N/A
All devices & versions of WordPressKit, Xcode & iOS.
N/A
We need to change the logic here:
WordPressKit-iOS/WordPressKit/RemoteBlogOptionsHelper.m
Lines 19 to 34 in 19a2f18
So that we also map key is_wpcom_atomic directly making it accessible for Apps using this library.
Hello
Is there a demo or sample on how to setup/use this pod?
I am using this path: wp-json/wp/v2 to get the responses, is it supported ?
Thanks,
This is the result of running pod spec lint WordPressKit.podspec:
-> WordPressKit (1.5.0)
- WARN | url: There was a problem validating the URL http://apps.wordpress.com.
- NOTE | xcodebuild: note: Using new build system
- NOTE | [iOS] xcodebuild: note: Planning build
- NOTE | [iOS] xcodebuild: note: Constructing build description
- NOTE | [iOS] xcodebuild: warning: Skipping code signing because the target does not have an Info.plist file. (in target 'App')
- WARN | xcodebuild: wpxmlrpc/WPXMLRPC/WPXMLRPCEncoder.h:50:9: warning: parameter 'parameters' not found in the function declaration [-Wdocumentation]
- NOTE | xcodebuild: wpxmlrpc/WPXMLRPC/WPXMLRPCEncoder.h:50:9: note: did you mean 'params'?
- WARN | xcodebuild: wpxmlrpc/WPXMLRPC/WPXMLRPCEncoder.h:92:3: warning: '@param' command used in a comment that is not attached to a function declaration [-Wdocumentation]
We should clean this up to build cleanly.
Access tokens, bearer tokens, and token links should not print out in the console log, nor the Activity Logs.
bearer_token, token_links.Expected: The values should be redacted
Actual: They are not redacted
We should adapt the framework to support Swift 5.
At the moment the framework uses Swift 4.2.
For all targets in the project, SWIFT_VERSION is currently set to 4.2.
WordPressKit v1.8.0 & beforeBy default, the endpoint returning data for StatsPostingStreakInsight returns a limited amount of data (around ~1k datapoints), which on high-traffic sites can be not enough data to show a years worth of posting activity.
We should bump that limit up and ask for a specific time-frame of data.
Fetch the campaigns using the new endpoint which supports sort/filter and pagination logic
Design ref - 1Osrn9gb2xLaKG6lIft3WC-fi-1461_9777
The content you are editing has changed. Please copy your edits and refresh the page.
This method is not being called anymore.
A quick ack of the repo shows whitelist and blacklist referenced in several places. Let's update these references in our code and repo documentation (e.g. README) to use more inclusive terms. Suggestions: allowlist or blockedlist. For references in third-party libs, we can see if there is an updated version of that lib and whether there is any blockers to switching to that version.
Refs wordpress-mobile/WordPress-iOS#15522
See wp.me/paaHJt-15h-p2 for more.
When retrying a request due to the response error 401 - Unauthorized (reference), we should ensure that only one login sequence is triggered at a time.
Currently, we check the value of isAuthenticating for this purpose. However, it's never set to true, and therefore the login sequence can be triggered several times. This might lead to generating a lot of login requests, and in some cases API request blocks due to a high volume of login attempts, if such restrictions are set up in the hosting.
Preparation:
Reproducing this issue requires modifying somehow the requests to fail with status code 401. This can be achieved by using a proxy, like the Charles proxy app, and rewriting the responses to return the desired status code.
CookieNonceAuthenticator and select one endpoint for modifying its response.401 (this can be achieved with a proxy and bypassing requests).More information about this issue can be found in p1650593568370329-slack-C011BKNU1V5.
It should be possible to replace manually configured RFC3339 DateFormatter instances with ISO8601DateFormatter.
Examples include both NSDate+WordPressJSON.m & WPStatsServiceRemote.m
N/A
WordPressKit v2.1.1 & beforeN/A
This will let us create different classes for each kind of content (Comment, User, etc...)
This is part of the Extract Notification Interactions project
By default, WordPressComRestApi automatically appends locale to requests when appendsPreferredLanguageLocale is enabled (i.e., the default state). For requests where nil parameters are passed to WordPressComRestApi.buildRequestURLFor(path:parameters:), locale is does not honor that request.
Requests that specify locale are not impacted.
Passing nil to WordPressComRestApi.buildRequestURLFor(path:parameters:) should result in a URL that includes locale when appendsPreferredLanguageLocale is enabled.
WordPressKit v2.0.0 & laterSee related discussion in p1551132833014600-slack-build-and-ship.
RemoteBlog.hasPaidPlan should return true on WP.com sites that have a paid plan, false otherwise.
The logic of RemoteBlog.hasPaidPlan is reversed. It returns true on WP.com sites that have a free plan, otherwise true.
I noticed this when calling hasPaidPlans in wordpress-mobile/WordPress-iOS#20163. It unexpectedly returned false on a site that has a paid plan.
6.1.0-betaIn #558, it appears that the refactor inadvertently flipped the logic on the hasPaidPlan bool.
Let's consolidate on using or the standard URLSession for the simple cases, or using AlamoFire for the more complex needs.
In order to fully support Swift 5 and to remove the warning in Xcode, Alamofire will need migrated from 4.x to 5.x. There are significant breaking changes involved, which is why this was not addressed during the current hack week.
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.