confluence-soap 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28dd7f0a8be54581855b39ba6d406cfc7e9c749b
-  data.tar.gz: 10dff918c2f03e4ccec12613e458d04975521fca
+  metadata.gz: faa98e76adbdb9a7a9ae872be7ba356b280989f4
+  data.tar.gz: 67c6bacca0f5dcf9bf85ecdb19a20182d9240764
 SHA512:
-  metadata.gz: 0fa5a0e5d0258fbf67c57a7e1a9621777e9693a9c1713a60d358ce09d9762a4a3a58e4110b67e9ace4660ee5fedf843873002ca5ef457f5727705a83364f6c5c
-  data.tar.gz: 00d47c5aace57ec6452045344cc60b368fb82e550a603062b5787071582438532e4075fbecb4a76ec14e1dc529a629c8b52d1755be56db12dc31ddf37463a7d2
+  metadata.gz: a67efcc7f12ea2ad22230c7244dba08a83d193044e91043b5f48ab339145f75f817b896d036c37d8e8a384e8030a0da2e4461b5cc64da34ccce689b63dd6a08f
+  data.tar.gz: 57d04949ed82713889656e05aa6b4952fc5f429f70cac6959a90bda7deb6cd8ddf209f004a00072df4add1596eb0e7063b3557a49bfb2c1e3d7592895178253f

data/Gemfile

@@ -1,5 +1,6 @@
 source "https://rubygems.org"
 gem 'savon'
+gem 'activesupport'
 
 group :development do
   gem "bundler", "~> 1.0"

data/Gemfile.lock

@@ -1,6 +1,9 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (3.2.16)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
     addressable (2.3.5)
     akami (1.2.0)
       gyoku (>= 0.4.0)
@@ -27,6 +30,7 @@ GEM
     httpi (2.1.0)
       rack
       rubyntlm (~> 0.3.2)
+    i18n (0.6.9)
     jeweler (2.0.0)
       builder
       bundler (>= 1.0)
@@ -88,6 +92,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport
   bundler (~> 1.0)
   jeweler (~> 2.0.0)
   rdoc (~> 3.12)

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Ping Yu
+Copyright (c) 2014 Intridea
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/{README.rdoc → README.md}

@@ -1,9 +1,11 @@
-= confluence-soap
+confluence-soap
+===============
 
-Description goes here.
+Ruby client for Confluence's SOAP API
+http://<confluence-install>/rpc/soap-axis/confluenceservice-v2?wsdl
+
+## Contributing to confluence-soap
 
-== Contributing to confluence-soap
- 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
 * Fork the project.
@@ -12,8 +14,8 @@ Description goes here.
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+### Copyright
 
-Copyright (c) 2014 Ping Yu. See LICENSE.txt for
+Copyright (c) 2014 Intridea. See LICENSE.txt for
 further details.
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/confluence-soap.rb

@@ -1,9 +1,23 @@
 require 'savon'
+require 'active_support/core_ext/string'
 
 class ConfluenceSoap
   attr_reader :client, :token
 
-  Page = Struct.new(:content, :contentStatus, :title, :space, :parentId, :permissions)
+  Page = Struct.new(:content, :content_status, :created, :creator, :current, :home_page, :id,
+                    :modified, :modifier, :parent_id, :permissions, :space, :title, :url, :version) do
+    def self.from_hash h
+      self.new *h.values_at(*Page.members.map {|m|m.to_sym})
+    end
+
+    SKIPPED_KEYS = [:content_status, :created, :creator, :current, :home_page, :modified, :modifier, :url]
+    def to_soap
+      to_h.inject({}) do |hash, (k,v)|
+        hash[k.to_s.camelize(:lower).to_sym] = v unless (v.nil? || SKIPPED_KEYS.include?(k))
+        hash
+      end
+    end
+  end
 
   def initialize url, user, password
     @client = Savon.client(wsdl: url)
@@ -15,24 +29,40 @@ class ConfluenceSoap
     @token = response.body[:login_response][:login_return]
   end
 
+  def logout
+    @client.call :logout, message: {in0: @token} if @token
+  end
+
   def get_pages space
     response = @client.call :get_pages, message: {in0: @token, in1: space}
-    parse_array_response :get_pages, response
+    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}
-    parse_response :get_page, response
+    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}
-    parse_array_response :get_children, response
+    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_h}
-    parse_response :store_page, response
+    response = @client.call :store_page, message: {in0: @token, 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}}
+    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}
+    Page.from_hash parse_response :remove_page, response
   end
 
   def search(term, criteria = {})
@@ -41,7 +71,8 @@ class ConfluenceSoap
     response =
       @client.call(:search, message: {
                      in0: @token, in1: term, in2: {item: criteria}, in3: limit})
-    parse_array_response :search, response
+    pages = parse_array_response :search, response
+    pages.map { |page| Page.from_hash(page) }
   end
 
   private

data/spec/confluence-soap_spec.rb

@@ -64,6 +64,19 @@ describe ConfluenceSoap do
     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
+
+    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')
@@ -79,14 +92,15 @@ describe ConfluenceSoap do
 
   describe '#store_page' do
     let(:page) do
-      ConfluenceSoap::Page.new('test', 'current', 'Testing API ', 'Space Name',
-                               'parent_id', 0)
+      ConfluenceSoap::Page.from_hash({content: 'test', title: 'Testing API ', space: 'Space Name',
+                                     parent_id: 'parent_id', permissions: 0})
     end
 
     before (:each)  do
       ConfluenceSoap.any_instance.stub(:login).and_return('token')
       subject.client.should_receive(:call)
-        .with(:store_page, message: {in0: 'token', in1: page.to_h})
+        .with(:store_page, message: {in0: 'token', in1: {content: 'test', title: 'Testing API ',
+                                      space: 'Space Name', parentId: 'parent_id', permissions: 0}})
         .and_return(double(:response, body: {store_page_response: {store_page_return: {}}}))
     end
 
@@ -95,6 +109,26 @@ describe ConfluenceSoap do
     end
   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
+      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', parentId: '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
+
   describe '#search' do
     let(:term) { 'search term' }
     let(:criteria) { {item: [{key: :spaceKey, value: 'SpaceName'}]} }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: confluence-soap
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ping Yu
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-22 00:00:00.000000000 Z
+date: 2014-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -25,6 +25,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -75,7 +89,7 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - .document
 - .rspec
@@ -83,11 +97,10 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - confluence-soap.gemspec
-- lib/.DS_Store
 - lib/confluence-soap.rb
 - spec/confluence-soap_spec.rb
 - spec/spec_helper.rb