ruby_api_pack_cloudways 0.1.0.pre.4 → 0.1.0.pre.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0751f30764c25914fc3e6b08872881efe1e67c34dbbb88f2f578862d94206007
-  data.tar.gz: fc3593e06a5172ef3c3cf50e660e1377420a5eb061de25ef090830162e49f4bc
+  metadata.gz: 7b502c4da2d913ded7dcfca1bc55ec230870752a73f5a80b5a2d519101da7a1a
+  data.tar.gz: eef95f114ac2467f27174534007f4f04804ca47c82c47496bbb327368eb63fb6
 SHA512:
-  metadata.gz: 744c1519f26a70691f11028171db1af66ba7e03931dd29a1a8383ddd53e8ce2116365c365475c2ef988d2b9badf121b25982b012e27e4607a3c3d4b996c7c48d
-  data.tar.gz: bc87eae838b78b2f0f6f3bf5c1ead4ab387a8422d0db3b9282d776449cf416d585af0fe2cd33597931be32fd98034b8af84d6f792544cb63e19bf8147e2babbb
+  metadata.gz: 6d8c0706ff2b775a0172fa13fe6d9d836f4a3d57354c47e6c0b7e1f50f66a2c57245bab98563d4e33a9beb9f68fa018a86c89bc386858779f1be8d9699e83770
+  data.tar.gz: 0c40f6a4bf8f8fa2bbdaf23fa5b104cac84450cbd280b0db3d86780a41c860135a95b8199dbe6f2a3f15e6fe8877c0c260c3ec4a5ff7e774b5002ed35f3b1fb9

data/README.md

@@ -1,35 +1,61 @@
-### 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.
-  
+### 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
+
+    <% @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:
+  
+    EDITOR="code --wait" bin/rails credentials:edit
+  
+Add the following to your credentials.yml:
+  
+    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

data/lib/ruby_api_pack_cloudways/api/cw_lists.rb

@@ -1,36 +1,31 @@
 # 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
+      # Fetch the list of providers from the Cloudways API
       def self.cw_provider_list
         fetch_list('/providers')['providers']
       end
 
-      # PHCDEVONE - Fetch the list of server sizes from the Cloudways API
+      # Fetch the list of server sizes from the Cloudways API
       def self.cw_server_size_list
         fetch_list('/server_sizes')['sizes']
       end
 
-      # PHCDEVONE - Fetch the list of apps from the Cloudways API
+      # Fetch the list of apps from the Cloudways API
       def self.cw_app_list
         fetch_list('/apps')['apps']
       end
 
-      # PHCDEVONE - Fetch the list of packages from the Cloudways API
+      # Fetch the list of packages from the Cloudways API
       def self.cw_package_list
         fetch_list('/packages')['packages']
       end
 
-      # PHCDEVONE - Fetch the list from the Cloudways API based on the given endpoint
+      # 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
+        Connection::CwConnect.new(RubyApiPackCloudways.configuration.api_url, endpoint).cloudways_api_connection
       end
     end
   end

data/lib/ruby_api_pack_cloudways/api/cw_server.rb

@@ -1,17 +1,15 @@
 # frozen_string_literal: true
 
-require_relative '../constants'
-
 module RubyApiPackCloudways
   module Api
     class CwServer
-      # PHCDEVONE - Include the RubyApiPackCloudways::Constants module
-      include RubyApiPackCloudways::Constants
-
-      # PHCDEVONE - Fetch the list of servers from the Cloudways API
+      # 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']
+        fetch_list('/server')['servers']
+      end
+
+      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,37 @@
 # frozen_string_literal: true
 
-require_relative '../constants'
+require 'httparty'
 
 module RubyApiPackCloudways
   module Connection
     class CwConnect
-      # PHCDEVONE - Include the RubyApiPackCloudways::Constants module
-      include RubyApiPackCloudways::Constants
+      attr_reader :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
-
-      # 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,30 @@
 # frozen_string_literal: true
 
-require_relative '../constants'
+require 'httparty'
 
 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
+      attr_reader :cw_api_url_base, :cw_url_path_auth, :cw_user_email, :cw_user_key
 
-      # 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
+      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 - 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
-
-      # 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.pre.5'
 end

data/lib/ruby_api_pack_cloudways.rb

@@ -1,9 +1,22 @@
 # frozen_string_literal: true
 
-require 'ruby_api_pack_cloudways/version'
-require 'ruby_api_pack_cloudways/cw_client'
+require 'faraday'
+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'
+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.pre.5
 platform: ruby
 authors:
 - PHCDevworks
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-05 00:00:00.000000000 Z
+date: 2024-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -66,10 +66,9 @@ files:
 - 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:

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