carrierwave-yandex-disk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ecbdf232daf7d6395c811bfb0469a47a20ca8a96784d519d76b6fa8ac478534c
+  data.tar.gz: 31532928a58bfd2bf83dbd0af33e18f3f240710a4c0176865ab418a52cec5cb1
+SHA512:
+  metadata.gz: 90abed12b1bb0fcaaf3d6ba9e29d59f441df890d4edb74436730249cfe7e269b4d051ea200e486098d825f6069225a9bdb73361b1cce3b293067e63cec789b1d
+  data.tar.gz: 2dc35139d5b58f2f3fd40f0f1d0b5f63296b8181b4ca962974ce9f3cc89851bb981111458bb4594aead5c65441196193926770e543dded709e94b338a4604f5b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+
+rvm:
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - rbx-3.91
+
+before_install:
+  - gem install bundler

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in carrierwave-yandex-disk.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    carrierwave-yandex-disk (0.1.0)
+      carrierwave (>= 1.2)
+      yandex-disk (>= 0.0.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.1.5)
+      activesupport (= 5.1.5)
+    activesupport (5.1.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    carrierwave (1.2.2)
+      activemodel (>= 4.0.0)
+      activesupport (>= 4.0.0)
+      mime-types (>= 1.16)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    excon (0.60.0)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.9.2)
+      faraday (>= 0.7.4, < 0.10)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    multipart-post (2.0.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      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.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    yandex-disk (0.0.8)
+      excon (>= 0.16)
+      faraday (~> 0.8)
+      faraday_middleware (~> 0.9.0)
+      nokogiri (>= 1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  carrierwave-yandex-disk!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 programrails
+
+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,167 @@
+# Yandex.Disk storage plugin for Carrierwave
+
+This gem allows you to set [Yandex.Disk](https://en.wikipedia.org/wiki/Yandex_Disk) (free of charge) as an online storage for the files you upload to your site with [Carrierwave](https://github.com/carrierwaveuploader/carrierwave). It is analogous to the [fog gems family](https://github.com/fog) and is especially useful for using Carrierwave on [Heroku](https://en.wikipedia.org/wiki/Heroku) (where the common file storage is [not supported](https://github.com/carrierwaveuploader/carrierwave/wiki/How-to%3A-Make-Carrierwave-work-on-Heroku)).
+
+This gem is NOT intended for an industry-scale cloud files storage (due to the possible Yandex.Disk bandwidth and other limitations). But it's a right fit for your (Heroku-based) job application test work, educational projects, etc.
+
+## Installation
+
+Set up a Yandex.Disk free account as described on the [Yandex::Disk gem page](https://github.com/anjlab/yandex-disk).
+
+Add these lines to your application's Gemfile:
+
+```ruby
+gem 'carrierwave-yandex-disk'
+```
+
+Set up your Rails application:
+
+* Write your OAuth2 token (generated on the Yandex.Disk setup step) into the `config/secrets.yml` file like this:
+
+```ruby
+development:
+  yandex_disk_access_token: 'AQAAAAAND3AxAATUPz31jhEFF0P_gltPlOFGi-4'
+
+test:
+  yandex_disk_access_token: 'AQAAAAAND3AxAATUPz31jhEFF0P_gltPlOFGi-4'
+
+production:
+  yandex_disk_access_token: <%= ENV["YANDEX_DISK_ACCESS_TOKEN"] %>
+```
+
+See [more info about secrets.yml usage](http://guides.rubyonrails.org/4_1_release_notes.html#config-secrets-yml).
+
+* Add your `config/secrets.yml` to the `.gitignore` file (if you haven't done it previously).
+
+* Create a file `config/initializers/carrierwave.rb` with the following content:
+
+```ruby
+CarrierWave.configure do |config|
+
+  config.yandex_disk_access_token = Rails.application.secrets.yandex_disk_access_token
+ 
+end
+```
+
+**NOTE**: You may use whatever other token initialization source here (if you don't like `secrets.yml`).
+
+In the target uploader set the storage like this:
+
+```ruby
+# app/uploaders/avatar_uploader.rb
+class AvatarUploader < CarrierWave::Uploader::Base
+  #storage :file
+  storage :yandex_disk
+end
+```
+
+Set up the [Carrierwave](https://github.com/carrierwaveuploader/carrierwave) gem.
+
+## Usage
+
+The usage is basically the same as in the regular (file-storage) Carrierwave case. The uploaded files get immediately "published" (e.g. available to anyone) on Yandex.Disk.
+
+**NOTE**: Do not manually operate with the Carrierwave-uploaded files on your Yandex.Disk account!
+
+Imagine you defined a model with an uploader:
+
+```ruby
+class User < ApplicationRecord
+	
+  mount_uploader :avatar, AvatarUploader
+
+end
+```
+
+Then (in your views) you can access the following methods:
+
+**url**:
+
+```ruby
+@user.avatar.url
+```
+
+or
+
+```ruby
+@user.avatar.file.url
+```
+
+Return example:
+
+```ruby
+https://downloader.disk.yandex.ru/disk/25e9fa3c40ea7e440029923e4a4c63e2f01cb66be3cda8cd1a756b8d2f46000f/5a934e46/jP34-9cszbD04Qaxa28_KP9GIgRMt42Dc_8aZRK8u2QXMsbsCPO6xe254apPTxbNg5jWPBB01aCTbWcWJo_f4g%3D%3D?uid=0&filename=user.png&disposition=attachment&hash=aHZ5UF177vQMTgCaLYPLS/VKtUrFKs/wlXlPu%2B7jXUw%3D%3A&limit=0&content_type=image%2Fpng&fsize=21128&hid=662f9a494d1d41839c86afd9c1de6afc&media_type=image&tknv=v2
+```
+
+Yields the direct URL (for your uploaded file) which is dynamically fetched from the server on every view rendering. This is a Yandex.Disk direct link policy limitation.
+
+**public_url**:
+
+```ruby
+@user.avatar.file.public_url
+```
+
+Return example:
+
+```ruby
+https://yadi.sk/i/H_D62-Ln3SmAhc
+```
+
+Yields the public URL (for your uploaded file). You may use this value for distributing the uploaded file beyond your site (on forums, blogs, etc).
+
+**storage_path**:
+
+```ruby
+@user.avatar.file.storage_path
+```
+
+Return example:
+
+```ruby
+/uploads/user/avatar/1/user.png
+```
+
+Yields the internal storage path (for your uploaded file). You would hardly need this value. It's format depends on the uploader's `store_dir` function.
+
+**filename**:
+
+```ruby
+@user.avatar.file.filename
+```
+
+Return example:
+
+```ruby
+user.png
+```
+
+Yields the filename (for your uploaded file).
+
+**extension**:
+
+```ruby
+@user.avatar.file.extension
+```
+
+Return example:
+
+```ruby
+.png
+```
+
+Yields the extension (for your uploaded file).
+
+
+## Special thanks
+
+This project is highly based on the [carrierwave-dropbox](https://github.com/robin850/carrierwave-dropbox) gem.
+
+Thanks to its author and contributors!
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/programrails/carrierwave-yandex-disk.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'carrierwave/yandex/disk'
+
+# 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
+
+require 'irb'
+IRB.start(__FILE__)

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/carrierwave-yandex-disk.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'carrierwave/yandex/disk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'carrierwave-yandex-disk'
+  spec.version       = Carrierwave::Yandex::Disk::VERSION
+  spec.authors       = ['programrails']
+  spec.email         = ['programrails@yandex.ru']
+
+  spec.summary       = 'Yandex.Disk integration for CarrierWave'.freeze
+  spec.description   = 'CarrierWave storage for Yandex.Disk'.freeze
+  spec.homepage      = 'https://github.com/programrails/carrierwave-yandex-disk'.freeze
+  spec.license       = 'MIT'.freeze
+
+  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', '~> 3.0'
+  spec.add_dependency 'carrierwave', '>= 1.2'
+  spec.add_dependency 'yandex-disk', '>= 0.0.8'
+end

data/lib/carrierwave/yandex/disk.rb

@@ -0,0 +1,18 @@
+require 'carrierwave'
+require 'carrierwave/yandex/storage/disk'
+
+require 'carrierwave/yandex/disk/version'
+
+module CarrierWave
+  module Uploader
+    # Rubocop, shut up
+    class Base
+      add_config :yandex_disk_access_token
+
+      configure do |config|
+        config.storage_engines[:yandex_disk] =
+          'CarrierWave::Storage::Yandex::Disk'
+      end
+    end
+  end
+end

data/lib/carrierwave/yandex/disk/version.rb

@@ -0,0 +1,7 @@
+module Carrierwave
+  module Yandex
+    module Disk
+      VERSION = '0.1.0'.freeze
+    end
+  end
+end

data/lib/carrierwave/yandex/storage/disk.rb

@@ -0,0 +1,113 @@
+require 'yandex/disk'
+
+module CarrierWave
+  module Storage
+    module Yandex
+      # Rubocop, shut up
+      class Disk < Abstract
+        # Stubs we must implement to create and save
+        # files (here on Yandex.Disk)
+
+        # Store a single file
+        def helper_create_publish(file)
+          location = "/#{uploader.store_path}"
+          location_path = "/#{uploader.store_dir}"
+
+          yandex_disk_client.mkdir_p(location_path)
+
+          yandex_disk_client.put!(file.path.to_s, location)
+
+          yandex_disk_client.make_public(location)
+        end
+
+        def helper_update_model(make_public_res)
+          location = "/#{uploader.store_path}"
+
+          public_url = ERB::Util.url_encode make_public_res[:public_url]
+
+          file_id = { location: location, public_url: public_url }.to_json
+
+          uploader.model.update_column uploader.mounted_as, file_id
+        end
+
+        def store!(file)
+          # I had to break this method into 2 helpers just because
+          # rubocop insisted on that. Isn't it stupid?
+          res = helper_create_publish(file)
+
+          helper_update_model(res)
+        end
+
+        # Retrieve a single file
+        def retrieve!(file_id)
+          file_id_hash = (JSON.parse file_id.gsub('=>', ':')).symbolize_keys
+
+          public_url = file_id_hash[:public_url]
+
+          location = file_id_hash[:location]
+
+          CarrierWave::Storage::Yandex::Disk::File
+            .new(public_url, location, yandex_disk_client)
+        end
+
+        def yandex_disk_client
+          @yandex_disk_client ||= begin
+            ::Yandex::Disk::Client.new(access_token: config[:access_token])
+          end
+        end
+
+        private
+
+        def config
+          @config ||= {}
+
+          @config[:access_token] ||= uploader.yandex_disk_access_token
+
+          @config
+        end
+        # Rubocop, shut up
+        class File
+          # alike http://www.rubydoc.info/gems/carrierwave/CarrierWave/Storage/Fog/File
+          include CarrierWave::Utilities::Uri
+
+          def initialize(public_url, location, yandex_disk_client)
+            @public_url = public_url
+            @location = location
+            @yandex_disk_client = yandex_disk_client
+          end
+
+          def filename
+            ::File.basename @location
+          end
+
+          def extension
+            ::File.extname @location
+          end
+
+          def url
+            query = 'https://cloud-api.yandex.net/v1/disk/public/resources/' \
+            "download?public_key=#{@public_url}"
+            uri = URI query
+            res = Net::HTTP.get(uri)
+            hash = JSON.parse(res)
+            hash['href']
+          end
+
+          def public_url
+            CGI.unescape @public_url
+          end
+
+          def storage_path
+            # deviation from http://www.rubydoc.info/gems/carrierwave/CarrierWave/Storage/Fog/File
+            @location
+          end
+
+          def delete
+            @yandex_disk_client.delete @location
+            @yandex_disk_client.delete(::File.dirname(@location))
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: carrierwave-yandex-disk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- programrails
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-27 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: '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: carrierwave
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: yandex-disk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+description: CarrierWave storage for Yandex.Disk
+email:
+- programrails@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- carrierwave-yandex-disk.gemspec
+- lib/carrierwave/yandex/disk.rb
+- lib/carrierwave/yandex/disk/version.rb
+- lib/carrierwave/yandex/storage/disk.rb
+homepage: https://github.com/programrails/carrierwave-yandex-disk
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Yandex.Disk integration for CarrierWave
+test_files: []