paperclip-imgur 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 55e4fc058747f3de3d7d5f3ac1c60eb5e50d08ab
+  data.tar.gz: 51760bd9e810ba8a9e5f14aa4722aebd2652f9b3
+SHA512:
+  metadata.gz: bcfe5c84a4bc6835b28618795d8b7420d0194006bbb5666f9acf6cb41e3b24deb46c694d5b6beba4767b9b918e628c9b19b01e8c6c29c306f434526a0d8fa24c
+  data.tar.gz: 08ec4452008de121fe831a32e1e82b1ec4f03ba155acda02e3210e90c71d62da486f935bbb66411af1a041e3e11b82767102debf6039651727472de6996851b6

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+nbproject

data/.rspec

@@ -0,0 +1 @@
+--color -fs

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in paperclip-imgur.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Daniel Cruz Horts
+
+MIT License
+
+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,71 @@
+# Paperclip::Imgur
+
+This gem extends [Paperclip](https://github.com/thoughtbot/paperclip) with [Imgur](http://imgur.com/) storage. It's been tested with Paperclip 3.3.1 and 4.3.
+
+If you want Paperclip Dropbox support, have a look at this [great gem](https://github.com/janko-m/paperclip-dropbox/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'paperclip-imgur'
+```
+
+And then run:
+```bash
+$ bundle install
+```
+
+## Usage
+
+Tell your typical model™ to use Imgur as storage:
+```ruby
+class User < ActiveRecord::Base
+  has_attached_file :avatar, storage: :imgur
+end
+```
+
+### Credentials
+
+The credentials to upload and delete images from Imgur will be read from `#{Rails.root}/config/imgur.yml`. This file must contain the following keys:
+```yml
+client_id: 'CLIENT_ID'
+client_secret: 'CLIENT_SECRET'
+refresh_token: 'REFRESH_TOKEN'
+```
+
+Get these keys with:
+```bash
+rake imgur:authorize CLIENT_ID='CLIENT_ID' CLIENT_SECRET='CLIENT_SECRET'
+```
+Please refer to the [API client gem documentation](https://github.com/dncrht/imgur) for more information on this.
+
+You can also specify the credentials per model attribute, using a hash:
+```ruby
+has_attached_file :avatar, storage: :imgur, imgur_credentials: {client_id: 'CLIENT_ID', client_secret: 'CLIENT_SECRET', refresh_token: 'REFRESH_TOKEN'}
+```
+...or path to a YAML file
+```ruby
+has_attached_file :avatar, storage: :imgur, imgur_credentials: 'path.to/file.yml'
+```
+...or a File itself
+```ruby
+has_attached_file :avatar, storage: :imgur, imgur_credentials: File.open('path.to/file.yml', 'r')
+```
+
+### Use attachment in views
+
+The image is available in your views in three different sizes:
+```ruby
+<%= image_path @user.avatar %>
+<%= image_path @user.avatar.url(:small) %>
+<%= image_path @user.avatar.url(:large) %>
+```
+
+### Deleting images
+
+To delete an image, follow the usual Paperclip procedure:
+```ruby
+@user.avatar = nil
+@user.save
+```

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :default => :spec

data/config/imgur.yml

@@ -0,0 +1,4 @@
+app_key: 1
+app_secret: 2
+access_token: 3
+access_token_secret: 4

data/lib/paperclip-imgur.rb

@@ -0,0 +1,2 @@
+require 'paperclip'
+require 'paperclip/imgur'

data/lib/paperclip/imgur.rb

@@ -0,0 +1 @@
+require 'paperclip/storage/imgur'

data/lib/paperclip/storage/imgur.rb

@@ -0,0 +1,107 @@
+require 'yaml'
+require 'erb'
+require 'imgur'
+
+module Paperclip
+  module Storage
+    module Imgur
+
+      # Specify credentials in a file, path, string or hash.
+      # Required fields: client_id, client_secret, refresh_token
+      def self.extended(base)
+        base.instance_eval do
+          imgur_credentials = parse_credentials(@options[:imgur_credentials])
+          imgur_options = @options[:imgur_options] || {}
+          environment = defined?(Rails) ? Rails.env : imgur_options[:environment].to_s
+
+          # Use credentials for the current Rails environment, if any
+          @imgur_credentials = (imgur_credentials[environment] || imgur_credentials).symbolize_keys
+        end
+      end
+
+      # We have to trust that any Imgur hash stored into *_file_name represents an existing Imgur image.
+      # This assumption let us avoid the latency of a network call.
+      # If not, someone has touched where he shouldn't!
+      def exists?(style_name = default_style)
+        if original_filename
+          true
+        else
+          false
+        end
+      end
+
+      def flush_writes
+        @queued_for_write.each do |style, file| #style is 'original' etc...
+
+          begin
+            image = imgur_session.image.image_upload(file)
+            image_id = image.id
+          rescue
+            # Sometimes there are API or network errors.
+            # In this cases, we don't store anything.
+            image_id = nil
+          end
+
+          # We cannot use update_attribute because it internally calls save, and save calls
+          # flush_writes again, and it will end up in a stack overflow due excessive recursion
+          instance.update_column :"#{name}_#{:file_name}", image_id
+        end
+        after_flush_writes
+        @queued_for_write = {}
+      end
+
+      def flush_deletes
+        @queued_for_delete.each do |path|
+          imgur_session.image.image_delete(path) # Doesn't matter if the image doesn't really exists
+        end
+        @queued_for_delete = []
+      end
+
+      # Returns the image's URL.
+      # We don't use imgur_session.find to avoid the latency of a network call.
+      def url(size = default_style)
+        image_id = instance.send("#{name}_#{:file_name}")
+
+        return @url_generator.for(size, {}) if image_id.nil? || image_id.empty? # Show Paperclip's default missing image path
+
+        ::Imgur::Image.new(id: image_id).url(size)
+      end
+
+      # Returns the path of the attachment.
+      # It's exactly the Imgur hash.
+      def path(style_name = default_style)
+        original_filename
+      end
+
+      def copy_to_local_file(style, destination_path)
+        # TO BE DONE
+        #local_file = File.open(destination_path, 'wb')
+        #local_file.write(imgur_session.get_file(path(style)))
+        #local_file.close
+      end
+
+      private
+
+      def imgur_session
+        @imgur_session ||= ::Imgur::Session.new(@imgur_credentials)
+      end
+
+      def parse_credentials(credentials = nil)
+        if credentials.nil? && defined?(Rails)
+          credentials = "#{Rails.root}/config/imgur.yml"
+        end
+
+        credentials = case credentials
+                      when File
+                        YAML.load(ERB.new(File.read(credentials.path)).result)
+                      when String, Pathname
+                        YAML.load(ERB.new(File.read(credentials)).result)
+                      end
+
+        return credentials.stringify_keys if credentials.respond_to? :stringify_keys
+
+        raise ArgumentError, 'Please specify Imgur credentials via a file, string or hash.'
+      end
+    end
+  end
+end

data/paperclip-imgur.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'paperclip-imgur'
+  gem.version       = '0.1.0'
+  gem.authors       = ['Daniel Cruz Horts']
+  gem.description   = %q{Extends Paperclip with Imgur storage}
+  gem.summary       = gem.description
+  gem.homepage      = 'https://github.com/dncrht/paperclip-imgur'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'imgurapi', '~> 2.0.1'
+end

data/spec/paperclip/storage/imgur_spec.rb

@@ -0,0 +1,95 @@
+require 'paperclip-imgur'
+require 'active_record'
+
+class CreateUsers < ActiveRecord::Migration
+  self.verbose = false
+
+  def change
+    create_table :users do |t|
+      t.attachment :avatar
+    end
+  end
+end
+
+describe Paperclip::Storage::Imgur do
+  before(:all) do
+    ActiveRecord::Base.send(:include, Paperclip::Glue)
+
+    FileUtils.rm_rf 'tmp'
+    FileUtils.mkdir_p 'tmp'
+    ActiveRecord::Base.establish_connection('sqlite3:///tmp/foo.sqlite3')
+    CreateUsers.migrate(:up)
+
+    Paperclip.options[:log] = false
+  end
+  
+  describe '#parse_credentials' do
+    def set_options(options)
+      stub_const('User', Class.new(ActiveRecord::Base) {
+          has_attached_file :avatar, { :storage => :imgur }.merge(options)
+        })
+    end
+
+    it 'should complain when providing unsuitable credentials' do
+      set_options(:imgur_credentials => 1)
+      expect { User.new.avatar }.to raise_error
+
+      set_options(:imgur_credentials => {})
+      expect { User.new.avatar }.to raise_error
+    end
+    
+    it 'should accept a properly formed hash' do
+      set_options(:imgur_credentials => {:app_key => '1', :app_secret => '2', :access_token => '3', :access_token_secret => '4'})
+      expect { User.new.avatar }.to_not raise_error
+    end
+
+    it 'should use config/imgur.yml under a Rails application if we left credentials blank' do
+      stub_const('Rails', Class.new {
+          def self.env
+            'testing'
+          end
+          def self.root
+            Dir.pwd
+          end
+        })
+
+      set_options({})
+      expect { User.new.avatar }.to_not raise_error
+    end
+    
+    it 'should accept a file path' do
+      set_options(:imgur_credentials => "#{Dir.pwd}/config/imgur.yml")
+      expect { User.new.avatar }.to_not raise_error
+    end
+    
+    it 'should accept a file' do
+      set_options(:imgur_credentials => File.open("#{Dir.pwd}/config/imgur.yml", 'r'))
+      expect { User.new.avatar }.to_not raise_error
+    end
+  end
+  
+  describe '#url' do
+    before(:each) do
+      stub_const('User', Class.new(ActiveRecord::Base) { has_attached_file :avatar, :storage => :imgur, :imgur_credentials => {:app_key => '1', :app_secret => '2', :access_token => '3', :access_token_secret => '4'} })
+
+      @imgur_hash = 'random_valid_hash'
+      @user = User.create(:avatar_file_name => @imgur_hash)
+    end
+
+    it "should return the missing image path if there's no image" do
+      User.new.avatar.url.should eq('/avatars/original/missing.png')
+      User.new.avatar.url(:random_size).should eq('/avatars/random_size/missing.png')
+    end
+
+    it "should return Imgur's image paths if there's an image" do
+      session = @user.avatar.instance_variable_get(:@imgur_session)
+      
+      @user.avatar.url.should eq(session.url(@imgur_hash))
+      @user.avatar.url(:random_size).should eq(session.url(@imgur_hash, :random_size))
+      @user.avatar.url(:small_square).should eq(session.url(@imgur_hash, :small_square))
+      @user.avatar.url(:large_thumbnail).should eq(session.url(@imgur_hash, :large_thumbnail))
+    end
+    
+  end
+  
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: paperclip-imgur
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Cruz Horts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: imgurapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: Extends Paperclip with Imgur storage
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/imgur.yml
+- lib/paperclip-imgur.rb
+- lib/paperclip/imgur.rb
+- lib/paperclip/storage/imgur.rb
+- paperclip-imgur.gemspec
+- spec/paperclip/storage/imgur_spec.rb
+homepage: https://github.com/dncrht/paperclip-imgur
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Extends Paperclip with Imgur storage
+test_files:
+- spec/paperclip/storage/imgur_spec.rb
+has_rdoc: