ruby_api_pack_cloudways 0.1.0.pre.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b502c4da2d913ded7dcfca1bc55ec230870752a73f5a80b5a2d519101da7a1a
-  data.tar.gz: eef95f114ac2467f27174534007f4f04804ca47c82c47496bbb327368eb63fb6
+  metadata.gz: 64e6f4ca33ac70dcd6309f9b74d7f72c3f1b70598756eb35ef54642cc98f5836
+  data.tar.gz: 1e83554286f6bc0d6c0803c18e33dd2e7e47706788ccadfa65949cdc81062e94
 SHA512:
-  metadata.gz: 6d8c0706ff2b775a0172fa13fe6d9d836f4a3d57354c47e6c0b7e1f50f66a2c57245bab98563d4e33a9beb9f68fa018a86c89bc386858779f1be8d9699e83770
-  data.tar.gz: 0c40f6a4bf8f8fa2bbdaf23fa5b104cac84450cbd280b0db3d86780a41c860135a95b8199dbe6f2a3f15e6fe8877c0c260c3ec4a5ff7e774b5002ed35f3b1fb9
+  metadata.gz: 51f40268262aaed80030f2e9343c4b5f31c8784e8fc5da4cee18b086acc18649d52b5f4e0e3f20d5fcf3c66f07fe9966b38d953e62c7c2b787e521dbff1bb876
+  data.tar.gz: e6fd7306e44faa0f0ea3c94799c66c2e40d645675a387bf92ffc88c173fd764eee16f36e95ffc90071cde0ef78764403c5f35d6b60194f54acb591be3775d7cd

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Copyright Bradley J Potts
+
+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

@@ -1,61 +1,77 @@
-### Ruby API Wrapper - Cloudways
-   
-Easily connect to your Cloudways account through their API.
-  
-* Secure OAuth Cloudways API Authentication
-  
-#### Step 1 - Add to your application
-  
-    gem 'ruby_api_pack_cloudways'
-    bundle install
-    
-#### Controller Example
-    
-    def index 
-        @servers = RubyApiPackCloudways::Api::CwServer.cw_server_list
-    end
-  
-#### Example on Index File
+# PHCDevworks RubyApiPackCloudways
 
-    <% @servers.each do |server| %>
-        <p><%= server %></p>
-    <% end %>
-  
-#### Intializer
-  
-Set the following initalizer in your application:
-  
-    RubyApiPackCloudways.configure do |config|
-        config.api_url = Rails.application.credentials.dig(:cloudways, :api_url)
-        config.api_path_token = Rails.application.credentials.dig(:cloudways, :api_path_token)
-        config.api_email = Rails.application.credentials.dig(:cloudways, :api_email)
-        config.api_key = Rails.application.credentials.dig(:cloudways, :api_key)
-    end
-  
-Open your credentials.yml.enc with your editor of choice in this case using VSCode:
+![Forks](https://img.shields.io/github/forks/phcdevworks/ruby_api_pack_cloudways.svg?style=social)
+![Stars](https://img.shields.io/github/stars/phcdevworks/ruby_api_pack_cloudways.svg?style=social)
+
+## Overview
+
+![Issues](https://img.shields.io/github/issues/phcdevworks/ruby_api_pack_cloudways.svg)
+![Dependabot Status](https://img.shields.io/badge/Dependabot-enabled-brightgreen.svg?logo=dependabot)
+[![codecov](https://codecov.io/gh/phcdevworks/ruby_api_pack_cloudways/graph/badge.svg?token=BEEHE8A5D1)](https://codecov.io/gh/phcdevworks/ruby_api_pack_cloudways)
+![Build Status](https://github.com/phcdevworks/ruby_api_pack_cloudways/actions/workflows/test.yml/badge.svg)
+[![CodeQL](https://github.com/phcdevworks/ruby_api_pack_cloudways/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/phcdevworks/ruby_api_pack_cloudways/actions/workflows/github-code-scanning/codeql)
+![Gem Version](https://img.shields.io/gem/v/ruby_api_pack_cloudways.svg)
+
+RubyApiPackCloudways is a Ruby gem that provides an easy interface for interacting with the Cloudways API. It includes functionality for fetching information about Cloudways providers, server sizes, apps, and packages, as well as managing server connections and authentication tokens.
+
+## Key Features:
+
+- **Provider List**: Fetch the list of available Cloudways providers.
+- **Server Sizes**: Retrieve details about available server sizes supported by Cloudways.
+- **App List**: Access a list of Cloudways applications.
+- **Package List**: Fetch the available packages on Cloudways.
+- **Token-Based Authentication**: Secure access to Cloudways API using OAuth tokens.
+
+## Usage
+
+### 1. Set up Cloudways API credentials
+
+You will need to configure your Cloudways API credentials in your Ruby environment. Here’s how you can do it:
+
+1. Open your configuration block in the initializer or main application file:
+
+```ruby
+RubyApiPackCloudways.configure do |config|
+  config.api_url = 'https://api.cloudways.com/api/v1'
+  config.api_path_token = '/oauth/access_token'
+  config.api_email = '<your_cloudways_email>'
+  config.api_key = '<your_cloudways_api_key>'
+end
+```
+
+2. Save and restart your application.
+
+## Installation
   
-    EDITOR="code --wait" bin/rails credentials:edit
+Add this line to your application's Gemfile:
+
+```ruby
+gem "ruby_api_pack_cloudways"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+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
+
+[![contributors](https://contributors-img.web.app/image?repo=phcdevworks/ruby_api_pack_cloudways)](https://github.com/phcdevworks/ruby_api_pack_cloudways/graphs/contributors)
   
-Add the following to your credentials.yml:
+![Last Commit](https://img.shields.io/github/last-commit/phcdevworks/ruby_api_pack_cloudways.svg)
+[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
   
-    cloudways:
-        api_url: 'https://api.cloudways.com/api/v1'
-        api_path_token: '/oauth/access_token'
-        api_email: 'Your Cloudways Email'
-        api_key: 'Your Cloudways API Key'
-    
-Some examples using tour editor of choice to open your credentials.yml.enc:
-    
-    EDITOR="atom --wait" bin/rails credentials:edit
-    
-    EDITOR="gedit --wait" bin/rails credentials:edit
-    
-    EDITOR="vim" bin/rails credentials:edit
-    
-    EDITOR="nano" bin/rails credentials:edit
-    
-    EDITOR="emacs" bin/rails credentials:edit
-    
-    EDITOR="subl -n -w" bin/rails credentials:edit
-    
-    EDITOR="mate -w" bin/rails credentials:edit
+![License](https://img.shields.io/github/license/phcdevworks/ruby_api_pack_cloudways.svg)

data/lib/ruby_api_pack_cloudways/api/cw_lists.rb

@@ -3,29 +3,27 @@
 module RubyApiPackCloudways
   module Api
     class CwLists
-      # Fetch the list of providers from the Cloudways API
-      def self.cw_provider_list
-        fetch_list('/providers')['providers']
+      def self.fetch_resource(endpoint)
+        Connection::CwConnect.new(
+          RubyApiPackCloudways.configuration.api_url,
+          endpoint
+        ).cloudways_api_connection
       end
 
-      # Fetch the list of server sizes from the Cloudways API
-      def self.cw_server_size_list
-        fetch_list('/server_sizes')['sizes']
+      def self.provider_list
+        fetch_resource('/providers')['providers']
       end
 
-      # Fetch the list of apps from the Cloudways API
-      def self.cw_app_list
-        fetch_list('/apps')['apps']
+      def self.server_size_list
+        fetch_resource('/server_sizes')['sizes']
       end
 
-      # Fetch the list of packages from the Cloudways API
-      def self.cw_package_list
-        fetch_list('/packages')['packages']
+      def self.app_list
+        fetch_resource('/apps')['apps']
       end
 
-      # Fetch the list from the Cloudways API based on the given endpoint
-      def self.fetch_list(endpoint)
-        Connection::CwConnect.new(RubyApiPackCloudways.configuration.api_url, endpoint).cloudways_api_connection
+      def self.package_list
+        fetch_resource('/packages')['packages']
       end
     end
   end

data/lib/ruby_api_pack_cloudways/api/cw_server.rb

@@ -3,14 +3,116 @@
 module RubyApiPackCloudways
   module Api
     class CwServer
-      # Fetch the list of servers from the Cloudways API
-      def self.cw_server_list
-        fetch_list('/server')['servers']
+      # 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(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

@@ -1,17 +1,18 @@
 # frozen_string_literal: true
 
-require 'httparty'
-
 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(
@@ -21,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
@@ -32,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/connection/cw_token.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'httparty'
-
 module RubyApiPackCloudways
   module Connection
     class CwToken

data/lib/ruby_api_pack_cloudways/version.rb

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

data/lib/ruby_api_pack_cloudways.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-require 'faraday'
+require 'httparty'
 require 'oj'
 
-# Load Configuration and API Files
 require_relative 'ruby_api_pack_cloudways/configuration'
 require_relative 'ruby_api_pack_cloudways/connection/cw_token'
 require_relative 'ruby_api_pack_cloudways/connection/cw_connect'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_api_pack_cloudways
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.5
+  version: 0.2.0
 platform: ruby
 authors:
 - PHCDevworks
@@ -9,22 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-10 00:00:00.000000000 Z
+date: 2024-10-30 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -53,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
@@ -61,6 +49,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
 - README.md
 - Rakefile
 - lib/ruby_api_pack_cloudways.rb
@@ -70,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: 
@@ -89,9 +78,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.27
 signing_key: