asciidoctor-diagram-cacoo 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 40b4cb0bdb3da01a484c1c04da271cc433f7e694
+  data.tar.gz: 6a2b98b103042457c5e42693ff4755587497731c
+SHA512:
+  metadata.gz: 5f5d4a80c7737437c7e1f8b2e89541160d462419b7ecac5e105a631de0972e5029480f8224a89c296ac36aea297d645334d4fba2e93252ae4edfce35f6b2adf6
+  data.tar.gz: d96a410aa0826a5b265a22867f961006b39be1759d5e091ed687cda8d6ee5ef6e8c306f2e9574140101756bf4512c4e6c9d1fd9363983b1d4c2676dbd38df9b4

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in asciidoctor-diagram-cacoo.gemspec
+gemspec
+
+gem 'asciidoctor-diagram'
+gem 'nokogiri'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Hiroaki Nakamura
+
+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,90 @@
+# Asciidoctor::Diagram::Cacoo
+
+A ruby gem for adding support for [Cacoo](https://cacoo.com) to [asciidoctor-diagram](https://github.com/asciidoctor/asciidoctor-diagram).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'asciidoctor-diagram-cacoo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install asciidoctor-diagram-cacoo
+
+If you enable downloading contents.xml for cacoo diagrams, you also need to install [Nokogiri](http://www.nokogiri.org/)
+
+    $ gem install nokogiri
+
+## Usage
+
+You must have an account of [Cacoo](https://cacoo.com/).
+You need to create an Caoo API Key at [Cacoo API key config page](https://cacoo.com/profile/api)
+and set it to the environment variable `CACOO_API_KEY`.
+
+If you use bash or zsh, you can set it like the following:
+
+```
+export CACOO_API_KEY=_Your_Cacoo_API_key_here_
+```
+
+
+When you would like to add a diagram on Cacoo, you need the diagram ID.
+For example, if your diagram's URL is https://cacoo.com/diagrams/f0MLos8tgXXxaTB,
+your diagram ID is f0MLos8tgXXxaTBv.
+
+You can add a diagram to your application, like the following example:
+
+```
+acoo::f0MLos8tgXXxaTBv["png", alt="alt text"]
+```
+
+### Complete example
+
+sample.adoc
+
+```
+= asciidoctor-diagram-cacoo-example
+
+:cacoo_does_download_contents: true
+:cacoo_contents_xml_indent: 0
+
+.DiagramBlockProcessor class diagram
+cacoo::f0MLos8tgXXxaTBv["png", alt="DiagramBlockProcessor class"]
+
+.Source class diagram
+cacoo::Vsw9cGkj8bJjEBr6["png", alt="Source class"]
+```
+
+Optional asciidoc document attributes
+
+* cacoo_does_download_contents: true|false. Enable downlaoding contents.xml for cacoo diagrams. This is not needed to generate documents. However it is useful to see differences in diagrams if you put these contents.xml in version control system like git. Filename will be "cacoo-#{diagram_id}-contents.xml"
+* cacoo_contents_xml_indent: 0|2|4|0. Number of spaces for indent of contents.xml.
+
+
+You can load asciidoctor-diagram and asciidoctor-diagram-cacoo (this gem) with `-r` option
+of asciidoctor like below:
+
+```
+$ asciidoctor -r asciidoctor-diagram -r asciidoctor-diagram-cacoo sample.adoc
+```
+
+For a complete example, see https://github.com/hnakamur/asciidoctor-diagram-cacoo-example
+
+## Credits
+
+[asciidoctor-diagram-cacoo/extension.rb]( https://github.com/hnakamur/asciidoctor-diagram-cacoo/blob/master/lib/asciidoctor-diagram-cacoo/extension.rb ) is based on https://gist.github.com/pepijnve/2d4059db5d827462b5cd by [pepijnve (Pepijn Van Eeckhoudt)]( https://github.com/pepijnve ).
+
+Thanks!
+
+## Contributing
+
+1. Fork it ( https://github.com/hnakamur/asciidoctor-diagram-cacoo/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/asciidoctor-diagram-cacoo.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'asciidoctor-diagram-cacoo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "asciidoctor-diagram-cacoo"
+  spec.version       = Asciidoctor::Diagram::Cacoo::VERSION
+  spec.authors       = ["Hiroaki Nakamura"]
+  spec.email         = ["hnakamur@gmail.com"]
+  spec.summary       = %q{a ruby gem for asciidoctor-diagram to use Cacoo diagrams}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/hnakamur/asciidoctor-diagram-cacoo"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/asciidoctor-diagram-cacoo.rb

@@ -0,0 +1,8 @@
+require "asciidoctor-diagram-cacoo/version"
+require 'asciidoctor/extensions'
+
+Asciidoctor::Extensions.register do
+  require_relative 'asciidoctor-diagram-cacoo/extension'
+  block Asciidoctor::Diagram::CacooBlockProcessor, :cacoo
+  block_macro Asciidoctor::Diagram::CacooBlockMacroProcessor, :cacoo
+end

data/lib/asciidoctor-diagram-cacoo/extension.rb

@@ -0,0 +1,125 @@
+require 'json'
+require 'time'
+require 'asciidoctor-diagram/extensions'
+require 'nokogiri'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    module Cacoo
+      def self.get_diagram_metadata(diagram_id, api_key)
+        # NOTE: See API document at https://cacoo.com/lang/en/api and
+        # https://cacoo.com/lang/en/api_image
+        unless @diagrams
+          diagrams = JSON.parse(get("/api/v1/diagrams.json?apiKey=#{api_key}"))
+          @diagrams = diagrams['result'].each_with_object({}) { |d, h| h[d['diagramId']] = d }
+        end
+
+        @diagrams[diagram_id]
+      end
+
+      def self.get_diagram(diagram_id, api_key)
+        # NOTE: See API document at https://cacoo.com/lang/en/api and
+        # https://cacoo.com/lang/en/api_image
+        get("/api/v1/diagrams/#{diagram_id}.png?apiKey=#{api_key}")
+      end
+
+      def self.get_diagram_contents(diagram_id, api_key)
+        # NOTE: See API document at https://cacoo.com/lang/en/api and
+        # https://cacoo.com/lang/en/api_diagram_contents
+        get("/api/v1/diagrams/#{diagram_id}/contents.xml?returnValues=textStyle,shapeStyle,uid,position,point&apiKey=#{api_key}")
+      end
+
+      def self.save_diagram_contents(filename, contents, indent)
+        doc = Nokogiri.XML(contents)
+        File.open(filename, 'w') do |f|
+          f.write doc.to_xml(indent: indent)
+        end
+      end
+
+      def self.get(url)
+        https = Net::HTTP.new('cacoo.com', 443)
+        https.use_ssl = true
+        https.start do
+          response = https.get(url)
+          raise "Cacoo response status code was #{response.code}" if response.code != '200'
+          response.body
+        end
+      end
+
+      def self.included(mod)
+        mod.register_format(:png, :image) do |c, p|
+          if c.options[:does_download_contents]
+            contents = Cacoo.get_diagram_contents(c.diagram_id, c.api_key)
+            Cacoo.save_diagram_contents("#{c.image_name}-contents.xml", contents, c.options[:contents_xml_indent])
+          end
+          Cacoo.get_diagram(c.diagram_id, c.api_key)
+        end
+      end
+
+      class Source < Extensions::BasicSource
+        attr_accessor :diagram_id
+        attr_accessor :api_key
+        attr_accessor :options
+
+        def initialize(diagram_id, api_key, options)
+          @diagram_id = diagram_id
+          @api_key = api_key
+          @options = options
+        end
+
+        def image_name
+          "cacoo-#{diagram_id}"
+        end
+
+        def code
+          diagram_id
+        end
+
+        def should_process?(image_file, image_metadata)
+          Time.rfc2822(cacoo_metadata['updated']) < Time.rfc2822(image_metadata['updated'])
+        end
+
+        def create_image_metadata
+          { 'updated' => cacoo_metadata['updated'] }
+        end
+
+        def cacoo_metadata
+          Cacoo.get_diagram_metadata(diagram_id, api_key)
+        end
+      end
+    end
+
+    class CacooBlockProcessor < Extensions::DiagramBlockProcessor
+      include Cacoo
+
+      def create_source(parent, reader, attributes)
+        api_key = ENV['CACOO_API_KEY'] || parent.document.attributes['cacoo_api_key']
+        raise "Please specify your Cacoo API key using the CACOO_API_KEY environment variable or cacoo_api_key document attribute" unless api_key
+        does_download_contents = parent.document.attributes['cacoo_does_download_contents'] || false
+        contents_xml_indent = (parent.document.attributes['cacoo_contents_xml_indent'] || '2').to_i
+        options = {
+          does_download_contents: does_download_contents,
+          contents_xml_indent: contents_xml_indent
+        }
+        Cacoo::Source.new(reader.read.strip, api_key, options)
+      end
+    end
+
+    class CacooBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
+      include Cacoo
+
+      def create_source(parent, target, attributes)
+        api_key = ENV['CACOO_API_KEY'] || parent.document.attributes['cacoo_api_key']
+        raise "Please specify your Cacoo API key using the CACOO_API_KEY environment variable or cacoo_api_key document attribute" unless api_key
+        does_download_contents = parent.document.attributes['cacoo_does_download_contents'] || false
+        contents_xml_indent = (parent.document.attributes['cacoo_contents_xml_indent'] || '2').to_i
+        options = {
+          does_download_contents: does_download_contents,
+          contents_xml_indent: contents_xml_indent
+        }
+        Cacoo::Source.new(target.strip, api_key, options)
+      end
+    end
+  end
+end

data/lib/asciidoctor-diagram-cacoo/version.rb

@@ -0,0 +1,7 @@
+module Asciidoctor
+  module Diagram
+    module Cacoo
+      VERSION = "0.2.2"
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-diagram-cacoo
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Hiroaki Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: ''
+email:
+- hnakamur@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- asciidoctor-diagram-cacoo.gemspec
+- lib/asciidoctor-diagram-cacoo.rb
+- lib/asciidoctor-diagram-cacoo/extension.rb
+- lib/asciidoctor-diagram-cacoo/version.rb
+homepage: https://github.com/hnakamur/asciidoctor-diagram-cacoo
+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.2.2
+signing_key: 
+specification_version: 4
+summary: a ruby gem for asciidoctor-diagram to use Cacoo diagrams
+test_files: []