EXPERIMENTAL CODE. NOT READY FOR PRODUCTION USE.

mobware-client

Appcelerator API Builder client CLI

install

$ npm install -g mobware-client

usage

enable

Enables a Titanium project for API Builder. It makes an HTTPS request to API Builder servers and gets API keys in return. The keys are then added to the user's tiapp.xml file.

  Usage: mobware-client-enable username password [options]

  Options:

    -h, --help             output usage information
    -a, --app-id <app-id>  App ID with which to associate this API Builder enablement
    -H, --host <host>      The host for connecting to the API Builder server
    -P, --no-prompt        No interactive prompting
    -p, --port <port>      The port for connecting to the API Builder server
    -t, --tiapp <tiapp>    Path to tiapp.xml to be updated

  Examples:

    # specify only the required values, use defaults for the rest
    $ mobware-client enable myusername mypassword

    # configure it heavily
    $ mobware-client enable myusername mypassword --tiapp /path/to/tiapp.xml \
        --host 360-dev.appcelerator.com --port 443 \
        --appId 7bd1239e-b199-4fbc-9c1c-30aa0b8d08ea

The result of a successful call:

<ti:app>
	<property name="mw-key-dev" type="string">DEVKEY</property>
	<property name="mw-key-prod" type="string">PRODKEY</property>
</ti:app>

disable

The opposite of enable, this process will remove API Builder API keys from your tiapp.xml, thereby invalidating any API Builder SDK usage. It exits quietly if no keys are present in the tiapp.xml.

  Usage: mobware-client-disable [options]

  Options:

    -h, --help           output usage information
    -t, --tiapp <tiapp>  Path to tiapp.xml

  To disable API Builder in a project:

    $ mobware-client disable --tiapp /path/to/tiapp.xml

keys

Get the API Builder API keys from the tiapp.xml of an API Builder-enabled project.

  Usage: mobware-client-keys [options]

  Options:

    -h, --help           output usage information
    -k, --keys <keys>    Key type to return. Can be a comma-separated list.
    -t, --tiapp <tiapp>  Path to tiapp.xml

  Examples:

    # list all API Builder keys for an enabled project
    $ mobware-client keys
      { "development": "DEVKEY", "production": "PRODKEY" }

    # list specific key
    $ mobware-client keys --keys production
      { "production": "PRODKEY" }

    # list specific keys as comma-separated list
    $ mobware-client keys --keys production,development
      { "development": "DEVKEY", "production": "PRODKEY" }

sdk

Install, get, or set the API Builder SDK for a project.

  Usage: mobware-client-sdk install|get|set [NAME] [VERSION] [options]

  Options:

    -h, --help                 output usage information
    -f, --force                overwrite existing updates
    -H, --host <host>          The host for connecting to the API Builder server
    -p, --password <password>  password for 360 auth
    -P, --port <port>          The port for connecting to the API Builder server
    -t, --tiapp <tiapp>        Path to tiapp.xml
    -u, --username <username>  username for 360 auth

  Examples:

    # install any available API Builder SDKs
    $ mobware-client install

    # install specific API Builder SDK, with optional version
    $ mobware-client install my.apibuilder.sdk
    $ mobware-client install [email protected]

    # get current API Builder SDK name from tiapp.xml
    $ mobware-client sdk get
      name.of.mobwareSdk

    # set API Builder SDK
    $ mobware-client sdk set my.mw.sdk

    # set API Builder SDK with version
    $ mobware-client sdk set my.mw.sdk 2.0

The set command above would generate a section like this in your tiapp.xml:

<ti:app>
	<modules>
		<module version="2.0" platform="commonjs">ti.mw.todo</module>
	</modules>
</ti:app>

Testing & Coverage

# run tests & linting
$ grunt

# generate code coverage report
$ grunt coverage

Reporting Bugs or submitting fixes

If you run into problems, please create an Issue or, even better, send us a pull request.

Contributing

To protect the interests of the mobware-client contributors, Appcelerator, customers and end users we require contributors to sign a Contributors License Agreement (CLA) before we pull the changes into the main repository. Our CLA is simple and straightforward - it requires that the contributions you make to any Appcelerator open source project are properly licensed and that you have the legal authority to make those changes. This helps us significantly reduce future legal risk for everyone involved. It is easy, helps everyone, takes only a few minutes, and only needs to be completed once.

You can digitally sign the CLA online. Please indicate your email address in your first pull request so that we can make sure that will locate your CLA. Once you've submitted it, you no longer need to send one for subsequent submissions.

Legal

Copyright (c) 2014 by Appcelerator, Inc. All Rights Reserved. This code contains patents and/or patents pending by Appcelerator, Inc. mobware-client is a trademark of Appcelerator, Inc. This project is licensed under the Apache Public License, version 2. Please see details in the LICENSE file.