blix-opds 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7f6de58bb54ea5536c72929758c405dc781e72b2b3bb45be7b4ceaa4f246bab
+  data.tar.gz: 033cdd38b86a12bdf0b9fb68e77858248970211c1e5c8f08a9500b236528b57e
+SHA512:
+  metadata.gz: 39d282ee7a04d1cc9e45f9b3cbf5d5e99d2c1ef4412474c08e28a87371eed084bd5b96b3bd8736b1e24728bcf9779a6dad7634d1ce4914c74e9d562ca49347b9
+  data.tar.gz: a41bf2c163b806cb98d66228da17426c8e27721f624f97c87a637d3e4f2a9ceea497cbad2d612f38a0899f2f7fd481e123a90a45bb02cf21d6d532682ba8e95a

data/README.md

@@ -0,0 +1,36 @@
+# Blix OPDS Generator
+
+Blix OPDS Generator is a Ruby gem that allows you to easily create OPDS (Open Publication Distribution System) catalogs for your digital content. It's designed to work seamlessly with Blix applications but can be used in any Ruby project.
+
+## Features
+
+- Generate OPDS-compliant XML catalogs
+- Support for nested directory structures
+- Automatic MIME type detection for common file types
+- Security measures to prevent unauthorized directory access
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blix-opds'
+```
+## Web example
+To use this in a blix web application, you might do something like this:
+
+```ruby
+      require 'blix/rest'
+      require 'blix/opds'
+
+      class Controller < Blix::Rest::Controller
+
+        include Blix::OPDS::Routes
+        
+        opds_routes :root=>'/Data/Books', :url=>'http://192.168.1.34:3000', :prefix=>'opds'
+
+        
+      end
+
+      run Blix::Rest::Server.new
+```

data/lib/blix/opds/generator.rb

@@ -0,0 +1,120 @@
+require 'nokogiri'
+require 'time'
+require 'securerandom'
+require 'uri'
+
+module Blix
+  module OPDS
+    class Generator
+      def initialize(root_path, url_prefix, options={})
+        @options    = options
+        @root_path  = root_path
+        @url_prefix = url_prefix.chomp('/') # Remove trailing slash if present
+        @types = (@options[:types] || []).map(&:to_s)
+      end
+
+      def process(relative_path = '')
+        # Remove any leading slashes from relative_path
+        relative_path = relative_path.gsub(/^\/+/, '')
+        normalized_path = File.expand_path(relative_path, @root_path)
+        
+        # Ensure the normalized_path is still within the root_path
+        unless normalized_path.start_with?(@root_path)
+          raise SecurityError, "Access to paths outside the root directory is not allowed"
+        end
+        
+        if File.directory?(normalized_path)
+          generate_listing(normalized_path, relative_path)
+        elsif File.file?(normalized_path)
+          serve_file(normalized_path)
+        else
+          nil
+        end
+      end
+
+      private
+
+      def generate_listing(dir_path, relative_path)
+        feed = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+          xml.feed(xmlns: 'http://www.w3.org/2005/Atom',
+                   'xmlns:dcterms' => 'http://purl.org/dc/terms/',
+                   'xmlns:opds' => 'http://opds-spec.org/2010/catalog') {
+            xml.id "urn:uuid:#{SecureRandom.uuid}"
+            xml.title "Directory: #{relative_path}"
+            xml.updated Time.now.iso8601
+            xml.author { xml.name "Blix OPDS" }
+
+            # Add navigation link to parent directory if not at root
+            unless relative_path.empty?
+              parent_path = relative_path.split('/')[0..-2].join('/')
+              parent_url  = parent_path.empty? ? @url_prefix : url_for(parent_path)
+              xml.link(rel: 'up', href: parent_url, type: 'application/atom+xml;profile=opds-catalog;kind=navigation')
+            end
+
+            # List entries
+            Dir.entries(dir_path).sort_by(&:downcase).each do |entry|
+              next if entry.start_with?('.') # Skip hidden files
+            
+              full_entry_path = File.join(dir_path, entry)
+              entry_type = File.directory?(full_entry_path) ? 'directory' : 'file'
+              entry_url  = url_for(File.join(relative_path,entry))
+              file_type  = File.extname(entry)[1..-1].to_s.downcase
+              next unless (entry_type == 'directory') || @types.empty? || @types.include?(file_type)
+            
+              xml.entry {
+                xml.id "urn:uuid:#{SecureRandom.uuid}"
+                xml.title entry
+                xml.updated File.mtime(full_entry_path).iso8601
+                
+                if entry_type == 'directory'
+                  xml.link(rel: 'subsection', 
+                           href: entry_url, 
+                           type: 'application/atom+xml;profile=opds-catalog;kind=navigation')
+                else
+                  xml.link(rel: 'http://opds-spec.org/acquisition', 
+                           href: entry_url, 
+                           type: guess_mime_type(entry))
+                end
+            
+                xml['dcterms'].format entry_type
+              }
+            end
+          }
+        end
+
+        feed.to_xml
+      end
+      
+      def serve_file(file_path)
+        # This method would be responsible for serving the actual file content
+        # In a real application, you'd set appropriate headers and return the file content
+        # For now, we'll just return a hash with file info
+        {
+          path: file_path,
+          mime_type: guess_mime_type(file_path),
+          size: File.size(file_path)
+        }
+      end
+
+      def guess_mime_type(filename)
+        case File.extname(filename).downcase
+        when '.pdf'  then 'application/pdf'
+        when '.epub' then 'application/epub+zip'
+        when '.mobi' then 'application/x-mobipocket-ebook'
+        else 'application/octet-stream'
+        end
+      end
+
+      # ensure all parts of a path are properly encoded
+      def encode_path(path)
+        path.split('/').map { |part| URI.encode_www_form_component(part) }.join('/')
+      end
+
+      def url_for(path)
+        File.join(@url_prefix, encode_path(path))
+      end
+
+     
+    end
+  end
+end

data/lib/blix/opds/routes.rb

@@ -0,0 +1,69 @@
+module Blix
+  module OPDS
+
+    module Routes
+
+      OPTIONS = {:accept=>:*, :force=>:raw, :extension=>false}
+
+      module ClassMethods
+        attr_reader :opds_root, :opds_prefix, :opds_options, :opds_url_prefix
+
+        def opds_path
+          File.join(@opds_prefix ||'/','*path')
+        end
+
+        def opds_routes(options={})
+          @opds_options = options
+
+          @opds_prefix = @opds_options[:prefix] || '/'
+          @opds_prefix = '/' + @opds_prefix unless @opds_prefix[0]=='/'
+
+          @opds_root   = @opds_options[:root] || raise( 'Missing root path for OPDS catalog file system')
+          @opds_url_prefix = @opds_options[:url] || raise( 'Missing url root for OPDS catalog')
+          @opds_url_prefix = File.join(@opds_url_prefix, @opds_prefix)
+
+          route 'GET',  opds_path , OPTIONS do
+            result  = get_handler.process( path_params[:path])
+
+            if result.is_a?(String)
+              add_headers 'content-type'=>'application/atom+xml'
+              result 
+            elsif result.is_a?(Hash)
+              data = File.read( result[:path] )
+              send_data data, :type=>result[:mime_type]
+            else
+              send_error 'not found', 404
+            end
+          rescue SecurityError
+            send_error 'invalid request'
+          end
+
+         
+        end
+
+      end # ClassMethods
+      
+
+      def opds_params(hash)
+        @opds_params ||= {}
+        @opds_params.merge!(hash)
+      end
+
+      def _params
+        self.class.opds_options.merge(@opds_params || {})
+      end
+
+      def get_handler
+        Generator.new(self.class.opds_root, self.class.opds_url_prefix, _params)
+      end
+
+      private
+
+      def self.included(mod)
+        mod.extend ClassMethods
+      end
+    end # Routes
+
+
+  end
+end

data/lib/blix/opds/version.rb

@@ -0,0 +1,5 @@
+module Blix
+  module OPDS
+    VERSION = "0.1.0"
+  end
+end

data/lib/blix/opds.rb

@@ -0,0 +1,9 @@
+require_relative 'opds/version'
+require_relative 'opds/generator'
+require_relative 'opds/routes'
+
+module Blix
+  module OPDS
+    # Any module-level code or configuration
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: blix-opds
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Clive Andrews
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+description: A library for generating OPDS (Open Publication Distribution System)
+  catalogs in Blix applications
+email:
+- pacman@realitybites.eu
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/blix/opds.rb
+- lib/blix/opds/generator.rb
+- lib/blix/opds/routes.rb
+- lib/blix/opds/version.rb
+homepage: https://github.com/yourusername/blix-opds
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: OPDS catalog generator for Blix
+test_files: []