Merge pull request #23 from bachya/current-ip-address

Add getCurrentIpAddress action

__tests__/actions/getCurrentIpAddress.spec.ts

@@ -0,0 +1,48 @@
+import { getCurrentIpAddress } from '../../src/actions';
+
+describe('getCurrentIpAddress function', () => {
+
+  it('is a function', () => {
+    expect(typeof getCurrentIpAddress).toBe('function');
+  });
+
+  it('builds a getCurrentIpAddress action', () => {
+    const expected = {
+      WFWorkflowActionIdentifier: 'is.workflow.actions.getipaddress',
+      WFWorkflowActionParameters: {
+        WFIPAddressSourceOption: 'External',
+        WFIPAddressTypeOption: 'IPv4',
+      },
+    };
+    const actual = getCurrentIpAddress({});
+
+    expect(actual).toEqual(expected);
+  });
+
+  it('builds a getCurrentIpAddress action when an address is passed', () => {
+    const expected = {
+      WFWorkflowActionIdentifier: 'is.workflow.actions.getipaddress',
+      WFWorkflowActionParameters: {
+        WFIPAddressSourceOption: 'Local',
+        WFIPAddressTypeOption: 'IPv4',
+      },
+    };
+    const actual = getCurrentIpAddress({ address: 'Local' });
+
+    expect(actual).toEqual(expected);
+  });
+
+  it('builds a getCurrentIpAddress action when a type is passed', () => {
+    const expected = {
+      WFWorkflowActionIdentifier: 'is.workflow.actions.getipaddress',
+      WFWorkflowActionParameters: {
+        WFIPAddressSourceOption: 'External',
+        WFIPAddressTypeOption: 'IPv6',
+      },
+    };
+    const actual = getCurrentIpAddress({ type: 'IPv6' });
+
+    expect(actual).toEqual(expected);
+  });
+
+});

src/actions/getCurrentIpAddress.ts

@@ -0,0 +1,40 @@
+import { withActionOutput } from '../utils';
+
+import WFIPAddressSourceOption from '../interfaces/WF/WFIPAddressSourceOption';
+import WFIPAddressTypeOption from '../interfaces/WF/WFIPAddressTypeOption';
+import WFWorkflowAction from '../interfaces/WF/WFWorkflowAction';
+
+/**
+ * Get Current IP Address Action. Returns the public/private IPv4 or IPv6
+ * address of the device.
+ *
+ * ```js
+ * getCurrentIpAddress({
+ *   'address': 'External',
+ *   'type': 'IPv4',
+ * });
+ * ```
+ */
+const getCurrentIpAddress = (
+  options: {
+    /** The address (public or private) to get */
+    address?: WFIPAddressSourceOption,
+    /** The type of address to get */
+    type?: WFIPAddressTypeOption,
+  },
+): WFWorkflowAction => {
+  const {
+    address = 'External',
+    type = 'IPv4',
+  } = options;
+
+  return {
+    WFWorkflowActionIdentifier: 'is.workflow.actions.getipaddress',
+    WFWorkflowActionParameters: {
+      WFIPAddressSourceOption: address,
+      WFIPAddressTypeOption: type,
+    },
+  };
+};
+
+export default withActionOutput(getCurrentIpAddress);

src/actions/index.ts

@@ -9,6 +9,7 @@ import count from './count';
 import exitShortcut from './exitShortcut';
 import getBatteryLevel from './getBatteryLevel';
 import getContentsOfUrl from './getContentsOfUrl';
+import getCurrentIpAddress from './getCurrentIpAddress';
 import getDictionaryValue from './getDictionaryValue';
 import getName from './getName';
 import getType from './getType';
@@ -46,6 +47,7 @@ export {
   exitShortcut,
   getBatteryLevel,
   getContentsOfUrl,
+  getCurrentIpAddress,
   getDictionaryValue,
   getName,
   getType,

src/interfaces/WF/WFIPAddressSourceOption.ts

@@ -0,0 +1,6 @@
+type WFIPAddressSourceOption = (
+  'External'
+  | 'Local'
+);
+
+export default WFIPAddressSourceOption;

src/interfaces/WF/WFIPAddressTypeOption.ts

@@ -0,0 +1,6 @@
+type WFIPAddressTypeOption = (
+  'IPv4'
+  | 'IPv6'
+);
+
+export default WFIPAddressTypeOption;

src/interfaces/WF/WFWorkflowActionIdentifier.ts

@@ -13,6 +13,7 @@ type WFWorkflowActionIdentifier = (
   | 'is.workflow.actions.exit'
   | 'is.workflow.actions.flashlight'
   | 'is.workflow.actions.getbatterylevel'
+  | 'is.workflow.actions.getipaddress'
   | 'is.workflow.actions.getitemname'
   | 'is.workflow.actions.getitemtype'
   | 'is.workflow.actions.gettext'

src/interfaces/WF/WFWorkflowActionParameters.ts

@@ -6,6 +6,8 @@ import WFGetDictionaryValueType from './WFGetDictionaryValueType';
 import WFHTTPBodyType from './WFHTTPBodyType';
 import WFHTTPMethod from './WFHTTPMethod';
 import WFInputType from './WFInputType';
+import WFIPAddressSourceOption from './WFIPAddressSourceOption';
+import WFIPAddressTypeOption from './WFIPAddressTypeOption';
 import WFMathOperation from './WFMathOperation';
 import WFSerialization from './WFSerialization';
 
@@ -36,6 +38,8 @@ interface WFWorkflowActionParameters {
   WFHTTPHeaders?: WFSerialization;
   WFHTTPMethod?: WFHTTPMethod;
   WFInputType?: WFInputType;
+  WFIPAddressSourceOption?: WFIPAddressSourceOption;
+  WFIPAddressTypeOption?: WFIPAddressTypeOption;
   WFJSONValues?: WFSerialization;
   WFMathOperand?: number;
   WFMathOperation?: WFMathOperation;