xploy

appway client written in ruby

Gem Version Travis-CI Build Status Coverage Status Dependency Status Code Climate

Installation

Add this line to your application's Gemfile:

gem 'xploy'

And then execute:

$ bundle

Or install it yourself as:

$ gem install xploy

Usage

Print usage with:

$ xploy

Generate a new app manifest with:

$ xploy new example

Deploy it to your appway instance on http://localhost:8000 with:

$ xploy create --servers=http://localhost:8000 --app.name=example --app.manifest=example.xploy
OK

Recommended Setup

You can store default parameters like app.name and app.manifest in a file named .xploy located in your current working dir.

For an example just have a look at the appway-example folder.

$ cd appway-example

Here you can just redeploy the preconfigured app like so:

$ xploy redeploy

Configuration

--app.name

The application name

--app.manifest

The path to the application manifest

--servers

A list of appway servers that the client must communicate with

--debug

When set to true it will debug all http traffic

--version

Print version

Development

To run the binary from the repository use the following command with ruby libray path:

RUBYLIB=lib bin/xploy

Coding guide

  • Using global methods like Xploy.parameter
    • is allowed for classes / modules defined on the same or a higher level to the Xploy namespace
    • is allowed for classes / modules defined excactly one level below the Xploy namespace
    • e.g. Xploy::Api
    • is not allowed for classes / modules defined more than one level below the Xploy namespace
    • e.g. Xploy::Api::Request
    • these classes should use dependency injection instead

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

Copyright (c) 2013 Jens Bissinger. See LICENSE.txt