Merge pull request #44 from petehayes102/master

Total rewrite using Tokio and Futures

Author: petehayes102

.gitignore

@@ -1,3 +1,3 @@
-Cargo.lock
-.pkg/
 /target/
+**/*.rs.bk
+Cargo.lock

.travis.yml

@@ -3,64 +3,20 @@ rust:
   - stable
   - beta
   - nightly
-sudo: false
-
-addons:
-  apt:
-    sources:
-      - sourceline: 'ppa:chris-lea/libsodium'
-      - sourceline: 'deb http://ppa.launchpad.net/chris-lea/libsodium/ubuntu trusty main'
-      - sourceline: 'deb-src http://ppa.launchpad.net/chris-lea/libsodium/ubuntu trusty main'
-    packages:
-      - libcurl4-openssl-dev
-      - libelf-dev
-      - libdw-dev
-      - binutils-dev
-      - libsodium-dev
-
-before_script:
-  - |
-      export PATH=$HOME/.local/bin:$PATH
-      export LIBRARY_PATH=$HOME/lib
-      export LD_LIBRARY_PATH=$HOME/lib
-      export PKG_CONFIG_PATH=$HOME/lib/pkgconfig
-
-      curl -sSOL https://github.com/zeromq/libzmq/releases/download/v4.2.0/zeromq-4.2.0.tar.gz
-      tar zxf zeromq-4.2.0.tar.gz
-      cd zeromq-4.2.0
-      ./autogen.sh
-      ./configure --prefix=$HOME --with-libsodium
-      make && make install
-      cd ..
-
-      curl -sSOL https://github.com/zeromq/czmq/releases/download/v4.0.1/czmq-4.0.1.tar.gz
-      tar zxf czmq-4.0.1.tar.gz
-      cd czmq-4.0.1
-      ./configure --prefix=$HOME
-      make && make install
-      cd $TRAVIS_BUILD_DIR
-
+matrix:
+  allow_failures:
+    - rust: nightly
+cache: cargo
 script:
-  - cargo build --verbose
-  - cargo test --verbose
-  - |
-      ln -s "$HOME/lib/libczmq.so.4" target/debug
-      ln -s "$HOME/lib/libzmq.so.5" target/debug
-
-      cd bindings
-
-      for VER in 5 7
-      do
-        cd "php$VER"
-        ln -s ../c include
-        phpize
-        ./configure --with-inapi=../../target/debug
-        make
-        TEST_PHP_ARGS="-q" make test || exit 1
-        cd ..
-      done
-
-      cd ..
-
+  - cargo build --verbose --all
+  - cargo test --verbose --all
+  - cargo doc --verbose --all --no-deps
+deploy:
+  provider: pages
+  skip_cleanup: true
+  local_dir: $TRAVIS_BUILD_DIR/target/doc
+  github_token: $GITHUB_TOKEN
+  on:
+    branch: master
 env:
   - TRAVIS_CARGO_NIGHTLY_FEATURE=""

AUTHORS

@@ -1,39 +1,7 @@
-[package]
-name = "intecture-api"
-version = "0.3.2"
-authors = [ "Peter Hayes <peter.hayes@betweenlines.co.uk>" ]
-license = "MPL-2.0"
-description = "API component for Intecture infrastructure. Intecture is the developer friendly, multi-lingual configuration management tool."
-keywords = ["intecture", "api"]
-homepage = "https://intecture.io"
-repository = "https://github.com/intecture/api"
-build = "build.rs"
-
-[features]
-default = ["remote-run"]
-# Run API endpoints against the local machine
-local-run = []
-# Run API endpoints against a remote agent
-remote-run = ["czmq"]
-
-[dev-dependencies]
-tempdir = "0.3"
-
-[dependencies]
-lazy_static = "0.2"
-libc = "0.2"
-mustache = "0.8"
-regex = "0.2"
-rustc-serialize = "0.3"
-serde = "0.9"
-serde_derive = "0.9"
-serde_json = "0.9"
-tempfile = "2.1"
-zfilexfer = "0.0.2"
-hostname = "0.1"
-czmq = { version = "0.1", optional = true }
-pnet = "0.16"
-
-[lib]
-name = "inapi"
-crate_type = ["rlib", "dylib"]
+[workspace]
+members = [
+    "agent",
+    "bindings",
+    "core",
+    "proj",
+]

COPYRIGHT

@@ -1,35 +1,16 @@
-# Intecture [![Build Status](https://travis-ci.org/intecture/api.svg?branch=master)](https://travis-ci.org/intecture/api) [![Coverage Status](https://coveralls.io/repos/github/Intecture/api/badge.svg?branch=master)](https://coveralls.io/github/Intecture/api?branch=master) [![Gitter](https://badges.gitter.im/Join/%20Chat.svg)](https://gitter.im/intecture/Lobby)
+# Intecture APIs [![Build Status](https://travis-ci.org/intecture/api.svg?branch=master)](https://travis-ci.org/intecture/api) [![Coverage Status](https://coveralls.io/repos/github/Intecture/api/badge.svg?branch=master)](https://coveralls.io/github/Intecture/api?branch=master) [![Gitter](https://badges.gitter.im/Join\%20Chat.svg)](https://gitter.im/intecture/Lobby)
 
-Intecture is a developer friendly, language agnostic configuration management tool for server systems.
+**Intecture is an API for managing your servers. Visit [intecture.io](https://intecture.io).**
 
-* Extensible support for virtually any programming language
-* Standard programming interface. No DSL. No magic.
-* Rust API library (and bindings for popular languages)
+---
 
-You can find out more at [intecture.io](https://intecture.io).
+Intecture's APIs (_cough_ and a binary) are the heart and soul of Intecture. Check out each component's `README.md` for details:
 
-## Installation
+- [core](core/) - The core API that does all the heavy lifting
+- [bindings](bindings/) - Rust FFI and language bindings
+- [proj](proj/) - Helpers and boilerplate for building Intecture projects
+- [agent](agent/) - Tiny daemon that exposes the core API as a service (for your hosts!)
 
-The best way to get up and running is by using the Intecture installer:
+## What's new?
 
-```
-$ curl -sSf https://get.intecture.io/ | sh -s -- api
-```
-
-For other installation options and dependencies, see the [Intecture book](https://intecture.io/book/rust/ch05-02-01-reference-api-installation.html).
-
-#### Uninstallation
-
-```
-$ curl -sSf https://get.intecture.io/ | sh -s -- -u api
-```
-
-## Contributing
-
-Dude! Awesome. Have a look at [`CONTRIBUTING.md`](CONTRIBUTING.md) for details.
-
-## Support
-
-- For any bugs, feature requests etc., please ticket them on GitHub.
-- You can ask questions and chat on our [Gitter channel](https://gitter.im/intecture/Lobby).
-- For enterprise support and consulting, please email <mailto:support@intecture.io>.
+Check out [RELEASES.md](RELEASES.md) for details.

Cargo.toml

@@ -0,0 +1,10 @@
+# 0.4.0 (in progress)
+
+Version 0.4 is a complete rewrite of Intecture's core API. If we had been running a stable release (i.e. 1.0), this version would be version 2.0, but sadly we have to go with the far less dramatic 0.4 :(
+
+Anyway, there are some big headlines in this release:
+
+- **Hello Tokio!** This is an exciting change to our socket API, as we bid a fond farewell to ZeroMQ. The change to Tokio will bring loads of benefits, such as substantially reducing our non-Rust dependencies, and introducing strongly typed messaging between servers and clients. This will make our communications more robust and less open to exploitation. Woo hoo!
+- **Asynchronous endpoints with `Futures`!** This is another huge change to the API, allowing us to multitask our configurations. It will also pave the way for a streaming API, which has been sorely lacking in Intecture until now.
+- **Greater emphasis on composability.** Each endpoint (formerly called _primitives_) is organised into a collection of _providers_ that will (you guessed it) provide target-specific implementations of the endpoint. Users will be able to select an endpoint provider manually or let the system choose the best provider for the target platform.
+- **Separation of duties.** In the previous versions of Intecture, the API had been organised into a single project, making it cluttered and unwieldy. For the next release, things like the FFI, language bindings and project boilerplate will be moved into separate child projects under the same Cargo workspace.

Makefile

@@ -0,0 +1,29 @@
+[package]
+name = "intecture_agent"
+version = "0.4.0"
+authors = [ "Pete Hayes <pete@intecture.io>" ]
+license = "MPL-2.0"
+description = "Tiny daemon that exposes Intecture's API as a service"
+homepage = "https://intecture.io"
+repository = "https://github.com/intecture/api"
+documentation = "https://intecture.io/rust/inapi/"
+keywords = ["intecture", "agent"]
+categories = ["servers"]
+readme = "README.md"
+include = ["Cargo.toml", "src/**/*.rs", "README.md", "LICENSE"]
+
+[badges]
+travis-ci = { repository = "intecture/api" }
+
+[dependencies]
+clap = "2.26"
+env_logger = "0.4"
+error-chain = "0.11"
+futures = "0.1"
+intecture_api = { version = "0.4.0", path = "../core" }
+serde = "1.0"
+serde_derive = "1.0"
+serde_json = "1.0"
+tokio-proto = "0.1"
+tokio-service = "0.1"
+toml = "0.4"

README.md

@@ -0,0 +1,29 @@
+# Agent
+
+Intecture Agent is a tiny daemon that exposes Intecture's core API as a service. This service should be running on each of your hosts to allow Intecture to manage them remotely. To connect to a remote host, use the `host::remote::Plain` type from [core](../core/).
+
+## Usage
+
+To run the agent, simply execute the `intecture_agent` binary, remembering to pass it a socket address to listen on.
+
+For example, to listen to localhost on port 7101, run:
+
+```sh
+intecture_agent --address localhost:7101
+```
+
+More likely though you'll want to listen on your public interface so that Intecture can talk to the host remotely. In this case you should specify the host's IP address, or use `0.0.0.0` to listen on all interfaces.
+
+## Config file
+
+You can also store agent parameters in a configuration file. The file must be in TOML format, and can live anywhere on your server. It should look like this:
+
+```toml
+address = "0.0.0.0:7101"
+```
+
+Once you've created a config file, you can start the agent by passing it the file path:
+
+```sh
+intecture_agent --config agent.toml
+```