ruby_api_pack_cloudways 0.1.0.pre.3 → 0.1.0.pre.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5d5c0dbd540fefe913e29f48ec5b2b4d13ec85defba36dc543bdb919f0bba69
-  data.tar.gz: f5c0c3726f3633a98d401a070885ed9b554c6d6e39d71d6119082b38907605ff
+  metadata.gz: 7b502c4da2d913ded7dcfca1bc55ec230870752a73f5a80b5a2d519101da7a1a
+  data.tar.gz: eef95f114ac2467f27174534007f4f04804ca47c82c47496bbb327368eb63fb6
 SHA512:
-  metadata.gz: 4fcf9c96ec828c8756960021f3b349c52ded473df0b7f4535bd3dd669fc2a33de2a4a506c61b93fc1ce2a878e593befed1e8be82c48d7d30445314c927e28ea4
-  data.tar.gz: 83dc4c10e916dfe74ddf293fd781fde36c94ec3b77839ba65c58cb28cc25b7f6607e883f1f8df8ff497ea8591a1c3b7238fb9aeb8886cec7158deb1baa3cdb79
+  metadata.gz: 6d8c0706ff2b775a0172fa13fe6d9d836f4a3d57354c47e6c0b7e1f50f66a2c57245bab98563d4e33a9beb9f68fa018a86c89bc386858779f1be8d9699e83770
+  data.tar.gz: 0c40f6a4bf8f8fa2bbdaf23fa5b104cac84450cbd280b0db3d86780a41c860135a95b8199dbe6f2a3f15e6fe8877c0c260c3ec4a5ff7e774b5002ed35f3b1fb9

data/README.md

@@ -1,36 +1,61 @@
-### 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
+    
+    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/Rakefile

@@ -1,6 +1,14 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
+# 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: %i[rubocop spec]

data/lib/ruby_api_pack_cloudways/api/cw_lists.rb

@@ -1,31 +1,32 @@
-module RubyApiPackCloudways
-    module Api
-        class CwLists
-
-            # 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
-
-            # 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
-
-            # 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
-
-            # 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
-
-        end
-    end         
-end
+# frozen_string_literal: true
+
+module RubyApiPackCloudways
+  module Api
+    class CwLists
+      # Fetch the list of providers from the Cloudways API
+      def self.cw_provider_list
+        fetch_list('/providers')['providers']
+      end
+
+      # Fetch the list of server sizes from the Cloudways API
+      def self.cw_server_size_list
+        fetch_list('/server_sizes')['sizes']
+      end
+
+      # Fetch the list of apps from the Cloudways API
+      def self.cw_app_list
+        fetch_list('/apps')['apps']
+      end
+
+      # Fetch the list of packages from the Cloudways API
+      def self.cw_package_list
+        fetch_list('/packages')['packages']
+      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
+      end
+    end
+  end
+end

data/lib/ruby_api_pack_cloudways/api/cw_server.rb

@@ -1,13 +1,16 @@
-module RubyApiPackCloudways
-    module Api
-        class CwServer
-
-            # 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
-
-        end
-    end         
-end
+# frozen_string_literal: true
+
+module RubyApiPackCloudways
+  module Api
+    class CwServer
+      # Fetch the list of servers from the Cloudways API
+      def self.cw_server_list
+        fetch_list('/server')['servers']
+      end
+
+      def self.fetch_list(endpoint)
+        Connection::CwConnect.new(RubyApiPackCloudways.configuration.api_url, endpoint).cloudways_api_connection
+      end
+    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,32 +1,42 @@
-module RubyApiPackCloudways
-    module Connection
-        class CwConnect
-
-            # Connection - Attributes
-            attr_accessor :cw_api_url_base, :cw_api_path
-
-            # 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
-
-            # Connection - API Connection Call
-            def cloudways_api_connection
-
-                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
-
-                return cw_api_connetion_response.get @cw_api_url_base + @cw_api_path
-
-            end
-
-        end
-    end
-end
+# frozen_string_literal: true
+
+require 'httparty'
+
+module RubyApiPackCloudways
+  module Connection
+    class CwConnect
+      attr_reader :cw_api_url_base, :cw_api_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
+
+      def cloudways_api_connection
+        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
+
+      def handle_response(response)
+        case response.code
+        when 200
+          parse_response(response)
+        else
+          raise "Error: Received status #{response.code}"
+        end
+      end
+
+      def parse_response(response)
+        Oj.load(response.body)
+      rescue Oj::ParseError => e
+        raise "Error parsing response: #{e.message}"
+      end
+    end
+  end
+end

data/lib/ruby_api_pack_cloudways/connection/cw_token.rb

@@ -1,47 +1,35 @@
-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
-
-            end
-
-            # Cloudways - Token - Request
-            def cw_api_token
-
-                # 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
-
-                # Cloudways - Token - Request Isolate and Get Token from Response via OJ
-                return cw_api_token = Oj.load(cloudways_token_request.body)["access_token"]
-
-            end
-
-        end
-    end
-end
+# frozen_string_literal: true
+
+require 'httparty'
+
+module RubyApiPackCloudways
+  module Connection
+    class CwToken
+      attr_reader :cw_api_url_base, :cw_url_path_auth, :cw_user_email, :cw_user_key
+
+      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
+
+      def cw_api_token
+        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
+
+      def parse_response(response)
+        Oj.load(response.body)
+      rescue Oj::ParseError => e
+        raise "Error parsing response: #{e.message}"
+      end
+    end
+  end
+end

data/lib/ruby_api_pack_cloudways/version.rb

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

data/lib/ruby_api_pack_cloudways.rb

@@ -1,6 +1,22 @@
-require "ruby_api_pack_cloudways/version"
-
-module RubyApiPackCloudways
-  class Error < StandardError; end
-  require_relative "ruby_api_pack_cloudways/cw_client"
-end
+# frozen_string_literal: true
+
+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
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+  end
+end

metadata

@@ -1,103 +1,62 @@
 --- !ruby/object:Gem::Specification
 name: ruby_api_pack_cloudways
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.3
+  version: 0.1.0.pre.5
 platform: ruby
 authors:
 - PHCDevworks
+- Brad Potts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-17 00:00:00.000000000 Z
+date: 2024-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: oj
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: 0.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '3.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
-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: []
@@ -107,9 +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/cw_client.rb
 - lib/ruby_api_pack_cloudways/version.rb
 homepage: https://phcdevworks.com/
 licenses:
@@ -127,14 +86,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.0.3.1
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: API Pack for Cloudways

data/lib/ruby_api_pack_cloudways/cw_client.rb

@@ -1,23 +0,0 @@
-# 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"]
-
-module RubyApiPackCloudways
-    class CwClient
-
-        # Load Required Gems
-        require "faraday"
-        require "oj"
-
-        # Load Main Files
-        require_relative "connection/cw_token"
-        require_relative "connection/cw_connect"
-
-        # Load API Files
-        require_relative "api/cw_lists"
-        require_relative "api/cw_server"
-
-    end
-end