{"id":19635696,"url":"https://github.com/codepath/android-rest-client-template","last_synced_at":"2025-04-05T16:07:15.920Z","repository":{"id":8640695,"uuid":"10289407","full_name":"codepath/android-rest-client-template","owner":"codepath","description":"Template Creating an Android OAuth REST Client","archived":false,"fork":false,"pushed_at":"2021-11-14T23:12:19.000Z","size":3194,"stargazers_count":329,"open_issues_count":2,"forks_count":171,"subscribers_count":49,"default_branch":"master","last_synced_at":"2025-03-29T15:06:02.997Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://github.com/codepath/android-rest-client-template","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codepath.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-05-25T20:27:10.000Z","updated_at":"2024-12-20T03:18:47.000Z","dependencies_parsed_at":"2022-08-22T10:00:26.559Z","dependency_job_id":null,"html_url":"https://github.com/codepath/android-rest-client-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codepath%2Fandroid-rest-client-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codepath%2Fandroid-rest-client-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codepath%2Fandroid-rest-client-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codepath%2Fandroid-rest-client-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codepath","download_url":"https://codeload.github.com/codepath/android-rest-client-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247361687,"owners_count":20926643,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T12:26:33.765Z","updated_at":"2025-04-05T16:07:15.899Z","avatar_url":"https://github.com/codepath.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RestClientTemplate [![Build Status](https://travis-ci.org/codepath/android-rest-client-template.svg?branch=master)](https://travis-ci.org/codepath/android-rest-client-template)\n\n## Overview\n\nRestClientTemplate is a skeleton Android project that makes writing Android apps sourced from OAuth JSON REST APIs as easy as possible. This skeleton project\ncombines the best libraries and structure to enable quick development of rich API clients. The following things are supported out of the box:\n\n * Authenticating with any OAuth 1.0a or OAuth 2 API\n * Sending requests for and parsing JSON API data using a defined client\n * Persisting data to a local SQLite store through an ORM layer\n * Displaying and caching remote image data into views\n\nThe following libraries are used to make this possible:\n\n * [scribe-java](https://github.com/fernandezpablo85/scribe-java) - Simple OAuth library for handling the authentication flow.\n * [Android Async HTTP](https://github.com/codepath/AsyncHttpClient) - Simple asynchronous HTTP requests with JSON parsing\n * [codepath-oauth](https://github.com/thecodepath/android-oauth-handler) - Custom-built library for managing OAuth authentication and signing of requests\n * [Glide](https://github.com/bumptech/glide) - Used for async image loading and caching them in memory and on disk.\n * [Room](https://developer.android.com/training/data-storage/room/index.html) - Simple ORM for persisting a local SQLite database on the Android device\n\n## Usage\n\n### 1. Configure the REST client\n\nOpen `src/com.codepath.apps.restclienttemplate/RestClient.java`. Configure the `REST_API_INSTANCE` and`REST_URL`.\n \nFor example if I wanted to connect to Twitter:\n\n```java\n// RestClient.java\npublic class RestClient extends OAuthBaseClient {\n    public static final BaseApi REST_API_INSTANCE = TwitterApi.instance();\n    public static final String REST_URL = \"https://api.twitter.com/1.1\";\n    public static final String REST_CONSUMER_KEY = BuildConfig.CONSUMER_KEY;       // Change this inside apikey.properties\n    public static final String REST_CONSUMER_SECRET = BuildConfig.CONSUMER_SECRET; // Change this inside apikey.properties\n    // ...constructor and endpoints\n}\n```\n\nRename the `apikey.properties.example` file to `apikey.properties`.   Replace the `CONSUMER_KEY` and `CONSUMER_SECRET` to the values specified in the Twitter console:\n\nCONSUMER_KEY=\"adsflfajsdlfdsajlafdsjl\"\nCONSUMER_SECRET=\"afdsljkasdflkjsd\"\n\nNext, change the `intent_scheme` and `intent_host` in `strings.xml` to a unique name that is special for this application.\nThis is used for the OAuth authentication flow for launching the app through web pages through an [Android intent](https://developer.chrome.com/multidevice/android/intents).\n\n```xml\n\u003cstring name=\"intent_scheme\"\u003eoauth\u003c/string\u003e\n\u003cstring name=\"intent_host\"\u003ecodepathtweets\u003c/string\u003e\n```\n\nNext, you want to define the endpoints which you want to retrieve data from or send data to within your client:\n\n```java\n// RestClient.java\npublic void getHomeTimeline(int page, JsonHttpResponseHandler handler) {\n  String apiUrl = getApiUrl(\"statuses/home_timeline.json\");\n  RequestParams params = new RequestParams();\n  params.put(\"page\", String.valueOf(page));\n  getClient().get(apiUrl, params, handler);\n}\n```\n\nNote we are using `getApiUrl` to get the full URL from the relative fragment and `RequestParams` to control the request parameters.\nYou can easily send post requests (or put or delete) using a similar approach:\n\n```java\n// RestClient.java\npublic void postTweet(String body, JsonHttpResponseHandler handler) {\n    String apiUrl = getApiUrl(\"statuses/update.json\");\n    RequestParams params = new RequestParams();\n    params.put(\"status\", body);\n    getClient().post(apiUrl, params, handler);\n}\n```\n\nThese endpoint methods will automatically execute asynchronous requests signed with the authenticated access token. To use JSON endpoints, simply invoke the method\nwith a `JsonHttpResponseHandler` handler:\n\n```java\n// SomeActivity.java\nRestClient client = RestApplication.getRestClient();\nclient.getHomeTimeline(1, new JsonHttpResponseHandler() {\n    @Override\n    public void onSuccess(int statusCode, Headers headers, JSON json) {\n    // json.jsonArray.getJSONObject(0).getLong(\"id\");\n  }\n});\n```\n\nBased on the JSON response (array or object), you need to declare the expected type inside the OnSuccess signature i.e\n`public void onSuccess(JSONObject json)`. If the endpoint does not return JSON, then you can use the `AsyncHttpResponseHandler`:\n\n```java\nRestClient client = RestApplication.getRestClient();\nclient.getSomething(new JsonHttpResponseHandler() {\n    @Override\n    public void onSuccess(int statusCode, Headers headers, String response) {\n        System.out.println(response);\n    }\n});\n```\nCheck out [Android Async HTTP Docs](https://github.com/codepath/AsyncHttpClient) for more request creation details.\n\n### 2. Define the Models\n\nIn the `src/com.codepath.apps.restclienttemplate.models`, create the models that represent the key data to be parsed and persisted within your application.\n\nFor example, if you were connecting to Twitter, you would want a Tweet model as follows:\n\n```java\n// models/Tweet.java\npackage com.codepath.apps.restclienttemplate.models;\n\nimport androidx.room.ColumnInfo;\nimport androidx.room.Embedded;\n\nimport androidx.room.Entity;\nimport androidx.room.PrimaryKey;\n\nimport org.json.JSONException;\nimport org.json.JSONObject;\n\n@Entity\npublic class Tweet {\n  // Define database columns and associated fields\n  @PrimaryKey\n  @ColumnInfo\n  Long id;\n  @ColumnInfo\n  String userHandle;\n  @ColumnInfo\n  String timestamp;\n  @ColumnInfo\n  String body;\n\n  // Use @Embedded to keep the column entries as part of the same table while still\n  // keeping the logical separation between the two objects.\n  @Embedded\n  User user;\n}\n```\n\nNote there is a separate `User` object but it will not actually be declared as a separate table.  By using the `@Embedded` annotation, the fields in this class will be stored as part of the Tweet table.  Room specifically does not load references between two different entities for performance reasons (see https://developer.android.com/training/data-storage/room/referencing-data), so declaring it this way causes the data to be denormalized as one table.\n\n```java\n// models/User.java\n\npublic class User {\n\n    @ColumnInfo\n    String name;\n\n    // normally this field would be annotated @PrimaryKey because this is an embedded object\n    // it is not needed\n    @ColumnInfo  \n    Long twitter_id;\n}\n```\nNotice here we specify the SQLite table for a resource, the columns for that table, and a constructor for turning the JSON object fetched from the API into this object. For more information on creating a model, check out the [Room guide](https://developer.android.com/training/data-storage/room/).\n\nIn addition, we also add functions into the model to support parsing JSON attributes in order to instantiate the model based on API data.  For the User object, the parsing logic would be:\n\n```java\n// Parse model from JSON\npublic static User parseJSON(JSONObject tweetJson) {\n\n    User user = new User();\n    this.twitter_id = tweetJson.getLong(\"id\");\n    this.name = tweetJson.getString(\"name\");\n    return user;\n}\n```\n\nFor the Tweet object, the logic would would be:\n\n```java\n// models/Tweet.java\n@Entity\npublic class Tweet {\n  // ...existing code from above...\n\n  // Add a constructor that creates an object from the JSON response\n  public Tweet(JSONObject object){\n    try {\n      this.user = User.parseJSON(object.getJSONObject(\"user\"));\n      this.userHandle = object.getString(\"user_username\");\n      this.timestamp = object.getString(\"timestamp\");\n      this.body = object.getString(\"body\");\n    } catch (JSONException e) {\n      e.printStackTrace();\n    }\n  }\n\n  public static ArrayList\u003cTweet\u003e fromJson(JSONArray jsonArray) {\n    ArrayList\u003cTweet\u003e tweets = new ArrayList\u003cTweet\u003e(jsonArray.length());\n\n    for (int i=0; i \u003c jsonArray.length(); i++) {\n        JSONObject tweetJson = null;\n        try {\n            tweetJson = jsonArray.getJSONObject(i);\n        } catch (Exception e) {\n            e.printStackTrace();\n            continue;\n        }\n\n        Tweet tweet = new Tweet(tweetJson);\n        tweets.add(tweet);\n    }\n\n    return tweets;\n  }\n}\n```\n\n\nNow you have a model that supports proper creation based on JSON. Create models for all the resources necessary for your mobile client.\n\n### 4. Define your queries\n\nNext, you will need to define the queries by creating a Data Access Object (DAO) class.   Here is an example of declaring queries to return a Tweet by the post ID, retrieve the most recent tweets, and insert tweets.   \n\n```java\n\nimport androidx.room.Dao;\nimport androidx.room.Insert;\nimport androidx.room.OnConflictStrategy;\nimport androidx.room.Query;\n\nimport java.util.List;\n\n@Dao\npublic interface TwitterDao {\n    // Record finders\n    @Query(\"SELECT * FROM Tweet WHERE post_id = :tweetId\")\n    Tweet byTweetId(Long tweetId);\n\n    @Query(\"SELECT * FROM Tweet ORDER BY created_at\")\n    List\u003cTweet\u003e getRecentTweets();\n\n    // Replace strategy is needed to ensure an update on the table row.  Otherwise the insertion will\n    // fail.\n    @Insert(onConflict = OnConflictStrategy.REPLACE)\n    void insertTweet(Tweet... tweets);\n}\n```\n\nThe examples here show how to perform basic queries on the Tweet table.  If you need to declare one-to-many or many-to-many relations, see the guides on using the [@Relation](https://developer.android.com/reference/android/arch/persistence/room/Relation) and [@ForeignKey](https://developer.android.com/reference/android/arch/persistence/room/ForeignKey) annotations.\n\n### 5. Create database\n\nWe need to define a database that extends `RoomDatabase` and describe which entities as part of this database. We also need to include what data access objects are to be included.  If the entities are modified or additional ones are included, the version number will need to be changed.  Note that only the `Tweet` class is declared:\n\n```java\n// bump version number if your schema changes\n@Database(entities={Tweet.class}, version=1)\npublic abstract class MyDatabase extends RoomDatabase {\n  // Declare your data access objects as abstract\n  public abstract TwitterDao twitterDao();\n\n  // Database name to be used\n  public static final String NAME = \"MyDataBase\";\n\n```    \n\nWhen compiling the code, the schemas will be stored in a `schemas/` directory assuming this statement\nhas been included your `app/build.gradle` file.  These schemas should be checked into your code based.\n\n```gradle\nandroid {\n    defaultConfig {\n\n        javaCompileOptions {\n            annotationProcessorOptions {\n                arguments = [\"room.schemaLocation\": \"$projectDir/schemas\".toString()]\n            }\n        }\n    }\n\n}\n```\n\n### 6. Initialize database\n\nInside your application class, you will need to initialize the database and specify a name for it.\n\n```java\npublic class RestClientApp extends Application {\n\n  MyDatabase myDatabase;\n\n  @Override\n  public void onCreate() {\n    // when upgrading versions, kill the original tables by using fallbackToDestructiveMigration()\n    myDatabase = Room.databaseBuilder(this, MyDatabase.class, MyDatabase.NAME).fallbackToDestructiveMigration().build();\n  }\n\n  public MyDatabase getMyDatabase() {\n    return myDatabase;\n  }\n\n}\n```\n\n### 7. Setup Your Authenticated Activities\n\nOpen `src/com.codepath.apps.restclienttemplate/LoginActivity.java` and configure the `onLoginSuccess` method\nwhich fires once your app has access to the authenticated API. Launch an activity and begin using your REST client:\n\n```java\n// LoginActivity.java\n@Override\npublic void onLoginSuccess() {\n  Intent i = new Intent(this, TimelineActivity.class);\n  startActivity(i);\n}\n```\n\nIn your new authenticated activity, you can access your client anywhere with:\n\n```java\nRestClient client = RestApplication.getRestClient();\nclient.getHomeTimeline(1, new JsonHttpResponseHandler() {\n  public void onSuccess(int statusCode, Headers headers, JSON json) {\n    Log.d(\"DEBUG\", \"timeline: \" + json.jsonArray.toString());\n    // Load json array into model classes\n  }\n});\n```\n\nYou can then load the data into your models from a `JSONArray` using:\n\n```java\nArrayList\u003cTweet\u003e tweets = Tweet.fromJSON(jsonArray);\n```\n\nor load the data from a single `JSONObject` with:\n\n```java\nTweet t = new Tweet(json);\n// t.body = \"foo\"\n```\n\nTo save, you will need to perform the database operation on a separate thread by creating an `AsyncTask` and adding the item:\n\n```java\nAsyncTask\u003cTweet, Void, Void\u003e task = new AsyncTask\u003cTweet, Void, Void\u003e() {\n    @Override\n    protected Void doInBackground(Tweet... tweets) {\n      TwitterDao twitterDao = ((RestApplication) getApplicationContext()).getMyDatabase().twitterDao();\n      twitterDao.insertModel(tweets);\n      return null;\n    };\n  };\n  task.execute(tweets);\n```\n\nThat's all you need to get started. From here, hook up your activities and their behavior, adjust your models and add more REST endpoints.\n\n### Extras\n\n#### Loading Images with Glide\n\nIf you want to load a remote image url into a particular ImageView, you can use Glide to do that with:\n\n```java\nGlide.with(this).load(imageUrl)\n     .into(imageView);\n```\n\nThis will load an image into the specified ImageView and resize the image to fit.\n\n#### Logging Out\n\nYou can log out by clearing the access token at any time through the client object:\n\n```java\nRestClient client = RestApplication.getRestClient();\nclient.clearAccessToken();\n```\n\n### Viewing SQL table\n\nYou can use `chrome://inspect` to view the SQL tables once the app is running on your emulator.  See [this guide](https://guides.codepath.com/android/Debugging-with-Stetho) for more details.\n\n### Adding OAuth2 support\n\nGoogle uses OAuth2 APIs so make sure to use the `GoogleApi20` instance:\n\n```java\npublic static final BaseApi REST_API_INSTANCE = GoogleApi20.instance();\n```\n\nChange `REST_URL` to use the Google API:\n\n```java\npublic static final String REST_URL = \"https://www.googleapis.com/calendar/v3\"; // Change this, base API URL\n```\n\nThe consumer and secret keys should be retrieved via [the credentials section](https://console.developers.google.com/apis/credentials) in the Google developer console  You will need to create an OAuth2 client ID and client secret.\n\nCreate a file called `apikey.properties`: \n\n```java\nREST_CONSUMER_KEY=\"XXX-XXX.apps.googleusercontent.com\"\nREST_CONSUMER_SECRET=\"XX-XXXXXXX\"\n```\n\nThe OAuth2 scopes should be used according to the ones defined in [the OAuth2 scopes](https://developers.google.com/identity/protocols/googlescopes):\n\n```java\npublic static final String OAUTH2_SCOPE = \"https://www.googleapis.com/auth/calendar.readonly\";\n```\n\nMake sure to pass this value into the scope parameter:\n\n```java\npublic RestClient(Context context) {\n\t\tsuper(context, REST_API_INSTANCE,\n\t\t\t\tREST_URL,\n\t\t\t\tREST_CONSUMER_KEY,\n\t\t\t\tREST_CONSUMER_SECRET,\n\t\t\t\tOAUTH2_SCOPE,  // OAuth2 scope, null for OAuth1\n\t\t\t\tString.format(REST_CALLBACK_URL_TEMPLATE, context.getString(R.string.intent_host),\n\t\t\t\t\t\tcontext.getString(R.string.intent_scheme), context.getPackageName(), FALLBACK_URL));\n\t}\n```\nGoogle only accepts `http://` or `https://` domains, so your `REST_CALLBACK_URL_TEMPLATE` will need to be adjusted:\n\n```java\npublic static final String REST_CALLBACK_URL_TEMPLATE = \"https://localhost\";\n```\n\nMake sure to update the `cprest` and `intent_host` to match this callback URL . \n\n### Troubleshooting\n\n* If you receive the following error `org.scribe.exceptions.OAuthException: Cannot send unauthenticated requests for TwitterApi client. Please attach an access token!` then check the following:\n * Is your intent-filter with `\u003cdata\u003e` attached to the `LoginActivity`? If not, make sure that the `LoginActivity` receives the request after OAuth authorization.\n * Is the `onLoginSuccess` method being executed in the `LoginActivity`. On launch of your app, be sure to start the app on the LoginActivity so authentication routines execute on launch and take you to the authenticated activity.\n * If you are plan to test with Android API 24 or above, you will need to use Chrome to launch the OAuth flow.  \n * Note that the emulators (both the Google-provided x86 and Genymotion versions) for API 24+ versions can introduce intermittent issues when initiating the OAuth flow for the first time.  For best results, use an device for this project.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodepath%2Fandroid-rest-client-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodepath%2Fandroid-rest-client-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodepath%2Fandroid-rest-client-template/lists"}