Browse files

Bump version to 0.1.6, update documentation

  • Loading branch information...
1 parent 539bc1a commit 714e61685ccdc0793f796e1d7f21c6804485659c @samstokes committed Mar 4, 2010
Showing with 33 additions and 24 deletions.
  1. +8 −3 History.txt
  2. +19 −15 README.txt
  3. +1 −1 lib/ruby-rapleaf.rb
  4. +5 −5 ruby-rapleaf.gemspec
View
11 History.txt
@@ -1,6 +1,11 @@
-=== 1.0.0 / 2008-08-27
+=== 0.1.6 / 2010-03-04
-* 1 major enhancement
+* Modified by Sam Stokes
- * Birthday!
+ * Support for Rapleaf Person API v3 (which is now the default)
+ * Work around Rapleaf bug: they think email addresses containing '+' are malformed, so for those we send them hashes instead.
+
+=== 0.1.5 / 2008-08-28
+
+* Original version by Glenn Rempe, with support for Rapleaf Person API v2
View
34 README.txt
@@ -1,6 +1,6 @@
= ruby-rapleaf
-* http://github.com/grempe/ruby-rapleaf
+* http://github.com/samstokes/ruby-rapleaf
== DESCRIPTION:
@@ -14,16 +14,24 @@ This library was inspired by the sample code provided by Rapleaf at:
http://trac.rapleaf.com/ruby-api-kit/wiki
-The code was extensively re-written so it would work with the current
-Rapleaf v2 API and is provided for your use. Sorry that no support
-for this library is currently available. However, Git pull requests/patches
-are accepted.
+The code was extensively re-written by Glenn Rempe so it would work with the
+then-current Rapleaf v2 API, and further modified by Sam Stokes to support the
+v3 API.
+
+=== Original (v2 API compatible)
http://github.com/grempe/ruby-rapleaf
Glenn Rempe
glenn@rempe.us
+=== Updated (v3 API compatible)
+
+http://github.com/samstokes/ruby-rapleaf
+
+Sam Stokes
+sam@rapportive.com
+
== SYNOPSIS:
In order to use this API, you will need to get an API Key from Rapleaf. These
@@ -37,6 +45,8 @@ To run any of the examples, simply run it like:
cd examples
ruby person.rb
+(There are some known problems running the examples at the moment... sorry!)
+
== REQUIREMENTS:
The following gems are required for installation of the ruby-rapleaf gem.
@@ -46,17 +56,11 @@ The following gems are required for installation of the ruby-rapleaf gem.
== INSTALL:
-Install as a Ruby Gem with:
-
- Update to RubyGems 1.2.0 before proceeding!!
-
- gem sources -a http://gems.github.com (you only have to do this once)
-
- sudo gem install grempe-ruby-rapleaf
+Sorry, there's no hosted gem at the moment!
- # OR
+You can build the gem yourself and install as a Ruby Gem with:
- git clone git://github.com/grempe/ruby-rapleaf.git
+ git clone git://github.com/samstokes/ruby-rapleaf.git
cd ruby-rapleaf
rake gem
rake install_gem
@@ -68,7 +72,7 @@ provided below.
RUBY LICENSE
-Copyright (c) 2008 Glenn Rempe
+Copyright (c) 2008-2010 Glenn Rempe, 2010 Sam Stokes
http://www.ruby-lang.org/en/LICENSE.txt
View
2 lib/ruby-rapleaf.rb
@@ -12,7 +12,7 @@
module Rapleaf
- VERSION = '0.1.5'
+ VERSION = '0.1.6'
# API Constants
API_HOST = 'api.rapleaf.com'
View
10 ruby-rapleaf.gemspec
@@ -1,16 +1,16 @@
Gem::Specification.new do |s|
s.name = %q{ruby-rapleaf}
- s.version = "0.1.5"
+ s.version = "0.1.6"
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
- s.authors = ["Glenn Rempe"]
- s.date = %q{2008-08-27}
+ s.authors = ["Glenn Rempe", "Sam Stokes"]
+ s.date = %q{2010-03-04}
s.description = %q{Rapleaf's goal is to make the internet safe and transparent, by allowing you to evaluate your web footprint across a variety of user-generated sites. See http://www.rapleaf.com for more information.}
- s.email = ["glenn@rempe.us"]
+ s.email = ["glenn@rempe.us", "sam@rapportive.com"]
s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
s.files = ["History.txt", "Manifest.txt", "README.txt", "Rakefile", "examples/person.rb", "lib/ruby-rapleaf.rb", "lib/rapleaf/exceptions.rb", "lib/rapleaf/rapleaf.rb", "lib/rapleaf/responses.rb", "ruby-rapleaf.gemspec"]
s.has_rdoc = true
- s.homepage = %q{http://github.com/grempe/ruby-rapleaf}
+ s.homepage = %q{http://github.com/samstokes/ruby-rapleaf}
s.rdoc_options = ["--main", "README.txt"]
s.require_paths = ["lib"]
s.rubyforge_project = %q{ruby-rapleaf}

0 comments on commit 714e616

Please sign in to comment.