Confluence rest api client
Switch branches/tags
Nothing to show
Clone or download
amishyn Merge pull request #3 from v0v04ka/master
Added get_by_id since there is no way to get current version of page…
Latest commit 9f6d9b7 Dec 18, 2017

README.md

Confluence::Api::Client

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/confluence/api/client. To experiment with that code, run bin/console for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

Installation

Add this line to your application's Gemfile:

gem 'confluence-api-client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install confluence-api-client

Usage

require 'rubygems'
require 'confluence/api/client'

username = 'username'
password = 'password'
space    = 'Home'
url      = 'https://company.atlassian.net/wiki'

# Note: url is automatically appended with /rest/api/content so if your
#       Confluence base URL is different from "/wiki" specify it above

client = Confluence::Api::Client.new(username, password, url)
page = client.get({spaceKey: space, title: 'September'})[0]
client.create({type:"page",title: "title", space: {key: space}, ancestors:[{type:"page",id: page['id']}]})

API Links

https://developer.atlassian.com/confdev/confluence-rest-api https://developer.atlassian.com/confdev/confluence-rest-api/confluence-rest-api-examples

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/[my-github-username]/confluence-api-client/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

TODO

  1. Cover with tests