calligraphy 0.2.0

data/lib/calligraphy/resource.rb

@@ -0,0 +1,93 @@
+module Calligraphy
+  class Resource
+    attr_accessor :client_nonce, :contents, :updated_at
+    attr_reader :full_request_path, :mount_point, :request_body, :request_path, :root_dir
+
+    def initialize(resource: nil, req: nil, mount: nil, root_dir: nil)
+      @full_request_path = req&.original_url
+      @mount_point = mount || req&.path&.tap { |s| s.slice! resource }
+      @request_body = req&.body&.read || ''
+      @request_path = mount.nil? ? resource : resource.split(mount)[-1]
+    end
+
+    def ancestor_exist?
+      raise NotImplemented
+    end
+
+    def can_copy?(options)
+      raise NotImplemented
+    end
+
+    def collection?
+      raise NotImplemented
+    end
+
+    def copy(options)
+      raise NotImplemented
+    end
+
+    def create_collection
+      raise NotImplemented
+    end
+
+    def delete_collection
+      raise NotImplemented
+    end
+
+    def etag
+      raise NotImplemented
+    end
+
+    def exists?
+      raise NotImplemented
+    end
+
+    def lock(nodes, depth='infinity')
+      raise NotImplemented
+    end
+
+    def lock_is_exclusive?
+      raise NotImplemented
+    end
+
+    def lock_tokens
+      raise NotImplemented
+    end
+
+    def locked?
+      raise NotImplemented
+    end
+
+    def locked_to_user?(headers=nil)
+      raise NotImplemented
+    end
+
+    def propfind(nodes)
+      raise NotImplemented
+    end
+
+    def proppatch(nodes)
+      raise NotImplemented
+    end
+
+    def read
+      raise NotImplemented
+    end
+
+    def readable?
+      exists? && !collection?
+    end
+
+    def refresh_lock
+      raise NotImplemented
+    end
+
+    def unlock(token)
+      raise NotImplemented
+    end
+
+    def write(contents=@request_body.to_s)
+      raise NotImplemented
+    end
+  end
+end

data/lib/calligraphy/unlock.rb

@@ -0,0 +1,15 @@
+module Calligraphy
+  class Unlock < WebDavRequest
+    def request
+      return :bad_request if @headers['Lock-Token'].nil?
+
+      @resource.unlock lock_token_header
+    end
+
+    private
+
+    def lock_token_header
+      @headers['Lock-Token'].gsub Calligraphy::LOCK_TOKEN_ANGLE_REGEX, ''
+    end
+  end
+end

data/lib/calligraphy/utils.rb

@@ -0,0 +1,38 @@
+module Calligraphy
+  module Utils
+    TRUE_VALUES = [true, 1, '1', 't', 'T', 'true', 'TRUE']
+    FALSE_VALUES = [false, 0, '0', 'f', 'F', 'false', 'FALSE']
+
+    def is_true?(val)
+      TRUE_VALUES.include? val
+    end
+
+    def is_false?(val)
+      FALSE_VALUES.include? val
+    end
+
+    def join_paths(*paths)
+      paths.join '/'
+    end
+
+    def split_and_pop(path:, separator: '/')
+      path.split(separator)[0..-2]
+    end
+
+    def obj_exists_and_is_not_type?(obj:, type:)
+      obj.nil? ? false : obj != type
+    end
+
+    def map_array_of_hashes(arr_hashes)
+      [].tap do |output_array|
+        arr_hashes.each do |hash|
+          output_array.push hash.map { |k, v| v }
+        end
+      end
+    end
+
+    def extract_lock_token(if_header)
+      if_header.scan(Calligraphy::LOCK_TOKEN_REGEX)&.flatten[0]
+    end
+  end
+end

data/lib/calligraphy/version.rb

@@ -0,0 +1,3 @@
+module Calligraphy
+  VERSION = '0.2.0'
+end

data/lib/calligraphy/web_dav_request.rb

@@ -0,0 +1,31 @@
+module Calligraphy
+  class WebDavRequest
+    attr_accessor :resource, :response
+    attr_reader :headers, :request
+
+    def initialize(headers:, request:, response:, resource:)
+      @headers = headers
+      @request = request
+      @response = response
+      @resource = resource
+    end
+
+    def request
+      raise NotImplemented
+    end
+
+    private
+
+    def body
+      @resource.request_body
+    end
+
+    def set_xml_content_type
+      @response.content_type = 'application/xml'
+    end
+
+    def xml_builder
+      Calligraphy::XML::Builder.new server_protocol: @request.env['SERVER_PROTOCOL']
+    end
+  end
+end

data/lib/calligraphy/xml/builder.rb

@@ -0,0 +1,147 @@
+module Calligraphy::XML
+  class Builder
+    SUPPORTED_NS_TAGS = %w(
+      creationdate displayname exclusive getcontentlanguage getcontentlength
+      getcontenttype getetag getlastmodified href lockdiscovery lockscope
+      locktype owner write
+    )
+
+    attr_reader :dav_ns, :default_ns, :server_protocol
+
+    def initialize(dav_ns: 'D', server_protocol: 'HTTP/1.1')
+      @dav_ns = dav_ns
+      @default_ns = { "xmlns:#{@dav_ns}" => 'DAV:' }
+      @server_protocol = server_protocol
+    end
+
+    def lock_res(activelock_properties)
+      build :prop do |xml|
+        xml.lockdiscovery do
+          activelock_properties.each do |properties|
+            activelock xml, properties
+          end
+        end
+      end
+    end
+
+    def propfind_res(path, properties)
+      multistatus do |xml|
+        href xml, path
+        propstat xml, properties[:found], :ok
+        propstat xml, properties[:not_found], :not_found
+      end
+    end
+
+    def proppatch_res(path, actions)
+      multistatus do |xml|
+        href xml, path
+        propstat xml, actions[:set]
+        propstat xml, actions[:remove]
+      end
+    end
+
+    private
+
+    def build(tag)
+      Nokogiri::XML::Builder.new do |xml|
+        xml[@dav_ns].send(tag, @default_ns) do
+          yield xml
+        end
+      end.to_xml
+    end
+
+    def activelock(xml, property_set)
+      xml.activelock do
+        property_set.each do |property|
+          property_drilldown xml, property
+        end
+      end
+    end
+
+    def href(xml, path)
+      xml.href path
+    end
+
+    def multistatus
+      build :multistatus do |xml|
+        xml.response do
+          yield xml
+        end
+      end
+    end
+
+    def prop(xml, property_set)
+      xml.prop do
+        property_set.each do |property|
+          property_drilldown xml, property
+        end
+      end
+    end
+
+    def propstat(xml, property_set, status=:ok)
+      return unless property_set.length > 0
+
+      xml.propstat do
+        prop xml, property_set
+        status xml, status
+      end
+    end
+
+    def resourcetype(xml, property)
+      if property.children.text == 'collection'
+        xml[@dav_ns].resourcetype do
+          xml.send 'collection'
+        end
+      else
+        xml[@dav_ns].resourcetype
+      end
+    end
+
+    def status(xml, status)
+      xml.status status_message status
+    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
+
+    def property_drilldown(xml, property)
+      if property.is_a? Array
+        property.each do |prop|
+          property_drilldown xml, prop
+        end
+      elsif property.children && property.text.nil?
+        xml.send property.name do
+          property.children.each do |child|
+            property_drilldown xml, child
+          end
+        end
+      elsif property.name == 'resourcetype'
+        resourcetype xml, property
+      elsif property.name == 'timeout'
+        timeout xml, property
+      elsif SUPPORTED_NS_TAGS.include? property.name
+        xml[@dav_ns].send property.name do
+          xml.text property.text
+        end
+      elsif property.namespace && property.namespace.href
+        xml.send property.name, xmlns: property.namespace.href do
+          xml.text property.text
+        end
+      else
+        xml.send property.name, property.text do
+          xml.parent.namespace = nil
+        end
+      end
+    end
+
+    def status_message(status)
+      status_code = Rack::Utils.status_code status
+      [@server_protocol, status_code, Rack::Utils::HTTP_STATUS_CODES[status_code]].join ' '
+    end
+  end
+end

data/lib/calligraphy/xml/namespace.rb

@@ -0,0 +1,10 @@
+module Calligraphy::XML
+  class Namespace
+    attr_accessor :href, :prefix
+
+    def initialize(namespace)
+      @href = namespace.href if namespace.href
+      @prefix = namespace.prefix if namespace.prefix
+    end
+  end
+end

data/lib/calligraphy/xml/node.rb

@@ -0,0 +1,23 @@
+module Calligraphy::XML
+  class Node
+    attr_accessor :children, :name, :namespace, :text
+
+    def initialize(node=nil)
+      unless node.nil?
+        @name = node.name
+        @text = node.text unless node.text.empty?
+
+        if node.namespace
+          @namespace = Calligraphy::XML::Namespace.new node.namespace
+        end
+
+        if node.children&.length > 0
+          @children = []
+          node.children.each do |child|
+            @children.push Calligraphy::XML::Node.new child
+          end
+        end
+      end
+    end
+  end
+end

data/lib/calligraphy/xml/utils.rb

@@ -0,0 +1,18 @@
+module Calligraphy::XML
+  module Utils
+    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 n&.href == Calligraphy::DAV_NS && !n.prefix.nil?
+      end
+      namespace
+
+      node = node.split(' ').map! { |n| namespace + n }.join(' ') if namespace
+
+      xml.css(node).children
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,46 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  # config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: calligraphy
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Brandon Robins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: WebDAV framework and extension for Rails 5
+email: brandon@onebnottwo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/calligraphy.rb
+- lib/calligraphy/copy.rb
+- lib/calligraphy/delete.rb
+- lib/calligraphy/file_resource.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_requests_controller.rb
+- lib/calligraphy/resource.rb
+- lib/calligraphy/unlock.rb
+- lib/calligraphy/utils.rb
+- lib/calligraphy/version.rb
+- lib/calligraphy/web_dav_request.rb
+- lib/calligraphy/xml/builder.rb
+- lib/calligraphy/xml/namespace.rb
+- lib/calligraphy/xml/node.rb
+- lib/calligraphy/xml/utils.rb
+- spec/spec_helper.rb
+homepage: http://www.github.com/eanlain/calligraphy
+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.6.14
+signing_key: 
+specification_version: 4
+summary: WebDAV framework and extension for Rails 5
+test_files:
+- spec/spec_helper.rb