confluence-rest-api 1.0.6 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ef648c1789440d8b0568c147ecfa0f73977892eaeed56aae36a22b2d2f97505
-  data.tar.gz: 5732c846ff1dda66a7ca5a63939551088cf9906fc10e78efdbcff2d7748b7f5d
+  metadata.gz: 699b6a15feda72043c33df69f39c7babed5e966922febcd374c15099af6f47bd
+  data.tar.gz: 729fa6fca4165a5a55c436be0374b4157a7c711b21ecae3a2a7912ef1d8246e2
 SHA512:
-  metadata.gz: b35aeb68b573092496b57cb5dfb4156dc551ac45bbb156485bd8815a99a3a5f6922ce1cc8243b734d20774293f281fbce650d24dc2402bba4d93fa3b83d64e37
-  data.tar.gz: f9e68dbdfaaa568b97f154cc223e3969c3e98abb63cba274c5078fb7e5975ae4fc397b9256b8d339c05478470fe7f9c950d9186c57089f98df2ccc99a70c68ba
+  metadata.gz: 12288d43598d66f9ec914ceb1e6a8928ab5bbe8e27d886dbdd82c4174105cc84ffcdc15d9f30214e76a9f0ca885c875d7b14b615c76f9059475558b51d9f702c
+  data.tar.gz: 496cf4efd0fd2e66515a32981f2da6bdc3a76cf612f65e3e8ee840ccb7822d8eefbe93b3e6d8c35c81def512502bf0295bede78c2c5ff6ba37a1b0c082c986df

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'
@@ -14,12 +16,14 @@ user_name   = 'username'
 password    = 'password'
 space_key   = 'space'
 
+##################################################################
+# A connection to the client must be done before any page requests
+##################################################################
 client  = ConfluenceClient.new(rest_server, user_name, password)
 
 #################################
 # Query an existing page by title
 #################################
-
 page = PageObject.new('page_title', space_key)
 if page.id.nil? 
     puts '*** WARNING: Unable to open page: page_title'
@@ -38,7 +42,6 @@ end
 ###############################
 # Query an existing page by id
 ###############################
-
 page = PageObject.new(123456789, space_key)
 if page.title.nil? 
     puts '*** WARNING: Unable to open page with id: 123456789'
@@ -57,7 +60,6 @@ end
 ###########################################################
 # Create a new page with a page titled "Home" as its parent
 ###########################################################
-
 home_page = PageObject.new('Home', space_key)
 unless home_page.id.nil?
   client.create_page_with_parent('My Page Title', space_key, 'My Page Body Content', home_page.id)
@@ -66,7 +68,6 @@ end
 #############################
 # Add an attachment to a page
 #############################
-
 page_obj = PageObject.new('My Page Title', space_key)
 unless page_obj.id.nil?
   img_base_name = 'my/image/location'
@@ -74,14 +75,13 @@ 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
 
 ##################################
 # Remove an attachment from a page
 ##################################
-
 page_obj = PageObject.new('My Page Title', space_key)
 id = page_obj.attachment_id('my_image.png')
 if id.nil?
@@ -112,10 +112,30 @@ 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
 ###############
-
 page_obj = PageObject.new('My Page Title', space_key)
 if page_obj.delete_page(page_obj.id).nil?
   puts "*** WARNING: Page with ID #{page_obj.id} was not deleted."

data/confluence-rest-api.gemspec

@@ -1,14 +1,16 @@
 Gem::Specification.new do |s|
   s.name    = %q{confluence-rest-api}
-  s.version = "1.0.6"
-  s.date    = %q{2020-04-17}
+  s.version = "1.1.1"
+  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'
-
+  s.add_runtime_dependency 'json', '~> 2.3', '>= 2.3.1'
+  s.add_runtime_dependency 'addressable', '~> 2.3', '>= 2.3.7'
+  s.add_runtime_dependency 'nokogiri', '~> 1.6', '>= 1.6.8'
 end

data/lib/page.rb

@@ -1,4 +1,5 @@
 require 'nokogiri'
+require 'addressable/uri'
 
 class PageObject < ConfluenceClient
 
@@ -69,6 +70,83 @@ class PageObject < ConfluenceClient
     true
   end
 
+  def labels
+    begin
+      res = RestClient.get "#{@@conf_url}/#{@@urn}/#{@id}/label", {params: {
+          :os_username => @@login, :os_password => @@pwd,
+          :start => 0, :limit => 500
+      }}
+    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
+        uri = "#{@@conf_url}/#{@@urn}/#{@id}/label?name=#{l}&os_username=#{@@login}&os_password=#{@@pwd}"
+        uri = Addressable::URI.parse(uri).normalize.to_s
+        res = RestClient.delete uri
+
+      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 StorageFormat
+class PagePayload
   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.6
+  version: 1.1.1
 platform: ruby
 authors:
 - Gregory J. Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-17 00:00:00.000000000 Z
+date: 2020-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -30,6 +30,66 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.7
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.8
 description: 
 email: 
 executables: []
@@ -42,7 +102,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: {}
@@ -61,8 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: Ruby REST API Client to create, update, and view pages