--- title: Setup slug: setup docTags: createdAt: 2024-11-27T11:42:57.108Z --- # Credentials To be able to add the Toro SDK to your project, you will need access to our Maven repository, which we will provide credentials for. We recommend creating a `toro.properties` file to store the credentials at the root directory of your project. :::CodeblockTabs Properties ```none MAVEN_REPO_URL= MAVEN_USERNAME= MAVEN_PASSWORD= ``` ::: :::hint{type="danger"} Ensure you add `toro.properties` to your `.gitignore` (or equivalent) to avoid commiting the credentials to your project's version control. ::: :::hint{type="info"} You could also set these as environment variables on your system if you wanted. ::: # Add Maven repository to project You will then need to add the repository in your project. :::hint{type="success"} Your `repositories` block could be in `settings.gradle` or project-level `build.gradle` depending on how your project is setup. Our example shows the setup in `settings.gradle`. ::: :::CodeblockTabs Gradle Kotlin DSL ```kotlin // If you are using a properties file, you can load it here val toroProps = java.util.Properties().apply { val propsFile = file("toro.properties") if (propsFile.exists()) { propsFile.inputStream().use { load(it) } } } dependencyResolutionManagement { repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS) repositories { google() // Keep your existing repositories mavenCentral() // Add the Toro Maven repository maven { name = "ToroRepo" url = uri(toroProps.getProperty("MAVEN_REPO_URL") ?: System.getenv("MAVEN_REPO_URL") ?: throw GradleException("No URL found for Toro repository")) credentials { username = toroProps.getProperty("MAVEN_USERNAME") ?: System.getenv("MAVEN_USERNAME") ?: throw GradleException("No username found for Toro repository") password = toroProps.getProperty("MAVEN_PASSWORD") ?: System.getenv("MAVEN_PASSWORD") ?: throw GradleException("No password found for Toro repository") } } } } ``` Gradle Groovy DSL ```java // If you are using a properties file, you can load it here def toroProps = new Properties() def propsFile = file("toro.properties") if (propsFile.exists()) { propsFile.withInputStream { stream -> toroProps.load(stream) } } dependencyResolutionManagement { repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS) repositories { google() // Keep your existing repositories mavenCentral() // Add the Toro Maven repository maven { name 'ToroRepo' url = uri(toroProps.getProperty('MAVEN_REPO_URL') ?: System.getenv('MAVEN_REPO_URL') ?: { throw new GradleException('No URL found for Toro repository') }()) credentials { username = toroProps.getProperty('MAVEN_USERNAME') ?: System.getenv('MAVEN_USERNAME') ?: { throw new GradleException('No username found for Toro repository') }() password = toroProps.getProperty('MAVEN_PASSWORD') ?: System.getenv('MAVEN_PASSWORD') ?: { throw new GradleException('No password found for Toro repository') }() } } } } ``` ::: :::hint{type="info"} In this snippet we support adding credentials from both environment variables and the `toro.properties` file. The reason being it tends to be easier to use a properties file locally, and environment variables are typically better suited for CI/CD pipelines. ::: # Declare the dependencies In your app-level `build.gradle` you can now add the Toro SDK as a dependency. :::CodeblockTabs Kotlin DSL ```kotlin dependencies { releaseImplementation("services.cabcard.toro:toro:$toroVersion") debugImplementation("services.cabcard.toro:toro-debug:$toroVersion") } ``` ```java dependencies { releaseImplementation "services.cabcard.toro:toro:${toroVersion}" debugImplementation "services.cabcard.toro:toro-debug:${toroVersion}" } ``` ::: :::hint{type="warning"} Ensure you declare the dependencies like this. The release variant is obfuscated with logging disabled by default for security reasons. We do retain the mapping, so you can contact us to decode stack traces and help diagnose production issues if necessary. ::: # Manifest Permissions Ensure the following permissions are present in your `AndroidManifest.xml`: ```xml ``` # Initialisation In the sample application, we use [Dagger Hilt](https://dagger.dev/hilt/) to handle dependency injection and initialisation, but you can feel free to use any other method you prefer. ## Dagger Hilt ```kotlin @Module @InstallIn(SingletonComponent::class) object AppModule { @Provides @Singleton fun provideToroClient(@ApplicationContext context: Context): ToroClient { return ToroClient( applicationContext = context, config = ToroConfig( merchant = MerchantConfig( categoryCode = "5812" // Your merchant category code ) ) ) } } ``` Then in your view model, you can inject the `ToroClient` instance: ```kotlin @HiltViewModel class TransactionViewModel @Inject constructor( private val toro: ToroClient ) ``` ## Alternative Create a singleton object to manage the SDK instance: ```kotlin object ToroSdk { private var _instance: ToroClient? = null val instance: ToroClient get() = checkNotNull(_instance) { "ToroSDK not initialised. Call ToroSdk.initialise() in your Application class" } fun initialise(applicationContext: Context) { if (_instance != null) { return // Already initialised } _instance = ToroClient( applicationContext = applicationContext, config = ToroConfig( merchant = MerchantConfig( categoryCode = "5812" // Your merchant category code ) ) ) } } ``` Initialise the SDK in your Application class: ```kotlin class MainApplication : Application() { override fun onCreate() { super.onCreate() ToroSdk.initialise(applicationContext) } } ``` Then use it in your ViewModels or other classes: :::CodeblockTabs ```kotlin class TransactionViewModel : ViewModel() { private val toro = ToroSdk.instance } ``` ```java public class TransactionViewModel extends ViewModel { private final ToroClient toro = ToroSdk.getInstance(); } ``` ::: :::hint{type="warning"} - You **must** provide `applicationContext` (not any other context) to the `ToroClient` constructor. - The SDK should only be initialised once during the app's lifecycle. ::: ##