paperclip-googledrive-new 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0fe5f090fad771e4faddaf9fe0115b56f9d81c91
+  data.tar.gz: 0a6f678018c2705defde95f0f4147f39a188d875
+SHA512:
+  metadata.gz: e9ed10cf2bafe7502c1b6e59a9a375fffebf50a5400de3c4e80f1b74c2b9f27d8280679d8c525bc00b818d236221aeff742dda584a27d1b57e9f2aaa5985a2e6
+  data.tar.gz: 2dde2fa5c5e546b694e1d9af75f891a1b277c2678f17bad77af6a50b384d67ead11b5c674beb1bdb150e7ea709602619aa5bb28b22ea132f0c33b154ae8e2750

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ivan
+
+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,103 @@
+# PaperclipGoogledrive
+[![Gem Version](https://badge.fury.io/rb/paperclip-googledrive.png)](http://badge.fury.io/rb/paperclip-googledrive)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/evinsou/paperclip-googledrive)
+
+PaperclipGoogledrive is a gem that extends paperclip storage for Google Drive. Works with Rails 3.x && RAILS 4x.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'paperclip-googledrive-new'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install paperclip-googledrive-new
+
+## Google Drive Setup
+
+Google Drive is a free service for file storage files. In order to use this storage you have to create oauth 2.0 client in [Google APIs console](https://code.google.com/apis/console/) and authorize access to Google Drive account.
+
+After creating your app, it will have an Client ID, Client Secret, Redirect URL. Get auth scope for drive [Google Drive scopes](https://developers.google.com/drive/scopes). You need these for the authorization Rake task:
+```
+$ rake google_drive:authorize
+```
+When you call this Rake task, it will ask you to provide the client id, client secret, redirect url and auth scope. Afterwards it will present you with an authorize url on Google Drive. Simply go to that url, authorize the app, then enter code from url in the console. The rake task will output valid ruby code which you can use to create a client.
+
+## Configuration
+
+Example:
+```ruby
+class Product < ActiveRecord::Base
+ has_attached_file :photo,
+    :storage => :google_drive,
+    :google_drive_credentials => "#{Rails.root}/config/google_drive.yml"
+end
+```
+The `:google_drive_credentials` option
+
+This can be a hash or path to a YAML file containing the keys listed in the example below. These are obtained from your Google Drive app settings and the authorization Rake task.
+
+Example `config/google_drive.yml`:
+```erb
+client_id: <%= ENV["CLIENT_ID"] %>
+client_secret: <%= ENV["CLIENT_SECRET"] %>
+access_token: <%= ENV["ACCESS_TOKEN"] %>
+refresh_token: <%= ENV["REFRESH_TOKEN"] %>
+```
+It is good practice to not include the credentials directly in the YAML file. Instead you can set them in environment variables and embed them with ERB.
+
+## Options
+
+The `:google_drive_options` option
+
+This is a hash containing any of the following options:
+ - `:path` – block, works similarly to Paperclip's `:path` option
+ - `:public_folder_id`- id of folder that must be created in google drive and set public permessions on it
+ - `:default_image` - an image in Public folder that used for attachemnts if attachement is not present
+
+The :path option should be a block that returns a path that the uploaded file should be saved to. The block yields the attachment style and is executed in the scope of the model instance. For example:
+```ruby
+class Product < ActiveRecord::Base
+  has_attached_file :photo,
+    :storage => :google_drive,
+    :google_drive_credentials => "#{Rails.root}/config/google_drive.yml",
+    :styles => { :medium => "300x300" },
+    :google_drive_options => {
+      :path => proc { |style| "#{style}_#{id}_#{photo.original_filename}" }
+    }
+end
+```
+For example, a new product is created with the ID of 14, and a some_photo.jpg as its photo. The following files would be saved to the Google Drive:
+
+Public/14_some_photo.jpg
+Public/14_some_photo_medium.jpg
+
+The another file is called some_photo_medium.jpg because style names (other than original) will always be appended to the filenames, for better management.
+
+## Misc
+
+Useful links
+[Google APIs console](https://code.google.com/apis/console/)
+
+[Google Drive scopes](https://developers.google.com/drive/scopes)
+
+[Enable the Drive API and SDK](https://developers.google.com/drive/enable-sdk)
+
+[Quickstart](https://developers.google.com/drive/quickstart-ruby#step_1_enable_the_drive_api)
+
+## License
+
+[MIT License](https://github.com/shoaibmalik786/paperclip-googledrive-new/blob/master/LICENSE)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/paperclip-googledrive-new.rb

@@ -0,0 +1,3 @@
+
+require 'paperclip'
+require 'paperclip/google_drive'

data/lib/paperclip/google_drive.rb

@@ -0,0 +1,2 @@
+require "paperclip/storage/google_drive"
+require "paperclip/google_drive/railtie" if defined?(Rails)

data/lib/paperclip/google_drive/railtie.rb

@@ -0,0 +1,10 @@
+
+module Paperclip
+  module GoogleDrive
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        load "paperclip/google_drive/tasks.rake"
+      end
+    end
+  end
+end

data/lib/paperclip/google_drive/rake.rb

@@ -0,0 +1,51 @@
+
+require 'google/api_client'
+
+module Paperclip
+  module GoogleDrive
+    module Rake
+      extend self
+
+      def authorize
+        puts 'Enter client ID:'
+        client_id = $stdin.gets.chomp
+        puts 'Enter client SECRET:'
+        client_secret = $stdin.gets.chomp.strip
+#        puts 'Enter SCOPE:'
+#        oauth_scope = $stdin.gets.chomp.strip
+        oauth_scope = ['https://www.googleapis.com/auth/drive', 'https://www.googleapis.com/auth/userinfo.profile']
+        puts 'Enter redirect URI:'
+        redirect_uri = $stdin.gets.chomp.strip
+
+        # Create a new API client & load the Google Drive API
+        client = Google::APIClient.new(:application_name => 'ppc-gd', :application_version => PaperclipGoogleDrive::VERSION)
+        drive = client.discovered_api('drive', 'v2')
+
+        client.authorization.client_id = client_id
+        client.authorization.client_secret = client_secret
+        client.authorization.scope = oauth_scope
+        client.authorization.redirect_uri = redirect_uri
+
+        # Request authorization
+        uri = client.authorization.authorization_uri.to_s
+        puts "\nGo to this url:"
+        puts client.authorization.authorization_uri.to_s
+        puts "\n Accept the authorization request from Google in your browser"
+
+        puts "\n\n\n Google will redirect you to localhost, but just copy the code parameter out of the URL they redirect you to, paste it here and hit enter:\n"
+
+        code = $stdin.gets.chomp.strip
+        client.authorization.code = code
+        client.authorization.fetch_access_token!
+
+        puts "\nAuthorization completed.\n\n"
+        puts "client = Google::APIClient.new"
+        puts "client.authorization.client_id = '#{client_id}'"
+        puts "client.authorization.client_secret = '#{client_secret}'"
+        puts "client.authorization.access_token = '#{client.authorization.access_token}'"
+        puts "client.authorization.refresh_token = '#{client.authorization.refresh_token}'"
+        puts "\n"
+      end
+    end
+  end
+end

data/lib/paperclip/google_drive/tasks.rake

@@ -0,0 +1,10 @@
+
+require "paperclip/google_drive/rake"
+
+namespace :google_drive do
+  desc "Authorize Google Drive account: "
+  task :authorize do
+    Paperclip::GoogleDrive::Rake.authorize
+  end
+end
+

data/lib/paperclip/storage/google_drive.rb

@@ -0,0 +1,256 @@
+
+require 'active_support/core_ext/hash/keys'
+require 'active_support/inflector/methods'
+require 'active_support/core_ext/object/blank'
+require 'yaml'
+require 'erb'
+require 'google/api_client'
+
+module Paperclip
+
+  module Storage
+      # * self.extended(base) add instance variable to attachment on call
+      # * url return url to show on site with style options
+      # * path(style) return title that used to insert file to store or find it in store
+      # * public_url_for title  return url to file if find by title or url to default image if set
+      # * search_for_title(title) take title, search in given folder and if it finds a file, return id of a file or nil
+      # * metadata_by_id(file_i get file metadata from store, used to back url or find out value of trashed
+      # * exists?(style)  check either exists file with title or not
+      # * default_image  return url to default url if set in option
+      # * find_public_folder return id of Public folder, must be in options
+      # return id of Public folder, must be in options
+      # * file_tit return base pattern of title or custom one set by user
+      # * parse_credentials(credenti get credentials from file, hash or path
+      # * assert_required_keys  check either all ccredentials keys is set
+      # * original_extension  return extension of file
+
+    module GoogleDrive
+
+      def self.extended(base)
+        begin
+          require 'google-api-client'
+        rescue LoadError => e
+          e.message << " (You may need to install the google-api-client gem)"
+          raise e
+        end unless defined?(Google)
+
+        base.instance_eval do
+          @google_drive_credentials = parse_credentials(@options[:google_drive_credentials] || {})
+          @google_drive_options = @options[:google_drive_options] || {}
+          google_api_client # Force validations of credentials
+        end
+      end
+      #
+      def flush_writes
+        @queued_for_write.each do |style, file|
+          if exists?(path(style))
+            raise FileExists, "file \"#{path(style)}\" already exists in your Google Drive"
+          else
+            #upload(style, file) #style file
+            client = google_api_client
+            drive = client.discovered_api('drive', 'v2')
+            result = client.execute(
+              :api_method => drive.files.get,
+              :parameters => { 'fileId' => @google_drive_options[:public_folder_id],
+                              'fields' => '  id, title' })
+            client.authorization.access_token = result.request.authorization.access_token
+            client.authorization.refresh_token = result.request.authorization.refresh_token
+            title, mime_type = title_for_file(style), "#{content_type}"
+            parent_id = @google_drive_options[:public_folder_id] # folder_id for Public folder
+            metadata = drive.files.insert.request_schema.new({
+              'title' => title, #if it is no extension, that is a folder and another folder
+              'description' => 'paperclip file on google drive',
+              'mimeType' => mime_type })
+            if parent_id
+              metadata.parents = [{'id' => parent_id}]
+            end
+            media = Google::APIClient::UploadIO.new( file, mime_type)
+            result = client.execute(
+              :api_method => drive.files.insert,
+              :body_object => metadata,
+              :media => media,
+              :parameters => {
+                'uploadType' => 'multipart',
+                'alt' => 'json' })
+          end
+        end
+        after_flush_writes
+        @queued_for_write = {}
+      end
+      #
+      def flush_deletes
+        @queued_for_delete.each do |path|
+          Paperclip.log("delete #{path}")
+          client = google_api_client
+          drive = client.discovered_api('drive', 'v2')
+          file_id = search_for_title(path)
+          unless file_id.nil?
+            folder_id = find_public_folder
+            parameters = {'fileId' => file_id,
+                          'folder_id' => folder_id }
+            result = client.execute(
+              :api_method => drive.files.delete,
+              :parameters => parameters)
+            if result.status != 200
+              puts "An error occurred: #{result.data['error']['message']}"
+            end
+          end
+        end
+        @queued_for_delete = []
+      end
+      #
+      def google_api_client
+        @google_api_client ||= begin
+          assert_required_keys
+        # Initialize the client & Google+ API
+          client = Google::APIClient.new(:application_name => 'ppc-gd', :application_version => PaperclipGoogleDrive::VERSION)
+#          client = Google::APIClient.new(:application_name => @google_drive_credentials[:application_name], :application_version => @google_drive_credentials[:application_version])
+          client.authorization.client_id = @google_drive_credentials[:client_id]
+          client.authorization.client_secret = @google_drive_credentials[:client_secret]
+          client.authorization.access_token = @google_drive_credentials[:access_token]
+          client.authorization.refresh_token = @google_drive_credentials[:refresh_token]
+          client
+        end
+      end
+      #
+      def google_drive
+        client = google_api_client
+        drive = client.discovered_api('drive', 'v2')
+        drive
+      end
+
+      def url(*args)
+        if present?
+          style = args.first.is_a?(Symbol) ? args.first : default_style
+          options = args.last.is_a?(Hash) ? args.last : {}
+          public_url_for(path(style))
+        else
+          default_image
+        end
+      end
+
+      def path(style)
+        title_for_file(style)
+      end
+
+      def title_for_file(style)
+        file_name = instance.instance_exec(style, &file_title)
+        style_suffix = (style != default_style ? "_#{style}" : "")
+        if original_extension.present? && file_name =~ /#{original_extension}$/
+          file_name.sub(original_extension, "#{style_suffix}#{original_extension}")
+        else
+          file_name + style_suffix + original_extension.to_s
+        end
+      end # full title
+
+      def public_url_for title
+        searched_id = search_for_title(title) #return id if any or style
+        if searched_id.nil? # it finds some file
+          default_image
+        else
+          metadata = metadata_by_id(searched_id)
+          metadata['webContentLink']
+        end
+      end # url
+      # take title, search in given folder and if it finds a file, return id of a file or nil
+      def search_for_title(title)
+        parameters = {
+                'folderId' => find_public_folder,
+                'q' => "title contains '#{title}'", # full_title
+                'fields' => 'items/id'}
+        client = google_api_client
+        drive = client.discovered_api('drive', 'v2')
+        result = client.execute(:api_method => drive.children.list,
+                          :parameters => parameters)
+        if result.status == 200
+          if result.data.items.length > 0
+            result.data.items[0]['id']
+          elsif result.data.items.length == 0
+            nil
+          else
+            nil
+          end
+        end
+      end # id or nil
+
+      def metadata_by_id(file_id)
+        if file_id.is_a? String
+          client = google_api_client
+          drive = client.discovered_api('drive', 'v2')
+          result = client.execute(
+            :api_method => drive.files.get,
+            :parameters => {'fileId' => file_id,
+                            'fields' => 'title, id, webContentLink, labels/trashed' })
+          if result.status == 200
+            result.data # data.class # => Hash
+          end
+        end
+      end
+
+      def exists?(style = default_style)
+        return false if not present?
+        result_id = search_for_title(path(style))
+        if result_id.nil?
+          false
+        else
+          data_hash = metadata_by_id(result_id)
+          !data_hash['labels']['trashed'] # if trashed -> not exists
+        end
+      end
+
+      def default_image
+        if @google_drive_options[:default_url] #if default image is set
+          title = @google_drive_options[:default_url]
+          searched_id = search_for_title(title) # id
+          metadata = metadata_by_id(searched_id) unless searched_id.nil?
+          metadata['webContentLink']
+        else
+          'No picture' # ---- ?
+        end
+      end
+
+      def find_public_folder
+        unless @google_drive_options[:public_folder_id]
+          raise KeyError, "you must set a Public folder if into options"
+        end
+        @google_drive_options[:public_folder_id]
+      end
+      class FileExists < ArgumentError
+      end
+      private
+
+        def file_title
+          return @google_drive_options[:path] if @google_drive_options[:path] #path: proc
+          eval %(proc { |style| "\#{id}_\#{#{name}.original_filename}"})
+        end
+
+        def parse_credentials(credentials)
+          result =
+            case credentials
+            when File
+              YAML.load(ERB.new(File.read(credentials.path)).result)
+            when String, Pathname
+              YAML.load(ERB.new(File.read(credentials)).result)
+            when Hash
+              credentials
+            else
+              raise ArgumentError, ":google_drive_credentials are not a path, file, nor a hash"
+            end
+          result.symbolize_keys #or string keys
+        end
+        # check either all ccredentials keys is set
+        def assert_required_keys
+          keys_list = [:client_id, :client_secret, :access_token, :refresh_token]
+          keys_list.each do |key|
+            @google_drive_credentials.fetch(key)
+          end
+        end
+        # return extension of file
+        def original_extension
+          File.extname(original_filename)
+        end
+    end
+
+  end
+
+end

data/lib/paperclip/version.rb

@@ -0,0 +1,3 @@
+module PaperclipGoogleDrive
+  VERSION = "1.0"
+end

data/paperclip-googledrive-new.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+#require File.expand_path('../lib/paperclip_googledrive/version', __FILE__)
+$:.push File.expand_path("../lib", __FILE__)
+require "paperclip/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "paperclip-googledrive-new"
+  spec.version       = PaperclipGoogleDrive::VERSION
+  spec.authors       = ['Shoaib Malik']
+  spec.email         = ["shoaib2109@gmail.com"]
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  end
+
+  spec.summary       = %q{Extends Paperclip with Google Drive storage with latest version of paperclip}
+  spec.description   = %q{paperclip-googledrive-new extends paperclip support of storage for google drive storage}
+  spec.homepage      = "https://github.com/shoaibmalik786/paperclip-googledrive-new"
+
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.files         = Dir["lib/**/*"] + ["README.md", "LICENSE", "paperclip-googledrive-new.gemspec"]
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.0.0"
+  spec.license       = "MIT"
+
+  spec.add_dependency "paperclip"
+  spec.add_dependency 'google-api-client', "~> 0.5"
+
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: paperclip-googledrive-new
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Shoaib Malik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: paperclip-googledrive-new extends paperclip support of storage for google
+  drive storage
+email:
+- shoaib2109@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/paperclip-googledrive-new.rb
+- lib/paperclip/google_drive.rb
+- lib/paperclip/google_drive/railtie.rb
+- lib/paperclip/google_drive/rake.rb
+- lib/paperclip/google_drive/tasks.rake
+- lib/paperclip/storage/google_drive.rb
+- lib/paperclip/version.rb
+- paperclip-googledrive-new.gemspec
+homepage: https://github.com/shoaibmalik786/paperclip-googledrive-new
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.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 Google Drive storage with latest version of paperclip
+test_files: []
+has_rdoc: