mandrill-template-manager 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0f07ce0a0fdd67bb48350b6b8704f4dd12aa096
-  data.tar.gz: 54efe14bbf3fe59062a17370517cb16408a31c7e
+  metadata.gz: f266294f177aacc1b9526a166683283d174b3f41
+  data.tar.gz: 2325b885208b5dd04fc6f8f1693baa119e8ebca5
 SHA512:
-  metadata.gz: 8a2b2400323faf0811dcd3056b5176b1ee7052a03232bf79fa9f18c4d8c196e6832a3566eaa67c15a2c8b630cc73c2ccb6db5ed64e8c3fdaa3e392738f56822c
-  data.tar.gz: 0e27fea8408dfdd325126442a0eab8837b59c487c212ec5572f5e59bb4e29b81a12c7310937785a824f8ad22cb51fd2a6a97ac2d53c0b96828686a754377456f
+  metadata.gz: 7361dfc08ed25beab0f5512303752b1cf5a07b8f88d17c95bbfa4f6ad72fe7272be46b94accfa4d66b912f0a189f58f79059b7ffff5aaae23cb00f759498449a
+  data.tar.gz: 097ad4edb603d6d857ea456286cfa4811435b112796dadd7fa06650ae507108ca9777bebc5f3fee3f65e3278a47f7b25673364bb1baffaf5a8b5c705b66091ff

data/README.md

@@ -1,4 +1,4 @@
-# Mandrill Template Manager(CLI)
+# Mandrill Template Manager (CLI)
 
 Manage [Mandrill Templates](https://mandrillapp.com/api/docs/templates.ruby.html) by CLI.
 
@@ -15,23 +15,28 @@ gem 'unicode'
 ```
 
 ```
-$ ./bin/mandrilltemplate
+$ bundle install
+```
+
+```
+$ bundle exec mandrilltemplate
 Commands:
-  mandrilltemplate delete NAME                # delete template from remote.
-  mandrilltemplate export NAME                # export template from remote to local files.
-  mandrilltemplate generate NAME              # generate new template files.
+  mandrilltemplate delete SLUG                # delete template from remote.
+  mandrilltemplate export SLUG                # export template from remote to local files.
+  mandrilltemplate export_all                 # export all templates from remote to local files.
+  mandrilltemplate generate SLUG              # generate new template files.
   mandrilltemplate help [COMMAND]             # Describe available commands or one specific command
   mandrilltemplate list                       # show template list both of remote and local.
-  mandrilltemplate publish NAME               # publish template from draft.
-  mandrilltemplate render NAME [PARAMS_FILE]  # render mailbody from local template data. File should be Array. see https://mandrillapp.com/api/docs/templates.JSON.html#method=render.
-  mandrilltemplate upload NAME                # upload template to remote as draft.
+  mandrilltemplate publish SLUG               # publish template from draft.
+  mandrilltemplate render SLUG [PARAMS_FILE]  # render mailbody from local template data. File should be Array. see https://mandrillapp.com/api/docs/templates.JSON.html#method=render.
+  mandrilltemplate upload SLUG                # upload template to remote as draft.
 
 ```
 
 ## Workflow
 
 1. generate new or export exist template as local files.
-2. modify and manage under version controle system.
+2. modify and manage under version control system.
 3. upload template.
 4. publish it.
 
@@ -44,7 +49,8 @@ APIKEY is read from environment variable.
 export MANDRILL_APIKEY='your api key'
 ```
 
-Next, check by list subcommand.
+
+## List templates
 
 ```
 $ mandrilltemplate list
@@ -65,25 +71,84 @@ Local Templates
 
 ```
 
+you can also specify a label to filter this list:
+
+```
+$ mandrilltemplate list LABEL
+```
+
+
+## Downloading templates from Mandrill
+
+```
+$ mandrilltemplate export SLUG
+```
+
+or
+
+```
+$ mandrilltemplate export_all
+```
+
+
+
+## Uploading and publishing templates
+
+```
+$ mandrilltemplate upload SLUG
+```
+
+```
+$ mandrilltemplate publish SLUG
+```
+
+or, both at once:
+
+```
+$ mandrilltemplate upload SLUG --publish
+```
+
+
+## Deleting templates
+
+```
+$ mandrilltemplate delete SLUG
+```
+
+will delete from server only.
+
+```
+$ mandrilltemplate upload SLUG --delete_local
+```
+
+will also delete local files.
+
+
 
 ## Template local files
 
-Templates are stored into `templates/` directory.
+Templates are stored by defualt into `templates/` directory.
+
+You can control this by setting the MANDRILL_TEMPLATES_DIR environment variable.
+
+```
+export MANDRILL_TEMPLATES_DIR=mandrill_templates
+```
 
 ```
 templates/
-├── ${template_name1}
-│   ├── code         # code contents
+├── ${template_slug1}
+│   ├── code.html    # code contents
 │   ├── metadata.yml # metadata of template
-│   └── text         # text contents
-├── ${template_name2}
-│   ├── code
+│   └── text.txt     # text contents
+├── ${template_slug2}
+│   ├── code.html
 │   ├── metadata.yml
-│   └── text
-└── ${template_name3}
-    ├── code
+│   └── text.txt
+└── ${template_slug3}
+    ├── code.html
     ├── metadata.yml
-    └── text
+    └── text.txt
 ```
 
 example of metadata.yml
@@ -97,7 +162,7 @@ from_email: test@example.com
 from_name: Boss
 ```
 
-## Optional: render suppots Handlebars preview.
+## Optional: render supports Handlebars preview.
 
 If you would like to use handlebars template.
 You should add handlebars rubygem to Gemfile.
@@ -114,7 +179,7 @@ It will be compiled as Handlebars Template.
 
 ```
 Usage:
-  mandrilltemplate render NAME [PARAMS_FILE]
+  mandrilltemplate render SLUG [PARAMS_FILE]
 
 Options:
   [--handlebars], [--no-handlebars]

data/lib/mandrill_template/cli.rb

@@ -9,75 +9,87 @@ autoload "Handlebars", 'handlebars'
 
 class MandrillTemplateManager < Thor
   include Thor::Actions
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 
-  desc "export NAME", "export template from remote to local files."
-  def export(name)
-    template = MandrillClient.client.templates.info(name)
+  desc "export_all", "export all templates from remote to local files."
+  def export_all
+    remote_templates = MandrillClient.client.templates.list
+    remote_templates.each do |template|
+      export(template["slug"])
+    end
+  end
+
+  desc "export SLUG", "export template from remote to local files."
+  def export(slug)
+    template = MandrillClient.client.templates.info(slug)
     meta, code, text  = build_template_for_export(template)
-    save_as_local_template(name, meta, code, text)
+    save_as_local_template(meta, code, text)
   end
 
-  desc "upload NAME", "upload template to remote as draft."
-  def upload(name)
-    template = MandrillTemplate::Local.new(name)
+  desc "upload SLUG", "upload template to remote as draft."
+  option :publish, type: :boolean, default: false, aliases: :p
+  def upload(slug)
+    template = MandrillTemplate::Local.new(slug)
     if template.avail
       upload_template(template)
+      publish(slug) if options[:publish]
     else
-      puts "Template data not found #{name}. Please generate first."
+      puts "Template data not found #{slug}. Please generate first."
     end
   end
 
-  desc "delete NAME", "delete template from remote."
-  def delete(name)
+  desc "delete SLUG", "delete template from remote."
+  option :delete_local, type: :boolean, default: false
+  def delete(slug)
     begin
-      result = MandrillClient.client.templates.delete(name)
+      result = MandrillClient.client.templates.delete(slug)
       puts result.to_yaml
     rescue Mandrill::UnknownTemplateError => e
       puts e.message
     end
+    delete_local_template(slug) if options[:delete_local]
   end
 
-  desc "generate NAME", "generate new template files."
-  def generate(name)
-    new_template = MandrillTemplate::Local.new(name)
+  desc "generate SLUG", "generate new template files."
+  def generate(slug)
+    new_template = MandrillTemplate::Local.new(slug)
     puts new_template.class
     meta, code, text = build_template_for_export(new_template)
-    save_as_local_template(name, meta, code, text)
+    save_as_local_template(meta, code, text)
   end
 
-  desc "publish NAME", "publish template from draft."
-  def publish(name)
-    puts MandrillClient.client.templates.publish(name).to_yaml
+  desc "publish SLUG", "publish template from draft."
+  def publish(slug)
+    puts MandrillClient.client.templates.publish(slug).to_yaml
   end
 
-  desc "render NAME [PARAMS_FILE]", "render mailbody from local template data. File should be Array. see https://mandrillapp.com/api/docs/templates.JSON.html#method=render."
+  desc "render SLUG [PARAMS_FILE]", "render mailbody from local template data. File should be Array. see https://mandrillapp.com/api/docs/templates.JSON.html#method=render."
   option :handlebars, type: :boolean, default: false
-  def render(name, params = nil)
+  def render(slug, params = nil)
     merge_vars =  params ? JSON.parse(File.read(params)) : []
-    template = MandrillTemplate::Local.new(name)
+    template = MandrillTemplate::Local.new(slug)
     if template.avail
       if options[:handlebars]
         handlebars = Handlebars::Context.new
         h_template = handlebars.compile(template['code'])
         puts h_template.call(localize_merge_vars(merge_vars))
       else
-        result = MandrillClient.client.templates.render template.name,
-          [{"content"=>template["code"], "name"=>template.name}],
+        result = MandrillClient.client.templates.render template.slug,
+          [{"content"=>template["code"], "name"=>template.slug}],
           merge_vars
         puts result["html"]
       end
     else
-      puts "Template data not found #{name}. Please generate first."
+      puts "Template data not found #{slug}. Please generate first."
     end
   end
 
-  desc "list", "show template list both of remote and local."
+  desc "list [LABEL]", "show template list both of remote and local [optionally filtered by LABEL]."
   option :verbose, type: :boolean, default: false, aliases: :v
-  def list
+  def list(label = nil)
     puts "Remote Templates"
     puts "----------------------"
-    remote_templates = MandrillClient.client.templates.list
+    remote_templates = MandrillClient.client.templates.list(label)
     remote_templates.map! do |template|
       template["has_diff"] = has_diff_between_draft_and_published?(template)
       template
@@ -117,7 +129,7 @@ class MandrillTemplateManager < Thor
     puts "Local Templates"
     puts "----------------------"
     Formatador.display_compact_table(
-      collect_local_templates,
+      collect_local_templates(label),
       [
         "name",
         "slug",
@@ -142,6 +154,7 @@ class MandrillTemplateManager < Thor
   def build_template_for_export(t)
     [
       {
+        "name"       => t['name'],
         "slug"       => t['slug'],
         "labels"     => t['labels'],
         "subject"    => t['subject'],
@@ -153,19 +166,27 @@ class MandrillTemplateManager < Thor
     ]
   end
 
-  def save_as_local_template(name, meta, code, text)
-    empty_directory File.join("templates", name)
-    create_file File.join("templates", name, "metadata.yml"), meta.to_yaml
-    create_file File.join("templates", name, "code"), code
-    create_file File.join("templates", name, "text"), text
+  def templates_directory
+    MandrillClient.templates_directory
+  end
+
+  def save_as_local_template(meta, code, text)
+    dir_name = meta['slug']
+    empty_directory File.join(templates_directory, dir_name)
+    create_file File.join(templates_directory, dir_name, "metadata.yml"), meta.to_yaml
+    create_file File.join(templates_directory, dir_name, "code.html"), code
+    create_file File.join(templates_directory, dir_name, "text.txt"), text
   end
 
-  def collect_local_templates
+  def collect_local_templates(label = nil)
     local_templates = []
-    dirs = Dir.glob("templates/*").map {|path| path.split(File::SEPARATOR).last}
+    dirs = Dir.glob("#{ templates_directory }/*").map {|path| path.split(File::SEPARATOR).last}
     dirs.map do |dir|
       begin
-      local_templates << MandrillTemplate::Local.new(dir)
+        template = MandrillTemplate::Local.new(dir)
+        if label.nil? || template['labels'].include?(label)
+          local_templates << template
+        end
       rescue
         next
       end
@@ -173,13 +194,22 @@ class MandrillTemplateManager < Thor
     local_templates
   end
 
+  def delete_local_template(slug)
+    template = MandrillTemplate::Local.new(slug)
+    if template.avail
+      template.delete!
+    else
+      puts "Local template data not found #{slug}."
+    end
+  end
+
   def upload_template(t)
-    if remote_template_exists?(t.name)
+    if remote_template_exists?(t.slug)
       method = :update
     else
       method = :add
     end
-    result = MandrillClient.client.templates.send(method, t.name,
+    result = MandrillClient.client.templates.send(method, t.slug,
       t['from_email'],
       t['from_name'],
       t['subject'],
@@ -191,9 +221,9 @@ class MandrillTemplateManager < Thor
     puts result.to_yaml
   end
 
-  def remote_template_exists?(name)
+  def remote_template_exists?(slug)
     begin
-      MandrillClient.client.templates.info(name)
+      MandrillClient.client.templates.info(slug)
       true
     rescue Mandrill::UnknownTemplateError
       false

data/lib/mandrill_template/client.rb

@@ -2,6 +2,10 @@ require 'mandrill'
 require 'mandrill_template/client'
 
 module MandrillClient
+  def self.templates_directory
+    ENV['MANDRILL_TEMPLATES_DIR'] || "templates"
+  end
+
   def self.client
     Mandrill::API.new ENV['MANDRILL_APIKEY']
   end

data/lib/mandrill_template/template.rb

@@ -1,16 +1,17 @@
 require 'mandrill'
 require 'yaml'
+require 'fileutils'
 
 module MandrillTemplate
   class Local < Hash
-    attr_reader :name, :avail
+    attr_reader :slug, :avail
 
-    def initialize(name)
-      @name       = name
-      meta, code, text = load_data(name)
+    def initialize(slug)
+      @slug = slug
+      meta, code, text = load_data(slug)
 
-      self['name']       = name
-      self['slug']       = meta['slug']       ||= name
+      self['name']       = meta['name']       ||= slug
+      self['slug']       = meta['slug']       ||= slug
       self['from_email'] = meta['from_email'] ||= nil
       self['from_name']  = meta['from_name']  ||= nil
       self['subject']    = meta['subject']    ||= nil
@@ -20,13 +21,17 @@ module MandrillTemplate
       self['text']       = text               ||= nil
     end
 
-    def load_data(name)
-      if Dir.exists?(File.join("templates", name))
+    def templates_directory
+      MandrillClient.templates_directory
+    end
+
+    def load_data(slug)
+      if Dir.exists?(File.join(templates_directory, slug))
         @avail = true
-        code = File.read(File.join("templates", name, "code"))
-        text = File.read(File.join("templates", name, "text"))
+        code = File.read(File.join(templates_directory, slug, "code.html"))
+        text = File.read(File.join(templates_directory, slug, "text.txt"))
         [
-          YAML.load_file(File.join("templates", name, "metadata.yml")),
+          YAML.load_file(File.join(templates_directory, slug, "metadata.yml")),
           code.empty? ? nil : code,
           text.empty? ? nil : text
         ]
@@ -34,5 +39,13 @@ module MandrillTemplate
         [{}, nil, nil]
       end
     end
+
+    def delete!
+      dir_name = File.join(templates_directory, slug)
+      puts dir_name
+      if Dir.exists?(dir_name)
+        FileUtils.rm_rf(dir_name)
+      end
+    end
   end
 end

data/mandrill-template-manager.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "mandrill-template-manager"
-  spec.version       = "0.2.2"
+  spec.version       = "0.3.0"
   spec.authors       = ["sawanoboly"]
   spec.email         = ["sawanoboriyu@higanworks.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mandrill-template-manager
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - sawanoboly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-10 00:00:00.000000000 Z
+date: 2016-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor