solusvm_client 0.0.1 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ab6d5b713ffed3f881959070f5bb2d7bf76a18c
-  data.tar.gz: c9d42df1091573b3f47b5e0255c5797d223f4a81
+  metadata.gz: 170aaff3a23f687e5960809d760c5cfbc529da3d
+  data.tar.gz: 5ad30db5ad52b508d9720db816c3474b81f02cfd
 SHA512:
-  metadata.gz: f4776b1ef98e1b32c20b43082232c720cfd568844189fa4f4559a699e56ba0f41b936c5ff5d07e2ba8b575855e0e859d68e25ceae3b4f1713d6c9b6479e6e34d
-  data.tar.gz: a48944f1131b0afb12e1a590d0875fee033cdac4cb3ec628c9a471f3c4ec40c3d1e41c86ed77a8c67e6127d34af45ffeb869eb8fc7badd45d2c8b144c6ea17d5
+  metadata.gz: b7996e4fbdf47f5779f09c89a5534b08e4d33fbea6a986d826c4752c9ed146135e8e88522691a2c4aeb48943b9e5e527c10aa028118ceae91a9f5e1df088eac0
+  data.tar.gz: 5d96204a840caf99b25c59a263bbb0c86e4b883bee4e46ab23e582d4401d77afb5cc1f2b7b132dbaddce6f6a71e604316c885504ec2b242df87d98c7af8fc5b4

data/.gitignore

@@ -1,4 +1,6 @@
+.idea
 *.gem
+test.rb
 *.rbc
 .bundle
 .config

data/README.md

@@ -1,6 +1,6 @@
-# SolusvmClient
+# SolusVMClient
 
-TODO: Write a gem description
+This Gem is a simple implementation of the SolusVM Client API (http://docs.solusvm.com/client_api)
 
 ## Installation
 
@@ -18,7 +18,121 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Initializing
+
+Initialize the API URL. For Rails put this into `config/initializers/solusvm_client.rb`
+
+```ruby
+
+# require 'solusvm_client' # include gem if you are not inside rails
+
+SolusVMClient.setup do |config|
+  config.api_url = "https://myserver.com:5656/api/client/command.php"
+end
+```
+
+### Instantiating a Server Object
+
+```ruby
+
+server = SolusVMClient::Server.new("MY API KEY", "MY API HASH")
+```
+
+### API Functions
+
+* reboot
+* boot
+* shutdown
+* status
+* info
+
+#### Examples
+
+```ruby
+
+result = server.reboot
+
+# result => {
+#            :status => "success",
+#         :statusmsg => "rebooted",
+#          :hostname => "myhostname.com",
+#         :ipaddress => "123.123.123.123",
+#            :vmstat => nil
+#     }
+
+result = server.shutdown
+
+# result => {
+#            :status => "success",
+#         :statusmsg => "shutdown",
+#          :hostname => "myhostname.com",
+#         :ipaddress => "123.123.123.123",
+#            :vmstat => nil
+#     }
+
+result = server.boot
+
+# result => {
+#            :status => "success",
+#         :statusmsg => "booted",
+#          :hostname => "myhostname.com",
+#         :ipaddress => "123.123.123.123",
+#            :vmstat => nil
+#     }
+
+result = server.status
+
+# result => {
+#            :status => "success",
+#         :statusmsg => "online",
+#            :vmstat => "online",
+#          :hostname => "myhostname.com",
+#         :ipaddress => "123.123.123.123"
+#     }
+
+result = server.info
+
+# result => {
+#         :status => "success",
+#      :statusmsg => nil,
+#       :hostname => "myhostname.com",
+#      :ipaddress => "123.123.123.123",
+#         :vmstat => nil
+#  }
+
+result = server.info({ ipaddr: true, hdd: true, mem: true, bw: true })
+
+# result => {
+#         :ipaddr => [
+#          [0] "123.123.123.123",
+#          [1] "0:0:0:0:0:ffff:7b7b:7b7b"
+#      ],
+#            :hdd => {
+#               :total => 10737418240,
+#                :used => 775327744,
+#                :free => 9962090496,
+#          :percentage => 7
+#      },
+#             :bw => {
+#               :total => 107374182400,
+#                :used => 256204956,
+#                :free => 107117977444,
+#          :percentage => 0
+#      },
+#            :mem => {
+#               :total => 134217728,
+#                :used => 25272320,
+#                :free => 108945408,
+#          :percentage => 19
+#      },
+#         :status => "success",
+#      :statusmsg => nil,
+#       :hostname => "myhostname.com",
+#      :ipaddress => "123.123.123.123",
+#         :vmstat => nil
+#  }
+```
+
 
 ## Contributing
 

data/lib/solusvm_client.rb

@@ -1,5 +1,12 @@
+require 'active_support/core_ext/module/attribute_accessors'
+require 'solusvm_client/server'
 require "solusvm_client/version"
 
-module SolusvmClient
-  # Your code goes here...
-end
+module SolusVMClient
+  mattr_accessor :api_url
+  @@api_url = nil
+
+  def self.setup
+    yield self if block_given?
+  end
+end

data/lib/solusvm_client/server.rb

@@ -0,0 +1,79 @@
+require 'active_support/all'
+require 'uri'
+require 'net/https'
+require 'json'
+
+module SolusVMClient
+  class Server
+    attr_accessor :api_key, :api_hash
+
+    @@actions = [
+        :reboot,
+        :boot,
+        :shutdown,
+        :status
+    ]
+
+    def initialize(api_key, api_hash)
+      self.api_key = api_key
+      self.api_hash = api_hash
+    end
+
+    def method_missing(m, *args, &block)
+      if @@actions.include?(m)
+        request(m)
+      else
+        super
+      end
+    end
+
+    def info(options = {})
+      result = request("info", options)
+      if options.include?(:ipaddr)
+        result[:ipaddr] = result[:ipaddr].split(",")
+      end
+
+      [:hdd, :mem, :bw].each do |k|
+        if options.include?(k)
+          usage = result[k].split(",")
+          result[k] = {
+              total: usage[0].to_i,
+              used: usage[1].to_i,
+              free: usage[2].to_i,
+              percentage: usage[3].to_i
+          }
+        end
+      end
+
+      result
+    end
+
+    def request(action, options = {})
+      uri = URI.parse(SolusVMClient.api_url)
+      https = Net::HTTP.new(uri.host, uri.port)
+      https.use_ssl = true
+
+      params = {
+          key: self.api_key,
+          hash: self.api_hash,
+          action: action
+      }.merge(options)
+
+      request = Net::HTTP::Post.new(uri)
+      request.set_form_data(params)
+
+      response = https.request(request)
+
+      result = {}
+      hash = Hash.from_xml("<root>#{response.body}</root>")["root"]
+
+      hash.each do |k,v|
+        result[k.to_sym] = v
+      end
+
+      raise result[:statusmsg] if result[:status] != "success"
+
+      result
+    end
+  end
+end

data/lib/solusvm_client/version.rb

@@ -1,3 +1,3 @@
 module SolusvmClient
-  VERSION = "0.0.1"
+  VERSION = "0.1"
 end

data/solusvm_client.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = SolusvmClient::VERSION
   spec.authors       = ["bontscho"]
   spec.email         = ["software@bontscho.de"]
-  spec.summary       = %q{Hello World}
-  spec.description   = %q{Hello World Description}
+  spec.summary       = %q{SolusVM Client API Implementation}
+  spec.description   = %q{This Gem implements the SolusVM Client API (http://docs.solusvm.com/client_api) to easily manage your Virtual Private Servers}
   spec.homepage      = "https://github.com/bontscho/solusvm_client-ruby"
   spec.license       = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solusvm_client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '0.1'
 platform: ruby
 authors:
 - bontscho
@@ -52,7 +52,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
-description: Hello World Description
+description: This Gem implements the SolusVM Client API (http://docs.solusvm.com/client_api)
+  to easily manage your Virtual Private Servers
 email:
 - software@bontscho.de
 executables: []
@@ -65,6 +66,7 @@ files:
 - README.md
 - Rakefile
 - lib/solusvm_client.rb
+- lib/solusvm_client/server.rb
 - lib/solusvm_client/version.rb
 - solusvm_client.gemspec
 homepage: https://github.com/bontscho/solusvm_client-ruby
@@ -90,5 +92,5 @@ rubyforge_project:
 rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
-summary: Hello World
+summary: SolusVM Client API Implementation
 test_files: []