Merge branch 'release/1.0.0'

README.md

@@ -1,2 +1,2 @@
-# firework_android_sdk_examples
+# Firework Android SDK Examples
 Firework Android SDK Examples

app/.gitignore

@@ -0,0 +1 @@
+/build

app/build.gradle.kts

@@ -0,0 +1,75 @@
+plugins {
+    id("com.android.application")
+    id("org.jetbrains.kotlin.android")
+}
+
+android {
+    compileSdk = 32
+
+    defaultConfig {
+        applicationId = "tv.fw.example"
+
+        minSdk = 21
+        targetSdk = 32
+
+        versionCode = 1
+        versionName = "1.0.0"
+
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+    }
+
+    buildTypes {
+        defaultConfig {
+            buildConfigField("String", "FW_CLIENT_ID", "\"f6d6ec1275217f178cdff91363825cb390e038c1168f64f6efa23cb95ec6b325\"")
+        }
+        release {
+            isMinifyEnabled = false
+            proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro")
+        }
+    }
+
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_1_8
+        targetCompatibility = JavaVersion.VERSION_1_8
+    }
+
+    kotlinOptions {
+        jvmTarget = JavaVersion.VERSION_1_8.toString()
+    }
+
+    buildFeatures {
+        viewBinding = true
+    }
+}
+
+dependencies {
+    implementation("androidx.core:core-ktx:1.7.0")
+    implementation("androidx.appcompat:appcompat:1.4.1")
+    implementation("com.google.android.material:material:1.6.0")
+    implementation("androidx.constraintlayout:constraintlayout:2.1.3")
+
+    testImplementation("junit:junit:4.13.2")
+
+    implementation(platform("org.jetbrains.kotlin:kotlin-bom:1.6.10"))
+    implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
+    testImplementation("org.jetbrains.kotlin:kotlin-test")
+
+    androidTestImplementation("androidx.test.ext:junit:1.1.3")
+    androidTestImplementation("androidx.test.espresso:espresso-core:3.4.0")
+
+    // Glide
+    implementation("com.github.bumptech.glide:glide:4.12.0")
+
+    // Firework Android SDK v2
+    val fireworkSdkVersion = "1.0.0"
+    implementation("com.github.loopsocial.firework_sdk_v2:fireworkSdk:$fireworkSdkVersion")
+
+    // Carousel feature
+    implementation("com.github.loopsocial.firework_sdk_v2:carouselFeature:$fireworkSdkVersion")
+
+    // Glide (optional)
+    implementation("com.github.loopsocial.firework_sdk_v2:glideImageLoader:$fireworkSdkVersion")
+
+    // Picasso (optional)
+    // implementation("com.github.loopsocial.firework_sdk_v2:picassoImageLoader:$fireworkSdkVersion")
+}

app/proguard-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.kts.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

app/src/androidTest/java/tv/fw/example/ExampleInstrumentedTest.kt

@@ -0,0 +1,22 @@
+package tv.fw.example
+
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import androidx.test.platform.app.InstrumentationRegistry
+import org.junit.Assert.assertEquals
+import org.junit.Test
+import org.junit.runner.RunWith
+
+/**
+ * Instrumented test, which will execute on an Android device.
+ *
+ * See [testing documentation](http://d.android.com/tools/testing).
+ */
+@RunWith(AndroidJUnit4::class)
+class ExampleInstrumentedTest {
+    @Test
+    fun useAppContext() {
+        // Context of the app under test.
+        val appContext = InstrumentationRegistry.getInstrumentation().targetContext
+        assertEquals("tv.fw.example", appContext.packageName)
+    }
+}

app/src/main/AndroidManifest.xml

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools"
+    package="tv.fw.example">
+
+    <application
+        android:name=".ExampleApplication"
+        android:allowBackup="true"
+        android:dataExtractionRules="@xml/data_extraction_rules"
+        android:fullBackupContent="@xml/backup_rules"
+        android:icon="@mipmap/ic_launcher"
+        android:label="@string/app_name"
+        android:roundIcon="@mipmap/ic_launcher_round"
+        android:supportsRtl="true"
+        android:theme="@style/Theme.FireworkExample"
+        tools:targetApi="31">
+        <activity
+            android:name=".MainActivity"
+            android:exported="true">
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN" />
+
+                <category android:name="android.intent.category.LAUNCHER" />
+            </intent-filter>
+        </activity>
+
+        <!-- this is required by Firework Android SDK v2 to get advertising_id from Android Ad SDK -->
+        <meta-data
+            android:name="com.google.android.gms.ads.AD_MANAGER_APP"
+            android:value="true" />
+    </application>
+
+</manifest>

app/src/main/java/tv/fw/example/ExampleApplication.kt

@@ -0,0 +1,25 @@
+package tv.fw.example
+
+import android.app.Application
+import tv.fw.example.BuildConfig.FW_CLIENT_ID
+import tv.fw.fireworksdk.FireworkSdk
+import tv.fw.fireworksdk.FireworkSdkConfig
+import tv.fw.imageloading.glide.GlideImageLoaderFactory
+
+class ExampleApplication : Application() {
+
+    override fun onCreate() {
+        super.onCreate()
+
+        // build Firework Android SDK v2 configuration
+        val config = FireworkSdkConfig.Builder(this)
+            .checksumRequired(false)
+            .clientId(FW_CLIENT_ID) // Client OAUTH Id
+            .userId("example app user ID") // User Id in your eco-system
+            .imageLoader(GlideImageLoaderFactory.createInstance()) // glide, picasso, or your implementation
+            .build()
+
+        // initialize Firework Android SDK v2
+        FireworkSdk.init(config)
+    }
+}

app/src/main/java/tv/fw/example/MainActivity.kt

@@ -0,0 +1,58 @@
+package tv.fw.example
+
+import android.graphics.Color
+import android.os.Bundle
+import android.view.LayoutInflater
+import androidx.appcompat.app.AppCompatActivity
+import tv.fw.carousel.options.ViewOptions
+import tv.fw.common.AdBadgeTextType
+import tv.fw.common.FeedLayout
+import tv.fw.common.FeedResource
+import tv.fw.common.PlayerMode
+import tv.fw.example.databinding.ActivityMainBinding
+
+class MainActivity : AppCompatActivity() {
+
+    lateinit var binding: ActivityMainBinding
+
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        binding = ActivityMainBinding.inflate(LayoutInflater.from(this))
+        setContentView(binding.root)
+
+        setupCarouselView()
+    }
+
+    private fun setupCarouselView() {
+        val carouselView = binding.carouselView
+
+        // You can create a view options with your custom parameters or ignore this step if you already have them in your layout
+        // Also creating ViewOptions is not mandatory and you can let the widget use its default values
+        val viewOptions = ViewOptions.Builder()
+            .feedLayout(FeedLayout.GRID)
+            .columnCount(3)
+            .pageSize(30)
+            .backgroundColor(Color.BLACK)
+            .itemSpacing(48)
+            .roundedCorner(true)
+            .roundedCornerRadius(2.0F)
+            .showFeedTitle(true)
+            .feedTextColor(Color.WHITE)
+            .feedBackgroundColor(Color.GRAY)
+            .feedTextNumberOfLines(1)
+            .feedTextPadding(12)
+            .feedTextSize(12)
+            .playerMode(PlayerMode.FIT_MODE)
+            .showPlayIcon(true)
+            .supportBackwardAds(true)
+            .feedResource(FeedResource.Discovery) // It also can be Channel and Playlist
+            .adBadgeBackColor(Color.CYAN)
+            .adBadgeTextColor(Color.WHITE)
+            .adBadgeLabel(AdBadgeTextType.SPONSORED)
+            .build()
+
+        // carouselView.init(viewOptions)
+
+        carouselView.init()
+    }
+}

app/src/main/res/drawable-v24/ic_launcher_foreground.xml

@@ -0,0 +1,30 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:aapt="http://schemas.android.com/aapt"
+    android:width="108dp"
+    android:height="108dp"
+    android:viewportWidth="108"
+    android:viewportHeight="108">
+    <path android:pathData="M31,63.928c0,0 6.4,-11 12.1,-13.1c7.2,-2.6 26,-1.4 26,-1.4l38.1,38.1L107,108.928l-32,-1L31,63.928z">
+        <aapt:attr name="android:fillColor">
+            <gradient
+                android:endX="85.84757"
+                android:endY="92.4963"
+                android:startX="42.9492"
+                android:startY="49.59793"
+                android:type="linear">
+                <item
+                    android:color="#44000000"
+                    android:offset="0.0" />
+                <item
+                    android:color="#00000000"
+                    android:offset="1.0" />
+            </gradient>
+        </aapt:attr>
+    </path>
+    <path
+        android:fillColor="#FFFFFF"
+        android:fillType="nonZero"
+        android:pathData="M65.3,45.828l3.8,-6.6c0.2,-0.4 0.1,-0.9 -0.3,-1.1c-0.4,-0.2 -0.9,-0.1 -1.1,0.3l-3.9,6.7c-6.3,-2.8 -13.4,-2.8 -19.7,0l-3.9,-6.7c-0.2,-0.4 -0.7,-0.5 -1.1,-0.3C38.8,38.328 38.7,38.828 38.9,39.228l3.8,6.6C36.2,49.428 31.7,56.028 31,63.928h46C76.3,56.028 71.8,49.428 65.3,45.828zM43.4,57.328c-0.8,0 -1.5,-0.5 -1.8,-1.2c-0.3,-0.7 -0.1,-1.5 0.4,-2.1c0.5,-0.5 1.4,-0.7 2.1,-0.4c0.7,0.3 1.2,1 1.2,1.8C45.3,56.528 44.5,57.328 43.4,57.328L43.4,57.328zM64.6,57.328c-0.8,0 -1.5,-0.5 -1.8,-1.2s-0.1,-1.5 0.4,-2.1c0.5,-0.5 1.4,-0.7 2.1,-0.4c0.7,0.3 1.2,1 1.2,1.8C66.5,56.528 65.6,57.328 64.6,57.328L64.6,57.328z"
+        android:strokeWidth="1"
+        android:strokeColor="#00000000" />
+</vector>