calligraphy 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3ed31ae5c1825d0054f391bd8692cde22743e792
-  data.tar.gz: aa169279219e512a0be3d368852a9291eb1d702b
+SHA256:
+  metadata.gz: d786f30edd4065ba7373c353c73337f67e4f0bca62645fc6a367af6878fcf252
+  data.tar.gz: 9e3fb9d9f5f2c84f4541aa1063fdf0a7a9da6bb210fd69c574dc75092ee79f48
 SHA512:
-  metadata.gz: dce3ce028df7fde58126f2799efd90daf3609517abbbcd92e37a7fa1062f83d034cc15e67292b31d496e6e366af9580f1e55a2dbc36f40dc537db3f742b6f32a
-  data.tar.gz: dd3ef30ce3a48d51a871f440eff8b40974a5e9b5292f6fb5f80699d8823e8872355c3c099405378633e2daba10d232b788112c35235fbb43ce9594449883d389
+  metadata.gz: b31d99b9de262e75ed85f73eeaffd2d0da9141aa0039cfbd51bd008c39a8c2897cdb050f33479d70e1d9259f160866918ddc115ca6cd90b4a057b96b20fbbcf2
+  data.tar.gz: 4274cbea8768e3021dda2bcc3fe0983bcdaa16fc5dcb4b0d4c34cabf01d3a4ab1f85c49b1a8ca4bc9f623f15dd00d9e3d8f9df6b4c60332284078ec8eed75151

data/README.md

@@ -1,4 +1,4 @@
-# Calligraphy
+# Calligraphy [![Build Status](https://travis-ci.org/eanlain/calligraphy.svg?branch=master)](https://travis-ci.org/eanlain/calligraphy) [![Gem Version](https://badge.fury.io/rb/calligraphy.svg)](https://badge.fury.io/rb/calligraphy)
 
 Calligraphy is a Web Distributed Authoring and Versioning (WebDAV) solution for Rails that:
 

data/lib/calligraphy.rb

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 require 'calligraphy/rails/mapper'
+require 'calligraphy/rails/web_dav_methods'
+require 'calligraphy/rails/web_dav_preconditions'
 require 'calligraphy/rails/web_dav_requests_controller'
 
+require 'calligraphy/xml/web_dav_elements'
 require 'calligraphy/xml/builder'
 require 'calligraphy/xml/namespace'
 require 'calligraphy/xml/node'
@@ -10,18 +15,19 @@ require 'calligraphy/utils'
 require 'calligraphy/resource/resource'
 require 'calligraphy/resource/file_resource'
 
-require 'calligraphy/web_dav_request'
-require 'calligraphy/copy'
-require 'calligraphy/delete'
-require 'calligraphy/get'
-require 'calligraphy/lock'
-require 'calligraphy/mkcol'
-require 'calligraphy/move'
-require 'calligraphy/propfind'
-require 'calligraphy/proppatch'
-require 'calligraphy/put'
-require 'calligraphy/unlock'
+require 'calligraphy/web_dav_request/web_dav_request'
+require 'calligraphy/web_dav_request/copy'
+require 'calligraphy/web_dav_request/delete'
+require 'calligraphy/web_dav_request/get'
+require 'calligraphy/web_dav_request/lock'
+require 'calligraphy/web_dav_request/mkcol'
+require 'calligraphy/web_dav_request/move'
+require 'calligraphy/web_dav_request/propfind'
+require 'calligraphy/web_dav_request/proppatch'
+require 'calligraphy/web_dav_request/put'
+require 'calligraphy/web_dav_request/unlock'
 
+#:nodoc:
 module Calligraphy
   # Constants used throughout Calligraphy.
   DAV_NS = 'DAV:'
@@ -37,17 +43,17 @@ module Calligraphy
 
   # HTTP methods allowed by the WebDavRequests controller.
   mattr_accessor :allowed_http_methods
-  @@allowed_http_methods = %w(
+  @@allowed_http_methods = %w[
     options get put delete copy move
     mkcol propfind proppatch lock unlock
-  )
+  ]
 
   # Proc responsible for returning the user's password, API key,
   # or HA1 digest hash so that Rails can check user credentials.
   # Should be overridden to handle your particular application's
   # user and/or authentication setup.
   mattr_accessor :digest_password_procedure
-  @@digest_password_procedure = Proc.new { |username| 'changeme!' }
+  @@digest_password_procedure = proc { |_username| 'changeme!' }
 
   # If Digest Authentication is enabled by default.
   mattr_accessor :enable_digest_authentication
@@ -59,15 +65,15 @@ module Calligraphy
 
   # Maximum lock lifetime in seconds.
   mattr_accessor :lock_timeout_period
-  @@lock_timeout_period = 86400
+  @@lock_timeout_period = 86_400
 
   # The HTTP actions Calligraphy uses to create mappings between WebDAV
   # HTTP verbs and URLs and WebDAV controller actions.
   mattr_accessor :web_dav_actions
-  @@web_dav_actions = %i(
+  @@web_dav_actions = %i[
     options get put delete copy move
     mkcol propfind proppatch lock unlock
-  )
+  ]
 
   # Default way to set up Calligraphy.
   # Run `rails generate calligraphy:install` to generate a

data/lib/calligraphy/rails/mapper.rb

@@ -1,166 +1,174 @@
-module ActionDispatch::Routing
-  class Mapper
-    module HttpHelpers
-      # Define a Calligraphy route that only recognizes HTTP COPY.
-      #   copy 'bacon', to: 'food#bacon'
-      def copy(*args, &block)
-        args = set_web_dav_args args
-        map_method :copy, args, &block
-      end
+# frozen_string_literal: true
+
+module ActionDispatch
+  module Routing
+    class Mapper
+      #:nodoc:
+      module HttpHelpers
+        # Define a Calligraphy route that only recognizes HTTP COPY.
+        #   copy 'bacon', to: 'food#bacon'
+        def copy(*args, &block)
+          args = web_dav_args args
+          map_method :copy, args, &block
+        end
 
-      # Define a Calligraphy route that only recognizes HTTP HEAD.
-      #   head 'bacon', to: 'food#bacon'
-      def head(*args, &block)
-        args = set_web_dav_args args
-        map_method :head, args, &block
-      end
+        # Define a Calligraphy route that only recognizes HTTP HEAD.
+        #   head 'bacon', to: 'food#bacon'
+        def head(*args, &block)
+          args = web_dav_args args
+          map_method :head, args, &block
+        end
 
-      # Define a Calligraphy route that only recognizes HTTP LOCK.
-      #   lock 'bacon', to: 'food#bacon'
-      def lock(*args, &block)
-        args = set_web_dav_args args
-        map_method :lock, args, &block
-      end
+        # Define a Calligraphy route that only recognizes HTTP LOCK.
+        #   lock 'bacon', to: 'food#bacon'
+        def lock(*args, &block)
+          args = web_dav_args args
+          map_method :lock, args, &block
+        end
 
-      # Define a Calligraphy route that only recognizes HTTP MKCOL.
-      #   mkcol 'bacon', to: 'food#bacon'
-      def mkcol(*args, &block)
-        args = set_web_dav_args args
-        map_method :mkcol, args, &block
-      end
+        # Define a Calligraphy route that only recognizes HTTP MKCOL.
+        #   mkcol 'bacon', to: 'food#bacon'
+        def mkcol(*args, &block)
+          args = web_dav_args args
+          map_method :mkcol, args, &block
+        end
 
-      # Define a Calligraphy route that only recognizes HTTP MOVE.
-      #   move 'bacon', to: 'food#bacon'
-      def move(*args, &block)
-        args = set_web_dav_args args
-        map_method :move, args, &block
-      end
+        # Define a Calligraphy route that only recognizes HTTP MOVE.
+        #   move 'bacon', to: 'food#bacon'
+        def move(*args, &block)
+          args = web_dav_args args
+          map_method :move, args, &block
+        end
 
-      # Define a Calligraphy route that only recognizes HTTP OPTIONS.
-      #   options 'bacon', to: 'food#bacon'
-      def options(*args, &block)
-        args = set_web_dav_args args
-        map_method :options, args, &block
-      end
+        # Define a Calligraphy route that only recognizes HTTP OPTIONS.
+        #   options 'bacon', to: 'food#bacon'
+        def options(*args, &block)
+          args = web_dav_args args
+          map_method :options, args, &block
+        end
 
-      # Define a Calligraphy route that only recognizes HTTP PROPFIND.
-      #   propfind 'bacon', to: 'food#bacon'
-      def propfind(*args, &block)
-        args = set_web_dav_args args
-        map_method :propfind, args, &block
-      end
+        # Define a Calligraphy route that only recognizes HTTP PROPFIND.
+        #   propfind 'bacon', to: 'food#bacon'
+        def propfind(*args, &block)
+          args = web_dav_args args
+          map_method :propfind, args, &block
+        end
 
-      # Define a Calligraphy route that only recognizes HTTP PROPPATCH.
-      #   proppatch 'bacon', to: 'food#bacon'
-      def proppatch(*args, &block)
-        args = set_web_dav_args args
-        map_method :proppatch, args, &block
-      end
+        # Define a Calligraphy route that only recognizes HTTP PROPPATCH.
+        #   proppatch 'bacon', to: 'food#bacon'
+        def proppatch(*args, &block)
+          args = web_dav_args args
+          map_method :proppatch, args, &block
+        end
 
-      # Define a Calligraphy route that only recognizes HTTP UNLOCK.
-      #   unlock 'bacon', to: 'food#bacon'
-      def unlock(*args, &block)
-        args = set_web_dav_args args
-        map_method :unlock, args, &block
-      end
+        # Define a Calligraphy route that only recognizes HTTP UNLOCK.
+        #   unlock 'bacon', to: 'food#bacon'
+        def unlock(*args, &block)
+          args = web_dav_args args
+          map_method :unlock, args, &block
+        end
 
-      # Define a Calligraphy route that only recognizes HTTP DELETE.
-      #   web_dav_delete 'broccoli', to: 'food#broccoli'
-      def web_dav_delete(*args, &block)
-        args = set_web_dav_args args
-        map_method :delete, args, &block
-      end
+        # Define a Calligraphy route that only recognizes HTTP DELETE.
+        #   web_dav_delete 'broccoli', to: 'food#broccoli'
+        def web_dav_delete(*args, &block)
+          args = web_dav_args args
+          map_method :delete, args, &block
+        end
 
-      # Define a Calligraphy route that only recognizes HTTP GET.
-      #   web_dav_get 'bacon', to: 'food#bacon'
-      def web_dav_get(*args, &block)
-        args = set_web_dav_args args
-        map_method :get, args, &block
-      end
+        # Define a Calligraphy route that only recognizes HTTP GET.
+        #   web_dav_get 'bacon', to: 'food#bacon'
+        def web_dav_get(*args, &block)
+          args = web_dav_args args
+          map_method :get, args, &block
+        end
 
-      # Define a Calligraphy route that only recognizes HTTP PUT.
-      #   web_dav_put 'bacon', to: 'food#bacon'
-      def web_dav_put(*args, &block)
-        args = set_web_dav_args args
-        map_method :put, args, &block
-      end
+        # Define a Calligraphy route that only recognizes HTTP PUT.
+        #   web_dav_put 'bacon', to: 'food#bacon'
+        def web_dav_put(*args, &block)
+          args = web_dav_args args
+          map_method :put, args, &block
+        end
 
-      private
+        private
 
-      def set_web_dav_args(args)
-        options = {
-          controller: 'calligraphy/rails/web_dav_requests',
-          action: 'invoke_method'
-        }
-        [args[0], options]
+        def web_dav_args(args)
+          options = {
+            controller: 'calligraphy/rails/web_dav_requests',
+            action: 'invoke_method'
+          }
+          [args[0], options]
+        end
       end
-    end
 
-    module Resources
-      class Resource
-        def web_dav_actions
-          if @only
-            Array(@only).map(&:to_sym)
-          elsif @except
-            Calligraphy.web_dav_actions - Array(@except).map(&:to_sym)
-          else
-            Calligraphy.web_dav_actions
+      #:nodoc:
+      module Resources
+        #:nodoc:
+        class Resource
+          # Returns the available WebDAV HTTP verbs based on Calligraphy
+          # configuration and Rails routing options.
+          def web_dav_actions
+            if @only
+              Array(@only).map(&:to_sym)
+            elsif @except
+              Calligraphy.web_dav_actions - Array(@except).map(&:to_sym)
+            else
+              Calligraphy.web_dav_actions
+            end
           end
         end
-      end
 
-      # With Calligraphy, a resourceful route provides mappings between WebDAV
-      # HTTP verbs and URLs and WebDAV controller actions. A single entry in
-      # the routing file, such as:
-      #
-      #   calligraphy_resource :photos
-      #
-      # creates eleven different routes in your application, all mapping to the
-      # WebDavRequests controller:
-      #
-      #     OPTIONS   /photos/*resource
-      #     GET       /photos/*resource
-      #     PUT       /photos/*resource
-      #     DELETE    /photos/*resource
-      #     COPY      /photos/*resource
-      #     MOVE      /photos/*resource
-      #     MKCOL     /photos/*resource
-      #     PROPFIND  /photos/*resource
-      #     PROPPATCH /photos/*resource
-      #     LOCK      /photos/*resource
-      #     UNLOCK    /photos/*resource
-      def calligraphy_resource(*resources, &block)
-        options = resources.extract_options!.dup
-
-        if apply_common_behavior_for :calligraphy_resource, resources, options, &block
-          return self
-        end
-
-        with_scope_level(:resource) do
-          options = apply_action_options options
-          singleton_resoure = ActionDispatch::Routing::Mapper::SingletonResource
-
-          resource_scope(singleton_resoure.new resources.pop, api_only?, @scope[:shallow], options) do
-            yield if block_given?
-
-            concerns(options[:concerns]) if options[:concerns]
-
-            set_mappings_for_web_dav_resources
+        # With Calligraphy, a resourceful route provides mappings between WebDAV
+        # HTTP verbs and URLs and WebDAV controller actions. A single entry in
+        # the routing file, such as:
+        #
+        #   calligraphy_resource :photos
+        #
+        # creates eleven different routes in your application, all mapping to
+        # the WebDavRequests controller:
+        #
+        #     OPTIONS   /photos/*resource
+        #     GET       /photos/*resource
+        #     PUT       /photos/*resource
+        #     DELETE    /photos/*resource
+        #     COPY      /photos/*resource
+        #     MOVE      /photos/*resource
+        #     MKCOL     /photos/*resource
+        #     PROPFIND  /photos/*resource
+        #     PROPPATCH /photos/*resource
+        #     LOCK      /photos/*resource
+        #     UNLOCK    /photos/*resource
+        def calligraphy_resource(*resources, &block)
+          options = resources.extract_options!.dup
+
+          if apply_common_behavior_for :calligraphy_resource, resources, options, &block
+            return self
+          end
+
+          with_scope_level(:resource) do
+            options = apply_action_options options
+
+            resource_scope(SingletonResource.new(resources.pop, api_only?, @scope[:shallow], options)) do
+              yield if block_given?
+
+              concerns(options[:concerns]) if options[:concerns]
+
+              set_mappings_for_web_dav_resources
+            end
           end
         end
-      end
 
-      private
-
-      def set_mappings_for_web_dav_resources
-        parent_resource.web_dav_actions.each do |action|
-          # Rails already defines GET, PUT, and DELETE actions which we don't
-          # want to override. Instead, we map WebDAV GET, PUT, and DELETE
-          # HTTP actions to 'web_dav_' prefixed methods.
-          if [:get, :put, :delete].include? action
-            send "web_dav_#{action.to_s}", '*resource'
-          else
-            send action, '*resource'
+        private
+
+        def set_mappings_for_web_dav_resources
+          parent_resource.web_dav_actions.each do |action|
+            # Rails already defines GET, PUT, and DELETE actions which we don't
+            # want to override. Instead, we map WebDAV GET, PUT, and DELETE
+            # HTTP actions to 'web_dav_' prefixed methods.
+            if %i[get put delete].include? action
+              send "web_dav_#{action}", '*resource'
+            else
+              send action, '*resource'
+            end
           end
         end
       end

data/lib/calligraphy/rails/web_dav_methods.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Calligraphy
+  module Rails
+    # Provides methods to direct the execution of WebDAV actions.
+    module WebDavMethods
+      private
+
+      def web_dav_request
+        {
+          headers: request.headers,
+          request: request,
+          resource: @resource,
+          response: response
+        }
+      end
+
+      def options
+        response.headers['DAV'] = @resource.dav_compliance
+
+        :ok
+      end
+
+      def get(head: false)
+        fresh_when(@resource, etag: @resource.etag) if @resource.readable?
+
+        Calligraphy::Get.new(web_dav_request).execute(head: head)
+      end
+
+      def put
+        Calligraphy::Put.new(web_dav_request).execute
+      end
+
+      def delete
+        Calligraphy::Delete.new(web_dav_request).execute
+      end
+
+      def copy
+        Calligraphy::Copy.new(web_dav_request).execute
+      end
+
+      def move
+        Calligraphy::Move.new(web_dav_request).execute
+      end
+
+      def mkcol
+        Calligraphy::Mkcol.new(web_dav_request).execute
+      end
+
+      def propfind
+        Calligraphy::Propfind.new(web_dav_request).execute
+      end
+
+      def proppatch
+        Calligraphy::Proppatch.new(web_dav_request).execute
+      end
+
+      def lock
+        Calligraphy::Lock.new(web_dav_request).execute
+      end
+
+      def unlock
+        Calligraphy::Unlock.new(web_dav_request).execute
+      end
+    end
+  end
+end