confluence_helper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 871a0cbe9392a85d9fbcc1dbee5d85ccad98f8da
+  data.tar.gz: 1089c0962a376f79dc98dfb6d2b7d4c8ee930e56
+SHA512:
+  metadata.gz: 51355352fd4557663437a81280ce8ded2507b538b282df80699c60a264a5b54a35caead2d117fa90f3684c6009422725ff4dec7368e1acfddca4e5619d99d0d1
+  data.tar.gz: 4d8414608b8f4be1d5af6563ac8b87077cd2cb48a16ba0122b791c34238dac19f612decba21a6321cde889b0a352df1e26d7aab1a05575797b979a3e163b1c38

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in confluence_helper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Nigel Thorne
+
+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,31 @@
+# ConfluenceHelper
+
+Confluence Helper wraps up some conflience API operations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'confluence_helper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install confluence_helper
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/confluence_helper/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/confluence_helper.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'confluence_helper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "confluence_helper"
+  spec.version       = ConfluenceHelper::VERSION
+  spec.authors       = ["Nigel Thorne"]
+  spec.email         = ["github@nigelthorne.com"]
+  spec.summary       = %q{Helper for accessing data from within your Confluence wiki}
+  spec.description   = %q{I needed to pull data from Confluence for several internal web services. This is intended to pull together all helper logic I need to get the data I want.}
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "nokogiri", "~> 1.6.4"
+  spec.add_runtime_dependency "envied", "~> 0.8.1"
+end

data/lib/confluence_helper.rb

@@ -0,0 +1,220 @@
+require "confluence_helper/version"
+
+module ConfluenceHelper
+	
+  class HtmlTable
+    def initialize(node)
+      @node = node
+    end
+    
+    def has_columns?(columns:)
+      column_names.sort == columns.sort
+    end
+    
+    def column_names
+      @column_names ||= @node.xpath('.//tr/th').map{|n| n.text.strip}
+    end
+    
+    def data
+      @data ||= 
+        @node
+          .xpath('.//tr')
+          .map{|r| r.xpath('.//td').map{|cell| cell_value(cell)} }
+          .reject{|r| r.empty? }
+          .map{|r| column_names
+                      .each
+                        .with_index
+                          .with_object({}){ |(c,i),o| o[c] = r[i]  }
+              }
+    end
+    
+    private
+    
+    def cell_value(cell)
+      (cell.xpath(".//a").empty? ? cell.text : cell.inner_html).gsub("\u00C2", " ").gsub("\u00A0", " ").strip
+    end
+  end
+
+
+class Confluence
+
+  def get_labels_for_each_child_page(rootpageid)
+    child_pages_in_space(rootpageid, {:expand => "metadata.labels"} ).
+      each_with_object({}) do |page, hash|
+        hash[page["title"]] = 
+          page.
+            fetch("metadata", {}).
+            fetch("labels",{}).
+            fetch("results",[]).
+            map{|l| l["name"]}
+      end
+  end
+  
+  def find_url_by_title_and_space(spacekey, title)
+    page_by_title_in_space(spacekey, title, {})["_links"]["self"]
+  end 
+  
+  def save_page_attachment( spacekey, page_title, attachment_name, destination )
+    response = query_rest_api( get_attachment_url( spacekey, page_title, attachment_name ) )
+    File.open(destination, 'wb') { |fp| fp.write(response.body) }
+  end
+  
+  def deliverables_pages(rootpageid)
+    child_pages_in_space(rootpageid, {:expand => "metadata.labels,body.export_view"} ).
+      each_with_object({}) do |page, hash|
+        hash[page["title"]] = DeliverablePage.new( 
+            labels: page.fetch("metadata", {}).fetch("labels", {}).fetch("results",[]).map{|l| l["name"]},
+            body: page.fetch("body", {}).fetch("export_view", {}).fetch("value", "")
+         )
+      end
+  end
+  
+  private
+
+  @@url = {}
+  
+  class DeliverablePage
+    def initialize(labels:, body:)
+      @node = Nokogiri::HTML(body)
+    end
+    
+    def tables
+      @tables ||= @node.xpath('//table').map{|t| HtmlTable.new(t) }
+    end
+
+    def deliverables
+      tables.select{|t| is_deliverables_table? t } .map{|table| table.data }.flatten
+    end
+
+    #Name	DHFR	Status	Location	Comments
+    def is_deliverables_table?(table)
+      table.has_columns? columns: %w{Name DHFR Status Location Comments}
+    end
+
+  end
+ 
+  def get_attachment_url(spacekey, page_title, attachment_name)
+    "#{ENVied.CONSTASH_URL}#{ get_attachment_data(spacekey, page_title, attachment_name)["_links"]["download"]}"
+  end
+  
+  def get_attachment_data(spacekey, page_title, attachment_name)
+    get_attachments_data(spacekey, page_title).find{|x| x["title"] == attachment_name}
+  end
+ 
+  def get_attachments_data(spacekey, page_title)
+    page_by_title_in_space(spacekey, page_title, {expand:"children.attachment"})["children"]["attachment"]["results"]
+  end
+  
+  def page_by_title_in_space(spacekey, page_title, options)
+    all_pages = pages_in_space(spacekey, options).lazy
+    all_pages.find {|p| p['title'] == page_title}.
+      tap{|page| raise "Can't find page with title #{page_title} in that space #{spacekey}\n\tFound pages: #{all_pages.map{|p| p['title']}.join("\n\t")}" unless page }
+  end   
+  
+  def pages_in_space(spacekey, options)
+    enum_for(:for_all_pages_of_results, "rest/api/space/#{spacekey}/content/page", options)
+  end  
+  
+  def child_pages_in_space(pageid, options)
+    enum_for(:for_all_pages_of_results, "rest/api/content/#{pageid}/child/page", options)
+  end  
+  
+  def for_all_pages_of_results(url, options, &block)
+    full_options = {start:0, limit:25}.merge(options)
+    response = query_rest_api(url, full_options)
+    if response && response.success? 
+      results = response.body.fetch('results',[])
+      results.each{ |p| block.call(p) }
+      if(results.count == full_options[:limit])
+        start = full_options[:start] + results.count 
+        for_all_pages_of_results(url, options.merge({start:start}), &block)  
+      end
+    end
+  end  
+  
+  def get_logged_in_connection(request = :json)
+    # TODO: move to memcache
+    # store = ActiveSupport::Cache.lookup_store(:mem_cache_store, ['localhost:11211'])
+  
+    return Faraday.new(:url => ENVied.CONSTASH_URL) do |faraday|
+      faraday.use :http_cache # , store: store
+      faraday.request :url_encoded              # form-encode POST params
+      faraday.basic_auth(ENVied.CONSTASH_USERNAME, ENVied.CONSTASH_PASSWORD)
+      faraday.request request
+
+      faraday.response :json, :content_type => /\bjson$/
+#      faraday.response :logger                  # log requests to STDOUT
+
+      faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+    end
+  end
+  
+  def query_rest_api(url, options = {})
+    puts "-->#{url} #{options.inspect}"
+    get_logged_in_connection().
+      get(url, options).
+        tap{ |response| 
+          raise "Error while attempting to query '#{ENVied.CONSTASH_URL}/#{url}'\n Status: #{response.status} \n #{response.body}" unless [200, 302].include? response.status  
+        }
+  end
+  
+  def get_url(space, title)
+    @@url[ [space,title] ] ||= find_url_by_title_and_space(space, title)
+  end
+end
+
+class WikiPage < Confluence
+
+  def initialize(spacekey, title)
+    @spacekey, @title = spacekey, title
+  end
+  
+  def to_nodes
+    parse_wiki_table(doc)
+  end
+  
+  def attachment(title)
+    page = query_rest_api( url , {expand:"children.attachment"})
+    results = page.body["children"]["attachment"]["results"]
+    result = results.find{|x| x["title"] == title}
+    attachment_url = "#{ENVied.CONSTASH_URL}#{result["_links"]["download"]}"
+    query_rest_api(attachment_url, options = {}).body
+  end
+  
+  private 
+  
+  def url
+    @url ||= get_url(@spacekey, @title)
+  end
+  
+  def doc
+    @doc ||= get_page_body()
+  end
+  
+  def get_page_body()
+    page = query_rest_api( url , {expand:"body.export_view"} )
+    return Nokogiri::HTML( page.body["body"]["export_view"]["value"] )
+  end 
+
+  
+  def parse_wiki_table(doc)
+    rows = doc.xpath("//table/tbody/tr")
+    headers =  rows.xpath("th").map{|n| n.content}
+    rows = rows - rows.xpath("th/..")
+    documents = rows.map{ | row | row_to_hash(row, headers) }  #convert to hashes
+    documents.each_with_object({}){|doc, o| o[doc["ID"].to_i] = doc } # index by id
+  end  
+  
+  def row_to_hash(row, headers)
+    row.xpath( "td" ).
+      to_a.
+        each.
+          with_index.
+          with_object( {} ) { | (cell , index) , row_hash | 
+            row_hash[ headers[ index ] ] = cell.content.gsub( /\u00A0/,"" ) 
+          }
+  end
+  
+end
+
+end

data/lib/confluence_helper/version.rb

@@ -0,0 +1,3 @@
+module ConfluenceHelper
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: confluence_helper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nigel Thorne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+- !ruby/object:Gem::Dependency
+  name: envied
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+description: I needed to pull data from Confluence for several internal web services.
+  This is intended to pull together all helper logic I need to get the data I want.
+email:
+- github@nigelthorne.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- confluence_helper.gemspec
+- lib/confluence_helper.rb
+- lib/confluence_helper/version.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.4.2
+signing_key: 
+specification_version: 4
+summary: Helper for accessing data from within your Confluence wiki
+test_files: []