mandrill-template-manager 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 32ca82c2977cb4fe68da1a2476622918cdafabe7
+  data.tar.gz: ae961d59944ce46502552ee4230057cbfe5bcac9
+SHA512:
+  metadata.gz: 3e9534c5b89fc18687dff1c435c155e7a50491d47ca2e7b76345e7eee71ef7c71a9e3bff7863eced832d3c373e6929a335fd143bf2b3b9de2a84d57d6297a7f3
+  data.tar.gz: 23d4a348a2f661fb13055cb30efddfdf160db004f90545a0a1f3cd955942b74164952fb94bf8d832c22aab55a279423711a7d9b1438f91b8c6044c558f0486c4

data/.gitignore

@@ -0,0 +1,51 @@
+# Created by https://www.gitignore.io
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+
+### Vim ###
+[._]*.s[a-w][a-z]
+[._]s[a-w][a-z]
+*.un~
+Session.vim
+.netrwhist
+*~
+
+## Manual
+/.envrc
+/templates/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.6
+before_install: gem install bundler -v 1.10.5

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mandrill-template-manager.gemspec
+gemspec
+
+gem 'formatador', github: 'geemus/formatador'
+gem 'unicode'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 sawanoboly(HiganWorks LLC)
+
+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,97 @@
+# Mandrill Template Manager(CLI)
+
+Manage [Mandrill Templates](https://mandrillapp.com/api/docs/templates.ruby.html) by CLI.
+
+## Install
+
+Add Gemfile and bundle.
+
+```
+gem 'mandrill-template-manager'
+```
+
+```
+$ ./bin/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 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 upload NAME     # 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.
+3. upload template.
+4. publish it.
+
+
+## Setup
+
+APIKEY is read from environment variable.
+
+```
+export MANDRILL_APIKEY='your api key'
+```
+
+Next, check by list subcommand.
+
+```
+$ mandrilltemplate list
+
+Remote Templates
+----------------------
+  +----------+----------+----------+--------------+---------------------+---------------------+--------+---------------+-----------------+------------------+--------------------+-----------+-------------------+
+  | has_diff | name     | slug     | publish_name | draft_updated_at    | published_at        | labels | subject       | publish_subject | from_email       | publish_from_email | from_name | publish_from_name |
+  +----------+----------+----------+--------------+---------------------+---------------------+--------+---------------+-----------------+------------------+--------------------+-----------+-------------------+
+  ... remote templates ...
+
+Local Templates
+----------------------
+  +----------+----------+------------------+-----------+--------------------+------------------------+
+  | name     | slug     | from_email       | from_name | subject            | labels                 |
+  +----------+----------+------------------+-----------+--------------------+------------------------+
+  ... local templates ...
+
+```
+
+
+## Template local files
+
+Templates are stored into `templates/` directory.
+
+```
+templates/
+├── ${template_name1}
+│   ├── code         # code contents
+│   ├── metadata.yml # metadata of template
+│   └── text         # text contents
+├── ${template_name2}
+│   ├── code
+│   ├── metadata.yml
+│   └── text
+└── ${template_name3}
+    ├── code
+    ├── metadata.yml
+    └── text
+```
+
+example of metadata.yml
+
+```
+---
+slug: mission
+labels: []
+subject: "Today's your mission"
+from_email: test@example.com
+from_name: Boss
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/mandrilltemplate

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), %w[.. lib])
+
+require "thor"
+require "mandrill_template/cli"
+require "mandrill_template/monkey_create_file"
+
+MandrillTemplateManager.start(ARGV)

data/lib/mandrill_template/cli.rb

@@ -0,0 +1,165 @@
+require 'mandrill'
+require 'mandrill_template/client'
+require 'mandrill_template/template'
+require 'formatador'
+require 'unicode' unless ['jruby'].include?(RbConfig::CONFIG['ruby_install_name'])
+require 'yaml'
+require "mandrill_template/monkey_create_file"
+
+class MandrillTemplateManager < Thor
+  include Thor::Actions
+  VERSION = "0.1.0"
+
+  desc "export NAME", "export template from remote to local files."
+  def export(name)
+    template = MandrillClient.client.templates.info(name)
+    meta, code, text  = build_template_for_export(template)
+    save_as_local_template(name, meta, code, text)
+  end
+
+  desc "upload NAME", "upload template to remote as draft."
+  def upload(name)
+    template = MandrillTemplate::Local.new(name)
+    if template.avail
+      upload_template(template)
+    else
+      puts "Template data not found #{name}. Please generate first."
+    end
+  end
+
+  desc "delete NAME", "delete template from remote."
+  def delete(name)
+    begin
+      result = MandrillClient.client.templates.delete(name)
+      puts result.to_yaml
+    rescue Mandrill::UnknownTemplateError => e
+      puts e.message
+    end
+  end
+
+  desc "generate NAME", "generate new template files."
+  def generate(name)
+    new_template = MandrillTemplate::Local.new(name)
+    puts new_template.class
+    meta, code, text = build_template_for_export(new_template)
+    save_as_local_template(name, meta, code, text)
+  end
+
+  desc "publish NAME", "publish template from draft."
+  def publish(name)
+    puts MandrillClient.client.templates.publish(name).to_yaml
+  end
+
+  desc "list", "show template list both of remote and local."
+  def list
+    puts "Remote Templates"
+    puts "----------------------"
+    remote_templates = MandrillClient.client.templates.list
+    remote_templates.map! do |template|
+      template["has_diff"] = has_diff_between_draft_and_published?(template)
+      template
+    end
+
+    Formatador.display_compact_table(
+      remote_templates,
+      ["has_diff",
+       "name",
+       "slug",
+       "publish_name",
+       "draft_updated_at",
+       "published_at",
+       "labels",
+       "subject",
+       "publish_subject",
+       "from_email",
+       "publish_from_email",
+       "from_name",
+       "publish_from_name"]
+    )
+
+    puts "Local Templates"
+    puts "----------------------"
+    Formatador.display_compact_table(
+      collect_local_templates,
+      [
+        "name",
+        "slug",
+        "from_email",
+        "from_name",
+        "subject",
+        "labels"
+      ]
+    )
+  end
+
+  private
+
+  def has_diff_between_draft_and_published?(t)
+    %w[name code text subject].each do |key|
+      return true if t[key] != t["publish_#{key}"]
+    end
+    return true unless t['published_at']
+    false
+  end
+
+  def build_template_for_export(t)
+    [
+      {
+        "slug"       => t['slug'],
+        "labels"     => t['labels'],
+        "subject"    => t['subject'],
+        "from_email" => t['from_email'],
+        "from_name"  => t['from_name']
+      },
+      t['code'],
+      t['text']
+    ]
+  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
+  end
+
+  def collect_local_templates
+    local_templates = []
+    dirs = Dir.glob("templates/*").map {|path| path.split(File::SEPARATOR).last}
+    dirs.map do |dir|
+      begin
+      local_templates << MandrillTemplate::Local.new(dir)
+      rescue
+        next
+      end
+    end
+    local_templates
+  end
+
+  def upload_template(t)
+    if remote_template_exists?(t.name)
+      method = :update
+    else
+      method = :add
+    end
+    result = MandrillClient.client.templates.send(method, t.name,
+      t['from_email'],
+      t['from_name'],
+      t['subject'],
+      t['code'],
+      t['text'],
+      false, # publish
+      t['labels']
+    )
+    puts result.to_yaml
+  end
+
+  def remote_template_exists?(name)
+    begin
+      MandrillClient.client.templates.info(name)
+      true
+    rescue Mandrill::UnknownTemplateError
+      false
+    end
+  end
+end

data/lib/mandrill_template/client.rb

@@ -0,0 +1,8 @@
+require 'mandrill'
+require 'mandrill_template/client'
+
+module MandrillClient
+  def self.client
+    Mandrill::API.new ENV['MANDRILL_APIKEY']
+  end
+end

data/lib/mandrill_template/monkey_create_file.rb

@@ -0,0 +1,11 @@
+class Thor
+  module Actions
+    class CreateFile
+      class_eval do
+        def identical?
+          exists? && File.binread(destination).force_encoding(render.encoding) == render
+        end
+      end
+    end
+  end
+end

data/lib/mandrill_template/template.rb

@@ -0,0 +1,38 @@
+require 'mandrill'
+require 'yaml'
+
+module MandrillTemplate
+  class Local < Hash
+    attr_reader :name, :avail
+
+    def initialize(name)
+      @name       = name
+      meta, code, text = load_data(name)
+
+      self['name']       = name
+      self['slug']       = meta['slug']       ||= name
+      self['from_email'] = meta['from_email'] ||= nil
+      self['from_name']  = meta['from_name']  ||= nil
+      self['subject']    = meta['subject']    ||= nil
+      self['labels']     = meta['labels']     ||= []
+
+      self['code']       = code               ||= nil
+      self['text']       = text               ||= nil
+    end
+
+    def load_data(name)
+      if Dir.exists?(File.join("templates", name))
+        @avail = true
+        code = File.read(File.join("templates", name, "code"))
+        text = File.read(File.join("templates", name, "text"))
+        [
+          YAML.load_file(File.join("templates", name, "metadata.yml")),
+          code.empty? ? nil : code,
+          text.empty? ? nil : text
+        ]
+      else
+        [{}, nil, nil]
+      end
+    end
+  end
+end

data/mandrill-template-manager.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "mandrill-template-manager"
+  spec.version       = "0.1.0"
+  spec.authors       = ["sawanoboly"]
+  spec.email         = ["sawanoboriyu@higanworks.com"]
+
+  spec.summary       = %q{Manage Mandrill Template CLI}
+  spec.description   = %q{Manage Mandrill Template CLI}
+  spec.homepage      = "https://github.com/higanworks/mandrill-template-manager"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor"
+  spec.add_dependency "mandrill-api"
+  spec.add_dependency "formatador"
+  spec.add_dependency "unicode"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-doc"
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: mandrill-template-manager
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sawanoboly
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mandrill-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: formatador
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: unicode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Manage Mandrill Template CLI
+email:
+- sawanoboriyu@higanworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/mandrilltemplate
+- lib/mandrill_template/cli.rb
+- lib/mandrill_template/client.rb
+- lib/mandrill_template/monkey_create_file.rb
+- lib/mandrill_template/template.rb
+- mandrill-template-manager.gemspec
+homepage: https://github.com/higanworks/mandrill-template-manager
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Manage Mandrill Template CLI
+test_files: []
+has_rdoc: