url_store 0.3.1 → 0.3.2

data/Readme.md

@@ -13,21 +13,38 @@ Great for:
  - 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:
+
+    <%= link_to 'paid', :controller =>:payments, :action=>:paid, :data=>UrlStore.encode(:id=>1, :status=>'paid') %>
+
+In controllers:
 
-    # Controller:
     if data = UrlStore.decode(params[:data])
       Payment.find(data[:id]).update_attribute(:status, data[:status])
     else
@@ -35,18 +52,24 @@ Usage
     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...

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/lib/url_store/generators/initializer.rb

@@ -0,0 +1,12 @@
+require 'rails/generators'
+
+class UrlStore::InitializerGenerator < Rails::Generators::Base
+
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  def create_initializer_file
+    template 'initializer.erb', 'config/initializers/url_store.rb'
+  end
+end

data/lib/url_store/generators/templates/initializer.erb

@@ -0,0 +1 @@
+UrlStore.defaults = {:secret => '<%= ActiveSupport::SecureRandom.hex(16) %>'}

data/lib/url_store/railtie.rb

@@ -0,0 +1,6 @@
+class UrlStore::Railtie < ::Rails::Railtie
+  
+  generators do
+    require 'url_store/generators/initializer'
+  end
+end

data/lib/url_store.rb

@@ -1,5 +1,7 @@
 require 'url_store/compact_encoder'
 
+require 'url_store/railtie' if defined?(::Rails) && ::Rails::VERSION::MAJOR >= 3
+
 class UrlStore
   VERSION = File.read( File.join(File.dirname(__FILE__),'..','VERSION') ).strip
   SECRET = 'asdkasjlwqjdqaccxnjkasdfh2313'

data/url_store.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{url_store}
-  s.version = "0.3.1"
+  s.version = "0.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Grosser"]
-  s.date = %q{2011-03-28}
+  s.date = %q{2011-05-28}
   s.description = %q{Data securely stored in urls.}
   s.email = %q{grosser.michael@gmail.com}
   s.files = [
@@ -20,6 +20,9 @@ Gem::Specification.new do |s|
     "VERSION",
     "lib/url_store.rb",
     "lib/url_store/compact_encoder.rb",
+    "lib/url_store/generators/initializer.rb",
+    "lib/url_store/generators/templates/initializer.erb",
+    "lib/url_store/railtie.rb",
     "spec/spec_helper.rb",
     "spec/url_store/compact_encoder_spec.rb",
     "spec/url_store_spec.rb",
@@ -27,7 +30,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = %q{http://github.com/grosser/url_store}
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.4.2}
+  s.rubygems_version = %q{1.6.2}
   s.summary = %q{Data securely stored in urls.}
   s.test_files = [
     "spec/spec_helper.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: url_store
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Michael Grosser
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-28 00:00:00 +02:00
+date: 2011-05-28 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -35,6 +35,9 @@ files:
 - VERSION
 - lib/url_store.rb
 - lib/url_store/compact_encoder.rb
+- lib/url_store/generators/initializer.rb
+- lib/url_store/generators/templates/initializer.erb
+- lib/url_store/railtie.rb
 - spec/spec_helper.rb
 - spec/url_store/compact_encoder_spec.rb
 - spec/url_store_spec.rb
@@ -69,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Data securely stored in urls.