pdns-remotebackend 0.0.4 → 0.0.5

data/Rakefile

@@ -1,9 +1,12 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
 
+require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "yard"
+require "yard/rake/yardoc_task"
 
 RSpec::Core::RakeTask.new
+YARD::Rake::YardocTask.new
 
 task :default => :spec
 task :test => :spec

data/contrib/example.rb

@@ -28,9 +28,9 @@ class RequestHandler < Pdns::Remotebackend::Handler
   def do_getdomainmetadata(args)
      if args["name"] == "example.com"
        if args["kind"] == "NSEC3NARROW"
-           result = "1"
+           @result = "1"
        elsif args["kind"] == "NSEC3PARAM"
-           result = "1 1 1 fe"
+           @result = "1 1 1 fe"
        end
      end
   end
@@ -40,7 +40,7 @@ class RequestHandler < Pdns::Remotebackend::Handler
   ## generate these
   def do_getdomainkeys(args)
      if args["name"] == "example.com"
-        result = [ 
+        @result = [ 
           {
              "id" => 1,
              "flags" => 257,
@@ -81,26 +81,26 @@ Coefficient: 5lP9IFknvFgaXKCs8MproehHSFhFTWac4557HIn03KrnlGOKDcY6DC/vgu1e42bEZ4J
   ## and dynamic A record for anything else in example.com domain 
   def do_lookup(args)
      if args["qname"] == "example.com" and args["qtype"].downcase == "soa"
-       result = [
-          record("SOA","example.com", "sns.dns.icann.org noc.dns.icann.org 2013012485 7200 3600 1209600 3600"),
+       @result = [
+          record("example.com", "SOA", "sns.dns.icann.org noc.dns.icann.org 2013012485 7200 3600 1209600 3600"),
               ]
      elsif args["qname"] == "example.com" and args["qtype"].downcase == "any"
-       result = [ 
-          record("SOA","example.com", "sns.dns.icann.org noc.dns.icann.org 2013012485 7200 3600 1209600 3600"),
-          record("NS","example.com","sns.dns.icann.org"),
-          record_prio("MX","example.com","test.example.com",10)
+       @result = [ 
+          record("SOA","example.com", "SOA", "sns.dns.icann.org noc.dns.icann.org 2013012485 7200 3600 1209600 3600"),
+          record("example.com", "NS", "sns.dns.icann.org"),
+          record_prio("example.com", "MX", "test.example.com",10)
               ]
      elsif args["qname"] == "test.example.com" and args["qtype"].downcase == "any"
-       result = [
-          record("A","test.example.com","127.0.0.1")
+       @result = [
+          record("test.example.com", "A", "127.0.0.1")
        ]
      elsif args["qname"] =~ /(.*)\.example\.com$/ and args["qtype"].downcase == "any"
        ip = 0
        $1.downcase.each_byte do |b| ip = ip + b end
        ip_2 = ip/256
        ip = ip%256
-       result = [
-          record("A",args["qname"], "127.0.#{ip_2}.#{ip}")
+       @result = [
+          record(args["qname"], "A", "127.0.#{ip_2}.#{ip}")
        ]
      end
   end
@@ -111,11 +111,11 @@ Coefficient: 5lP9IFknvFgaXKCs8MproehHSFhFTWac4557HIn03KrnlGOKDcY6DC/vgu1e42bEZ4J
   ## for sake of having an example. Do not do ths in production.
   def do_list(args)
      if args["zonename"] == "example.com"
-       result = [
-          record("SOA","example.com", "sns.dns.icann.org noc.dns.icann.org 2013012485 7200 3600 1209600 3600"),
-          record("NS","example.com","sns.dns.icann.org"),
-          record_prio("MX","example.com","test.example.com",10),
-          record("A","test.example.com","127.0.0.1")
+       @result = [
+          record("example.com", "SOA", "sns.dns.icann.org noc.dns.icann.org 2013012485 7200 3600 1209600 3600"),
+          record("example.com", "NS", "sns.dns.icann.org"),
+          record_prio("example.com", "MX", "test.example.com",10),
+          record("test.example.com", "A", "127.0.0.1")
        ]
      end
   end

data/lib/pdns/remotebackend/version.rb

@@ -1,5 +1,5 @@
 module Pdns
  module Remotebackend
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
  end
 end

data/lib/pdns/remotebackend.rb

@@ -7,26 +7,51 @@ module Pdns
   class Handler
      attr_accessor :log, :result, :ttl
 
+     # Initialize with defaults values
      def initialize
        @log = []
        @result = false
        @ttl = 300
        @params = {}
      end
- 
-     def record_prio_ttl(qtype,qname,content,prio,ttl,auth=1)
+
+     # Generates a hash of resource record
+     # 
+     # @param [String] qname name of record
+     # @param [String] qtype type of record
+     # @param [String] content record contents
+     # @param [Integer] prio Record priority
+     # @param [Integer] ttl Record TTL
+     # @param [Integer] auth Whether we are authoritative for the record or not
+     # @return [Hash] A resource record hash
+     def record_prio_ttl(qname,qtype,content,prio,ttl,auth=1)
        {:qtype => qtype, :qname => qname, :content => content, :priority => prio, :ttl => ttl, :auth => auth}
      end
 
-     def record_prio(qtype,qname,content,prio,auth=1)
-       record_prio_ttl(qtype,qname,content,prio,@ttl,auth)
+     # Generates a hash of resource record
+     #
+     # @param [String] qname name of record
+     # @param [String] qtype type of record
+     # @param [String] content record contents
+     # @param [Integer] prio Record priority
+     # @param [Integer] auth Whether we are authoritative for the record or not
+     # @return [Hash] A resource record hash
+     def record_prio(qname,qtype,content,prio,auth=1)
+       record_prio_ttl(qname,qtype,content,prio,@ttl,auth)
      end
 
-     def record(qtype,qname,content,auth=1)
-       record_prio_ttl(qtype,qname,content,0,@ttl,auth)
-     end
-  
-     def do_initialize(args)
+     # Generates a hash of resource record
+     #
+     # @param [String] qname name of record
+     # @param [String] qtype type of record
+     # @param [String] content record contents
+     # @param [Integer] auth Whether we are authoritative for the record or not
+     # @return [Hash] A resource record hash
+     def record(qname,qtype,content,auth=1)
+       record_prio_ttl(qname,qtype,content,0,@ttl,auth)
+     end
+  
+     def do_initialize(*args)
        @params = args
        @log << "PowerDNS ruby remotebackend version #{Pdns::Remotebackend::VERSION} initialized"
        @result = true
@@ -117,16 +142,13 @@ module Pdns
       @options = options
     end
 
-    def open
-      [STDIN,STDOUT]
-    end
-
-    def close
-    end
-
-    def mainloop
+    # Reads one line at a time from remotebackend, and calls approriate method 
+    #
+    # @param [Socket] reader Socket to read from'
+    # @param [Socket] writer Socket to write to
+    protected 
+    def mainloop(reader,writer)
       h = @handler.new
-      reader,writer = self.open
       
       begin
         reader.each_line do |line|
@@ -137,17 +159,15 @@ module Pdns
           begin
             input = JSON.parse(line)
             method = "do_#{input["method"].downcase}"
-            args = input["parameters"] || []
+            args = input["parameters"] || {}
 
             h.result = false
             h.log = []
- 
+
             if h.respond_to?(method.to_sym) == false
                res = false
-            elsif args.size > 0
-               h.send(method,args)
             else
-               h.send(method)
+               h.send(method,args)
             end
 
             writer.puts ({:result => h.result, :log => h.log}).to_json
@@ -158,27 +178,26 @@ module Pdns
         end
       rescue SystemExit, Interrupt
       end 
-      self.close
     end
   end
- end
 
- class Pipe
-   def run
-     mainloop
-   end
- end
+  class Pipe < Connector
+    def run
+      mainloop STDIN,STDOUT
+    end
+  end
 
- class Unix 
+  class Unix < Connector
     def run
       @path = options[:path] || "/tmp/remotebackend.sock"
       Socket.unix_server_loop(@path) do |sock, client_addrinfo| 
-         begin 
-            mainloop sock, sock
-         ensure
-            sock.close
-         end
+        begin 
+           mainloop sock, sock
+        ensure
+           sock.close
+        end
       end
     end
+  end
  end
 end

data/pdns-remotebackend.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["cmouse@desteem.org"]
   gem.description   = %q{This gem provides a base class and helpers for writing remotebackend servers for pipe/unix/. It is intended to make using remotebackend easier. For http support, see pdns-remotebackend-http.}
   gem.summary       = %q{This gem provides a base class and helpers for writing remotebackend servers for pipe/unix/http post/json modes}
-  gem.homepage      = "http://github.com/cmouse/pdns-remotebackend"
+  gem.homepage      = "http://github.com/cmouse/pdns-remotebackend-gem"
   gem.license       = "MIT"
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -17,5 +17,8 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'redcarpet'
+
   gem.add_runtime_dependency 'json'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pdns-remotebackend
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &6278620 !ruby/object:Gem::Requirement
+  requirement: &6907400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *6278620
+  version_requirements: *6907400
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &6278200 !ruby/object:Gem::Requirement
+  requirement: &6906980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,32 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *6278200
+  version_requirements: *6906980
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &6906560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *6906560
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &6906140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *6906140
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &6277780 !ruby/object:Gem::Requirement
+  requirement: &6905720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +65,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *6277780
+  version_requirements: *6905720
 description: This gem provides a base class and helpers for writing remotebackend
   servers for pipe/unix/. It is intended to make using remotebackend easier. For http
   support, see pdns-remotebackend-http.
@@ -64,7 +86,7 @@ files:
 - pdns-remotebackend.gemspec
 - spec/lib/pdns_remotebackend_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/cmouse/pdns-remotebackend
+homepage: http://github.com/cmouse/pdns-remotebackend-gem
 licenses:
 - MIT
 post_install_message: 
@@ -93,3 +115,4 @@ summary: This gem provides a base class and helpers for writing remotebackend se
 test_files:
 - spec/lib/pdns_remotebackend_spec.rb
 - spec/spec_helper.rb
+has_rdoc: