dead_drop 0.4.0.0 → 0.4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fe2ec6af9c3b6f5834ea8c80551d02fa6e6fa0d
-  data.tar.gz: b217a9ec5663be952b14df2c1aff055574a2264d
+  metadata.gz: f61d0d3417d6a25aa211c401001a57644add9278
+  data.tar.gz: 53c387d6e9d87a8fe63c9c6d20fae643b6c89147
 SHA512:
-  metadata.gz: c03e940f6e11a6765ad8b38848a14307a9a0111a5a121010b0ecdb4a33a39ba8a00be0c63d29db7dcfdda45a67d7a7a30ada4a6d25e582c23c15b7216d5c76ab
-  data.tar.gz: 355950eed287eef995cd7d716de1158b9b31bdba14fd3f6400338ddfedea67c3caa58d7315150dbb6bfb922755bce68dd1ac7ca1392a641217651afa53ae1d2d
+  metadata.gz: efae49dd9f1f12f21563f3b60432bf884a6ee1fe5e6d841b315fe269f472f6aab4ca8570a1a9759216502b123ccaa5d6a403fca5b1bf78a8063fcab9f968ee01
+  data.tar.gz: dae89bf7cb59479969b43c030540d632a232195e4ee9e7c23d0daf1c5be01328a6b814db86f60b3fb19929b8d688ea208ea463b752a44ec2be2a5c88a5403e1f

data/README.md

@@ -0,0 +1,110 @@
+DeadDrop [![Gem Version](https://badge.fury.io/rb/dead_drop.svg)](http://badge.fury.io/rb/dead_drop)
+========
+
+DeadDrop is a Rails::Engine that allows you to drop content in an anonymous locker only accessible with a randomly generated token.
+
+You can configure when the content should expire and limit the number of total accesses to the content.
+
+DeadDrop can use any Cache::Store that supports the decrement method. This gem has been tested with :file_store, :memory_store, :mem_cache_store and :dalli_store.
+
+
+Supported Ruby implementations
+------------------------------
+
+DeadDrop should work on:
+
+ * JRuby
+ * Ruby
+ * Rubinius
+
+If you have problems, please enter an issue.
+
+Installation and Configuration
+------------------------------
+
+Add `gem 'dead_drop'` to your Gemfile.
+
+If you want to use the Controller option described below add this to your `routes.rb`:
+```ruby
+mount DeadDrop::Engine, at: "/dead_drop"  # Or any mount point you like
+```
+
+You can configure this gem in `initializers/dead_drop.rb`. Here is an example with the default values:
+```ruby
+DeadDrop.setup do |config|
+  config.cache_store = :file_store, 'tmp/cache', { # Just configure any Cache::Store as you'd normally do.
+    namespace: 'ddrop',
+    compress: true,
+    compress_threshold: 2*1024  # 2K
+  }
+  config.default_access_limit = nil     # How many accesses do you want to allow by default? (nil: no limit)
+  config.default_expiration = 24.hours  # When should content expire by default? (nil: no limit)
+  config.token_length = 32
+  config.default_salt = ''              # Optionally salt tokens before computing the SHA256 when creating the cache key.
+  config.cache_key_creation = :base64digest   # When generating the key from the salt+token (SHA256), use this representation.
+                                              # When using :file_store on Windows it is recommended to use :hexdigest
+                                              # representation in order to avoid collisions due to the case insensitive FS.
+end
+```
+
+If you want to use the same Cache::Store instance than the rest of your Rails app, just:
+```ruby
+DeadDrop.setup do |config|
+  config.cache_store = Rails.cache
+end
+```
+
+
+Usage
+-----
+
+**Dropping**
+```ruby
+csv_content = "col1, col2\n 1.012, John\n 4.332, Mary"
+token = DeadDrop.drop(csv_content, filename: "data.csv", expiration: 5.minutes, limit: 1)
+```
+*csv_content* has been saved in Cache::Store and a url friendly token has been returned.
+This token can be used later to access programatically the resource or a url can be generated:
+```ruby
+url = dead_drop.pick_url(token) # The resource will be rendered when accessed unless it was dropped with
+                                # the 'filename' option (useful for storing static html pages, for instance)
+url = dead_drop.download_url(token, 'file.dat') # The resource will always be downloaded
+```
+This url is only useful if you have activated the custom controller in your `routes.rb` (described in installation section)
+
+
+**Accessing Using Controller**
+
+Just access to the url generated by above helpers which will show the content in the browser or download a file depending on the options you chose.
+
+The url should look similar to `http://domain.com/dead_drop/3vTCwxjRC1oASZgY4MHwbWmQdL9l8Bwb`
+
+
+**Accessing Programmatically**
+```ruby
+content = DeadDrop.pick(token)
+```
+If the token is still valid this hash will be returned: `{:resource=>content, :filename=>name, :mime_type=>mime}`. Else `nil` is returned.
+
+If you just want to check the validity of the token without actually loading the resource:
+```ruby
+DeadDrop.exists?(token)
+```
+
+
+Helping Out
+-----------
+
+If you have a fix you wish to provide, please send a pull request on github.
+
+
+Author
+------
+
+Miguel Canton Cortes, [GitHub](http://github.com/miwelc)
+
+
+Copyright
+---------
+
+MIT Licensed

data/lib/dead_drop.rb

@@ -7,6 +7,7 @@ module DeadDrop
     mattr_accessor :default_access_limit
     mattr_accessor :default_expiration
     mattr_accessor :default_salt
+    mattr_accessor :token_length
     mattr_accessor :cache_key_creation
     mattr_accessor :cache
 
@@ -18,6 +19,7 @@ module DeadDrop
     self.default_salt = ''
     self.default_access_limit = nil
     self.default_expiration = 24.hours
+    self.token_length = 32
     self.cache_key_creation = :base64digest
   end
 
@@ -40,7 +42,7 @@ module DeadDrop
 
     token = ""
     loop do
-      token = SecureRandom.urlsafe_base64(24)
+      token = SecureRandom.urlsafe_base64((DeadDrop.token_length*3)/4)
       break unless DeadDrop.exists?(token, salt: options[:salt])
     end
 

data/lib/dead_drop/version.rb

@@ -1,3 +1,3 @@
 module DeadDrop
-  VERSION = "0.4.0.0"
+  VERSION = "0.4.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dead_drop
 version: !ruby/object:Gem::Version
-  version: 0.4.0.0
+  version: 0.4.1.0
 platform: ruby
 authors:
 - Miguel Canton Cortes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-03-28 00:00:00.000000000 Z
+date: 2015-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -60,6 +60,7 @@ files:
 - lib/tasks/dead_drop_tasks.rake
 - MIT-LICENSE
 - Rakefile
+- README.md
 - test/dead_drop_test.rb
 - test/test_helper.rb
 - test/dummy/config.ru