opensips-pi 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGNkZWNmOTRlMzgxMmVmOTgwMGM4ZTM4MjMxNTI5ZmQ1MTFhY2JkMA==
+  data.tar.gz: !binary |-
+    MmI0M2U3M2FhNjhkNmM0YjBhYTQwMmJkOGJkNTU5MDJmOWE5MzVjOQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YTc4YTJiOWZiMDJlNTA0YjY5ZjIwMzU0OGJhZDYxNjU3YTA2NmI3YTk4YzYz
+    ZTljYmE2NjMyZTkyZGYwOGVmYmRhZjAzNzg2ZGVlMzU3NTJjYjFkOWRmNDMx
+    MGUwNzEwZjI0OGU0MDljNjQ1YzVmZmMyYjUyZjYxOTUxYzI5Njg=
+  data.tar.gz: !binary |-
+    YTg4NmQ3MzZiYjMwMTc4YzI5M2FjNGYyMmIyMDNhYWNmNmEyNzQ3MmQzYTBh
+    MzE4Yjg2MzQxOWMzMjg1ZDI3OGNmZmQwNzNmYTk4OTE2N2FiZWYwM2U1NTU1
+    Y2RhZDIyNmU0NzlhMDUwNmU2Y2Q0MDc4ZmExMDljNjBmY2E0NWM=

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Vagrantfile
+.vagrant

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Locaweb <development@locaweb.com.br>
+
+MIT License
+
+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,55 @@
+## Opensips::Pi
+
+Opensips::Pi is an OpenSIPS Provisioning Interface for Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'opensips-pi'
+
+And then execute:
+
+    $ bundle
+
+Or manually install it:
+
+    $ gem install opensips-pi
+
+## Configuration
+
+By default, `opensipsctl` is used to run all commands. You can change this as the following:
+
+    Opensips::Pi.bin = "/usr/sbin/opensipsctl"
+
+To log information, an instance of [Logger](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html) is used by default. You can also change this:
+
+    Opensips::Pi.logger = Rails.logger
+
+## Usage
+
+To add a new user:
+
+    Opensips::Pi.add("username", "password")
+
+To remove an user:
+
+    Opensips::Pi.remove("username")
+
+To change user's password:
+
+    Opensips::Pi.password("username", "new_password")
+
+More methods will be available soon. Feel free to fork this project and contribute with pull requests.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+This project is released under the MIT License. See LICENSE.txt for more information.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/opensips-pi.rb

@@ -0,0 +1,52 @@
+require "opensips-pi/version"
+require "open3"
+require "logger"
+
+module Opensips
+  module Pi
+    @@logger = nil
+    @@bin = nil
+
+    def self.bin
+      @@bin || "opensipsctl"
+    end
+
+    def self.bin=(cmd)
+      @@bin = cmd
+    end
+
+    def self.logger
+      @@logger ||= Logger.new(STDOUT)
+    end
+
+    def self.logger=(klass)
+      @@logger = klass
+    end
+
+    def self.add(user, pass, domain=nil)
+      call("#{bin} add #{identifier(user,domain).shellescape} #{pass.shellescape}")
+    end
+
+    def self.remove(user, domain=nil)
+      call("#{bin} rm #{identifier(user,domain).shellescape}")
+    end
+
+    def self.password(user, pass, domain=nil)
+      call("#{bin} passwd #{identifier(user,domain).shellescape} #{pass.shellescape}")
+    end
+
+    private
+    def self.identifier(user, domain)
+      domain ? "#{user}@#{domain}" : user
+    end
+
+    def self.call(cmd)
+      out, err, code = Open3.capture3(cmd)
+
+      logger.info("Opensips::Pi") { out }
+      logger.error("Opensips::Pi") { err }
+
+      [code.success?,out,err]
+    end
+  end
+end

data/lib/opensips-pi/version.rb

@@ -0,0 +1,5 @@
+module Opensips
+  module Pi
+    VERSION = "0.0.2"
+  end
+end

data/opensips-pi.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'opensips-pi/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "opensips-pi"
+  gem.version       = Opensips::Pi::VERSION
+  gem.authors       = ["Lenon Marcel", "Alexandre Cardoso"]
+  gem.email         = ["lenon.marcel@gmail.com", "accbel@gmail.com"]
+  gem.description   = %q{OpenSIPS provisioning interface for Ruby.}
+  gem.summary       = %q{Opensips::Pi is an OpenSIPS Provisioning Interface for Ruby.}
+  gem.homepage      = "https://github.com/locaweb/opensips-pi"
+  gem.license       = "MIT"
+
+  gem.add_development_dependency "rspec", "~> 2.13.0"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/spec/opensips_pi_spec.rb

@@ -0,0 +1,158 @@
+require "spec_helper"
+
+describe Opensips::Pi do
+  subject { Opensips::Pi }
+
+  let(:user) { "fulano" }
+  let(:domain) { "domain" }
+  let(:pass) { "senha" }
+  let(:bin) { "opensipsctl-bin" }
+
+  before do
+    subject.bin = nil
+    subject.logger = nil
+    Logger.any_instance.stub(:info => double, :error => double)
+  end
+
+  describe ".bin" do
+    it "returns opensipsctl by default" do
+      subject.bin = nil
+      subject.bin.should be == "opensipsctl"
+    end
+
+    it "returns a custom command" do
+      subject.bin = "/usr/sbin/opensipsctl"
+      subject.bin.should be == "/usr/sbin/opensipsctl"
+    end
+  end
+
+  describe ".logger" do
+    it "returns a new instance of Logger by default" do
+      subject.logger = nil
+      subject.logger.should be_kind_of Logger
+    end
+
+    it "returns a custom logger" do
+      dummy = Class.new
+      subject.logger = dummy
+      subject.logger.should be == dummy
+    end
+  end
+
+  describe ".add" do
+    before { subject.stub(:bin => bin) }
+
+    it "calls opensipsctl command with given username, domain and password" do
+      Open3.should_receive(:capture3).with("#{bin} add #{user}@#{domain} #{pass}").and_return(["foo", "bar", double(:"success?" => true)])
+
+      expect {
+        subject.add(user, pass, domain)
+      }.to_not raise_error
+    end
+
+    it "calls opensipsctl command with given username and password" do
+      Open3.should_receive(:capture3).with("#{bin} add #{user} #{pass}").and_return(["foo", "bar", double(:"success?" => true)])
+
+      expect {
+        subject.add(user, pass)
+      }.to_not raise_error
+    end
+
+    it "returns false when opensipsctl exit with 1" do
+      Open3.stub(:capture3 => ["foo", "bar", double(:"success?" => false)])
+      subject.add(user, pass).should == [false,"foo","bar"]
+    end
+
+    it "returns true when opensipsctl exit with 0" do
+      Open3.stub(:capture3 => ["foo", "bar", double(:"success?" => true)])
+      subject.add(user, pass).should be_true
+    end
+
+    it "escape arguments when calling opensipsctl" do
+      user = "user with spaces"
+      Open3.should_receive(:capture3).with("#{bin} add user\\ with\\ spaces #{pass}").and_return(["","",double(:"success?" => true)])
+
+      subject.add(user, pass)
+    end
+
+    it_behaves_like "a method that log stdout and stderr messages", :add, "fulano", "senha"
+  end
+
+  describe ".remove" do
+    before { subject.stub(:bin => bin) }
+
+    it "calls opensipsctl command with given username and domain" do
+      Open3.should_receive(:capture3).with("#{bin} rm #{user}@#{domain}").and_return(["foo", "bar", double(:"success?" => true)])
+
+      expect {
+        subject.remove(user, domain)
+      }.to_not raise_error
+    end
+
+    it "calls opensipsctl command with given username" do
+      Open3.should_receive(:capture3).with("#{bin} rm #{user}").and_return(["foo", "bar", double(:"success?" => true)])
+
+      expect {
+        subject.remove(user)
+      }.to_not raise_error
+    end
+
+    it "returns false when opensipsctl exit with 1" do
+      Open3.stub(:capture3 => ["foo", "bar", double(:"success?" => false)])
+      subject.remove(user).should == [false,"foo","bar"]
+    end
+
+    it "returns true when opensipsctl exit with 0" do
+      Open3.stub(:capture3 => ["foo", "bar", double(:"success?" => true)])
+      subject.remove(user).should be_true
+    end
+
+    it "escape arguments when calling opensipsctl" do
+      user = "user with spaces"
+      Open3.should_receive(:capture3).with("#{bin} rm user\\ with\\ spaces").and_return(["","",double(:"success?" => true)])
+
+      subject.remove(user)
+    end
+
+    it_behaves_like "a method that log stdout and stderr messages", :remove, "fulano"
+  end
+
+  describe ".password" do
+    before { subject.stub(:bin => bin) }
+
+    it "calls opensipsctl command with given username, password and domain" do
+      Open3.should_receive(:capture3).with("#{bin} passwd #{user}@#{domain} #{pass}").and_return(["foo", "bar", double(:"success?" => true)])
+
+      expect {
+        subject.password(user, pass, domain)
+      }.to_not raise_error
+    end
+
+    it "calls opensipsctl command with username and password" do
+      Open3.should_receive(:capture3).with("#{bin} passwd #{user} #{pass}").and_return(["foo", "bar", double(:"success?" => true)])
+
+      expect {
+        subject.password(user, pass)
+      }.to_not raise_error
+    end
+
+    it "returns false when opensipsctl exit with 1" do
+      Open3.stub(:capture3 => ["foo", "bar", double(:"success?" => false)])
+      subject.password(user, pass).should == [false,"foo","bar"]
+    end
+
+    it "returns true when opensipsctl exit with 0" do
+      Open3.stub(:capture3 => ["foo", "bar", double(:"success?" => true)])
+      subject.password(user, pass).should be_true
+    end
+
+    it "escape arguments when calling opensipsctl" do
+      user = "user with spaces"
+      Open3.should_receive(:capture3).with("#{bin} passwd user\\ with\\ spaces #{pass}").and_return(["","",double(:"success?" => true)])
+
+      subject.password(user, pass)
+    end
+
+    it_behaves_like "a method that log stdout and stderr messages", :password, "fulano", "senha"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'opensips-pi'
+
+Dir["spec/support/**/*.rb"].each { |f| load(f) }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,17 @@
+shared_examples "a method that log stdout and stderr messages" do |method, *args|
+  it "log stdout and stderr messages" do
+    Open3.stub(:capture3 => ["standard output", "standard error", double(:"success?" => false)])
+
+    subject.logger.should_receive(:info) { |prog, &block|
+      prog.should be == "Opensips::Pi"
+      block.call.should be == "standard output"
+    }
+
+    subject.logger.should_receive(:error) { |prog, &block|
+      prog.should be == "Opensips::Pi"
+      block.call.should be == "standard error"
+    }
+
+    subject.send(method, *args)
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: opensips-pi
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Lenon Marcel
+- Alexandre Cardoso
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+description: OpenSIPS provisioning interface for Ruby.
+email:
+- lenon.marcel@gmail.com
+- accbel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/opensips-pi.rb
+- lib/opensips-pi/version.rb
+- opensips-pi.gemspec
+- spec/opensips_pi_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+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
+  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.0.2
+signing_key: 
+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