Project

bintje

0.0
No commit activity in last 3 years
No release in over 3 years
OpenObject xmlrpc interface
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.3
>= 0
~> 2.14

Runtime

 Project Readme

Build Status Code Climate Coverage Status Security Status

Bintje

Provides few methods to access OpenObject's framework models and methods through xmlrpc.

Installation

Add this line to your application's Gemfile:

gem 'bintje'

And then execute:

$ bundle

Or install it yourself as:

$ gem install bintje

Usage

Include the OpenObject module into a class :

class ReceiverModel
    include OpenObject
end

If the OpenObject model name is not you class name underscored, then set the OpenObject model name

class ReceiverModel
    include OpenObject
    set_open_object_model "another_name"
end

Then you can request OpenObject models with standard CRUD methods ... See spec/reciever_model_spec.rb for more details on how it works

Generate documentation

  1. install yard gem
  2. yard doc
  3. yard graph --dependencies --empty-mixins --full | dot -T svg -o diagram.svg
  4. firefox doc/index.html
  5. firefox doc/diagram.svg

Contributing

  1. Fork it
  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 new Pull Request