carrierwave-google-storage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3fe891849a61908e41b35c935710bc4a569a5734
+  data.tar.gz: 4bb3cbf64e11b7d0332a31c704866119942469ea
+SHA512:
+  metadata.gz: 09e09763d724d810621724e3f7dd3acfa2b257449232a0196598f041e79bceb6bb9cf74a278e8af0bc743168ab99f253f17cf173b6689e04b0d7b785d70c8a90
+  data.tar.gz: 106287b9e00fa42557e2af14da8b22b12c4221810790f1c42ceeefdc168c921dd7ed312f83bebf327e5faf1964c0fd12917cd45dd3e075154d21b27f6442a75d

data/.env.sample

@@ -0,0 +1,2 @@
+GCLOUD_PROJECT=
+GCLOUD_BUCKET=

data/.gcp-keyfile.sample.json

@@ -0,0 +1,12 @@
+{
+  "type": "service_account",
+  "project_id": "",
+  "private_key_id": "",
+  "private_key": "",
+  "client_email": "",
+  "client_id": "",
+  "auth_uri": "",
+  "token_uri": "",
+  "auth_provider_x509_cert_url": "",
+  "client_x509_cert_url": ""
+}

data/.gitignore

@@ -0,0 +1,15 @@
+*.gem
+.env
+/bin
+/vendor
+/uploads
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.gcp-keyfile.json

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.12.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jasdeep Singh
+
+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,84 @@
+# Carrierwave Google Storage
+
+[![Build Status](https://travis-ci.org/metaware/carrierwave-google-storage.svg?branch=master)](https://travis-ci.org/metaware/carrierwave-google-storage)
+[![Code Climate](https://codeclimate.com/github/metaware/carrierwave-google-storage/badges/gpa.svg)](https://codeclimate.com/github/metaware/carrierwave-google-storage)
+
+Use the official `gcloud` gem by Google for Google Cloud Storage, instead of Fog. 
+
+- No need to activate Interoperable Access on your project.
+- Rely on Google's preferred authentication mechanism. ie: Service Accounts.
+ 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'carrierwave-google-storage'
+```
+
+## Usage
+
+```
+CarrierWave.configure do |config|
+  config.storage                             = :gcloud
+  config.gcloud_bucket                       = 'your-bucket-name'
+  config.gcloud_bucket_is_public             = true
+  config.gcloud_authenticated_url_expiration = 600
+  
+  config.gcloud_attributes = {
+    expires: 600
+  }
+  
+  config.gcloud_credentials = {
+    gcloud_project: 'gcp-project-name',
+    gcloud_keyfile: 'path-to-gcp-keyfile.json'
+  }
+end
+```
+
+## How to get the Keyfile?
+
+To generate a new keyfile, perform the following steps: 
+
+- Go to [Cloud Console > API Manager > Credentials](https://console.cloud.google.com/apis/credentials)
+- Click Create Credentials > Service Account Key
+- Service Account > New Service Account 
+- Give any name for "Service Account Name"
+- Set Key type to JSON
+- Click "Create"
+
+Here's a quick GIF for those who are visual like myself:
+
+![](http://g.recordit.co/VjsK6CAUha.gif)
+
+## Contributing
+
+### Environment Variables and such
+
+You should have access to a Google Cloud Platform account, as you'll need the keyfile and a project ID in order to contribute to the development of this gem. You'll need the the following files:
+
+- `.gcp-keyfile.json` (sample file provided: `.gcp-keyfile.sample.json`)
+- `.env` (sample file provided: `.env.sample`)
+
+If you have any questions, please feel free to open up issues and/or PR's. Contributions are welcomed.
+
+In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality.
+
+You get extra attention, if your PR includes specs/tests.
+
+- Fork or clone the project.
+- Create your feature branch ($ git checkout -b my-new-feature)
+- Install the dependencies by doing: $ bundle install in the project directory.
+- Add your bug fixes or new feature code.
+- New features should include new specs/tests.
+- Bug fixes should ideally include exposing specs/tests.
+- Commit your changes ($ git commit -am 'Add some feature')
+- Push to the branch ($ git push origin my-new-feature)
+- Open your Pull Request! 
+
+## License
+
+Copyright (c) 2016 [Jasdeep Singh](http://jasdeep.ca) ([Metaware Labs Inc](http://metawarelabs.com/))
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/carrierwave-google-storage.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'carrierwave/google/storage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "carrierwave-google-storage"
+  spec.version       = Carrierwave::Google::Storage::VERSION
+  spec.authors       = ["Jasdeep Singh"]
+  spec.email         = ["narang.jasdeep@gmail.com"]
+
+  spec.summary       = %q{Use gcloud for Google Cloud Storage support in CarrierWave.}
+  spec.description   = %q{A slimmer alternative to using Fog for Google Cloud Storage support in CarrierWave. Heavily inspired from carrierwave-aws}
+  spec.homepage      = "https://github.com/metaware/carrierwave-google-cloud"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency 'carrierwave', '~> 0.7'
+  spec.add_dependency 'gcloud', '~> 0.8.0'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10.3"
+  spec.add_development_dependency "uri-query_params", "~> 0.7.1"
+end

data/lib/carrierwave-google-storage.rb

@@ -0,0 +1,23 @@
+require 'gcloud'
+require 'carrierwave'
+require 'carrierwave/google/storage/version'
+require 'carrierwave/storage/gcloud'
+require 'carrierwave/storage/gcloud_file'
+require 'carrierwave/storage/gcloud_options'
+require 'carrierwave/support/uri_filename'
+
+class CarrierWave::Uploader::Base
+  
+  ConfigurationError = Class.new(StandardError)
+
+  add_config :gcloud_attributes
+  add_config :gcloud_bucket
+  add_config :gcloud_bucket_is_public
+  add_config :gcloud_credentials
+  add_config :gcloud_authenticated_url_expiration
+
+  configure do |config|
+    config.storage_engines[:gcloud] = 'CarrierWave::Storage::Gcloud'
+  end
+
+end

data/lib/carrierwave/google/storage/version.rb

@@ -0,0 +1,7 @@
+module Carrierwave
+  module Google
+    module Storage
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/carrierwave/storage/gcloud.rb

@@ -0,0 +1,37 @@
+
+module CarrierWave
+  module Storage
+    class Gcloud < Abstract
+    
+      def self.connection_cache
+        @connection_cache ||= {}
+      end
+
+      def self.clear_connection_cache!
+        @connection_cache = {}
+      end
+      
+      def store!(file)
+        CarrierWave::Storage::GcloudFile.new(uploader, connection, uploader.store_path).tap do |gcloud_file|
+          gcloud_file.store(file)
+        end
+      end
+
+      def retrieve!(identifier)
+        CarrierWave::Storage::GcloudFile.new(uploader, connection, uploader.store_path(identifier)).retrieve
+      end
+
+      def connection
+        @connection ||= begin
+          cert_path = Gem.loaded_specs['google-api-client'].full_gem_path+'/lib/cacerts.pem'
+          ENV['SSL_CERT_FILE'] = cert_path
+          self.class.connection_cache[credentials] ||= ::Gcloud.new(credentials[:gcloud_project] || ENV["GCLOUD_PROJECT"], credentials[:gcloud_keyfile] || ENV["GCLOUD_KEYFILE"]).storage
+        end
+      end
+
+      def credentials
+        uploader.gcloud_credentials
+      end
+    end
+  end
+end

data/lib/carrierwave/storage/gcloud_file.rb

@@ -0,0 +1,102 @@
+module CarrierWave
+  module Storage
+    class GcloudFile
+    
+      attr_writer :file
+      attr_accessor :uploader, :connection, :path, 
+        :gcloud_options, :file_exists
+
+      delegate :content_type, :size, to: :file
+
+      def initialize(uploader, connection, path)
+        @uploader    = uploader
+        @connection  = connection
+        @path        = path
+      end
+
+      def file
+        by_verifying_existence { @file ||= bucket.file(path) }
+      end
+      alias_method :to_file, :file
+      
+      def retrieve
+        by_verifying_existence { @file ||= bucket.file(path) }
+        self
+      end
+      
+      def by_verifying_existence(&block)
+        begin
+          self.file_exists = true
+          yield
+        rescue Exception => exception
+          self.file_exists = false if (exception.class == ::Gcloud::Storage::ApiError) && (exception.message == "Not Found")
+          raise exception
+        end
+      end
+
+      def attributes
+        {
+          content_type: file.content_type,
+          size: file.size,
+          updated_at: file.updated_at.to_s,
+          etag: file.etag
+        }
+      end
+      
+      def delete
+        deleted = file.delete
+        self.file_exists = false if deleted
+        deleted
+      end
+      
+      def exists?
+        self.file_exists
+      end
+
+      def extension
+        elements = path.split('.')
+        elements.last if elements.size > 1
+      end
+
+      def filename(options = {})
+        CarrierWave::Support::UriFilename.filename(file.name)
+      end
+
+      def read
+        (file.download file.name, verify: :all).read
+      end
+
+      def store(new_file)
+        bucket.create_file new_file.path, "uploads/" + new_file.filename
+        self
+      end
+
+      def copy_to(new_path)
+        file.copy(new_path)
+      end
+
+      def authenticated_url(options = {})
+        file.signed_url
+      end
+
+      def public_url
+        if uploader.asset_host
+          "#{uploader.asset_host}/#{path}"
+        else
+          file.public_url.to_s
+        end
+      end
+
+      def url(options = {})
+        uploader.gcloud_bucket_is_public ? public_url : authenticated_url
+      end
+
+      private
+
+      def bucket
+        bucket ||= connection.bucket(uploader.gcloud_bucket)
+      end
+
+    end
+  end
+end

data/lib/carrierwave/storage/gcloud_options.rb

@@ -0,0 +1,34 @@
+module CarrierWave
+  module Storage
+    class GcloudOptions
+      attr_reader :uploader
+
+      def initialize(uploader)
+        @uploader = uploader
+      end
+
+      def read_options
+        gcloud_read_options
+      end
+
+      def expiration_options(options = {})
+        uploader_expiration = uploader.gcloud_authenticated_url_expiration
+        { expires_in: uploader_expiration }.merge(options)
+      end
+
+      private
+
+      def gcloud_attributes
+        uploader.gcloud_attributes || {}
+      end
+
+      def gcloud_read_options
+        uploader.gcloud_read_options || {}
+      end
+
+      def gcloud_write_options
+        uploader.gcloud_write_options || {}
+      end
+    end
+  end
+end

data/lib/carrierwave/support/uri_filename.rb

@@ -0,0 +1,11 @@
+module CarrierWave
+  module Support
+    module UriFilename
+      def self.filename(url)
+        path = url.split('?').first
+
+        URI.decode(path).gsub(/.*\/(.*?$)/, '\1')
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: carrierwave-google-storage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jasdeep Singh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: gcloud
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !ruby/object:Gem::Dependency
+  name: uri-query_params
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+description: A slimmer alternative to using Fog for Google Cloud Storage support in
+  CarrierWave. Heavily inspired from carrierwave-aws
+email:
+- narang.jasdeep@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.sample"
+- ".gcp-keyfile.sample.json"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- carrierwave-google-storage.gemspec
+- lib/carrierwave-google-storage.rb
+- lib/carrierwave/google/storage/version.rb
+- lib/carrierwave/storage/gcloud.rb
+- lib/carrierwave/storage/gcloud_file.rb
+- lib/carrierwave/storage/gcloud_options.rb
+- lib/carrierwave/support/uri_filename.rb
+homepage: https://github.com/metaware/carrierwave-google-cloud
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Use gcloud for Google Cloud Storage support in CarrierWave.
+test_files: []