Premiumer


Source link: https://github.com/tslamic/premiumer

Showing ads in your app? Wanna offer a single in-app purchase to remove them? Premiumer does just that!

How?

Using Premiumer is incredibly easy. First, add the following dependency:

compile 'com.github.tslamic:premiumer2:1.0'

Then, create an instance:

Premiumer premiumer = PremiumerBuilder.with(context)
  .sku(billingSku)
  .listener(premiumerListnener)
  .build();

Next, bind to the underlying in-app billing service. This should usually follow the Activity or Fragment lifecycle. Also, ensure premiumer can handle purchase results by overriding onActivityResult. For example:

@Override protected void onStart() {

super.onStart();

premiumer.bind();
 
}
  @Override protected void onStop() {

super.onStop();

premiumer.unbind();
 
}
  @Override protected void onActivityResult(int requestCode, int resultCode, Intent data) {

if (!premiumer.handleActivityResult(requestCode, resultCode, data)) {

  super.onActivityResult(requestCode, resultCode, data);

}
 
}

If the in-app billing service is availabe and premiumer was successfully bound, onBillingAvailable() will be invoked on the listener you provided in the builder, onBillingUnavailable() otherwise.

You're now all set! 🎉

To perform a purchase, invoke premiumer.purchase(Activity). This should be the same Activity overriding onActivityResult. Just before a purchase is shipped over to in-app billing service for processing, you'll receive a onPurchaseRequested(String) callback.

The String argument is a developer-specified payload, uniquely identifying a purchase. By default, Premiumer will use a randomly generated UUID, but you can easily provide your own PayloadGenerator when building a Premiumer instance:

PremiumerBuilder.with(context)
  .sku(billingSku)
  .listener(premiumerListnener)
  .payloadGenerator(customGenerator);
 // custom generator
  .build();

Once a purchase is processed, the in-app billing service will return a result to the Activity triggering the purchase. If you've properly overriden onActivityResult, Premiumer will notify you what happened:

Callback Meaning
onPurchaseBadResult (int, Intent) purchase result was not OK, e.g. the user cancelled the purchase flow
onPurchaseBadResponse(Intent) in-app billing response was incomplete or missing information
onPurchaseFailedVerification() purchase verification failed
onPurchaseSuccessful(Purchase) purchase succeeded

By default, no purchase verification is done. You can change that, however, by providing a PurchaseVerifier instance when building Premiumer:

PremiumerBuilder.with(context)
  .sku(billingSku)
  .listener(premiumerListnener)
  .purchaseVerifier(verifier);
 // custom verifier
  .build();

When a purchase is successful, Premiumer will, by default, store the purchase information in plain text to SharedPreferences. You can provide a different caching mechanism by specifying PurchaseCache when building Premiumer:

PremiumerBuilder.with(context)
  .sku(billingSku)
  .listener(premiumerListnener)
  .purchaseCache(cache);
 // custom cache
  .build();

You can always obtain the information about the item you're about to purchase by invoking premiumer.skuDetails(). This will return onSkuDetails(SkuDetails) callback.

Similarly, once a purchase has been made, you can retrieve it by invoking premiumer.purchaseDetails(). This will invoke onPurchaseDetails(Purchase callback.

If, for any reason, you wish to consume a purchase, invoke premiumer.consumeSku(). If successful, onSkuConsumed() will be invoked, onFailedToConsumeSku() otherwise.

Callbacks

As you might have guessed, all Premiumer interaction results in a PremiumerListener callback. Here's the complete list:

Method name Meaning
onShowAds() Invoked if ads should be visible.
onHideAds() Invoked if ads should be hidden.
onBillingAvailable() Invoked if in-app Billing is available.
onBillingUnavailable() Invoked if in-app Billing is unavailable.
onSkuDetails(SkuDetails) Invoked when SkuDetails information is retireved.
onSkuConsumed() Invoked if sku has been successfully consumed.
onFailedToConsumeSku() Invoked if sku has not been successfully consumed.
onPurchaseRequested(String) Invoked on a purchase request.
onPurchaseDetails(Purchase) Invoked when purchase details are retrieved.
onPurchaseSuccessful(Purchase) Invoked on a successful purchase.
onPurchaseBadResult(int, Intent) Invoked when the sku purchase is unsuccessful.
onPurchaseBadResponse(Intent) Invoked when the sku purchase returns bad data.
onPurchaseFailedVerification() Invoked if a purchase has failed verification.

If you feel that's too much, you can cherry pick the methods by extending SimplePremiumerListener.

Contribution

Improvement suggestions, bug reports, pull requests, etc. are very welcome and greatly appreciated!

License

Copyright 2017 Tadej Slamic  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. 

Resources

Navigator code generator for Android.

A tiny, thread safe memory cache implementation which uses a LRU policy.

An uncaught exception handler library.

Android library to place labels next to another. If there is not enough space for the next label, it will be added in a new line.

Handler-based Eventbus for Android.

Android DI, DDD, Specification Pattern, Repository Pattern, IoC.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes