spurious 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b533d30b3dcb525331727b9951acc663b1eca0a
-  data.tar.gz: c78434539e6826c1aec78b1998844c20374a3ada
+  metadata.gz: b90d80370ce75037f0b8993e9709b583a0d7d525
+  data.tar.gz: 933f62bf2eadd850c83b919611eec066e632f344
 SHA512:
-  metadata.gz: 352b11cba543b8b7e77e44c73f5ca52c230b19000f373d46fdd9bb87e372f92e6f740bb21edd7fae41348cd28587932416246359c5976d4f5302ceb405a8e289
-  data.tar.gz: 111df58ffdedee9430ebafe8d56264c08adc65d04624ae8f43dcd2a18c12be11b9a2fc410ea0275a951d9fa056b7e29d00a3ddb68740bb890bb55a4f9e040480
+  metadata.gz: d953665121a757a050891aa28dc15c4693f353bd9e270b8f3ae6c166d23092cb636bc6085e61e82f3a16e6e04c883b6f93ebe95884933d121b4560bc942f01eb
+  data.tar.gz: 728e4ed72952845780c7e379b28a0c90b91f5f4f6d1d13c48c3573ac2330084fe609b24ca5a2683c21de1b88302c217cc6548b4fc011bbede1041df45722225c

data/README.md

@@ -1,9 +1,92 @@
 # Spurious
 
-TODO: Write a gem description
+Spurious is a toolset allowing development against a subset of AWS resource, locally.
+
+The services are run as docker containers, and spurious manages the lifecycle and 
+linking so all you have to worry about is using the the services.
+
+You change the endpoint and port for each service to those provided by spurious.
+
+There are a number of supporting repos that ease the configuration of these SDKs.
+
+## Supported services
+
+Currently the following services are supported by spurious:
+
+* S3 ([fake-s3](https://github.com/jubos/fake-s3))
+* SQS ([fake_sqs](https://github.com/iain/fake_sqs))
+* DynamoDB ([DynamoDB Local](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tools.DynamoDBLocal.html))
+* ElastiCache ([fake_elasticache](https://github.com/stevenjack/fake_elasticache))
+
+> The following services are actively in development:
+
+* Spurious Browser (A web based application much like the AWS Console allowing control 
+  over the spurious services from a web interface).
+* SNS
+* CloudFormation (Allow you to create resources that there are already services for in spurious).
+
+## Requirements
+
+Spurious works on the following platforms:
+
+* OSX
+* Windows
+
+> Support for linux will be available shortly.
+
+### Dependencies
+
+Spurious requires the following to be installed and started to work correctly:
+
+* Ruby 1.9.*
+* Docker 1.0.*
 
 ## Installation
 
+### Quick install
+
+For the quick install to work, make sure you have [homebrew](http://brew.sh/) installed then run the following:
+
+```bash
+curl -L https://raw.github.com/stevenjack/spurious/master/tools/install.sh | sh
+```
+
+### Manual install
+
+#### Docker
+
+Each of the local services are run inside a docker container, so without docker spurious won't work.
+As OSX doesn't currently have support for LXC containers natively, you need to run a VM that is capable
+of providing this.
+
+The quickest way to get docker setup on OSX is with a combination of [homebrew](http://brew.sh/),
+[boot2docker](https://github.com/boot2docker/boot2docker) and [VirutalBox](https://www.virtualbox.org/wiki/Downloads)
+ (boot2docker currently only supports VirtualBox)
+
+`brew install boot2docker docker`
+
+Once you've installed both of these, run the following commands to start the boot2docker:
+
+```bash
+boot2docker	init
+boot2docker up
+```
+
+Once the process has completed, you should be given an env variable to export, make sure that this is exported
+before continuing as spurious makes use of this.
+
+##### Alternative VM setup
+
+Boot2docker is just one route of being able to run docker containers from your mac and as it only supports VirtualBox is 
+a little limited. You can use a number of other virtual machines, just sure you've exposed the docker API and you can connectivity
+to the VM on it's own IP address so you can construct the following en variable:
+
+```bash
+DOCKER_HOST=tcp://{IP_OF_HOST:DOCKER_API_PORT}
+```
+
+#### Spurious
+
 Add this line to your application's Gemfile:
 
     gem 'spurious'
@@ -16,9 +99,97 @@ Or install it yourself as:
 
     $ gem install spurious
 
+
+This will install spurious and give you the CLI tools for starting the server and interacting with it.
+
 ## Usage
 
-TODO: Write usage instructions here
+Spurious is split up into two components, the cli and the server. The server interacts with the docker API and
+controls the lifecycle of the containers. The CLI simply talks to the server and formats the responses for
+the end user.
+
+The server runs as a daemon and must be run before using the CLI, if it's not the CLI will prompt you. To run
+enter in an directory:
+
+```bash
+spurious-server start
+```
+
+You can check the status of the server by running:
+
+```bash
+spurious-server status
+```
+
+and stop it with:
+
+```bash
+spurious-server stop
+```
+
+Once you've started the server you can start using the spurious CLI tool. Run the following commands to get the
+containers up and running:
+
+```bash
+spurious init
+spurious up
+```
+
+You should now have 6 containers running which you can check with:
+
+```bash
+docker ps
+```
+
+### Using the containers
+
+Once the containers are up and running, they're assigned random port numbers from docker which are available on the
+ip address of the VM used to run the containers. To make the discovery of these ports simpler there's the following
+command:
+
+```bash
+spurious ports
+```
+
+that returns the list of host and port details for each of the spurious containers. If you pass the flag --json you'll
+get the result back as a JSON string so you can then parse this and use it to automatically configure your chosen method of working with AWS.
+
+### SDK Helpers
+
+Once the containers are running you'll need to wire up the SDK to point to the correct endpoints and port numbers. Here's
+and example using the ruby SDK:
+
+```ruby
+require 'json'
+
+port_config = JSON.parse(`spurious ports --json`)
+
+ AWS.config(
+    :region              => 'eu-west-1',
+    :use_ssl             => false,
+    :access_key_id       => "access",
+    :secret_access_key   => "secret",
+    :dynamo_db_endpoint  => port_config['spurious-dynamo']['Host'],
+    :dynamo_db_port      => port_config['spurious-dynamo']['HostPort'],
+    :sqs_endpoint        => port_config['spurious-sqs']['Host'],
+    :sqs_port            => port_config['spurious-sqs']['HostPort'],
+    :s3_endpoint         => port_config['spurious-s3']['Host'],
+    :s3_port             => port_config['spurious-s3']['HostPort'],
+    :s3_force_path_style => true
+  )
+
+```
+
+There are also helpers available for the different flavours of the AWS SDK:
+
+#### Ruby
+
+* [Spurious ruby AWS SDK Helper](https://github.com/stevenjack/spurious-ruby-awssdk-helper)
+
+
+#### PHP/Java/Node.js
+
+> Coming soon
 
 ## Contributing
 

data/lib/spurious/version.rb

@@ -1,3 +1,3 @@
 module Spurious
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/spurious.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
 
+  spec.add_runtime_dependency "thor"
   spec.add_runtime_dependency "spurious-server"
   spec.add_runtime_dependency "eventmachine"
   spec.add_runtime_dependency "timeout"

data/tools/install.sh

@@ -0,0 +1,78 @@
+#!/bin/bash
+
+vercomp () {
+    if [[ $1 == $2 ]]
+    then
+        return 0
+    fi
+    local IFS=.
+    local i ver1=($1) ver2=($2)
+    # fill empty fields in ver1 with zeros
+    for ((i=${#ver1[@]}; i<${#ver2[@]}; i++))
+    do
+        ver1[i]=0
+    done
+    for ((i=0; i<${#ver1[@]}; i++))
+    do
+        if [[ -z ${ver2[i]} ]]
+        then
+            # fill empty fields in ver2 with zeros
+            ver2[i]=0
+        fi
+        if ((10#${ver1[i]} > 10#${ver2[i]}))
+        then
+            return 1
+        fi
+        if ((10#${ver1[i]} < 10#${ver2[i]}))
+        then
+            return 2
+        fi
+    done
+    return 0
+}
+
+if [[ $(command -v docker) ]]; then
+  DOCKER_VERSION=$(docker -v | cut -d',' -f 1 | cut -d' ' -f 3)
+  vercomp $DOCKER_VERSION "1.1.0"
+  if [[ $? == 2 ]]; then
+    echo "You must have version 1.1.0 of the docker client installed, currently installed: $DOCKER_VERSION"
+    exit 1
+  fi
+fi
+
+if [[ $(command -v boot2docker) ]]; then
+  BOOT2DOCKER_VERSION=$(boot2docker version | grep Client | cut -d':' -f 2 | sed 's/v//g')
+  vercomp $BOOT2DOCKER_VERSION "1.1.0"
+  if [[ $? == 2 ]]; then
+    echo "You must have version 1.1.0 of boot2docker client installed, currently installed: $BOOT2DOCKER_VERSION"
+    exit 1
+  fi
+fi
+
+if [[ $(command -v ruby) ]]; then
+  RUBY_VERSION=$(ruby -v | cut -d' ' -f2 | cut -d'p' -f1)
+  vercomp $RUBY_VERSION "1.9"
+  if [[ $? == 2 ]]; then
+    echo "You must have version 1.9 or greater of ruby installed, currently installed: $(ruby -v)"
+    exit 1
+  fi
+fi
+
+echo '[install] Starting install of docker and boot2docker using brew'
+brew install docker boot2docker
+echo '[install] Initializing boot2docker'
+boot2docker init
+echo '[install] Starting boot2docker'
+boot2docker up
+echo '[install] Installing spurious'
+gem install spurious
+echo '[install] Starting spurious server'
+DOCKER_HOST=tcp://$(boot2docker ip 2>/dev/null):2375 spurious-server start
+echo '[install] Initializing spurious'
+spurious init
+echo '[install] Starting spurious'
+spurious start
+echo '\n----------------------'
+echo 'Installation complete'
+echo '\nPlease add the following export to you ~/.bashrc or ~/.zshrc:'
+echo "\nexport DOCKER_HOST=tcp://$(boot2docker ip 2>/dev/null):2375"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spurious
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Steven Jack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-11 00:00:00.000000000 Z
+date: 2014-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker
@@ -80,6 +80,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: spurious-server
   requirement: !ruby/object:Gem::Requirement
@@ -146,6 +160,7 @@ files:
 - spec/config_spec.rb
 - spec/helper.rb
 - spurious.gemspec
+- tools/install.sh
 homepage: ''
 licenses:
 - MIT
@@ -166,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Spurious is a cli tool that interacts with the spurious server