ansible_module 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25454d518dee3e7062ee9c41cf9af20707e5bacd
-  data.tar.gz: b332710c5fe099b3867b6a30f2e84070575230e2
+  metadata.gz: d6355d7da66ac0cb19bc372a9733fba816217b87
+  data.tar.gz: 4f34188771a2276f2397609b3540cabcb79c55cd
 SHA512:
-  metadata.gz: 005c884025fcfaf5cb9b0a5902d835fa72dd4bf3aa198fd092dec44aadc29a217861cbec8f3e161d2cb3dc51b61311829fb112eeb9b6b6952a30cc67424014c8
-  data.tar.gz: a275f040175cb221ee1373dc037c6f7260338d715d3a80bc7f0175310aa792634f9c22413e4d48c61a0084ca35ba5a10635a7b6a3efc732d9317805c84e3c292
+  metadata.gz: ab78c4fb84571570587976d59dfbf3a3ad9f076d2b8fe61210ecf94ba6cf81b067118dd9dc88d6ff6c5e48d29cb29a8203fc564ec0f84a20d0c5c683ece8400a
+  data.tar.gz: ed41b1780a6439bfff9a3fe88d0418b5d42887380814af2be2efa9ba11ef9c10270599843b6df554d90dc51a744852fb6e9a9fb0fad67cf785c26d9da59e58af

data/CHANGELOG.md

@@ -1,7 +1,12 @@
 CHANGELOG
 =========
 
+## 0.9.1 (2014-08-28)
+
+* Add private method `AnsibleModule#invalid_json` to improve the message on
+  validation failure.
+
 ## 0.9.0 (2014-08-27)
 
-* Implement basic instance methods: main, run, exit_json, fail_json
-* Implement basic class methods: instance, params
+* Implement basic instance methods: `main`, `run`, `exit_json`, `fail_json`
+* Implement basic class methods: `instance`, `params`

data/README.md

@@ -1,30 +1,63 @@
 AnsibleModule
 =============
 
+[![Gem Version](https://badge.fury.io/rb/ansible_module.svg)](http://badge.fury.io/rb/ansible_module)
+
 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.
+It is distributed as a gem package under the [MIT-LICENSE](MIT-LICENSE).
 
 Installation
 ------------
 
-Add the following to your Ansible playbook:
+### Manual Installation
+
+Install Ruby (2.0 or later) and `ansible_module` gem on your *remote* hosts.
+
+The following is a typical procedure on Ubuntu Server 14.04:
+
+```
+$ sudo add-apt-repository -y ppa:brightbox/ruby-ng
+$ sudo apt-get update
+$ sudo apt-get -y install ruby2.1
+$ sudo gem install ansible_module
+```
+
+### Installation with Ansible
+
+Create an Ansible [playbook](http://docs.ansible.com/playbooks.html) to install Ruby and `ansible_module` gem.
+
+The following is an example for Ubuntu Server 14.04:
 
 ```yaml
-- hosts: web-servers
+- hosts: servers
+  sudo: yes
   tasks:
+  - name: Add ppa for ruby
+    apt_repository: repo='ppa:brightbox/ruby-ng' state=present
+  - name: Install ruby 2.1
+    apt: name=ruby2.1 state=present
   - 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.
+If you named this file `ruby_environment.yml`, then run the following command on your *local* host:
+
+```
+$ ansible-playbook -i hosts ruby_environment.yml
+```
+
+In the above example, the `hosts` file is an [inventory](http://docs.ansible.com/intro_inventory.html) which lists up host names or IP addresses.
+
 
-Synopsis
---------
+Example (1)
+-----------
 
-Create the following Ruby script as `library/calc`:
+Create a file named `calc` on the `library` directory as follows:
 
 ```ruby
+#!/usr/bin/ruby
+
 require 'ansible_module'
 
 class Calc < AnsibleModule
@@ -44,10 +77,14 @@ end
 Calc.instance.run
 ```
 
-Add the following to your Ansible playbook:
+The values of attributes `x` and `y` are set during instantiation process by `AnsibleModule`.
+
+Note that you can validate them with `validates` class method derived from `ActiveModel`.
+
+Then, create a file named `calc.yml` as follows:
 
 ```yaml
-- hosts: web-servers
+- hosts: servers
   tasks:
   - name: Make a calculation
     calc: x=50 y=50
@@ -56,7 +93,98 @@ Add the following to your Ansible playbook:
       msg="sum = {{ result['sum'] }}"
 ```
 
+And run the following command on your local host:
+
+```
+$ ansible-playbook -i hosts calc.yml
+```
+
+
+Example (2)
+-----------
+
+Create a file named `mysql_change_master` on the `library` directory as follows:
+
+```ruby
+#!/usr/bin/ruby
+
+require 'ansible_module'
+
+class MysqlChangeMaster < AnsibleModule
+  attribute :host, String
+  attribute :port, Integer, default: 3306
+  attribute :user, String
+  attribute :password, String
+  attribute :mysql_root_password, String
+
+  validates :port, inclusion: { in: 0..65535 }
+
+  def main
+    statement = %Q{
+      STOP SLAVE;
+      CHANGE MASTER TO
+        MASTER_HOST='#{host}',
+        MASTER_PORT=#{port},
+        MASTER_USER='#{user}',
+        MASTER_PASSWORD='#{password}',
+        MASTER_AUTO_POSITION=1;
+      START SLAVE;
+    }.squish
+
+    command = %Q{
+      /usr/bin/mysql -u root -p#{mysql_root_password} -e "#{statement}"
+    }.squish
+
+    system(command)
+
+    exit_json(statement: statement, changed: true)
+  end
+end
+
+MysqlChangeMaster.instance.run
+```
+
+Note that you can use methods added by `ActiveSupport` like `String#squish`.
+
+Then, create a file named `replication.yml` as follows:
+
+```yaml
+- hosts: mysql-slave
+  vars_files:
+    - shared/secret.yml
+  tasks:
+  - name: Change master to the db1
+    mysql: >
+      host="db1"
+      user="repl"
+      password="{{ mysql_repl_password }}"
+      mysql_root_password="{{ mysql_root_password }}"
+```
+
+Next, create a file named `secret.yml` on the `shared` directory as follows:
+
+```secret.yml
+mysql_repl_password: p@ssw0rd
+mysql_root_password: p@ssw0rd
+```
+
+Note that you should replace `p@ssw0rd` with real passwords.
+
+And run the following command on your local host:
+
+```
+$ ansible-playbook -i hosts replication.yml
+```
+
+You might want to encrypt the `secret.yml` with [ansible-vault](http://docs.ansible.com/playbooks_vault.html).
+In that case, you must add `--ask-vault-pass` option to the above command:
+
+```
+$ ansible-playbook -i hosts --ask-vault-pass replication.yml
+```
+
+
 License
 -------
 
-AnsibleModule is distributed under the MIT license. ([MIT-LICENCE](MIT-LICENCE))
+AnsibleModule is distributed under the [MIT-LICENSE](MIT-LICENSE).

data/VERSION

@@ -1 +1 @@
-0.9.0
+0.9.1

data/lib/ansible_module.rb

@@ -16,7 +16,7 @@ class AnsibleModule
     if valid?
       main
     else
-      fail_json(msg: errors.full_messages.join(' '))
+      invalid_json
     end
   rescue StandardError => e
     fail_json(msg: "Failed: #{e.to_s}")
@@ -38,6 +38,12 @@ class AnsibleModule
     exit 1
   end
 
+  def invalid_json
+    message = 'Invalid parameters: '
+    message += errors.full_messages.map { |m| "#{m}." }.join(' ')
+    fail_json(msg: message)
+  end
+
   class << self
     def instance
       @instance ||= new(params)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ansible_module
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Tsutomu KURODA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-27 00:00:00.000000000 Z
+date: 2014-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json