vidibus-pureftpd 0.1.0 → 1.0.0

data/README.md

@@ -1,43 +1,69 @@
 # Vidibus::Pureftpd
 
-Allows control of [Pure-FTPd](http://www.pureftpd.org/project/pure-ftpd), the free, secure, production-quality and standard-conformant FTP server.
+Provides an ActiveModel-based abstraction of Pure-FTPd's [virtual users](http://download.pureftpd.org/pub/pure-ftpd/doc/README.Virtual-Users). [Pure-FTPd](http://www.pureftpd.org/project/pure-ftpd) is a free, secure, production-quality and standard-conformant FTP server.
 
-This gem is part of [Vidibus](http://vidibus.org), an open source toolset for building distributed (video) applications.
-
-## Installation
-
-Add the dependency to the Gemfile of your application: `gem 'vidibus-pureftpd'`. Then call bundle install on your console.
+This gem is part of [Vidibus](http://vidibus.org), an open source toolset for building distributed (video) applications. It has been tested with Ruby 1.8.7 and 1.9.3.
 
 
 ## Usage
 
-Add a user:
+Basic CRUD operations are available for `Vidibus::Pureftpd::User`:
 
-```
-Vidibus::Pureftpd.add_user({
-  :login => 'someuser',
+```ruby
+user = Vidibus::Pureftpd::User.new(
+  :login => 'my_user',
   :password => 'verysecret',
-  :directory => '/tmp'
-})
-```
+  :directory => '/home/my_user'
+)
+# => returns a new user instance
 
-Delete a user:
+user = Vidibus::Pureftpd::User.create(
+  :login => 'my_user',
+  :password => 'verysecret',
+  :directory => '/home/my_user'
+)
+# => creates a new user and returns the instance
 
+user = Vidibus::Pureftpd::User.find_by_login('my_user')
+# => reads user from database and returns an user instance
+
+user.save
+# => saves user to database and returns true
+
+user.destroy
+# => removes user from database
 ```
-Vidibus::Pureftpd.delete_user(:login => 'someuser')
-```
 
-Change a user's password:
+Additionally, some methods are provided for your convenience:
+
+```ruby
+user.valid?
+# => returns true if user is valid
+
+user.persisted?
+# => returns true if user has been saved to database
 
+user.reload
+# => reloads user from database
 ```
-Vidibus::Pureftpd.change_password({
-  :login => 'someuser',
-  :password => 'whatever'
-})
+
+By default, `Vidibus::Pureftpd` will use these settings which you may override:
+
+```ruby
+Vidibus::Pureftpd.settings[:sysuser]        # => 'pureftpd_user'
+Vidibus::Pureftpd.settings[:sysgroup]       # => 'pureftpd_group'
+Vidibus::Pureftpd.settings[:password_file]  # => '/etc/pure-ftpd/pureftpd.passwd'
 ```
 
 
-## Install Pure-FTPd on Debian Lenny
+## Installation
+
+Add the dependency to the Gemfile of your application: `gem 'vidibus-pureftpd'`. Then call bundle install on your console.
+
+Installation of the Pure-FTPd server itself is quite simple:
+
+
+### Install Pure-FTPd on Debian Lenny
 
 Get the package:
 
@@ -112,13 +138,13 @@ Finally, (re)start Pure-FTPd:
 For more instructions, please [check this resource](http://linux.justinhartman.com/PureFTPd_Installation_and_Setup).
 
 
-## Install Pure-FTPd on OSX for testing
+### Install Pure-FTPd on OSX (required for testing this gem)
 
 ```
 brew install pure-ftpd
 ```
 
-Create the user `pureftpd_user` with ID 483:
+In order to perform the tests, a certain user is required. Create the user `pureftpd_user` with ID 483:
 
 ```
 sudo dscl . create /Users/pureftpd_user uid 483
@@ -127,7 +153,7 @@ sudo dscl . create /Users/pureftpd_user UserShell /etc/pure-ftpd
 sudo dscl . create /Users/pureftpd_user NFSHomeDirectory /dev/null
 ```
 
-Create the group `pureftpd_group` with ID 483:
+Then create the group `pureftpd_group`, also with ID 483:
 
 ```
 sudo dscl . create /Groups/pureftpd_group gid 483
@@ -141,21 +167,14 @@ dscacheutil -q user
 dscacheutil -q group
 ```
 
-Ensure that the database exists and is writable for the user that executes RSpec:
-
-```
-sudo mkdir /etc/pure-ftpd/
-sudo touch /etc/pure-ftpd/pureftpd.passwd
-sudo chown -R `whoami` /etc/pure-ftpd/
-```
 
-To start the server (not needed for testing), type:
+Not needed for testing, but to start the server, type:
 
 ```
 sudo /usr/local/sbin/pure-ftpd &
 ```
 
-You should be able to connect via ftp:
+You should now be able to connect via ftp:
 
 ```
 ftp localhost
@@ -164,7 +183,27 @@ ftp localhost
 Shut it down with:
 
 ```
-pkill pure-ftpd
+sudo pkill pure-ftpd
+```
+
+
+## TODO
+
+Implement all user options offered by Pure-FTPd:
+
+```
+  -t <download bandwidth>
+  -T <upload bandwidth>
+  -n <max number of files>
+  -N <max Mbytes>
+  -q <upload ratio>
+  -Q <download ratio>
+  -r <allow client host>
+  -R <deny client host>
+  -i <allow local host>
+  -I <deny local host>
+  -y <max number of concurrent sessions>
+  -z <hhmm>-<hhmm>
 ```
 
 

data/Rakefile

@@ -5,7 +5,7 @@ require 'rdoc/task'
 require 'rspec'
 require 'rspec/core/rake_task'
 
-require 'vidibus/pureftpd'
+require 'vidibus/pureftpd/version'
 
 Bundler::GemHelper.install_tasks
 

data/config/locales/de.yml

@@ -0,0 +1,8 @@
+de:
+  errors:
+    messages:
+      taken: 'ist bereits vergeben'
+      not_existent: 'gibt es nicht'
+      not_a_directory: 'muss ein Verzeichnis sein'
+      not_readable: 'muss lesbar sein'
+      not_writable: 'muss beschreibbar sein'

data/config/locales/en.yml

@@ -0,0 +1,8 @@
+en:
+  errors:
+    messages:
+      taken: 'has already been taken'
+      not_existent: 'does not exist'
+      not_a_directory: 'must be a directory'
+      not_readable: 'must be readable'
+      not_writable: 'must be writable'

data/lib/vidibus-pureftpd.rb

@@ -1,4 +1,6 @@
-require 'open3'
+require 'posix/spawn'
+require 'active_model'
 require 'vidibus-core_extensions'
 
 require 'vidibus/pureftpd'
+require 'vidibus/pureftpd/user'

data/lib/vidibus/pureftpd.rb

@@ -1,7 +1,5 @@
 module Vidibus
   module Pureftpd
-    VERSION = '0.1.0'
-
     class Error < StandardError; end
 
     class << self
@@ -17,60 +15,25 @@ module Vidibus
         }
       end
 
-      # Adds a new user.
-      # Required options:
-      #   :login, :password, :directory
-      def add_user(options)
-        unless options.keys?(:login, :password, :directory)
-          raise ArgumentError.new('Required options are :login, :password, :directory')
-        end
-        password = options.delete(:password)
-        cmd = 'pure-pw useradd %{login} -f %{password_file} -u %{sysuser} -g %{sysgroup} -d %{directory} -m' % settings.merge(options)
-        perform(cmd) do |stdin, stdout, stderr|
-          stdin.puts(password)
-          stdin.puts(password)
-        end
-      end
-
-      # Deletes an existing user.
-      # Required options:
-      #   :login
-      def delete_user(options)
-        unless options.key?(:login)
-          raise ArgumentError.new('Required option is :login')
-        end
-        cmd = 'pure-pw userdel %{login} -f %{password_file} -m' % settings.merge(options)
-        perform(cmd)
-      end
-
-      # Changes password of existing user.
-      # Required options:
-      #   :login, :password
-      def change_password(options)
-        unless options.keys?(:login, :password)
-          raise ArgumentError.new('Required options are :login, :password')
-        end
-        password = options.delete(:password)
-        cmd = 'pure-pw passwd %{login} -f %{password_file} -m' % settings.merge(options)
-        perform(cmd) do |stdin, stdout, stderr|
-          stdin.puts(password)
-          stdin.puts(password)
-        end
-      end
-
-      protected
-
-      # Performs given command. Accepts a block with |stdin, stdout, stderr|.
+      # Performs given command prefixed with pure-pw.
+      # Accepts a block with |stdin, stdout, stderr|.
       def perform(cmd, &block)
+        cmd = "pure-pw #{cmd}"
         error = ''
-        Open3.popen3(cmd) do |stdin, stdout, stderr|
-          yield(stdin, stdout, stderr) if block_given?
-          error = stderr.read
-        end
+        output = nil
+
+        pid, stdin, stdout, stderr = POSIX::Spawn::popen4(cmd)
+        yield(stdin, stdout, stderr) if block_given?
+        error = stderr.read
+        output = stdout.read
+
         unless error == ''
-          raise Error.new("Error while executing this command:\n#{cmd}\n\n#{error}")
+          raise Error.new("Pure-FTPd returned an error:\n#{cmd}\n\n#{error}")
         end
-        true
+        output
+      ensure
+        [stdin, stdout, stderr].each { |io| io.close if !io.closed? }
+        Process::waitpid(pid)
       end
     end
   end

data/lib/vidibus/pureftpd/user.rb

@@ -4,27 +4,56 @@ module Vidibus
       include ActiveModel::Validations
       include ActiveModel::Dirty
 
-      attr_accessor :login, :password, :directory
+      class Error < Vidibus::Pureftpd::Error; end
+      class DocumentNotFound < Error; end
+
+      ACCESSSORS = [:login, :password, :directory]
+
+      ACCESSSORS.each do |attribute|
+        class_eval <<-EOS
+          def #{attribute}=(value)
+            unless @#{attribute} == value
+              #{attribute}_will_change!
+              @#{attribute} = value
+            end
+          end
+
+          def #{attribute}
+            @#{attribute}
+          end
+        EOS
+      end
 
-      validate :login, :password, :directory, :presence => true
-      validates :unique_login
+      define_attribute_methods ACCESSSORS
+
+      validates :password, :directory, :presence => true
+      validates :login, :format => { :with => /^[a-z_]+$/ }
+      validate :unique_login?, :if => :login_changed?
+      validate :valid_directory?, :if => :directory_changed?
 
       def initialize(values = {})
-        attributes = values
+        self.attributes = values
+        @persisted = false
       end
 
       def save
+        return false unless valid? && changed?
         persisted? ? update : create
+        @previously_changed = changes
+        @changed_attributes.clear
+        @persisted = true
       end
 
       def destroy
-        cmd = 'userdel %{login} -f %{password_file} -m' % settings
+        return false unless persisted? && login_was
+        cmd = "userdel #{login_was} -f %{password_file} -m" % settings
         perform(cmd)
-        user.instance_variable_set('@is_persisted', false)
+        instance_variable_set('@persisted', false)
+        self
       end
 
       def persisted?
-        @is_persisted || User.find(login)
+        @persisted
       end
 
       def attributes
@@ -35,50 +64,91 @@ module Vidibus
         hash
       end
 
-      def attributes=(values)
-        values.each {|a| self.send("#{a}=")}
+      def attributes=(hash)
+        hash.each do |key, value|
+          send("#{key}=", value)
+        end
       end
 
       def reload
-        attributes = User.find(login).attributes
-      end
-
-      def settings
-        attributes.merge(Vidibus::Pureftpd.settings)
+        if persisted? && login_was && (user = User.find_by_login(login_was))
+          self.attributes = user.attributes
+          self
+        else
+          raise DocumentNotFound
+        end
       end
 
       class << self
 
-        def find(login)
-          cmd = 'show %{login} -f %{password_file}' % settings
-          data = Vidibus::Pureftpd.perform(cmd)
+        def find_by_login(login)
+          cmd = "show #{login} -f %{password_file}" %
+            Vidibus::Pureftpd.settings
+          begin
+            data = Vidibus::Pureftpd.perform(cmd)
+          rescue Vidibus::Pureftpd::Error => e
+            if e.message.match('Unable to fetch info about user')
+              return nil
+            else
+              raise e
+            end
+          end
+
           attributes = {}
+          data.scan(/(#{ACCESSSORS.join('|')})\s*:\s*(.+)/i).each do |key, value|
+            attributes[key.downcase] = value
+          end
+
           User.new(attributes).tap do |user|
-            user.instance_variable_set('@is_persisted', true)
+            user.instance_variable_set('@persisted', true)
           end
         end
 
         def create(attributes)
-
+          new(attributes).tap do |user|
+            user.save
+          end
         end
       end
 
       private
 
-      def unique_login
-        puts %(login = #{login.inspect})
-        puts %(login_was = #{login_was.inspect})
+      def settings
+        attributes.merge(Vidibus::Pureftpd.settings)
+      end
+
+      def unique_login?
+        return unless login.present?
+        if User.find_by_login(login)
+          self.errors.add(:login, :taken)
+        end
+      end
+
+      def valid_directory?
+        return unless directory.present?
+        if !File.exist?(directory)
+          self.errors.add(:directory, :not_existent)
+        elsif !File.directory?(directory)
+          self.errors.add(:directory, :not_a_directory)
+        elsif !File.readable?(directory)
+          self.errors.add(:directory, :not_readable)
+        elsif !File.writable?(directory)
+          self.errors.add(:directory, :not_writable)
+        end
       end
 
       def update
         if login_changed?
           a = attributes
+          destroy
+          User.create(a)
         end
         if password_changed?
           update_password
         end
-
-        # usermod
+        if changes.except(:login, :password).any?
+          update_attributes
+        end
       end
 
       def create
@@ -87,14 +157,22 @@ module Vidibus
       end
 
       def update_password
-        cmd = 'pure-pw passwd %{login} -f %{password_file} -m' % settings
+        cmd = 'passwd %{login} -f %{password_file} -m' % settings
         perform_with_password_input(cmd)
       end
 
+      def update_attributes
+        cmd = 'usermod %{login} -d %{directory} -f %{password_file} -m' % settings
+        perform(cmd)
+      end
+
+      # TODO: Dry this up. But args << &Proc.new isn't possible.
       def perform(cmd)
-        Vidibus::Pureftpd.perform(cmd)
-      rescue Vidibus::Pureftpd::Error => e
-        raise fucked
+        if block_given?
+          Vidibus::Pureftpd.perform(cmd, &Proc.new)
+        else
+          Vidibus::Pureftpd.perform(cmd)
+        end
       end
 
       def perform_with_password_input(cmd)
@@ -103,7 +181,6 @@ module Vidibus
           stdin.puts(password)
         end
       end
-
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vidibus-pureftpd
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,6 +11,22 @@ bindir: bin
 cert_chain: []
 date: 2012-09-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: posix-spawn
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: vidibus-core_extensions
   requirement: !ruby/object:Gem::Requirement
@@ -27,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -133,6 +165,8 @@ files:
 - lib/vidibus/pureftpd/version.rb
 - lib/vidibus/pureftpd.rb
 - lib/vidibus-pureftpd.rb
+- config/locales/de.yml
+- config/locales/en.yml
 - LICENSE
 - README.md
 - Rakefile
@@ -150,7 +184,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1082857674235287288
+      hash: 848917452145310950
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: