filepickerio_rails 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+.rvmrc
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in filepickerio_rails.gemspec
+gemspec

data/README.md

@@ -0,0 +1,44 @@
+filepickerio_rails
+==================
+
+Installation
+------------
+
+Add your Filepicker.io API Key to an initialiser (`config/initializer/filepickerio_rails.rb`):
+
+    FilepickerioRails.configure do |config|
+      config.api_key = '[YOUR API KEY FROM FILEPICKER.IO]'
+    end
+
+Include the filepicker.io JavaScript library in your page (such as your application.html.erb layout):
+
+    <%= javascript_include_tag "//api.filepicker.io/v0/filepicker.js" %>
+
+... or, if you're not using the asset pipeline, you can use the expansion:
+
+    <%= javascript_include_tag :filepickerio %>
+
+Render a Filepicker.io file upload and save fields using the form tag helper:
+
+    <%= fp_file_field_tag :image_url, 'Pick file', 'http://example.com/existing-upload.jpg' %>
+    <%= fp_file_field_tag :image_url, 'Pick file', 'http://example.com/existing-upload.jpg', 'image/jpg' %>
+    <%= fp_file_field_tag :image_url, 'Pick file', 'http://example.com/existing-upload.jpg', 'image/jpg', { class: 'primary btn' } %>
+
+    <%= fp_save_button 'Save to Dropbox', 'http://www.filepicker.io/static/img/success.png', 'image/jpg' %>
+    <%= fp_save_button 'Save to Dropbox', 'http://www.filepicker.io/static/img/success.png', 'image/jpg', data: { 'fp-option-services' => 'DROPBOX' } %>
+
+Or use the data-bound form builder methods, fp_file_field, fp_save_button:
+
+    <%= form_for @entry do |f| %>
+      <%= f.fp_file_field :image_url %>
+      <%= f.fp_file_field :lolcat_image_url, "Upload lolcat" %>
+
+      <%= f.fp_save_button :image_url, "Save existing image to cloud", 'image/jpg' %>
+    <%- end %>
+
+Filepicker.io Data Params
+-------------------------
+
+Pass a data hash as the last parameter to the helper methods to control the Filepicker.io widget.
+
+See the documentation at [https://developers.filepicker.io/docs/web/](https://developers.filepicker.io/docs/web/)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/filepickerio_rails.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "filepickerio_rails/version"
+
+Gem::Specification.new do |s|
+  s.name        = "filepickerio_rails"
+  s.version     = FilepickerioRails::VERSION
+  s.authors     = ["Adam Burmister"]
+  s.email       = ["adam.burmister@gmail.com"]
+  s.homepage    = "http://adamburmister.github.com/filepickerio_rails/"
+  s.summary     = %q{Rails view helpers for Filepicker.io widgets}
+  s.description = %q{Rails view helpers for Filepicker.io widgets}
+
+  s.rubyforge_project = "filepickerio_rails"
+
+  s.files         = `git ls-files`.split("\n")
+  s.files.reject! { |fn| fn.include? "example" } # don't include our example rails project which is just for testing
+
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "rails"
+  s.add_dependency "railties", "~> 3.1"
+end

data/lib/filepickerio_rails/action_view/form_builder.rb

@@ -0,0 +1,14 @@
+module FilepickerioRails
+  class ::ActionView::Helpers::FormBuilder
+    
+    # Returns a input tag tailored for a Filepicker.io upload widget to be attached for the form object
+    def fp_file_field(method, text=nil, options={})
+      @template.fp_file_field(@object_name, method, text, options)
+    end
+
+    def fp_save_button(method, text, mime, options={}, &block)
+      @template.fp_save_button(@object, method, text, mime, options, &block)
+    end
+
+  end
+end

data/lib/filepickerio_rails/action_view/form_tag_helper.rb

@@ -0,0 +1,111 @@
+module FilepickerioRails
+  module ActionView
+
+    # This module creates filepicker.io fields
+    #
+    # Examples:
+    #
+    #     filepickerio_upload_tag :user, 'Pick file', 'http://example.com/existing-upload.jpg', data: { "fp-mimetypes": "image/jpg" }
+    #
+    #     filepickerio_save_button_tag 'Save file to cloud', 'http://example.com/existing-upload.jpg', 'image/jpeg'
+    #
+    module FormTagHelper
+
+      def fp_file_field_tag(object_name, text_or_options=nil, value_or_options=nil, options={})
+        # Allow users to pass in variable length arguments
+        if text_or_options.is_a? Hash
+          text = value = nil
+          options = text_or_options
+        elsif value_or_options.is_a? Hash
+          value = nil
+          options = value_or_options
+        else
+          text = text_or_options
+          value = value_or_options
+        end
+
+        options.merge!(
+          # This avoids the ActiveModel naming of `object_name[method]`
+          id: object_name,
+          name: object_name,
+          value: value
+        )
+
+        fp_file_field(object_name, nil, text, options)
+      end
+
+      def fp_file_field(object_name, method, text, options)
+        dragdrop = options[:dragdrop] && options[:dragdrop] == true
+
+        input_type = if dragdrop
+          options.delete(:dragdrop)
+          'filepicker-dragdrop'
+        else
+          'filepicker'
+        end
+
+        options = { 
+          type: input_type,
+          size: nil,
+          data: {
+            "fp-apikey" => fp_api_key,
+            "fp-button-text" => text || 'Pick File'
+          }
+        }.deep_merge(options)
+
+        ::ActionView::Helpers::InstanceTag.new(object_name, method, self, options.delete(:object)).to_input_field_tag(input_type, options)
+      end
+
+      def fp_save_button_tag(content=nil, url=nil, mime=nil, options=nil, &block)
+        raise "URL of file to be saved must be set" if url.nil?
+
+        options.deep_merge!({ 
+            data: {
+              "fp-url" => url
+            } 
+          })
+
+        fp_save_button(nil, nil, content, mime, options, &block)
+      end
+
+      def fp_save_button(object, method, content=nil, mime=nil, options={}, &block)
+        raise "Mime type of file to be saved must be set" if mime.nil?
+
+        value = options[:value]
+        if object && method
+          if !value
+            value = options.fetch(:value){ ::ActionView::Helpers::InstanceTag::value_before_type_cast(object, method.to_s) }
+            value &&= ERB::Util.html_escape(value)
+          end
+        end
+
+        options = { 
+          name: nil,
+          type: nil,
+          data: {
+            "fp-apikey" => fp_api_key,
+            "fp-mimetype" => mime,
+            "fp-url" => value
+          } 
+        }.deep_merge(options)
+
+        # Convert services array into string
+        if options[:data]['fp-option-services'].is_a? Array
+          options[:data]['fp-option-services'] = options[:data]['fp-option-services'].join(',')
+        end
+
+        button_tag(content || 'Save file', options, &block)
+      end
+
+    private
+
+      def fp_api_key
+        raise "Filepicker.io API Key not set. Check config/initializer/filepickerio_rails.rb" if !FilepickerioRails.config.api_key
+        FilepickerioRails.config.api_key
+      end
+
+    end
+  end
+end
+
+ActionView::Base.send :include, FilepickerioRails::ActionView::FormTagHelper

data/lib/filepickerio_rails/configuration.rb

@@ -0,0 +1,27 @@
+require 'active_support/configurable'
+
+module FilepickerioRails
+  # Configures global settings for FilepickerioRails
+  #   FilepickerioRails.configure do |config|
+  #     config.api_key = 'YOURKEY'
+  #   end
+  def self.configure(&block)
+    yield @config ||= FilepickerioRails::Configuration.new
+  end
+
+  # Global settings for FilepickerioRails
+  def self.config
+    @config
+  end
+
+  # Do not access this class directly, use self.config
+  class Configuration
+    include ActiveSupport::Configurable
+    config_accessor :api_key
+  end
+
+  # Initialize the configuration
+  configure do |config|
+    config.api_key = nil
+  end
+end

data/lib/filepickerio_rails/railtie.rb

@@ -0,0 +1,23 @@
+module FilepickerioRails
+  class Railtie < Rails::Railtie
+
+    # By running before_configuration we give users a chance to override
+    # within their rails config
+    config.before_configuration do
+      # If you're not using the asset pipeline you can use this javascript
+      # expansion to include the Filepicker.io JS lib
+      config.action_view.javascript_expansions[:filepickerio] = %w(//api.filepicker.io/v0/filepicker.js)
+    end
+
+    initializer 'filepickerio_rails.action_view' do
+      ActiveSupport.on_load :action_view do
+        # Load the helpers along with action_view
+        # The _tag helper renders non-model bound tags
+        require 'filepickerio_rails/action_view/form_tag_helper'
+        # The form builder renders model bound field tags
+        require 'filepickerio_rails/action_view/form_builder'
+      end
+    end
+
+  end
+end

data/lib/filepickerio_rails/version.rb

@@ -0,0 +1,3 @@
+module FilepickerioRails
+  VERSION = "0.0.1"
+end

data/lib/filepickerio_rails.rb

@@ -0,0 +1,18 @@
+# load Rails/Railtie
+begin
+  require 'rails'
+rescue LoadError
+  #do nothing
+end
+
+$stderr.puts <<-EOC if !defined?(Rails)
+warning: no framework detected.
+would you check out if your Gemfile appropriately configured?
+---- e.g. ----
+when Rails:
+    gem 'filepickerio_rails'
+EOC
+
+require "filepickerio_rails/version"
+require 'filepickerio_rails/configuration'
+require 'filepickerio_rails/railtie' if defined?(Rails)

data/spec/form_tag_helper_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe FilepickerioRails::ActionView::FormTagHelper do
+  describe "#filepickerio_save_button" do
+    pending
+  end
+
+  describe "#fp_file_field_tag" do
+    context "field" do
+      let :template do
+        <<-EOTEMPLATE
+          <%= fp_file_field_tag :entry, "Pick file to upload", 'value.jpg', class: 'btn' %>
+        EOTEMPLATE
+      end
+
+      it "should render successfuly" do
+        render(inline: template)
+        rendered.should_not be_nil
+      end
+
+      it "should have a type of filepickerio" do
+        render(inline: template, locals: { user: user })
+        rendered.should have_xpath('//input[@type="filepicker"]')
+      end
+
+      it "should have the API key as a data property data-fp-apikey" do
+        render(inline: template, locals: { user: user })
+        rendered.should have_xpath("//input[@data-fp-apikey='#{test_api_key}']")
+      end
+
+      describe "with dragdrop:true" do
+        let :template do
+          <<-EOTEMPLATE
+            <%= form_for(user) do |f| %>
+               <%= f.fp_file_field(:avatar, dragdrop: true) %>
+            <%- end -%>
+          EOTEMPLATE
+        end
+
+        it "should render the type as `filepicker-dragdrop`" do
+          render(inline: template, locals: { user: user })
+          rendered.should have_xpath('//input[@type="filepicker-dragdrop"]')
+        end
+      end
+
+      describe "with optional data params" do
+        let :template do
+          <<-EOTEMPLATE
+            <%= form_for(user) do |f| %>
+               <%= f.fp_file_field(:avatar, data: { "data-fp-apikey" => "987654321", "data-fp-class" => "myCssClass", "data-fp-button-text" => "UploadFu" }) %>
+            <%- end -%>
+          EOTEMPLATE
+        end
+
+        it "should render any passed Filepicker.io configuration data options" do
+          render(inline: template, locals: { user: user })
+          rendered.should have_xpath('//input[@data-fp-class="myCssClass"]')
+          rendered.should have_xpath('//input[@data-fp-button-text="UploadFu"]')
+        end
+
+        it "should override the API key outputted if passed" do
+          render(inline: template, locals: { user: user })
+          rendered.should have_xpath('//input[@data-fp-apikey="987654321"]')
+        end
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'filepickerio_rails'
+
+Dir[ File.dirname(__FILE__) << "/support/**/*.rb"].each {|file| require file }
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/form_helpers.rb

@@ -0,0 +1,14 @@
+require 'action_view'
+require 'action_view/template'
+
+require 'filepickerio_rails/action_view/form_tag_helper'
+
+module FormHelpers
+  include ActionView::Helpers::FormHelper
+  include ActionView::Context
+  include ActionController::RecordIdentifier
+
+  def protect_against_forgery?
+    false
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: filepickerio_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Adam Burmister
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70225434735840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70225434735840
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &70225434735260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70225434735260
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70225434734180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70225434734180
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: &70225434732980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70225434732980
+description: Rails view helpers for Filepicker.io widgets
+email:
+- adam.burmister@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- filepickerio_rails.gemspec
+- lib/filepickerio_rails.rb
+- lib/filepickerio_rails/action_view/form_builder.rb
+- lib/filepickerio_rails/action_view/form_tag_helper.rb
+- lib/filepickerio_rails/configuration.rb
+- lib/filepickerio_rails/railtie.rb
+- lib/filepickerio_rails/version.rb
+- spec/form_tag_helper_spec.rb
+- spec/spec_helper.rb
+- spec/support/form_helpers.rb
+homepage: http://adamburmister.github.com/filepickerio_rails/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1270750157206818046
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1270750157206818046
+requirements: []
+rubyforge_project: filepickerio_rails
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Rails view helpers for Filepicker.io widgets
+test_files:
+- spec/form_tag_helper_spec.rb
+- spec/spec_helper.rb
+- spec/support/form_helpers.rb