filepicker-rails 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bdbbd40e9ca36cb245058decb551050c07409f09
-  data.tar.gz: 18ed7a4fef1e29641a14c3fe44f5b3d53da5da13
+  metadata.gz: a7c6108a87b1e18899294344d21da54df7705e14
+  data.tar.gz: fbab8e63de76ba8773a0aa1283591223386e8827
 SHA512:
-  metadata.gz: d78b7710a6a81288be4d5e29cfe06c469ecd64cafffabf983fea1f25b4f10ce22b750a7b632b67b0cdafcc1d78fc6df74360031cf9b25629e6ab63ba1bf5c35c
-  data.tar.gz: b3e3f5984ab5b101a1e4f5560066a3e9775b926b46353f97accf3b06e77e0b917bf47b37c7926e44cd1b0ce5da10a70e765c65ec9b38b2051b555db4a7204ced
+  metadata.gz: f445d0c3ebc0b0766d1bd034d27aa4fc5c53c5cd405c6bbf2b753263e33288834e1b6d61eeeb73c4410260bddb4f1c0a8fe45f329f91314fd1a1316480b0e3d0
+  data.tar.gz: f1e3d5ff4a55be3249441f7cace323ff85f4658d64220a836ec5641c090842347be91ab0706a1be4724bcde5221788630d5b14b70c4a6045d2c212d8fcb68c77

data/README.md

@@ -28,24 +28,12 @@ Add the filepicker.io javascript library to your layout:
 <%= filepicker_js_include_tag %>
 ```
 
-Set your API Key in config/application.rb:
+Set your API Key in `config/application.rb`:
 
 ```ruby
 config.filepicker_rails.api_key = "Your filepicker.io API Key"
 ```
 
-Set your Secret Key in config/application.rb for signed request support:
-
-```ruby
-config.filepicker_rails.secret_key = "Your filepicker.io Secret Key"
-```
-
-Set your CDN Path in config/production.rb ([CDN usage](https://developers.inkfilepicker.com/docs/cdn/)):
-
-```ruby
-config.filepicker_rails.cdn_host = "Your CDN host name"
-```
-
 ## Usage
 
 ### First create a migration to add the field that will hold your filepicker.io URL
@@ -58,13 +46,9 @@ Then add a column to the model's table of type :string:
 
 ```ruby
 class AddNameOfAttrForFilepickerUrlToUser < ActiveRecord::Migration
-  def up
+  def change
     add_column :user, :filepicker_url, :string
   end
-
-  def down
-    remove_column :user, :filepicker_url
-  end
 end
 ```
 
@@ -80,24 +64,15 @@ end
   <%= f.submit %>
 <% end %>
 ```
+The `filepicker_field` accepts a options parameter, [click here to see all the valid options](http://rubydoc.info/github/Ink/filepicker-rails/master/FilepickerRails/FormHelper:filepicker_field).
 
-Full options list:
-
-* button_text - The text of the upload button.
-* button_class - The class of the upload button.
-* extensions - The extensions of file types you want to support for this upload. Ex: ".png,.jpg".
-* mimetypes - The file types you want to support for this upload. Ex: "image/png,text/*".
-* container - Where to show the file picker dialog can be "modal", "window" or the
-of an iframe on the page.
-* multiple - (true or false) Whether or not multiple uploads can be saved at once.
-* services - What services your users can upload to. Ex: "BOX, COMPUTER, FACEBOOK".
-* store_path - The path to store the file at within the specified file store.
-* store_location - The file is not copied by default. It remains in the original location. If you wish you have the file copied onto your own storage, you can specify where we should put the copy. The only value at the moment is "S3".
-* store_access - Should the underlying file be publicly available on its S3 link. Options are "public" and "private", defaults to 'private'.
-* dragdrop - (true or false) Whether or not to allow drag-and-drop uploads.
-* drag_text - The text of the dragdrop pane.
-* drag_class - The class of the dragdrop pane.
-* onchange - The onchange event.
+### Displaying an image:
+
+```erb
+<%= filepicker_image_tag @user.filepicker_url, w: 160, h: 160, fit: 'clip' %>
+```
+
+The `filepicker_image_tag` accepts a options parameter, [click here to see all the valid options](http://rubydoc.info/github/Ink/filepicker-rails/master/FilepickerRails/ApplicationHelper:filepicker_image_url).
 
 ### Accessing FilePicker File with OnChange:
 
@@ -137,31 +112,60 @@ Example fpfiles object:
 }]
 ```
 
-### Displaying an image:
+### Allowing the user to download a file (or upload it to any of the supported services)
 
 ```erb
-<%= filepicker_image_tag @user.filepicker_url, w: 160, h: 160, fit: 'clip' %>
+<%= filepicker_save_button "Save", @user.filepicker_url, "image/jpg" %>
 ```
 
-See [the filepicker.io documentation](https://developers.filepicker.io/docs/web/#fpurl-images) for the full options list.
+The `filepicker_save_button` accepts a options parameter, [click here to see all the valid options](http://rubydoc.info/github/Ink/filepicker-rails/master/FilepickerRails/ApplicationHelper:filepicker_save_button).
 
-### Allowing the user to download a file (or upload it to any of the supported services)
+### CDN
 
-```erb
-<%= filepicker_save_button "Save", @user.filepicker_url, "image/jpg" %>
+Set your CDN Path in `config/production.rb` ([CDN usage](https://developers.inkfilepicker.com/docs/cdn/)):
+
+```ruby
+config.filepicker_rails.cdn_host = "Your CDN host name"
+```
+
+### Policy
+
+To use the [filepicker policies](https://developers.inkfilepicker.com/docs/security/) follow this instructions.
+
+Set your Secret Key in `config/application.rb`
+
+```ruby
+config.filepicker_rails.secret_key = "Your filepicker.io Secret Key"
 ```
 
-Full options list:
+#### Expiry time
 
-* container - Where to show the file picker dialog can be "modal", "window" or the
-of an iframe on the page.
-* services - What services your users can upload to. Ex: "BOX, COMPUTER, FACEBOOK".
-* save_as_name - A recommended file name. The user can override this.
+By default the expiry time is 10 minutes. If you need to change the expiry time this should be an integer and it is expressed in seconds since the [Epoch](http://en.wikipedia.org/wiki/Unix_time).
 
-### Demo
+So you can do something like that to set the expiry time to 5 minutes.
+
+```ruby
+config.filepicker_rails.expiry = -> { (Time.zone.now + 5.minutes).to_i }
+```
+
+If you need always the same url, a static expiry time, to do some cache. You can set a date starting of the Epoch.
+
+```ruby
+-> { 100.years.since(Time.at(0)).to_i }
+```
+
+The argument need to be a [callable](http://www.rubytapas.com/episodes/35-Callable).
+
+## Demo
 
 See a simple demo app [repo](https://github.com/maxtilford/filepicker-rails-demo)
 
+## RDocs
+
+You can view the Filepicker::Rails documentation in RDoc format here:
+
+http://rubydoc.info/github/Ink/filepicker-rails/master/frames
+
 ## Versioning
 
 Filepicker::Rails follow the [Semantic Versioning](http://semver.org/).

data/Rakefile

@@ -5,8 +5,11 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
+require 'rspec/core/rake_task'
 require 'rdoc/task'
 
+RSpec::Core::RakeTask.new
+
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'FilepickerRails'
@@ -18,9 +21,17 @@ end
 APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
 load 'rails/tasks/engine.rake'
 
-require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new
-task :default => [:spec]
+task :default do
+  if ENV['BUNDLE_GEMFILE'] =~ /gemfiles/
+    Rake::Task['spec'].invoke
+  else
+    Rake::Task['appraise'].invoke
+  end
+end
+
+task :appraise do
+  exec 'appraisal install && appraisal rake'
+end
 
 Bundler::GemHelper.install_tasks
 

data/app/helpers/filepicker_rails/application_helper.rb

@@ -1,10 +1,33 @@
 module FilepickerRails
   module ApplicationHelper
 
+    # Creates a javascript tag to the filepicker JavaScript.
+    #
+    # #### Examples
+    #
+    #     filepicker_js_include_tag
+    #     # => <script src="//api.filepicker.io/v1/filepicker.js"></script>
     def filepicker_js_include_tag
       javascript_include_tag "//api.filepicker.io/v1/filepicker.js"
     end
 
+    # Creates a button allowing the user to download a file
+    # (or upload it to any of the supported services). Set the content of
+    # the button on the `text` parameter. The `url` of the content you want the user to save.
+    # Define the `mimetype` of the content. Accepts a optional `options` parameter.
+    #
+    # #### Options
+    #
+    # - `:container` - Where to show the file picker dialog can be `modal`,
+    # `window` or the id of an iframe on the page.
+    # - `:services` - What services your users can upload to. Ex: `BOX, COMPUTER, FACEBOOK`.
+    # - `:save_as_name` - A recommended file name. The user can override this.
+    #
+    # #### Examples
+    #
+    #     filepicker_save_button "Save", @user.filepicker_url, "image/jpg"
+    #     # => <button data-fp-apikey="..." data-fp-mimetype="image/jpg" data-fp-url="https://www.filepicker.io/api/file/hFHUCB3iTxyMzseuWOgG" name="button" type="submit">save</button>
+    #
     def filepicker_save_button(text, url, mimetype, options = {})
       options[:data] ||= {}
       container = options.delete(:container)
@@ -20,71 +43,130 @@ module FilepickerRails
       button_tag(text, options)
     end
 
-    # Allows options to be passed to filepicker_image_url and then falls back to normal Rails options
-    # for image_tag
-    # If specifying html width, height, pass it down to filepicker for optimization
+    # Creates a image tag of the `url`. Accepts the options to work on filepicker.io,
+    # see the valid options on `filepicker_image_url` documentation. Accepts html options to the image tag,
+    # see the [image_tag](http://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html#method-i-image_tag)
+    # documentation for the valid options.
+    #
+    # #### Examples
+    #
+    #      filepicker_image_tag @user.filepicker_url, w: 160, h: 160, fit: 'clip'
+    #      # => <img src="https://www.filepicker.io/api/file/hFHUCB3iTxyMzseuWOgG/convert?w=160&h=160&fit=clip" />
+    #
     def filepicker_image_tag(url, image_options={}, image_tag_options={})
       image_tag(filepicker_image_url(url, image_options), image_tag_options)
     end
 
-    # w - Resize the image to this width.
+    # Creates the full path of the image to the specified `url` accepts optional `options`
+    # hash for configuration.
+    #
+    # #### Options
+    #
+    # - `:w` - Resize the image to this width.
     #
-    # h - Resize the image to this height.
+    # - `:h` - Resize the image to this height.
     #
-    # fit - Specifies how to resize the image. Possible values are:
-    #       clip: Resizes the image to fit within the specified parameters without
-    #             distorting, cropping, or changing the aspect ratio
-    #       crop: Resizes the image to fit the specified parameters exactly by
+    # - `:fit` - Specifies how to resize the image. Possible values are:
+    #     - `:clip` - Resizes the image to fit within the specified parameters without
+    #             distorting, cropping, or changing the aspect ratio, this is the default.
+    #     - `:crop` - Resizes the image to fit the specified parameters exactly by
     #             removing any parts of the image that don't fit within the boundaries
-    #       scales: Resizes the image to fit the specified parameters exactly by
+    #     - `:scales` - Resizes the image to fit the specified parameters exactly by
     #               scaling the image to the desired size
-    #       Defaults to "clip".
-    # align - Determines how the image is aligned when resizing and using the "fit" parameter.
+    # - `:align` - Determines how the image is aligned when resizing and using the "fit" parameter.
     #         Check API for details.
     #
-    # rotate - Rotate the image. Default is no rotation.
-    #          rotate="exif" will rotate the image automatically based on the exif data in the image.
-    #          Other valid values are integers between 0 and 359, for degrees of rotation.
+    # - `:rotate` - Rotate the image. Default is no rotation. Possible values are:
+    #     - `:exif` - will rotate the image automatically based on the exif data in the image.
+    #     -  Other valid values are integers between 0 and 359, for degrees of rotation.
     #
-    # cache - Specifies if the image should be cached or not.
-    #
-    # crop - Crops the image to a specified rectangle. The input to this parameter
-    #        should be 4 numbers for 'x,y,width,height' - for example,
-    #        'crop=10,20,200,250' would select the 200x250 pixel rectangle starting
+    # - `:crop` - Crops the image to a specified rectangle. The input to this parameter
+    #        should be 4 numbers for `x,y,width,height` - for example,
+    #        `10, 20, 200, 250` would select the 200x250 pixel rectangle starting
     #        from 10 pixels from the left edge and 20 pixels from the top edge of the
     #        image.
     #
-    # format - Specifies what format the image should be converted to, if any.
-    #          Possible values are "jpg" and "png". For "jpg" conversions, you
+    # - `:format` - Specifies what format the image should be converted to, if any.
+    #          Possible values are `jpg` and `png`. For `jpg` conversions, you
     #          can additionally specify a quality parameter.
     #
-    # quality - For jpeg conversion, specifies the quality of the resultant image.
+    # - `:quality` - For jpeg conversion, specifies the quality of the resultant image.
     #           Quality should be an integer between 1 and 100
     #
-    # watermark - Adds the specified absolute url as a watermark on the image.
+    # - `:watermark` - Adds the specified absolute url as a watermark on the image.
     #
-    # watersize - This size of the watermark, as a percentage of the base
+    # - `:watersize` - This size of the watermark, as a percentage of the base
     #             image (not the original watermark).
     #
-    # waterposition - Where to put the watermark relative to the base image.
-    #                 Possible values for vertical position are "top","middle",
-    #                 "bottom" and "left","center","right", for horizontal
+    # - `:waterposition` - Where to put the watermark relative to the base image.
+    #                 Possible values for vertical position are `top`,`middle`,
+    #                 `bottom` and `left`,`center`,`right`, for horizontal
     #                 position. The two can be combined by separating vertical
     #                 and horizontal with a comma. The default behavior
     #                 is bottom,right
+    #
+    # - `:cache` - Specifies if the image should be cached or not.
+    #
+    # #### Examples
+    #
+    #      filepicker_image_url @user.filepicker_url, w: 160, h: 160, fit: 'clip'
+    #      # => https://www.filepicker.io/api/file/hFHUCB3iTxyMzseuWOgG/convert?w=160&h=160&fit=clip
+    #
     def filepicker_image_url(url, options = {})
-      query_params = options.slice(:w, :h, :fit, :align, :rotate, :cache, :crop, :format, :quality, :watermark, :watersize, :waterposition).to_query
+      FilepickerImageUrl.new(url, options).execute
+    end
+
+    class FilepickerImageUrl
 
-      if ::Rails.application.config.filepicker_rails.cdn_host
-        uri = URI.parse(url)
-        url.gsub!("#{uri.scheme}://#{uri.host}", ::Rails.application.config.filepicker_rails.cdn_host)
+      CONVERT_OPTIONS = [:w, :h, :fit, :align, :rotate, :crop, :format,
+                         :quality, :watermark, :watersize, :waterposition]
+      VALID_OPTIONS   = CONVERT_OPTIONS + [:cache]
+
+      def initialize(url, options = {})
+        @url, @options = url, options
       end
 
-      if query_params.blank?
-        [url, query_params]
-      else
-        [url, "/convert?", query_params]
-      end.join
+      def execute
+        url_with_path = if convert_options.any?
+          "#{cdn_url}/convert"
+        else
+          cdn_url
+        end
+
+        query_params = all_options.merge(policy_config).to_query
+
+        [url_with_path, query_params.presence].compact.join('?')
+      end
+
+      private
+
+        attr_reader :url, :options
+
+        def all_options
+          options.select { |option| VALID_OPTIONS.include?(option) }
+        end
+
+        def convert_options
+          options.select { |option| CONVERT_OPTIONS.include?(option) }
+        end
+
+        def cdn_host
+          ::Rails.application.config.filepicker_rails.cdn_host
+        end
+
+        def cdn_url
+          if cdn_host
+            uri = URI.parse(url)
+            url.gsub("#{uri.scheme}://#{uri.host}", cdn_host)
+          else
+            url
+          end
+        end
+
+        def policy_config
+          Policy.apply
+        end
     end
+    private_constant :FilepickerImageUrl
   end
 end

data/app/helpers/filepicker_rails/form_helper.rb

@@ -1,57 +1,101 @@
 module FilepickerRails
   module FormHelper
 
-    def filepicker_field(method, options = {})
-      type = options.delete(:dragdrop) ? 'filepicker-dragdrop' : 'filepicker'
+    FILEPICKER_OPTIONS_TO_DASHERIZE = [:button_text, :button_class, :mimetypes,
+                                       :extensions, :container, :services,
+                                       :drag_text, :drag_class, :store_path,
+                                       :store_location, :store_access, :multiple]
 
-      input_options = retrieve_legacy_filepicker_options(options)
-      input_options['data-fp-apikey'] ||= ::Rails.application.config.filepicker_rails.api_key
-      input_options.merge!(secure_filepicker) unless input_options['data-fp-policy'].present?
-      input_options['type'] = type
+    FILEPICKER_OPTIONS_TO_CAMELIZE = [:max_size]
 
-      if ::Rails.version.to_i >= 4
-        tag = ActionView::Helpers::Tags::TextField.new(@object_name, method, @template, objectify_options(input_options))
-        tag.send(:add_default_name_and_id, input_options)
-        tag.render
+    # Creates a filepicker field, accepts optional `options` hash for configuration.
+    #
+    # #### Options
+    #
+    # - `:button_text` - The text of the upload button.
+    # - `:button_class` - The class of the upload button.
+    # - `:extensions` - The extensions of file types you want to support for this upload. Ex: `.png,.jpg`.
+    # - `:mimetypes` - The file types you want to support for this upload. Ex: `image/png,text/*`.
+    # - `:container` - Where to show the file picker dialog can be `modal`, `window` or the id of an iframe on the page.
+    # - `:multiple` - (true or false) Whether or not multiple uploads can be saved at once.
+    # - `:services` - What services your users can upload to. Ex: `BOX, COMPUTER, FACEBOOK`.
+    # - `:store_path` - The path to store the file at within the specified file store.
+    # - `:store_location` - The file is not copied by default. It remains in the original location. If you wish you have the file copied onto your own storage, you can specify where we should put the copy. The only value at the moment is `S3`.
+    # - `:store_access` - Should the underlying file be publicly available on its S3 link. Options are `public` and `private`, defaults to 'private'.
+    # - `:dragdrop` - (`true` or `false`) Whether or not to allow drag-and-drop uploads.
+    # - `:drag_text` - The text of the dragdrop pane.
+    # - `:drag_class` - The class of the dragdrop pane.
+    # - `:onchange` - The onchange event.
+    # - `:max_size` - The maximum file size allowed, in bytes.
+    # - `:class` - Add a class to the input.
+    # - `:value` - Define the value of the input
+    #
+    # #### Examples
+    #
+    #     filepicker_field(:filepicker_url)
+    #     # => <input data-fp-apikey="..." id="user_filepicker_url" name="user[filepicker_url]" type="filepicker" />
+    #
+    # This is mixed on form for to be used like.
+    #
+    #     <%= form_for @user do |f| %>
+    #       <%= f.filepicker_field :filepicker_url %>
+    #       <%= f.submit %>
+    #     <% end %>
+    #
+    def filepicker_field(method, options = {})
+      define_input_options(options)
+      @method = method
+      if rails_greater_than_4?
+        rails_greater_than_4_input
       else
-        ActionView::Helpers::InstanceTag.new(@object_name, method, @template).to_input_field_tag(type, input_options)
+        rails_input
       end
     end
 
     private
 
-      def retrieve_legacy_filepicker_options(options)
-        mappings = {
-            :button_text    => 'data-fp-button-text',
-            :button_class   => 'data-fp-button-class',
-            :mimetypes      => 'data-fp-mimetypes',
-            :extensions     => 'data-fp-extensions',
-            :container      => 'data-fp-container',
-            :services       => 'data-fp-services',
-            :drag_text      => 'data-fp-drag-text',
-            :drag_class     => 'data-fp-drag-class',
-            :store_path     => 'data-fp-store-path',
-            :store_location => 'data-fp-store-location',
-            :store_access   => 'data-fp-store-access',
-            :multiple       => 'data-fp-multiple',
-            :max_size       => 'data-fp-maxSize',
-            :onchange       => 'onchange',
-            :class          => 'class',
-            :value          => 'value'
-        }
+      attr_reader :input_options, :method, :type, :object_name, :template
+
+      def define_input_options(options)
+        @type = options.delete(:dragdrop) ? 'filepicker-dragdrop' : 'filepicker'
+        @input_options = retrieve_legacy_filepicker_options(options)
+        @input_options['data-fp-apikey'] ||= ::Rails.application.config.filepicker_rails.api_key
+        @input_options.merge!(secure_filepicker) unless @input_options['data-fp-policy'].present?
+        @input_options['type'] = @type
+        @input_options
+      end
+
+      def rails_greater_than_4_input
+        tag = ActionView::Helpers::Tags::TextField.new(object_name, method, template, objectify_options(input_options))
+        tag.send(:add_default_name_and_id, input_options)
+        tag.render
+      end
 
+      def rails_input
+        ActionView::Helpers::InstanceTag.new(object_name, method, template).to_input_field_tag(type, input_options)
+      end
+
+      def rails_greater_than_4?
+        ::Rails.version.to_i >= 4
+      end
+
+      def filepicker_prefix
+        'data-fp-'
+      end
+
+      def retrieve_legacy_filepicker_options(options)
+        mappings = {}
+        FILEPICKER_OPTIONS_TO_DASHERIZE.each do |option|
+          mappings[option] = "#{filepicker_prefix}#{option.to_s.dasherize}"
+        end
+        FILEPICKER_OPTIONS_TO_CAMELIZE.each do |option|
+          mappings[option] = "#{filepicker_prefix}#{option.to_s.camelize(:lower)}"
+        end
         Hash[options.map {|k, v| [mappings[k] || k, v] }]
       end
 
       def secure_filepicker
-        return {} unless ::Rails.application.config.filepicker_rails.secret_key.present?
-        grant = Policy.new
-        grant.call = [:pick, :store]
-
-        {
-            'data-fp-policy' => grant.policy,
-            'data-fp-signature' => grant.signature
-        }
+        Policy.apply([:pick, :store], ['data-fp-policy', 'data-fp-signature'])
       end
   end
 end

data/lib/filepicker_rails/configuration.rb

@@ -1,14 +1,77 @@
 module FilepickerRails
   class Configuration
-    attr_writer :api_key, :default_expiry
-    attr_accessor :secret_key, :cdn_host
 
+    # Define your API Key to be used.
+    #
+    # #### Examples
+    #
+    # This is to be used on the `config/application.rb`:
+    #
+    #      config.filepicker_rails.api_key = 'Your filepicker.io API Key'
+    #
+    attr_writer :api_key
+
+    # Define your Secret key to be used on Policy.
+    #
+    # More info about Policy on [Ink documentation](https://developers.filepicker.io/docs/security/)
+    #
+    # #### Examples
+    #
+    # This is to be used on the `config/application.rb`:
+    #
+    #      config.filepicker_rails.secret_key = 'Your filepicker.io Secret Key'
+    #
+    attr_writer :secret_key
+
+    # @private
+    attr_reader :secret_key
+
+    # Set your CDN Path to be used
+    #
+    # More info about CDN on [Ink documentation](https://developers.filepicker.io/docs/cdn/)
+    #
+    # #### Examples
+    #
+    # This is to be used on the `config/application.rb`:
+    #
+    #      config.filepicker_rails.cdn_host = 'Your CDN host name'
+    #
+    attr_writer :cdn_host
+
+    # @private
+    attr_reader :cdn_host
+
+    # @private
     def api_key
       @api_key or raise "Set config.filepicker_rails.api_key"
     end
 
-    def default_expiry
-      @default_expiry ||= 600
+    # Define the expire time when using Policy.
+    #
+    # By default the expiry time is 10 minutes.
+    # If you need to change the expiry time this should be an integer and
+    # it is expressed in seconds since the [Epoch](http://en.wikipedia.org/wiki/Unix_time).
+    #
+    # #### Examples
+    #
+    # This is to be used on the `config/application.rb`:
+    #
+    #      config.filepicker_rails.expiry = -> { (Time.zone.now + 5.minutes).to_i }
+    #      # Define the expiry time to 5 minutes
+    #
+    # If you need always the same url, a static expiry time, to do some cache.
+    # You can set a date starting of the Epoch.
+    #
+    #     config.filepicker_rails.expiry = -> { 100.years.since(Time.at(0)).to_i }
+    #
+    def expiry=(expiry)
+      raise ArgumentError, 'Must be a callable' unless expiry.respond_to?(:call)
+      @expiry = expiry
+    end
+
+    # @private
+    def expiry
+      @expiry ||= -> { Time.zone.now.to_i + 600 }
     end
   end
 end

data/lib/filepicker_rails/engine.rb

@@ -1,4 +1,5 @@
 module FilepickerRails
+  # @private
   class Engine < ::Rails::Engine
     config.filepicker_rails = FilepickerRails::Configuration.new
     isolate_namespace FilepickerRails

data/lib/filepicker_rails/policy.rb

@@ -19,11 +19,21 @@ module FilepickerRails
       OpenSSL::HMAC.hexdigest('sha256', ::Rails.application.config.filepicker_rails.secret_key, policy)
     end
 
+    def self.apply(call = [:read, :convert], keys = ['policy', 'signature'])
+      return {} unless ::Rails.application.config.filepicker_rails.secret_key.present?
+      grant = Policy.new
+      grant.call = call
+      {
+        keys[0] => grant.policy,
+        keys[1] => grant.signature
+      }
+    end
+
     private
     def json_policy
       hash = Hash.new
 
-      @expiry ||= Time.now.to_i + ::Rails.application.config.filepicker_rails.default_expiry
+      @expiry ||= ::Rails.application.config.filepicker_rails.expiry.call
 
       [:expiry, :call, :handle, :maxsize, :minsize, :path].each do |input|
         hash[input] = send(input) unless send(input).nil?
@@ -32,4 +42,5 @@ module FilepickerRails
       MultiJson.dump(hash)
     end
   end
+  private_constant :Policy
 end

data/lib/filepicker_rails/version.rb

@@ -1,3 +1,3 @@
 module FilepickerRails
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filepicker-rails
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Max Tilford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-30 00:00:00.000000000 Z
+date: 2014-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -108,6 +108,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Makes integrating filepicker.io with rails 4 easy
 email:
 - maxtilford@gmail.com
@@ -150,3 +178,4 @@ signing_key:
 specification_version: 4
 summary: Makes integrating filepicker.io with rails 4 easy
 test_files: []
+has_rdoc: