paperclip-googledrive 0.0.1 → 0.1.2

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Ivan
+Copyright (c) 2013 Ivan
 
 MIT License
 

data/README.md

@@ -1,7 +1,7 @@
+
 # PaperclipGoogledrive
- --- WORK IN PROGRESS ---
 
-PaperclipGoogledrive is a gem that extends paperclip storage for Google Drive.
+PaperclipGoogledrive is a gem that extends paperclip storage for Google Drive. Works with Rails 3.x.
 
 ## Installation
 
@@ -17,12 +17,81 @@ Or install it yourself as:
 
     $ gem install paperclip-googledrive
 
-## Usage
+## 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
+ - `: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)
 
-May be available soon.
+## License
 
-Add to class
-has_attach_file method and descript name of attachemnt, set storage to google drive and set credentials and options.
+[MIT License](https://github.com/evinsou/paperclip-googledrive/blob/master/LICENSE)
 
 ## Contributing
 
@@ -31,3 +100,6 @@ has_attach_file method and descript name of attachemnt, set storage to google dr
 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
+=======
+paperclip-googledrive
+=====================

data/lib/paperclip/version.rb

@@ -1,3 +1,3 @@
 module PaperclipGoogleDrive
-  VERSION = "0.0.1"
+  VERSION = "0.1.2"
 end

data/paperclip-googledrive.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |gem|
 
   gem.summary       = %q{Extends Paperclip with Google Drive storage}
   gem.description   = %q{paperclip-googledrive extends paperclip support of storage for google drive storage}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/evinsou/paperclip-googledrive"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = Dir["lib/**/*"] + ["README.md", "LICENSE", "paperclip-googledrive.gemspec"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paperclip-googledrive
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -77,7 +77,7 @@ files:
 - README.md
 - LICENSE
 - paperclip-googledrive.gemspec
-homepage: ''
+homepage: https://github.com/evinsou/paperclip-googledrive
 licenses:
 - MIT
 post_install_message: