Niedzielski has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/333453 )
Change subject: Hygiene: rename Retrofit *Endpoints* to Service
......................................................................
Hygiene: rename Retrofit *Endpoints* to Service
Service terminology has become more prevalent in our codebase when
referring to Retrofitted API endpoints. Rename remaining endpoints
usages to service
Change-Id: Ib9365c3c624abefc0baa6ec0f553eb1574a4977a
---
M app/src/main/java/org/wikipedia/dataclient/retrofit/MwCachedService.java
M app/src/main/java/org/wikipedia/dataclient/retrofit/RbCachedService.java
M app/src/main/java/org/wikipedia/edit/preview/EditPreviewClient.java
D app/src/main/java/org/wikipedia/server/mwapi/MwPageEndpointsCache.java
M app/src/main/java/org/wikipedia/server/mwapi/MwPageService.java
A app/src/main/java/org/wikipedia/server/mwapi/MwPageServiceCache.java
M app/src/main/java/org/wikipedia/server/restbase/RbPageService.java
R app/src/main/java/org/wikipedia/server/restbase/RbPageServiceCache.java
M app/src/main/java/org/wikipedia/settings/DeveloperSettingsFragment.java
9 files changed, 88 insertions(+), 88 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/apps/android/wikipedia
refs/changes/53/333453/1
diff --git
a/app/src/main/java/org/wikipedia/dataclient/retrofit/MwCachedService.java
b/app/src/main/java/org/wikipedia/dataclient/retrofit/MwCachedService.java
index aa1edb4..d101492 100644
--- a/app/src/main/java/org/wikipedia/dataclient/retrofit/MwCachedService.java
+++ b/app/src/main/java/org/wikipedia/dataclient/retrofit/MwCachedService.java
@@ -3,7 +3,7 @@
import android.support.annotation.NonNull;
import org.wikipedia.dataclient.WikiSite;
-import org.wikipedia.server.mwapi.MwPageEndpointsCache;
+import org.wikipedia.server.mwapi.MwPageServiceCache;
import retrofit2.Retrofit;
@@ -13,6 +13,6 @@
}
@NonNull @Override protected Retrofit create(@NonNull WikiSite wiki) {
- return MwPageEndpointsCache.retrofit(wiki);
+ return MwPageServiceCache.retrofit(wiki);
}
}
\ No newline at end of file
diff --git
a/app/src/main/java/org/wikipedia/dataclient/retrofit/RbCachedService.java
b/app/src/main/java/org/wikipedia/dataclient/retrofit/RbCachedService.java
index 17b55cf..e9bc878 100644
--- a/app/src/main/java/org/wikipedia/dataclient/retrofit/RbCachedService.java
+++ b/app/src/main/java/org/wikipedia/dataclient/retrofit/RbCachedService.java
@@ -3,7 +3,7 @@
import android.support.annotation.NonNull;
import org.wikipedia.dataclient.WikiSite;
-import org.wikipedia.server.restbase.RbPageEndpointsCache;
+import org.wikipedia.server.restbase.RbPageServiceCache;
import retrofit2.Retrofit;
@@ -13,6 +13,6 @@
}
@NonNull @Override protected Retrofit create(@NonNull WikiSite wiki) {
- return RbPageEndpointsCache.retrofit(wiki);
+ return RbPageServiceCache.retrofit(wiki);
}
}
\ No newline at end of file
diff --git
a/app/src/main/java/org/wikipedia/edit/preview/EditPreviewClient.java
b/app/src/main/java/org/wikipedia/edit/preview/EditPreviewClient.java
index aee0a35..61b276b 100644
--- a/app/src/main/java/org/wikipedia/edit/preview/EditPreviewClient.java
+++ b/app/src/main/java/org/wikipedia/edit/preview/EditPreviewClient.java
@@ -7,7 +7,7 @@
import org.wikipedia.dataclient.retrofit.MwCachedService;
import org.wikipedia.dataclient.retrofit.RetrofitException;
import org.wikipedia.page.PageTitle;
-import org.wikipedia.server.restbase.RbPageEndpointsCache;
+import org.wikipedia.server.restbase.RbPageServiceCache;
import retrofit2.Call;
import retrofit2.Response;
@@ -19,7 +19,7 @@
class EditPreviewClient {
@NonNull private final MwCachedService<Service> cachedService
= new MwCachedService<>(Service.class);
- @NonNull private final Retrofit retrofit =
RbPageEndpointsCache.INSTANCE.getRetrofit();
+ @NonNull private final Retrofit retrofit =
RbPageServiceCache.INSTANCE.getRetrofit();
Call<EditPreview> request(@NonNull WikiSite wiki, @NonNull PageTitle title,
@NonNull String wikitext, @NonNull Callback cb) {
diff --git
a/app/src/main/java/org/wikipedia/server/mwapi/MwPageEndpointsCache.java
b/app/src/main/java/org/wikipedia/server/mwapi/MwPageEndpointsCache.java
deleted file mode 100644
index 151cbe7..0000000
--- a/app/src/main/java/org/wikipedia/server/mwapi/MwPageEndpointsCache.java
+++ /dev/null
@@ -1,45 +0,0 @@
-package org.wikipedia.server.mwapi;
-
-import android.support.annotation.NonNull;
-import android.support.annotation.Nullable;
-
-import org.wikipedia.dataclient.WikiSite;
-import org.wikipedia.dataclient.retrofit.RetrofitFactory;
-
-import retrofit2.Retrofit;
-
-/**
- * It's good to cache the Retrofit web service since it's a memory intensive
object.
- * Keep the same instance around as long as we're dealing with the same domain.
- */
-public final class MwPageEndpointsCache {
- public static final MwPageEndpointsCache INSTANCE = new
MwPageEndpointsCache();
-
- @Nullable private WikiSite wiki;
- private MwPageService.MwPageEndpoints cachedWebService;
-
- public static Retrofit retrofit(@NonNull WikiSite wiki) {
- return RetrofitFactory.newInstance(wiki);
- }
-
- private MwPageEndpointsCache() {
- }
-
- public MwPageService.MwPageEndpoints getMwPageEndpoints(WikiSite
newWikiSite) {
- if (!newWikiSite.equals(wiki)) {
- cachedWebService = createMwService(newWikiSite);
- wiki = newWikiSite;
- }
- return cachedWebService;
- }
-
- public void update() {
- if (wiki != null) {
- cachedWebService = createMwService(wiki);
- }
- }
-
- private MwPageService.MwPageEndpoints createMwService(WikiSite wiki) {
- return retrofit(wiki).create(MwPageService.MwPageEndpoints.class);
- }
-}
diff --git a/app/src/main/java/org/wikipedia/server/mwapi/MwPageService.java
b/app/src/main/java/org/wikipedia/server/mwapi/MwPageService.java
index 605eeb8..0e2b66a 100644
--- a/app/src/main/java/org/wikipedia/server/mwapi/MwPageService.java
+++ b/app/src/main/java/org/wikipedia/server/mwapi/MwPageService.java
@@ -9,7 +9,7 @@
import org.wikipedia.server.PageService;
import org.wikipedia.server.PageSummary;
import org.wikipedia.server.ServiceError;
-import org.wikipedia.server.restbase.RbPageEndpointsCache;
+import org.wikipedia.server.restbase.RbPageServiceCache;
import org.wikipedia.settings.RbSwitch;
import org.wikipedia.zero.WikipediaZeroHandler;
@@ -27,19 +27,19 @@
* Retrofit web service client for MediaWiki PHP API.
*/
public class MwPageService implements PageService {
- private final MwPageEndpoints webService;
+ private final Service service;
private final Retrofit retrofit;
private WikipediaZeroHandler responseHeaderHandler;
public MwPageService(final WikiSite wiki) {
responseHeaderHandler =
WikipediaApp.getInstance().getWikipediaZeroHandler();
- webService = MwPageEndpointsCache.INSTANCE.getMwPageEndpoints(wiki);
- retrofit = RbPageEndpointsCache.INSTANCE.getRetrofit();
+ service = MwPageServiceCache.INSTANCE.getService(wiki);
+ retrofit = RbPageServiceCache.INSTANCE.getRetrofit(); // todo: why
does MW depend on RB?
}
@Override
public void pageSummary(String title, final PageSummary.Callback cb) {
- Call<MwPageSummary> call = webService.pageSummary(title);
+ Call<MwPageSummary> call = service.pageSummary(title);
call.enqueue(new Callback<MwPageSummary>() {
/**
* Invoked for a received HTTP response.
@@ -71,7 +71,7 @@
@Override
public void pageLead(String title, int leadImageThumbWidth, boolean
noImages,
final PageLead.Callback cb) {
- Call<MwPageLead> call = webService.pageLead(title,
leadImageThumbWidth, optional(noImages));
+ Call<MwPageLead> call = service.pageLead(title, leadImageThumbWidth,
optional(noImages));
call.enqueue(new Callback<MwPageLead>() {
@Override
public void onResponse(Call<MwPageLead> call, Response<MwPageLead>
response) {
@@ -92,7 +92,7 @@
@Override
public void pageRemaining(String title, boolean noImages, final
PageRemaining.Callback cb) {
- Call<MwPageRemaining> call = webService.pageRemaining(title,
optional(noImages));
+ Call<MwPageRemaining> call = service.pageRemaining(title,
optional(noImages));
call.enqueue(new Callback<MwPageRemaining>() {
@Override
public void onResponse(Call<MwPageRemaining> call,
Response<MwPageRemaining> response) {
@@ -113,7 +113,7 @@
@Override
public MwPageCombo pageCombo(String title, boolean noImages) throws
IOException {
- Response<MwPageCombo> rsp = webService.pageCombo(title,
optional(noImages)).execute();
+ Response<MwPageCombo> rsp = service.pageCombo(title,
optional(noImages)).execute();
if (rsp.isSuccessful() && !rsp.body().hasError()) {
return rsp.body();
}
@@ -136,9 +136,9 @@
}
/**
- * Retrofit endpoints for MW API endpoints.
+ * Retrofit service for MW API endpoints.
*/
- interface MwPageEndpoints {
+ interface Service {
/**
* Gets the lead section and initial metadata of a given title.
*
diff --git
a/app/src/main/java/org/wikipedia/server/mwapi/MwPageServiceCache.java
b/app/src/main/java/org/wikipedia/server/mwapi/MwPageServiceCache.java
new file mode 100644
index 0000000..54b431b
--- /dev/null
+++ b/app/src/main/java/org/wikipedia/server/mwapi/MwPageServiceCache.java
@@ -0,0 +1,46 @@
+package org.wikipedia.server.mwapi;
+
+import android.support.annotation.NonNull;
+import android.support.annotation.Nullable;
+
+import org.wikipedia.dataclient.WikiSite;
+import org.wikipedia.dataclient.retrofit.RetrofitFactory;
+
+import retrofit2.Retrofit;
+
+// todo: can this class be replaced by WikiCachedService?
+/**
+ * It's good to cache the Retrofit web service since it's a memory intensive
object.
+ * Keep the same instance around as long as we're dealing with the same domain.
+ */
+public final class MwPageServiceCache {
+ public static final MwPageServiceCache INSTANCE = new MwPageServiceCache();
+
+ @Nullable private WikiSite wiki;
+ private MwPageService.Service service;
+
+ public static Retrofit retrofit(@NonNull WikiSite wiki) {
+ return RetrofitFactory.newInstance(wiki);
+ }
+
+ private MwPageServiceCache() {
+ }
+
+ public MwPageService.Service getService(WikiSite newWikiSite) {
+ if (!newWikiSite.equals(wiki)) {
+ service = createService(newWikiSite);
+ wiki = newWikiSite;
+ }
+ return service;
+ }
+
+ public void update() {
+ if (wiki != null) {
+ service = createService(wiki);
+ }
+ }
+
+ private MwPageService.Service createService(WikiSite wiki) {
+ return retrofit(wiki).create(MwPageService.Service.class);
+ }
+}
diff --git a/app/src/main/java/org/wikipedia/server/restbase/RbPageService.java
b/app/src/main/java/org/wikipedia/server/restbase/RbPageService.java
index 351fe5a..3f6c19a 100644
--- a/app/src/main/java/org/wikipedia/server/restbase/RbPageService.java
+++ b/app/src/main/java/org/wikipedia/server/restbase/RbPageService.java
@@ -32,19 +32,19 @@
* Retrofit web service client for RESTBase Nodejs API.
*/
public class RbPageService implements PageService {
- private final RbEndpoints webService;
+ private final Service service;
private Retrofit retrofit;
private WikipediaZeroHandler responseHeaderHandler;
public RbPageService(final WikiSite wiki) {
responseHeaderHandler =
WikipediaApp.getInstance().getWikipediaZeroHandler();
- webService = RbPageEndpointsCache.INSTANCE.getRbEndpoints(wiki);
- retrofit = RbPageEndpointsCache.INSTANCE.getRetrofit();
+ service = RbPageServiceCache.INSTANCE.getService(wiki);
+ retrofit = RbPageServiceCache.INSTANCE.getRetrofit();
}
@Override
public void pageSummary(final String title, final PageSummary.Callback cb)
{
- Call<RbPageSummary> call = webService.pageSummary(title);
+ Call<RbPageSummary> call = service.pageSummary(title);
call.enqueue(new Callback<RbPageSummary>() {
/**
* Invoked for a received HTTP response.
@@ -83,7 +83,7 @@
@Override
public void pageLead(String title, final int leadImageThumbWidth, boolean
noImages,
final PageLead.Callback cb) {
- Call<RbPageLead> call = webService.pageLead(title, optional(noImages));
+ Call<RbPageLead> call = service.pageLead(title, optional(noImages));
call.enqueue(new Callback<RbPageLead>() {
@Override
public void onResponse(Call<RbPageLead> call, Response<RbPageLead>
response) {
@@ -109,7 +109,7 @@
@Override
public void pageRemaining(String title, boolean noImages, final
PageRemaining.Callback cb) {
- Call<RbPageRemaining> call = webService.pageRemaining(title,
optional(noImages));
+ Call<RbPageRemaining> call = service.pageRemaining(title,
optional(noImages));
call.enqueue(new Callback<RbPageRemaining>() {
@Override
public void onResponse(Call<RbPageRemaining> call,
Response<RbPageRemaining> response) {
@@ -132,7 +132,7 @@
@Override
public RbPageCombo pageCombo(String title, boolean noImages) throws
IOException {
- Response<RbPageCombo> rsp = webService.pageCombo(title,
optional(noImages)).execute();
+ Response<RbPageCombo> rsp = service.pageCombo(title,
optional(noImages)).execute();
if (rsp.isSuccessful() && !rsp.body().hasError()) {
return rsp.body();
}
@@ -147,7 +147,7 @@
* of a wiki page.
*/
public void define(String title, final DefinitionCallback cb) {
- Call<Map<String, RbDefinition.Usage[]>> call =
webService.define(title);
+ Call<Map<String, RbDefinition.Usage[]>> call = service.define(title);
call.enqueue(new Callback<Map<String, RbDefinition.Usage[]>>() {
@Override
public void onResponse(@NonNull Call<Map<String,
RbDefinition.Usage[]>> call,
@@ -193,9 +193,9 @@
}
/**
- * Retrofit endpoints for mobile content service endpoints.
+ * Retrofit service for mobile content service endpoints.
*/
- interface RbEndpoints {
+ interface Service {
String ACCEPT_HEADER_MOBILE_SECTIONS = "accept: application/json;
charset=utf-8; "
+
"profile=\"https://www.mediawiki.org/wiki/Specs/mobile-sections/0.8.0\"";;
String ACCEPT_HEADER_DEFINITION = "accept: application/json;
charset=utf-8; "
diff --git
a/app/src/main/java/org/wikipedia/server/restbase/RbPageEndpointsCache.java
b/app/src/main/java/org/wikipedia/server/restbase/RbPageServiceCache.java
similarity index 64%
rename from
app/src/main/java/org/wikipedia/server/restbase/RbPageEndpointsCache.java
rename to
app/src/main/java/org/wikipedia/server/restbase/RbPageServiceCache.java
index 82a5adf..4fea1b9 100644
--- a/app/src/main/java/org/wikipedia/server/restbase/RbPageEndpointsCache.java
+++ b/app/src/main/java/org/wikipedia/server/restbase/RbPageServiceCache.java
@@ -14,11 +14,11 @@
* It's good to cache the Retrofit web service since it's a memory intensive
object.
* Keep the same instance around as long as we're dealing with the same domain.
*/
-public final class RbPageEndpointsCache {
- public static final RbPageEndpointsCache INSTANCE = new
RbPageEndpointsCache();
+public final class RbPageServiceCache {
+ public static final RbPageServiceCache INSTANCE = new RbPageServiceCache();
private WikiSite wiki;
- private RbPageService.RbEndpoints cachedWebService;
+ private RbPageService.Service service;
private Retrofit retrofit;
public static Retrofit retrofit(@NonNull WikiSite wiki) {
@@ -27,29 +27,28 @@
return RetrofitFactory.newInstance(endpoint, wiki);
}
- private RbPageEndpointsCache() {
- }
-
public Retrofit getRetrofit() {
return retrofit;
}
- public RbPageService.RbEndpoints getRbEndpoints(WikiSite newWikiSite) {
+ public RbPageService.Service getService(WikiSite newWikiSite) {
if (!newWikiSite.equals(wiki)) {
- cachedWebService = createRbService(newWikiSite);
+ service = createService(newWikiSite);
wiki = newWikiSite;
}
- return cachedWebService;
+ return service;
}
public void update() {
if (wiki != null) {
- cachedWebService = createRbService(wiki);
+ service = createService(wiki);
}
}
- private RbPageService.RbEndpoints createRbService(WikiSite wiki) {
+ private RbPageService.Service createService(WikiSite wiki) {
retrofit = retrofit(wiki);
- return retrofit.create(RbPageService.RbEndpoints.class);
+ return retrofit.create(RbPageService.Service.class);
}
-}
+
+ private RbPageServiceCache() { }
+}
\ No newline at end of file
diff --git
a/app/src/main/java/org/wikipedia/settings/DeveloperSettingsFragment.java
b/app/src/main/java/org/wikipedia/settings/DeveloperSettingsFragment.java
index b0a1581..7cbd59b 100644
--- a/app/src/main/java/org/wikipedia/settings/DeveloperSettingsFragment.java
+++ b/app/src/main/java/org/wikipedia/settings/DeveloperSettingsFragment.java
@@ -3,8 +3,8 @@
import android.content.SharedPreferences;
import org.wikipedia.R;
-import org.wikipedia.server.mwapi.MwPageEndpointsCache;
-import org.wikipedia.server.restbase.RbPageEndpointsCache;
+import org.wikipedia.server.mwapi.MwPageServiceCache;
+import org.wikipedia.server.restbase.RbPageServiceCache;
public class DeveloperSettingsFragment extends PreferenceLoaderFragment {
public static DeveloperSettingsFragment newInstance() {
@@ -16,9 +16,9 @@
@Override
public void onSharedPreferenceChanged(SharedPreferences
sharedPreferences, String key) {
if
(getString(R.string.preference_key_restbase_uri_format).equals(key)) {
- RbPageEndpointsCache.INSTANCE.update();
+ RbPageServiceCache.INSTANCE.update();
} else if
(getString(R.string.preference_key_mediawiki_base_uri).equals(key)) {
- MwPageEndpointsCache.INSTANCE.update();
+ MwPageServiceCache.INSTANCE.update();
}
}
};
--
To view, visit https://gerrit.wikimedia.org/r/333453
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ib9365c3c624abefc0baa6ec0f553eb1574a4977a
Gerrit-PatchSet: 1
Gerrit-Project: apps/android/wikipedia
Gerrit-Branch: master
Gerrit-Owner: Niedzielski <sniedziel...@wikimedia.org>
Gerrit-Reviewer: Sniedzielski <sniedziel...@wikimedia.org>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
