charmkit 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 203289a3aae8632c1d17184802978a559efba7c1
-  data.tar.gz: 8d69c49efde5af1203d7414663abd5c8c2ae9a7e
+  metadata.gz: d00fbd867145c222acc4d9352a4969d0aa405257
+  data.tar.gz: 1e6a86849fe915d2b18ee28136d1eff6a9f27995
 SHA512:
-  metadata.gz: 54d8fa719cafe769644e60412dbc8c046729f1e793dd436de91534464238b2350404ec1126987d1d7839721ba76b720dfa740de693e7a09d0df97830cc7637ef
-  data.tar.gz: cc4ae72da3dc9f4e15e18341157c90e2c0a6b4d92fcb9c1b34ab4eda95e23e38bcc9712520ad7ff78f93244b96315db8d521524f4e5241b72a1919593a2d4afc
+  metadata.gz: e7d99c2a2dbba161818f949b1e739787e03a322018ff645255cf1a226189360d91f7df3fc403f2d4e3e7f54d3406f65d7c20e622ec9b013b1d59517cf3739c29
+  data.tar.gz: 5f13cbc2404d7789de62bee4d23c59fc966b5b0c9180e853c5c7e19da8a44c1c4062c6b890a78c2ea962be12ee8a72cc5dfe2faf4669a5e387bb914a516be417

data/README.md

@@ -28,16 +28,15 @@ In **hooks/install**:
 #!/bin/sh
 
 apt-get update
-apt-get install -qyf ruby --no-install-recommends
-gem install bundler
+apt-get install -qyf ruby bundler --no-install-recommends
 
 bundle install --local --quiet
 
-# Runs the lib/install.rb hook
 bundle exec rake dokuwiki:install
 ```
 
-In other hooks call *charmkit* with the execing hook (eg. **hooks/config-changed**)
+In other hooks call the relevant rake tasks, for example, in
+**hooks/config-changed**:
 
 ```
 #!/bin/sh
@@ -51,8 +50,6 @@ Same for **hooks/upgrade-charm**
 #!/bin/sh
 
 bundle exec rake dokuwiki:install
-bundle exec rake dokuwiki:config_changed
-
 ```
 
 ## Writing Charmkit style hooks
@@ -63,21 +60,13 @@ All Charmkit hooks will reside in a normal **Rakefile**.
 
 ```ruby
 require 'charmkit'
+require 'charmkit/plugins/nginx'
+require 'charmkit/plugins/php'
 
 namespace :dokuwiki do
 
-  desc "Install required apt packages"
-  task :install_deps do
-    pkgs = [
-      'nginx-full', 'php-fpm',      'php-cgi',      'php-curl', 'php-gd', 'php-json',
-      'php-mcrypt', 'php-readline', 'php-mbstring', 'php-xml'
-    ]
-    `apt-get update`
-    `apt-get install -qyf #{pkgs.join(' ')}`
-  end
-
   desc "Install Dokuwiki"
-  task :install => [:install_deps] do
+  task :install => ["nginx:install", "php:install"] do
     app_path = `config-get app_path`
     resource_path = `resource-get stable-release`
     hook_path = ENV['JUJU_CHARM_DIR']
@@ -130,6 +119,41 @@ end
 The core of Charmkit contains a few helpers such as template rendering but
 otherwise kept relatively small.
 
+**Charmkit** does have a sense of "plugins" which are really **rake** tasks that
+reside in *charmkit/plugin/{name}* as seen in the example syntax above.
+
+## Using local plugins
+
+In addition to the plugins(read: rake tasks) you can add your own to the charm
+itself. To add a task either create a directory inside your charm (eg.
+**tasks**) and name the file something relvant. For example, to create a plugin
+that will install **vim** you would do the following inside your charm directory:
+
+Create a file **tasks/vim.rb** with the below syntax:
+
+```ruby
+namespace :vim do
+  desc "install vim"
+  task :install do
+   system("apt-get install -qyf vim")
+  end
+end
+```
+
+And in your **Rakefile** include it in using the **require_relative** syntax:
+
+```ruby
+require 'charmkit'
+require_relative 'tasks/vim'
+```
+
+Now you can install **vim** with the rake command or utilize the tasks inside
+your **Rakefile**:
+
+```
+bundle exec rake vim:install
+```
+
 ## Packaging the Charm
 
 You'll want to make sure that any Ruby gems used are packaged with your charm so

data/examples/my-demo-charm/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gem "rake"
+gem "charmkit", "~> 0.4.0"

data/examples/my-demo-charm/Gemfile.lock

@@ -0,0 +1,15 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    charmkit (0.4.1)
+    rake (11.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  charmkit (~> 0.4.0)
+  rake
+
+BUNDLED WITH
+   1.13.6

data/examples/my-demo-charm/README.md

@@ -0,0 +1,45 @@
+# Overview
+
+DokuWiki is a simple to use and highly versatile Open Source wiki software that
+doesn't require a database. It is loved by users for its clean and readable
+syntax. The ease of maintenance, backup and integration makes it an
+administrator's favorite. Built in access controls and authentication connectors
+make DokuWiki especially useful in the enterprise context and the large number
+of plugins contributed by its vibrant community allow for a broad range of use
+cases beyond a traditional wiki.
+
+# Usage
+
+    $ juju deploy cs:~adam-stokes/dokuwiki
+
+## Login
+
+Initial login and password are
+
+    username: admin
+    password: password
+
+# Developing
+
+## Setting up
+
+As long as you have ruby and bundler installed you can do the following:
+
+```
+bundle install
+bundle exec rake -T
+```
+
+All tasks are kept in **Rakefile** and are called via **hooks/{hook-name}**.
+
+# Author
+
+Adam Stokes <adam.stokes@ubuntu.com>
+
+# Copyright
+
+2016 Adam Stokes
+
+# License
+
+MIT

data/examples/my-demo-charm/Rakefile

@@ -0,0 +1,62 @@
+# The below requires will pull in charmkit and its nginx and php plugins
+# which are provided with the library.
+require 'charmkit'
+require 'charmkit/plugins/nginx'
+require 'charmkit/plugins/php'
+
+# The below require_relative will load a local task from tasks/vim.rb
+require_relative "tasks/vim.rb"
+
+namespace :dokuwiki do
+
+  desc "Install Dokuwiki"
+  # Notice that I set task dependencies on nginx, php, AND vim
+  # so that they get installed prior to installing dokuwiki
+  task :install => ["nginx:install", "php:install", "vim:install"] do
+    app_path = `config-get app_path`.chomp
+    resource_path = `resource-get stable-release`.chomp
+    hook_path = ENV['JUJU_CHARM_DIR']
+
+    mkdir_p app_path unless Dir.exists? app_path
+
+    `tar xf #{resource_path} -C #{app_path} --strip-components=1`
+    cp "#{hook_path}/templates/acl.auth.php", "#{app_path}/conf/acl.auth.php"
+    cp "#{hook_path}/templates/local.php", "#{app_path}/conf/local.php"
+    cp "#{hook_path}/templates/plugins.local.php", "#{app_path}/conf/plugin.local.php"
+
+    version = File.read "#{app_path}/VERSION"
+    `application-version-set '#{version}'`
+    `status-set active "Dokuwiki Install finished."`
+  end
+
+  desc "Configure Dokuwiki"
+  task :config_changed do
+    app_path = `config-get app_path`.chomp
+    hook_path = ENV['JUJU_CHARM_DIR']
+
+    admin_user = `config-get admin_user`.chomp
+    admin_password = `config-get admin_password`.chomp
+    admin_name = `config-get admin_name`.chomp
+    admin_email = `config-get admin_email`.chomp
+    template "#{hook_path}/templates/users.auth.php",
+             "#{app_path}/conf/users.auth.php",
+             admin_user: admin_user,
+             admin_password: admin_password,
+             admin_name: admin_name,
+             admin_email: admin_email
+
+    public_address = `unit-get public-address`.chomp
+    template "#{hook_path}/templates/vhost.conf",
+             "/etc/nginx/sites-enabled/default",
+             public_address: public_address,
+             app_path: app_path
+
+    chown_R 'www-data', 'www-data', app_path
+
+    `systemctl restart php7.0-fpm`
+    `systemctl restart nginx`
+    `status-set active "Ready"`
+  end
+end
+
+task :default => 'dokuwiki:install'

data/examples/my-demo-charm/config.yaml

@@ -0,0 +1,21 @@
+options:
+  app_path:
+    type: string
+    default: "/srv/app"
+    description: "Where Dokuwiki will be installed"
+  admin_user:
+    type: string
+    default: admin
+    description: "Admin username (default: admin)"
+  admin_password:
+    type: string
+    default: "5f4dcc3b5aa765d61d8327deb882cf99"
+    description: "Admin password md5 hash format (default password: password)"
+  admin_name:
+    type: string
+    default: "The Admin"
+    description: Admin name
+  admin_email:
+    type: string
+    default: "admin@example.com"
+    description: Admin email

data/examples/my-demo-charm/copyright

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Adam Stokes <adam.stokes@ubuntu.com>
+
+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/examples/my-demo-charm/hooks/config-changed

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+bundle exec rake dokuwiki:config_changed

data/examples/my-demo-charm/hooks/install

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+apt-get update && apt-get install -qyf ruby bundler --no-install-recommends
+
+bundle install --local --quiet
+
+# Do install task
+bundle exec rake dokuwiki:install

data/examples/my-demo-charm/hooks/upgrade-charm

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+./hooks/install

data/examples/my-demo-charm/icon.svg

@@ -0,0 +1,322 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:xlink="http://www.w3.org/1999/xlink"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="96"
+   height="96"
+   id="svg6517"
+   version="1.1"
+   inkscape:version="0.91 r13725"
+   sodipodi:docname="icon.svg">
+  <defs
+     id="defs6519">
+    <linearGradient
+       id="Background">
+      <stop
+         id="stop4178"
+         offset="0"
+         style="stop-color:#b8b8b8;stop-opacity:1" />
+      <stop
+         id="stop4180"
+         offset="1"
+         style="stop-color:#c9c9c9;stop-opacity:1" />
+    </linearGradient>
+    <filter
+       style="color-interpolation-filters:sRGB;"
+       inkscape:label="Inner Shadow"
+       id="filter1121">
+      <feFlood
+         flood-opacity="0.59999999999999998"
+         flood-color="rgb(0,0,0)"
+         result="flood"
+         id="feFlood1123" />
+      <feComposite
+         in="flood"
+         in2="SourceGraphic"
+         operator="out"
+         result="composite1"
+         id="feComposite1125" />
+      <feGaussianBlur
+         in="composite1"
+         stdDeviation="1"
+         result="blur"
+         id="feGaussianBlur1127" />
+      <feOffset
+         dx="0"
+         dy="2"
+         result="offset"
+         id="feOffset1129" />
+      <feComposite
+         in="offset"
+         in2="SourceGraphic"
+         operator="atop"
+         result="composite2"
+         id="feComposite1131" />
+    </filter>
+    <filter
+       style="color-interpolation-filters:sRGB;"
+       inkscape:label="Drop Shadow"
+       id="filter950">
+      <feFlood
+         flood-opacity="0.25"
+         flood-color="rgb(0,0,0)"
+         result="flood"
+         id="feFlood952" />
+      <feComposite
+         in="flood"
+         in2="SourceGraphic"
+         operator="in"
+         result="composite1"
+         id="feComposite954" />
+      <feGaussianBlur
+         in="composite1"
+         stdDeviation="1"
+         result="blur"
+         id="feGaussianBlur956" />
+      <feOffset
+         dx="0"
+         dy="1"
+         result="offset"
+         id="feOffset958" />
+      <feComposite
+         in="SourceGraphic"
+         in2="offset"
+         operator="over"
+         result="composite2"
+         id="feComposite960" />
+    </filter>
+    <clipPath
+       clipPathUnits="userSpaceOnUse"
+       id="clipPath873">
+      <g
+         transform="matrix(0,-0.66666667,0.66604479,0,-258.25992,677.00001)"
+         id="g875"
+         inkscape:label="Layer 1"
+         style="fill:#ff00ff;fill-opacity:1;stroke:none;display:inline">
+        <path
+           style="fill:#ff00ff;fill-opacity:1;stroke:none;display:inline"
+           d="m 46.702703,898.22775 50.594594,0 C 138.16216,898.22775 144,904.06497 144,944.92583 l 0,50.73846 c 0,40.86071 -5.83784,46.69791 -46.702703,46.69791 l -50.594594,0 C 5.8378378,1042.3622 0,1036.525 0,995.66429 L 0,944.92583 C 0,904.06497 5.8378378,898.22775 46.702703,898.22775 Z"
+           id="path877"
+           inkscape:connector-curvature="0"
+           sodipodi:nodetypes="sssssssss" />
+      </g>
+    </clipPath>
+    <filter
+       inkscape:collect="always"
+       id="filter891"
+       inkscape:label="Badge Shadow">
+      <feGaussianBlur
+         inkscape:collect="always"
+         stdDeviation="0.71999962"
+         id="feGaussianBlur893" />
+    </filter>
+  </defs>
+  <sodipodi:namedview
+     id="base"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageopacity="0.0"
+     inkscape:pageshadow="2"
+     inkscape:zoom="1"
+     inkscape:cx="39.339828"
+     inkscape:cy="216.87971"
+     inkscape:document-units="px"
+     inkscape:current-layer="layer1"
+     showgrid="false"
+     fit-margin-top="0"
+     fit-margin-left="0"
+     fit-margin-right="0"
+     fit-margin-bottom="0"
+     inkscape:window-width="1920"
+     inkscape:window-height="1043"
+     inkscape:window-x="1914"
+     inkscape:window-y="0"
+     inkscape:window-maximized="1"
+     showborder="true"
+     showguides="false"
+     inkscape:guide-bbox="true"
+     inkscape:showpageshadow="false"
+     inkscape:snap-bbox="true">
+    <inkscape:grid
+       type="xygrid"
+       id="grid821"
+       empspacing="5"
+       visible="true"
+       enabled="true"
+       snapvisiblegridlinesonly="true" />
+    <sodipodi:guide
+       orientation="1,0"
+       position="16,48"
+       id="guide823" />
+    <sodipodi:guide
+       orientation="0,1"
+       position="64,80"
+       id="guide825" />
+    <sodipodi:guide
+       orientation="1,0"
+       position="80,40"
+       id="guide827" />
+    <sodipodi:guide
+       orientation="0,1"
+       position="64,16"
+       id="guide829" />
+  </sodipodi:namedview>
+  <metadata
+     id="metadata6522">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title />
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     inkscape:label="BACKGROUND"
+     inkscape:groupmode="layer"
+     id="layer1"
+     transform="translate(268,-635.29076)"
+     style="display:inline">
+    <path
+       style="fill:#262a2d;fill-opacity:1;stroke:none;display:inline;filter:url(#filter1121)"
+       d="m -268,700.15563 0,-33.72973 c 0,-27.24324 3.88785,-31.13513 31.10302,-31.13513 l 33.79408,0 c 27.21507,0 31.1029,3.89189 31.1029,31.13513 l 0,33.72973 c 0,27.24325 -3.88783,31.13514 -31.1029,31.13514 l -33.79408,0 C -264.11215,731.29077 -268,727.39888 -268,700.15563 Z"
+       id="path6455"
+       inkscape:connector-curvature="0"
+       sodipodi:nodetypes="sssssssss" />
+    <g
+       style="opacity:0.7"
+       id="g11"
+       transform="matrix(0.62044056,0,0,0.62044056,-314.18126,593.62097)">
+      <rect
+         style="fill:#dcf0f0"
+         x="112.197"
+         y="168.302"
+         width="31.702999"
+         height="15.852"
+         id="rect13" />
+      <rect
+         style="fill:#dcf0f0"
+         x="159.75"
+         y="168.302"
+         width="31.683001"
+         height="15.852"
+         id="rect15" />
+      <rect
+         style="fill:#dcf0f0"
+         x="112.173"
+         y="136.599"
+         width="79.269997"
+         height="15.852"
+         id="rect17" />
+      <rect
+         style="fill:#dcf0f0"
+         x="112.197"
+         y="104.898"
+         width="47.558998"
+         height="15.851"
+         id="rect19" />
+      <rect
+         style="fill:#dcf0f0"
+         x="175.60201"
+         y="104.898"
+         width="15.851"
+         height="15.851"
+         id="rect21" />
+    </g>
+    <image
+       width="70"
+       height="70"
+       preserveAspectRatio="none"
+       xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAMAAACdt4HsAAADAFBMVEVNbjAsNlKaPjNnYjJ8QlG9 PkXpAAVIPSKAelxrOB7PAwvoAAV0ajdTTj04S2hsZko9RyZTTTDiAARwbHJhXWU6VXA0WoB3dHtL TDuEf4I5UmRUVGMyLh+YkXRBPChVTTdLSVU1MSI9OCqTjpIoHTYsJ0M7O1IjHx4rJx1KapMkKDVK N0okICIzSWQ+ZowAAACkuaqQ0GSiva7jbUmUXy5rqJrP47+AqIO5oT0kr1qlm1GLu5O9qlzBloVt qE/UTkaIqm3ajGfPqZToumZzXC3DqESQf014eTfcw1LuV1AgSweUyKLbVy70yLa80VXTeVjX7NY+ rWC2fnLC2MWup4ZBOCWnkjePfjTst5innH7we3C5spBswocsdiHyo5VlLxjWw2pzw4yFRCbe1a5l qHXtOjZuaFkQvDrz2F8KsDHsHh8cgx4adxzVXDDvcmoHiBng8N3q0XPKwZxueF/xkITEXjrMakTv YVlkv4OS0qDBUS/GRCVJuW7128imQiS1SyuNNBf37N1vYUXa2L7bdUXV6c3Oyq6v3pTXZDdQcDaq uroAmB653busp5U2bi3ehFOVq7UexUTF5Md/e2ShnZTgkWTimG0BpigZtzpmja3zsqAuwkWh1KiB zJVoQiiAnrK0PyL++NtwzmPPRSVxKQ5JyFN5yZHvhnvi3saJo7RizFufs7ippaOzv7vs5cNWyVfs 7NapOh/dfUvl3rygmojJwbz48ObZbD7j59Sa14Cq2rXdiVuzr5+Jz5s8xk3lpX+l2oju6MrjnXbn rYvZ2MbGzMC0sK3h2tFwk66P1HfOysYBxD7q5t+B0WyWk4K8QiPr7ujv5bwAvjXS0sDu7+K/vK3S 1s307uLz6Nzx8erj5uHx8+++xbx5mbD57sX38NacNRrt4dPm6eUAsC6Khm749vCNinoAtzH+++X/ /PH88cnU2tH489f888/w5NbZ3tXg493//ff59un9+Ozd4Nr28NP///78+vPy6L/z6sP17c749N72 79D17cz068j59eJDZRzfAAAAMHRSTlPpdfrY0fsd3u7zVm7q4pTVyMGS59haPe629XTKcv6q/saC l/xmiakwWQwcEUIGAQC57bJoAAALH0lEQVR4AYyTW0gb+ReAfeilakurLbTl76Varf411vfSpbSK i2ARRKlW0KDYh0AFXS9gMBotUgLSUNtCfMiFBJKQJhiTXkBBokkdluIgs1nnYWacQJAkOGFJEHLJ jHt+Scf0pbAfEUH4vnNyxilo/g/cb2psqJPUl1VVV9y6ekUCf6m7VlJdJmkGfh1oamwECVm3Sq5e Cpb39Y8vDbscXH99c7OkUCuVPmyrQoFfj0JWN7L2HUkhwiFSPM+NVzXXFxqHpGNjY231Z4H7OQtG XSrvA2vYtb+fYCIIRvgJnj9ZulY2ZIRAy+s3Y5clZ4GS7vEfFhNhGCaZJZFECMkzHeBcPeAbhx62 GI3r0isNKICo2GcSOfYTIsm8n5Uz8BUyqeC8US7/8GRB+sZobJGWiIHq4cQ+AvkocTZeYODDCx6L RfBRXs6zAv7Mdu/qbwvSdePG2OUCuHZdTe29K+NJ0MXRDAC2wyEIhM8jUCqPnVZ7VJhdWJmX45Pb vTu9vV2/j7WMQaD2zvW7Hz8F3P1J5MMGrsWEy0fZqUXGYVUnHTRGCDqdh7freM6mfoH8rR1Eb1ub FAXuWKJKMqpc7oYbLKrVLgqzOdQamsYwSlBjFgutsQu0jed8Oo9BVcnK8amtnWyhd2dI2/qssqCW iAYCAXKzDwIERiXtOkfShi0mCR3m9Wl8XtqqtmB2jiPoNcsCi+unthCQ2J6Uy/HBqoKabygQ9Zej DehFhqIdjEpDMBFKY3dgNp/OTvswH5fx6ijw8c6t7e1s4PEMLscL65sLJO+UKPApCGd30QRD0K6I XeNjGEJji6h1KquXttHeTGYNq2Txuc5tBCQ6cVyuuFgH/4kNt0kU8AYTyYSDphjYAoZTkYhPo+Io zGrjrbTOkzEsVbL6uY0PCChM6XF8qKIBvQtNNwJRCOwG9+Gx6ewRC02AC7+tmJez0FBRaawpw5I2 67/PBh7P6HF9Ydn93Nt4bzcaiELABQ/eqoo4aF+EgME0RvE8b4Ov77X5sv7MxnsAEp1zelxxUYJ0 FKj9REaj0UBwWEgKalvEo6NgulVt92Z4PuXxpDIZzuDXss7JDQAVpvR6PVpfDNR8VMIKJAowNivh sep8gkfgOeSnUhnAsIn8NxvZwsakU+/UVsD6YkByVwkbKPfGeYGhrCqPz04IPAA6j/wTw/Ig8gFo dM459fML/jvN+UDDTRIF3P0ZIUskwgvI/jH+8Ng9yCqm1gEoTCmcTlPlbvh2Qz7Q9D+4Ifl5uZ87 e+d/8o+Py7P+q3XEpNPJapePAuFv9fkAPAaSDMwud2cDoi76qRUTq/jyCrH+ag7GLxDhPSK+W50P wGOYXZ0wd/VBIGeLxzs5ObS8MLFzXwAIwPrsYHAtFHL7459vNOUDRV0To+aBJ+WcqJ/5JwY3+K/B ByYVznntZug0HVr2x8N3684CjcXnJ54GDrxBPoUCeR04/sM08xqAxgzLwvqhdDod2twMh/1lYuBC cen52QOS3A0KqRwgH5/kfE+PouPly5dQmGPZwaM18CHgXw7Hv1eIgaLSonP/kHDGoEPUn06sptLQ ODQs9QxBAFCw2fVBPz0NLbnDsdj1xh+B4uLG2r+VJBkNujLIR4ERWfvAbPr4MPSutRXv6OgQ10c6 BLx78Vj4nUQMlF6osX+GFSAg3n5CJpONmGfToZVnD7R4B87Om1bWcj58Yl+PYrHwn1XiDUpLS91K 8iC2t3R8AjZwuDo6PT09MjIQrZx/+KDVZDINuk9DSM8SWzs6iMX/uiU+hf8XlZ5/PrH6tOtJKgXn Q6yOmqfbp2Wyzp5B7cJC5YsVfwiNTuf82MHR93g8fLMhF4CfxnMD5tHRR4+ePzdPDKwC5pH26RGZ rN28SXm/rinT+fHpt2//baNuQtrIwzCAH/bQy24p+K0tteuHRk28bbuUXfYiFaWi262yxRSE4AdK DbiwBuJhKWkRY8AoKDU5VDBbJBAPJsQhI10oExxjCOkk2ckIYZPMxDCymcmkM1Bh3XeSTA7SBw+C PL+8/t9X9/NXTEBvkpydCgDHHIj9u/TDz2+e//bnsxcvXjyDzwfs+dI+G2Vz+5dy5I+H4RG7wSsI Qf8waoVrrgBtuCeWj/xyfpFIfP5vaelz4s3vzx5DyxuVk/MS5QEIm93mhQ0c4ASKkE2aCtCKeWIe d/Dtp0TiAmLaTzxeulQAlmVzRBEQTKiNEASBX41YUURq6KgAPS1CzPPxDgwAufxu3CCPnbi8yCmA NyY/HgBmQYjpTfd1dnRYjLRWgK46TyzmT38q9vftRgcAkD9ychv6uQIB/fyVyYFaEYPDodOZ9RLP fVsB1E1/x2L/pD9fQD9hMxrNl6Xkiu0cG33yxGpGbAa7cWTcbjAPRzZECVKtVgD4n+KJBdJ/XZT6 tvPz8ytILAdNxDZonxhfHHfYUZsZWUQJIct/OOChL7Z0VIA2N/wOzLvLt1670fjQ9+udVyYTfCQK zcXFCfugzWz1Ep68kDVPWLNC1stIMuC+XQE6nfCKzMu3L3UWy92nA3Pz2mXdBIqigzbE/ITNFTgu Dn14RtJg12ezBEMDwIfqK0AHrEE4eHW+MDA7OqYNhzOplbnl4Ic8wRVKkQUZyOodKMGTDMlLPM9X dStAd5XHI2xEzrG5H/uWwycnJ1Mzqc15SzpSSHIKkCQBEKRhh4GUGEIyhXjR2aMAmuaAR/D5rnIL Y6OzJ5C1tbWt4hgHeDzOQR+AEEnTtMQPO9BQMEA5JvRi9J4C9Lb58wK2esWe3X20WQK2j7aBgDHW sVwyDikCgiTxers97RcNI4hIN2sUoNUt0JGDS7bADMwowNHu7vZU6TXwZCiZDMmCBAKJjAyKVqOD Ehu6FKDHmaXxIMGy+NPZTEYBXC7X0VYmk5q3LPgKFFUCQBAfjiDW8UWriHUqQFeDkPczXpYtbAxs plLhqdIErr2dHdd2JpPZnIUxSImWBZ6WIvcdcCEIXLMCqKtJmmO88u0ylvnN1MxUGdjbOT3dOZrK hFMr2gUsIPLy/hGdDjV+PwLPWK2WATntATrA+OHucxxeIrbKAAjHp66tTDgMYxz4eTD0gzoEQVDH MFyzArRFJZLxcjlIIS4TqdTMdhkA4fB4bxuIzIp23U2LYiAoQihePGtVgFYsSzPviEJBFrgknras yISrDBwfHh6eHoWLYyz4KJKBQYpGuwL0tPBS8GOeK19uPISntTJxtFcCQHj//ngXHuNkZSBNB2mx 2Me/UYCuOonfiAgExxUBEEj3+txKJrV1tFMBXr8+3NvSPuobKwQlkWaddfW3K2+gbiJ5ZyQbC3Cl wOVRlHthbhOIXQUA4fWjvunp0clJZ0PzvZ5uKAKgrIHHfFkPES8Gzo6iaJ72Lc+ngHCdHkJk4KfR 6aHp/hs3a7o0pV4FaMPFyKqYzZJJWEX0DPM5N4IME0yvl4nj9xAYoH9vaqi/Xm5cAzoxEV+P+KCV ZiYnmeCGEzuLFgKkFDiwrMAtFgkYYCgcHhqt6dVorgMdLSKx6ou4cbaQxFqoEPzpQCia5kV/0LIZ BmLvUB4gvN3/leoLQHeVJIlyeCrpXognIYBQ0JcI9+QN7QwQayNj067w0ING6F8DIM2SyNMBHGup a7rZHA3JfUqiA+6NqvbGWlVt/ewMXNHY9NDQNAzwJaAdczZUt9+sqe3q1jRiFGwhjjvrmhpr5WVp etU1t4BY7oclKgNcA3pae7rUxZNQqWoZMupsaIJlqaAMUas1vSogtH0Pvm5Uab4AKIEfAdDdXA1z d6vhWxV01Rr4KhG3GmGgSh/yP0awuzrIDDAQAAAAAElFTkSuQmCC "
+       id="image3437"
+       x="-254"
+       y="648.29077" />
+  </g>
+  <g
+     inkscape:groupmode="layer"
+     id="layer3"
+     inkscape:label="PLACE YOUR PICTOGRAM HERE"
+     style="display:inline" />
+  <g
+     inkscape:groupmode="layer"
+     id="layer2"
+     inkscape:label="BADGE"
+     style="display:none"
+     sodipodi:insensitive="true">
+    <g
+       style="display:inline"
+       transform="translate(-340.00001,-581)"
+       id="g4394"
+       clip-path="none">
+      <g
+         id="g855">
+        <g
+           inkscape:groupmode="maskhelper"
+           id="g870"
+           clip-path="url(#clipPath873)"
+           style="opacity:0.6;filter:url(#filter891)">
+          <path
+             transform="matrix(1.4999992,0,0,1.4999992,-29.999795,-237.54282)"
+             d="m 264,552.36218 a 12,12 0 0 1 -12,12 12,12 0 0 1 -12,-12 12,12 0 0 1 12,-12 12,12 0 0 1 12,12 z"
+             sodipodi:ry="12"
+             sodipodi:rx="12"
+             sodipodi:cy="552.36218"
+             sodipodi:cx="252"
+             id="path844"
+             style="color:#000000;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:4;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
+             sodipodi:type="arc" />
+        </g>
+        <g
+           id="g862">
+          <path
+             sodipodi:type="arc"
+             style="color:#000000;fill:#f5f5f5;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:4;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
+             id="path4398"
+             sodipodi:cx="252"
+             sodipodi:cy="552.36218"
+             sodipodi:rx="12"
+             sodipodi:ry="12"
+             d="m 264,552.36218 a 12,12 0 0 1 -12,12 12,12 0 0 1 -12,-12 12,12 0 0 1 12,-12 12,12 0 0 1 12,12 z"
+             transform="matrix(1.4999992,0,0,1.4999992,-29.999795,-238.54282)" />
+          <path
+             transform="matrix(1.25,0,0,1.25,33,-100.45273)"
+             d="m 264,552.36218 a 12,12 0 0 1 -12,12 12,12 0 0 1 -12,-12 12,12 0 0 1 12,-12 12,12 0 0 1 12,12 z"
+             sodipodi:ry="12"
+             sodipodi:rx="12"
+             sodipodi:cy="552.36218"
+             sodipodi:cx="252"
+             id="path4400"
+             style="color:#000000;fill:#dd4814;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:4;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
+             sodipodi:type="arc" />
+          <path
+             sodipodi:type="star"
+             style="color:#000000;fill:#f5f5f5;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:3;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
+             id="path4459"
+             sodipodi:sides="5"
+             sodipodi:cx="666.19574"
+             sodipodi:cy="589.50385"
+             sodipodi:r1="7.2431178"
+             sodipodi:r2="4.3458705"
+             sodipodi:arg1="1.0471976"
+             sodipodi:arg2="1.6755161"
+             inkscape:flatsided="false"
+             inkscape:rounded="0.1"
+             inkscape:randomized="0"
+             d="m 669.8173,595.77657 c -0.39132,0.22593 -3.62645,-1.90343 -4.07583,-1.95066 -0.44938,-0.0472 -4.05653,1.36297 -4.39232,1.06062 -0.3358,-0.30235 0.68963,-4.03715 0.59569,-4.47913 -0.0939,-0.44198 -2.5498,-3.43681 -2.36602,-3.8496 0.18379,-0.41279 4.05267,-0.59166 4.44398,-0.81759 0.39132,-0.22593 2.48067,-3.48704 2.93005,-3.4398 0.44938,0.0472 1.81505,3.67147 2.15084,3.97382 0.3358,0.30236 4.08294,1.2817 4.17689,1.72369 0.0939,0.44198 -2.9309,2.86076 -3.11469,3.27355 -0.18379,0.41279 0.0427,4.27917 -0.34859,4.5051 z"
+             transform="matrix(1.511423,-0.16366377,0.16366377,1.511423,-755.37346,-191.93651)" />
+        </g>
+      </g>
+    </g>
+  </g>
+</svg>

data/examples/my-demo-charm/metadata.yaml

@@ -0,0 +1,18 @@
+name: dokuwiki
+summary: |
+  Dokuwiki is a simple to use wiki.
+description: |
+  DokuWiki is a simple to use and highly versatile Open Source wiki software
+  that doesn't require a database. It is loved by users for its clean and
+  readable syntax.
+maintainers: ['Adam Stokes <adam.stokes@ubuntu.com>']
+series:
+  - xenial
+tags:
+  - php
+  - wiki
+resources:
+  stable-release:
+    type: file
+    filename: stable.tgz
+    description: "Dokuwiki stable wiki source"

data/examples/my-demo-charm/tasks/vim.rb

@@ -0,0 +1,8 @@
+# The local task provide with the charm itself
+
+namespace :vim do
+  desc "Install VIM"
+  task :install do
+    system("apt-get install -qyf vim")
+  end
+end

data/examples/my-demo-charm/templates/acl.auth.php

@@ -0,0 +1,10 @@
+# acl.auth.php
+# <?php exit()?>
+# Don't modify the lines above
+#
+# Access Control Lists
+#
+# Auto-generated by install script
+# Date: Mon, 09 Nov 2015 01:28:56 +0000
+*               @ALL          1
+*               @user         8

data/examples/my-demo-charm/templates/local.php

@@ -0,0 +1,15 @@
+<?php
+/* Generated by Juju
+ */
+$conf['title'] = 'Dokuwiki';
+$conf['tagline'] = 'deployed by Juju';
+$conf['license'] = 'cc-by-sa';
+$conf['useacl'] = 1;
+$conf['superuser'] = '@admin';
+$conf['disableactions'] = 'register';
+$conf['showuseras'] = 'username';
+$conf['youarehere'] = 1;
+$conf['gzip_output'] = 1;
+$conf['sitemap'] = 1;
+$conf['userewrite'] = '1';
+$conf['useslash'] = 1;

data/examples/my-demo-charm/templates/plugins.local.php

@@ -0,0 +1,12 @@
+<?php
+/*
+ * Local plugin enable/disable settings
+ *
+ * Auto-generated by install script
+ * Date: Tue, 15 Sep 2015 13:34:04 +0000
+ */
+
+$plugins['authad']    = 0;
+$plugins['authldap']  = 0;
+$plugins['authmysql'] = 0;
+$plugins['authpgsql'] = 0;

data/examples/my-demo-charm/templates/users.auth.php

@@ -0,0 +1,11 @@
+# users.auth.php
+# <?php exit()?>
+# Don't modify the lines above
+#
+# Userfile
+#
+# Format:
+#
+# login:passwordhash:Real Name:email:groups,comma,seperated
+
+<%= admin_user %>:<%= admin_password %>:<%= admin_name %>:<%= admin_email %>:admin,user

data/examples/my-demo-charm/templates/vhost.conf

@@ -0,0 +1,42 @@
+# set cgi.fix_pathinfo = 0 in /etc/php/7.0/fpm/php.ini
+
+server {
+        ## Your website name goes here.
+        server_name <%= public_address %>;
+        ## Your only path reference.
+        root <%= app_path %>;
+        location / {
+		index doku.php;
+                # This is cool because no php is touched for static content.
+                # include the "?$args" part so non-default permalinks doesn't break when using query string
+                try_files $uri $uri/ @dokuwiki;
+        }
+
+	location ~ ^/lib.*\.(gif|png|ico|jpg)$ {
+                    expires 30d;
+	}
+
+	location ^~ /conf/ { return 403; }
+	location ^~ /data/ { return 403; }
+
+ 	location @dokuwiki {
+		rewrite ^/_media/(.*) /lib/exe/fetch.php?media=$1 last;
+		rewrite ^/_detail/(.*) /lib/exe/detail.php?media=$1 last;
+		rewrite ^/_export/([^/]+)/(.*) /doku.php?do=export_$1&id=$2 last;
+		rewrite ^/(.*) /doku.php?id=$1 last;
+	}
+
+        location ~ \.php$ {
+                include fastcgi_params;
+                fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
+                fastcgi_pass unix:/run/php/php7.0-fpm.sock;
+        }
+	# Block access to data folders
+	location ~ /(data|conf|bin|inc)/ {
+		deny all;
+	}
+	# Block access to .htaccess files
+	location ~ /\.ht {
+		deny  all;
+	}
+}

data/lib/charmkit/helpers/runner.rb

@@ -0,0 +1,17 @@
+require 'open3'
+
+module Charmkit
+  module Helpers
+    def run(*cmd)
+      stdout_s, stderr_s, status = Open3.capture3(*cmd)
+      if not status.success?
+        raise StandardError, "Failed to run command: #{stderr_s}"
+      end
+      return {
+        :out => stdout_s,
+        :err => stderr_s,
+        :status => status
+      }
+    end
+  end
+end

data/lib/charmkit/version.rb

@@ -6,7 +6,7 @@ module Charmkit
   module VERSION
     MAJOR = 0
     MINOR = 4
-    PATCH = 1
+    PATCH = 2
     PRE = nil
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')

data/lib/charmkit.rb

@@ -1,8 +1,6 @@
 require "charmkit/version"
 require "charmkit/helpers/template"
+require "charmkit/helpers/runner"
 
-module Charmkit
-  # A generic exception by Charmkit
-  class Error < StandardError; end
-end
+module Charmkit; end
 extend Charmkit::Helpers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: charmkit
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Adam Stokes
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-05 00:00:00.000000000 Z
+date: 2016-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,15 +98,27 @@ files:
 - bin/console
 - bin/setup
 - charmkit.gemspec
-- examples/Charmkitfile
-- examples/basic.rb
-- examples/demo/lib/install.rb
-- examples/demo/readme
-- examples/plugin_loader.rb
-- examples/template.rb
-- examples/templates/user_auth.txt
+- examples/my-demo-charm/Gemfile
+- examples/my-demo-charm/Gemfile.lock
+- examples/my-demo-charm/README.md
+- examples/my-demo-charm/Rakefile
+- examples/my-demo-charm/config.yaml
+- examples/my-demo-charm/copyright
+- examples/my-demo-charm/hooks/config-changed
+- examples/my-demo-charm/hooks/install
+- examples/my-demo-charm/hooks/upgrade-charm
+- examples/my-demo-charm/icon.svg
+- examples/my-demo-charm/metadata.yaml
+- examples/my-demo-charm/readme
+- examples/my-demo-charm/tasks/vim.rb
+- examples/my-demo-charm/templates/acl.auth.php
+- examples/my-demo-charm/templates/local.php
+- examples/my-demo-charm/templates/plugins.local.php
+- examples/my-demo-charm/templates/users.auth.php
+- examples/my-demo-charm/templates/vhost.conf
 - lib/charmkit.rb
 - lib/charmkit/extend/string_tools.rb
+- lib/charmkit/helpers/runner.rb
 - lib/charmkit/helpers/template.rb
 - lib/charmkit/plugins/nginx.rb
 - lib/charmkit/plugins/php.rb

data/examples/Charmkitfile

@@ -1,66 +0,0 @@
-# -*- mode:ruby -*-
-
-depends_on "nginx-full"
-depends_on "php-fpm"
-depends_on "php-cgi"
-depends_on "php-curl"
-depends_on "php-gd"
-depends_on "php-json"
-depends_on "php-mcrypt"
-depends_on "php-readline"
-depends_on "php-mbstring"
-depends_on "php-xml"
-
-hook "install" do
-  release = "#{config['release']}-release"
-  app_path = config 'app_path'
-  hook_path = ENV['JUJU_CHARM_DIR']
-  run "tar xf #{resource[release]} -C #{app_path} --strip-components=1"
-  rm "#{app_path}/conf/install.php" if is_file? "#{app_path}/conf/install.php"
-  cp "#{hook_path}/templates/acl.auth.php", "#{app_path}/conf/acl.auth.php"
-  cp "#{hook_path}/templates/local.php", "#{app_path}/conf/local.php"
-  cp "#{hook_path}/templates/plugins.local.php", "#{app_path}/conf/plugin.local.php"
-  file "/etc/dokuwiki-release", content: release
-  case release
-  when "stable"
-    version = cat "#{app_path}/VERSION"
-    run "application-version-set '#{version}'"
-  when "development"
-    t = Time.now
-    version = t.strftime "%Y-%m-%d"
-    run "application-version-set 'development-#{version}'"
-  else
-    status :blocked, "Unable to set proper application version"
-    exit 1
-  end
-end
-
-hook "config-changed" do
-  app_path = config 'app_path'
-  hook_path = ENV['JUJU_CHARM_DIR']
-  installed_release = cat "/etc/dokuwiki-release"
-  release = config 'release'
-  if !installed_release.eql? release
-    run './hooks/install'
-  end
-
-  admin_user = config 'admin_user'
-  admin_password = config 'admin_password'
-  admin_name = config 'admin_name'
-  admin_email = config 'admin_email'
-  template "#{hook_path}/templates/users.auth.php",
-           "#{app_path}/conf/users.auth.php",
-           admin_user: admin_user,
-           admin_password: admin_password,
-           admin_name: admin_name,
-           admin_email: admin_email
-
-  template "#{hook_path}/templates/vhost.conf",
-           "/etc/nginx/sites-enabled/default",
-           public_address: unit['public-address'],
-           app_path: app_path
-
-  chown_R 'www-data', 'www-data', app_path
-  run "systemctl restart nginx"
-  status :active, "Ready"
-end

data/examples/basic.rb

@@ -1,6 +0,0 @@
-require_relative './plugin_loader'
-
-# run 'ls -l /tmp'
-# status :active, "running application status..."
-# package ['znc', 'znc-perl', 'znc-python'], :update_cache
-# is_installed? 'znc'

data/examples/demo/lib/install.rb

@@ -1,30 +0,0 @@
-require 'charmkit'
-
-class Install < Charmkit
-  plugin :core
-  plugin :nginx
-  plugin :php
-
-  incant :nginx_install do |nginx|
-    ngnix.install
-    nginx.set_vhost server_name: config('server_name'),
-                    application_path: config('app_path')
-  end
-  incant :php_install do |php|
-    php.install version: 7,
-                plugins: ['fpm',
-                          'cgi',
-                          'curl',
-                          'gd',
-                          'json',
-                          'mcrypt',
-                          'readline',
-                          'mbstring',
-                          'xml']
-  end
-
-
-  def summon
-    log "Running example charm code"
-  end
-end

data/examples/plugin_loader.rb

@@ -1 +0,0 @@
-require 'charmkit/helpers'

data/examples/template.rb

@@ -1,4 +0,0 @@
-require 'charmkit'
-
-template 'examples/templates/user_auth.txt', '/tmp/user_auth.txt',
-         firstname: "joe", lastname: "bob"

data/examples/templates/user_auth.txt

@@ -1 +0,0 @@
-Hi there <%= firstname %> <%= lastname %>