dokku_client 0.9 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98487c367379ec7fe21e9cd1ba2f9aea6fb491e2
-  data.tar.gz: 846d0acb2ea573cb1ef92c102d9105898702576e
+  metadata.gz: 77adf120b4406d0e502dc931bdc9feb2a52491d1
+  data.tar.gz: 4b290479f297e51af9e1ee2d5afe0cb139343636
 SHA512:
-  metadata.gz: b70e4db5d19ea9f9d070785c5e271a9a8097e30aee7947cd9fc30e9415061eaa69feccde3e853105f41bce2137a8f370c8933abd6303607b29404e9596dff9b8
-  data.tar.gz: 28e373b20dada52682a1ee324a2f9ef27b0b72fe66405acaf1f23b624885e6aeea0f9f051505b74505f75fe67753d10be60ad5d59db9ef28f5ffca14d0700014
+  metadata.gz: 995043f21370163f484433b117d6e11e22f2423e45a938f478297af136ebe9da3ab9b9b6ffdacd30e049671f779a73b3b00fa313a28d90ba56f38bcfd1aa74cf
+  data.tar.gz: f0cbed2205eb095fa869690dd41957b56959b08a0b864689b50abe9650603c2b42dc6d103933fa19ca6b362d29c620025c23c54856ca8f8e76b6948b2697b717

data/CHANGELOG

@@ -0,0 +1,48 @@
+=== 1.1 Current release
+
+* **TODO** more commands (redis , mysql)
+
+=== 1.0
+
+* set available commands visible in dokku help
+
+=== 0.9
+
+* better help output with description to each command
+
+=== 0.8
+
+* fix problem with rc / rdm command
+
+=== 0.7
+
+* fix postgresql methods
+
+=== 0.6
+
+* rails console commands
+
+=== 0.5
+
+* small updates
+
+=== 0.4
+
+* fix mongodb commands
+* postgresql commands
+
+=== 0.3
+
+* mongodb commands
+
+=== 0.2
+
+* delegate methods
+* memcached commands
+* more common commands
+
+=== 0.1
+
+* gem basic structure
+* logs command
+* config option per project

data/README.md

@@ -16,83 +16,74 @@ Install it yourself as:
 
 ## Configuration
 
-    $ dokku reconfig
+    $ dokku (for the first time in project)
 
-You will be asked for your dokku host and project name which will be stored in your application .git/config
-
-Show help
-
-    dokku help
-
-or
-
-    dokku --help
-
-Available commands (aliases to commands in brackets)
+    $ dokku reconfig (to update config)
 
-    dokku
-        logs (l)
-        run (r) <command>
-        url (u)
-        plugins (p)
-        config (c)
-        rc <env>
-        rdm
-        get_config (gc) <KEY>
-        set_config (sc) KEY=VALUE [KEY2=VALUE2]
-        unset_config (uc) KEY [KEY2]
-        create_mem
-        delete_mem
-        info_mem
-        logs_mem
-        link_mem <container>
-        create_mongo
-        delete_mongo
-        link_mongo
-        logs_mongo
-        list_mongo
-        status_mongo
-        create_postgres <db>
-        delete_postgres <db>
-        info_postgres <db>
-        list_postgres
-        logs_postgres <db>
-        link_postgres <db>
-
-## Roadmap
-
-### 0.7 Current release
+You will be asked for your dokku host and project name which will be stored in your application .git/config
 
-* **TODO** more commands (redis , mysql)
+## Customize list of available commands
 
-### 0.6
+    In 'active commands' question when you configuring dokku client type plugin name separated by comma and commands for this plugin will be visible in dokku help.
+    Available plugins:
 
-* rails console commands
+        + memcached
+        + postgresl
+        + mongodb
 
-### 0.5
+    Common and Config commands are enabled by default. If you don't answer to 'active commands' then all commands will be visible.
 
-* small updates
 
-### 0.4
+## Show help
 
-* fix mongodb commands
-* postgresql commands
+    dokku help
 
-### 0.3
+or
 
-* mongodb commands
+    dokku --help
 
-### 0.2
+## Available commands (aliases to commands in brackets)
 
-* delegate methods
-* memcached commands
-* more common commands
+    dokku
 
-### 0.1
+      Common commands:
+        logs (l)                                  show app logs
+        run (r) '<command>'                       run command (unfortunately fon now you have to type command in quotes)
+        url (u)                                   show link to aplication
+        plugins (p)                               show installed plugins on dokku host
+        rc <env>                                  run rails console for application (pass 'staging' to load staging console, or leave empty for production)
+        rdm                                       run database migrations
+
+      Config commands:
+        config (c)                                show environment variables for project
+        get_config (gc) <KEY>                     show exact environment variable
+        set_config (sc) KEY=VALUE [KEY2=VALUE2]   set new environment variables
+        unset_config (uc) KEY [KEY2]              remove environment variables
+
+      Memcached commands:
+        create_mem                                create memcached container
+        delete_mem                                delete memcached container
+        info_mem                                  display container informations
+        logs_mem                                  display last logs from memcached container
+        link_mem <container>                      link an app to memcached container
+
+      MongoDB commands:
+        create_mongo                              create a mongo database
+        delete_mongo                              delete a mongo database
+        console_mongo                             lunch mongodb console as admin
+        link_mongo                                link mongo container to application
+        logs_mongo                                display logs for mongo container
+        list_mongo                                list all mongo databases
+        status_mongo                              display status of mongo container
+
+      Postgresql commands:
+        create_postgres <db>                      create a postgresql database
+        delete_postgres <db>                      delete specified postgresql database
+        info_postgres <db>                        display database information
+        link_postgres <db>                        link an app to a postgresql container
+        list_postgres <db>                        display list of postgresql containers
+        logs_postgres                             display last logs from postgresql container
 
-* gem basic structure
-* logs command
-* config option per project
 
 ## Contributing
 

data/lib/dokku_client/base.rb

@@ -6,8 +6,9 @@ module DokkuClient
     GIT_DIR = '.git'
 
     KEYS_AND_QUESTIONS = {
-      "dokku-client.project-name"  => "Enter project name",
-      "dokku-client.project-host"   => "Enter dokku host"
+      "dokku-client.project-name"  => "Enter project name:",
+      "dokku-client.project-host"  => "Enter dokku host:",
+      "dokku-client.plugins"  => "Active commands (comma separated):"
     }
 
     def initialize(options={})
@@ -43,6 +44,10 @@ module DokkuClient
       exec "ssh", "-t", "dokku@#{@options["project-host"]}", arg
     end
 
+    def plugin_enabled plugin
+      @options["plugins"].include?(plugin) ||  @options["plugins"].nil?
+    end
+
     private
 
     def config_update_success

data/lib/dokku_client/plugins/memcached.rb

@@ -26,12 +26,14 @@ module DokkuClient
       end
 
       def commands opts
-        opts.separator  "\n   Memcached commands:"
-        opts.separator  "     create_mem                            create memcached container"
-        opts.separator  "     delete_mem                            delete memcached container"
-        opts.separator  "     info_mem                              display container informations"
-        opts.separator  "     logs_mem                              display last logs from memcached container"
-        opts.separator  "     link_mem <container>                  link an app to memcached container"
+        if plugin_enabled('memcached')
+          opts.separator  "\n   Memcached commands:"
+          opts.separator  "     create_mem                            create memcached container"
+          opts.separator  "     delete_mem                            delete memcached container"
+          opts.separator  "     info_mem                              display container informations"
+          opts.separator  "     logs_mem                              display last logs from memcached container"
+          opts.separator  "     link_mem <container>                  link an app to memcached container"
+        end
       end
 
     end

data/lib/dokku_client/plugins/mongodb.rb

@@ -34,14 +34,16 @@ module DokkuClient
       end
 
       def commands opts
-        opts.separator  "\n   MongoDB commands:"
-        opts.separator  "     create_mongo                          create a mongo database"
-        opts.separator  "     delete_mongo                          delete a mongo database"
-        opts.separator  "     console_mongo                         lunch mongodb console as admin"
-        opts.separator  "     link_mongo                            link mongo container to application"
-        opts.separator  "     logs_mongo                            display logs for mongo container"
-        opts.separator  "     list_mongo                            list all mongo databases"
-        opts.separator  "     status_mongo                          display status of mongo container"
+        if plugin_enabled('mongodb')
+          opts.separator  "\n   MongoDB commands:"
+          opts.separator  "     create_mongo                          create a mongo database"
+          opts.separator  "     delete_mongo                          delete a mongo database"
+          opts.separator  "     console_mongo                         lunch mongodb console as admin"
+          opts.separator  "     link_mongo                            link mongo container to application"
+          opts.separator  "     logs_mongo                            display logs for mongo container"
+          opts.separator  "     list_mongo                            list all mongo databases"
+          opts.separator  "     status_mongo                          display status of mongo container"
+        end
       end
 
     end

data/lib/dokku_client/plugins/postgresql.rb

@@ -38,13 +38,15 @@ module DokkuClient
       end
 
       def commands opts
-        opts.separator  "\n   Postgresql commands:"
-        opts.separator  "     create_postgres                       create a postgresql database"
-        opts.separator  "     delete_postgres                       delete specified postgresql database"
-        opts.separator  "     info_postgres                         display database information"
-        opts.separator  "     link_postgres                         link an app to a postgresql container"
-        opts.separator  "     list_postgres                         display list of postgresql containers"
-        opts.separator  "     logs_postgres                         display last logs from postgresql container"
+        if plugin_enabled('postgresql')
+          opts.separator  "\n   Postgresql commands:"
+          opts.separator  "     create_postgres <db>                  create a postgresql database"
+          opts.separator  "     delete_postgres <db>                  delete specified postgresql database"
+          opts.separator  "     info_postgres <db>                    display database information"
+          opts.separator  "     link_postgres <db>                    link an app to a postgresql container"
+          opts.separator  "     list_postgres <db>                    display list of postgresql containers"
+          opts.separator  "     logs_postgres                         display last logs from postgresql container"
+        end
       end
 
     end

data/lib/dokku_client/version.rb

@@ -1,3 +1,3 @@
 module DokkuClient
-  VERSION = '0.9'
+  VERSION = '1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dokku_client
 version: !ruby/object:Gem::Version
-  version: '0.9'
+  version: '1.0'
 platform: ruby
 authors:
 - Kuba Łasecki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-26 00:00:00.000000000 Z
+date: 2014-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grit
@@ -75,6 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG
 - Gemfile
 - LICENSE
 - README.md