shrine-webdav 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a8ff691d2208dfa2d84ffe07f02a264ced26cbe
+  data.tar.gz: c5e50429ba8788a0f5aa35e4e9437cd1dd2bd897
+SHA512:
+  metadata.gz: 8294f24e37d5405cabd75cc537f2d484f98d72876d072c558ed5a37c03582eec7860fc46586b3fa9097cbd9ad27f28fdc11dc3db678690269ec1776a5f9b02cc
+  data.tar.gz: 16896d69aff2bccc93d0f643594c15dca182be9410807257c3f22a28d05e4a2586ced39a2508e7edcd0d56a67b2b5f401169863035dfb1b327adf046e98346c1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

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 at i.kushmantsev@fun-box.ru. 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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shrine-webdav.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ivan Kushmantsev
+
+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,103 @@
+# Shrine::Storage::WebDAV
+
+Provides a simple WebDAV storage for Shrine.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shrine-webdav'
+```
+
+## Usage
+
+Suppose you have Report model which should be able to store data in a remote WebDAV storage.
+```ruby
+class Report < ApplicationRecord
+end
+# == Schema Information
+#
+# Table name: reports
+#
+#  id                :uuid             not null, primary key
+#  name              :string           not null
+#  created_at        :datetime         not null
+#  updated_at        :datetime         not null
+```
+Before you can add attributes pointing to remote files to your model you should describe Uploader class:
+```ruby
+# app/models/reports/report_uploader.rb
+class ReportUploader < Shrine
+  plugin :activerecord
+  plugin :logging, logger: Rails.logger
+
+  def generate_location(_io, context)
+    uuid = context[:record].id
+    "#{uuid}.#{context[:name]}"
+  end
+end
+```
+You don't have to override method `generate_location`, but if you didn't you would have random file names.
+
+Now you can add the attributes:
+```ruby
+class Report < ApplicationRecord
+  include ReportUploader::Attachment.new(:pdf)
+  include ReportUploader::Attachment.new(:xls)
+end
+```
+Note corresponding migrations:
+```ruby
+class AddFileAttributes < ActiveRecord::Migration[5.1]
+  def change
+    add_column :reports, :xls_data, :text
+    add_column :reports, :pdf_data, :text
+  end
+end
+```
+
+Create file `shrine.rb` in `config/initializers/` to configure WebDAV storage:
+```ruby
+# config/initializers/shrine.rb
+require 'shrine'
+require "shrine/storage/webdav"
+
+Shrine.storages = {
+  cache: Shrine::Storage::WebDAV.new(host: 'http://webdav-server.com', prefix: 'your_project/cache'),
+  store: Shrine::Storage::WebDAV.new(host: 'http://webdav-server.com', prefix: 'your_project/store')
+}
+```
+
+Now you can use your virtual attributes `pdf` and `xls` like this:
+```ruby
+report = Report.new(name: 'Senseless report')
+
+# here you are going to have file sample.pdf uploaded
+# to "http://webdav-server.com/your_project/cache/#{report.id}.pdf"
+report.pdf = File.open('sample.pdf')
+
+# file sample.xls is being uploading
+# to "http://webdav-server.com/your_project/cache/#{report.id}.xls"
+report.xls = File.open('sample.xls')
+
+# after commiting in database both files sample.pdf and sample.xls have
+# been uploaded to "http://webdav-server.com/your_project/store/..."
+report.save
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `shrine-webdav.gemspec`, 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/funbox/shrine-webdav. 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](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/lib/shrine/webdav.rb

@@ -0,0 +1,70 @@
+require 'shrine'
+
+class Shrine
+  module Storage
+    class WebDAV
+      def initialize(host:, prefix: nil)
+        @host = host
+        mkpath(prefix) unless prefix.nil? || prefix.empty?
+        @host = path(host, prefix)
+      end
+
+      def upload(io, id, shrine_metadata: {}, **upload_options)
+        mkpath_to_file(id)
+        response = HTTP.put(path(@host, id), body: io.read)
+        return if (200..299).cover?(response.code.to_i)
+        raise "uploading of #{path(@host, id)} failed, the server response was #{response}"
+      end
+
+      def url(id, **options)
+        id
+      end
+
+      def open(id)
+        tempfile = Tempfile.new('webdav-', binmode: true)
+        response = HTTP.get(path(@host, id))
+        unless response.code.to_i == 200
+          tempfile.close!
+          raise "downloading of #{path(@host, id)} failed, the server response was #{response}"
+        end
+        tempfile.write(response)
+        tempfile.open
+        tempfile
+      end
+
+      def exists?(id)
+        response = HTTP.head(path(@host, id))
+        (200..299).cover?(response.code.to_i)
+      end
+
+      def delete(id)
+        HTTP.delete(path(@host, id))
+      end
+
+      private
+
+      def path(host, uri)
+        [host, uri].compact.join('/')
+      end
+
+      def mkpath_to_file(path_to_file)
+        last_slash = path_to_file.rindex('/')
+        path = path_to_file[0..last_slash]
+        mkpath(path)
+      end
+
+      def mkpath(path)
+        dirs = []
+        path.split('/').each do |dir|
+          dirs << "#{dirs[-1]}/#{dir}"
+        end
+        dirs.each do |dir|
+          response = HTTP.request(:mkcol, "#{@host}#{dir}")
+          unless (200..301).cover?(response.code.to_i)
+            raise "creation of directory #{@host}#{dir} failed, the server response was #{response}"
+          end
+        end
+      end
+    end
+  end
+end

data/shrine-webdav.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'shrine-webdav'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Ivan Kushmantsev']
+  spec.email         = ['i.kushmantsev@fun-box.ru']
+
+  spec.summary       = 'Provides a simple WebDAV storage for Shrine.'
+  spec.description   = 'Provides a simple WebDAV storage for Shrine.'
+  spec.homepage      = 'https://github.com/funbox/shrine-webdav'
+  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_dependency 'shrine', '>= 2.0'
+  spec.add_dependency 'http', '~> 2.2', '>= 2.2.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: shrine-webdav
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ivan Kushmantsev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shrine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: webmock
+  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: Provides a simple WebDAV storage for Shrine.
+email:
+- i.kushmantsev@fun-box.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/shrine/webdav.rb
+- shrine-webdav.gemspec
+homepage: https://github.com/funbox/shrine-webdav
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Provides a simple WebDAV storage for Shrine.
+test_files: []