vestacp 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 15b1b629a74550b2c26b71b0bb7097f75a1d1eb7
+  data.tar.gz: 54df1114e6fced6ea19a0225534a637d8ab42573
+SHA512:
+  metadata.gz: 7d3f7c445f1cbd68d53b6693d4f7686ce2ee7b55def06b6205c26859819ad6d2c4785462c03016b02861759b0faca334aaedded088620ebfea0f523f479810e4
+  data.tar.gz: e9cc9587fd638f722aa34a72c202f824fd9554c16f9995e862f9ed86febd1e1f3ffe9adf027c1508696c54ebd1e3af74ceafc4457f0f8264d4fd7d77e572f15e

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

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,31 @@
+# Vestacp
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vestacp'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vestacp
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/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,28 @@
+require "vestacp/version"
+
+module Vestacp
+  autoload :Config,  "vestacp/config"
+  autoload :Base,  "vestacp/base"
+  autoload :Account,  "vestacp/account"
+
+  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,49 @@
+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_client(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_user(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
+  end
+end

data/lib/vestacp/base.rb

@@ -0,0 +1,85 @@
+require 'faraday'
+
+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 = {})
+      if params[:cmd].blank?
+        raise "No API command set"
+      end
+
+      if raw.server && raw.server.api_username && raw.server.api_password && aw.server.api_url
+        params.merge!(
+          :user => raw.server.api_username,
+          :password => raw.server.api_password
+        )
+
+        url = URI.parse(raw.server.api_url)
+      else
+        params.merge!(
+          :user => Vestacp.config.api_username,
+          :password => Vestacp.config.api_password
+        )
+
+        url = URI.parse(Vestacp.config.api_url)
+      end
+
+      params.merge!(returncode: 'yes')
+
+      # 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(response.body)
+    end
+
+    # Parse VestaCP responses.
+    # TODO: add more responses.
+    #
+    # See: http://vestacp.com/docs/api/#return_codes
+    def self.parse_response(raw)
+      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/version.rb

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

data/vestacp.gemspec

@@ -0,0 +1,25 @@
+# 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          = "vestacp"
+  spec.version       = Vestacp::VERSION
+  spec.authors       = ["Dmitry K."]
+  spec.email         = ["a@kdas.me"]
+  spec.summary       = %q{VestaCP API bindings}
+  spec.description   = %q{Developed and tested on version 0.9.8-14}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "faraday", ">= 0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: vestacp
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Dmitry K.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Developed and tested on version 0.9.8-14
+email:
+- a@kdas.me
+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/version.rb
+- vestacp.gemspec
+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.4.8
+signing_key: 
+specification_version: 4
+summary: VestaCP API bindings
+test_files: []