activestorage-cloudinary-service 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2eb62018264e48d4b9f1dc376cfd401f8d215645
+  data.tar.gz: bc69c0c0b7367845416aeb0aa67e1bd5087175ed
+SHA512:
+  metadata.gz: 3332fda9e60d98e76fa3c84bd7d148118811537bcf0bf5c806ec6ffb366f72a4450ab6b9696362085eeaa16324b798e8c48a3d81d365e47b5ca2a2bd55ea396b
+  data.tar.gz: 4c92345d5ca888864a208ea6d51a38547f846ac90e67df9b4d8d3d78149c5a3c14f0ed73a85eeb83099924df86f790c6cb42e3a04c242ff4867c76f13c5d439b

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in active_storage-cloudinary_service.gemspec
+gemspec
+
+gem 'cloudinary', require: false

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    activestorage-cloudinary-service (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws_cf_signer (0.1.3)
+    cloudinary (1.8.2)
+      aws_cf_signer
+      rest-client
+    diff-lcs (1.3)
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    netrc (0.11.0)
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activestorage-cloudinary-service!
+  bundler (~> 1.16)
+  cloudinary
+  rake (~> 10.0)
+  rspec
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,83 @@
+# ActiveStorage::Service::CloudinaryService
+
+With **v5.2**, Rails introduces [ActiveStorage](https://github.com/rails/rails/blob/master/activestorage/README.md), to facilitate uploading files to cloud services and attaching those files to ActiveRecord objects. Out of the box, it comes with implementations for cloud storage services; Amazon S3, Google Cloud Storage, and Microsoft Azure Storage; with an extendible adapter for adding support for other storage services.
+
+This gem extends the ActiveStorage::Service api with an implementation for [Cloudinary](https://cloudinary.com/) cloud service. The implementation is a thin wrapper around the official [cloudinary gem](https://github.com/cloudinary/cloudinary_gem) to provide necessary interfaces required to hook up cloudinary to the active_storage api. Serving as a middleman, it interprets active_storage requests and delegate to their cloudinary gem contemporary and parses the response as necessary. So you can work with Cloudinary much like you would any of the other active_storage services that comes out of the box.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cloudinary', require: false
+gem 'activestorage-cloudinary-service'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+In your Rails 5.2+ app, run:
+```shell
+  rails active_storage:install
+```
+This copy's over the active_storage migration for creating the needed tables and then run:
+```shell
+  rails db:migrate
+```
+
+_Note: you can skip the above two steps if you already have active_storage setup or if working a new Rails 5.2 (the setup is automatically added)_
+
+Declare a Cloudinary service in `config/storage.yml`. Each active_storage service requires a `name` and the relevant configurations options. Basic configuration options for cloudinary are `cloud_name`, `api_key` and `api_secret`. These are available from your [cloudinary account dashboard](https://cloudinary.com/console/cloudinary.yml).
+
+```yaml
+cloudinary:
+  service: Cloudinary
+  cloud_name: <%= ENV['CLOUDINARY_CLOUD_NAME'] %>
+  api_key:    <%= ENV['CLOUDINARY_API_KEY'] %>
+  api_secret: <%= ENV['CLOUDINARY_API_SECRET'] %>
+```
+
+The env vars should correspond to their appropriate values as defined in your app. Or using `rails credentials:edit` to set the cloudinary secrets `(as cloudinary:cloud_name|api_key|api_secret)`
+```yaml
+cloudinary:
+  service: Cloudinary
+  cloud_name: <%= Rails.application.credentials.dig(:cloudinary, :cloud_name) %>
+  api_key: <%= Rails.application.credentials.dig(:cloudinary, :api_key) %>
+  api_secret: <%= Rails.application.credentials.dig(:cloudinary, :api_secret) %>
+```
+
+*See [here](https://cloudinary.com/documentation/api_and_access_identifiers) for other supported configurations options that can be provided.*
+
+Tell Active Storage to use the Cloudinary service by setting `Rails.application.config.active_storage.service`. It is recommended to do this on a per-environment basis to enjoy the flexibility of using different services for different environment.
+
+For example, to use the cloudinary service in the production environment, you would add the following to `config/environments/production.rb`
+
+```rb
+config.active_storage.service = :cloudinary
+```
+
+## Known issues
+Currently, active_storage client-side upload doesn't work with Cloudinary. This because the cloudinary api doesn't, as at now, support the `PUT` request method used by [activestorage.js](https://github.com/rails/rails/blob/master/activestorage/app/javascript/activestorage/blob_upload.js#L9) library and as such client side uploads will error out with the message `Method PUT is not allowed by Access-Control-Allow-Methods in preflight response.`
+
+Nevertheless, the necessary ground work for this is set and once either active_storage is updated to support more request type or Cloudinary enables support for `PUT` request method, it should work fine.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/0sc/activestorage-cloudinary-service. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActiveStorage::Service::CloudinaryService project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/0sc/activestorage-cloudinary-service/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'progress']
+end
+
+task default: :spec

data/activestorage-cloudinary-service.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_storage/service/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'activestorage-cloudinary-service'
+  spec.version       = ActiveStorage::CloudinaryService::VERSION
+  spec.authors       = ['Osmond Oscar']
+  spec.email         = ['oskarromero3@gmail.com']
+
+  spec.summary       = 'Rails ActiveStorage adapter for cloudinary'
+  spec.homepage      = 'https://github.com/0sc/activestorage-cloudinary-service'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'cloudinary'
+end

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'active_storage/service/cloudinary_service'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_storage/service/cloudinary_service.rb

@@ -0,0 +1,156 @@
+require 'cloudinary'
+require 'open-uri'
+
+module ActiveStorage
+  class Service::CloudinaryService < Service
+    # FIXME: implement setup for private resource type
+    # FIXME: allow configuration via cloudinary url
+    def initialize(cloud_name:, api_key:, api_secret:, options: {})
+      options.merge!(
+        cloud_name: cloud_name,
+        api_key: api_key,
+        api_secret: api_secret
+      )
+      Cloudinary.config(options)
+      # Cloudinary.config_from_url(url)
+    end
+
+    def upload(key, io, checksum: nil)
+      instrument :upload, key: key, checksum: checksum do
+        Cloudinary::Uploader.upload(io, public_id: key)
+      end
+    end
+
+    # Return the content of the file at the +key+.
+    def download(key)
+      tmp_file = open(url_for_public_id(key))
+      if block_given?
+        instrument :streaming_download, key: key do
+          File.open(tmp_file, 'rb') do |file|
+            while (data = file.read(64.kilobytes))
+              yield data
+            end
+          end
+        end
+      else
+        instrument :download, key: key do
+          File.binread tmp_file
+        end
+      end
+    end
+
+    # Delete the file at the +key+.
+    def delete(key)
+      instrument :delete, key: key do
+        delete_resource_with_public_id(key)
+      end
+    end
+
+    # Delete files at keys starting with the +prefix+.
+    def delete_prefixed(prefix)
+      instrument :delete_prefixed, prefix: prefix do
+        find_resources_with_public_id_prefix(prefix).each do |resource|
+          delete_resource_with_public_id(resource['public_id'])
+        end
+      end
+    end
+
+    # Return +true+ if a file exists at the +key+.
+    def exist?(key)
+      instrument :exist?, key: key do
+        resource_exists_with_public_id?(key)
+      end
+    end
+
+    # Returns a signed, temporary URL for the file at the +key+. The URL will be valid for the amount
+    # of seconds specified in +expires_in+. You must also provide the +disposition+ (+:inline+ or +:attachment+),
+    # +filename+, and +content_type+ that you wish the file to be served with on request.
+    def url(key, expires_in:, disposition:, filename:, content_type:)
+      instrument :url, key: key do
+        options = {
+          expires_in: expires_in,
+          content_type: content_type,
+          disposition: disposition,
+          filename: filename
+        }
+        signed_download_url_for_public_id(key, options)
+      end
+    end
+
+    # Returns a signed, temporary URL that a direct upload file can be PUT to on the +key+.
+    # The URL will be valid for the amount of seconds specified in +expires_in+.
+    # You must also provide the +content_type+, +content_length+, and +checksum+ of the file
+    # that will be uploaded. All these attributes will be validated by the service upon upload.
+    def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
+      instrument :url_for_direct_upload, key: key do
+        options = {
+          expires_in: expires_in,
+          content_type: content_type,
+          content_length: content_length,
+          checksum: checksum
+        }
+        direct_upload_url_for_public_id(key, options)
+      end
+    end
+
+    # Returns a Hash of headers for +url_for_direct_upload+ requests.
+    def headers_for_direct_upload(key, filename:, content_type:, content_length:, checksum:)
+      { 'Content-Type' => content_type, 'X-Unique-Upload-Id' => key }
+    end
+
+    private
+
+    def resource_exists_with_public_id?(public_id)
+      !find_resource_with_public_id(public_id).empty?
+    end
+
+    def find_resource_with_public_id(public_id)
+      Cloudinary::Api.resources_by_ids(public_id).fetch('resources')
+    end
+
+    def find_resources_with_public_id_prefix(prefix)
+      Cloudinary::Api.resources(type: :upload, prefix: prefix).fetch('resources')
+    end
+
+    def delete_resource_with_public_id(public_id)
+      Cloudinary::Uploader.destroy(public_id)
+    end
+
+    def url_for_public_id(public_id)
+      Cloudinary::Api.resource(public_id)['secure_url']
+    end
+
+    # FIXME: Cloudinary Ruby SDK does't expose an api for signed upload url
+    # The expected url is similar to the private_download_url
+    # with download replaced with upload
+    def direct_upload_url_for_public_id(public_id, options)
+      # allow the server to auto detect the resource_type
+      options[:resource_type] ||= 'auto'
+      signed_download_url_for_public_id(public_id, options).sub(/download/, 'upload')
+    end
+
+    def signed_download_url_for_public_id(public_id, options)
+      options[:resource_type] ||= resource_type(options[:content_type])
+      Cloudinary::Utils.private_download_url(
+        public_id,
+        resource_format(options),
+        signed_url_options(options)
+      )
+    end
+
+    def signed_url_options(options)
+      {
+        resource_type: (options[:resource_type] || 'auto'),
+        type: (options[:type] || 'upload'),
+        attachment: (options[:attachment] == :attachment),
+        expires_at: (Time.now + options[:expires_in])
+      }
+    end
+
+    def resource_format(_options); end
+
+    def resource_type(content_type)
+      content_type.sub(%r{/.*$}, '')
+    end
+  end
+end

data/lib/active_storage/service/version.rb

@@ -0,0 +1,5 @@
+module ActiveStorage
+  module CloudinaryService
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: activestorage-cloudinary-service
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Osmond Oscar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cloudinary
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- oskarromero3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- activestorage-cloudinary-service.gemspec
+- bin/console
+- bin/setup
+- lib/active_storage/service/cloudinary_service.rb
+- lib/active_storage/service/version.rb
+homepage: https://github.com/0sc/activestorage-cloudinary-service
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Rails ActiveStorage adapter for cloudinary
+test_files: []