Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 67 lines (45 sloc) 2.589 kB
b3e6ec6 @kalbasit Display the badge only for the master branch
kalbasit authored
1 # Zuora [![Build Status](https://secure.travis-ci.org/wildfireapp/zuora.png?branch=master)](http://travis-ci.org/wildfireapp/zuora) [![Gemnasium](https://gemnasium.com/wildfireapp/zuora.png)](https://gemnasium.com/wildfireapp/zuora)
35a6399 @skiz Initial Import
skiz authored
2
3 This library allows you to interact with [Zuora](http://www.zuora.com) billing platform directly using
4 familiar [ActiveModel](https://github.com/rails/rails/tree/master/activemodel) based objects.
5
6 ## Requirements
7 * [bundler](https://github.com/carlhuda/bundler)
8 * [active_support](https://github.com/rails/rails/tree/master/activesupport)
9 * [savon](https://github.com/rubiii/savon)
10 * [wasabi](https://github.com/rubiii/wasabi)
11
12 All additional requirements for development should be referenced in the provided zuora.gemspec and Gemfile.
13
14 ## Installation
15
16 git clone git@github.com:wildfireapp/zuora.git
17
18 ## Getting Started
19
20 $ bundle install
21 $ bundle exec irb -rzuora
22
23 Zuora.configure(:username => 'USER', :password => 'PASS')
24
25 account = Zuora::Objects::Account.create(:account_number => '12345')
26 # => <Zuora::Objects::Account :account_number => 12345, :id => 'abc123'>
27 Zuora::Objects::Account.find('abc123')
28 # => <Zuora::Objects::Account :account_number => 12345, :id => 'abc123'>
29 account.destroy
30 # => true
31
32 ## Documentation
33 You can generate up to date documentation with the provided a rake task.
34
35 $ rake doc
36 $ open doc/index.html
37
38 ## Advanced Usage
39 Review the generated documentation for usage patterns and examples of using specific zObjects.
40
41 ## Test Suite
42 This library comes with a full test suite, which can be run using the stanard rake utility.
43
44 $ rake spec
45
46 ## Live Integration Suite
47 There is also a live suite which you can test against your sandbox account.
48 This can by ran by setting up your credentials and running the integration suite.
49
50 **Do not run this suite using your production credentials. Doing so may destroy
51 data although every precaution has been made to avoid any destructive behavior.**
52
53 $ ZUORA_USER=login ZUORA_PASS=password rake spec:integrations
54
55 ## Support & Maintenance
5127c1b @skiz Update README.md to reflect proper version support (v38)
skiz authored
56 This library currently supports Zuora's SOAP API version 38.
35a6399 @skiz Initial Import
skiz authored
57
58 ## Contributors
59 * Josh Martin <josh.martin@wildfireapp.com>
60 * Alex Reyes <alex.reyes@wildfireapp.com>
bc3c9c9 @kalbasit Add Myself to the list of contributors [ci skip]
kalbasit authored
61 * Wael Nasreddine <wael.nasreddine@wildfireapp.com>
35a6399 @skiz Initial Import
skiz authored
62
63 ## Credits
64 * [Wildfire Ineractive](http://www.wildfireapp.com) for facilitating the development and maintenance of the project.
65 * [Zuora](http://www.zuora.com) for providing us with the opportunity to share this library with the community.
66
Something went wrong with that request. Please try again.