confluence-soap 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28dd7f0a8be54581855b39ba6d406cfc7e9c749b
+  data.tar.gz: 10dff918c2f03e4ccec12613e458d04975521fca
+SHA512:
+  metadata.gz: 0fa5a0e5d0258fbf67c57a7e1a9621777e9693a9c1713a60d358ce09d9762a4a3a58e4110b67e9ace4660ee5fedf843873002ca5ef457f5727705a83364f6c5c
+  data.tar.gz: 00d47c5aace57ec6452045344cc60b368fb82e550a603062b5787071582438532e4075fbecb4a76ec14e1dc529a629c8b52d1755be56db12dc31ddf37463a7d2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p353

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+gem 'savon'
+
+group :development do
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.0"
+  gem "rdoc", "~> 3.12"
+end
+
+group :test do
+  gem "rspec", "~> 2.8.0"
+  gem "simplecov"
+end

data/Gemfile.lock

@@ -0,0 +1,96 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    akami (1.2.0)
+      gyoku (>= 0.4.0)
+      nokogiri (>= 1.4.0)
+    builder (3.2.2)
+    descendants_tracker (0.0.3)
+    diff-lcs (1.1.3)
+    docile (1.1.1)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.6)
+    github_api (0.11.1)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    gyoku (1.1.1)
+      builder (>= 2.1.2)
+    hashie (2.0.5)
+    highline (1.6.20)
+    httpi (2.1.0)
+      rack
+      rubyntlm (~> 0.3.2)
+    jeweler (2.0.0)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.11)
+      multi_json (>= 1.5)
+    mime-types (1.25.1)
+    mini_portile (0.5.2)
+    multi_json (1.8.4)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    nori (2.3.0)
+    oauth2 (0.9.3)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 0.1.8)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.1)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    rubyntlm (0.3.4)
+    savon (2.3.3)
+      akami (~> 1.2.0)
+      builder (>= 2.1.2)
+      gyoku (~> 1.1.0)
+      httpi (~> 2.1.0)
+      nokogiri (>= 1.4.0)
+      nori (~> 2.3.0)
+      wasabi (~> 3.2.2)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    wasabi (3.2.3)
+      httpi (~> 2.0)
+      mime-types (< 2.0.0)
+      nokogiri (>= 1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 2.0.0)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  savon
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Ping Yu
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= confluence-soap
+
+Description goes here.
+
+== 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.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* 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 (c) 2014 Ping Yu. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "confluence-soap"
+  gem.homepage = "http://github.com/intridea/confluence-soap"
+  gem.license = "MIT"
+  gem.summary = %Q{ruby client for confluence soap API}
+  gem.description = %Q{}
+  gem.email = "ping@intridea.com", "eric@intridea.com"
+  gem.authors = ["Ping Yu", "Eric Himmelreich"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "confluence-soap #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/confluence-soap.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "confluence-soap"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ping Yu", "Eric Himmelreich"]
+  s.date = "2014-01-22"
+  s.description = ""
+  s.email = ["ping@intridea.com", "eric@intridea.com"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".ruby-version",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "confluence-soap.gemspec",
+    "lib/.DS_Store",
+    "lib/confluence-soap.rb",
+    "spec/confluence-soap_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/intridea/confluence-soap"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.14"
+  s.summary = "ruby client for confluence soap API"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<savon>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+    else
+      s.add_dependency(%q<savon>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    end
+  else
+    s.add_dependency(%q<savon>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+  end
+end
+

data/lib/confluence-soap.rb

@@ -0,0 +1,56 @@
+require 'savon'
+
+class ConfluenceSoap
+  attr_reader :client, :token
+
+  Page = Struct.new(:content, :contentStatus, :title, :space, :parentId, :permissions)
+
+  def initialize url, user, password
+    @client = Savon.client(wsdl: url)
+    @token = login(user, password)
+  end
+
+  def login user, password
+    response = @client.call :login, message: {in0: user, in1: password}
+    @token = response.body[:login_response][:login_return]
+  end
+
+  def get_pages space
+    response = @client.call :get_pages, message: {in0: @token, in1: space}
+    parse_array_response :get_pages, response
+  end
+
+  def get_page page_id
+    response = @client.call :get_page, message: {in0: @token, in1: page_id}
+    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
+  end
+
+  def store_page page
+    response = @client.call :store_page, message: {in0: @token, in1: page.to_h}
+    parse_response :store_page, response
+  end
+
+  def search(term, criteria = {})
+    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})
+    parse_array_response :search, response
+  end
+
+  private
+
+  def parse_array_response method, response
+    parse_response(method, response)["#{method}_return".to_sym]
+  end
+
+  def parse_response method, response
+    response.body["#{method}_response".to_sym]["#{method}_return".to_sym]
+  end
+end

data/spec/confluence-soap_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+describe ConfluenceSoap do
+  let (:url) {'http://example.com?wsdl'}
+  subject {ConfluenceSoap.new(url, 'user', 'password')}
+
+  describe 'Page' do
+    ConfluenceSoap::Page.new.to_h
+  end
+
+  describe '#initialize' do
+    it 'should create a savon soap client with url provided' do
+      Savon.should_receive(:client).with(wsdl: url)
+      ConfluenceSoap.any_instance.should_receive(:login)
+
+      subject
+    end
+  end
+
+  describe '#login' do
+    before (:each) do
+      Savon::Client.any_instance.should_receive(:call).twice
+        .with(:login, message: {in0: 'user', in1: 'password'})
+        .and_return(double(:response, body: {login_response: {login_return: 'token'}}))
+    end
+
+    it 'should login with savon client' do
+
+      subject.login('user', 'password')
+    end
+
+    it 'should store the login token' do
+      subject.login('user', 'password')
+
+      subject.token.should == 'token'
+    end
+  end
+
+  describe '#get_pages' do
+    let(:space) { 'SpaceName' }
+    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_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
+
+    it 'should return the page' do
+      subject.get_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: []}}}))
+    end
+
+    it 'should return array of child pages' do
+      subject.get_children('page_id').should == []
+    end
+  end
+
+  describe '#store_page' do
+    let(:page) do
+      ConfluenceSoap::Page.new('test', 'current', 'Testing API ', 'Space Name',
+                               'parent_id', 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})
+        .and_return(double(:response, body: {store_page_response: {store_page_return: {}}}))
+    end
+
+    it 'should store page with savon' do
+      subject.store_page(page)
+    end
+  end
+
+  describe '#search' do
+    let(:term) { 'search term' }
+    let(:criteria) { {item: [{key: :spaceKey, 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: []}}}))
+    end
+
+    it 'should search with savon' do
+      subject.search(term, spaceKey: 'SpaceName').should == []
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'confluence-soap'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: confluence-soap
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ping Yu
+- Eric Himmelreich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  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
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+description: ''
+email:
+- ping@intridea.com
+- eric@intridea.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- .ruby-version
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- confluence-soap.gemspec
+- lib/.DS_Store
+- lib/confluence-soap.rb
+- spec/confluence-soap_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/intridea/confluence-soap
+licenses:
+- MIT
+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.1.11
+signing_key: 
+specification_version: 4
+summary: ruby client for confluence soap API
+test_files: []