Merge pull request #253 from sandeep-vedam/pin-context

Pin context

Author: michielvandergeest

docs/plugins/pin.md

@@ -36,15 +36,17 @@ Pin.hide()
 
 Sends a Pin code to the middleware layer for verification. If the code is correct, the STB will be unlocked.
 
+The `submit` method accepts `pin` and `context` as it's arguments. The context argument indicates in with what purpsose the Pin dialog is being used. The accepted values van be either `parental` or `purchase`. `context` defaults to `purchase`, but it's recommended to explicitly specify the context
+
 The `submit` method is automatically invoked when you are using the built-in **Pin** dialog. Use this method for sending the Pin code *only* if you are making a fully custom **Pin** dialog in your App.
 
 ```js
-Pin.submit('0000')
+Pin.submit('0000', context)
   .then(() => console.log('Unlocked!'))
   .catch(e => console.log('Pin error', e))
 ```
 
-The `submit` method returns a *Promise*. If the supplied Pin code is correct, the Promise resolves with `true` and the STB will be unlocked. If the Pin code is wrong, the Promise resolves with `false`.
+The `submit` method returns a *Promise*. If the supplied Pin code is correct (and context is valid), the Promise resolves with `true` and the STB will be unlocked. If the Pin code or context are wrong, the Promise resolves with `false`.
 
 If the middleware is unable to unlock the STB, the Promise is *rejected* (with an optional error message).
 
@@ -55,7 +57,7 @@ During development, the default Pin code is  `0000`. Optionally, you can overwri
 Checks if the STB is currently *unlocked*.
 
 ```js
-Pin.unlocked()
+Pin.unlocked(context)
   .then(
     unlocked => unlocked === true ?
       console.log('STB is unlocked') :
@@ -71,7 +73,7 @@ If the middleware is unable to retrieve the current state, the Promise is *rejec
 Checks if the STB is currently *locked*.
 
 ```js
-Pin.locked()
+Pin.locked(context)
   .then(
     locked => locked === true ?
       console.log('STB is locked') :

src/Pin/index.js

@@ -20,11 +20,13 @@
 import Settings from '../Settings'
 import PinDialog from './dialog'
 import { ApplicationInstance } from '../Launch'
+import { Log } from '../../index'
 
 // only used during local development
 let unlocked = false
+const contextItems = ['purchase', 'parental']
 
-let submit = pin => {
+let submit = (pin, context) => {
   return new Promise((resolve, reject) => {
     if (pin.toString() === Settings.get('platform', 'pin', '0000').toString()) {
       unlocked = true
@@ -35,7 +37,7 @@ let submit = pin => {
   })
 }
 
-let check = () => {
+let check = context => {
   return new Promise(resolve => {
     resolve(unlocked)
   })
@@ -52,6 +54,17 @@ export const initPin = config => {
 
 let pinDialog = null
 
+const contextCheck = context => {
+  if (context === undefined) {
+    Log.info('Please provide context explicitly')
+    return contextItems[0]
+  } else if (!contextItems.includes(context)) {
+    Log.warn('Incorrect context provided')
+    return false
+  }
+  return context
+}
+
 // Public API
 export default {
   show() {
@@ -73,34 +86,49 @@ export default {
     )
     pinDialog = null
   },
-  submit(pin) {
+  submit(pin, context) {
     return new Promise((resolve, reject) => {
       try {
-        submit(pin)
-          .then(resolve)
-          .catch(reject)
+        context = contextCheck(context)
+        if (context) {
+          submit(pin, context)
+            .then(resolve)
+            .catch(reject)
+        } else {
+          reject('Incorrect Context provided')
+        }
       } catch (e) {
         reject(e)
       }
     })
   },
-  unlocked() {
+  unlocked(context) {
     return new Promise((resolve, reject) => {
       try {
-        check()
-          .then(resolve)
-          .catch(reject)
+        context = contextCheck(context)
+        if (context) {
+          check(context)
+            .then(resolve)
+            .catch(reject)
+        } else {
+          reject('Incorrect Context provided')
+        }
       } catch (e) {
         reject(e)
       }
     })
   },
-  locked() {
+  locked(context) {
     return new Promise((resolve, reject) => {
       try {
-        check()
-          .then(unlocked => resolve(!!!unlocked))
-          .catch(reject)
+        context = contextCheck(context)
+        if (context) {
+          check(context)
+            .then(unlocked => resolve(!!!unlocked))
+            .catch(reject)
+        } else {
+          reject('Incorrect Context provided')
+        }
       } catch (e) {
         reject(e)
       }