enki 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8523f2685c2123bf425f7d19aa4e30c281c838ca
+  data.tar.gz: ff57940d741e8c08feb6638dedaf49bfccfb45cc
+SHA512:
+  metadata.gz: 7622883a70c067430fb391415c0ef8763021e4dc9f3d4be3a0027ddfced4242059c7986f2e21e1cb5231216f209d47e577ea455b591c919ce59e1893efe58d6e
+  data.tar.gz: 6e3c3ffb6b9ac187e8df743c2da91c33f583d5f2227e7cffc61b5316b42a51cb9e31e5d76f58bcf9c7cd042a31a8f8af7956d23bca5f32b18c0df6b02b5fba39

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in enki.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Giorgos Avramidis
+
+MIT License
+
+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,29 @@
+# Enki
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'enki'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install enki
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/enki/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,7 @@
+require "bundler/gem_tasks"
+
+desc "Open an irb session preloaded with this library"
+task :console do
+    sh "irb -rubygems -I lib -r enki.rb"
+end
+

data/enki.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'enki/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "enki"
+  spec.version       = Enki::VERSION
+  spec.authors       = ["Giorgos Avramidis"]
+  spec.email         = ["avramidg@gmail.com"]
+  spec.summary       = %q{Provide snowcrash and confluence integration}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  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_runtime_dependency "qarioz-confluencer", "~> 0.6", '>= 0.6.0'
+  spec.add_runtime_dependency "redcarpet", "~> 3.1", ">= 3.1.2"
+  spec.add_development_dependency "bundler", "~> 1.6", ">= 1.6.0"
+  spec.add_development_dependency "rake", "~> 10.3", ">= 10.3.2"
+  spec.add_development_dependency "rspec", "~> 3.0", ">= 3.0.0"
+end

data/lib/enki.rb

@@ -0,0 +1,46 @@
+require 'enki/version'
+require 'logger'
+require 'erb'
+require 'yaml'
+
+module Enki
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :confluence_url,
+      :confluence_user,
+      :confluence_password,
+      :confluence_space
+
+    attr_accessor :snowcrash_binary
+    attr_accessor :erb_template
+
+    def initialize
+      @erb_template = File.join File.dirname(__FILE__), "templates/default.html.erb"
+    end
+  end
+end
+
+require 'enki/confluence.rb'
+require 'enki/redcarpenter.rb'
+require 'enki/snowcrasher.rb'
+
+require 'enki/railtie.rb' if defined?(Rails) && Rails::VERSION::MAJOR > 2

data/lib/enki/confluence.rb

@@ -0,0 +1,68 @@
+require "confluencer"
+
+module Enki
+  module Confluence
+    extend self
+
+    def upload(file:, title: nil, space: nil)
+      confluence_session do |client|
+        upload_with_client(file: file, client: client, title: title, space: space)
+      end
+    end
+
+    def process_dir(src_dir:)
+      confluence_session do |client|
+        Dir.glob("#{src_dir}/**/*.html").each do |file|
+          upload_with_client(file: file, client: client)
+        end
+      end
+    end
+
+    private
+
+    def upload_with_client(file:, client:, title: nil, space: nil)
+      title ||= File.basename(file, '.*')
+      space ||= Enki.configuration.confluence_space
+
+      content = File.read(file)
+
+      old_page = begin
+        client.get_page(space, title)
+      rescue ::Confluence::Error
+        # Page does not exist yet
+        nil
+      end
+
+      if old_page
+        Enki.logger.info "Updating #{old_page["title"].inspect} in #{old_page["space"].inspect}..."
+        client.update_page({
+          "id" => old_page["id"],
+          "space" => old_page["space"],
+          "title" => old_page["title"],
+          "content" => content,
+          "version" => old_page["version"],
+        }, {})
+      else
+        Enki.logger.info "Creating #{title.inspect} in #{space.inspect}..."
+        client.store_page({
+          "space" => space,
+          "title" => title,
+          "content" => content,
+        })
+      end
+      Enki.logger.info "Done!"
+    end
+
+    def confluence_session
+      options = {
+        url: Enki.configuration.confluence_url,
+        username: Enki.configuration.confluence_user,
+        password: Enki.configuration.confluence_password
+      }
+
+      ::Confluence::Session.new(options) do |client|
+        yield(client)
+      end
+    end
+  end
+end

data/lib/enki/railtie.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require 'rails'
+
+module Enki
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/compile_docs.rake'
+    end
+  end
+end

data/lib/enki/redcarpenter.rb

@@ -0,0 +1,44 @@
+require 'redcarpet'
+
+class EnkiRender < Redcarpet::Render::HTML
+  def block_code(code, language)
+    <<-HTML
+      <ac:structured-macro ac:name="code">
+        <ac:plain-text-body>
+          <![CDATA[#{code}]]>
+        </ac:plain-text-body>
+      </ac:structured-macro>
+    HTML
+  end
+end
+
+module Enki
+  module Redcarpenter
+    extend self
+
+    def compile_file(source:, output:)
+      @data = YAML.load_file(source)
+      @markdown = ::Redcarpet::Markdown.new(
+        EnkiRender,
+        no_intra_emphasis: true,
+      )
+
+      template_file = File.open(Enki.configuration.erb_template)
+
+      template = ERB.new template_file.read
+
+      File.open(output, 'w') do |file|
+        file.puts template.result(binding)
+      end
+    end
+
+    def compile_dir(src_dir:, dst_dir:)
+      Dir.glob("#{src_dir}/**/*.yml").each do |source_file|
+        output_file = "#{dst_dir}/#{source_file[%r{#{src_dir}/(.*)\.yml}, 1]}.html"
+        FileUtils.mkdir_p File.dirname(output_file)
+
+        compile_file(source: source_file, output: output_file)
+      end
+    end
+  end
+end

data/lib/enki/snowcrasher.rb

@@ -0,0 +1,22 @@
+module Enki
+  module Snowcrasher
+    extend self
+
+    def compile_file(source:, output:, format: "yaml")
+      result = `#{Enki.configuration.snowcrash_binary} --output '#{output}' --format #{format} '#{source}' 2>&1`
+
+      unless $?.success?
+        raise "Snowcrasher: Error: #{result}"
+      end
+    end
+
+    def compile_dir(src_dir:, dst_dir:)
+      Dir.glob("#{src_dir}/**/*.md").each do |source_file|
+        output_file = "#{dst_dir}/#{source_file[%r{#{src_dir}/(.*)\.md}, 1]}.yml"
+        FileUtils.mkdir_p File.dirname(output_file)
+
+        compile_file(source: source_file, output: output_file)
+      end
+    end
+  end
+end

data/lib/enki/version.rb

@@ -0,0 +1,3 @@
+module Enki
+  VERSION = "0.0.2"
+end

data/lib/tasks/compile_docs.rake

@@ -0,0 +1,16 @@
+namespace :enki do
+  desc "Generate AST files"
+  task :generate_ast => :environment do
+    Enki::Snowcrasher.compile_dir(src_dir: "doc", dst_dir: "tmp/enki/ast")
+  end
+
+  desc "Generate html from AST"
+  task :ast_to_html => :generate_ast do
+    Enki::Redcarpenter.compile_dir(src_dir: "tmp/enki/ast", dst_dir: "tmp/enki/html")
+  end
+
+  desc "Upload documentation to confluence"
+  task :upload_to_confluence => :ast_to_html do
+    Enki::Confluence.process_dir(src_dir: "tmp/enki/html")
+  end
+end

data/lib/templates/default.html.erb

@@ -0,0 +1,117 @@
+<ac:structured-macro ac:name="toc">
+  <ac:parameter ac:name="maxLevel">3</ac:parameter>
+</ac:structured-macro>
+
+<h2><%= @data['name'] %></h2>
+<%=@markdown.render @data['description'] %>
+
+<% @data['resourceGroups'].each do |group| %>
+  <h2><%= group['name'] %></h2>
+  <hr/>
+  <% group['resources'].each do |resource| %>
+    <% resource['actions'].each do |action| %>
+      <h3><%= action['method'] %> <%= resource['uriTemplate'] %></h3>
+
+      <h5>Description</h5>
+      <%=@markdown.render action['description'] %>
+
+      <% if action['parameters'] %>
+        <h5>Parameters</h5>
+        <table>
+          <tbody>
+            <tr>
+              <th>Name</th>
+              <th>Type</th>
+              <th>Default</th>
+              <th>Example</th>
+              <th>Mandatory</th>
+              <th>Description</th>
+            </tr>
+            <% action['parameters'].each do |parameter| %>
+              <tr>
+                <td><%= parameter['name'] %></td>
+                <td><%= parameter['type'] %></td>
+                <td><%= parameter['default'] %></td>
+                <td><%= parameter['example'] %></td>
+                <td><%= parameter['required'] and 'yes' or 'no' %></td>
+                <td><%=@markdown.render parameter['description'] %></td>
+              </tr>
+            <% end %>
+          </tbody>
+        </table>
+      <% end %>
+
+      <% if action['body'] %>
+        <ac:structured-macro ac:name="code">
+          <ac:plain-text-body>
+            <![CDATA[<%= action['body'] %>]]>
+          </ac:plain-text-body>
+        </ac:structured-macro>
+      <% end %>
+
+      <% if action['examples'] %>
+        <% action['examples'].each do |example| %>
+          <% if example['requests'] %>
+            <h5>Request</h5>
+            <% example['requests'].each do |request| %>
+              <%=@markdown.render request['description'] if request['description'] %>
+              <% if request['body'] %>
+                <ac:structured-macro ac:name="code">
+                  <ac:parameter ac:name="title">Example</ac:parameter>
+                  <ac:plain-text-body>
+                    <![CDATA[<%= request['body'] %>]]>
+                  </ac:plain-text-body>
+                </ac:structured-macro>
+              <% end %>
+              <% if request['schema'] %>
+                <ac:structured-macro ac:name="code">
+                  <ac:parameter ac:name="title">JSON Schema</ac:parameter>
+                  <ac:parameter ac:name="collapse">true</ac:parameter>
+                  <ac:plain-text-body>
+                    <![CDATA[<%= request['schema'] %>]]>
+                  </ac:plain-text-body>
+                </ac:structured-macro>
+              <% end %>
+            <% end %>
+          <% end %>
+          <% if example['responses'] %>
+            <h5>Response codes</h5>
+            <table>
+              <tbody>
+                <tr>
+                  <th>Code</th>
+                  <th>Comment</th>
+                </tr>
+                <% example['responses'].each do |response| %>
+                  <tr>
+                    <td><%= response['name'] %></td>
+                    <td>
+                      <%=@markdown.render response['description'].to_s %>
+                      <% if response['body'] %>
+                        <ac:structured-macro ac:name="code">
+                          <ac:parameter ac:name="title">Example</ac:parameter>
+                          <ac:plain-text-body>
+                            <![CDATA[<%= response['body'] %>]]>
+                          </ac:plain-text-body>
+                        </ac:structured-macro>
+                      <% end %>
+                      <% if response['schema'] %>
+                        <ac:structured-macro ac:name="code">
+                          <ac:parameter ac:name="title">JSON Schema</ac:parameter>
+                          <ac:parameter ac:name="collapse">true</ac:parameter>
+                          <ac:plain-text-body>
+                            <![CDATA[<%= response['schema'] %>]]>
+                          </ac:plain-text-body>
+                        </ac:structured-macro>
+                      <% end %>
+                    </td>
+                  </tr>
+                <% end %>
+              </tbody>
+            </table>
+          <% end %>
+        <% end %>
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>

data/spec/enki_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Enki do
+  describe "#configure" do
+    it "sets the confluence user" do
+      Enki.configure do |conf|
+        conf.confluence_user = "conf_user"
+      end
+
+      expect(Enki.configuration.confluence_user).to eql "conf_user"
+    end
+
+    it "sets the confluence password" do
+      Enki.configure do |conf|
+        conf.confluence_password = "conf_pass"
+      end
+
+      expect(Enki.configuration.confluence_password).to eql "conf_pass"
+    end
+
+    it "sets the confluence url" do
+      Enki.configure do |conf|
+        conf.confluence_url = "conf_url"
+      end
+
+      expect(Enki.configuration.confluence_url).to eql "conf_url"
+    end
+
+    it "sets the confluence space" do
+      Enki.configure do |conf|
+        conf.confluence_url = "conf_space"
+      end
+
+      expect(Enki.configuration.confluence_space).to eql "conf_space"
+    end
+
+    it "sets the erb template path" do
+      # has a default template path
+      expect(Enki.configuration.erb_template).to eql "lib/templates/default.html.erb"
+
+      Enki.configure do |conf|
+        conf.erb_template = "template_path"
+      end
+
+      expect(Enki.configuration.erb_template).to eql "template_path"
+    end
+  end
+
+  describe "logging" do
+    it "sets the logger" do
+      logger = Logger.new(STDOUT)
+      Enki.logger = logger
+
+      expect(logger).to receive(:log).with("a message")
+
+      Enki.logger.log "a message"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'enki'

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: enki
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Giorgos Avramidis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: qarioz-confluencer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: ''
+email:
+- avramidg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- enki.gemspec
+- lib/enki.rb
+- lib/enki/confluence.rb
+- lib/enki/railtie.rb
+- lib/enki/redcarpenter.rb
+- lib/enki/snowcrasher.rb
+- lib/enki/version.rb
+- lib/tasks/compile_docs.rake
+- lib/templates/default.html.erb
+- spec/enki_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: Provide snowcrash and confluence integration
+test_files:
+- spec/enki_spec.rb
+- spec/spec_helper.rb