rs-mule 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDA0NmVlMGNmZWE4YTNjNmQ1NGZmM2ZiNTY0MGFjNjBjMzlmZmYyMg==
+  data.tar.gz: !binary |-
+    OTZlMTEwZjBlNzJjOWI2MzQ4MGY2ZWFjM2E4MGM2N2NhOWY0MDc0Yw==
+SHA512:
+  metadata.gz: !binary |-
+    MjQ4NTViOTgxZDQ2MmQ2YzJkMWE1NWJiZjgwNjBmNmFlMTNkMWZiMzExYmYz
+    OGQ5NjRhNjc0MWZiNjM3YjljNzk5YmEwOGI4MWRkOWVkNTg5NzBmY2E4M2E2
+    MDg3NzAyN2QyN2Y5NDNmNWMzZDFiMmY3MThhYzUwNTFjZmI3MWU=
+  data.tar.gz: !binary |-
+    NjY0NDgzMmI3ZGU4NjMyNTUyOTcxMjcxZDRjMDVjMmZjNDIxYzMwNjhjODkx
+    YjA1YTEzOGZmZDFhNmYwMGNkZGQ1OGI4MDkwY2U1Y2UyYWMzZmZjYWNkZGRm
+    NWZkN2EyNWMyYWFiZjUyZjAzNmMzODAyYWMyZDhkNWU5ZTk5ZmE=

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2014 Ryan Geyer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,149 @@
+# rs-mule
+
+A [CLI](./#CLI) tool that runs "stuff".  Meant primarily for running RightScripts or Chef recipes on individual nodes, identified by tags.
+
+Also a [Library](./#Library) that allows you to do the same sorta stuff in your own app, cause I'm generous like that.
+
+[<img src="https://travis-ci.org/rgeyer/rs-mule.png" />](https://travis-ci.org/rgeyer/rs-mule)
+
+## CLI
+
+### Authentication
+The CLI requires you to authenticate with right_api_client.  Typically providing
+your rightscale email address, password, and an account id are sufficient for
+getting authenticated.  However you can also use an oAuth token. For more
+information on the required parameters check out the
+[right_api_client documentation](https://github.com/rightscale/right_api_client)
+
+When using the CLI you can provide RightScale API authentication info in two ways.
+
+#### rs_auth_hash
+Perhaps the easiest way to provide the authentication parameters is on the
+commandline with the --rs-auth-hash option.
+
+Example:
+```
+rs-mule [COMMAND] --rs-auth-hash=email:foo@bar.baz password:password account_id:12345
+```
+
+#### rs_auth_file
+You can also create a YAML file which contains the authentication parameters you
+want to supply, then point rs-mule at your authentication parameter file.
+
+You can find an example of this file at the root of this project as
+"auth_file.yaml.example", and it looks a little like this.
+
+Example File:
+```
+---
+:email: foo@bar.baz
+:password: password
+:account_id: 12345
+```
+
+You can tell rs-mule to use your parameters file thusly.
+
+Example:
+```
+rs-mule [COMMAND] --rs-auth-file=/path/to/auth_file.yaml
+```
+
+### Usage
+
+rs-mule has one (soon to be two) commands.
+
+```
+Commands:
+  rs-mule help [COMMAND]                       # Describe available commands or one specific command
+  rs-mule run_executable --tags=one two three  # Runs a specified recipe or RightScript on instances targeted by tag
+```
+
+#### run_executable command
+This is used to run a RightScript or Chef recipe on instances found using a tag
+search.
+
+The simplest usage requires the executable to run, and at least one tag.
+```
+rs-mule run_executable "Some RightScript Name" --tags=tag1
+```
+
+##### Tag Matching Strategy
+If you provide more than one tag, rs-mule will assume that you want target
+instances to possess all of the supplied tags in order for the executable to be
+run on them.  However, you can be a little more lenient and have rs-mule run the
+executable on instances which have any of the tags.
+
+Script will run only on instances which have both "tag1" and "tag2"
+```
+rs-mule run_executable "Some RightScript Name" --tags=tag1 tag2
+```
+
+The explicit version of above
+```
+rs-mule run_executable "Some RightScript Name" --tags=tag1 tag2 --tag-match-strategy=all
+```
+
+Script will run on any instance which has either "tag1" or "tag2"
+```
+rs-mule run_executable "Some RightScript Name" --tags=tag1 tag2 --tag-match-strategy=any
+```
+
+##### RightScript Version
+When you are running a RightScript, rs-mule will assume you want to run the
+latest and greatest version.  It'll also assume that revision is not the HEAD
+revision.  You can supply a specified revision number, or use 0 if you want to
+live on the edge and use the HEAD revision.
+
+Specify revision 3
+```
+rs-mule run_executable "Some RightScript Name" --tags=tag1 --right-script-revision=3
+```
+
+Specify HEAD revision
+```
+rs-mule run_executable "Some RightScript Name" --tags=tag1 --right-script-revision=0
+```
+
+##### Executable Type
+The executable value can be one of the following;
+* The name of a RightScript
+* An API href of a RightScript (Eg. /api/right_scripts/abc123)
+* The name of a Chef recipe (Eg. cookbook::recipe)
+
+rs-mule will attempt to automatically detect which one you've supplied by applying
+some regular expressions and other detection mechanisms against the executable
+string provided.
+
+However, you can remove the guesswork by specifying the executable type as an
+option.
+
+RightScript HREF:
+```
+rs-mule run_executable "/api/right_scripts/abc123" --executable-type=right_script_href --tags=tag1
+```
+
+RightScript Name:
+```
+rs-mule run_executable "Some RightScript Name" --executable-type=right_script_name --tags=tag1
+```
+
+Chef Recipe:
+```
+rs-mule run_executable "cookbook::recipe" --executable-type=recipe_name --tags=tag1
+```
+
+## Library
+The library does all this cool stuff, and I'll document it, I swear...
+
+## Authors
+
+Created and maintained by [Ryan Geyer][author] (<me@ryangeyer.com>)
+
+## License
+
+MIT (see [LICENSE][license])
+
+[author]:           https://github.com/rgeyer
+[issues]:           https://github.com/rgeyer/rs-mule/issues
+[license]:          https://github.com/rgeyer/rs-mule/blob/master/LICENSE
+[repo]:             https://github.com/rgeyer/rs-mule

data/bin/rs-mule

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) 2014 Ryan Geyer
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "rs-mule"))
+
+RsMule::Cli.start(ARGV)

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: rs-mule
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan J. Geyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: right_api_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.15
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.15
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+description: It runs "stuff"
+email: me@ryangeyer.com
+executables:
+- rs-mule
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/rs-mule
+homepage: https://github.com/rgeyer/rs-mule
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: It runs "stuff"
+test_files: []