Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hummatli/AndroidAppUpdater

:sunny::package::racehorse: An Android library to check new versions(update) of your Android applications on the PlayStore (free, open source, third party).
https://github.com/hummatli/AndroidAppUpdater

android android-apps android-library free-library java kotlin opensource-android-tool opensource-library update-checker

Last synced: about 2 months ago
JSON representation

:sunny::package::racehorse: An Android library to check new versions(update) of your Android applications on the PlayStore (free, open source, third party).

Host: GitHub
URL: https://github.com/hummatli/AndroidAppUpdater
Owner: hummatli
License: apache-2.0
Created: 2016-07-12T07:06:59.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2023-02-12T20:52:25.000Z (almost 2 years ago)
Last Synced: 2024-08-09T13:17:03.023Z (6 months ago)
Topics: android, android-apps, android-library, free-library, java, kotlin, opensource-android-tool, opensource-library, update-checker
Language: Kotlin
Homepage:
Size: 11 MB
Stars: 178
Watchers: 7
Forks: 59
Open Issues: 11
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

AndroidAppUpdater - Java (Kotlin, Android)

Android Library

A free, open source, third party Android library to notify the update information about the installed android apps on an android device. The library has been built with the Kotlin language. Check out the wiki link. To support,

## Description
AndroidAppUpdater is a free, open source, third party Android library for notifing update information to android apps installed on an android device. By its help, an old application is notified about update information from the Google Play Market.
`Library has built with Kotlin language on Android Studio IDE` and binaries have added to `jcenter()` `maven` repository.
You can check [jCenter() download statistics](https://bintray.com/hummatli/maven/android-app-updater#statistics) on this [link](https://bintray.com/hummatli/maven/android-app-updater#statistics)
There is a list of [application using AndroidAppUpdater](https://github.com/hummatli/AndroidAppUpdater#applications-using-androidappupdater). It would be nice if see your app link there too. If you use this library and want to see your app in the start of the [list](https://github.com/hummatli/AndroidAppUpdater#applications-using-androidappupdater) please [inform me](mailto:[email protected]) or send a pull request.

* [jCenter() download statistics](https://bintray.com/hummatli/maven/android-app-updater#statistics)
* [Application using AndroidAppUpdater](https://github.com/hummatli/AndroidAppUpdater#applications-using-androidappupdater)

_**Don't forget to start the protect to support us**_

## Contributors
* Developer - Main functionality:
[Sattar Hummatli](https://github.com/hummatli) - [LinkedIn](https://www.linkedin.com/in/hummatli), [email protected], [Other libs](https://github.com/hummatli/AndroidAppUpdater#other-libraries-by-developer)
* Developer - Added new feature:
[andrewpros](https://github.com/andrewpros) , Thanks!, `New Feature: "Info Resolver"`. Now you can get information from your own formatted service
* Translator `Portuguese`: [azzarr](https://github.com/azzarr) , Thanks!
* Translator `Hindi`: [dalwadi2](https://github.com/dalwadi2), Thanks!
* Translator `German`: [Ndam Njoya](https://www.facebook.com/ndam.njoya), Thanks!
* Translator `French`: [Zeldarck](https://github.com/Zeldarck), Thanks!, Has changed sample apps to support `French`.
* Translator `Greek`: [Nikos Linakis](https://github.com/hastoukopsaro), Thanks!.

## Contents
* [Description](https://github.com/hummatli/AndroidAppUpdater#description)
* [Service structure](https://github.com/hummatli/AndroidAppUpdater#service-structure)
* [Library structure](https://github.com/hummatli/AndroidAppUpdater#library-structure)
* [Installation manual](https://github.com/hummatli/AndroidAppUpdater#installation-manual)
* [Help - Issues](https://github.com/hummatli/AndroidAppUpdater#help---issues)
* [Releases - Upgrade documentation](https://github.com/hummatli/AndroidAppUpdater#releases---upgrade-documentation)
* [To contribute](https://github.com/hummatli/AndroidAppUpdater#to-contribute)
* [Contributors](https://github.com/hummatli/AndroidAppUpdater#contributors)
* [Localization](https://github.com/hummatli/AndroidAppUpdater#localization)
* [Applications using AndroidAppUpdater](https://github.com/hummatli/AndroidAppUpdater#applications-using-androidappupdater)
* [Other libraries by developer](https://github.com/hummatli/AndroidAppUpdater#other-libraries-by-developer)

## Demo App
Download the demo app from this link - Demo App. You can easly test the lib's functionality.

## Service structure
To provide update information to your app you need to implement service responding json data about application current state. Structure of the json data is as below.
You can provide `http://` and `https://` services. Library works both of them.

Json with sample data. [Link](https://github.com/MobAppHome/MAHServiceForMyApps/blob/master/public/mah_android_updater_dir/mah_android_updater_sample.json) to working sample

```json
{
"is_run_mode":"true",
"name":"AndroidAppUpdater Sample",
"uri_current":"com.mobapphome.mahandroidupdater.sample",
"version_code_current":"2",
"version_code_min":"1",
"update_info":"On version 1.0 we added bla bla",
"update_date":"16/07/2016"
}
```
* `is_run_mode` - service mode: if it's false modul will not react to service and will not show dialogs
* `name` - name of the belonging app
* `uri_current` - current package path
* `version_code_current` - current version code avilable
* `version_code_min` - Minimum version code, which does not work normal and had to force to update
* `update_info` - Update information
* `update_date` - Update date

If one of the variables would not be on json, then modul will not repond to service and act, Try to implement all data.

You can check you json validity with this [jsonlint.com](http://jsonlint.com/)

There is interface called `IUpdateInfoResolver` by the help of it you can fetch your update information form own structed service. For example `JSON API`, `XML`,`Raw text` and so on. For this reason there is special `init()` method accepting this variable. This feature has added by @andrewpros.

## Library structure
`You can call with the same way in Kotlin and Java. Library contains samples both in Kotlin and Java`
Library components:
* `AAUpdaterDlg`- In this situation dialog show to user to update or install newer version and lets to postpone the action to later time and use application
* `AAUpdaterRestricterDlg` - In this situation dialog urges user to update or install newer version and dont alow use older version

The porpose of lib to show automatically these dialogs on application start if there are any need for it.
**-** `AAUpdaterDlg` opens on following situation.
* Or `uri_current` value is different from app's installed package url
* Or `version_code_current` value is greater than app's installed version on device

**-** `AAUpdaterRestricterDlg` opens on all situation `AAUpdaterDlg` opens and following situation.
* `version_code_min` value is greater than app's installed version on device

But when you develop your apps UI and want to show these dialogs there are test modes also and you can open dialogs by calling methods relatively
* `AAUpdaterController.testUpdaterDlg(activity)` - `AAUpdaterDlg`
* `AAUpdaterController.testRestricterDlg(activity)` - `AAUpdaterRestricterDlg`

## Installation manual
The lib has compiled with the gradle 4.6.

**1)** To import library to you project add following lines to project's `build.gradle` file.
The last stable version is `1.3.3`

```gradle
repositories {
maven { url 'https://dl.bintray.com/hummatli/maven/' }
}

dependencies {
//The android-app-updater libary
implementation 'com.mobapphome.library:android-app-updater:1.3.3'

//These dependencies have been used in this lib so you need to include them acording to gradle 3.0 and upper
implementation 'com.google.code.gson:gson:2.8.2'
implementation 'org.jsoup:jsoup:1.10.2'
}
```

**2)** On the start of your application call `AAUpdaterController.init()` method to initialize modul. For example: MainActivity's `onCreate()` method or in splash activity. Check http url is correct and points to your service on the web.
Code:
```java kotlin
AAUpdaterController.init(activity,"http://highsoft.az/android-app-updater-sample.php")
```

**3)** When you quit app, you have to call `AAUpdaterController.end()` method to finalize modul. For example: MainActivity's `onDestroy()` method.
```java kotlin
AAUpdaterController.end()
```

**4)** To customize `AndroidAppUpdater` dialog UI and overide colors set these values on your main projects `color.xml` file
```xml
#FFFFFFFF
#FF3F51B5
#FF3F51B5

#a33F51B5
#ff3F51B5
#ffffffff

#ffFF4081
```

**5)** `Localization:` Following languages is supporting by the lib - [Supported Languages](https://github.com/hummatli/AndroidAppUpdater#localization). To set localization to app use your own method or if it is static and don't change in program session you can just simply add `LocaleUpdater.updateLocale(this, "your_lang");` in the start of your app. For examlpe `LocaleUpdater.updateLocale(this, "ru");`

**6)** To customize `AndroidAppUpdater` UI texts and overide them add these lines to main projects `string.xml` and set them values.
To help translators there prefixes on the name of strings
* < command verb (actions)> - These are commands verbs. Meaninaction on UI , dialogs
* < noun > - these are nouns not action (verb)

```xml
Update information

Later
Close
Update
Install
Open new version
Uninstall old

Application has moved to new address. Please install newer version
New version is available. Please update application
This is old version and does not operate. An application has moved to new address. \nPlease install newer version
This is old version and does not operate. Please update application
This is old version and does not operate. Please open new version

Check your internet connection
Install Google Play Services to update application
\"AndroidAppUpdater\" library
```

**7)** To customize `Info button` on the `right - upper` corner of dialogs. You can do it with help of `AAUpdaterController.init()` method. It has three version. `init()`This method well documented and you can see it when developing your app.
You can do followings with `Info button`:
* Change visibility
* Set your own name or url to open when click on info button
* Open popup menu or act as button when click on info button

**8)** As modul takes information from web servcie you need add `INTERNET` permission to main project.
```xml

```

## Proguard configuration
AndroidAppUpdater uses Gson and Jsoup libs. There for if you want to create your project with proguard you need to add proguard configuration to your proguard file. Look at [Progurda File](https://github.com/hummatli/AndroidAppUpdater/blob/master/proguard-rules-android-app-updater.pro).

## Help - Issues
If you have any problem with setting and using library or want to ask question, please let me know. Create [issue](https://github.com/hummatli/AndroidAppUpdater/issues) or write to [email protected]. I will help.

## To contribute
I am open to hear offers and opinions from you

* Fork it
* Create your feature branch (git checkout -b my-new-feature)
* Commit your changes (git commit -am 'Added some feature')
* Push to the branch (git push origin my-new-feature)
* Create new Pull Request
* Star it

## Localization
Library now supports following languages
* Azerbaijan
* English
* German
* Greek
* Hindi
* Portuguese
* Russia
* Turkey
* [Add your language](https://github.com/hummatli/AndroidAppUpdater/blob/master/README.md#to-contribute-for-localization)

### To contribute for localization
**To help translator in context I have added prefixes to the start of the string names.
Be carefull when translating. Prefixes are following:**
_* < command verb (actions)> - These are commands verbs. Meaninaction on UI , dialogs_
_* < noun > - these are nouns not action (verb)_

We need help to add new language localization support for libarary. If you have any hope to help us we were very happy and you can check following GitHub Issues URL to contribute. To contribute get | [Indian Railway PNRStatus IRCTC](https://play.google.com/store/apps/details?id=com.emilartin.travel.indianrailwaypnrstatusirctc)
| [Миллионер - на Pусском](https://play.google.com/store/apps/details?id=iqra.viktorina.intellektualnoy.iq.millionaire.russian.millioner.russkiy) | | [Milyoner - Türkçe](https://play.google.com/store/apps/details?id=oyun.bilgi.entellektuel.iq.millionaire.turkish.milyoner.turkce)
| [Millionaire - in English](https://play.google.com/store/apps/details?id=game.quiz.intellectual.iq.millionaire.english) | | [Məzənnə](https://play.google.com/store/apps/details?id=com.mobapphome.currency)
| [AppCrossPromoter - Sample](https://play.google.com/store/apps/details?id=com.mobapphome.mahads.sample) | | [AndroidAppUpdater - Sample](https://play.google.com/store/apps/details?id=androidappupdater.sample)
| [SimpleEncryptorLib - Sample](https://play.google.com/store/apps/details?id=com.mobapphome.mahencryptorlib) | | [Ləzzət](https://play.google.com/store/apps/details?id=com.mobapphome.lezzet)
| [Milyonçu](https://play.google.com/store/apps/details?id=oyun.test.sualcavab.iq.millionaire.azerbaijani.milyoncu.azerbaycanca) | | [Millionär - Deutsche](https://play.google.com/store/apps/details?id=spiel.quiz.intellektuell.iq.millionaire.german.millionar.deutsche)

## Other libraries by developer
* [![AppCrossPromoter](https://img.shields.io/badge/GitHUB-AppCrossPromoter-green.svg)](https://github.com/hummatli/AppCrossPromoter) - Library for advertisement own apps through your other apps.
* [![SimpleEncryptorLib](https://img.shields.io/badge/GitHUB-SimpleEncryptorLib-green.svg)](https://github.com/hummatli/SimpleEncryptorLib) - Library for encryption and decryption strings on Android apps and PC Java applications.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.