activestorage-cloudinary-service 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2eb62018264e48d4b9f1dc376cfd401f8d215645
-  data.tar.gz: bc69c0c0b7367845416aeb0aa67e1bd5087175ed
+  metadata.gz: 2ed3e755146252107a2682fbd64e330be4ad5da2
+  data.tar.gz: dd6ea8202085b611a75cf588c3acd499a632975b
 SHA512:
-  metadata.gz: 3332fda9e60d98e76fa3c84bd7d148118811537bcf0bf5c806ec6ffb366f72a4450ab6b9696362085eeaa16324b798e8c48a3d81d365e47b5ca2a2bd55ea396b
-  data.tar.gz: 4c92345d5ca888864a208ea6d51a38547f846ac90e67df9b4d8d3d78149c5a3c14f0ed73a85eeb83099924df86f790c6cb42e3a04c242ff4867c76f13c5d439b
+  metadata.gz: 9b82f66786e2c685b88b4470a536b8a4d1d97578b61eb0f973a6508b44fb7bce0a406555456a806dc6cbd4791f7ff217f0cbe1a746b5670d323db13f69901c67
+  data.tar.gz: 2fc0f43b8c67469a7b658bf8ec9b9b5d8a5759f29de7b906ddde69fb23f294b4acf35734dabce0e5e71fd80d256ed05ac78eefb8bab7b577413b1f280e9c9ade

data/.circleci/config.yml

@@ -0,0 +1,44 @@
+version: 2
+jobs:
+  build:
+    working_directory: ~/0sc/activestorage-cloudinary-service
+    parallelism: 1
+    shell: /bin/bash --login
+    environment:
+      CIRCLE_ARTIFACTS: /tmp/circleci-artifacts
+      CIRCLE_TEST_REPORTS: /tmp/circleci-test-results
+    docker:
+      - image: circleci/ruby:2.4.2-jessie
+    steps:
+      - checkout
+      - run: mkdir -p $CIRCLE_ARTIFACTS $CIRCLE_TEST_REPORTS
+      - restore_cache:
+          keys:
+            # This branch if available
+            - v1-dep-{{ .Branch }}-
+            # Default branch if not
+            - v1-dep-master-
+            # Any branch if there are none on the default branch - this should be unnecessary if you have your default branch configured correctly
+            - v1-dep-
+      - run: echo -e "export RAILS_ENV=test\nexport RACK_ENV=test" >> $BASH_ENV
+      - run: 'bundle check --path=vendor/bundle || bundle install --path=vendor/bundle
+          --jobs=4 --retry=3'
+      - save_cache:
+          key: v1-dep-{{ .Branch }}-{{ epoch }}
+          paths:
+            # This is a broad list of cache paths to include many possible development environments
+            # You can probably delete some of these entries
+            - vendor/bundle
+            - ~/.bundle
+      - run:
+          command: bundle exec rspec --require spec_helper --format progress spec
+          environment:
+            RAILS_ENV: test
+            RACK_ENV: test
+      - store_test_results:
+          path: /tmp/circleci-test-results
+      # Save artifacts
+      - store_artifacts:
+          path: /tmp/circleci-artifacts
+      - store_artifacts:
+          path: /tmp/circleci-test-results

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/Gemfile

@@ -5,4 +5,5 @@ 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
+gem 'activestorage', '~> 5.2.0', require: false
+gem 'cloudinary', '~> 1.8.2', require: false

data/Gemfile.lock

@@ -1,24 +1,82 @@
 PATH
   remote: .
   specs:
-    activestorage-cloudinary-service (0.1.0)
+    activestorage-cloudinary-service (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actionpack (5.2.0)
+      actionview (= 5.2.0)
+      activesupport (= 5.2.0)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.0)
+      activesupport (= 5.2.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
+      arel (>= 9.0)
+    activestorage (5.2.0)
+      actionpack (= 5.2.0)
+      activerecord (= 5.2.0)
+      marcel (~> 0.3.1)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
     aws_cf_signer (0.1.3)
+    builder (3.2.3)
     cloudinary (1.8.2)
       aws_cf_signer
       rest-client
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
     diff-lcs (1.3)
     domain_name (0.5.20170404)
       unf (>= 0.0.5, < 1.0.0)
+    erubi (1.7.1)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    marcel (0.3.2)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.0)
     mime-types (3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
+    mimemagic (0.3.2)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
     netrc (0.11.0)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.5)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
     rake (10.5.0)
     rest-client (2.0.2)
       http-cookie (>= 1.0.2, < 2.0)
@@ -37,6 +95,9 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.4)
@@ -45,11 +106,13 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activestorage (~> 5.2.0)
   activestorage-cloudinary-service!
   bundler (~> 1.16)
-  cloudinary
+  cloudinary (~> 1.8.2)
+  pry (~> 0.11.3)
   rake (~> 10.0)
-  rspec
+  rspec (~> 3.7.0)
 
 BUNDLED WITH
-   1.16.0
+   1.16.2

data/README.md

@@ -64,11 +64,6 @@ Currently, active_storage client-side upload doesn't work with Cloudinary. This
 
 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
 

data/activestorage-cloudinary-service.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry', '~> 0.11.3'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'cloudinary'
+  spec.add_development_dependency 'rspec', '~> 3.7.0'
 end

data/lib/active_storage/service/cloudinary_service.rb

@@ -1,11 +1,15 @@
 require 'cloudinary'
-require 'open-uri'
+require_relative 'download_utils'
 
 module ActiveStorage
+  # Wraps the Cloudinary as an Active Storage service.
+  # See ActiveStorage::Service for the generic API documentation that applies to all services.
   class Service::CloudinaryService < Service
+    include DownloadUtils
+
     # FIXME: implement setup for private resource type
     # FIXME: allow configuration via cloudinary url
-    def initialize(cloud_name:, api_key:, api_secret:, options: {})
+    def initialize(cloud_name:, api_key:, api_secret:, **options)
       options.merge!(
         cloud_name: cloud_name,
         api_key: api_key,
@@ -17,28 +21,32 @@ module ActiveStorage
 
     def upload(key, io, checksum: nil)
       instrument :upload, key: key, checksum: checksum do
-        Cloudinary::Uploader.upload(io, public_id: key)
+        Cloudinary::Uploader.upload(io, public_id: key, resource_type: 'auto')
       end
     end
 
     # Return the content of the file at the +key+.
-    def download(key)
-      tmp_file = open(url_for_public_id(key))
+    def download(key, &block)
       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
+          source = cloudinary_url_for_key(key)
+          stream_download(source, &block)
         end
       else
         instrument :download, key: key do
-          File.binread tmp_file
+          Cloudinary::Downloader.download(key)
         end
       end
     end
 
+    # Return the partial content in the byte +range+ of the file at the +key+.
+    def download_chunk(key, range)
+      instrument :download_chunk, key: key, range: range do
+        source = cloudinary_url_for_key(key)
+        download_range(source, range)
+      end
+    end
+
     # Delete the file at the +key+.
     def delete(key)
       instrument :delete, key: key do
@@ -49,9 +57,7 @@ module ActiveStorage
     # 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
+        Cloudinary::Api.delete_resources_by_prefix(prefix)
       end
     end
 
@@ -87,9 +93,15 @@ module ActiveStorage
           expires_in: expires_in,
           content_type: content_type,
           content_length: content_length,
-          checksum: checksum
+          checksum: checksum,
+          resource_type: 'auto'
         }
-        direct_upload_url_for_public_id(key, options)
+
+        # 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
+        signed_download_url_for_public_id(key, options)
+          .sub(/download/, 'upload')
       end
     end
 
@@ -108,49 +120,48 @@ module ActiveStorage
       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])
+      extension = resource_format(options[:filename])
+      options[:resource_type] ||= resource_type(extension)
+
       Cloudinary::Utils.private_download_url(
-        public_id,
-        resource_format(options),
+        finalize_public_id(public_id, extension, options[:resource_type]),
+        extension,
         signed_url_options(options)
       )
     end
 
+    # TODO: for assets of type raw,
+    # cloudinary request the extension to be part of the public_id
+    def finalize_public_id(public_id, extension, resource_type)
+      return public_id unless resource_type == 'raw'
+      public_id + '.' + extension
+    end
+
     def signed_url_options(options)
       {
-        resource_type: (options[:resource_type] || 'auto'),
+        resource_type: (options[:resource_type] || 'image'),
         type: (options[:type] || 'upload'),
-        attachment: (options[:attachment] == :attachment),
+        attachment: (options[:disposition]&.to_sym == :attachment),
         expires_at: (Time.now + options[:expires_in])
       }
     end
 
-    def resource_format(_options); end
+    def resource_format(filename)
+      extension = filename&.extension_with_delimiter || ''
+      extension.sub('.', '')
+    end
+
+    def resource_type(extension)
+      Cloudinary::Utils.resource_type_for_format(extension)
+    end
 
-    def resource_type(content_type)
-      content_type.sub(%r{/.*$}, '')
+    def cloudinary_url_for_key(key)
+      Cloudinary::Utils.cloudinary_url(key)
     end
   end
 end

data/lib/active_storage/service/download_utils.rb

@@ -0,0 +1,50 @@
+require 'net/http'
+require 'openssl'
+
+module DownloadUtils
+  def stream_download(source, chunk_size = 5_242_880)
+    url = URI.parse(source)
+    http, req = setup_connection(url)
+
+    content_length = http.request_head(url).content_length
+    upper_limit = content_length + (content_length % chunk_size)
+    offset = 0
+
+    http.start do |agent|
+      while offset < upper_limit
+        lim = (offset + chunk_size)
+        # QUESTION: is it relevant to set the last chunk
+        # to the exact remaining bytes
+        # lim = content_length if lim > content_length
+        req.range = (offset..lim)
+
+        chunk = agent.request(req).body
+        yield chunk.force_encoding(Encoding::BINARY)
+
+        offset += chunk_size + 1
+      end
+    end
+  end
+
+  def download_range(source, range)
+    url = URI.parse(source)
+    http, req = setup_connection(url)
+    req.range = range
+
+    chunk = http.start { |agent| agent.request(req).body }
+    chunk.force_encoding(Encoding::BINARY)
+  end
+
+  private
+
+  def setup_connection(url)
+    http = Net::HTTP.new(url.host, url.port)
+    req = Net::HTTP::Get.new(url.request_uri)
+
+    if url.port == 443
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    end
+    [http, req]
+  end
+end

data/lib/active_storage/service/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activestorage-cloudinary-service
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Osmond Oscar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-19 00:00:00.000000000 Z
+date: 2018-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,47 +25,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.11.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.11.3
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: cloudinary
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.7.0
 description: 
 email:
 - oskarromero3@gmail.com
@@ -73,8 +73,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -85,6 +87,7 @@ files:
 - bin/console
 - bin/setup
 - lib/active_storage/service/cloudinary_service.rb
+- lib/active_storage/service/download_utils.rb
 - lib/active_storage/service/version.rb
 homepage: https://github.com/0sc/activestorage-cloudinary-service
 licenses: