├── app ├── .gitignore ├── src │ ├── main │ │ ├── java │ │ │ └── za │ │ │ │ └── co │ │ │ │ └── riggaroo │ │ │ │ └── gus │ │ │ │ ├── GusApplication.java │ │ │ │ ├── model │ │ │ │ └── GithubUser.java │ │ │ │ ├── presentation │ │ │ │ ├── base │ │ │ │ │ ├── MvpView.java │ │ │ │ │ ├── BaseActivity.java │ │ │ │ │ ├── MvpPresenter.java │ │ │ │ │ └── BasePresenter.java │ │ │ │ └── search │ │ │ │ │ ├── UserSearchContract.java │ │ │ │ │ ├── UserViewHolder.java │ │ │ │ │ ├── UsersAdapter.java │ │ │ │ │ ├── UserSearchPresenter.java │ │ │ │ │ └── UserSearchActivity.java │ │ │ │ └── data │ │ │ │ ├── UserRepository.java │ │ │ │ ├── remote │ │ │ │ ├── GithubUserRestService.java │ │ │ │ └── model │ │ │ │ │ ├── UsersList.java │ │ │ │ │ └── User.java │ │ │ │ └── UserRepositoryImpl.java │ │ ├── res │ │ │ ├── mipmap-hdpi │ │ │ │ └── ic_launcher.png │ │ │ ├── mipmap-mdpi │ │ │ │ └── ic_launcher.png │ │ │ ├── mipmap-xhdpi │ │ │ │ └── ic_launcher.png │ │ │ ├── mipmap-xxhdpi │ │ │ │ └── ic_launcher.png │ │ │ ├── mipmap-xxxhdpi │ │ │ │ └── ic_launcher.png │ │ │ ├── values │ │ │ │ ├── colors.xml │ │ │ │ ├── dimens.xml │ │ │ │ ├── strings.xml │ │ │ │ └── styles.xml │ │ │ ├── values-w820dp │ │ │ │ └── dimens.xml │ │ │ ├── menu │ │ │ │ └── menu_user_search.xml │ │ │ ├── drawable │ │ │ │ └── ic_search.xml │ │ │ └── layout │ │ │ │ ├── list_item_user.xml │ │ │ │ └── activity_user_search.xml │ │ └── AndroidManifest.xml │ ├── mock │ │ └── java │ │ │ └── za │ │ │ └── co │ │ │ └── riggaroo │ │ │ └── gus │ │ │ ├── injection │ │ │ └── Injection.java │ │ │ └── data │ │ │ └── remote │ │ │ └── MockGithubUserRestServiceImpl.java │ ├── prod │ │ └── java │ │ │ └── za │ │ │ └── co │ │ │ └── riggaroo │ │ │ └── gus │ │ │ └── injection │ │ │ └── Injection.java │ ├── test │ │ └── java │ │ │ └── za │ │ │ └── co │ │ │ └── riggaroo │ │ │ └── gus │ │ │ ├── presentation │ │ │ └── search │ │ │ │ └── UserSearchPresenterTest.java │ │ │ └── data │ │ │ └── UserRepositoryImplTest.java │ └── androidTestMock │ │ └── java │ │ └── za │ │ └── co │ │ └── riggaroo │ │ └── gus │ │ └── presentation │ │ └── search │ │ └── UserSearchActivityTest.java ├── proguard-rules.pro └── build.gradle ├── settings.gradle ├── device-2016-08-22-193107.mp4 ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── .gitignore ├── README.md ├── gradle.properties ├── gradlew.bat ├── gradlew └── LICENSE /app/.gitignore: -------------------------------------------------------------------------------- 1 | /build 2 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | include ':app' 2 | -------------------------------------------------------------------------------- /device-2016-08-22-193107.mp4: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riggaroo/GithubUsersSearchApp/HEAD/device-2016-08-22-193107.mp4 -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riggaroo/GithubUsersSearchApp/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /app/src/main/java/za/co/riggaroo/gus/GusApplication.java: -------------------------------------------------------------------------------- 1 | package za.co.riggaroo.gus; 2 | 3 | 4 | public class GusApplication { 5 | 6 | } 7 | -------------------------------------------------------------------------------- /app/src/main/java/za/co/riggaroo/gus/model/GithubUser.java: -------------------------------------------------------------------------------- 1 | package za.co.riggaroo.gus.model; 2 | 3 | 4 | public class GithubUser { 5 | } 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.iml 2 | .gradle 3 | /local.properties 4 | /.idea/* 5 | .DS_Store 6 | /build 7 | /captures 8 | 9 | 10 | 11 | .idea/vcs.xml 12 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riggaroo/GithubUsersSearchApp/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riggaroo/GithubUsersSearchApp/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riggaroo/GithubUsersSearchApp/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riggaroo/GithubUsersSearchApp/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/riggaroo/GithubUsersSearchApp/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/java/za/co/riggaroo/gus/presentation/base/MvpView.java: -------------------------------------------------------------------------------- 1 | package za.co.riggaroo.gus.presentation.base; 2 | 3 | 4 | public interface MvpView { 5 | } 6 | -------------------------------------------------------------------------------- /app/src/main/java/za/co/riggaroo/gus/presentation/base/BaseActivity.java: -------------------------------------------------------------------------------- 1 | package za.co.riggaroo.gus.presentation.base; 2 | 3 | 4 | public class BaseActivity { 5 | } 6 | -------------------------------------------------------------------------------- /app/src/main/res/values/colors.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | #3F51B5 4 | #303F9F 5 | #FF4081 6 | 7 | -------------------------------------------------------------------------------- /app/src/main/res/values/dimens.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 16dp 4 | 16dp 5 | 6 | -------------------------------------------------------------------------------- /app/src/main/java/za/co/riggaroo/gus/presentation/base/MvpPresenter.java: -------------------------------------------------------------------------------- 1 | package za.co.riggaroo.gus.presentation.base; 2 | 3 | public interface MvpPresenter { 4 | 5 | void attachView(V mvpView); 6 | 7 | void detachView(); 8 | } 9 | 10 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Sat Aug 20 19:04:08 SAST 2016 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-2.14.1-all.zip 7 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # GithubUsersSearchApp 2 | Sample app showcasing how to go about writing tests for Android Apps 3 | 4 | You can read the corresponding blog posts here: 5 | https://riggaroo.co.za/introduction-automated-android-testing/ 6 | https://riggaroo.co.za/automated-android-testing-part-2-setup/ 7 | -------------------------------------------------------------------------------- /app/src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | Gus 3 | Search for users on Github... 4 | Search 5 | Start typing to search 6 | 7 | -------------------------------------------------------------------------------- /app/src/main/java/za/co/riggaroo/gus/data/UserRepository.java: -------------------------------------------------------------------------------- 1 | package za.co.riggaroo.gus.data; 2 | 3 | 4 | import java.util.List; 5 | 6 | import rx.Observable; 7 | import za.co.riggaroo.gus.data.remote.model.User; 8 | 9 | public interface UserRepository { 10 | 11 | Observable> searchUsers(String searchTerm); 12 | } 13 | -------------------------------------------------------------------------------- /app/src/main/res/values-w820dp/dimens.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 64dp 6 | 7 | -------------------------------------------------------------------------------- /app/src/main/res/menu/menu_user_search.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 10 | -------------------------------------------------------------------------------- /app/src/main/res/values/styles.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /app/src/main/res/drawable/ic_search.xml: -------------------------------------------------------------------------------- 1 | 6 | 9 | 10 | -------------------------------------------------------------------------------- /app/src/main/java/za/co/riggaroo/gus/data/remote/GithubUserRestService.java: -------------------------------------------------------------------------------- 1 | package za.co.riggaroo.gus.data.remote; 2 | 3 | 4 | import retrofit2.http.GET; 5 | import retrofit2.http.Path; 6 | import retrofit2.http.Query; 7 | import rx.Observable; 8 | import za.co.riggaroo.gus.data.remote.model.User; 9 | import za.co.riggaroo.gus.data.remote.model.UsersList; 10 | 11 | public interface GithubUserRestService { 12 | 13 | @GET("/search/users?per_page=2") 14 | Observable searchGithubUsers(@Query("q") String searchTerm); 15 | 16 | @GET("/users/{username}") 17 | Observable getUser(@Path("username") String username); 18 | } 19 | -------------------------------------------------------------------------------- /app/src/main/java/za/co/riggaroo/gus/presentation/search/UserSearchContract.java: -------------------------------------------------------------------------------- 1 | package za.co.riggaroo.gus.presentation.search; 2 | 3 | 4 | import java.util.List; 5 | 6 | import za.co.riggaroo.gus.data.remote.model.User; 7 | import za.co.riggaroo.gus.presentation.base.MvpPresenter; 8 | import za.co.riggaroo.gus.presentation.base.MvpView; 9 | 10 | interface UserSearchContract { 11 | 12 | interface View extends MvpView { 13 | void showSearchResults(List githubUserList); 14 | 15 | void showError(String message); 16 | 17 | void showLoading(); 18 | 19 | void hideLoading(); 20 | } 21 | 22 | interface Presenter extends MvpPresenter { 23 | void search(String term); 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /app/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # By default, the flags in this file are appended to flags specified 3 | # in /Users/rebeccafranks/Library/Android/sdk/tools/proguard/proguard-android.txt 4 | # You can edit the include path and order by changing the proguardFiles 5 | # directive in build.gradle. 6 | # 7 | # For more details, see 8 | # http://developer.android.com/guide/developing/tools/proguard.html 9 | 10 | # Add any project specific keep options here: 11 | 12 | # If your project uses WebView with JS, uncomment the following 13 | # and specify the fully qualified class name to the JavaScript interface 14 | # class: 15 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 16 | # public *; 17 | #} 18 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | # Project-wide Gradle settings. 2 | 3 | # IDE (e.g. Android Studio) users: 4 | # Gradle settings configured through the IDE *will override* 5 | # any settings specified in this file. 6 | 7 | # For more details on how to configure your build environment visit 8 | # http://www.gradle.org/docs/current/userguide/build_environment.html 9 | 10 | # Specifies the JVM arguments used for the daemon process. 11 | # The setting is particularly useful for tweaking memory settings. 12 | org.gradle.jvmargs=-Xmx1536m 13 | 14 | # When configured, Gradle will run in incubating parallel mode. 15 | # This option should only be used with decoupled projects. More details, visit 16 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects 17 | # org.gradle.parallel=true 18 | -------------------------------------------------------------------------------- /app/src/main/java/za/co/riggaroo/gus/presentation/search/UserViewHolder.java: -------------------------------------------------------------------------------- 1 | package za.co.riggaroo.gus.presentation.search; 2 | 3 | import android.support.v7.widget.RecyclerView; 4 | import android.view.View; 5 | import android.widget.ImageView; 6 | import android.widget.TextView; 7 | 8 | import za.co.riggaroo.gus.R; 9 | 10 | 11 | class UserViewHolder extends RecyclerView.ViewHolder { 12 | final TextView textViewBio; 13 | final TextView textViewName; 14 | final ImageView imageViewAvatar; 15 | 16 | UserViewHolder(View v ) { 17 | super(v); 18 | imageViewAvatar = (ImageView) v.findViewById(R.id.imageview_userprofilepic); 19 | textViewName = (TextView) v.findViewById(R.id.textview_username); 20 | textViewBio = (TextView) v.findViewById(R.id.textview_user_profile_info); 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /app/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 6 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /app/src/mock/java/za/co/riggaroo/gus/injection/Injection.java: -------------------------------------------------------------------------------- 1 | package za.co.riggaroo.gus.injection; 2 | 3 | 4 | import za.co.riggaroo.gus.data.UserRepository; 5 | import za.co.riggaroo.gus.data.UserRepositoryImpl; 6 | import za.co.riggaroo.gus.data.remote.GithubUserRestService; 7 | import za.co.riggaroo.gus.data.remote.MockGithubUserRestServiceImpl; 8 | 9 | public class Injection { 10 | 11 | private static GithubUserRestService userRestService; 12 | 13 | 14 | public static UserRepository provideUserRepo() { 15 | return new UserRepositoryImpl(provideGithubUserRestService()); 16 | } 17 | 18 | static GithubUserRestService provideGithubUserRestService() { 19 | if (userRestService == null) { 20 | userRestService = new MockGithubUserRestServiceImpl(); 21 | } 22 | return userRestService; 23 | } 24 | 25 | } -------------------------------------------------------------------------------- /app/src/main/java/za/co/riggaroo/gus/data/remote/model/UsersList.java: -------------------------------------------------------------------------------- 1 | package za.co.riggaroo.gus.data.remote.model; 2 | 3 | import com.google.gson.annotations.Expose; 4 | import com.google.gson.annotations.SerializedName; 5 | 6 | import java.util.ArrayList; 7 | import java.util.List; 8 | 9 | public class UsersList { 10 | 11 | @SerializedName("total_count") 12 | @Expose 13 | private Integer totalCount; 14 | @SerializedName("incomplete_results") 15 | @Expose 16 | private Boolean incompleteResults; 17 | @SerializedName("items") 18 | @Expose 19 | private List items = new ArrayList(); 20 | 21 | public UsersList(final List githubUsers) { 22 | this.items = githubUsers; 23 | } 24 | 25 | /** 26 | * @return The totalCount 27 | */ 28 | public Integer getTotalCount() { 29 | return totalCount; 30 | } 31 | 32 | 33 | /** 34 | * @return The incompleteResults 35 | */ 36 | public Boolean getIncompleteResults() { 37 | return incompleteResults; 38 | } 39 | 40 | /** 41 | * @return The items 42 | */ 43 | public List getItems() { 44 | return items; 45 | } 46 | 47 | 48 | } 49 | -------------------------------------------------------------------------------- /app/src/main/java/za/co/riggaroo/gus/data/UserRepositoryImpl.java: -------------------------------------------------------------------------------- 1 | package za.co.riggaroo.gus.data; 2 | 3 | 4 | import java.io.IOException; 5 | import java.util.List; 6 | 7 | import rx.Observable; 8 | import za.co.riggaroo.gus.data.remote.GithubUserRestService; 9 | import za.co.riggaroo.gus.data.remote.model.User; 10 | 11 | public class UserRepositoryImpl implements UserRepository { 12 | 13 | private GithubUserRestService githubUserRestService; 14 | 15 | public UserRepositoryImpl(GithubUserRestService githubUserRestService) { 16 | this.githubUserRestService = githubUserRestService; 17 | } 18 | 19 | @Override 20 | public Observable> searchUsers(final String searchTerm) { 21 | return Observable.defer(() -> githubUserRestService.searchGithubUsers(searchTerm).concatMap( 22 | usersList -> Observable.from(usersList.getItems()) 23 | .concatMap(user -> githubUserRestService.getUser(user.getLogin())).toList())) 24 | .retryWhen(observable -> observable.flatMap(o -> { 25 | if (o instanceof IOException) { 26 | return Observable.just(null); 27 | } 28 | return Observable.error(o); 29 | })); 30 | } 31 | 32 | } 33 | -------------------------------------------------------------------------------- /app/src/main/java/za/co/riggaroo/gus/presentation/base/BasePresenter.java: -------------------------------------------------------------------------------- 1 | package za.co.riggaroo.gus.presentation.base; 2 | 3 | import rx.Subscription; 4 | import rx.subscriptions.CompositeSubscription; 5 | 6 | public class BasePresenter implements MvpPresenter { 7 | 8 | private T view; 9 | 10 | private CompositeSubscription compositeSubscription = new CompositeSubscription(); 11 | 12 | @Override 13 | public void attachView(T mvpView) { 14 | view = mvpView; 15 | } 16 | 17 | @Override 18 | public void detachView() { 19 | compositeSubscription.clear(); 20 | view = null; 21 | } 22 | 23 | public T getView() { 24 | return view; 25 | } 26 | 27 | public void checkViewAttached() { 28 | if (!isViewAttached()) { 29 | throw new MvpViewNotAttachedException(); 30 | } 31 | } 32 | 33 | private boolean isViewAttached() { 34 | return view != null; 35 | } 36 | 37 | protected void addSubscription(Subscription subscription) { 38 | this.compositeSubscription.add(subscription); 39 | } 40 | 41 | public static class MvpViewNotAttachedException extends RuntimeException { 42 | public MvpViewNotAttachedException() { 43 | super("Please call Presenter.attachView(MvpView) before" + " requesting data to the Presenter"); 44 | } 45 | } 46 | } 47 | -------------------------------------------------------------------------------- /app/src/main/java/za/co/riggaroo/gus/presentation/search/UsersAdapter.java: -------------------------------------------------------------------------------- 1 | package za.co.riggaroo.gus.presentation.search; 2 | 3 | import android.content.Context; 4 | import android.support.v7.widget.RecyclerView; 5 | import android.view.LayoutInflater; 6 | import android.view.View; 7 | import android.view.ViewGroup; 8 | 9 | import com.squareup.picasso.Picasso; 10 | 11 | import java.util.List; 12 | 13 | import za.co.riggaroo.gus.R; 14 | import za.co.riggaroo.gus.data.remote.model.User; 15 | 16 | class UsersAdapter extends RecyclerView.Adapter { 17 | private final Context context; 18 | private List items; 19 | 20 | UsersAdapter(List items, Context context) { 21 | this.items = items; 22 | this.context = context; 23 | } 24 | 25 | @Override 26 | public UserViewHolder onCreateViewHolder(ViewGroup parent, int viewType) { 27 | View v = LayoutInflater.from(parent.getContext()).inflate(R.layout.list_item_user, parent, false); 28 | return new UserViewHolder(v); 29 | } 30 | 31 | @Override 32 | public void onBindViewHolder(UserViewHolder holder, int position) { 33 | User item = items.get(position); 34 | 35 | holder.textViewBio.setText(item.getBio()); 36 | if (item.getName() != null) { 37 | holder.textViewName.setText(item.getLogin() + " - " + item.getName()); 38 | } else { 39 | holder.textViewName.setText(item.getLogin()); 40 | } 41 | Picasso.with(context).load(item.getAvatarUrl()).into(holder.imageViewAvatar); 42 | } 43 | 44 | @Override 45 | public int getItemCount() { 46 | if (items == null) { 47 | return 0; 48 | } 49 | return items.size(); 50 | } 51 | 52 | void setItems(List githubUserList) { 53 | this.items = githubUserList; 54 | notifyDataSetChanged(); 55 | } 56 | } -------------------------------------------------------------------------------- /app/src/main/java/za/co/riggaroo/gus/presentation/search/UserSearchPresenter.java: -------------------------------------------------------------------------------- 1 | package za.co.riggaroo.gus.presentation.search; 2 | 3 | 4 | import java.util.List; 5 | 6 | import rx.Scheduler; 7 | import rx.Subscriber; 8 | import za.co.riggaroo.gus.data.UserRepository; 9 | import za.co.riggaroo.gus.data.remote.model.User; 10 | import za.co.riggaroo.gus.presentation.base.BasePresenter; 11 | 12 | class UserSearchPresenter extends BasePresenter implements UserSearchContract.Presenter { 13 | private final Scheduler mainScheduler, ioScheduler; 14 | private UserRepository userRepository; 15 | 16 | UserSearchPresenter(UserRepository userRepository, Scheduler ioScheduler, Scheduler mainScheduler) { 17 | this.userRepository = userRepository; 18 | this.ioScheduler = ioScheduler; 19 | this.mainScheduler = mainScheduler; 20 | } 21 | 22 | @Override 23 | public void search(String term) { 24 | checkViewAttached(); 25 | getView().showLoading(); 26 | addSubscription(userRepository.searchUsers(term).subscribeOn(ioScheduler).observeOn(mainScheduler) 27 | .subscribe(new Subscriber>() { 28 | @Override 29 | public void onCompleted() { 30 | 31 | } 32 | 33 | @Override 34 | public void onError(Throwable e) { 35 | getView().hideLoading(); 36 | getView().showError( 37 | e.getMessage()); //TODO You probably don't want this error to show to users - Might want to show a friendlier message :) 38 | } 39 | 40 | @Override 41 | public void onNext(List users) { 42 | getView().hideLoading(); 43 | getView().showSearchResults(users); 44 | } 45 | })); 46 | } 47 | } 48 | -------------------------------------------------------------------------------- /app/src/mock/java/za/co/riggaroo/gus/data/remote/MockGithubUserRestServiceImpl.java: -------------------------------------------------------------------------------- 1 | package za.co.riggaroo.gus.data.remote; 2 | 3 | import java.util.ArrayList; 4 | import java.util.List; 5 | 6 | import retrofit2.http.Path; 7 | import retrofit2.http.Query; 8 | import rx.Observable; 9 | import za.co.riggaroo.gus.data.remote.model.User; 10 | import za.co.riggaroo.gus.data.remote.model.UsersList; 11 | 12 | 13 | public class MockGithubUserRestServiceImpl implements GithubUserRestService { 14 | private final List usersList = new ArrayList<>(); 15 | private User dummyUser1, dummyUser2; 16 | 17 | public MockGithubUserRestServiceImpl() { 18 | dummyUser1 = new User("riggaroo", "Rebecca Franks", 19 | "https://riggaroo.co.za/wp-content/uploads/2016/03/rebeccafranks_circle.png", "Android Dev"); 20 | dummyUser2 = new User("riggaroo2", "Rebecca's Alter Ego", 21 | "https://s-media-cache-ak0.pinimg.com/564x/e7/cf/f3/e7cff3be614f68782386bfbeecb304b1.jpg", "A unicorn"); 22 | usersList.add(dummyUser1); 23 | usersList.add(dummyUser2); 24 | } 25 | 26 | private static Observable dummyGithubSearchResult = null; 27 | 28 | public static void setDummySearchGithubCallResult(Observable result) { 29 | dummyGithubSearchResult = result; 30 | } 31 | 32 | @Override 33 | public Observable searchGithubUsers(final String searchTerm) { 34 | if (dummyGithubSearchResult != null) { 35 | return dummyGithubSearchResult; 36 | } 37 | return Observable.just(new UsersList(usersList)); 38 | } 39 | 40 | @Override 41 | public Observable getUser(final String username) { 42 | if (username.equals("riggaroo")) { 43 | return Observable.just(dummyUser1); 44 | } else if (username.equals("riggaroo2")) { 45 | return Observable.just(dummyUser2); 46 | } 47 | return Observable.just(null); 48 | } 49 | 50 | 51 | } 52 | -------------------------------------------------------------------------------- /app/src/prod/java/za/co/riggaroo/gus/injection/Injection.java: -------------------------------------------------------------------------------- 1 | package za.co.riggaroo.gus.injection; 2 | 3 | 4 | import okhttp3.OkHttpClient; 5 | import okhttp3.logging.HttpLoggingInterceptor; 6 | import retrofit2.Retrofit; 7 | import retrofit2.adapter.rxjava.RxJavaCallAdapterFactory; 8 | import retrofit2.converter.gson.GsonConverterFactory; 9 | import za.co.riggaroo.gus.data.UserRepository; 10 | import za.co.riggaroo.gus.data.UserRepositoryImpl; 11 | import za.co.riggaroo.gus.data.remote.GithubUserRestService; 12 | 13 | public class Injection { 14 | 15 | private static final String BASE_URL = "https://api.github.com"; 16 | private static OkHttpClient okHttpClient; 17 | private static GithubUserRestService userRestService; 18 | private static Retrofit retrofitInstance; 19 | 20 | 21 | public static UserRepository provideUserRepo() { 22 | return new UserRepositoryImpl(provideGithubUserRestService()); 23 | } 24 | 25 | static GithubUserRestService provideGithubUserRestService() { 26 | if (userRestService == null) { 27 | userRestService = getRetrofitInstance().create(GithubUserRestService.class); 28 | } 29 | return userRestService; 30 | } 31 | 32 | static OkHttpClient getOkHttpClient() { 33 | if (okHttpClient == null) { 34 | HttpLoggingInterceptor logging = new HttpLoggingInterceptor(); 35 | logging.setLevel(HttpLoggingInterceptor.Level.BASIC); 36 | okHttpClient = new OkHttpClient.Builder().addInterceptor(logging).build(); 37 | } 38 | 39 | return okHttpClient; 40 | } 41 | 42 | static Retrofit getRetrofitInstance() { 43 | if (retrofitInstance == null) { 44 | Retrofit.Builder retrofit = new Retrofit.Builder().client(Injection.getOkHttpClient()).baseUrl(BASE_URL) 45 | .addConverterFactory(GsonConverterFactory.create()) 46 | .addCallAdapterFactory(RxJavaCallAdapterFactory.create()); 47 | retrofitInstance = retrofit.build(); 48 | 49 | } 50 | return retrofitInstance; 51 | } 52 | } 53 | -------------------------------------------------------------------------------- /app/src/main/res/layout/list_item_user.xml: -------------------------------------------------------------------------------- 1 | 2 | 9 | 10 | 20 | 21 | 32 | 33 | 47 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 12 | set DEFAULT_JVM_OPTS= 13 | 14 | set DIRNAME=%~dp0 15 | if "%DIRNAME%" == "" set DIRNAME=. 16 | set APP_BASE_NAME=%~n0 17 | set APP_HOME=%DIRNAME% 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windowz variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | if "%@eval[2+2]" == "4" goto 4NT_args 53 | 54 | :win9xME_args 55 | @rem Slurp the command line arguments. 56 | set CMD_LINE_ARGS= 57 | set _SKIP=2 58 | 59 | :win9xME_args_slurp 60 | if "x%~1" == "x" goto execute 61 | 62 | set CMD_LINE_ARGS=%* 63 | goto execute 64 | 65 | :4NT_args 66 | @rem Get arguments from the 4NT Shell from JP Software 67 | set CMD_LINE_ARGS=%$ 68 | 69 | :execute 70 | @rem Setup the command line 71 | 72 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if "%ERRORLEVEL%"=="0" goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 85 | exit /b 1 86 | 87 | :mainEnd 88 | if "%OS%"=="Windows_NT" endlocal 89 | 90 | :omega 91 | -------------------------------------------------------------------------------- /app/src/main/res/layout/activity_user_search.xml: -------------------------------------------------------------------------------- 1 | 2 | 10 | 11 | 22 | 23 | 24 | 25 | 38 | 39 | 40 | 41 | 53 | 54 | 67 | 68 | 69 | -------------------------------------------------------------------------------- /app/build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'com.android.application' 2 | 3 | android { 4 | compileSdkVersion 24 5 | buildToolsVersion "24.0.2" 6 | 7 | defaultConfig { 8 | applicationId "za.co.riggaroo.gus" 9 | minSdkVersion 16 10 | targetSdkVersion 24 11 | versionCode 1 12 | versionName "1.0" 13 | testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner" 14 | jackOptions { 15 | enabled true 16 | } 17 | 18 | } 19 | buildTypes { 20 | release { 21 | minifyEnabled false 22 | proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' 23 | } 24 | debug { 25 | testCoverageEnabled = true 26 | } 27 | } 28 | 29 | 30 | 31 | productFlavors { 32 | prod { 33 | 34 | } 35 | mock { 36 | } 37 | } 38 | compileOptions { 39 | sourceCompatibility JavaVersion.VERSION_1_8 40 | targetCompatibility JavaVersion.VERSION_1_8 41 | } 42 | } 43 | 44 | dependencies { 45 | compile fileTree(dir: 'libs', include: ['*.jar']) 46 | 47 | compile 'com.squareup.okhttp3:logging-interceptor:3.4.0-RC1' 48 | compile 'com.android.support:appcompat-v7:24.2.0' 49 | compile 'com.android.support.constraint:constraint-layout:1.0.0-alpha7' 50 | 51 | //Retrofit, RxJava and OkHttp. 52 | compile 'com.squareup.retrofit2:retrofit:2.1.0' 53 | compile 'com.squareup.retrofit2:converter-gson:2.1.0' 54 | compile 'com.squareup.okhttp3:okhttp:3.4.0-RC1' 55 | compile 'com.squareup.retrofit2:adapter-rxjava:2.1.0' 56 | compile 'io.reactivex:rxandroid:1.2.1' 57 | compile 'io.reactivex:rxjava:1.1.6' 58 | compile 'com.squareup.picasso:picasso:2.5.2' 59 | 60 | //Dependencies for JUNit and unit tests. 61 | testCompile "junit:junit:4.12" 62 | testCompile "org.mockito:mockito-all:1.10.19" 63 | testCompile "org.hamcrest:hamcrest-all:1.3" 64 | testCompile("org.powermock:powermock-module-junit4:1.6.2") 65 | testCompile("org.powermock:powermock-api-mockito:1.6.2") 66 | testCompile 'com.squareup.okhttp3:mockwebserver:3.4.0-RC1' 67 | 68 | //Dependencies for Espresso 69 | androidTestCompile 'com.android.support:appcompat-v7:24.2.0' 70 | androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', { 71 | exclude group: 'com.android.support', module: 'support-annotations' 72 | }) 73 | androidTestCompile("com.android.support.test:runner:0.5") { 74 | exclude module: 'support-annotations' 75 | exclude module: 'support-v4' 76 | } 77 | androidTestCompile("com.android.support.test:rules:0.5") { 78 | exclude module: 'support-annotations' 79 | exclude module: 'support-v4' 80 | } 81 | androidTestCompile("com.android.support.test.espresso:espresso-intents:2.2.2") { 82 | exclude module: 'recyclerview-v7' 83 | exclude module: 'support-annotations' 84 | exclude module: 'support-v4' 85 | } 86 | androidTestCompile('com.android.support.test.espresso:espresso-contrib:2.2.1') { 87 | exclude module: 'recyclerview-v7' 88 | exclude module: 'support-annotations' 89 | exclude module: 'support-v4' 90 | 91 | } 92 | 93 | 94 | compile 'com.android.support:recyclerview-v7:24.2.0' 95 | } 96 | -------------------------------------------------------------------------------- /app/src/test/java/za/co/riggaroo/gus/presentation/search/UserSearchPresenterTest.java: -------------------------------------------------------------------------------- 1 | package za.co.riggaroo.gus.presentation.search; 2 | 3 | import org.junit.Before; 4 | import org.junit.Test; 5 | import org.mockito.Mock; 6 | import org.mockito.MockitoAnnotations; 7 | 8 | import java.io.IOException; 9 | import java.util.ArrayList; 10 | import java.util.List; 11 | 12 | import rx.Observable; 13 | import rx.schedulers.Schedulers; 14 | import za.co.riggaroo.gus.data.UserRepository; 15 | import za.co.riggaroo.gus.data.remote.model.User; 16 | import za.co.riggaroo.gus.data.remote.model.UsersList; 17 | import za.co.riggaroo.gus.presentation.base.BasePresenter; 18 | 19 | import static org.mockito.Matchers.anyList; 20 | import static org.mockito.Matchers.anyString; 21 | import static org.mockito.Mockito.never; 22 | import static org.mockito.Mockito.verify; 23 | import static org.mockito.Mockito.when; 24 | 25 | public class UserSearchPresenterTest { 26 | 27 | private static final String USER_LOGIN_RIGGAROO = "riggaroo"; 28 | private static final String USER_LOGIN_2_REBECCA = "rebecca"; 29 | @Mock 30 | UserRepository userRepository; 31 | @Mock 32 | UserSearchContract.View view; 33 | 34 | UserSearchPresenter userSearchPresenter; 35 | 36 | @Before 37 | public void setUp() throws Exception { 38 | MockitoAnnotations.initMocks(this); 39 | userSearchPresenter = new UserSearchPresenter(userRepository, Schedulers.immediate(), Schedulers.immediate()); 40 | userSearchPresenter.attachView(view); 41 | } 42 | 43 | @Test 44 | public void search_ValidSearchTerm_ReturnsResults() { 45 | UsersList userList = getDummyUserList(); 46 | when(userRepository.searchUsers(anyString())).thenReturn(Observable.>just(userList.getItems())); 47 | 48 | userSearchPresenter.search("riggaroo"); 49 | 50 | verify(view).showLoading(); 51 | verify(view).hideLoading(); 52 | verify(view).showSearchResults(userList.getItems()); 53 | verify(view, never()).showError(anyString()); 54 | } 55 | 56 | @Test 57 | public void search_UserRepositoryError_ErrorMsg() { 58 | String errorMsg = "No internet"; 59 | when(userRepository.searchUsers(anyString())).thenReturn(Observable.error(new IOException(errorMsg))); 60 | 61 | userSearchPresenter.search("bookdash"); 62 | 63 | verify(view).showLoading(); 64 | verify(view).hideLoading(); 65 | verify(view, never()).showSearchResults(anyList()); 66 | verify(view).showError(errorMsg); 67 | } 68 | 69 | UsersList getDummyUserList() { 70 | List githubUsers = new ArrayList<>(); 71 | githubUsers.add(user1FullDetails()); 72 | githubUsers.add(user2FullDetails()); 73 | return new UsersList(githubUsers); 74 | } 75 | 76 | User user1FullDetails() { 77 | return new User(USER_LOGIN_RIGGAROO, "Rigs Franks", "avatar_url", "Bio1"); 78 | } 79 | 80 | User user2FullDetails() { 81 | return new User(USER_LOGIN_2_REBECCA, "Rebecca Franks", "avatar_url2", "Bio2"); 82 | } 83 | 84 | @Test(expected = BasePresenter.MvpViewNotAttachedException.class) 85 | public void search_NotAttached_ThrowsMvpException() { 86 | userSearchPresenter.detachView(); 87 | 88 | userSearchPresenter.search("test"); 89 | 90 | verify(view, never()).showLoading(); 91 | verify(view, never()).showSearchResults(anyList()); 92 | } 93 | 94 | } -------------------------------------------------------------------------------- /app/src/androidTestMock/java/za/co/riggaroo/gus/presentation/search/UserSearchActivityTest.java: -------------------------------------------------------------------------------- 1 | package za.co.riggaroo.gus.presentation.search; 2 | 3 | import android.support.test.espresso.matcher.ViewMatchers; 4 | import android.support.test.rule.ActivityTestRule; 5 | import android.support.test.runner.AndroidJUnit4; 6 | import android.view.KeyEvent; 7 | 8 | import org.junit.Before; 9 | import org.junit.Rule; 10 | import org.junit.Test; 11 | import org.junit.runner.RunWith; 12 | 13 | import java.io.IOException; 14 | 15 | import rx.Observable; 16 | import za.co.riggaroo.gus.R; 17 | import za.co.riggaroo.gus.data.remote.MockGithubUserRestServiceImpl; 18 | 19 | import static android.support.test.espresso.Espresso.onView; 20 | import static android.support.test.espresso.action.ViewActions.click; 21 | import static android.support.test.espresso.action.ViewActions.pressKey; 22 | import static android.support.test.espresso.action.ViewActions.typeText; 23 | import static android.support.test.espresso.assertion.ViewAssertions.doesNotExist; 24 | import static android.support.test.espresso.assertion.ViewAssertions.matches; 25 | import static android.support.test.espresso.matcher.ViewMatchers.isDisplayed; 26 | import static android.support.test.espresso.matcher.ViewMatchers.withEffectiveVisibility; 27 | import static android.support.test.espresso.matcher.ViewMatchers.withId; 28 | import static android.support.test.espresso.matcher.ViewMatchers.withText; 29 | import static org.hamcrest.Matchers.allOf; 30 | import static org.hamcrest.Matchers.not; 31 | 32 | @RunWith(AndroidJUnit4.class) 33 | public class UserSearchActivityTest { 34 | 35 | @Rule 36 | public ActivityTestRule testRule = new ActivityTestRule<>(UserSearchActivity.class); 37 | 38 | @Test 39 | public void searchActivity_onLaunch_HintTextDisplayed(){ 40 | //Given activity automatically launched 41 | //When user doesn't interact with the view 42 | //Then 43 | onView(withText("Start typing to search")).check(matches(isDisplayed())); 44 | } 45 | 46 | @Test 47 | public void searchText_ReturnsCorrectlyFromWebService_DisplaysResult() { 48 | //Given activity is automatically launched 49 | 50 | //When 51 | onView(allOf(withId(R.id.menu_search), withEffectiveVisibility(ViewMatchers.Visibility.VISIBLE))).perform( 52 | click()); // When using a SearchView, there are two views that match the id menu_search - one that represents the icon, and the other the edit text view. We want to click on the visible one. 53 | onView(withId(R.id.search_src_text)).perform(typeText("riggaroo"), pressKey(KeyEvent.KEYCODE_ENTER)); 54 | 55 | //Then 56 | onView(withText("Start typing to search")).check(matches(not(isDisplayed()))); 57 | onView(withText("riggaroo - Rebecca Franks")).check(matches(isDisplayed())); 58 | onView(withText("Android Dev")).check(matches(isDisplayed())); 59 | onView(withText("A unicorn")).check(matches(isDisplayed())); 60 | onView(withText("riggaroo2 - Rebecca's Alter Ego")).check(matches(isDisplayed())); 61 | } 62 | 63 | @Test 64 | public void searchText_ServiceCallFails_DisplayError(){ 65 | String errorMsg = "Server Error"; 66 | MockGithubUserRestServiceImpl.setDummySearchGithubCallResult(Observable.error(new Exception(errorMsg))); 67 | 68 | onView(allOf(withId(R.id.menu_search), withEffectiveVisibility(ViewMatchers.Visibility.VISIBLE))).perform( 69 | click()); // When using a SearchView, there are two views that match the id menu_search - one that represents the icon, and the other the edit text view. We want to click on the visible one. 70 | onView(withId(R.id.search_src_text)).perform(typeText("riggaroo"), pressKey(KeyEvent.KEYCODE_ENTER)); 71 | 72 | onView(withText(errorMsg)).check(matches(isDisplayed())); 73 | 74 | } 75 | } -------------------------------------------------------------------------------- /app/src/main/java/za/co/riggaroo/gus/presentation/search/UserSearchActivity.java: -------------------------------------------------------------------------------- 1 | package za.co.riggaroo.gus.presentation.search; 2 | 3 | import android.os.Bundle; 4 | import android.support.v7.app.AppCompatActivity; 5 | import android.support.v7.widget.RecyclerView; 6 | import android.support.v7.widget.SearchView; 7 | import android.support.v7.widget.Toolbar; 8 | import android.view.Menu; 9 | import android.view.MenuItem; 10 | import android.view.View; 11 | import android.widget.ProgressBar; 12 | import android.widget.TextView; 13 | 14 | import java.util.List; 15 | 16 | import rx.android.schedulers.AndroidSchedulers; 17 | import rx.schedulers.Schedulers; 18 | import za.co.riggaroo.gus.R; 19 | import za.co.riggaroo.gus.data.remote.model.User; 20 | import za.co.riggaroo.gus.injection.Injection; 21 | 22 | 23 | public class UserSearchActivity extends AppCompatActivity implements UserSearchContract.View { 24 | 25 | private UserSearchContract.Presenter userSearchPresenter; 26 | private UsersAdapter usersAdapter; 27 | private SearchView searchView; 28 | private Toolbar toolbar; 29 | private ProgressBar progressBar; 30 | private RecyclerView recyclerViewUsers; 31 | private TextView textViewErrorMessage; 32 | 33 | @Override 34 | protected void onCreate(Bundle savedInstanceState) { 35 | super.onCreate(savedInstanceState); 36 | setContentView(R.layout.activity_user_search); 37 | userSearchPresenter = new UserSearchPresenter(Injection.provideUserRepo(), Schedulers.io(), 38 | AndroidSchedulers.mainThread()); 39 | userSearchPresenter.attachView(this); 40 | 41 | toolbar = (Toolbar) findViewById(R.id.toolbar); 42 | setSupportActionBar(toolbar); 43 | progressBar = (ProgressBar) findViewById(R.id.progress_bar); 44 | textViewErrorMessage = (TextView) findViewById(R.id.text_view_error_msg); 45 | recyclerViewUsers = (RecyclerView) findViewById(R.id.recycler_view_users); 46 | usersAdapter = new UsersAdapter(null, this); 47 | recyclerViewUsers.setAdapter(usersAdapter); 48 | 49 | } 50 | 51 | @Override 52 | protected void onDestroy() { 53 | super.onDestroy(); 54 | userSearchPresenter.detachView(); 55 | } 56 | 57 | @Override 58 | public boolean onCreateOptionsMenu(Menu menu) { 59 | super.onCreateOptionsMenu(menu); 60 | getMenuInflater().inflate(R.menu.menu_user_search, menu); 61 | final MenuItem searchActionMenuItem = menu.findItem(R.id.menu_search); 62 | searchView = (SearchView) searchActionMenuItem.getActionView(); 63 | searchView.setOnQueryTextListener(new SearchView.OnQueryTextListener() { 64 | @Override 65 | public boolean onQueryTextSubmit(String query) { 66 | if (!searchView.isIconified()) { 67 | searchView.setIconified(true); 68 | } 69 | userSearchPresenter.search(query); 70 | toolbar.setTitle(query); 71 | searchActionMenuItem.collapseActionView(); 72 | return false; 73 | } 74 | 75 | @Override 76 | public boolean onQueryTextChange(String s) { 77 | return false; 78 | } 79 | }); 80 | searchActionMenuItem.expandActionView(); 81 | return true; 82 | } 83 | 84 | @Override 85 | public void showSearchResults(List githubUserList) { 86 | recyclerViewUsers.setVisibility(View.VISIBLE); 87 | textViewErrorMessage.setVisibility(View.GONE); 88 | usersAdapter.setItems(githubUserList); 89 | } 90 | 91 | @Override 92 | public void showError(String message) { 93 | textViewErrorMessage.setVisibility(View.VISIBLE); 94 | recyclerViewUsers.setVisibility(View.GONE); 95 | textViewErrorMessage.setText(message); 96 | } 97 | 98 | @Override 99 | public void showLoading() { 100 | progressBar.setVisibility(View.VISIBLE); 101 | recyclerViewUsers.setVisibility(View.GONE); 102 | textViewErrorMessage.setVisibility(View.GONE); 103 | } 104 | 105 | @Override 106 | public void hideLoading() { 107 | progressBar.setVisibility(View.GONE); 108 | recyclerViewUsers.setVisibility(View.VISIBLE); 109 | textViewErrorMessage.setVisibility(View.GONE); 110 | 111 | } 112 | } 113 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 10 | DEFAULT_JVM_OPTS="" 11 | 12 | APP_NAME="Gradle" 13 | APP_BASE_NAME=`basename "$0"` 14 | 15 | # Use the maximum available, or set MAX_FD != -1 to use that value. 16 | MAX_FD="maximum" 17 | 18 | warn ( ) { 19 | echo "$*" 20 | } 21 | 22 | die ( ) { 23 | echo 24 | echo "$*" 25 | echo 26 | exit 1 27 | } 28 | 29 | # OS specific support (must be 'true' or 'false'). 30 | cygwin=false 31 | msys=false 32 | darwin=false 33 | case "`uname`" in 34 | CYGWIN* ) 35 | cygwin=true 36 | ;; 37 | Darwin* ) 38 | darwin=true 39 | ;; 40 | MINGW* ) 41 | msys=true 42 | ;; 43 | esac 44 | 45 | # Attempt to set APP_HOME 46 | # Resolve links: $0 may be a link 47 | PRG="$0" 48 | # Need this for relative symlinks. 49 | while [ -h "$PRG" ] ; do 50 | ls=`ls -ld "$PRG"` 51 | link=`expr "$ls" : '.*-> \(.*\)$'` 52 | if expr "$link" : '/.*' > /dev/null; then 53 | PRG="$link" 54 | else 55 | PRG=`dirname "$PRG"`"/$link" 56 | fi 57 | done 58 | SAVED="`pwd`" 59 | cd "`dirname \"$PRG\"`/" >/dev/null 60 | APP_HOME="`pwd -P`" 61 | cd "$SAVED" >/dev/null 62 | 63 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 64 | 65 | # Determine the Java command to use to start the JVM. 66 | if [ -n "$JAVA_HOME" ] ; then 67 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 68 | # IBM's JDK on AIX uses strange locations for the executables 69 | JAVACMD="$JAVA_HOME/jre/sh/java" 70 | else 71 | JAVACMD="$JAVA_HOME/bin/java" 72 | fi 73 | if [ ! -x "$JAVACMD" ] ; then 74 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 75 | 76 | Please set the JAVA_HOME variable in your environment to match the 77 | location of your Java installation." 78 | fi 79 | else 80 | JAVACMD="java" 81 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 82 | 83 | Please set the JAVA_HOME variable in your environment to match the 84 | location of your Java installation." 85 | fi 86 | 87 | # Increase the maximum file descriptors if we can. 88 | if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then 89 | MAX_FD_LIMIT=`ulimit -H -n` 90 | if [ $? -eq 0 ] ; then 91 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 92 | MAX_FD="$MAX_FD_LIMIT" 93 | fi 94 | ulimit -n $MAX_FD 95 | if [ $? -ne 0 ] ; then 96 | warn "Could not set maximum file descriptor limit: $MAX_FD" 97 | fi 98 | else 99 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 100 | fi 101 | fi 102 | 103 | # For Darwin, add options to specify how the application appears in the dock 104 | if $darwin; then 105 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 106 | fi 107 | 108 | # For Cygwin, switch paths to Windows format before running java 109 | if $cygwin ; then 110 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 111 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 112 | JAVACMD=`cygpath --unix "$JAVACMD"` 113 | 114 | # We build the pattern for arguments to be converted via cygpath 115 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 116 | SEP="" 117 | for dir in $ROOTDIRSRAW ; do 118 | ROOTDIRS="$ROOTDIRS$SEP$dir" 119 | SEP="|" 120 | done 121 | OURCYGPATTERN="(^($ROOTDIRS))" 122 | # Add a user-defined pattern to the cygpath arguments 123 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 124 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 125 | fi 126 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 127 | i=0 128 | for arg in "$@" ; do 129 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 130 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 131 | 132 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 133 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 134 | else 135 | eval `echo args$i`="\"$arg\"" 136 | fi 137 | i=$((i+1)) 138 | done 139 | case $i in 140 | (0) set -- ;; 141 | (1) set -- "$args0" ;; 142 | (2) set -- "$args0" "$args1" ;; 143 | (3) set -- "$args0" "$args1" "$args2" ;; 144 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 145 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 146 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 147 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 148 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 149 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 150 | esac 151 | fi 152 | 153 | # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules 154 | function splitJvmOpts() { 155 | JVM_OPTS=("$@") 156 | } 157 | eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS 158 | JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" 159 | 160 | exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" 161 | -------------------------------------------------------------------------------- /app/src/main/java/za/co/riggaroo/gus/data/remote/model/User.java: -------------------------------------------------------------------------------- 1 | package za.co.riggaroo.gus.data.remote.model; 2 | 3 | import com.google.gson.annotations.Expose; 4 | import com.google.gson.annotations.SerializedName; 5 | 6 | public class User { 7 | 8 | @SerializedName("login") 9 | @Expose 10 | private String login; 11 | @SerializedName("id") 12 | @Expose 13 | private Integer id; 14 | @SerializedName("avatar_url") 15 | @Expose 16 | private String avatarUrl; 17 | @SerializedName("gravatar_id") 18 | @Expose 19 | private String gravatarId; 20 | @SerializedName("url") 21 | @Expose 22 | private String url; 23 | @SerializedName("html_url") 24 | @Expose 25 | private String htmlUrl; 26 | @SerializedName("followers_url") 27 | @Expose 28 | private String followersUrl; 29 | @SerializedName("following_url") 30 | @Expose 31 | private String followingUrl; 32 | @SerializedName("gists_url") 33 | @Expose 34 | private String gistsUrl; 35 | @SerializedName("starred_url") 36 | @Expose 37 | private String starredUrl; 38 | @SerializedName("subscriptions_url") 39 | @Expose 40 | private String subscriptionsUrl; 41 | @SerializedName("organizations_url") 42 | @Expose 43 | private String organizationsUrl; 44 | @SerializedName("repos_url") 45 | @Expose 46 | private String reposUrl; 47 | @SerializedName("events_url") 48 | @Expose 49 | private String eventsUrl; 50 | @SerializedName("received_events_url") 51 | @Expose 52 | private String receivedEventsUrl; 53 | @SerializedName("type") 54 | @Expose 55 | private String type; 56 | @SerializedName("site_admin") 57 | @Expose 58 | private Boolean siteAdmin; 59 | @SerializedName("name") 60 | @Expose 61 | private String name; 62 | @SerializedName("company") 63 | @Expose 64 | private Object company; 65 | @SerializedName("blog") 66 | @Expose 67 | private String blog; 68 | @SerializedName("location") 69 | @Expose 70 | private String location; 71 | @SerializedName("email") 72 | @Expose 73 | private Object email; 74 | @SerializedName("hireable") 75 | @Expose 76 | private Object hireable; 77 | @SerializedName("bio") 78 | @Expose 79 | private String bio; 80 | @SerializedName("public_repos") 81 | @Expose 82 | private Integer publicRepos; 83 | @SerializedName("public_gists") 84 | @Expose 85 | private Integer publicGists; 86 | @SerializedName("followers") 87 | @Expose 88 | private Integer followers; 89 | @SerializedName("following") 90 | @Expose 91 | private Integer following; 92 | @SerializedName("created_at") 93 | @Expose 94 | private String createdAt; 95 | @SerializedName("updated_at") 96 | @Expose 97 | private String updatedAt; 98 | 99 | public User() { 100 | } 101 | 102 | public User(final String userLogin, final String name, final String avatarUrl, final String bio) { 103 | this.login = userLogin; 104 | this.name = name; 105 | this.avatarUrl = avatarUrl; 106 | this.bio = bio; 107 | } 108 | 109 | public User(final String userLogin) { 110 | this.login = userLogin; 111 | } 112 | 113 | /** 114 | * @return The login 115 | */ 116 | public String getLogin() { 117 | return login; 118 | } 119 | 120 | /** 121 | * @return The id 122 | */ 123 | public Integer getId() { 124 | return id; 125 | } 126 | 127 | 128 | public String getAvatarUrl() { 129 | return avatarUrl; 130 | } 131 | 132 | 133 | public String getGravatarId() { 134 | return gravatarId; 135 | } 136 | 137 | 138 | public String getUrl() { 139 | return url; 140 | } 141 | 142 | 143 | public String getHtmlUrl() { 144 | return htmlUrl; 145 | } 146 | 147 | 148 | public String getFollowersUrl() { 149 | return followersUrl; 150 | } 151 | 152 | 153 | public String getFollowingUrl() { 154 | return followingUrl; 155 | } 156 | 157 | 158 | public String getGistsUrl() { 159 | return gistsUrl; 160 | } 161 | 162 | 163 | public String getStarredUrl() { 164 | return starredUrl; 165 | } 166 | 167 | 168 | public String getSubscriptionsUrl() { 169 | return subscriptionsUrl; 170 | } 171 | 172 | 173 | public String getOrganizationsUrl() { 174 | return organizationsUrl; 175 | } 176 | 177 | 178 | public String getReposUrl() { 179 | return reposUrl; 180 | } 181 | 182 | 183 | public String getEventsUrl() { 184 | return eventsUrl; 185 | } 186 | 187 | public String getReceivedEventsUrl() { 188 | return receivedEventsUrl; 189 | } 190 | 191 | 192 | public String getType() { 193 | return type; 194 | } 195 | 196 | public Boolean getSiteAdmin() { 197 | return siteAdmin; 198 | } 199 | 200 | public String getName() { 201 | return name; 202 | } 203 | 204 | public Object getCompany() { 205 | return company; 206 | } 207 | 208 | public String getBlog() { 209 | return blog; 210 | } 211 | 212 | public String getLocation() { 213 | return location; 214 | } 215 | 216 | 217 | public Object getEmail() { 218 | return email; 219 | } 220 | 221 | public Object getHireable() { 222 | return hireable; 223 | } 224 | 225 | public String getBio() { 226 | return bio; 227 | } 228 | 229 | public Integer getPublicRepos() { 230 | return publicRepos; 231 | } 232 | 233 | public Integer getPublicGists() { 234 | return publicGists; 235 | } 236 | 237 | public Integer getFollowers() { 238 | return followers; 239 | } 240 | 241 | public Integer getFollowing() { 242 | return following; 243 | } 244 | 245 | public String getCreatedAt() { 246 | return createdAt; 247 | } 248 | 249 | public String getUpdatedAt() { 250 | return updatedAt; 251 | } 252 | 253 | 254 | } 255 | 256 | -------------------------------------------------------------------------------- /app/src/test/java/za/co/riggaroo/gus/data/UserRepositoryImplTest.java: -------------------------------------------------------------------------------- 1 | package za.co.riggaroo.gus.data; 2 | 3 | import junit.framework.Assert; 4 | 5 | import org.junit.Before; 6 | import org.junit.Test; 7 | import org.mockito.Mock; 8 | import org.mockito.MockitoAnnotations; 9 | 10 | import java.io.IOException; 11 | import java.util.ArrayList; 12 | import java.util.List; 13 | 14 | import okhttp3.MediaType; 15 | import okhttp3.ResponseBody; 16 | import retrofit2.Response; 17 | import retrofit2.adapter.rxjava.HttpException; 18 | import rx.Observable; 19 | import rx.observers.TestSubscriber; 20 | import za.co.riggaroo.gus.data.remote.GithubUserRestService; 21 | import za.co.riggaroo.gus.data.remote.model.User; 22 | import za.co.riggaroo.gus.data.remote.model.UsersList; 23 | 24 | import static org.mockito.Matchers.anyString; 25 | import static org.mockito.Mockito.never; 26 | import static org.mockito.Mockito.times; 27 | import static org.mockito.Mockito.verify; 28 | import static org.mockito.Mockito.when; 29 | 30 | public class UserRepositoryImplTest { 31 | 32 | private static final String USER_LOGIN_RIGGAROO = "riggaroo"; 33 | private static final String USER_LOGIN_2_REBECCA = "rebecca"; 34 | @Mock 35 | GithubUserRestService githubUserRestService; 36 | 37 | private UserRepository userRepository; 38 | 39 | @Before 40 | public void setUp() { 41 | MockitoAnnotations.initMocks(this); 42 | userRepository = new UserRepositoryImpl(githubUserRestService); 43 | } 44 | 45 | @Test 46 | public void searchUsers_200OkResponse_InvokesCorrectApiCalls() { 47 | //Given 48 | when(githubUserRestService.searchGithubUsers(anyString())).thenReturn(Observable.just(githubUserList())); 49 | when(githubUserRestService.getUser(anyString())) 50 | .thenReturn(Observable.just(user1FullDetails()), Observable.just(user2FullDetails())); 51 | 52 | //When 53 | TestSubscriber> subscriber = new TestSubscriber<>(); 54 | userRepository.searchUsers(USER_LOGIN_RIGGAROO).subscribe(subscriber); 55 | 56 | //Then 57 | subscriber.awaitTerminalEvent(); 58 | subscriber.assertNoErrors(); 59 | 60 | List> onNextEvents = subscriber.getOnNextEvents(); 61 | List users = onNextEvents.get(0); 62 | Assert.assertEquals(USER_LOGIN_RIGGAROO, users.get(0).getLogin()); 63 | Assert.assertEquals(USER_LOGIN_2_REBECCA, users.get(1).getLogin()); 64 | verify(githubUserRestService).searchGithubUsers(USER_LOGIN_RIGGAROO); 65 | verify(githubUserRestService).getUser(USER_LOGIN_RIGGAROO); 66 | verify(githubUserRestService).getUser(USER_LOGIN_2_REBECCA); 67 | } 68 | 69 | private UsersList githubUserList() { 70 | User user = new User(USER_LOGIN_RIGGAROO); 71 | 72 | User user2 = new User(USER_LOGIN_2_REBECCA); 73 | 74 | List githubUsers = new ArrayList<>(); 75 | githubUsers.add(user); 76 | githubUsers.add(user2); 77 | UsersList usersList = new UsersList(githubUsers); 78 | return usersList; 79 | } 80 | 81 | private User user1FullDetails() { 82 | User user = new User(USER_LOGIN_RIGGAROO, "Rigs Franks", "avatar_url", "Bio1"); 83 | return user; 84 | } 85 | 86 | private User user2FullDetails() { 87 | User user = new User(USER_LOGIN_2_REBECCA, "Rebecca Franks", "avatar_url2", "Bio2"); 88 | return user; 89 | } 90 | 91 | @Test 92 | public void searchUsers_IOExceptionThenSuccess_SearchUsersRetried() { 93 | //Given 94 | when(githubUserRestService.searchGithubUsers(anyString())) 95 | .thenReturn(getIOExceptionError(), Observable.just(githubUserList())); 96 | when(githubUserRestService.getUser(anyString())) 97 | .thenReturn(Observable.just(user1FullDetails()), Observable.just(user2FullDetails())); 98 | 99 | //When 100 | TestSubscriber> subscriber = new TestSubscriber<>(); 101 | userRepository.searchUsers(USER_LOGIN_RIGGAROO).subscribe(subscriber); 102 | 103 | //Then 104 | subscriber.awaitTerminalEvent(); 105 | subscriber.assertNoErrors(); 106 | 107 | verify(githubUserRestService, times(2)).searchGithubUsers(USER_LOGIN_RIGGAROO); 108 | 109 | verify(githubUserRestService).getUser(USER_LOGIN_RIGGAROO); 110 | verify(githubUserRestService).getUser(USER_LOGIN_2_REBECCA); 111 | } 112 | 113 | @Test 114 | public void searchUsers_GetUserIOExceptionThenSuccess_SearchUsersRetried() { 115 | //Given 116 | when(githubUserRestService.searchGithubUsers(anyString())).thenReturn(Observable.just(githubUserList())); 117 | when(githubUserRestService.getUser(anyString())) 118 | .thenReturn(getIOExceptionError(), Observable.just(user1FullDetails()), 119 | Observable.just(user2FullDetails())); 120 | 121 | //When 122 | TestSubscriber> subscriber = new TestSubscriber<>(); 123 | userRepository.searchUsers(USER_LOGIN_RIGGAROO).subscribe(subscriber); 124 | 125 | //Then 126 | subscriber.awaitTerminalEvent(); 127 | subscriber.assertNoErrors(); 128 | 129 | verify(githubUserRestService, times(2)).searchGithubUsers(USER_LOGIN_RIGGAROO); 130 | 131 | verify(githubUserRestService, times(2)).getUser(USER_LOGIN_RIGGAROO); 132 | verify(githubUserRestService).getUser(USER_LOGIN_2_REBECCA); 133 | } 134 | 135 | @Test 136 | public void searchUsers_OtherHttpError_SearchTerminatedWithError() { 137 | //Given 138 | when(githubUserRestService.searchGithubUsers(anyString())).thenReturn(get403ForbiddenError()); 139 | 140 | //When 141 | TestSubscriber> subscriber = new TestSubscriber<>(); 142 | userRepository.searchUsers(USER_LOGIN_RIGGAROO).subscribe(subscriber); 143 | 144 | //Then 145 | subscriber.awaitTerminalEvent(); 146 | subscriber.assertError(HttpException.class); 147 | 148 | verify(githubUserRestService).searchGithubUsers(USER_LOGIN_RIGGAROO); 149 | 150 | verify(githubUserRestService, never()).getUser(USER_LOGIN_RIGGAROO); 151 | verify(githubUserRestService, never()).getUser(USER_LOGIN_2_REBECCA); 152 | } 153 | 154 | 155 | private Observable getIOExceptionError() { 156 | return Observable.error(new IOException()); 157 | } 158 | 159 | private Observable get403ForbiddenError() { 160 | return Observable.error(new HttpException( 161 | Response.error(403, ResponseBody.create(MediaType.parse("application/json"), "Forbidden")))); 162 | 163 | } 164 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------