ruby_api_pack_cloudways 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 032f4359de51e5272ede2f343e9da2b2381ff7690ede8e34c6b5c3be75161e16
-  data.tar.gz: bfe23a4dfd1f23abeb3dc12a71fc1190ab2db8354dfd4f3fd23ed6173ce7faa8
+  metadata.gz: 64e6f4ca33ac70dcd6309f9b74d7f72c3f1b70598756eb35ef54642cc98f5836
+  data.tar.gz: 1e83554286f6bc0d6c0803c18e33dd2e7e47706788ccadfa65949cdc81062e94
 SHA512:
-  metadata.gz: adcd283753e724c24dccc49bc16d5cf8fa0fa222b3c0647c08fb940686355cb7f887e3c042cf78132a05ea6324970ae72e1a2593d770206719370f8bcad8997c
-  data.tar.gz: '09a39d106708fd11d900c6143a210478a1ff330e39ea7b599a284c30ae21d515f00993a99204cdb72d772e68f3317aa7d7706c990f1de870ec73a132974c0c7e'
+  metadata.gz: 51f40268262aaed80030f2e9343c4b5f31c8784e8fc5da4cee18b086acc18649d52b5f4e0e3f20d5fcf3c66f07fe9966b38d953e62c7c2b787e521dbff1bb876
+  data.tar.gz: e6fd7306e44faa0f0ea3c94799c66c2e40d645675a387bf92ffc88c173fd764eee16f36e95ffc90071cde0ef78764403c5f35d6b60194f54acb591be3775d7cd

data/README.md

@@ -58,6 +58,10 @@ Or install it yourself as:
 ```bash
 $ gem install ruby_api_pack_cloudways
 ```
+# Documentation Wiki
+
+- [Home](https://github.com/phcdevworks/ruby_api_pack_cloudways/wiki)
+- [Server Endpoints](https://github.com/phcdevworks/ruby_api_pack_cloudways/wiki/Cloudways-API-Ruby-Server-Endpoint-Client)
 
 ## Contributing
 

data/lib/ruby_api_pack_cloudways/api/cw_server.rb

@@ -3,13 +3,116 @@
 module RubyApiPackCloudways
   module Api
     class CwServer
+      # Server endpoints
+      ENDPOINTS = {
+        list: '/server',
+        details: '/server/details',
+        attach_block_storage: '/server/attach_block_storage',
+        clone: '/server/clone',
+        create: '/server/create',
+        delete: '/server/delete',
+        disk_usage: '/server/disk_usage',
+        restart: '/server/restart',
+        scale_block_storage: '/server/scale_block_storage',
+        scale_volume_size: '/server/scale_volume_size',
+        start: '/server/start',
+        stop: '/server/stop',
+        update_label: '/server/update_label',
+        upgrade: '/server/upgrade'
+      }.freeze
+
+      # List all servers
       def self.server_list
-        fetch_list('/server')['servers']
+        fetch_list(ENDPOINTS[:list])['servers']
+      end
+
+      # Get server details
+      def self.server_details(server_id)
+        fetch_with_id(ENDPOINTS[:details], server_id)
+      end
+
+      # Attach block storage to a server
+      def self.attach_block_storage(server_id, params)
+        post_with_id(ENDPOINTS[:attach_block_storage], server_id, params)
+      end
+
+      # Clone a server
+      def self.clone_server(server_id, params)
+        post_with_id(ENDPOINTS[:clone], server_id, params)
+      end
+
+      # Create a new server
+      def self.create_server(params)
+        post_without_id(ENDPOINTS[:create], params)
+      end
+
+      # Delete a server
+      def self.delete_server(server_id)
+        fetch_with_id(ENDPOINTS[:delete], server_id)
+      end
+
+      # Get disk usage information
+      def self.disk_usage(server_id)
+        fetch_with_id(ENDPOINTS[:disk_usage], server_id)
+      end
+
+      # Restart a server
+      def self.restart_server(server_id)
+        fetch_with_id(ENDPOINTS[:restart], server_id)
+      end
+
+      # Scale block storage of a server
+      def self.scale_block_storage(server_id, params)
+        post_with_id(ENDPOINTS[:scale_block_storage], server_id, params)
       end
 
-      def self.fetch_list(endpoint)
+      # Scale volume size of a server
+      def self.scale_volume_size(server_id, params)
+        post_with_id(ENDPOINTS[:scale_volume_size], server_id, params)
+      end
+
+      # Start a server
+      def self.start_server(server_id)
+        fetch_with_id(ENDPOINTS[:start], server_id)
+      end
+
+      # Stop a server
+      def self.stop_server(server_id)
+        fetch_with_id(ENDPOINTS[:stop], server_id)
+      end
+
+      # Update server label
+      def self.update_server_label(server_id, params)
+        post_with_id(ENDPOINTS[:update_label], server_id, params)
+      end
+
+      # Upgrade a server
+      def self.upgrade_server(server_id, params)
+        post_with_id(ENDPOINTS[:upgrade], server_id, params)
+      end
+
+      # Private methods to fetch data
+      private_class_method def self.fetch_list(endpoint)
         Connection::CwConnect.new(RubyApiPackCloudways.configuration.api_url, endpoint).cloudways_api_connection
       end
+
+      # Private methods to fetch data with server id
+      private_class_method def self.fetch_with_id(endpoint, server_id)
+        Connection::CwConnect.new(RubyApiPackCloudways.configuration.api_url, "#{endpoint}/#{server_id}")
+                             .cloudways_api_connection
+      end
+
+      # Private methods to post data with server id
+      private_class_method def self.post_with_id(endpoint, server_id, params)
+        connection = Connection::CwConnect.new(RubyApiPackCloudways.configuration.api_url, "#{endpoint}/#{server_id}")
+        connection.cloudways_api_post_connection(params)
+      end
+
+      # Private methods to post data without server id
+      private_class_method def self.post_without_id(endpoint, params)
+        connection = Connection::CwConnect.new(RubyApiPackCloudways.configuration.api_url, endpoint)
+        connection.cloudways_api_post_connection(params)
+      end
     end
   end
 end

data/lib/ruby_api_pack_cloudways/connection/cw_connect.rb

@@ -3,13 +3,16 @@
 module RubyApiPackCloudways
   module Connection
     class CwConnect
+      # Initialize Cloudways API URL and path
       attr_reader :cw_api_url_base, :cw_api_path
 
+      # Initialize Cloudways API URL and path
       def initialize(cw_api_url_base, cw_api_path)
         @cw_api_url_base = cw_api_url_base
         @cw_api_path = cw_api_path
       end
 
+      # GET request to Cloudways API
       def cloudways_api_connection
         token = CwToken.new.cw_api_token
         response = HTTParty.get(
@@ -19,8 +22,20 @@ module RubyApiPackCloudways
         handle_response(response)
       end
 
+      # POST request to Cloudways API
+      def cloudways_api_post_connection(params)
+        token = CwToken.new.cw_api_token
+        response = HTTParty.post(
+          "#{@cw_api_url_base}#{@cw_api_path}",
+          headers: { 'Authorization' => "Bearer #{token}", 'Content-Type' => 'application/json' },
+          body: params.to_json
+        )
+        handle_response(response)
+      end
+
       private
 
+      # Handle response from Cloudways API
       def handle_response(response)
         case response.code
         when 200
@@ -30,6 +45,7 @@ module RubyApiPackCloudways
         end
       end
 
+      # Parse response from Cloudways API
       def parse_response(response)
         Oj.load(response.body)
       rescue Oj::ParseError => e

data/lib/ruby_api_pack_cloudways/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyApiPackCloudways
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_api_pack_cloudways
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - PHCDevworks
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-27 00:00:00.000000000 Z
+date: 2024-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -39,7 +39,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.16'
-description: Ruby API wrapper to use with Cloudways API.
+description: |-
+  RubyApiPackCloudways is a Ruby gem for interacting with the Cloudways API. It provides easy access to
+    providers, server sizes, apps, and packages, with built-in OAuth authentication for secure API requests.
 email:
 - info@phcdevworks.com
 - brad.potts@phcdevworks.com
@@ -57,12 +59,12 @@ files:
 - lib/ruby_api_pack_cloudways/connection/cw_connect.rb
 - lib/ruby_api_pack_cloudways/connection/cw_token.rb
 - lib/ruby_api_pack_cloudways/version.rb
-homepage: https://phcdevworks.com/
+homepage: https://github.com/phcdevworks/ruby_api_pack_cloudways/wiki
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org/
-  homepage_uri: https://phcdevworks.com/
+  homepage_uri: https://github.com/phcdevworks/ruby_api_pack_cloudways/wiki
   source_code_uri: https://github.com/phcdevworks/ruby_api_pack_cloudways/
   changelog_uri: https://github.com/phcdevworks/ruby_api_pack_cloudways/releases
 post_install_message: