upcloud_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 00ada3fa455f28b43b44810cf220f82d45cfad1f
+  data.tar.gz: beb7aab61179f05542b475ad4ff38ca61e4d678e
+SHA512:
+  metadata.gz: d79da75d918016abc1c2a7ef085df7d1152bffbe254646e7926dfedbc572130545531e215cc9c7e35564cd63514d8cbf49a8bae2480785c011390a4f0b8748c6
+  data.tar.gz: e0252fd9d2106ca4a7c723984eebecd54d1f83e059b3740f0fddbe598d6902e49999dc12660d30b24f64151e5021680520ebee889604b467693e42a8fb804ebc

data/lib/upcloud_api.rb

@@ -0,0 +1,212 @@
+
+require "httparty"
+
+class UpcloudApi
+
+    # @param user [String] Upcloud API account
+    # @param password [String] Upcloud API password
+    def initialize user, password
+        @user = user
+        @password = password
+        @auth = { username: @user, password: @password }
+    end
+
+    # Tests that authentication to Upcloud works.
+    #
+    # This is not required to use, as authentication is used
+    # with HTTP basic auth with each request.
+    #
+    # Calls GET /1.2/server
+    #
+    # Returns true in success, false if not
+    def login
+        response = get "server"
+        response.code == 200
+    end
+
+    # Returns available credits.
+    #
+    # Calls GET /1.2/acccount
+    def account_information
+        response = get "account"
+        data = JSON.parse response.body
+        data["acccount"]["credits"]
+    end
+
+    # Lists servers associated with the account
+    #
+    # Calls GET /1.2/server
+    #
+    # Returns array of servers with values
+    # - zone
+    # - core_number
+    # - title
+    # - hostname
+    # - memory_amount
+    # - uuid
+    # - state
+    def servers
+        response = get "server"
+        data = JSON.parse response.body
+        data["servers"]["server"]
+    end
+
+    # Shows details of a server.
+    #
+    # Calls GET /1.2/server/#{uuid}
+    #
+    # @param uuid from UpcloudApi#servers
+    def server_details uuid
+        response = get "server/#{uuid}"
+        data = JSON.parse response.body
+        data
+    end
+
+    # Lists templates available from Upcloud
+    #
+    # Calls GET /1.2/storage/template
+    def templates
+        response = get "storage/template"
+        data = JSON.parse response.body
+        data
+    end
+
+    # Creates new server from template.
+    #
+    # Calls POST /1.2/server
+    #
+    # @param template_uuid Uuid from UpcloudApi#templates (a disk’s UUID)
+    #
+    # Returns HTTParty response bodys
+    def create_server template_uuid, disk_name
+        data = {
+            server = {
+                "zone" => "",
+                "title" => "",
+                "hostname" => "",
+                "core_number" => "",
+                "memory_amount" => "",
+                "storage_devices" => [
+                    "action" => "clone",
+                    "storage" => template_uuid,
+                    "title" => disk_name
+                ]
+            }
+        }
+
+        json = JSON.encode data
+        response = post "server", json
+
+        response
+    end
+
+    # Modifies existing server.
+    #
+    # In order to modify a server, the server must be stopped first.
+    #
+    # Calls PUT /1.2/server/#{uuid}
+    #
+    # @param server_uuid [String] UUID of the server that will be modified.
+    # @param params [Hash] Hash of params that will be passed to be changed.
+    def modify_server server_uuid, params
+        data = { "server" => params }
+        json = JSON.encode data
+        response = put "server/#{server_uuid}", json
+
+        response
+    end
+
+    # Deletes a server.
+    #
+    # In order to delete a server, the server must be stopped first.
+    #
+    # Calls DELETE /1.2/server/#{uuid}
+    def delete_server server_uuid
+        response = delete "server/#{server_uuid}"
+
+        response
+    end
+
+    # Starts server that is shut down.
+    #
+    # Calls POST /1.2/server/#{uuid}/start
+    #
+    # @param server_uuid UUID of the server
+    def start_server server_uuid
+        response = post "server/#{server_uuid}/start"
+
+        response
+    end
+
+    # Shuts down a server that is currently running
+    #
+    # Calls POST /1.2/server/#{uuid}/stop
+    #
+    # Hard shutdown means practically same as taking the power cable off from the computer.
+    # Soft shutdown sends ACPI signal to the server, which should then automatically handle shutdown routines by itself.
+    # If timeout is given, server will be forcibly shut down after the timeout has expired.
+    #
+    # @param server_uuid UUID of the server
+    # @param type Type of the shutdown. Available types are :hard and :soft. Defaults to :soft.
+    # @param timeout Time after server will be hard stopped if it didn’t close cleanly. Only affects :soft type.
+    def start_server server_uuid, type: :soft, timeout: nil
+        data = {
+            "stop_server" => {
+                "stop_type" => type.to_s
+            }
+        }
+        data["stop_server"]["timeout"] = timeout unless timeout.nil?
+
+        json = JSON.encode data
+
+        response = post "server/#{server_uuid}/stop", json
+
+        response
+    end
+
+    # Restarts down a server that is currently running
+    #
+    # Calls POST /1.2/server/#{uuid}/restart
+    #
+    # Hard shutdown means practically same as taking the power cable off from the computer.
+    # Soft shutdown sends ACPI signal to the server, which should then automatically handle shutdown routines by itself.
+    # If timeout is given, server will be forcibly shut down after the timeout has expired.
+    #
+    # @param server_uuid UUID of the server
+    # @param type Type of the shutdown. Available types are :hard and :soft. Defaults to :soft.
+    # @param timeout Time after server will be hard stopped if it didn’t close cleanly. Only affects :soft type.
+    # @param timeout_action What will happen when timeout happens. :destroy hard stops the server and :ignore makes
+    # server if timeout happens. Default is :ignore.
+    def start_server server_uuid, type: :soft, timeout: nil, timeout_action: :ignore
+        data = {
+            "stop_server" => {
+                "stop_type" => type.to_s
+            }
+        }
+        data["stop_server"]["timeout"] = timeout unless timeout.nil?
+
+        json = JSON.encode data
+
+        response = post "server/#{server_uuid}/restart", json
+
+        response
+    end
+
+    private
+
+    def get action
+        HTTParty.get "https://api.upcloud.com/1.2/#{action}", basic_auth: @auth
+    end
+
+    def post action, body = ""
+        HTTParty.post "https://api.upcloud.com/1.2/#{action}", basic_auth: @auth, body: body
+    end
+
+    def put action, body = ""
+        HTTParty.put "https://api.upcloud.com/1.2/#{action}", basic_auth: @auth, body: body
+    end
+
+    def delete action, body = ""
+        HTTParty.delete "https://api.upcloud.com/1.2/#{action}", basic_auth: @auth
+    end
+end

data/lib/upcloud_api/version.rb

@@ -0,0 +1,3 @@
+class UpcloudApi
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: upcloud_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Samu Voutilainen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+description: Ruby implementation of Upcloud API, meant for programmable maintenance
+  of virtual private servers in Upcloud’s system.
+email: smar@smar.fi
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/upcloud_api.rb
+- lib/upcloud_api/version.rb
+homepage: https://github.com/Smarre/upcloud_api
+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.6
+signing_key: 
+specification_version: 4
+summary: Implementation of Upcloud API for VPS management
+test_files: []
+has_rdoc: