confluence-soap 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69c70a9833f7aa57fa636ef35557cac026f35b98
-  data.tar.gz: f4ff292c2bb73668555fe00569d0d4fd6cc0d782
+  metadata.gz: 05235a53aeb95b8019306a7550602d9177d84407
+  data.tar.gz: 9db7f2a153e4b1ab49a38fedcf580d271efa453c
 SHA512:
-  metadata.gz: fc77609b9558fa7239f55c01941b89c41f243ae0e8b8085a1d797e506912a52381fdb3ce02fec9064bffb5f203c06ba50d9f840400a0089069c396923681fad8
-  data.tar.gz: 1c24c6eb42d207f04133ab6565038c61a0512ae73b78a92111dc0e10aae99e0a440e537c72353726246cd58cbd24b4b811c3dc5531caf5d9fbb0a7a79395a366
+  metadata.gz: 2d6e0c7787d416a1fdbbfafd015936221b37f49a503dc68e2fad905bfa6e3914875bb9b2b1f0a900e2b97b3e4e8db3c9cf32399c8e833da24179e23acb5e5cce
+  data.tar.gz: a679505d6e4380d034075115ee506073df8a1e116c60573dfb2d02d04cc18f873a5367677df90f01800e2330cf145d166dd6867c16d556bffcea6bd69964f5df

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/confluence-soap.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "confluence-soap"
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ping Yu", "Eric Himmelreich"]

data/lib/confluence-soap.rb

@@ -34,34 +34,36 @@ class ConfluenceSoap
   end
 
   def get_pages space
-    response = @client.call :get_pages, message: {in0: @token, in1: space}
+    response = @client.call :get_pages, auth_message({in1: space})
     pages = parse_array_response :get_pages, response
     pages.map { |page| Page.from_hash(page) }
   end
 
   def get_page page_id
-    response = @client.call :get_page, message: {in0: @token, in1: page_id}
+    response = @client.call :get_page, auth_message({in1: page_id})
     Page.from_hash parse_response :get_page, response
   end
 
   def get_children page_id
-    response = @client.call :get_children, message: {in0: @token, in1: page_id}
+    response = @client.call :get_children, auth_message({in1: page_id})
     pages = parse_array_response :get_children, response
     pages.map { |page| Page.from_hash(page) }
   end
 
   def store_page page
-    response = @client.call :store_page, message: {in0: @token, in1: page.to_soap}
+    response = @client.call :store_page, auth_message({in1: page.to_soap})
     Page.from_hash parse_response :store_page, response
   end
 
   def update_page page
-    response = @client.call :update_page, message: {in0: @token, in1: page.to_soap, in2: {minorEdit: true}}
+    response =
+      @client.call(:update_page,
+                   auth_message({in1: page.to_soap, in2: {minorEdit: true} }))
     Page.from_hash parse_response :update_page, response
   end
 
   def remove_page page_id
-    response = @client.call :remove_page, message: {in0: @token, in1: page_id}
+    response = @client.call :remove_page, auth_message({in1: page_id})
     Page.from_hash parse_response :remove_page, response
   end
 
@@ -69,15 +71,29 @@ class ConfluenceSoap
     limit    = criteria.delete(:limit) || 20
     criteria = criteria.map { |k, v| {key: k, value: v} }
     response =
-      @client.call(:search, message: {
-                     in0: @token, in1: term, in2: {item: criteria}, in3: limit})
+      @client.call(:search,
+                   auth_message({in1: term, in2: {item: criteria}, in3: limit}))
     pages = parse_array_response :search, response
     pages.map { |page| Page.from_hash(page) }
   end
 
-  def has_user user
+  def add_label_by_name(label, page_id)
+    response =
+      @client.call(:add_label_by_name, auth_message({in1: label, in2: page_id}))
+
+    parse_response(:add_label_by_name, response)
+  end
+
+  def remove_label_by_name(label, page_id)
     response =
-      @client.call(:has_user, message: { in0: @token, in1: user })
+      @client.call(:remove_label_by_name,
+                   auth_message({in1: label, in2: page_id}))
+
+    parse_response(:remove_label_by_name, response)
+  end
+
+  def has_user user
+    response = @client.call(:has_user, auth_message({in1: user}))
     parse_response(:has_user, response)
   end
 
@@ -98,6 +114,10 @@ class ConfluenceSoap
     parse_response(method, response)["#{method}_return".to_sym] || []
   end
 
+  def auth_message(params = {})
+    {message: {in0: @token}.merge(params)}
+  end
+
   def parse_response method, response
     response.body["#{method}_response".to_sym]["#{method}_return".to_sym]
   end

data/spec/confluence-soap_spec.rb

@@ -36,126 +36,149 @@ describe ConfluenceSoap do
     end
   end
 
-  describe '#get_pages' do
-    let(:space) { 'SpaceName' }
-    before (:each) do
+  describe 'with an authenticated user' do
+    before(:each) do
       ConfluenceSoap.any_instance.stub(:login).and_return('token')
-      subject.client.should_receive(:call)
-        .with(:get_pages, message: {in0: 'token', in1: space})
-        .and_return(double(:response, body: {get_pages_response: {get_pages_return: {get_pages_return: []}}}))
     end
 
-    it 'should return the pages in the space' do
-      subject.get_pages(space).should == []
-    end
-  end
+    describe '#get_pages' do
+      let(:space) { 'SpaceName' }
+      before (:each) do
 
-  describe '#get_page' do
-    let(:page_id) { '123456' }
-    before (:each) do
-      ConfluenceSoap.any_instance.stub(:login).and_return('token')
-      subject.client.should_receive(:call)
-        .with(:get_page, message: {in0: 'token', in1: page_id})
-        .and_return(double(:response, body: {get_page_response: {get_page_return: {}}}))
-    end
+        subject.client.should_receive(:call)
+          .with(:get_pages, message: {in0: 'token', in1: space})
+          .and_return(double(:response, body: {get_pages_response: {get_pages_return: {get_pages_return: []}}}))
+      end
 
-    it 'should return the page' do
-      subject.get_page page_id
+      it 'should return the pages in the space' do
+        subject.get_pages(space).should == []
+      end
     end
-  end
 
-  describe '#get_page' do
-    let(:page_id) { '123456' }
-    before (:each) do
-      ConfluenceSoap.any_instance.stub(:login).and_return('token')
-      subject.client.should_receive(:call)
-        .with(:remove_page, message: {in0: 'token', in1: page_id})
-        .and_return(double(:response, body: {remove_page_response: {remove_page_return: {}}}))
-    end
+    describe '#get_page' do
+      let(:page_id) { '123456' }
+      before (:each) do
+        subject.client.should_receive(:call)
+          .with(:get_page, message: {in0: 'token', in1: page_id})
+          .and_return(double(:response, body: {get_page_response: {get_page_return: {}}}))
+      end
 
-    it 'should return the page' do
-      subject.remove_page page_id
-    end
-  end
-  describe '#get_children' do
-    before (:each) do
-      ConfluenceSoap.any_instance.stub(:login).and_return('token')
-      subject.client.should_receive(:call)
-        .with(:get_children, message: {in0: 'token', in1: 'page_id'})
-        .and_return(double(:response, body: {get_children_response: {get_children_return: {get_children_return: []}}}))
+      it 'should return the page' do
+        subject.get_page page_id
+      end
     end
 
-    it 'should return array of child pages' do
-      subject.get_children('page_id').should == []
-    end
-  end
+    describe '#get_page' do
+      let(:page_id) { '123456' }
+      before (:each) do
+        subject.client.should_receive(:call)
+          .with(:remove_page, message: {in0: 'token', in1: page_id})
+          .and_return(double(:response, body: {remove_page_response: {remove_page_return: {}}}))
+      end
 
-  describe '#store_page' do
-    let(:page) do
-      ConfluenceSoap::Page.from_hash({content: 'test', title: 'Testing API ', space: 'Space Name',
-                                     parent_id: 'parent_id', permissions: 0})
+      it 'should return the page' do
+        subject.remove_page page_id
+      end
     end
+    describe '#get_children' do
+      before (:each) do
+        subject.client.should_receive(:call)
+          .with(:get_children, message: {in0: 'token', in1: 'page_id'})
+          .and_return(double(:response, body: {get_children_response: {get_children_return: {get_children_return: []}}}))
+      end
 
-    before (:each)  do
-      ConfluenceSoap.any_instance.stub(:login).and_return('token')
-      subject.client.should_receive(:call)
-        .with(:store_page, message: {in0: 'token', in1: {content: 'test', title: 'Testing API ',
-                                      space: 'Space Name', parent_id: 'parent_id', permissions: 0}})
-        .and_return(double(:response, body: {store_page_response: {store_page_return: {}}}))
+      it 'should return array of child pages' do
+        subject.get_children('page_id').should == []
+      end
     end
 
-    it 'should store page with savon' do
-      subject.store_page(page)
-    end
-  end
+    describe '#store_page' do
+      let(:page) do
+        ConfluenceSoap::Page.from_hash({content: 'test', title: 'Testing API ', space: 'Space Name',
+                                         parent_id: 'parent_id', permissions: 0})
+      end
 
-  describe '#update_page' do
-    let(:page) do
-      ConfluenceSoap::Page.from_hash({content: 'test', title: 'Testing API ', space: 'Space Name',
-                                     parent_id: 'parent_id', permissions: 0})
-    end
+      before (:each)  do
+        subject.client.should_receive(:call)
+          .with(:store_page, message: {in0: 'token', in1: {content: 'test', title: 'Testing API ',
+                    space: 'Space Name', parent_id: 'parent_id', permissions: 0}})
+          .and_return(double(:response, body: {store_page_response: {store_page_return: {}}}))
+      end
 
-    before (:each)  do
-      ConfluenceSoap.any_instance.stub(:login).and_return('token')
-      subject.client.should_receive(:call)
-        .with(:update_page, message: {in0: 'token', in1: {content: 'test', title: 'Testing API ',
-                                      space: 'Space Name', parent_id: 'parent_id', permissions: 0},
-                                      in2: {minorEdit: true}})
-        .and_return(double(:response, body: {update_page_response: {update_page_return: {}}}))
+      it 'should store page with savon' do
+        subject.store_page(page)
+      end
     end
 
-    it 'should store page with savon' do
-      subject.update_page(page)
+    describe '#update_page' do
+      let(:page) do
+        ConfluenceSoap::Page.from_hash({content: 'test', title: 'Testing API ', space: 'Space Name',
+                                         parent_id: 'parent_id', permissions: 0})
+      end
+
+      before (:each)  do
+        subject.client.should_receive(:call)
+          .with(:update_page, message: {in0: 'token', in1: {content: 'test', title: 'Testing API ',
+                    space: 'Space Name', parent_id: 'parent_id', permissions: 0},
+                  in2: {minorEdit: true}})
+          .and_return(double(:response, body: {update_page_response: {update_page_return: {}}}))
+      end
+
+      it 'should store page with savon' do
+        subject.update_page(page)
+      end
     end
-  end
 
-  describe '#search' do
-    let(:term) { 'search term' }
-    let(:criteria) { {item: [{key: :space_key, value: 'SpaceName'}]} }
-    before (:each)  do
-      ConfluenceSoap.any_instance.stub(:login).and_return('token')
-      subject.client.should_receive(:call)
-        .with(:search,
-              message: {in0: 'token', in1: term, in2: criteria, in3: 20})
-        .and_return(double(:response, body: {search_response: {search_return: {search_return: []}}}))
+    describe '#search' do
+      let(:term) { 'search term' }
+      let(:criteria) { {item: [{key: :space_key, value: 'SpaceName'}]} }
+      before (:each)  do
+        subject.client.should_receive(:call)
+          .with(:search,
+                message: {in0: 'token', in1: term, in2: criteria, in3: 20})
+          .and_return(double(:response, body: {search_response: {search_return: {search_return: []}}}))
+      end
+
+      it 'should search with savon' do
+        subject.search(term, space_key: 'SpaceName').should == []
+      end
     end
 
-    it 'should search with savon' do
-      subject.search(term, space_key: 'SpaceName').should == []
+    describe '#add_label_by_name' do
+      before(:each) do
+        subject.client.should_receive(:call)
+          .with(:add_label_by_name, message: {in0: 'token', in1: 'faq', in2: 1})
+          .and_return(double(:response, body: {add_label_by_name_response: {add_label_by_name_return: true}}))
+      end
+
+      it 'should add a label to the page' do
+        subject.add_label_by_name('faq', 1).should == true
+      end
     end
-  end
 
-  describe '#execute' do
-    before (:each)  do
-      ConfluenceSoap.any_instance.stub(:login).and_return('token')
-      subject.should_receive(:login)
+    describe '#remove_label_by_name' do
+      before(:each) do
+        subject.client.should_receive(:call)
+          .with(:remove_label_by_name, message: {in0: 'token', in1: 'faq', in2: 1})
+          .and_return(double(:response, body: {remove_label_by_name_response: {remove_label_by_name_return: true}}))
+      end
+
+      it 'should remove a label from the page' do
+        subject.remove_label_by_name('faq', 1).should == true
+      end
     end
 
-    it 'should reconnect when session is invalid' do
-      Savon::SOAPFault.any_instance.stub(:to_hash).and_return({fault: {faultstring: 'InvalidSessionException'}})
-      ex = Savon::SOAPFault.new nil, nil
-      subject.execute do |x|
-        raise ex if x.is_a? ConfluenceSoap
+    describe '#execute' do
+      before (:each)  do
+        subject.should_receive(:login)
+      end
+
+      it 'should reconnect when session is invalid' do
+        Savon::SOAPFault.any_instance.stub(:to_hash).and_return({fault: {faultstring: 'InvalidSessionException'}})
+        ex = Savon::SOAPFault.new nil, nil
+        subject.execute do |x|
+          raise ex if x.is_a? ConfluenceSoap
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: confluence-soap
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Ping Yu