opensips-pi 0.0.4 → 0.0.5

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzBhOTQ1ZjJjOTUwYjYwMzAwYTM4MDE2YjZlNzcyNjQ4Mjc0ZDg5Nw==
+  data.tar.gz: !binary |-
+    YmNkZmI2MWQyMDU0ZjNlMTRiZDkzMTZkZDk3NDNmN2VhNGQzMzY2ZA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MjRjYTQyOTQ1NTBhMjA5ZGY0ZjIyZDVhNjUzZmQ5OTg1YmZmNmYzNTE4ZTUy
+    YTE5YWNmZjU1ODJlZDEyMjE2ZDA4MmU3NjVjMDhmZjEzOTkwZjEyYjVhODUz
+    NDY0N2NmYWUwNWE3ZDI1ZmQxZmY4MmZkYTkxYTQwODM0NDBiZDA=
+  data.tar.gz: !binary |-
+    MGU2ZGI3Nzg3Mzc5Y2M4MDljMjMxMTE0Zjg5OTEyYWVjN2YwNTU4ODI4YWJl
+    NTVkNjBjZTU3ZTFkYjk2NWVhZTAyOTY5MDQ0OGZmYWZhYzc4YTliMGFhZDA1
+    MTE5OTg1M2I4NDBlNzdhMjY5NjlhMTA3OGY3MDY2ZmU3YzY5NDM=

data/lib/opensips-pi.rb

@@ -8,30 +8,63 @@ module Opensips
     @@logger = nil
     @@bin = nil
 
+    # Returns the OpenSIPS control tool, that is "opensipsctl" by default.
+    # You can customize this with {.bin=}.
+    #
+    # @return [String]
     def self.bin
       @@bin || "opensipsctl"
     end
 
+    # Customize the OpenSIPS control tool. See {.bin} for more information.
+    #
+    # @example
+    #   Opensips::Pi.bin = "/usr/sbin/opensipsctl"
+    #   Opensips::Pi.bin #=> "/usr/sbin/opensipsctl"
+    # @param cmd [String] Path to OpenSIPS control tool.
     def self.bin=(cmd)
       @@bin = cmd
     end
 
+    # Returns an instance of Ruby's {http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html Logger} (by default)
+    # or a logger set with {.logger=}.
+    #
+    # @return [Logger]
     def self.logger
       @@logger ||= Logger.new(STDOUT)
     end
 
+    # Customize the logger. See {.logger} for more information.
+    #
+    # @example
+    #   Opensips::Pi.logger = Rails.logger
+    # @param [Logger]
     def self.logger=(klass)
       @@logger = klass
     end
 
+    # Add a new OpenSIPS user.
+    #
+    # @param user [String]
+    # @param pass [String]
+    # @param domain [String]
     def self.add(user, pass, domain=nil)
       call("#{bin} add #{identifier(user,domain).shellescape} #{pass.shellescape}")
     end
 
+    # Remove an user from OpenSIPS.
+    #
+    # @param user [String]
+    # @param domain [String]
     def self.remove(user, domain=nil)
       call("#{bin} rm #{identifier(user,domain).shellescape}")
     end
 
+    # Change user's password.
+    #
+    # @param user [String]
+    # @param pass [String] New password
+    # @param domain [String]
     def self.password(user, pass, domain=nil)
       call("#{bin} passwd #{identifier(user,domain).shellescape} #{pass.shellescape}")
     end

data/lib/opensips-pi/version.rb

@@ -1,5 +1,5 @@
 module Opensips
   module Pi
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opensips-pi
 version: !ruby/object:Gem::Version
-  version: 0.0.4
-  prerelease: 
+  version: 0.0.5
 platform: ruby
 authors:
 - Lenon Marcel
@@ -15,7 +14,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -23,7 +21,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -51,29 +48,29 @@ files:
 homepage: https://github.com/locaweb/opensips-pi
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Opensips::Pi is an OpenSIPS Provisioning Interface for Ruby.
 test_files:
 - spec/opensips_pi_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples.rb
+has_rdoc: