confluence_reporter 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8966c801f8a7318c64acc02cd64b8cd5097500d0
+  data.tar.gz: 7d0034d1901e3ee790e5e9ba64a27ca805a16c5e
+SHA512:
+  metadata.gz: 47c2e0b883f7ee14b9d5bc3844720ebff56361e35c13bdad435eea4646c6590d1d9175c677d8ea4c75eaf37347892cbc2ef01ddea0dee6337a9782556fb7c2a8
+  data.tar.gz: 96a62ba2c6c99ea9ac89071e165df55b7aa5eac712ec01877686270ee207427e1cf91d541f97496a8952bf6c7e8e25fe81421f09862bb1d01f6bf14b94a76bc3

data/.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.gitignore

@@ -0,0 +1,23 @@
+.idea
+*.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 hiera_loader.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,191 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+
+   Copyright 2015 Adaptavist.com Ltd.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,23 @@
+# ConfluenceReporter
+
+Logger to confluence. Allows access to pages, creation and appending of messages. You have to flush the log to confluence by calling report_event method.
+
+For now all log messages are displayed in the same way. Will add colors in next version.
+
+## Usage
+
+```
+
+reporter = ConfluenceReporter::Reporter.new(base_url, user, password)
+
+puts reporter.find_page_by_id(page_id)
+
+puts reporter.find_page_by_name(name, parrent_page_id)
+
+reporter.log(log)
+
+# Flush log to confluence, creates or appends to page 
+reporter.report_event(name, parrent_page_id, space)
+
+
+```

data/Rakefile

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

data/confluence_reporter.gemspec

@@ -0,0 +1,19 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'confluence_reporter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "confluence_reporter"
+  spec.version       = ConfluenceReporter::VERSION
+  spec.authors       = ["Martin Brehovsky"]
+  spec.email         = ["mbrehovsky@adaptavist.com"]
+  spec.summary       = "Api to publish to confluence"
+  spec.description   = "Creates and updates pages in confluence"
+  spec.homepage      = "https://github.com/Adaptavist/confluence_reporter"
+  spec.license       = "Apache-2.0"
+  spec.files = `git ls-files`.split($\)
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/confluence_reporter.rb

@@ -0,0 +1,203 @@
+# Copyright 2015 Adaptavist.com Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require "confluence_reporter/version"
+require "base64"
+require 'uri'
+require 'net/http'
+require 'net/https'
+require 'json'
+
+module ConfluenceReporter
+    
+    class Reporter
+    
+    attr_accessor :body_message, :base_url, :user, :password
+
+        def initialize(base_url, user, password)
+            @body_message = "<h2>#{Time.now}</h2>"
+            @base_url = base_url
+            @user = user
+            @password = password
+        end
+
+        %w(debug info warn error fatal).each do |m|
+            define_method(m) do |*args|
+                log(*args)
+            end
+        end
+
+        def log(message, print=true)
+            if print
+                puts message
+            end
+            @body_message = @body_message + "<p>#{message.gsub("\\n", "<br/>").gsub("<", "&lt;").gsub(">","&gt;").gsub("&", "&amp;")}</p>"
+        end
+
+        def log_structured_code(message, print=true)
+            if print
+                puts message
+            end
+            message.split("\n").each do |line|
+                    @body_message = @body_message + "<pre>#{line}</pre>"
+            end
+        end
+
+        def find_page_by_name(name, parrent_page_id=nil)
+            found = nil
+            if parrent_page_id
+                uri = URI.parse(@base_url + parrent_page_id + "/child/page")
+                https = Net::HTTP.new(uri.host, uri.port)
+                https.use_ssl = true
+                
+                # https.set_debug_output $stderr
+                next_url = uri.request_uri
+                # Confluence limits the result to only 25
+                while (next_url and !found)
+                    request = Net::HTTP::Get.new(next_url)
+                    request.basic_auth(@user, @password)
+                    request['Accept'] = 'application/json'
+                    response = https.request(request)
+                    resp = JSON.parse(response.body)
+                    resp["results"].each do |res|
+                        if res["title"] == name
+                            found = res
+                            break
+                        end
+                    end
+
+                    if resp["_links"]["next"]
+                        if next_url == (resp["_links"]["base"] + resp["_links"]["next"])
+                            next_url = nil
+                        else
+                            next_url = resp["_links"]["base"] + resp["_links"]["next"]
+                        end
+                    else
+                        next_url = nil
+                    end
+                end
+            else
+                uri = URI.parse(@base_url)
+                params={"start" => "0", "limit" => "40", "title" => name, "type" => "page", "expand" => "id,version,ancestors"}
+                uri.query = URI.encode_www_form(params)
+                https = Net::HTTP.new(uri.host, uri.port)
+                https.use_ssl = true
+                
+                request = Net::HTTP::Get.new(uri.request_uri)
+                request.basic_auth(@user, @password)
+                request['Accept'] = 'application/json'
+
+                response = https.request(request)
+                resp = JSON.parse(response.body)
+                found = resp["results"]
+            end
+            found
+        end
+
+        def find_page_by_id(page_id)
+            uri = URI.parse(@base_url + page_id)
+            params={"expand" => "body,body.storage,version"}
+            uri.query = URI.encode_www_form(params)
+            https = Net::HTTP.new(uri.host, uri.port)
+            https.use_ssl = true
+
+            request = Net::HTTP::Get.new(uri.request_uri)
+            request.basic_auth(@user, @password)
+            request['Accept'] = 'application/json'
+
+            response = https.request(request)
+            JSON.parse(response.body)
+        end
+
+        # appends the log to confluence page if found, if not creates new page
+        # clears the log
+        def report_event(name, parrent_page_id=nil, space=nil)
+            page = find_page_by_name(name, parrent_page_id)
+            if page
+                append_to_page(page["id"], parrent_page_id)
+            else
+                create_page(name, space, parrent_page_id)
+            end
+            clear_log
+        end
+
+        # Creates new page with title set, 
+        # if parrent_page_id is provided it adjusts ancestor accordingly and 
+        # the same space short key  
+        def create_page(title, space, parrent_page_id=nil)
+            params = { 'type' => 'page',
+                'title' => title,
+                'space' => {'key' => space},
+                'body' => {
+                    'storage' => {
+                        'value' => ("#{ @body_message.to_json.gsub("&&", "&amp;&amp;").gsub(/\\u001b.../, "   ") }").force_encoding('UTF-8'),
+                        'representation' => 'storage'
+                        }
+                    }
+                }
+            if parrent_page_id
+                params['ancestors'] = [{'type' => 'page', 'id' => parrent_page_id}]
+            end
+
+            uri = URI.parse(@base_url)
+            https = Net::HTTP.new(uri.host,uri.port)
+            https.use_ssl = true
+            # https.set_debug_output $stderr
+            req = Net::HTTP::Post.new(uri.path, initheader = {'Content-Type' =>'application/json'})
+            req.basic_auth(@user, @password)
+            req['Accept'] = 'application/json'
+            req.body = "#{params.to_json}"
+            response = https.request(req)
+            response = JSON.parse(response.body)
+            if response["statusCode"] == 400
+                puts response.inspect
+                puts req.body.inspect
+                puts "Create page: Error reporting to confluence: #{response["message"]}"
+                raise "Create page: Error reporting to confluence: #{response["message"]}"
+            else
+                puts "Reported page creation."
+            end
+        end
+
+        def append_to_page(page_id, parrent_page_id)
+            page = find_page_by_id(page_id)
+            page["version"]["number"] = page["version"]["number"].to_i + 1
+            page["body"]["storage"]["value"] = (page["body"]["storage"]["value"] + "#{ @body_message.to_json.gsub(/\\u001b.../, "   ") }").force_encoding('UTF-8')
+            page['ancestors'] = [{'type' => 'page', 'id' => parrent_page_id}]
+            uri = URI.parse(@base_url + "#{page_id}")
+            https = Net::HTTP.new(uri.host,uri.port)
+            https.use_ssl = true
+            # https.set_debug_output $stderr
+            req = Net::HTTP::Put.new(uri.path, initheader = {'Content-Type' =>'application/json'})
+            req.basic_auth(@user, @password)
+            req['Accept'] = 'application/json'
+            req.body = "#{page.to_json}"
+            response = https.request(req)
+            response = JSON.parse(response.body)
+            if response["statusCode"] == 400
+                puts response.inspect
+                puts req.body.inspect
+                puts "Append to page: Error reporting to confluence: #{response["message"]}"
+                raise "Append to page: Error reporting to confluence: #{response["message"]}"
+            else
+                puts "Reported page update."
+            end
+        end
+
+        def clear_log
+            @body_message = ""
+        end
+    end
+end

data/lib/confluence_reporter/version.rb

@@ -0,0 +1,3 @@
+module ConfluenceReporter
+  VERSION = "0.0.8"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: confluence_reporter
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+platform: ruby
+authors:
+- Martin Brehovsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-04 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: Creates and updates pages in confluence
+email:
+- mbrehovsky@adaptavist.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- confluence_reporter.gemspec
+- lib/confluence_reporter.rb
+- lib/confluence_reporter/version.rb
+homepage: https://github.com/Adaptavist/confluence_reporter
+licenses:
+- Apache-2.0
+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.0
+signing_key: 
+specification_version: 4
+summary: Api to publish to confluence
+test_files: []