ansible_module 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25454d518dee3e7062ee9c41cf9af20707e5bacd
+  data.tar.gz: b332710c5fe099b3867b6a30f2e84070575230e2
+SHA512:
+  metadata.gz: 005c884025fcfaf5cb9b0a5902d835fa72dd4bf3aa198fd092dec44aadc29a217861cbec8f3e161d2cb3dc51b61311829fb112eeb9b6b6952a30cc67424014c8
+  data.tar.gz: a275f040175cb221ee1373dc037c6f7260338d715d3a80bc7f0175310aa792634f9c22413e4d48c61a0084ca35ba5a10635a7b6a3efc732d9317805c84e3c292

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+CHANGELOG
+=========
+
+## 0.9.0 (2014-08-27)
+
+* Implement basic instance methods: main, run, exit_json, fail_json
+* Implement basic class methods: instance, params

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Tsutomu Kuroda
+
+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,62 @@
+AnsibleModule
+=============
+
+AnsibleModule is a Ruby class that provides basic functionalities as an [Ansible](http://ansible.com) module.
+
+It is distributed as a gem package under the MIT license.
+
+Installation
+------------
+
+Add the following to your Ansible playbook:
+
+```yaml
+- hosts: web-servers
+  tasks:
+  - name: Install ansible_module gem
+    gem: name=ansible_module user_install=false state=present
+```
+
+Note that you should install a Ruby (2.0 or later) on your hosts.
+
+Synopsis
+--------
+
+Create the following Ruby script as `library/calc`:
+
+```ruby
+require 'ansible_module'
+
+class Calc < AnsibleModule
+  attribute :x, Integer
+  attribute :y, Integer, default: 100
+
+  validates :x, presence: true, numericality: { only_integer: true }
+  validates :y, numericality: { only_integer: true }
+
+  def main
+    sum = x + y
+
+    exit_json(x: x, y: y, sum: sum, changed: true)
+  end
+end
+
+Calc.instance.run
+```
+
+Add the following to your Ansible playbook:
+
+```yaml
+- hosts: web-servers
+  tasks:
+  - name: Make a calculation
+    calc: x=50 y=50
+    register: result
+  - debug: >
+      msg="sum = {{ result['sum'] }}"
+```
+
+License
+-------
+
+AnsibleModule is distributed under the MIT license. ([MIT-LICENCE](MIT-LICENCE))

data/VERSION

@@ -0,0 +1 @@
+0.9.0

data/lib/ansible_module.rb

@@ -0,0 +1,59 @@
+require 'shellwords'
+require 'json'
+require 'virtus'
+require 'active_support/all'
+require 'active_model'
+
+class AnsibleModule
+  include Virtus.model
+  include ActiveModel::Validations
+
+  def main
+    raise "Not implemented."
+  end
+
+  def run
+    if valid?
+      main
+    else
+      fail_json(msg: errors.full_messages.join(' '))
+    end
+  rescue StandardError => e
+    fail_json(msg: "Failed: #{e.to_s}")
+  end
+
+  private
+
+  def exit_json(hash)
+    hash = ActiveSupport::HashWithIndifferentAccess.new(hash)
+    print JSON.dump(hash)
+    exit 0
+  end
+
+  def fail_json(hash)
+    hash = ActiveSupport::HashWithIndifferentAccess.new(hash)
+    hash[:failed] = true
+    hash[:msg] ||= "No error message."
+    print JSON.dump(hash)
+    exit 1
+  end
+
+  class << self
+    def instance
+      @instance ||= new(params)
+      @instance
+    end
+
+    def params
+      return @params if @params
+      @params = ActiveSupport::HashWithIndifferentAccess.new
+      File.open(ARGV[0]) do |fh|
+        fh.read().shellsplit.each do |word|
+          (key, value) = word.split('=', 2)
+          @params[key] = value
+        end
+      end
+      @params
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: ansible_module
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Tsutomu KURODA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.5
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.5
+description: AnsibleModule is a Ruby class that provides basic functionalities as
+  an Ansible module.
+email: t-kuroda@oiax.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- CHANGELOG.md
+- MIT-LICENSE
+- VERSION
+- lib/ansible_module.rb
+homepage: https://github.com/kuroda/ansible_module
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.10
+signing_key: 
+specification_version: 4
+summary: AnsibleModule class for Ruby language.
+test_files: []