Readme.md in url_store-0.3.1 vs Readme.md in url_store-0.3.2
- old
+ new
@@ -11,42 +11,65 @@
- email unsubscribe links
- click tracking
- access control
- ...
-
Install
=======
- - As gem: ` sudo gem install url_store `
- - As Rails plugin: ` rails plugin install git://github.com/grosser/url_store.git `
+When using Rails 3, include it in your Gemfile:
+
+ gem 'url_store'
+
+When using Rails 2 or no rails at all:
+
+ sudo gem install url_store
+
+Or as Rails plugin:
+
+ rails plugin install git://github.com/grosser/url_store.git
+
Usage
=====
- # config (e.g environment.rb)
+
+When on Rails, create config/initializers/url_store.rb using generator. A random secret will be generated for you:
+
+ rails generate url_store:initializer
+
+Or configure it by hand (e.g in environment.rb):
+
UrlStore.defaults = {:secret => 'adadasd2adsdasd4ads4eas4dea4dsea4sd'}
- # View:
- <%= link_to 'paid', :controller=>:payments, :action=>:paid, :data=>UrlStore.encode(:id=>1, :status=>'paid') %>
+In Rails views:
- # Controller:
+ <%= link_to 'paid', :controller =>:payments, :action=>:paid, :data=>UrlStore.encode(:id=>1, :status=>'paid') %>
+
+In controllers:
+
if data = UrlStore.decode(params[:data])
Payment.find(data[:id]).update_attribute(:status, data[:status])
else
raise 'FRAUD!'
end
### Defaults
+
UrlStore.defaults = {:secret => 'something random'} # ALWAYS use your own secret
UrlStore.defaults = {... , :hasher => 'MD5'} # default: 'SHA1'
UrlStore.defaults = {... , :serializer => :yaml} # default: :marshal
### Tips
+
- If you need multiple UrlStores, just use ` UrlStore.new(:secret => 'sadasd', ...) `
- As long as you stay under 2k chars there should be no problems. [max url lengths per browser/server](http://www.boutell.com/newfaq/misc/urllength.html)
- Data is not (yet) encrypted, users could read(but not change) the encoded data
- Replay attacks are possible <-> add a timestamp to check the freshness of the encoded data
-Author
+Authors
=======
+
+### [Contributors](http://github.com/grosser/url_store/contributors)
+ - [Priit Haamer](http://prii.it)
+
[Michael Grosser](http://grosser.it)<br/>
michael@grosser.it<br/>
-Hereby placed under public domain, do what you want, just do not hold me accountable...
+Hereby placed under public domain, do what you want, just do not hold anyone accountable...