paperclip-google-drive 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69f1e775714355167b9e85e90dfd7253f1d8b20d
-  data.tar.gz: 56a69a0462cccee0ba272ecc6cfd6ca857ca0e3b
+  metadata.gz: 06f945a112a7fc9c7edc1c8b925bb957011f26ba
+  data.tar.gz: 7ff404b4f10d203c306efebe144ca86e5f449a06
 SHA512:
-  metadata.gz: 115f4d3fb27f33dd9d21a48a377e7b3445dfb817778464c91dabf8d9cf8ab56952f5cc53ddce1d1ab94f9b852aa51f53adee01afe51d41abebc5e73ea69a3178
-  data.tar.gz: afb020197387bc07cec4cc69df47600adb46eb7f8ab54ead3f59dedbd41de49d75f7b3793b2df1729cbfdce2e6466cb88316ac36dd05c40f81817a8c7696c8cb
+  metadata.gz: c228c2ff00f14992a98974fb94d4da90e230d7b357feb93ab4805f49923ceec9a2aeb09922b0b7fd53107c788673ff46fc261539ce3db6683c2223f3716ed64f
+  data.tar.gz: 68d6878eea81fb2b9fec1607ad32a77f932c1e0199ba0630ac506833b9f88b10aafe7b42b1ad9f1ea1c3380b217c4451bd1af5a8026ee74b32e1f0ca29570f6f

data/lib/paperclip/google_drive/session.rb

@@ -32,47 +32,76 @@ module Paperclip
       #   scope
       #   scope=
       #   save
-      def self.from_config(config, options = {})
-        fail(ArgumentError, 'You must to specified the application_name option') unless options[:application_name]
-
-        if config.is_a?(String)
-          config = Paperclip::GoogleDrive::Config.new(config)
+      class << self
+        def from_config(config_path, options = {})
+          validate_options(options)
+          config = get_cofiguration(config_path, options)
+          credentials = Google::Auth::UserRefreshCredentials.new(
+            client_id: config.client_id,
+            client_secret: config.client_secret,
+            scope: config.scope,
+            redirect_uri: 'urn:ietf:wg:oauth:2.0:oob'
+          )
+          if config.refresh_token
+            credentials.refresh_token = config.refresh_token
+            credentials.fetch_access_token!
+          else
+            $stderr.print("\n1. Open this page:\n%s\n\n" % credentials.authorization_uri)
+            $stderr.print('2. Enter the authorization code shown in the page: ')
+            credentials.code = $stdin.gets.chomp
+            credentials.fetch_access_token!
+            config.refresh_token = credentials.refresh_token
+          end
+          config.save
+          init_drive_service(options[:application_name], credentials)
         end
 
-        config.scope ||= DEFAULT_SCOPE
-
-        if options[:client_id] && options[:client_secret]
-          config.client_id = options[:client_id]
-          config.client_secret = options[:client_secret]
-        elsif (options[:client_id] && !options[:client_secret]) ||
-                (!options[:client_id] && options[:client_secret])
-          fail(ArgumentError, 'client_id and client_secret must be both specified or both omitted')
+        # @param config_path [ String ]
+        # @param options [ Hash ]
+        # @return [ Paperclip::GoogleDrive::Config ]
+        def get_cofiguration(config_path, options)
+          if config_path.is_a?(String)
+            config = Paperclip::GoogleDrive::Config.new(config_path)
+          else
+            raise(ArgumentError, 'You must set a valid config_path path')
+          end
+          config.scope ||= DEFAULT_SCOPE
+          config_from_options(config, options)
         end
 
-        credentials = Google::Auth::UserRefreshCredentials.new(
-          client_id: config.client_id,
-          client_secret: config.client_secret,
-          scope: config.scope,
-          redirect_uri: 'urn:ietf:wg:oauth:2.0:oob')
+        # @param options [ Hash ]
+        # @param  config [ Paperclip::GoogleDrive::Config ]
+        # @return [ Paperclip::GoogleDrive::Config ]
+        def config_from_options(config, options)
+          if options[:client_id] && options[:client_secret]
+            config.client_id = options[:client_id]
+            config.client_secret = options[:client_secret]
+          end
+          config
+        end
 
-        if config.refresh_token
-          credentials.refresh_token = config.refresh_token
-          credentials.fetch_access_token!
-        else
-          $stderr.print("\n1. Open this page:\n%s\n\n" % credentials.authorization_uri)
-          $stderr.print('2. Enter the authorization code shown in the page: ')
-          credentials.code = $stdin.gets.chomp
-          credentials.fetch_access_token!
-          config.refresh_token = credentials.refresh_token
+        # @param options [ Hash ]
+        def validate_options(options)
+          raise(ArgumentError, 'You must specify the application_name option') unless options[:application_name]
+          raise(ArgumentError, 'client_id and client_secret must be both specified or both omitted') if invalid_client_options?(options)
         end
 
-        config.save
+        # @param options [ Hash ]
+        # @return [ Boolean ]
+        def invalid_client_options?(options)
+          (options[:client_id] && !options[:client_secret]) || (!options[:client_id] && options[:client_secret])
+        end
 
-        # Initialize the API
-        client = Google::Apis::DriveV3::DriveService.new
-        client.client_options.application_name = options[:application_name]
-        client.authorization = credentials
-        client
+        # @param application_name [ String ]
+        # @param credentials [ Google::Auth::UserRefreshCredentials ]
+        # @return [ Google::Apis::DriveV3::DriveService ]
+        def init_drive_service(application_name, credentials)
+          # Initialize the API
+          client = Google::Apis::DriveV3::DriveService.new
+          client.client_options.application_name = application_name
+          client.authorization = credentials
+          client
+        end
       end
     end
   end

data/lib/paperclip/google_drive/tasks.rake

@@ -2,7 +2,7 @@ require "paperclip/google_drive/rake"
 
 namespace :google_drive do
   desc "Authorize Google Drive account: "
-  task :authorize, [:client_secret_path, :application_name] do |t, args|
+  task :authorize, [:client_secret_path, :application_name] do |_t, args|
     client_secret_path = args[:client_secret_path]
     application_name = args[:application_name]
     Paperclip::GoogleDrive::Rake.authorize(client_secret_path, application_name)

data/lib/paperclip/storage/google_drive.rb

@@ -11,44 +11,48 @@ require 'paperclip/google_drive/session'
 require 'fileutils'
 
 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_title return base pattern of title or custom one set by user
-      # * original_extension  return extension of file
-
+    # * 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_title return base pattern of title or custom one set by user
+    # * 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_client_secret_path = @options[:google_drive_client_secret_path]
-          @google_drive_options = @options[:google_drive_options] || { application_name: 'test-app' }
-          fail(ArgumentError, 'You must to provide a valid google_drive_client_secret_path option') unless @google_drive_client_secret_path
-          google_api_client # Force validations of credentials
+      class << self
+        def extended(base)
+          check_gem_is_installed
+          base.instance_eval do
+            @google_drive_client_secret_path = @options[:google_drive_client_secret_path]
+            @google_drive_options = @options[:google_drive_options] || { application_name: 'test-app' }
+            raise(ArgumentError, 'You must provide a valid google_drive_client_secret_path option') unless @google_drive_client_secret_path
+            raise(ArgumentError, 'You must set the public_folder_id option') unless @google_drive_options[:public_folder_id]
+            google_api_client # Force validations of credentials
+          end
+        end
+
+        def check_gem_is_installed
+          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)
         end
       end
 
-      #
+      # Main process to upload a file
       def flush_writes
         @queued_for_write.each do |style, file|
           raise FileExists, "file \"#{path(style)}\" already exists in your Google Drive" if exists?(path(style))
 
-          name, mime_type = name_for_file(style), "#{ file.content_type }"
+          name, mime_type = name_for_file_from(style), "#{ file.content_type }"
 
           file_metadata = {
             name: name,
@@ -57,7 +61,7 @@ module Paperclip
             parents: [find_public_folder]
           }
 
-          result = google_api_client.create_file(
+          google_api_client.create_file(
             file_metadata,
             fields: 'id',
             upload_source: file.binmode,
@@ -68,12 +72,12 @@ module Paperclip
         @queued_for_write = {}
       end
 
-      #
+      # Process to destroy a file
       def flush_deletes
         @queued_for_delete.each do |path|
-          Paperclip.log("Delete: #{path}")
+          Paperclip.log("Delete: #{ path }")
           file_id = search_for_title(path)
-          result = google_api_client.delete_file(file_id) unless file_id.nil?
+          google_api_client.delete_file(file_id) unless file_id.nil?
         end
         @queued_for_delete = []
       end
@@ -91,21 +95,37 @@ module Paperclip
 
       alias_method :google_drive, :google_api_client
 
+      # This could be used to scale image as Google does. e.i. `<url>=s220`,
+      # where 220 is the width in pixeles OR as Paperclip does.
+      # @params args [ Array ]
+      # @return [ String ]
+      #  ex.
+      #     1. If you want the medium version of your image (Paperclip way)
+      #       some_model.avatar.url(:medium)
+      #     2. If you want a custom version of your image/pdf (Google way)
+      #       some_model.avatar.url(:custom, width: 500)
       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))
+          if style == :custom
+            custom_width = options[:width] || 220
+            file_name = name_for_file_from(default_style)
+          else
+            custom_width = nil
+            file_name = name_for_file_from(style)
+          end
+
+          public_url_for(file_name, custom_width)
         else
           default_image
         end
       end
 
-      def path(style)
-        name_for_file(style)
-      end
-
-      def name_for_file(style)
+      # Gets full title/name
+      # @param style [ String ]
+      # @return [ String ]
+      def name_for_file_from(style)
         file_name = instance.instance_exec(style, &file_title)
         style_suffix = (style != default_style ? "_#{style}" : "")
         if original_extension.present? && file_name =~ /#{original_extension}$/
@@ -113,26 +133,37 @@ module Paperclip
         else
           file_name + style_suffix + original_extension.to_s
         end
-      end # full title
+      end
+
+      alias_method :path, :name_for_file_from
 
       # Gets the public url for a passed filename
       # @param title [ String ]
+      # @param custom_width [ Integer ]
       # @return [ String ] with url
-      def public_url_for(title)
+      def public_url_for(title, custom_width)
         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)
-          full_image_for(metadata.thumbnail_link) #web_content_link #or metadata.web_view_link?
+          custom_image_for(metadata.thumbnail_link, custom_width)
         end
       end
 
-      # Removes the last parameter `=s220` which is inchaged to scale the retrieved image
+      # Retrieves the specific image with a custom size. It is resized by GDrive API if you
+      # pass the :custom as style option. In other cases it removes the last parameter `=s220`
+      # which is inchaged to do the scaling process.
       # @param drive_thumbnail_link [ String ]
+      # @param custom_width [ Integer ]
       # @return [ String ]
-      def full_image_for(drive_thumbnail_link)
-        drive_thumbnail_link.split(/=s/)[0]
+      def custom_image_for(drive_thumbnail_link, custom_width=nil)
+        file_url, current_width = drive_thumbnail_link.split(/=s/)
+        new_file_url = if custom_width.nil?
+                        file_url
+                      else
+                        "#{ file_url }=s#{ custom_width }"
+                      end
       end
 
       # Takes the file title/name and search it in a given folder
@@ -146,26 +177,37 @@ module Paperclip
                 q: "name contains '#{ name }' and '#{ find_public_folder }' in parents",
                 fields: 'files(id, name)'
                 )
-        if result.files.length > 0 # TODO: change these coditionals
+        if result.files.length > 0
           result.files[0].id
         else
           nil
         end
       end
 
+      # Gets a file from GDrive
       # @parent file_id [ String ]
       # @return [ Google::Apis::DriveV3::File ]
       def metadata_by_id(file_id)
         if file_id.is_a? String
           client = google_api_client
-          result = client.get_file(
+          metadata = client.get_file(
                     file_id,
                     fields: 'id, name, thumbnailLink'
                     )
-          result
+          validate_metadata(metadata)
+          metadata
         end
       end
 
+      # Raises an error in case that the Google Drive API does not response
+      # with the minimum required information.
+      # @params [ Google::Apis::DriveV3::File ]
+      def validate_metadata(metadata)
+        raise 'the file id was not retrieved' if metadata.id.nil?
+        raise 'the file name was not retrieved' if metadata.name.nil?
+        raise 'the file thumbnail_link was not retrieved' if metadata.thumbnail_link.nil?
+      end
+
       # Checks if the image already exits
       # @param style [ String ]
       # @return [ Boolean ]
@@ -185,14 +227,13 @@ module Paperclip
           title = @google_drive_options[:default_url]
           searched_id = search_for_title(title) # id
           metadata = metadata_by_id(searched_id) unless searched_id.nil?
-          full_image_for(metadata.thumbnail_link) #web_view_link #web_content_link
+          custom_image_for(metadata.thumbnail_link)
         else
           'No picture' # ---- ?
         end
       end
 
       def find_public_folder
-        raise KeyError, "You must set the public_folder_id option" unless @google_drive_options[:public_folder_id]
         if @google_drive_options[:public_folder_id].is_a? Proc
           instance.instance_exec(&@google_drive_options[:public_folder_id])
         else

data/lib/paperclip/version.rb

@@ -1,3 +1,3 @@
 module PaperclipGoogleDrive
-  VERSION = "0.2.4"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paperclip-google-drive
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Diego Gomez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-15 00:00:00.000000000 Z
+date: 2016-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paperclip