confluence-rest-api 1.0.8 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6470ce4a3916a34479ddbd6d9b8e880ebd81c880f9fb469418b8c231da8016be
-  data.tar.gz: a2d2d4d82cd187ff1ae6e748b2031fdab215555c9593adecc2ef75fdbab437ee
+  metadata.gz: ed5f052109908ba6e1cc2ed313802359131330793cef7a9bc444c4d1f72bfe22
+  data.tar.gz: 7d7d21092d94dde2f347f018173b8cd611b74c9f6fc20b8bbc79ba146aa2b72a
 SHA512:
-  metadata.gz: a5d3f5be7749537bd8c750535257ca1082722eb0ebead4336da7188845f34a1e961a80d9d0794f3faae306b128639055620937800c5a751cd25c8ff40574d8b3
-  data.tar.gz: a38c201489ec9839a16b3571db9b0636702dbe2abd9b258dfff9450e0df08fdaada08dcd0f86dc4902edae5d2d62f9f118eddcff9fb0b0c21d35f743c33359db
+  metadata.gz: 24fb564f85688ed4435cc0f654f36b69a351467fe851114802435e1b733d089f958e1bcca66c5341f7efed2eb59ac4e6b7f84e911d1418750d2935d99c6f625b
+  data.tar.gz: 0351b16fb8e6e743ed6c5eadce6c92869406ed74c00ec6437478183ed829d2ebe1b740c8906f948f9cfd51f586c2f8b56f1615a19b086368b037cd432d266cb3

data/README.md

@@ -1,10 +1,12 @@
 # Ruby Confluence REST API Client
 
 [![Gem Version](https://badge.fury.io/rb/confluence-rest-api.svg)](https://badge.fury.io/rb/confluence-rest-api)
+
 ### Installation
 ```cassandraql
 gem install confluence-rest-api
 ```
+
 ### Usage
 ```ruby
 require 'confluence-rest-api'
@@ -63,30 +65,6 @@ unless home_page.id.nil?
   client.create_page_with_parent('My Page Title', space_key, 'My Page Body Content', home_page.id)
 end
 
-###########################################################
-# Update a page with a new title and keep the same parent
-###########################################################
-page_obj = PageObject.new('My Page Title', space_key)
-title = 'My New Page Title'
-# Storage Format for the page can also be modified here if needed. 
-content = page_obj.storage_format
-unless page_obj.id.nil?
-  client.update_page_with_no_parent(page_obj, title, space_key, content)
-end
-
-################################################
-# Update a page with a new title and new parent
-################################################
-page_obj = PageObject.new('My Page Title', space_key)
-parent_obj = PageObject.new('My New Parent', space_key)
-title = 'My New Page Title'
-# Storage Format for the page can also be modified here if needed. 
-content = page_obj.storage_format
-unless page_obj.id.nil? || parent_obj.id.nil?
-  client.update_page_with_parent(page_obj, title, parent_obj, space_key, content)
-end
-
-
 #############################
 # Add an attachment to a page
 #############################
@@ -97,7 +75,7 @@ unless page_obj.id.nil?
   if page_obj.attach_binary_file(image, img_base_name).nil?
     puts "*** WARNING: Image attachment #{image} for #{title} was not successful."
   else
-    puts "Image attachment #{image} for #{title} was successful."
+    puts "Image attachment #{image} for #{page_obj.title} was successful."
   end
 end
 
@@ -134,6 +112,27 @@ end
 page_obj = PageObject.new('My Page Title', space_key)
 page_obj.save_file_attachments(page_obj.id, './')
 
+################################################
+# Get all labels associated with a given page ID
+################################################
+page_obj = PageObject.new('My Page Title', space_key)
+page_labels = page_obj.labels(page_obj.id)
+puts "Page Labels for #{page_obj.title}: #{page_labels}"
+
+#########################
+# Adding labels to a page
+#########################
+page_obj = PageObject.new('My Page Title', space_key)
+new_labels = ['my_label1','my_label2']
+page_obj.add_labels(new_labels)
+
+#############################
+# Deleting labels from a page
+#############################
+page_obj = PageObject.new('My Page Title', space_key)
+del_labels = ['my_label1','my_label2']
+page_obj.delete_labels(del_labels)
+
 ###############
 # Delete a page
 ###############

data/confluence-rest-api.gemspec

@@ -1,14 +1,14 @@
 Gem::Specification.new do |s|
   s.name    = %q{confluence-rest-api}
-  s.version = "1.0.8"
-  s.date    = %q{2020-05-22}
+  s.version = "1.0.10"
+  s.date    = %q{2020-08-25}
   s.summary = %q{Ruby REST API Client to create, update, and view pages}
   s.authors = "Gregory J. Miller"
   s.files   = [
       "lib/confluence-rest-api.rb", "lib/confluence.rb", "lib/page.rb", "lib/storage_format.rb", "README.md", "confluence-rest-api.gemspec"
   ]
   s.license       = "MIT"
-  s.homepage      = "https://github.com/grmi64/confluence-rest-api"
+  s.homepage      = "https://github.com/GM314/confluence-rest-api"
   s.add_runtime_dependency 'rest-client', '~> 2.0', '>= 2.0.0'
 
 end

data/lib/confluence.rb

@@ -22,14 +22,14 @@ class ConfluenceClient
 
   end
 
-  def update_page_with_parent(page_obj, title, parent_page_obj, spacekey, content)
+  def update_page_with_parent(page_obj, parent_page_obj, spacekey, content)
 
     version = page_obj.version + 1
 
     page_meta = { type:     'update_page_with_parent',
                   pageid:   page_obj.id,
                   parentid: parent_page_obj.id,
-                  title:    title,
+                  title:    page_obj.title,
                   spacekey: spacekey,
                   content:  content,
                   version:  version }
@@ -49,13 +49,13 @@ class ConfluenceClient
 
   end
 
-  def update_page_with_no_parent(page_obj, title, spacekey, content)
+  def update_page_with_no_parent(page_obj, spacekey, content)
 
     version = page_obj.version + 1
 
     page_meta = { type:     'update_page_with_no_parent',
                   pageid:   page_obj.id,
-                  title:    title,
+                  title:    page_obj.title,
                   spacekey: spacekey,
                   content:  content,
                   version:  version }

data/lib/page.rb

@@ -69,6 +69,80 @@ class PageObject < ConfluenceClient
     true
   end
 
+  def labels(page_id)
+    begin
+      res = RestClient.get "#{@@conf_url}/#{@@urn}/#{page_id}/label", {params: {
+          :os_username => @@login, :os_password => @@pwd,
+          :start => 0, :limit => 1000
+      }}
+    rescue RestClient::ExceptionWithResponse => e
+      puts Nokogiri.XML(e.response)
+      nil
+    end
+    size = JSON.parse(res)['size']
+    if size > 0
+      size -= 1
+      labels = Array.new
+      (0..size).each do |idx|
+        labels << JSON.parse(res)['results'][idx]["name"]
+      end
+      labels
+    else
+      nil
+    end
+  end
+
+  def add_labels(labels)
+    payload = String.new('[')
+    json_label = '{
+        "prefix": "global",
+        "name": "__LABEL__"
+      }'.freeze
+
+    labels.each_with_index do |l, idx|
+      jl = json_label.sub(/__LABEL__/, l)
+      if idx == 0
+        payload += jl
+      else
+        payload += ',' + jl
+      end
+    end
+    payload = payload + ']'
+    puts "Add label payload: #{payload}"
+
+    begin
+      res = RestClient.post "#{@@conf_url}/#{@@urn}/#{@id}/label?os_username=#{@@login}&os_password=#{@@pwd}", payload, :content_type => 'application/json'
+    rescue RestClient::ExceptionWithResponse => e
+      puts Nokogiri.XML(e.response)
+    end
+    if res.nil?
+      puts "*** WARNING: Label update failed for page with ID: #{@id}"
+      nil
+    else
+      puts JSON.parse(res)
+      true
+    end
+  end
+
+  # Note that we must use query parameters here because deleting labels with a "/" will fail otherwise.
+  def delete_labels(labels)
+    labels.each do |l|
+      puts "Deleting label: #{l}"
+      begin
+        res = RestClient.delete "#{@@conf_url}/#{@@urn}/#{@id}/label?name=#{l}&os_username=#{@@login}&os_password=#{@@pwd}"
+      rescue RestClient::ExceptionWithResponse => e
+        puts Nokogiri.XML(e.response)
+      end
+      if res.nil?
+        puts "*** WARNING: Label removal failed for page with ID: #{@id}"
+        return nil
+      end
+    end
+
+    true
+
+  end
+
   # Return an array of all page attachment information
   def get_all_attachments(page_id)
 

data/lib/storage_format.rb

@@ -1,4 +1,4 @@
-class PagePayload
+class StorageFormat
   attr_accessor :page_format
 
   VALID_OPTIONS = [:type, :title, :spacekey, :content, :pageid, :parentid, :version]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: confluence-rest-api
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.10
 platform: ruby
 authors:
 - Gregory J. Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-22 00:00:00.000000000 Z
+date: 2020-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -42,7 +42,7 @@ files:
 - lib/confluence.rb
 - lib/page.rb
 - lib/storage_format.rb
-homepage: https://github.com/grmi64/confluence-rest-api
+homepage: https://github.com/GM314/confluence-rest-api
 licenses:
 - MIT
 metadata: {}