Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 66 lines (44 sloc) 2.469 kb
8be48ddd » Ben Curren
2009-01-12 Added initial project files.
1 = rshoeboxed
2
82c9b410 » Ben Curren
2009-01-21 Created a gemspec. Updated the README.
3 * http://github.com/bcurren/rshoeboxed
8be48ddd » Ben Curren
2009-01-12 Added initial project files.
4
5 == DESCRIPTION:
6
82c9b410 » Ben Curren
2009-01-21 Created a gemspec. Updated the README.
7 Ruby wrapper for the Shoeboxed API.
8be48ddd » Ben Curren
2009-01-12 Added initial project files.
8
82c9b410 » Ben Curren
2009-01-21 Created a gemspec. Updated the README.
9 == SYNOPSIS:
8be48ddd » Ben Curren
2009-01-12 Added initial project files.
10
82c9b410 » Ben Curren
2009-01-21 Created a gemspec. Updated the README.
11 === Generate authentication url
8be48ddd » Ben Curren
2009-01-12 Added initial project files.
12
82c9b410 » Ben Curren
2009-01-21 Created a gemspec. Updated the README.
13 Use the following code to generate a url to send a user to to authenticate. The first parameter is the
14 AppName provided by shoeboxed. Shoeboxed will redirect back to the return url once a user successfully
15 authenticates. When the user is redirected back to the return_url, a token will be provided in the url
16 for you to store for future API calls.
17
51748233 » Ben Curren
2009-01-21 Added code tag to other code blocks.
18 RShoeboxed::Connection.authentication_url("Outright", "http://example.com")
82c9b410 » Ben Curren
2009-01-21 Created a gemspec. Updated the README.
19
20 === Get a list of all receipts
21
22 The api_token is provided by shoeboxed when you setup your API account. The user_token is retrieved by
23 sending a user to authentication_url so they can log in to shoeboxed. On success, they will be redirected
24 to the return_url with the user_token.
25
51748233 » Ben Curren
2009-01-21 Added code tag to other code blocks.
26 connection = RShoeboxed::Connection.new("api_token", "user_token")
27 receipts = connection.get_receipt_call(Date.new(2008, 1, 1), Date.new(2008, 12, 29))
82c9b410 » Ben Curren
2009-01-21 Created a gemspec. Updated the README.
28
29 === Get a particular receipt
8be48ddd » Ben Curren
2009-01-12 Added initial project files.
30
51748233 » Ben Curren
2009-01-21 Added code tag to other code blocks.
31 connection = RShoeboxed::Connection.new("api_token", "user_token")
32 receipt = connection.get_category_info_call("2342442424")
8be48ddd » Ben Curren
2009-01-12 Added initial project files.
33
82c9b410 » Ben Curren
2009-01-21 Created a gemspec. Updated the README.
34 === Get a list of all categories
8be48ddd » Ben Curren
2009-01-12 Added initial project files.
35
51748233 » Ben Curren
2009-01-21 Added code tag to other code blocks.
36 connection = RShoeboxed::Connection.new("api_token", "user_token")
37 categories = connection.get_category_call
8be48ddd » Ben Curren
2009-01-12 Added initial project files.
38
39 == INSTALL:
40
82c9b410 » Ben Curren
2009-01-21 Created a gemspec. Updated the README.
41 * sudo gem install bcurren_rshoeboxed
8be48ddd » Ben Curren
2009-01-12 Added initial project files.
42
43 == LICENSE:
44
45 (The MIT License)
46
47 Copyright (c) 2009 Ben Curren
48
49 Permission is hereby granted, free of charge, to any person obtaining
50 a copy of this software and associated documentation files (the
51 'Software'), to deal in the Software without restriction, including
52 without limitation the rights to use, copy, modify, merge, publish,
53 distribute, sublicense, and/or sell copies of the Software, and to
54 permit persons to whom the Software is furnished to do so, subject to
55 the following conditions:
56
57 The above copyright notice and this permission notice shall be
58 included in all copies or substantial portions of the Software.
59
60 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
61 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
62 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
63 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
64 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
65 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
82c9b410 » Ben Curren
2009-01-21 Created a gemspec. Updated the README.
66 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Something went wrong with that request. Please try again.