calligraphy 0.2.1 → 0.3.1

data/lib/calligraphy/xml/node.rb

@@ -1,9 +1,16 @@
-module Calligraphy::XML
-  class Node
-    attr_accessor :children, :name, :namespace, :text
+# frozen_string_literal: true
+
+module Calligraphy
+  module XML
+    # Simple XML node, used to store resource properties in Resource methods
+    # and later to create XML response bodies.
+    class Node
+      attr_accessor :children, :name, :namespace, :text
+
+      #:nodoc:
+      def initialize(node = nil)
+        return if node.nil?
 
-    def initialize(node=nil)
-      unless node.nil?
         @name = node.name
         @text = node.text unless node.text.empty?
 
@@ -11,11 +18,18 @@ module Calligraphy::XML
           @namespace = Calligraphy::XML::Namespace.new node.namespace
         end
 
-        if node.children&.length > 0
-          @children = node.children.map do |child|
-            Calligraphy::XML::Node.new child
-          end
-        end
+        return unless node_has_children node
+
+        @children = []
+        node.children.each { |x| @children.push Calligraphy::XML::Node.new x }
+      end
+
+      private
+
+      def node_has_children(node)
+        return false if node.children.nil?
+
+        node.children.length.positive?
       end
     end
   end

data/lib/calligraphy/xml/utils.rb

@@ -1,18 +1,29 @@
-module Calligraphy::XML
-  module Utils
-    def xml_for(body:, node:)
-      xml = Nokogiri::XML body
-      return :bad_request unless xml.errors.empty?
+# frozen_string_literal: true
 
-      namespace = nil
-      xml.root.namespace_definitions.each do |n|
-        namespace = "#{n.prefix}|" if n&.href == Calligraphy::DAV_NS && !n.prefix.nil?
+module Calligraphy
+  module XML
+    # Miscellaneous XML convenience methods.
+    module Utils
+      # Returns the XML for a given XML body and node/CSS selector.
+      def xml_for(body:, node:)
+        xml = Nokogiri::XML body
+        return :bad_request unless xml.errors.empty?
+
+        namespace = nil
+        xml.root.namespace_definitions.each do |n|
+          namespace = "#{n.prefix}|" if dav_namespace n
+        end
+
+        node = node.split(' ').map! { |n| namespace + n }.join(' ') if namespace
+
+        xml.css(node).children
       end
-      namespace
 
-      node = node.split(' ').map! { |n| namespace + n }.join(' ') if namespace
+      private
 
-      xml.css(node).children
+      def dav_namespace(namespace)
+        namespace&.href == Calligraphy::DAV_NS && !namespace.prefix.nil?
+      end
     end
   end
 end

data/lib/calligraphy/xml/web_dav_elements.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Calligraphy
+  module XML
+    # Methods to help build WebDAV elements and properties.
+    module WebDavElements
+      DAV_NS_TAGS = %w[
+        activelock allprop collection creationdate depth displayname error
+        exclusive getcontentlanguage getcontentlength getcontenttype getetag
+        getlastmodified href include location lockdiscovery lockentry lockinfo
+        lockroot lockscope locktoken locktype multistatus owner prop
+        propertyupdate propfind propname propstat remove response
+        responsedescription resourcetype set shared status supportedlock
+        timeout write
+      ].freeze
+
+      DAV_NS_METHODS = %w[resourcetype supportedlock timeout].freeze
+
+      # Build an XML response for a LOCK request.
+      def lock_response(activelock_properties)
+        build :prop do |xml|
+          xml.lockdiscovery do
+            activelock_properties.each do |properties|
+              xml.activelock do
+                iterate_and_drilldown xml, properties
+              end
+            end
+          end
+        end
+      end
+
+      # Build an XML response for a PROPFIND request.
+      def propfind_response(path, properties)
+        multistatus do |xml|
+          href xml, path
+          propstat xml, properties[:found], :ok
+          propstat xml, properties[:not_found], :not_found
+        end
+      end
+
+      # Build an XML response for a PROPPATCH request.
+      def proppatch_response(path, actions)
+        multistatus do |xml|
+          href xml, path
+          propstat xml, actions[:set]
+          propstat xml, actions[:remove]
+        end
+      end
+
+      private
+
+      def resourcetype(xml, property)
+        xml[@dav_ns].resourcetype do
+          self_closing_tag xml, property.text if property.text == 'collection'
+        end
+      end
+
+      def supportedlock(xml, property)
+        children = JSON.parse property.text, symbolize_names: true
+
+        xml[@dav_ns].supportedlock do
+          children.each do |child|
+            xml[@dav_ns].lockentry do
+              lockscope xml, child[:lockentry][:lockscope]
+              locktype xml, child[:lockentry][:locktype]
+            end
+          end
+        end
+      end
+
+      def lockscope(xml, scope)
+        xml[@dav_ns].lockscope do
+          self_closing_tag xml, scope
+        end
+      end
+
+      def locktype(xml, type)
+        xml[@dav_ns].locktype do
+          self_closing_tag xml, type
+        end
+      end
+
+      # NOTE: `xml[@dav_ns].send timeout` results in Timeout being called, so
+      # we have this timeout method for convenience.
+      def timeout(xml, property)
+        xml[@dav_ns].timeout do
+          xml.text property.text
+        end
+      end
+    end
+  end
+end

data/lib/generators/calligraphy/install_generator.rb

@@ -1,12 +1,16 @@
+# frozen_string_literal: true
+
 require 'rails/generators/base'
 
 module Calligraphy
   module Generators
+    # Generator used to copy Calligraphy initializer over to your application.
     class InstallGenerator < ::Rails::Generators::Base
       source_root File.expand_path('../../templates', __FILE__)
 
       desc 'Creates a Calligraphy initializer for your application'
 
+      #:nodoc:
       def copy_initializer
         template 'calligraphy.rb', 'config/initializers/calligraphy.rb'
       end

data/lib/generators/templates/calligraphy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Calligraphy.configure do |config|
   # The HTTP actions Calligraphy uses to create mappings between WebDAV
   # HTTP verbs and URLs and WebDAV controller actions.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calligraphy
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Brandon Robins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-17 00:00:00.000000000 Z
+date: 2018-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,6 +17,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,21 +27,104 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.11.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.11.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.11.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description: WebDAV framework and extension for Rails 5
+        version: 12.3.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+description: 
 email: brandon@onebnottwo.com
 executables: []
 extensions: []
@@ -47,30 +133,32 @@ files:
 - LICENSE
 - README.md
 - lib/calligraphy.rb
-- lib/calligraphy/copy.rb
-- lib/calligraphy/delete.rb
-- lib/calligraphy/get.rb
-- lib/calligraphy/lock.rb
-- lib/calligraphy/mkcol.rb
-- lib/calligraphy/move.rb
-- lib/calligraphy/propfind.rb
-- lib/calligraphy/proppatch.rb
-- lib/calligraphy/put.rb
 - lib/calligraphy/rails/mapper.rb
+- lib/calligraphy/rails/web_dav_methods.rb
+- lib/calligraphy/rails/web_dav_preconditions.rb
 - lib/calligraphy/rails/web_dav_requests_controller.rb
 - lib/calligraphy/resource/file_resource.rb
 - lib/calligraphy/resource/resource.rb
-- lib/calligraphy/unlock.rb
 - lib/calligraphy/utils.rb
 - lib/calligraphy/version.rb
-- lib/calligraphy/web_dav_request.rb
+- lib/calligraphy/web_dav_request/copy.rb
+- lib/calligraphy/web_dav_request/delete.rb
+- lib/calligraphy/web_dav_request/get.rb
+- lib/calligraphy/web_dav_request/lock.rb
+- lib/calligraphy/web_dav_request/mkcol.rb
+- lib/calligraphy/web_dav_request/move.rb
+- lib/calligraphy/web_dav_request/propfind.rb
+- lib/calligraphy/web_dav_request/proppatch.rb
+- lib/calligraphy/web_dav_request/put.rb
+- lib/calligraphy/web_dav_request/unlock.rb
+- lib/calligraphy/web_dav_request/web_dav_request.rb
 - lib/calligraphy/xml/builder.rb
 - lib/calligraphy/xml/namespace.rb
 - lib/calligraphy/xml/node.rb
 - lib/calligraphy/xml/utils.rb
+- lib/calligraphy/xml/web_dav_elements.rb
 - lib/generators/calligraphy/install_generator.rb
 - lib/generators/templates/calligraphy.rb
-- spec/spec_helper.rb
 homepage: http://www.github.com/eanlain/calligraphy
 licenses:
 - MIT
@@ -83,7 +171,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -91,9 +179,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: WebDAV framework and extension for Rails 5
-test_files:
-- spec/spec_helper.rb
+test_files: []

data/lib/calligraphy/get.rb

@@ -1,12 +0,0 @@
-module Calligraphy
-  class Get < WebDavRequest
-    def request(head: false)
-      if @resource.readable?
-        return :ok if head
-        return :ok, @resource.read
-      else
-        return :not_found
-      end
-    end
-  end
-end

data/lib/calligraphy/lock.rb

@@ -1,52 +0,0 @@
-module Calligraphy
-  class Lock < WebDavRequest
-    include Calligraphy::XML::Utils
-
-    def request
-      if @resource.request_body.blank? && !@resource.locked_to_user?(@headers)
-        lock_properties = @resource.refresh_lock
-      elsif (@resource.locked? && @resource.lock_is_exclusive?) ||
-              (@resource.locked_to_user?(@headers) && !xml_contains_shared_lock?)
-        return :locked
-      else
-        resource_exists_beforehand = @resource.exists?
-
-        xml = xml_for body: body, node: 'lockinfo'
-        return :bad_request if xml == :bad_request
-
-        lock_properties = @resource.lock xml, @headers['Depth']
-      end
-
-      builder = xml_builder
-      xml_res = builder.lock_res lock_properties
-
-      lock_token = lock_properties[-1]
-        .select { |x| x.name == 'locktoken' }[0]
-        .children[0]
-        .text
-
-      response.headers['Lock-Token'] = "<#{lock_token}>"
-      set_xml_content_type
-
-      if resource_exists_beforehand
-        return :ok, xml_res
-      else
-        return :created, xml_res
-      end
-    end
-
-    private
-
-    def xml_contains_shared_lock?
-      lock_type = nil
-      xml = xml_for body: body, node: 'lockinfo'
-      xml.each do |node|
-        next unless node.is_a? Nokogiri::XML::Element
-
-        lock_type = node.children[0].name if node.name == 'lockscope'
-      end
-
-      lock_type == 'shared'
-    end
-  end
-end