vestacp2 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92cd396e93a1c6f3a0089b3fb5c58b2cda3270b4
+  data.tar.gz: 7a997be78bb56354a90c5dc8b6047506eb9ffce6
+SHA512:
+  metadata.gz: e6a4923ee4569a09fc316d4fb640ba3f82636a4eb0a56c48eaf0d80e7af3abfc7a06eb0f39e8a681466d96b9c4b05dbc4027d98175393e6f70fbf7b97c145318
+  data.tar.gz: ff3e4816308f51674e6c133b005671a2587378058d8072ffdd43a52204c404aa2b6e202cf0c2fb9a6028fb09ac19769ef69c22db26ce270404babe0e15296286

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.history/
+Untitled-1.http
+test.rb

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Dmitry K.
+
+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,96 @@
+# Vestacp
+
+VestaCP API bindings on ruby. For now, only with user accounts, but that's simple — to make it work with another api functions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vestacp2'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vestacp2
+
+## Usage
+
+```ruby
+Vestacp::Account.information({username: 'admin'})
+```
+
+will return
+```ruby
+{:error=>false,
+ :response=>
+  {"admin"=>
+    {"FNAME"=>"System",
+     "LNAME"=>"Administrator",
+     "PACKAGE"=>"default",
+     "WEB_TEMPLATE"=>"default",
+     "BACKEND_TEMPLATE"=>"",
+     "PROXY_TEMPLATE"=>"default",
+     "DNS_TEMPLATE"=>"default",
+     "WEB_DOMAINS"=>"100",
+     "WEB_ALIASES"=>"100",
+     "DNS_DOMAINS"=>"100",
+     "DNS_RECORDS"=>"100",
+     "MAIL_DOMAINS"=>"100",
+     "MAIL_ACCOUNTS"=>"100",
+     "DATABASES"=>"100",
+     "CRON_JOBS"=>"100",
+     "DISK_QUOTA"=>"10000",
+     "BANDWIDTH"=>"100000",
+     "NS"=>"ns1.localhost.ltd, ns2.localhost.ltd",
+     "SHELL"=>"bash",
+     "BACKUPS"=>"3",
+     "CONTACT"=>"a@kdas.me",
+     "CRON_REPORTS"=>"yes",
+     "RKEY"=>"YTTyCNpySz",
+     "SUSPENDED"=>"no",
+     "SUSPENDED_USERS"=>"0",
+     "SUSPENDED_WEB"=>"0",
+     "SUSPENDED_DNS"=>"0",
+     "SUSPENDED_MAIL"=>"0",
+     "SUSPENDED_DB"=>"0",
+     "SUSPENDED_CRON"=>"0",
+     "IP_AVAIL"=>"1",
+     "IP_OWNED"=>"1",
+     "U_USERS"=>"1",
+     "U_DISK"=>"0",
+     "U_DISK_DIRS"=>"0",
+     "U_DISK_WEB"=>"0",
+     "U_DISK_MAIL"=>"0",
+     "U_DISK_DB"=>"0",
+     "U_BANDWIDTH"=>"0",
+     "U_WEB_DOMAINS"=>"1",
+     "U_WEB_SSL"=>"0",
+     "U_WEB_ALIASES"=>"1",
+     "U_DNS_DOMAINS"=>"1",
+     "U_DNS_RECORDS"=>"11",
+     "U_MAIL_DOMAINS"=>"1",
+     "U_MAIL_DKIM"=>"0",
+     "U_MAIL_ACCOUNTS"=>"0",
+     "U_DATABASES"=>"1",
+     "U_CRON_JOBS"=>"7",
+     "U_BACKUPS"=>"0",
+     "LANGUAGE"=>"en",
+     "HOME"=>"/home/admin",
+     "TIME"=>"06:03:09",
+     "DATE"=>"2015-07-18"}}}
+```
+
+etc..
+
+## Contributing
+
+1. Fork it ( https://github.com/okdas/vestacp/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/vestacp.rb

@@ -0,0 +1,30 @@
+require "vestacp/version"
+
+module Vestacp
+  autoload :Config,  "vestacp/config"
+  autoload :Base,  "vestacp/base"
+  autoload :Database,  "vestacp/database"
+  autoload :Account,  "vestacp/account"
+  autoload :Domain,  "vestacp/domain"
+
+  class << self
+    attr_accessor :config
+  end
+
+  self.config ||= Config.new
+
+  # Pass a block to configure the Vestacp API
+  #
+  #   Vestacp.configure do |config|
+  #     config.api_username = 'admin'
+  #     config.api_password = 'n0passw0rd'
+  #     config.api_url      = 'https://example.com:8083/api/'
+  #   end
+
+  def self.configure
+    yield config
+    config
+  end
+end
+
+

data/lib/vestacp/account.rb

@@ -0,0 +1,116 @@
+module Vestacp
+  # Vestacp::Account is the class for managing clients
+  class Account < Base
+
+    # Create User Account
+    #
+    # Parameters:
+    #
+    # * <tt>:username</tt>
+    # * <tt>:password</tt>
+    # * <tt>:email</tt>
+    # * <tt>:package</tt>
+    # * <tt>:first_name</tt>
+    # * <tt>:last_name</tt>
+    #
+    # See:
+    #
+    # http://vestacp.com/docs/api/#add_user
+    def self.add(raw = {})
+      args = {
+        username: 'arg1',
+        password: 'arg2',
+        email: 'arg3',
+        package: 'arg4',
+        first_name: 'arg5',
+        last_name: 'arg6'
+      }
+      params = {}
+      raw.each {|key, value| params[args[key].to_sym] = value }
+      params.merge!(cmd: 'v-add-user')
+      send_request(params, raw)
+    end
+
+    # Delete User Account
+    #
+    # Parameters:
+    #
+    # * <tt>:username</tt>
+    def self.delete(raw = {})
+      args = {
+        username: 'arg1'
+      }
+      params = {}
+      raw.each {|key, value| params[args[key].to_sym] = value }
+      params.merge!(cmd: 'v-delete-user')
+      send_request(params, raw)
+    end
+
+
+    # Suspend User Account
+    #
+    # Parameters:
+    #
+    # * <tt>:username</tt>
+    def self.suspend(raw = {})
+      args = {
+        username: 'arg1'
+      }
+      params = {}
+      raw.each {|key, value| params[args[key].to_sym] = value }
+      params.merge!(cmd: 'v-suspend-user')
+      send_request(params, raw)
+    end
+
+
+    # Suspend User Account
+    #
+    # Parameters:
+    #
+    # * <tt>:username</tt>
+    def self.unsuspend(raw = {})
+      args = {
+        username: 'arg1'
+      }
+      params = {}
+      raw.each {|key, value| params[args[key].to_sym] = value }
+      params.merge!(cmd: 'v-unsuspend-user')
+      send_request(params, raw)
+    end
+
+
+    # List User Account Information
+    #
+    # Returns JSON.
+    #
+    # Parameters:
+    #
+    # * <tt>:username</tt>
+    def self.information(raw = {})
+      args = {
+        username: 'arg1'
+      }
+      params = {}
+      raw.each {|key, value| params[args[key].to_sym] = value }
+      params.merge!(cmd: 'v-list-user', arg2: 'json')
+      send_request(params, raw, true)
+    end
+
+    # Check User Account Credentials
+    #
+    # Parameters:
+    #
+    # * <tt>:username</tt>
+    # * <tt>:password</tt>
+    def self.check_credentials(raw = {})
+      args = {
+        username: 'arg1',
+        password: 'arg2'
+      }
+      params = {}
+      raw.each {|key, value| params[args[key].to_sym] = value }
+      params.merge!(cmd: 'v-list-user')
+      send_request(params, raw)
+    end
+  end
+end

data/lib/vestacp/base.rb

@@ -0,0 +1,95 @@
+require 'faraday'
+require 'json'
+
+module Vestacp
+  # Vestacp::Base is the main class used to subclass Vestacp API resources
+  class Base
+
+    # Sends an API request to the Vestacp API
+    #
+    # Parameters:
+    # * <tt>:cmd</tt> - The API action to perform
+    #
+    # All other paramters are passed along as HTTP POST variables
+    def self.send_request(params = {}, raw = {}, json_response = false)
+      if params[:cmd].nil? || params[:cmd].empty?
+        raise "No API command set"
+      end
+
+      if !raw[:server]
+        raise "No server as argument and server configuration!" unless Vestacp.config
+        raw[:server] = {
+          api_username: Vestacp.config.api_username,
+          api_password: Vestacp.config.api_password,
+          api_url: Vestacp.config.api_url
+        }
+      end
+
+      params.merge!(
+        user: raw[:server][:api_username],
+        password: raw[:server][:api_password]
+      )
+
+      # params.merge!(returncode: 'yes') unless params[:returncode]
+
+      url = URI.parse(raw[:server][:api_url])
+
+      # SSL without is really bad design. In order to support even self-signed
+      # certificates I should do that.
+      conn = Faraday.new(:url => url, ssl: { verify: false }) do |faraday|
+        faraday.request  :url_encoded             # form-encode POST params
+        faraday.response :logger                  # log requests to STDOUT
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+
+      response = conn.post do |req|
+        req.body = params
+      end
+
+      parse_response(json_response ? JSON.parse(response.body) : response.body)
+    end
+
+    # Parse VestaCP responses.
+    # TODO: add more responses.
+    #
+    # See: http://vestacp.com/docs/api/#return_codes
+    def self.parse_response(raw, json_response = false)
+      case raw
+      when 'OK'
+        {error: false, response: raw}
+      when /^Error/
+        {error: true, response: raw}
+      else
+        {error: false, response: raw}
+      end
+
+      # case raw
+      # when '0'
+      #   {
+      #     error: false, value: raw, name: 'OK',
+      #     comment: 'Command has been successfuly performed.'
+      #   }
+      # when '1'
+      #   {
+      #     error: true, value: raw, name: 'E_ARGS',
+      #     comment: 'Not enough arguments provided.'
+      #   }
+      # when '2'
+      #   {
+      #     error: true, value: raw, name: 'E_INVALID',
+      #     comment: 'Object or argument is not valid.'
+      #   }
+      # when '3'
+      #   {
+      #     error: true, value: raw, name: 'E_NOTEXIST',
+      #     comment: "Object doesn't exist."
+      #   }
+      # else
+      #   {
+      #     error: true, value: '-1', name: 'E_UNKNOWN',
+      #     comment: "Unknown response: #{raw}"
+      #   }
+      # end
+    end
+  end
+end

data/lib/vestacp/config.rb

@@ -0,0 +1,20 @@
+module Vestacp
+  # Vestacp::Config stores configuration data for connecting to the Vestacp API
+  class Config
+    # The Vestacp API username
+    attr_accessor :api_username
+
+    # The Vestacp API password
+    attr_accessor :api_password
+
+    # The Vestacp API URL
+    attr_accessor :api_url
+
+    # Create a new config object
+    def initialize
+      @api_username = 'example_user'
+      @api_password = 'example_pass'
+      @api_url      = 'https://example.com:8083/api/'
+    end
+  end
+end

data/lib/vestacp/database.rb

@@ -0,0 +1,38 @@
+module Vestacp
+  # Vestacp::Database is the class for clients domain
+  class Database < Base
+    def self.add(raw = {})
+        args = {
+            username: 'arg1',
+            db_name: 'arg2',
+            db_user: 'arg3',
+            db_pass: 'arg4'
+        }
+        params = {}
+        raw.each {|key, value| params[args[key].to_sym] = value }
+        params.merge!(cmd: 'v-add-database')
+        send_request(params, raw)
+    end
+
+    # Delete User Databaase
+    #
+    # Parameters:
+    #
+    # * <tt>:username</tt>
+    # * <tt>:db_name</tt>
+    # * <tt>:db_name</tt>
+    # * <tt>:db_pass</tt>
+    def self.delete(raw = {})
+        args = {
+            username: 'arg1',
+            db_name: 'arg2',
+            db_user: 'arg3',
+            db_pass: 'arg4'
+        }
+        params = {}
+        raw.each {|key, value| params[args[key].to_sym] = value }
+        params.merge!(cmd: 'v-delete-database')
+        send_request(params, raw)
+    end
+  end
+end

data/lib/vestacp/domain.rb

@@ -0,0 +1,46 @@
+module Vestacp
+    # Vestacp::Domain is the class for clients domain
+  class Domain < Base
+
+    # Create User Account
+    #
+    # Parameters:
+    #
+    # * <tt>:username</tt>
+    # * <tt>:password</tt>
+    # * <tt>:email</tt>
+    # * <tt>:package</tt>
+    # * <tt>:first_name</tt>
+    # * <tt>:last_name</tt>
+    #
+    # See:
+    #
+    # http://vestacp.com/docs/api/#add_user
+    def self.add(raw = {})
+        args = {
+        username: 'arg1',
+        domain: 'arg2'
+        }
+        params = {}
+        raw.each {|key, value| params[args[key].to_sym] = value }
+        params.merge!(cmd: 'v-add-domain')
+        send_request(params, raw)
+    end
+
+    # Delete User Domain
+    #
+    # Parameters:
+    #
+    # * <tt>:username</tt>
+    def self.delete(raw = {})
+        args = {
+        username: 'arg1',
+        domain: 'arg2'
+        }
+        params = {}
+        raw.each {|key, value| params[args[key].to_sym] = value }
+        params.merge!(cmd: 'v-delete-domain')
+        send_request(params, raw)
+    end
+  end
+end

data/lib/vestacp/version.rb

@@ -0,0 +1,3 @@
+module Vestacp
+  VERSION = "0.1.3"
+end

data/vestacp.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vestacp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vestacp2"
+  spec.version       = Vestacp::VERSION
+  spec.authors       = ["Umut ADALI","Dmitry Knyazev"]
+  spec.email         = ["kobeumut@gmail.com"]
+  spec.summary       = %q{VestaCP API bindings}
+  spec.description   = %q{Developed and tested on version 0.9.8-14. Only to do simple things with user accounts. That's not a problem to make them more complicated :)}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+#  if spec.respond_to?(:metadata)
+#    spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+#  else
+#    raise "RubyGems 2.0 or newer is required to protect against " \
+#      "public gem pushes."
+#  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+
+  spec.add_runtime_dependency "faraday", "~> 0.13.1"
+
+  spec.add_development_dependency 'bundler', '~> 1.15', '>= 1.15.4'
+  spec.add_development_dependency 'rake', '~> 12.2', '>= 12.2.1'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: vestacp2
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Umut ADALI
+- Dmitry Knyazev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.2.1
+description: Developed and tested on version 0.9.8-14. Only to do simple things with
+  user accounts. That's not a problem to make them more complicated :)
+email:
+- kobeumut@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vestacp.rb
+- lib/vestacp/account.rb
+- lib/vestacp/base.rb
+- lib/vestacp/config.rb
+- lib/vestacp/database.rb
+- lib/vestacp/domain.rb
+- lib/vestacp/version.rb
+- vestacp.gemspec
+- vestacp2-0.1.1.gem
+- vestacp2-0.1.2.gem
+- vestacp2-0.1.gem
+homepage: ''
+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.1
+signing_key: 
+specification_version: 4
+summary: VestaCP API bindings
+test_files: []