carrierwave-filepickerio 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 carrierwave-filepickerio.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Adam Burmister
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+carrierwave-filepickerio
+========================
+
+FilePicker.io support for CarrierWave.
+
+Installation
+------------
+
+Install the latest stable release:
+
+    gem install carrierwave-filepickerio
+
+In Rails, add it to your Gemfile:
+
+    gem 'carrierwave-filepickerio'
+
+Configuration
+-------------
+
+Add your FilePicker.io API key to the CarrierWave initializer:
+
+    CarrierWave.configure do |config|
+      # ... add the following
+      config.filepickerio_api_key = '[Your API key]'
+    end
+
+Usage
+-----
+
+After setting up your CarrierWave uploader as per normal (see the CarrierWave site for more information) you need to configure your page to use the Filepicker.io widget.
+
+First of all, include the filepicker.io JavaScript library in your page (such as your application.html.erb layout):
+
+```erb
+<%= javascript_include_tag "//api.filepicker.io/v0/filepicker.js" %>
+```
+
+... or, if you're not using the asset pipeline, you can use the expansion:
+
+```erb
+<%= javascript_include_tag :filepickerio %>
+```
+
+Form Builders
+-------------
+
+To use the FilePicker.io uploader you need to call the view helper like so:
+
+```erb
+<%= form_for @entry do |f| %>
+  <%= f.fp_file_field :image %>
+  <%= f.fp_save_button :image, "Save existing image to cloud", 'image/jpeg' %>
+<%- end %>
+```
+
+You can change the button text by passing along a string as the first parameter
+
+```erb
+<%= f.fp_file_field :image, "Pick a picture" %>
+```
+
+To include a drag-n-drop area pass the dragdrop parameter in the options hash, which is the last parameter.
+
+```erb
+<%= f.fp_file_field :image, "Pick a picture", dragdrop: true %>
+```
+
+You can also attach any other events to the input as normal, for instance you can listen to change events:
+
+```erb
+<%= f.fp_file_field :image, "Pick a picture", dragdrop: true, onchange: '$("#pic").attr("src", arguments[0].files[0].url)' %>
+```
+
+Specify any Filepicker.io additional data options in the data hash
+
+```erb
+<%= f.fp_file_field :image, "Pick a picture", data: { 'fp-mimetypes' => 'image/jpeg,image/png' } %>
+```
+
+You may include any of the additional parameters...
+
+Additional Options
+------------------
+
+Any additional Filepicker.io configuration can be passed within an optional data hash passed to the view helper method.
+
+```erb
+<%= f.fp_file_field :image, data: { "fp-button-text" => "Pick a lolcat to upload" } %>
+```
+
+See [https://developers.filepicker.io/docs/web/](https://developers.filepicker.io/docs/web/) for a full list of configuration options.

data/Rakefile

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

data/carrierwave-filepickerio.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "carrierwave-filepickerio/version"
+
+Gem::Specification.new do |s|
+  s.name        = "carrierwave-filepickerio"
+  s.version     = CarrierWave::Filepickerio::VERSION
+  s.authors     = ["Adam Burmister"]
+  s.email       = ["adam.burmister@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{FilePicker.io support for CarrierWave}
+  s.description = %q{Upload files to your ruby web application using the FilePicker.io client-side JS libraries, picking files from not only the local file system, but also online services such as Facebook, Dropbox, Gmail, Flickr, and many more.}
+
+  s.rubyforge_project = "carrierwave-filepickerio"
+
+  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 "rails"
+  s.add_dependency "filepickerio_rails", "~> 0.0.2"
+  s.add_dependency "carrierwave"
+end

data/lib/carrierwave-filepickerio/form_builder.rb

@@ -0,0 +1,32 @@
+module CarrierWave
+  module Filepickerio
+    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={})
+        method = "remote_#{method.to_s}_url".to_sym if !method.to_s.ends_with?('_url')
+        @template.fp_file_field(@object_name, method, text, options)
+      end
+
+      def fp_save_button(method, text, mime, options={}, &block)
+        method = "#{method.to_s}_url".to_sym if !method.to_s.ends_with?('_url')
+        options[:type]='button'
+        
+        # The URL value being used is not absolute, which is required by filepicker.io. So pull out the value
+        # from the object now, and make it full relative to the current asset host
+        value = options.fetch(:value){ ::ActionView::Helpers::InstanceTag::value_before_type_cast(@object, method.to_s) }
+        value &&= ERB::Util.html_escape(value)
+
+        options[:value] = @template.asset_path(value)
+
+        # If no asset host is set create a full url form the request
+        if !(options[:value].starts_with?('http://') || options[:value].starts_with?('https://'))
+          options[:value] = @template.instance_eval "request.protocol + request.host_with_port + asset_path(value)"
+        end
+
+        @template.fp_save_button(@object, method, text, mime, options, &block)
+      end
+      
+    end
+  end
+end

data/lib/carrierwave-filepickerio/railtie.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+module CarrierWave
+  module Filepickerio
+    class Railtie < Rails::Railtie
+
+      # Lazy load the form builder with action_view
+      initializer 'carrierwave-filepickerio.action_view' do
+        ActiveSupport.on_load :action_view do
+          require 'carrierwave-filepickerio/form_builder'
+        end
+      end
+
+      config.after_initialize do
+        FilepickerioRails.configure do |config|
+          config.api_key = CarrierWave::Uploader::Base.filepickerio_api_key
+        end
+      end
+
+    end
+  end
+end

data/lib/carrierwave-filepickerio/uploader/configuration.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module CarrierWave
+  module Filepickerio
+    module Uploader
+      module Configuration
+        extend ActiveSupport::Concern
+
+        included do
+          add_config :filepickerio_api_key
+          reset_direct_config
+        end
+
+        module ClassMethods
+          def reset_direct_config
+            configure do |config|
+              config.filepickerio_api_key = nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/carrierwave-filepickerio/version.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+module CarrierWave
+  module Filepickerio
+    VERSION = "0.0.1"
+  end
+end

data/lib/carrierwave-filepickerio.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+require 'carrierwave-filepickerio/version'
+
+require 'carrierwave'
+require 'filepickerio_rails'
+require 'carrierwave-filepickerio/railtie' if defined?(Rails)
+
+module CarrierWave
+  module Filepickerio
+    module Uploader
+      # Add our filepickerio_api_key property to the CarrierWave configuration
+      autoload :Configuration, 'carrierwave-filepickerio/uploader/configuration'
+      CarrierWave::Uploader::Base.send(:include, Configuration)
+    end
+  end
+end

data/spec/form_builder_spec.rb

@@ -0,0 +1,80 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe CarrierWave::Filepickerio::FormBuilder do
+  describe "#filepickerio_field" do
+
+    let :user do
+      mock_model("User", login: "Username", avatar: nil)
+    end
+
+    context "javascripts" do
+      it "should expand :filepickerio to the filepicker.io JS URL" do
+        javascript_include_tag(:filepickerio).should == ''
+      end
+    end
+
+    context "form field" do
+      let :template do
+        <<-EOTEMPLATE
+          <%= form_for(user) do |f| %>
+             <%= f.filepickerio_field(:avatar) %>
+          <%- end -%>
+        EOTEMPLATE
+      end
+
+      it "should render successfuly" do
+        render(inline: template, locals: { user: user })
+        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.filepickerio_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.filepickerio_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 @@
+# encoding: utf-8
+
+require 'carrierwave-filepickerio'
+
+#TODO Require classes to support tests
+
+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
+
+  config.order = 'random'
+end

data/spec/support/carrierwave_config.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+# Setup CarrierWave ready for testing with the API key
+CarrierWave.configure do |config|
+  config.filepickerio_api_key = "TESTAPIKEY"
+end

data/spec/support/form_builder_helpers.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'action_view'
+require 'action_view/template'
+
+require 'carrierwave-filepickerio/form_builder'
+
+module FormBuilderHelpers
+  include ActionView::Helpers::FormHelper
+  include ActionView::Context
+  include ActionController::RecordIdentifier
+
+  def protect_against_forgery?
+    false
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: carrierwave-filepickerio
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Adam Burmister
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70292672181200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70292672181200
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70292672180400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70292672180400
+- !ruby/object:Gem::Dependency
+  name: filepickerio_rails
+  requirement: &70292672114120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70292672114120
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  requirement: &70292672112100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70292672112100
+description: Upload files to your ruby web application using the FilePicker.io client-side
+  JS libraries, picking files from not only the local file system, but also online
+  services such as Facebook, Dropbox, Gmail, Flickr, and many more.
+email:
+- adam.burmister@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- carrierwave-filepickerio.gemspec
+- lib/carrierwave-filepickerio.rb
+- lib/carrierwave-filepickerio/form_builder.rb
+- lib/carrierwave-filepickerio/railtie.rb
+- lib/carrierwave-filepickerio/uploader/configuration.rb
+- lib/carrierwave-filepickerio/version.rb
+- spec/form_builder_spec.rb
+- spec/spec_helper.rb
+- spec/support/carrierwave_config.rb
+- spec/support/form_builder_helpers.rb
+homepage: ''
+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: -514538051003963035
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -514538051003963035
+requirements: []
+rubyforge_project: carrierwave-filepickerio
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: FilePicker.io support for CarrierWave
+test_files:
+- spec/form_builder_spec.rb
+- spec/spec_helper.rb
+- spec/support/carrierwave_config.rb
+- spec/support/form_builder_helpers.rb