filepicker-rails 0.0.2 → 0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NWZhNzRjMzBjODI1OWM0ODUyYzFkZGI5OTRmOTU3MmY2YmYyZmJmNA==
+  data.tar.gz: !binary |-
+    NzY3MDZiNWE0NzA1Y2Y4NGI2OGM4YTkwMDIzN2QyZTJiNGQwNTE4YQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    Zjg2ZTFlZjc5MjJjYWM5YWFhNzZlNTMzZTBhYWM2NTFjMjY3OTJlNTc3ODYy
+    NDc0NjVkNjA4MjUwNWI0MDc5MWQzMzRjZGY4ODRlYzMzY2IyZmFiODY1ZjM3
+    NmI3YTIxZmFmMDlmN2YwYjk5YWZlNTNmMDdlNDlmOTA4ODE4OTY=
+  data.tar.gz: !binary |-
+    Y2NiZWQwN2IwNjEzOGMwYzk0MmVjNjk1MTk3YmY5ZjQ5NGM1ODUxNGE3Nzgw
+    NDM4YTlhMDc0NDEzMWU4ZjU1Y2Q4ZDdiNTA0Yzg1YzM3NjkxMjc0NGRlMTkz
+    NWNhZTU1NzkzOWNkNzhhNjczZDdmMmUwOTUyOGM2NjViMjQ0Mjg=

data/README.md

@@ -6,7 +6,9 @@ Adds form, image_tag, and download/save helpers to help you get up and running w
 
 Add this line to your application's Gemfile:
 
-    gem 'filepicker-rails'
+```ruby
+gem 'filepicker-rails'
+```
 
 And then execute:
 
@@ -18,49 +20,100 @@ Or install it yourself as:
 
 Add the filepicker.io javascript library to your layout:
 
-    <%= filepicker_js_include_tag %>
+```erb
+<%= filepicker_js_include_tag %>
+```
 
 Set your API Key in config/application.rb:
 
-    config.filepicker_rails.api_key = "Your filepicker.io API Key"
+```ruby
+config.filepicker_rails.api_key = "Your filepicker.io API Key"
+```
 
 ## Usage
+### First create a migration to add the field that will hold your filepicker.io URL
+Run the Rails migration generator from the command line:
 
-### Adding an upload field to your form:
+    $ rails g migration AddNameOfAttrForFilepickerUrlToUser
+
+Then add a column to the model's table of type :string:
 
-    <%= form_for @user do |f| %>
-      <div>
-        <%= f.label :avatar_url, "Upload Your Avatar:" %>
-        <%= f.filepicker_field :avatar_url %> <!-- User#avatar_url is a regular string column -->
-      </div>
+```ruby
+class AddNameOfAttrForFilepickerUrlToUser < ActiveRecord::Migration
+  def up
+    add_column :user, :filepicker_url, :string
+  end
 
-      <%= f.submit %>
-    <% end %>
+  def down
+    remove_column :user, :filepicker_url
+  end
+end
+```
 
+
+### Adding an upload field to your form:
+
+```erb
+<%= form_for @user do |f| %>
+  <div>
+    <%= f.label :filepicker_url, "Upload Your Avatar:" %>
+    <%= f.filepicker_field :filepicker_url %> <!-- User#filepicker_url is a regular string column -->
+  </div>
+
+  <%= f.submit %>
+<% end %>
+```
 Full options list:
 
 * button_text - The text of the upload button.
 * button_class - The class of the upload button.
-* mimetypes - The file types you want to support for this upload. Ex: "image/png,text/*"
+* 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".
-* dragdrop - (true or false) Whether or not to all drag-and-drop uploads
+* 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
-
+* onchange - The onchange event.
+
+### Accessing FilePicker File with OnChange:
+
+When the dialog finishes uploading the file, the javascript code in the onchange field will be run with a special 'event' variable. The variable has a fpfiles (or if not multiple, also fpfile) attribute with information about the files (jQuery users: look under event.originalEvent).
+
+Example fpfiles object:
+```javascript
+[{
+    url: 'https://...',
+    data: {
+        filename: 'filename.txt',
+        size: 100,
+        type: 'text/plain'
+    }
+},{
+    url: 'https://...',
+    data: {
+        filename: 'filename2.jpg',
+        size: 9000,
+        type: 'image/jpeg'
+    }
+}]
+```
 
 ### Displaying an image:
 
-    <%= filepicker_image_tag @user.avatar_url, w: 160, h: 160, fit: 'clip' %>
+```erb
+<%= filepicker_image_tag @user.filepicker_url, w: 160, h: 160, fit: 'clip' %>
+```
 
 See [the filepicker.io documentation](https://developers.filepicker.io/docs/web/#fpurl-images) for the full options list.
 
 
 ### Allowing the user to download a file (or upload it to any of the supported services)
 
-    <%= filepicker_save_button "Save", @user.avatar_url, "image/jpg" %>
+```erb
+<%= filepicker_save_button "Save", @user.filepicker_url, "image/jpg" %>
+```
 
 Full options list:
 
@@ -71,4 +124,4 @@ of an iframe on the page.
 
 ### Demo
 
-See a simple demo app [repo](https://github.com/maxtilford/filepicker-rails-demo) and [running on heroku](http://filepicker-rails-demo.herokuapp.com)
+See a simple demo app [repo](https://github.com/maxtilford/filepicker-rails-demo)

data/filepicker-rails.gemspec

@@ -3,9 +3,9 @@ require File.expand_path('../lib/filepicker/rails/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Max Tilford"]
   gem.email         = ["maxtilford@gmail.com"]
-  gem.description   = %q{Makes integrating filepicker.io with rails easy}
-  gem.summary       = %q{Makes integrating filepicker.io with rails easy}
-  gem.homepage      = "https://github.com/maxtilford/filepicker-rails"
+  gem.description   = %q{Makes integrating filepicker.io with rails 4 easy}
+  gem.summary       = %q{Makes integrating filepicker.io with rails 4 easy}
+  gem.homepage      = "https://github.com/Filepicker/filepicker-rails"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -16,4 +16,5 @@ Gem::Specification.new do |gem|
 
   gem.required_rubygems_version = ">= 1.3.6"
   gem.add_dependency "railties", ">= 3.1.0", "< 5.0"
+  gem.add_dependency 'multi_json', '~> 1.6'
 end

data/lib/filepicker-rails.rb

@@ -1,5 +1,6 @@
 require "filepicker/rails/version"
 require "filepicker/rails/configuration"
+require "filepicker/rails/policy"
 require "filepicker/rails/form_builder"
 require "filepicker/rails/view_helpers"
 require "filepicker/rails/railtie"

data/lib/filepicker/rails/configuration.rb

@@ -1,10 +1,19 @@
 module Filepicker
   module Rails
     class Configuration
-      attr_writer :api_key
+      attr_writer :api_key, :secret_key, :default_expiry
+
       def api_key
         @api_key or raise "Set config.filepicker_rails.api_key"
       end
+
+      def secret_key
+        @secret_key
+      end
+
+      def default_expiry
+        @default_expiry ||= 600
+      end
     end
   end
 end

data/lib/filepicker/rails/form_builder.rb

@@ -3,33 +3,52 @@ module Filepicker
     module FormBuilder
 
       def filepicker_field(method, options = {})
-        input_options = {
-          'data-fp-apikey' =>
-          ::Rails.application.config.filepicker_rails.api_key,
+        type = options.delete(:dragdrop) ? 'filepicker-dragdrop' : 'filepicker'
 
-          'data-fp-button-text' => options.fetch(:button_text, "Pick File"),
+        input_options = retrive_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?
 
-          'data-fp-button-class' => options[:button_class],
+        input_options['type'] = type
 
-          'data-fp-mimetypes' => options[:mimetypes],
-
-          'data-fp-option-container' => options[:container],
-
-          'data-fp-option-multiple' => false,
+        if ::Rails.version.to_i >= 4
+          ActionView::Helpers::Tags::TextField.new(@object_name, method, @template).tag('input', input_options)
+        else
+          ActionView::Helpers::InstanceTag.new(@object_name, method, @template).to_input_field_tag(type, input_options)
+        end
+      end
 
-          'data-fp-option-services' => Array(options[:services]).join(","),
+      private
+
+      def retrive_legacy_filepicker_options(options)
+        mappings = {
+            :button_text    => 'data-fp-button-text',
+            :button_class   => 'data-fp-button-class',
+            :mimetypes      => 'data-fp-mimetypes',
+            :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',
+            :multiple       => 'data-fp-multiple',
+            :onchange       => 'onchange',
+            :class          => 'class',
+            :value          => 'value'
+        }
 
-          'data-fp-drag-text' => options.fetch(:drag_text, "Or drop files here"),
+        Hash[options.map {|k, v| [mappings[k] || k, v] }]
+      end
 
-          'data-fp-drag-class' => options[:drag_class],
+      def secure_filepicker
+        return {} unless ::Rails.application.config.filepicker_rails.secret_key.present?
+        grant = Policy.new
+        grant.call = [:pick, :store]
 
-          'onchange' => options[:onchange]
+        {
+            'data-fp-policy' => grant.policy,
+            'data-fp-signature' => grant.signature
         }
-
-        type = options[:dragdrop] ? 'filepicker-dragdrop' : 'filepicker'
-
-        ActionView::Helpers::InstanceTag.new(@object_name, method, @template)
-          .to_input_field_tag(type, input_options)
       end
     end
   end

data/lib/filepicker/rails/policy.rb

@@ -0,0 +1,37 @@
+require 'base64'
+require 'openssl'
+
+module Filepicker
+  module Rails
+    class Policy
+      attr_accessor :expiry, :call, :handle, :maxsize, :minsize, :path
+
+      def initialize(options = {})
+        [:expiry, :call, :handle, :maxsize, :minsize, :path].each do |input|
+          send("#{input}=", options[input]) unless options[input].nil?
+        end
+      end
+
+      def policy
+        Base64.urlsafe_encode64(json_policy)
+      end
+
+      def signature
+        OpenSSL::HMAC.hexdigest('sha256', ::Rails.application.config.filepicker_rails.secret_key, policy)
+      end
+
+      private
+      def json_policy
+        hash = Hash.new
+
+        @expiry ||= Time.now.to_i + ::Rails.application.config.filepicker_rails.default_expiry
+
+        [:expiry, :call, :handle, :maxsize, :minsize, :path].each do |input|
+          hash[input] = send(input) unless send(input).nil?
+        end
+
+        MultiJson.dump(hash)
+      end
+    end
+  end
+end

data/lib/filepicker/rails/version.rb

@@ -1,5 +1,5 @@
 module Filepicker
   module Rails
-    VERSION = "0.0.2"
+    VERSION = "0.1"
   end
 end

data/lib/filepicker/rails/view_helpers.rb

@@ -23,13 +23,13 @@ module Filepicker
 
       # 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
-      def filepicker_image_tag(url, options={})
-        image_tag(filepicker_image_url(url, options), options)
+      def filepicker_image_tag(url, image_options={}, image_tag_options={})
+        image_tag(filepicker_image_url(url, image_options), image_tag_options)
       end
 
-      # width - Resize the image to this width.
+      # w - Resize the image to this width.
       #
-      # height - 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
@@ -66,7 +66,7 @@ module Filepicker
       #                 and horizontal with a comma. The default behavior
       #                 is bottom,right
       def filepicker_image_url(url, options = {})
-        query_params = options.slice(:width, :height, :fit, :align, :crop, :format, :quality, :watermark, :watersize, :waterposition).to_query
+        query_params = options.slice(:w, :h, :fit, :align, :crop, :format, :quality, :watermark, :watersize, :waterposition).to_query
         [url, "/convert?", query_params].join
       end
 

metadata

@@ -1,55 +1,56 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: filepicker-rails
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+version: !ruby/object:Gem::Version
+  version: '0.1'
 platform: ruby
-authors: 
+authors:
 - Max Tilford
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-12-01 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 3
-        - 1
-        - 0
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.1.0
     - - <
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 5
-        - 0
-        version: "5.0"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
   type: :runtime
-  version_requirements: *id001
-description: Makes integrating filepicker.io with rails easy
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Makes integrating filepicker.io with rails 4 easy
+email:
 - maxtilford@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - LICENSE
@@ -59,43 +60,31 @@ files:
 - lib/filepicker-rails.rb
 - lib/filepicker/rails/configuration.rb
 - lib/filepicker/rails/form_builder.rb
+- lib/filepicker/rails/policy.rb
 - lib/filepicker/rails/railtie.rb
 - lib/filepicker/rails/version.rb
 - lib/filepicker/rails/view_helpers.rb
-homepage: https://github.com/maxtilford/filepicker-rails
+homepage: https://github.com/Filepicker/filepicker-rails
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
-summary: Makes integrating filepicker.io with rails easy
+specification_version: 4
+summary: Makes integrating filepicker.io with rails 4 easy
 test_files: []
-