ruby_api_pack_cloudways 0.1.0.pre.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0751f30764c25914fc3e6b08872881efe1e67c34dbbb88f2f578862d94206007
-  data.tar.gz: fc3593e06a5172ef3c3cf50e660e1377420a5eb061de25ef090830162e49f4bc
+  metadata.gz: 032f4359de51e5272ede2f343e9da2b2381ff7690ede8e34c6b5c3be75161e16
+  data.tar.gz: bfe23a4dfd1f23abeb3dc12a71fc1190ab2db8354dfd4f3fd23ed6173ce7faa8
 SHA512:
-  metadata.gz: 744c1519f26a70691f11028171db1af66ba7e03931dd29a1a8383ddd53e8ce2116365c365475c2ef988d2b9badf121b25982b012e27e4607a3c3d4b996c7c48d
-  data.tar.gz: bc87eae838b78b2f0f6f3bf5c1ead4ab387a8422d0db3b9282d776449cf416d585af0fe2cd33597931be32fd98034b8af84d6f792544cb63e19bf8147e2babbb
+  metadata.gz: adcd283753e724c24dccc49bc16d5cf8fa0fa222b3c0647c08fb940686355cb7f887e3c042cf78132a05ea6324970ae72e1a2593d770206719370f8bcad8997c
+  data.tar.gz: '09a39d106708fd11d900c6143a210478a1ff330e39ea7b599a284c30ae21d515f00993a99204cdb72d772e68f3317aa7d7706c990f1de870ec73a132974c0c7e'

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,35 +1,73 @@
-### 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
-    
-    # Load Gems & Files
-    require "ruby_api_pack_cloudways"
-
-    def index
-        @provider_list = RubyApiPackCloudways::Api::CwLists.cw_provider_list
-    end
-  
-#### Example on Index File
-
-    <% @provider_list.each do |provider| %>
-        <%= provider["name"] %>
-    <% end %>
-  
-#### Variables
-  
-Set the following environment variables in your application:
-  
-    export PHCDEV_API_CLOUDWAYS_EMAIL=your_cloudways_email_login
-    export PHCDEV_API_CLOUDWAYS_KEY=api_key_provided_by_cloudways
-  
-These variables should be configured with your Cloudways email login and API key provided by Cloudways.
-  
+# PHCDevworks RubyApiPackCloudways
+
+![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
+  
+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
+```
+
+## Contributing
+
+[![contributors](https://contributors-img.web.app/image?repo=phcdevworks/ruby_api_pack_cloudways)](https://github.com/phcdevworks/ruby_api_pack_cloudways/graphs/contributors)
+  
+![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).
+  
+![License](https://img.shields.io/github/license/phcdevworks/ruby_api_pack_cloudways.svg)

data/lib/ruby_api_pack_cloudways/api/cw_lists.rb

@@ -1,36 +1,29 @@
 # frozen_string_literal: true
 
-require_relative '../constants'
-
 module RubyApiPackCloudways
   module Api
     class CwLists
-      # PHCDEVONE - Include the RubyApiPackCloudways::Constants module
-      include RubyApiPackCloudways::Constants
-
-      # PHCDEVONE - 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
 
-      # PHCDEVONE - 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
 
-      # PHCDEVONE - 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
 
-      # PHCDEVONE - 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
 
-      # PHCDEVONE - Fetch the list from the Cloudways API based on the given endpoint
-      def self.fetch_list(endpoint)
-        Connection::CwConnect.new(CW_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

@@ -1,17 +1,14 @@
 # frozen_string_literal: true
 
-require_relative '../constants'
-
 module RubyApiPackCloudways
   module Api
     class CwServer
-      # PHCDEVONE - Include the RubyApiPackCloudways::Constants module
-      include RubyApiPackCloudways::Constants
+      def self.server_list
+        fetch_list('/server')['servers']
+      end
 
-      # PHCDEVONE - Fetch the list of servers from the Cloudways API
-      def self.cw_server_list
-        servers = Connection::CwConnect.new(CW_API_URL, '/server').cloudways_api_connection
-        servers['servers']
+      def self.fetch_list(endpoint)
+        Connection::CwConnect.new(RubyApiPackCloudways.configuration.api_url, endpoint).cloudways_api_connection
       end
     end
   end

data/lib/ruby_api_pack_cloudways/configuration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RubyApiPackCloudways
+  class Configuration
+    attr_accessor :api_url, :api_path_token, :api_email, :api_key
+
+    def initialize
+      @api_url = 'https://api.cloudways.com/api/v1'
+      @api_path_token = '/oauth/access_token'
+      @api_email = nil
+      @api_key = nil
+    end
+  end
+end

data/lib/ruby_api_pack_cloudways/connection/cw_connect.rb

@@ -1,57 +1,35 @@
 # frozen_string_literal: true
 
-require_relative '../constants'
-
 module RubyApiPackCloudways
   module Connection
     class CwConnect
-      # PHCDEVONE - Include the RubyApiPackCloudways::Constants module
-      include RubyApiPackCloudways::Constants
-
-      # PHCDEVONE - Define attribute readers for the base URL, path, and Faraday connection
-      attr_reader :cw_api_url_base, :cw_api_path, :faraday_connection
+      attr_reader :cw_api_url_base, :cw_api_path
 
-      # PHCDEVONE - Initialize the connection with the given URL, path, and optional Faraday connection
-      def initialize(cw_api_url_base, cw_api_path, faraday_connection = nil)
+      def initialize(cw_api_url_base, cw_api_path)
         @cw_api_url_base = cw_api_url_base
         @cw_api_path = cw_api_path
-        @faraday_connection = faraday_connection || Faraday
       end
 
-      # PHCDEVONE - Establish a connection to the Cloudways API and handle the response
       def cloudways_api_connection
-        token = fetch_token
-        response = create_connection(token).get(@cw_api_path)
+        token = CwToken.new.cw_api_token
+        response = HTTParty.get(
+          "#{@cw_api_url_base}#{@cw_api_path}",
+          headers: { 'Authorization' => "Bearer #{token}" }
+        )
         handle_response(response)
       end
 
       private
 
-      # PHCDEVONE - Fetch the API token using the CwToken class
-      def fetch_token
-        CwToken.new(CW_API_URL, CW_API_PATH_TOKEN, CW_API_EMAIL, CW_API_KEY).cw_api_token
-      end
-
-      # PHCDEVONE - Create a Faraday connection with the given token
-      def create_connection(token)
-        faraday_connection.new(url: @cw_api_url_base) do |conn|
-          conn.request :oauth2, token, token_type: :bearer
-          conn.response :logger
-          conn.adapter Faraday.default_adapter
-        end
-      end
-
-      # PHCDEVONE - Handle the response from the API call
       def handle_response(response)
-        case response.status
+        case response.code
         when 200
           parse_response(response)
         else
-          raise "Error: Received status #{response.status}"
+          raise "Error: Received status #{response.code}"
         end
       end
 
-      # PHCDEVONE - Parse the API response using Oj
       def parse_response(response)
         Oj.load(response.body)
       rescue Oj::ParseError => e

data/lib/ruby_api_pack_cloudways/connection/cw_token.rb

@@ -1,44 +1,28 @@
 # frozen_string_literal: true
 
-require_relative '../constants'
-
 module RubyApiPackCloudways
   module Connection
     class CwToken
-      # PHCDEVONE - Define attribute readers for API URL base, auth path, user email, user key, and Faraday connection
-      attr_reader :cw_api_url_base, :cw_url_path_auth, :cw_user_email, :cw_user_key, :faraday_connection
-
-      # PHCDEVONE - Initialize the token connection with the given parameters and optional Faraday connection
-      def initialize(cw_api_url_base, cw_url_path_auth, cw_user_email, cw_user_key, faraday_connection = Faraday)
-        @cw_api_url_base = cw_api_url_base
-        @cw_url_path_auth = cw_url_path_auth
-        @cw_user_email = cw_user_email
-        @cw_user_key = cw_user_key
-        @faraday_connection = faraday_connection
-      end
+      attr_reader :cw_api_url_base, :cw_url_path_auth, :cw_user_email, :cw_user_key
 
-      # PHCDEVONE - Create a Faraday connection for the API token
-      def cw_api_token_connection
-        faraday_connection.new(url: "#{@cw_api_url_base}#{@cw_url_path_auth}") do |conn|
-          conn.request :url_encoded
-          conn.response :logger
-          conn.adapter Faraday.default_adapter
-        end
+      def initialize
+        @cw_api_url_base = RubyApiPackCloudways.configuration.api_url
+        @cw_url_path_auth = RubyApiPackCloudways.configuration.api_path_token
+        @cw_user_email = RubyApiPackCloudways.configuration.api_email
+        @cw_user_key = RubyApiPackCloudways.configuration.api_key
       end
 
-      # PHCDEVONE - Retrieve the API token from the Cloudways API
       def cw_api_token
-        response = cw_api_token_connection.post do |req|
-          req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
-          req.body = { email: @cw_user_email, api_key: @cw_user_key }
-        end
-
+        response = HTTParty.post(
+          "#{@cw_api_url_base}#{@cw_url_path_auth}",
+          headers: { 'Content-Type' => 'application/x-www-form-urlencoded' },
+          body: { email: @cw_user_email, api_key: @cw_user_key }
+        )
         parse_response(response)['access_token']
       end
 
       private
 
-      # PHCDEVONE - Parse the response from the API token request
       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.pre.4'
+  VERSION = '0.1.0'
 end

data/lib/ruby_api_pack_cloudways.rb

@@ -1,9 +1,21 @@
 # frozen_string_literal: true
 
-require 'ruby_api_pack_cloudways/version'
-require 'ruby_api_pack_cloudways/cw_client'
+require 'httparty'
+require 'oj'
+
+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'
+require_relative 'ruby_api_pack_cloudways/api/cw_lists'
+require_relative 'ruby_api_pack_cloudways/api/cw_server'
 
 module RubyApiPackCloudways
-  # PHCDEVONE - Define a custom error class for the RubyApiPackCloudways module
-  class Error < StandardError; end
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_api_pack_cloudways
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.4
+  version: 0.1.0
 platform: ruby
 authors:
 - PHCDevworks
@@ -9,22 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-05 00:00:00.000000000 Z
+date: 2024-10-27 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
@@ -61,15 +47,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
 - README.md
 - Rakefile
 - lib/ruby_api_pack_cloudways.rb
 - lib/ruby_api_pack_cloudways/api/cw_lists.rb
 - lib/ruby_api_pack_cloudways/api/cw_server.rb
+- lib/ruby_api_pack_cloudways/configuration.rb
 - lib/ruby_api_pack_cloudways/connection/cw_connect.rb
 - lib/ruby_api_pack_cloudways/connection/cw_token.rb
-- lib/ruby_api_pack_cloudways/constants.rb
-- lib/ruby_api_pack_cloudways/cw_client.rb
 - lib/ruby_api_pack_cloudways/version.rb
 homepage: https://phcdevworks.com/
 licenses:
@@ -90,9 +76,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: 

data/lib/ruby_api_pack_cloudways/constants.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module RubyApiPackCloudways
-  module Constants
-    # PHCDEVONE - Define the base URL for the Cloudways API
-    CW_API_URL = 'https://api.cloudways.com/api/v1'
-
-    # PHCDEVONE - Define the authentication path for the Cloudways API
-    CW_API_PATH_TOKEN = '/oauth/access_token'
-
-    # PHCDEVONE - Retrieve the Cloudways API email from environment variables
-    CW_API_EMAIL = ENV['PHCDEV_API_CLOUDWAYS_EMAIL']
-
-    # PHCDEVONE - Retrieve the Cloudways API key from environment variables
-    CW_API_KEY = ENV['PHCDEV_API_CLOUDWAYS_KEY']
-  end
-end

data/lib/ruby_api_pack_cloudways/cw_client.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require 'faraday'
-require 'oj'
-
-# PHCDEVONE - Load API Files
-require_relative 'connection/cw_token'
-require_relative 'connection/cw_connect'
-require_relative 'api/cw_lists'
-require_relative 'api/cw_server'
-require_relative 'constants'
-
-module RubyApiPackCloudways
-  class CwClient
-    # PHCDEVONE - Include the RubyApiPackCloudways::Constants module
-    include RubyApiPackCloudways::Constants
-  end
-end