yapfac 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGE0MDA3MjA1NDQ5NTgxZWM3NGNlYTczZWU2ZTYxZWY2MDk0OTQxYw==
+  data.tar.gz: !binary |-
+    ODZkYjRjMjliNWUwODkwNmNhYTExOTg2NTA2MWQ2YzlmZTY1ZGZlZQ==
+SHA512:
+  metadata.gz: !binary |-
+    Nzk3NTU1OGQwZjA4MjNlODZkMTBjY2Q2YjNiNWYyMTIyNDU5MmJjYzQ4OTZk
+    YzI2Njk3ZmZjN2ZjOGNiMTUyNjM2OWI4ZjI5YTM1ZjRkMDA1ZTY3NzVkNDFh
+    YTkwMGI3ZDRjOGIyYmQxZjExYjg2YTdkYzU3M2VlZTI5NzdlYTI=
+  data.tar.gz: !binary |-
+    ODZlYmE4YTkzMmY5NzAyYzEzNTkwNDUwODY1YzM1MTgyYWYxYzcwMjU1MTRj
+    NmU3ODU3ZTU5MjQ2YmYzNWYyNWJmYWU2MWNjMDJlZDc0OGI3NWY4YjI0OTE0
+    ZDI5MTBmZGZhN2Y4NDdjOTE2MzRiNjE5YjgyNDc2NDBhYjI5NDY=

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+before_install: gem install bundler -v 1.10.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yapfac.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# YAPFAC: Yet Another Parser for Apache Configuration
+
+YAPFAC provides a parser to read and write Apache configuration files. YAPFAC also provides a secure RESTful API for doing this remotely, providing seamless controll of a number of Apache servers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yapfac', git: 'eiwi1101/yapfac'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yapfac
+
+## Configuration
+
+Before using Yapfac, configure the gem in an initializer or some other useful place. The following are the default configuration options.
+
+```ruby
+Yapfac.configure do |config|
+
+  # Apache Default Options
+  config.apache_path = "/etc/apache2"
+  config.sites_available_path = "sites-available"
+  config.sites_enabled_path = "sites-enabled"
+
+end
+```
+
+## Usage
+
+```ruby
+default = Yapfac::Apache::Site.new("/etc/apache2/sites-available/000-default.conf")
+puts default.to_s #=> Converts the config back into Apache Config format.
+puts default.to_h #=> Converts the config into a hash.
+
+sites = Yapfac::Apache.sites_available
+puts sites.first.to_s #=> Dumps the configuration file for the first site in sites-available
+
+online = Yapfac::Apache.sites_enabled #=> Just reads the sites-enabled dir.
+
+### COMING SOON
+
+Yapfac::Apache.a2ensite  "example.com.conf" #=> Enables site
+Yapfac::Apache.a2dissite "000-default.conf" #=> Disables site
+
+# Self-explanatory
+Yapfac::Apache.reload
+Yapfac::Apache.restart
+
+Yapfac::Apache.a2ensite! "example.com.conf" #=> Enables site and reloads Apache. Same for ::a2dissite.
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+For ease in testing, you can modify `bin/quicktest` to run through some real-world scenarios. (Currently, `bin/quicktest` requires apache2 to be installed.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/eiwi1101/yapfac. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "yapfac"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/quicktest

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby
+$: << 'lib'
+
+require 'yapfac'
+require 'json'
+
+Yapfac::Apache.sites_available.each do |site|
+  v = Yapfac::Apache::Site.new(site)
+
+  puts "=" * 80
+  puts v.name
+  puts "-" * 80
+  puts v.to_s
+  puts "-" * 80
+  puts JSON.pretty_generate v.to_h
+end

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/yapfac/apache/directive.rb

@@ -0,0 +1,42 @@
+module Yapfac
+class  Apache
+class  Directive
+
+  attr_accessor :name, :params
+
+  def initialize(name, params = nil)
+    @name   = name
+    @params = parse(params)
+  end
+
+  def to_s
+    "#{@name} #{@params.collect do |p|
+      if p =~ /\s/
+        "\"#{p}\""
+      else
+        p
+      end
+    end.join(' ')}"
+  end
+
+  def to_h
+    return ({
+      name: @name,
+      params: @params
+    })
+  end
+
+private
+
+  def parse(params)
+    return Array.new if params.nil?
+
+    return params.
+      split(/\s(?=(?:[^'"]|'[^']*'|"[^"]*")*$)/).
+      select { |s| not s.empty? }.
+      map    { |s| s.gsub(/(^\s+)|(\s+$)|(^["']+)|(["']+$)/, '') }
+  end
+
+end
+end
+end

data/lib/yapfac/apache/scope.rb

@@ -0,0 +1,64 @@
+module Yapfac
+class  Apache
+class  Scope
+
+  attr_reader :name, :params, :parent
+
+  def initialize(name = nil, params = nil, parent = nil)
+    @name   = name
+    @params = params.nil? ? Array.new : params.split(/\s+/)
+    @parent = parent
+
+    @directives = Array.new
+    @scopes     = Array.new
+  end
+
+  def add_directive(line)
+    @directives.push(line)
+  end
+
+  def add_scope(scope)
+    if scope == self
+      raise "Scope can not be a child of itsself."
+    end
+
+    @scopes.push(scope)
+  end
+
+  def to_h
+    return({
+      name: @name,
+      params: @params,
+      directives: @directives.collect(&:to_h),
+      scopes: @scopes.collect(&:to_h)
+    })
+  end
+
+  def to_s
+    # TODO: Figure out a cleaner indentation method.
+
+    out = Array.new
+    tab = @parent.nil? ? "" : "\t"
+
+    unless parent.nil?
+      out << "<#{@name} #{@params.join(' ')}>"
+    end
+
+    unless @directives.empty?
+      out << @directives.collect { |d| d.to_s.prepend(tab) }
+    end
+
+    unless @scopes.empty?
+      out << @scopes.collect { |s| s.to_s.split("\n").collect { |v| v.prepend(tab) }.join("\n") }
+    end
+
+    unless parent.nil?
+      out << "</#{@name}>"
+    end
+
+    return out.join("\n")
+  end
+
+end
+end
+end

data/lib/yapfac/apache/site.rb

@@ -0,0 +1,50 @@
+module Yapfac
+class  Apache
+class  Site < Scope
+
+  def initialize(filename)
+    super()
+    @name = File.basename(filename, '.conf')
+    @config_lines = read_file(filename)
+    parse!
+  end
+
+private
+
+  def read_file(filename)
+    lines = File.read(filename)
+    lines.gsub!("\\\n", '')
+
+    lines_a = lines.split("\n").map(&:strip!)
+    lines_a.reject! { |l| l =~ /^\s*(?:#.*)?$/ }
+    lines_a.reject! &:nil?
+    lines_a.map     { |l| l.gsub! /\s+/, ' ' }
+
+    return lines_a
+  end
+
+  def parse!
+    scope = self
+
+    @config_lines.each do |line|
+      # Enter Child Scope
+      if line =~ /^<(\w+)\s*(.*)?>$/
+        new_scope = Yapfac::Apache::Scope.new($1, $2, scope)
+        scope.add_scope(new_scope)
+        scope = new_scope
+
+      # Exit Child Scope
+      elsif line =~ /^<\/#{scope.name}>$/
+        scope = scope.parent
+
+      # Add Directive
+      elsif line =~ /^(\w+)\s*(.*)$/
+        directive = Yapfac::Apache::Directive.new($1, $2)
+        scope.add_directive(directive)
+      end
+    end
+  end
+
+end
+end
+end

data/lib/yapfac/apache.rb

@@ -0,0 +1,24 @@
+# Load Apache deps
+require 'yapfac/apache/directive'
+require 'yapfac/apache/scope'
+require 'yapfac/apache/site'
+#require 'yapfac/apache/directive'
+
+# Autoload Directives
+
+module Yapfac
+class Apache
+
+  def initialize
+  end
+
+  def self.sites_available
+    Dir[File.join(Yapfac.configuration.apache_path, Yapfac.configuration.sites_available_path, '*.conf')]
+  end
+
+  def self.sites_enabled
+    Dir[File.join(Yapfac.configuration.apache_path, Yapfac.configuration.sites_enabled_path, '*.conf')]
+  end
+
+end
+end

data/lib/yapfac/version.rb

@@ -0,0 +1,3 @@
+module Yapfac
+  VERSION = "0.1.0"
+end

data/lib/yapfac.rb

@@ -0,0 +1,28 @@
+require "yapfac/version"
+require "yapfac/apache"
+
+module Yapfac
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configuration=(configuration)
+    @configuration = configuration
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  class Configuration
+    attr_accessor :apache_path
+    attr_accessor :sites_available_path
+    attr_accessor :sites_enabled_path
+
+    def initialize
+      @apache_path = "/etc/apache2"
+      @sites_available_path = "sites-available"
+      @sites_enabled_path = "sites-enabled"
+    end
+  end
+end

data/yapfac.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yapfac/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yapfac"
+  spec.version       = Yapfac::VERSION
+  spec.authors       = ["William Eisert"]
+  spec.email         = ["weisert@eisertdev.com"]
+
+  spec.summary       = %q{Yet Another Parser for Apache Configuration}
+  spec.description   = %q{Parsing and manipulation gem for Apache configuration files. Can also be used to control remote servers using a secure RESTful API. Think, Webmin.}
+  spec.homepage      = "https://github.com/eiwi1101/yapfac"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: yapfac
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- William Eisert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.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: Parsing and manipulation gem for Apache configuration files. Can also
+  be used to control remote servers using a secure RESTful API. Think, Webmin.
+email:
+- weisert@eisertdev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/quicktest
+- bin/setup
+- lib/yapfac.rb
+- lib/yapfac/apache.rb
+- lib/yapfac/apache/directive.rb
+- lib/yapfac/apache/scope.rb
+- lib/yapfac/apache/site.rb
+- lib/yapfac/version.rb
+- yapfac.gemspec
+homepage: https://github.com/eiwi1101/yapfac
+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.5.0
+signing_key: 
+specification_version: 4
+summary: Yet Another Parser for Apache Configuration
+test_files: []