Skip to content

Latest commit

 

History

History
67 lines (49 loc) · 3.46 KB

DEVELOPMENT.md

File metadata and controls

67 lines (49 loc) · 3.46 KB
Raw

Braintree-Android Development Notes

This document outlines development practices that we follow internally while developing this SDK.

Setup

  • Make sure Java 8 is installed and available in your PATH.
  • If you do not have the Android SDK installed, run ./gradlew build 3 times to download the Android SDK and install all required tools as well as set your local.properties file (we use sdk-manager-plugin to do this automatically).
  • If you do have the Android SDK installed, add a local.properties file to the top level directory with sdk.dir=/path/to/your/sdk/.android-sdk
  • Run ./gradlew :Demo:installDebug to install the Demo app on a device.
  • See the testing section for more about setting up and running tests.

Development Merchant Server

The included demo app utilizes a test merchant server hosted on heroku (https://braintree-sample-merchant.herokuapp.com). It produces client tokens that point to Braintree's Sandbox Environment.

Tests

All tests can be run on the command line with rake. It's a good idea to run rake, before committing.

You can also run rake unit_tests or rake integration_tests if you want to run a subset of the tests. You will need to start an emulator before running rake integration_tests.

Architecture

There are several components that comprise this SDK:

  • Braintree provides the networking, communication and modeling layer for Braintree.
  • BraintreeDataCollector collects and provides data for fraud detection.
  • Core provides shared code across all the modules in the SDK.
  • Demo is a collection of Braintree reference integrations.
  • PayPalOneTouch provides support for PayPal app and browser switch.
  • PayPalDataCollector collects and provides data for PayPal fraud detection.
  • TestUtils contains common test code used between modules.

The individual components may be of interest for advanced integrations and are each available as modules in maven.

Environmental Assumptions

  • Java 8
  • Android Studio
  • Gradle
  • Android SDK >= 21
  • Host app does not integrate with the Kount SDK
  • Host app has a secure, authenticated server with a Braintree server-side integration

Committing

  • Commits should be small but atomic. Tests should always be passing; the product should always function appropriately.
  • Commit messages should be concise and descriptive.

Deployment and Code Organization

  • Code on main is assumed to be in a relatively good state at all times
    • Tests should be passing, all demo apps should run
    • Functionality and user experience should be cohesive
    • Dead code should be kept to a minimum
  • Versioned deployments are tagged with their version numbers
    • Version numbers conform to SEMVER
    • These versions are more heavily tested
    • We will provide support for these versions and commit to maintaining backwards compatibility on our servers
  • Pull requests are welcome
    • Feel free to create an issue on Github before investing development time
  • As needed, the Braintree team may develop features privately
    • If our internal and public branches get out of sync, we will reconcile this with merges (as opposed to rebasing)
    • In general, we will try to develop in the open as much as possible