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'
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
- Fork it ( https://github.com/[my-github-username]/confluence-api-client/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
TODO
- Cover with tests
- Add rest of the functionality from confluence api
- Change faraday to unirest?