ruby_api_pack_cloudways 0.1.0.pre.1 → 0.1.0.pre.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3de7f67e4fbda00d90fc05e85f484bce584337d5141dca95b1c2d27fd6d0094e
-  data.tar.gz: 7f252f81ceca0dafc869b9992df00e4d1f36ff42d1446e9e1814c6750000c066
+  metadata.gz: 0751f30764c25914fc3e6b08872881efe1e67c34dbbb88f2f578862d94206007
+  data.tar.gz: fc3593e06a5172ef3c3cf50e660e1377420a5eb061de25ef090830162e49f4bc
 SHA512:
-  metadata.gz: 148bc5b11df8440766a62c217891e312629bbfcc1bcf2b8f2baafb1da2b66c80491fa019143d2159a79a27ffd8f0b5dd8138c8affe9358442e2d3f16dd478607
-  data.tar.gz: 9a9694d4c3ab236c517532562c7698e8c5d64142ab3eed92e9920ea12ef782c150bbc07064a4515349a9faf45d67cb607e2243b6a4ad1537d2bb46646333b1c7
+  metadata.gz: 744c1519f26a70691f11028171db1af66ba7e03931dd29a1a8383ddd53e8ce2116365c365475c2ef988d2b9badf121b25982b012e27e4607a3c3d4b996c7c48d
+  data.tar.gz: bc87eae838b78b2f0f6f3bf5c1ead4ab387a8422d0db3b9282d776449cf416d585af0fe2cd33597931be32fd98034b8af84d6f792544cb63e19bf8147e2babbb

data/README.md

@@ -1,36 +1,35 @@
-### Ruby API Wrapper - Cloudways
-     
-Early Release. Beta 5.
-   
-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
-
-    PHCDEV_API_CLOUDWAYS_EMAIL = Your Cloudways Email Login
-    PHCDEV_API_CLOUDWAYS_KEY = API Key Provided by Cloudways
+### 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.
+  

data/Rakefile

@@ -1,6 +1,14 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'rake'
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+RuboCop::RakeTask.new do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb', '*.gemspec', 'Rakefile']
+end
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: %i[rubocop spec]

data/lib/ruby_api_pack_cloudways/api/cw_lists.rb

@@ -1,31 +1,37 @@
+# frozen_string_literal: true
+
+require_relative '../constants'
+
 module RubyApiPackCloudways
-    module Api
-        class CwLists
+  module Api
+    class CwLists
+      # PHCDEVONE - Include the RubyApiPackCloudways::Constants module
+      include RubyApiPackCloudways::Constants
 
-            # List - Providers
-            def self.cw_provider_list
-                providers_list = Connection::CwConnect.new(CW_API_URL, "/providers")
-                return Oj.load(providers_list.cloudways_api_connection.body)["providers"]
-            end
+      # PHCDEVONE - Fetch the list of providers from the Cloudways API
+      def self.cw_provider_list
+        fetch_list('/providers')['providers']
+      end
 
-            # List - Server Sizes
-            def self.cw_server_size_list
-                server_sizes_list = Connection::CwConnect.new(CW_API_URL, "/server_sizes")
-                return Oj.load(server_sizes_list.cloudways_api_connection.body)["sizes"]
-            end
+      # PHCDEVONE - Fetch the list of server sizes from the Cloudways API
+      def self.cw_server_size_list
+        fetch_list('/server_sizes')['sizes']
+      end
 
-            # List - App
-            def self.cw_app_list
-                app_list = Connection::CwConnect.new(CW_API_URL, "/apps")
-                return Oj.load(app_list.cloudways_api_connection.body)["apps"]
-            end
+      # PHCDEVONE - Fetch the list of apps from the Cloudways API
+      def self.cw_app_list
+        fetch_list('/apps')['apps']
+      end
 
-            # List - Package
-            def self.cw_package_list
-                package_list = Connection::CwConnect.new(CW_API_URL, "/packages")
-                return Oj.load(package_list.cloudways_api_connection.body)["packages"]
-            end
+      # PHCDEVONE - Fetch the list of packages from the Cloudways API
+      def self.cw_package_list
+        fetch_list('/packages')['packages']
+      end
 
-        end
-    end         
-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
+      end
+    end
+  end
+end

data/lib/ruby_api_pack_cloudways/api/cw_server.rb

@@ -1,13 +1,18 @@
-module RubyApiPackCloudways
-    module Api
-        class CwServer
+# frozen_string_literal: true
+
+require_relative '../constants'
 
-            # List - Servers
-            def self.cw_server_list
-                cw_api_list_server = Connection::CwConnect.new(CW_API_URL, "/server")
-                return Oj.load(cw_api_list_server.cloudways_api_connection.body)["servers"]
-            end
+module RubyApiPackCloudways
+  module Api
+    class CwServer
+      # PHCDEVONE - Include the RubyApiPackCloudways::Constants module
+      include RubyApiPackCloudways::Constants
 
-        end
-    end         
-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']
+      end
+    end
+  end
+end

data/lib/ruby_api_pack_cloudways/connection/cw_connect.rb

@@ -1,32 +1,62 @@
+# frozen_string_literal: true
+
+require_relative '../constants'
+
 module RubyApiPackCloudways
-    module Connection
-        class CwConnect
+  module Connection
+    class CwConnect
+      # PHCDEVONE - Include the RubyApiPackCloudways::Constants module
+      include RubyApiPackCloudways::Constants
 
-            # Connection - Attributes
-            attr_accessor :cw_api_url_base, :cw_api_path
+      # PHCDEVONE - Define attribute readers for the base URL, path, and Faraday connection
+      attr_reader :cw_api_url_base, :cw_api_path, :faraday_connection
 
-            # Connection - Init
-            def initialize(cw_api_url_base, cw_api_path)
-                @cw_api_url_base = cw_api_url_base
-                @cw_api_path = cw_api_path
-            end
+      # 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)
+        @cw_api_url_base = cw_api_url_base
+        @cw_api_path = cw_api_path
+        @faraday_connection = faraday_connection || Faraday
+      end
 
-            # Connection - API Connection Call
-            def cloudways_api_connection
+      # 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)
+        handle_response(response)
+      end
 
-                cw_api_get_token_connection_request = Connection::CwToken.new(CW_API_URL, CW_API_PATH_TOKEN, CW_API_EMAIL, CW_API_KEY)
-                cw_api_get_token_connection_response = cw_api_get_token_connection_request.cw_api_token
-                
-                cw_api_connetion_response = Faraday.new(url: @cw_api_url_base) do |cw_api_connection|
-                    cw_api_connection.request :oauth2, cw_api_get_token_connection_response, token_type: :bearer
-                    cw_api_connection.response :logger
-                    cw_api_connection.adapter Faraday.default_adapter
-                end
+      private
 
-                return cw_api_connetion_response.get @cw_api_url_base + @cw_api_path
+      # 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
 
-            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
+        when 200
+          parse_response(response)
+        else
+          raise "Error: Received status #{response.status}"
         end
+      end
+
+      # PHCDEVONE - Parse the API response using Oj
+      def parse_response(response)
+        Oj.load(response.body)
+      rescue Oj::ParseError => e
+        raise "Error parsing response: #{e.message}"
+      end
     end
-end
+  end
+end

data/lib/ruby_api_pack_cloudways/connection/cw_token.rb

@@ -1,47 +1,49 @@
-module RubyApiPackCloudways
-    module Connection
-        class CwToken
-
-            # Cloudways - Token - Attributes
-            attr_accessor :cw_api_url_base, :cw_url_path_auth, :cw_user_email, :cw_user_key
-
-            # Cloudways - Token - Init
-            def initialize(cw_api_url_base, cw_url_path_auth, cw_user_email, cw_user_key)  
-                @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
-            end 
-
-            # Cloudways - Token - Connection
-            def cw_api_token_connection
-
-                # Cloudways - Token - Connection via Faraday
-                Faraday.new url: @cw_api_url_base + @cw_url_path_auth do |cw_token_connection|
-                    cw_token_connection.request  :url_encoded
-                    cw_token_connection.response :logger
-                    cw_token_connection.adapter  Faraday.default_adapter
-                end
+# frozen_string_literal: true
 
-            end
+require_relative '../constants'
 
-            # Cloudways - Token - Request
-            def cw_api_token
+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
+
+      # 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
+      end
 
-                # Cloudways - Token - Request From Above Connection Method
-                cloudways_token_request = cw_api_token_connection.post do |cw_token_request|
-                    cw_token_request.headers["Content-Type"] = "application/x-www-form-urlencoded"
-                    cw_token_request.body = {
-                        email: @cw_user_email,
-                        api_key: @cw_user_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
 
-                # Cloudways - Token - Request Isolate and Get Token from Response via OJ
-                return cw_api_token = Oj.load(cloudways_token_request.body)["access_token"]
+        parse_response(response)['access_token']
+      end
 
-            end
+      private
 
-        end
+      # PHCDEVONE - Parse the response from the API token request
+      def parse_response(response)
+        Oj.load(response.body)
+      rescue Oj::ParseError => e
+        raise "Error parsing response: #{e.message}"
+      end
     end
-end
+  end
+end

data/lib/ruby_api_pack_cloudways/constants.rb

@@ -0,0 +1,17 @@
+# 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,24 +1,18 @@
-# Variables
-CW_API_URL = "https://api.cloudways.com/api/v1"
-CW_API_PATH_TOKEN = "/oauth/access_token"
-CW_API_EMAIL = ENV["PHCDEV_API_CLOUDWAYS_EMAIL"]
-CW_API_KEY = ENV["PHCDEV_API_CLOUDWAYS_KEY"]
+# frozen_string_literal: true
 
-module RubyApiPackCloudways
-    class CwClient
-
-        # Load Required Gems
-        require "faraday"
-        require "faraday_middleware"
-        require "oj"
+require 'faraday'
+require 'oj'
 
-        # Load Main Files
-        require_relative "connection/cw_token"
-        require_relative "connection/cw_connect"
+# 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'
 
-        # Load API Files
-        require_relative "api/cw_lists"
-        require_relative "api/cw_server"
-
-    end
-end
+module RubyApiPackCloudways
+  class CwClient
+    # PHCDEVONE - Include the RubyApiPackCloudways::Constants module
+    include RubyApiPackCloudways::Constants
+  end
+end

data/lib/ruby_api_pack_cloudways/version.rb

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

data/lib/ruby_api_pack_cloudways.rb

@@ -1,7 +1,9 @@
-require "ruby_api_pack_cloudways/version"
+# frozen_string_literal: true
+
+require 'ruby_api_pack_cloudways/version'
+require 'ruby_api_pack_cloudways/cw_client'
 
 module RubyApiPackCloudways
+  # PHCDEVONE - Define a custom error class for the RubyApiPackCloudways module
   class Error < StandardError; end
-
-          require_relative "ruby_api_pack_cloudways/cw_client"
 end

metadata

@@ -1,123 +1,62 @@
 --- !ruby/object:Gem::Specification
 name: ruby_api_pack_cloudways
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.1
+  version: 0.1.0.pre.4
 platform: ruby
 authors:
 - PHCDevworks
+- Brad Potts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-16 00:00:00.000000000 Z
+date: 2024-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 13.0.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 13.0.3
-- !ruby/object:Gem::Dependency
-  name: oj
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: 0.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-description: Ruby API wrapper to use with Cloudways API. Can be used alone or part
-  of the larger PHCDevworks Ruby API Pack.
+        version: '3.16'
+description: Ruby API wrapper to use with Cloudways API.
 email:
-- imfo@phcdevworks.com
+- info@phcdevworks.com
+- brad.potts@phcdevworks.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -129,6 +68,7 @@ files:
 - lib/ruby_api_pack_cloudways/api/cw_server.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/
@@ -147,14 +87,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.2.20
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: API Pack for Cloudways