Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 136 lines (88 sloc) 4.375 kb
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
1 = ruby-rapleaf
2
714e616 @samstokes Bump version to 0.1.6, update documentation
authored
3 * http://github.com/samstokes/ruby-rapleaf
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
4
5 == DESCRIPTION:
6
7 Rapleaf's goal is to make the internet safe and transparent, by allowing you
8 to evaluate your web footprint across a variety of user-generated sites.
9 See http://www.rapleaf.com for more information.
10
11 == FEATURES/PROBLEMS:
12
13 This library was inspired by the sample code provided by Rapleaf at:
14
15 http://trac.rapleaf.com/ruby-api-kit/wiki
16
714e616 @samstokes Bump version to 0.1.6, update documentation
authored
17 The code was extensively re-written by Glenn Rempe so it would work with the
18 then-current Rapleaf v2 API, and further modified by Sam Stokes to support the
19 v3 API.
20
21 === Original (v2 API compatible)
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
22
23 http://github.com/grempe/ruby-rapleaf
24
25 Glenn Rempe
26 glenn@rempe.us
27
714e616 @samstokes Bump version to 0.1.6, update documentation
authored
28 === Updated (v3 API compatible)
29
30 http://github.com/samstokes/ruby-rapleaf
31
32 Sam Stokes
33 sam@rapportive.com
34
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
35 == SYNOPSIS:
36
37 In order to use this API, you will need to get an API Key from Rapleaf. These
38 can be obtained free at http://www.rapleaf.com/.
39
40 To run the samples you will need to put your API Key in the
41 examples/person.rb file or the examples will fail.
42
43 To run any of the examples, simply run it like:
44
45 cd examples
46 ruby person.rb
47
714e616 @samstokes Bump version to 0.1.6, update documentation
authored
48 (There are some known problems running the examples at the moment... sorry!)
49
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
50 == REQUIREMENTS:
51
52 The following gems are required for installation of the ruby-rapleaf gem.
53
54 * xml-simple
55 * builder
56
57 == INSTALL:
58
714e616 @samstokes Bump version to 0.1.6, update documentation
authored
59 Sorry, there's no hosted gem at the moment!
257f90b @grempe Correct gem name and add git clone instructions.
grempe authored
60
714e616 @samstokes Bump version to 0.1.6, update documentation
authored
61 You can build the gem yourself and install as a Ruby Gem with:
257f90b @grempe Correct gem name and add git clone instructions.
grempe authored
62
714e616 @samstokes Bump version to 0.1.6, update documentation
authored
63 git clone git://github.com/samstokes/ruby-rapleaf.git
257f90b @grempe Correct gem name and add git clone instructions.
grempe authored
64 cd ruby-rapleaf
65 rake gem
66 rake install_gem
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
67
68 == LICENSE:
69
0c9420d @grempe Added first basic working copy of the Rapleaf lib
grempe authored
70 This software is distributed under the Ruby License. A copy of which is
71 provided below.
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
72
0c9420d @grempe Added first basic working copy of the Rapleaf lib
grempe authored
73 RUBY LICENSE
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
74
714e616 @samstokes Bump version to 0.1.6, update documentation
authored
75 Copyright (c) 2008-2010 Glenn Rempe, 2010 Sam Stokes
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
76
0c9420d @grempe Added first basic working copy of the Rapleaf lib
grempe authored
77 http://www.ruby-lang.org/en/LICENSE.txt
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
78
0c9420d @grempe Added first basic working copy of the Rapleaf lib
grempe authored
79 Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.co.jp>.
80 You can redistribute it and/or modify it under either the terms of the GPL
81 (see COPYING.txt file), or the conditions below:
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
82
0c9420d @grempe Added first basic working copy of the Rapleaf lib
grempe authored
83 1. You may make and give away verbatim copies of the source form of the
84 software without restriction, provided that you duplicate all of the
85 original copyright notices and associated disclaimers.
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
86
0c9420d @grempe Added first basic working copy of the Rapleaf lib
grempe authored
87 2. You may modify your copy of the software in any way, provided that
88 you do at least ONE of the following:
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
89
0c9420d @grempe Added first basic working copy of the Rapleaf lib
grempe authored
90 a) place your modifications in the Public Domain or otherwise
91 make them Freely Available, such as by posting said
92 modifications to Usenet or an equivalent medium, or by allowing
93 the author to include your modifications in the software.
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
94
0c9420d @grempe Added first basic working copy of the Rapleaf lib
grempe authored
95 b) use the modified software only within your corporation or
96 organization.
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
97
0c9420d @grempe Added first basic working copy of the Rapleaf lib
grempe authored
98 c) rename any non-standard executables so the names do not conflict
99 with standard executables, which must also be provided.
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
100
0c9420d @grempe Added first basic working copy of the Rapleaf lib
grempe authored
101 d) make other distribution arrangements with the author.
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
102
0c9420d @grempe Added first basic working copy of the Rapleaf lib
grempe authored
103 3. You may distribute the software in object code or executable
104 form, provided that you do at least ONE of the following:
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
105
0c9420d @grempe Added first basic working copy of the Rapleaf lib
grempe authored
106 a) distribute the executables and library files of the software,
107 together with instructions (in the manual page or equivalent)
108 on where to get the original distribution.
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
109
0c9420d @grempe Added first basic working copy of the Rapleaf lib
grempe authored
110 b) accompany the distribution with the machine-readable source of
111 the software.
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
112
0c9420d @grempe Added first basic working copy of the Rapleaf lib
grempe authored
113 c) give non-standard executables non-standard names, with
114 instructions on where to get the original software distribution.
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
115
0c9420d @grempe Added first basic working copy of the Rapleaf lib
grempe authored
116 d) make other distribution arrangements with the author.
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
117
0c9420d @grempe Added first basic working copy of the Rapleaf lib
grempe authored
118 4. You may modify and include the part of the software into any other
119 software (possibly commercial). But some files in the distribution
120 are not written by the author, so that they are not under this terms.
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
121
0c9420d @grempe Added first basic working copy of the Rapleaf lib
grempe authored
122 They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
123 files under the ./missing directory. See each file for the copying
124 condition.
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
125
126 5. The scripts and library files supplied as input to or produced as
0c9420d @grempe Added first basic working copy of the Rapleaf lib
grempe authored
127 output from the software do not automatically fall under the
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
128 copyright of the software, but belong to whomever generated them,
0c9420d @grempe Added first basic working copy of the Rapleaf lib
grempe authored
129 and may be sold commercially, and may be aggregated with this
130 software.
afdd91c @grempe Converted to using Hoe for gem management.
grempe authored
131
0c9420d @grempe Added first basic working copy of the Rapleaf lib
grempe authored
132 6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
133 IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
134 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
135 PURPOSE.
Something went wrong with that request. Please try again.