cloudally 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7316687a69f5efc3a9644196d14ab51d8e5fe3a435fbe392d633fef1cd6c5995
-  data.tar.gz: 83b8bc9d624b50f7d9e06899af6f44dce0f0c052a40700d64392c56dd7b56ef8
+  metadata.gz: 26ff0cec39018a19e5f5f42cbb64628f060a19702ade85a67a9fa760b7edf0d4
+  data.tar.gz: 7d02ca3eb358d908ac2dec13b6f2b449d0e1213e97255414b7401dc826343799
 SHA512:
-  metadata.gz: aec4098aaa3dd430ff2a18f03fbb59f6d140297377899c4a350f399e0e80d6db7f619e30acda36d3515729eca23fa2cafc8ca5b9d27484ebce557f4a6997aecf
-  data.tar.gz: 5ab2fd0b3e793e9e7ad39d64a894f79668217c2c712005da420a218608c794f9996385d9f6414eeac6ec23717ae9c769656a18079060feaab39b40162ec1c770
+  metadata.gz: f50593cbf3f41eaf514a54a821eeb3f94f7360de5823ca066e13725faf1c58fe35e577852987eb20a7ecf402742c91e2a794a89d016d62230c725dcd31b7c815
+  data.tar.gz: d5757a6b9737d8558abfdf977e90972fbd1e3b47457d1a7f99592942726947bc62a80cb608b9da4a4b19473da9d07c71e024beac8845ab3d62967bdd87013fa8

data/.env.template

@@ -1,4 +1,4 @@
 CLOUDALLY_CLIENT_ID=<client id>
 CLOUDALLY_CLIENT_SECRET=<client secret>
-CLOUDALLY_USER=<uername/mail>
+CLOUDALLY_USER=<username/mail>
 CLOUDALLY_PASSWORD=<password>

data/.gitignore

@@ -41,3 +41,4 @@
 
 # Used by RuboCop. Remote config files pulled in from inherit_from directive.
 # .rubocop-https?--*
+Gemfile.lock

data/CHANGELOG.md

@@ -1,5 +1,10 @@
-## [Unreleased]
+## [Unreleased]
+
+## [0.1.0] - 2024-01-25
+- Initial release
 
-## [0.1.0] - 2024-01-25
-
-- Initial release
+## [0.1.1] - 2024-01-25
+-  Missing files added to gem
+
+## [0.1.2] - 2024-01-30
+-  Correct version faraday library

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cloudally.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rubocop", "~> 1.7"

data/README.md

@@ -0,0 +1,74 @@
+# Cloudally API
+
+
+This is a wrapper for the CloudAlly portal API v1. You can see the API endpoints here https://api.cloudally.com/documentation
+
+Currently only the GET requests for the Partner Portal API are implemented.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cloudally'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install cloudally
+
+## Usage
+
+Before you start making the requests to API provide the client id and client secret and email/password using the configuration wrapping.
+
+```
+CloudAlly.configure do |config|
+	config.client_id = ENV["CLOUDALLY_CLIENT_ID"]
+	config.client_secret = ENV["CLOUDALLY_CLIENT_SECRET"]
+	config.username = ENV["CLOUDALLY_USER"]
+	config.password = ENV["CLOUDALLY_PASSWORD"]
+	config.logger = Logger.new( "./cloudally-http.log" )
+end
+CloudAlly.partner_login
+client = CloudAlly.client
+```
+
+## Resources
+### Authentication
+```
+client.partner_login
+```
+|Resource|API endpoint|Description|
+|:--|:--|:--|
+|.auth_partner or .partner_login|/auth/partner|Authenticate partner|
+|.auth or .login|/auth|Authenticate portal user|
+|.auth_refresh|/auth/refresh|Refresh authentication token|
+
+### Partner Portal
+Endpoint for partner related requests https://api.cloudally.com/documentation#/Partner%20Portal
+```
+partner = client.get_partner
+puts partner.email
+```
+
+|Resource|API endpoint|
+|:--|:--|
+|.partners or .get_partner|/v1/partners|
+|.partner_bills|/v1/partners/bills
+|.partner_status or .get_status_by_partner|/v1/partners/status|
+|.partner_tasks|/v1/partners/tasks|
+|.partner_resellers or .get_resellers_list  |/v1/partners/resellers|
+|.partner_resellers( partner_id ) or .get_reseller_by_partner_id( partner_id )|/v1/partners/resellers/{partner_id}|
+|.partner_users or .get_users_by_partner|/v1/partners/users|
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jancotanis/cloudally.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+task default: %i[test rubocop]

data/cloudally.gemspec

@@ -1,37 +1,35 @@
 # frozen_string_literal: true
 
-require_relative "lib/cloudally/version"
+require_relative 'lib/cloudally/version'
 
 Gem::Specification.new do |s|
-  s.name        = "cloudally"
+  s.name        = 'cloudally'
   s.version     = CloudAlly::VERSION
-  s.authors     = ["Janco Tanis"]
-  s.email       = "gems@jancology.com"
-  s.license     = "MIT"
+  s.authors     = ['Janco Tanis']
+  s.email       = 'gems@jancology.com'
+  s.license     = 'MIT'
 
+  s.summary     = 'A Ruby wrapper for the CloudAlly Partner Portal REST APIs (readonly)'
+  s.homepage    = 'https://rubygems.org/gems/cloudally'
 
-  s.summary     = %q{A Ruby wrapper for the CloudAlly Partner Portal REST APIs (readonly)}
-  s.homepage    = "https://rubygems.org/gems/cloudally"
+  s.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
 
-  s.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
-
-  s.metadata["homepage_uri"] = s.homepage
-  s.metadata["source_code_uri"] = "https://github.com/jancotanis/cloudally"
+  s.metadata['homepage_uri'] = s.homepage
+  s.metadata['source_code_uri'] = 'https://github.com/jancotanis/cloudally'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   s.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
-  s.bindir        = "exe"
+  s.bindir        = 'exe'
   s.executables   = s.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
 
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.platform = Gem::Platform::RUBY
-  s.add_runtime_dependency('faraday', ['>= 0.7', '< 0.10'])
-  s.add_development_dependency "dotenv"
-  s.add_development_dependency "minitest"
-  s.add_development_dependency "rubocop"
-
+  s.add_runtime_dependency 'faraday'
+  s.add_development_dependency 'dotenv'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'rubocop'
 end

data/lib/cloudally/api.rb

@@ -1,32 +1,31 @@
-require File.expand_path('../connection', __FILE__)
-require File.expand_path('../request', __FILE__)
-require File.expand_path('../authentication', __FILE__)
-
-
-module CloudAlly
-  # @private
-  class API
-    # @private
-    attr_accessor *Configuration::VALID_OPTIONS_KEYS
-
-    # Creates a new API
-    def initialize(options={})
-      options = CloudAlly.options.merge(options)
-      Configuration::VALID_OPTIONS_KEYS.each do |key|
-        send("#{key}=", options[key])
-      end
-    end
-
-    def config
-      conf = {}
-      Configuration::VALID_OPTIONS_KEYS.each do |key|
-        conf[key] = send key
-      end
-      conf
-    end
-
-    include Connection
-    include Request
-    include Authentication
-  end
-end
+require File.expand_path('connection', __dir__)
+require File.expand_path('request', __dir__)
+require File.expand_path('authentication', __dir__)
+
+module CloudAlly
+  # @private
+  class API
+    # @private
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API
+    def initialize(options = {})
+      options = CloudAlly.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    def config
+      conf = {}
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        conf[key] = send key
+      end
+      conf
+    end
+
+    include Connection
+    include Request
+    include Authentication
+  end
+end

data/lib/cloudally/authentication.rb

@@ -1,65 +1,53 @@
-module CloudAlly
-	# Defines HTTP request methods
-	module Authentication
-
-		# Return an access token from authorization
-		def get_access_token(options={})
-			params = access_token_params.merge(options)
-
-			response = post("/auth/partner", params)
-			res = JSON.parse( response.body )
-
-			access_token = res[ "accessToken" ]
-
-			raise Exception.new 'Could not find valid accessToken' if access_token == '' || access_token.nil?
-			access_token
-		end
-
-		# Authorize to the CloudAlly portal and return access_token
-		def auth( options={} )
-			params = access_token_params.merge(options)
-			response = post("/auth", params)
-			# return access_token
-			process_token( response.body )
-		end
-		alias login auth
-
-		# Return an access token from authorization
-		def auth_refresh( token )
-			params = { refreshToken: token}
-
-			response = post( "/auth/refresh", params )
-			# return access_token
-			process_token( response.body )
-		end
-
-		# Authorize to the partner portal and return access_token
-		def auth_partner( options={} )
-			params = access_token_params.merge(options)
-			response = post("/auth/partner", params)
-			# return access_token
-			process_token( response.body )
-		end
-		alias partner_login auth_partner
-
-		private
-
-		def access_token_params
-			{
-			  email: username,
-			  password: password
-			}
-		end
-		def process_token( response )
-			at = nil
-			CloudAlly.configure do |config|
-				at = config.access_token	= response[ "accessToken" ]
-				config.token_type			= response[ "tokenType" ]
-				config.refresh_token		= response[ "refreshToken" ]
-				config.token_expires		= response[ "expiresIn" ]
-			end
-			raise Exception.new 'Could not find valid accessToken; response '+response.to_s if at == '' || at.nil?
-			at
-		end
-	end
-end
+module CloudAlly
+  # Deals with authentication flow and stores it within global configuration
+  module Authentication
+    # Authorize to the CloudAlly portal and return access_token
+    def auth(options = {})
+      params = access_token_params.merge(options)
+      response = post("/auth", params)
+      # return access_token
+      process_token(response.body)
+    end
+    alias login auth
+
+    # Return an access token from authorization
+    def auth_refresh(token)
+      params = { refreshToken: token }
+
+      response = post("/auth/refresh", params)
+      # return access_token
+      process_token(response.body)
+    end
+
+    # Authorize to the partner portal and return access_token
+    def auth_partner(options = {})
+      params = access_token_params.merge(options)
+      response = post("/auth/partner", params)
+      # return access_token
+      process_token(response.body)
+    end
+    alias partner_login auth_partner
+
+    private
+
+    def access_token_params
+      {
+        email: username,
+        password: password
+      }
+    end
+
+    def process_token(response)
+      at = nil
+      CloudAlly.configure do |config|
+        at = config.access_token = response["accessToken"]
+        config.token_type        = response["tokenType"]
+        config.refresh_token     = response["refreshToken"]
+        config.token_expires     = response["expiresIn"]
+      end
+      raise StandardError.new 'Could not find valid accessToken; response ' + response.to_s if at == '' || at.nil?
+
+      at
+    end
+  end
+end

data/lib/cloudally/client/partners.rb

@@ -1,66 +1,69 @@
-
 module CloudAlly
-	class Client
-		# Defines methods related to users
-		module PartnerPortal
+  class Client
+    # Defines methods related to partners
+    module PartnerPortal
+      # Get CloudAlly Partner settings.
+      #
+      # @see https://api.cloudally.com/documentation#/Partner%20Portal
+      def partners
+        get("partners")
+      end
+      alias get_partner partners
+
+      # Get Partner bills.
+      #
+      # @see https://api.cloudally.com/documentation#/Partner%20Portal
+      def partner_bills
+        get_paged("partners/bills")
+      end
+
+      # Get Partner bills.
+      #
+      # @see https://api.cloudally.com/documentation#/Partner%20Portal
+      def partner_status
+        get_paged("partners/status")
+      end
+      alias get_status_by_partner partner_status
+
+      # Get Partner tasks.
+      #
+      # @see https://api.cloudally.com/documentation#/Partner%20Portal
+      def partner_tasks
+        get_paged("partners/tasks")
+      end
+
+      # Get Partner resellers.
+      #
+      # @see https://api.cloudally.com/documentation#/Partner%20Portal
+      def partner_resellers(partner_id = nil)
+        if partner_id
+          get_paged("partners/resellers/#{partner_id}")
+        else
+          get_paged("partners/resellers")
+        end
+      end
 
-			# Get CloudAlly Partner settings.
-			#
-			# @see https://api.cloudally.com/documentation#/Partner%20Portal
-			def partners
-				get( "partners" )
-			end
-			alias :get_partner :partners
+      # Get Partner resellers.
+      #
+      # @see https://api.cloudally.com/documentation#/Partner%20Portal
+      def get_resellers_list
+        partner_resellers()
+      end
 
-			# Get Partner bills.
-			#
-			# @see https://api.cloudally.com/documentation#/Partner%20Portal
-			def partner_bills
-				get_paged( "partners/bills" )
-			end
-			# Get Partner bills.
-			#
-			# @see https://api.cloudally.com/documentation#/Partner%20Portal
-			def partner_status
-				get_paged( "partners/status" )
-			end
-			alias :get_status_by_partner :partner_status
-			# Get Partner tasks.
-			#
-			# @see https://api.cloudally.com/documentation#/Partner%20Portal
-			def partner_tasks
-				get_paged( "partners/tasks" )
-			end
-			# Get Partner resellers.
-			#
-			# @see https://api.cloudally.com/documentation#/Partner%20Portal
-			def partner_resellers( partner_id=nil )
-				if partner_id
-					get_paged( "partners/resellers/#{partner_id}" )
-				else
-					get_paged( "partners/resellers" )
-				end
-			end
-			# Get Partner resellers.
-			#
-			# @see https://api.cloudally.com/documentation#/Partner%20Portal
-			def get_resellers_list
-				partner_resellers()
-			end
-			# Get Partner resellers.
-			#
-			# @see https://api.cloudally.com/documentation#/Partner%20Portal
-			def get_reseller_by_partner_id partner_id
-				partner_resellers( partner_id )
-			end
-			# Get Partner users.
-			#
-			# @see https://api.cloudally.com/documentation#/Partner%20Portal
-			def partner_users
-				get_paged( "partners/users" )
-			end
-			alias :get_users_by_partner :partner_users
+      # Get Partner resellers.
+      #
+      # @see https://api.cloudally.com/documentation#/Partner%20Portal
+      def get_reseller_by_partner_id partner_id
+        partner_resellers(partner_id)
+      end
 
-		end
-	end
-end
+      # Get Partner users.
+      #
+      # @see https://api.cloudally.com/documentation#/Partner%20Portal
+      def partner_users
+        get_paged("partners/users")
+      end
+      alias get_users_by_partner partner_users
+    end
+  end
+end

data/lib/cloudally/client.rb

@@ -1,11 +1,11 @@
-module CloudAlly
-  # Wrapper for the CloudAlly REST API
-  #
-  # @note All methods have been separated into modules and follow the same grouping used in api docs
-  # @see https://api.cloudally.com/documentation
-  class Client < API
-    Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
-
-    include CloudAlly::Client::PartnerPortal
-  end
-end
+module CloudAlly
+  # Wrapper for the CloudAlly REST API
+  #
+  # @note All methods have been separated into modules and follow the same grouping used in api docs
+  # @see https://api.cloudally.com/documentation
+  class Client < API
+    Dir[File.expand_path('client/*.rb', __dir__)].each { |f| require f }
+
+    include CloudAlly::Client::PartnerPortal
+  end
+end

data/lib/cloudally/configuration.rb

@@ -1,103 +1,86 @@
-require_relative "./version"
-module CloudAlly
-  # Defines constants and methods related to configuration
-  module Configuration
-    # An array of valid keys in the options hash when configuring a {CloudAlly::API}
-
-    VALID_OPTIONS_KEYS = [
-		:access_token,
-		:token_type,
-		:refresh_token,
-		:token_expires,
-		:client_id,
-		:client_secret,
-		:connection_options,
-		:username,
-		:password,
-		:endpoint,
-		:logger,
-		:format,
-		:page_size,
-		:user_agent
-    ].freeze
-
-	# By default, don't set a user access token
-    DEFAULT_ACCESS_TOKEN = nil
-    DEFAULT_TOKEN_TYPE = nil
-
-    # By default, don't set an application ID
-    DEFAULT_CLIENT_ID = nil
-
-    # By default, don't set an application secret
-    DEFAULT_CLIENT_SECRET = nil
-
-    # By default, don't set application username
-    DEFAULT_USERNAME = nil
-
-    # By default, don't set application password
-    DEFAULT_PASSWORD = nil
-
-    # By default, don't set any connection options
-    DEFAULT_CONNECTION_OPTIONS = {}
-
-    # The endpoint that will be used to connect if none is set
-    #
-    # @note There is no reason to use any other endpoint at this time
-    DEFAULT_ENDPOINT = "https://api.cloudally.com/v1/".freeze
-
-    # By default, don't turn on logging
-    DEFAULT_LOGGER = nil
-
-    # The response format appended to the path and sent in the 'Accept' header if none is set
-    #
-    # @note JSON is the only available format at this time
-    DEFAULT_FORMAT = :json
-
-    # The page size for paged rest responses 
-    #
-    # @note default JSON is the only available format at this time
-    DEFAULT_PAGE_SIZE = 500
-
-    # The user agent that will be sent to the API endpoint if none is set
-    DEFAULT_USER_AGENT = "CloudAlly Ruby API wrapper #{CloudAlly::VERSION}".freeze
-
-    # @private
-    attr_accessor *VALID_OPTIONS_KEYS
-
-    # When this module is extended, set all configuration options to their default values
-    def self.extended(base)
-      base.reset
-    end
-
-    # Convenience method to allow configuration options to be set in a block
-    def configure
-      yield self
-    end
-
-    # Create a hash of options and their values
-    def options
-      VALID_OPTIONS_KEYS.inject({}) do |option, key|
-        option.merge!(key => send(key))
-      end
-    end
-
-    # Reset all configuration options to defaults
-    def reset
-      self.access_token       = DEFAULT_ACCESS_TOKEN
-      self.token_type         = DEFAULT_TOKEN_TYPE
-      self.client_id          = DEFAULT_CLIENT_ID
-      self.client_secret      = DEFAULT_CLIENT_SECRET
-      self.username           = DEFAULT_USERNAME
-      self.password           = DEFAULT_PASSWORD
-      self.connection_options = DEFAULT_CONNECTION_OPTIONS
-      self.endpoint           = DEFAULT_ENDPOINT
-      self.logger             = DEFAULT_LOGGER
-      self.format             = DEFAULT_FORMAT
-      self.page_size          = DEFAULT_PAGE_SIZE
-      self.user_agent         = DEFAULT_USER_AGENT
-	  
-	  self.refresh_token      = nil
-	  self.token_expires      = nil
-    end
-  end
-end
+require_relative "./version"
+module CloudAlly
+  # Defines constants and methods related to configuration
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {CloudAlly::API}
+
+    VALID_OPTIONS_KEYS = [
+      :access_token,
+      :token_type,
+      :refresh_token,
+      :token_expires,
+      :client_id,
+      :client_secret,
+      :connection_options,
+      :username,
+      :password,
+      :endpoint,
+      :logger,
+      :format,
+      :page_size,
+      :user_agent
+    ].freeze
+
+
+    # By default, don't set any connection options
+    DEFAULT_CONNECTION_OPTIONS = {}
+
+    # The endpoint that will be used to connect if none is set
+    #
+    # @note There is no reason to use any other endpoint at this time
+    DEFAULT_ENDPOINT = "https://api.cloudally.com/v1/".freeze
+
+    # The response format appended to the path and sent in the 'Accept' header if none is set
+    #
+    # @note JSON is the only available format at this time
+    DEFAULT_FORMAT = :json
+
+    # The page size for paged rest responses
+    #
+    # @note default JSON is the only available format at this time
+    DEFAULT_PAGE_SIZE = 500
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = "CloudAlly Ruby API wrapper #{CloudAlly::VERSION}".freeze
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.access_token       = nil
+      self.token_type         = nil
+      self.refresh_token      = nil
+      self.token_expires      = nil
+      self.client_id          = nil
+      self.client_secret      = nil
+      self.username           = nil
+      self.password           = nil
+
+      self.logger             = nil
+      self.connection_options = DEFAULT_CONNECTION_OPTIONS
+      self.endpoint           = DEFAULT_ENDPOINT
+      self.format             = DEFAULT_FORMAT
+      self.page_size          = DEFAULT_PAGE_SIZE
+      self.user_agent         = DEFAULT_USER_AGENT
+
+    end
+  end
+end

data/lib/cloudally/connection.rb

@@ -1,45 +1,42 @@
-require 'faraday'
-#require 'faraday_middleware'
-#Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{|f| require f}
-
-module CloudAlly
-	# @private
-	module Connection
-	private
-
-		def connection
-		  options = {
-			:headers => { 
-				'Accept' => "application/#{format}; charset=utf-8",
-				'User-Agent' => user_agent
-			},
-			:url => endpoint
-		  }.merge( connection_options )
-
-		  Faraday::Connection.new(options) do |connection|
-			connection.use Faraday::Response::RaiseError
-			#connection.use FaradayMiddleware::RaiseHttpException
-			connection.adapter Faraday.default_adapter
-
-			#connection.use FaradayMiddleware::InstagramOAuth2, client_id, access_token
-			connection.authorization :Bearer, access_token if access_token
-			connection.headers['client-id'] = client_id
-			connection.headers['client-secret'] = client_secret
-			connection.response :json, :content_type => /\bjson$/
-			connection.use Faraday::Request::UrlEncoded
-
-			#connection.use FaradayMiddleware::LoudLogger if loud_logger
-			if logger
-				connection.response :logger, logger, { headers: true, bodies: true } do |l|
-					# filter json content
-					l.filter(/(\"password\"\:\")(.+?)(\".*)/, '\1[REMOVED]\3')
-					l.filter(/(\"accessToken\"\:\")(.+?)(\".*)/, '\1[REMOVED]\3')
-					# filter header content
-					l.filter(/(client-secret\:.)([^&]+)/, '\1[REMOVED]')
-					l.filter(/(Authorization\:.)([^&]+)/, '\1[REMOVED]')
-				end
-			end
-		  end
-		end
-	end
-end
+require 'faraday'
+
+module CloudAlly
+  # @private
+  module Connection
+    private
+
+    def connection
+      options = {
+        headers: {
+          'Accept': "application/#{format}; charset=utf-8",
+          'User-Agent': user_agent
+        },
+        url: endpoint
+      }.merge(connection_options)
+
+      Faraday::Connection.new(options) do |connection|
+        connection.use Faraday::Response::RaiseError
+        connection.adapter Faraday.default_adapter
+
+        connection.authorization :Bearer, access_token if access_token
+        connection.headers['client-id'] = client_id
+        connection.headers['client-secret'] = client_secret
+        connection.response :json, content_type: /\bjson$/
+        connection.use Faraday::Request::UrlEncoded
+
+        setup_logger_filtering(connection,logger) if logger
+      end
+    end
+
+    def setup_logger_filtering(connection,logger)
+      connection.response :logger, logger, { headers: true, bodies: true } do |l|
+        # filter json content
+        l.filter(/("password":")(.+?)(".*)/, '\1[REMOVED]\3')
+        l.filter(/("accessToken":")(.+?)(".*)/, '\1[REMOVED]\3')
+        # filter header content
+        l.filter(/(client-secret\:.)([^&]+)/, '\1[REMOVED]')
+        l.filter(/(Authorization\:.)([^&]+)/, '\1[REMOVED]')
+      end
+    end
+  end
+end

data/lib/cloudally/request.rb

@@ -1,117 +1,121 @@
-require 'uri'
-require 'json'
-
-module CloudAlly
-
-	# Defines HTTP request methods
-	module Request
-		class Entity
-			attr_reader :attributes
-			def initialize attributes
-				@attributes = attributes.clone.transform_keys( &:to_s )
-			end
-
-			def method_missing(method_sym, *arguments, &block)
-				len = arguments.length
-				if method = method_sym[/.*(?==\z)/m]
-					# assignment
-					if len != 1
-						raise! ArgumentError, "wrong number of arguments (given #{len}, expected 1)", caller(1)
-					end
-					@attributes[method] = arguments[ 0 ]
-				elsif @attributes.include? method_sym.to_s
-					r = @attributes[method_sym.to_s]
-					case r
-					when Hash
-						r = @attributes[method_sym.to_s] = self.class.new( r )
-					when Array
-						# make deep copy
-						@attributes[method_sym.to_s] = r = r.map{ |item| self.class.new( item ) } if r.length > 0 && r[0].is_a?( Hash )
-						r
-					else
-						r
-					end
-				else
-					super
-				end
-			end
-
-			def respond_to?(method_sym, include_private = false)
-				if @attributes.include? method_sym.to_s
-					true
-				else
-					super
-				end
-			end
-		end
-		# Perform an HTTP GET request and return entity
-		def get(path, options={})
-			response = request(:get, path, options)
-			:json.eql?( format ) ? Entity.new( response.body ) : response.body
-		end
-
-		# Perform an HTTP GET request for paged date sets responsind to 
-		# Name			Description
-		# pageSize		The number of records to display per page
-		# page			The page number
-		# nextPageToken Next page token
-		def get_paged( path, options={}, &block )
-			raise! ArgumentError, "Pages requests should be json formatted (given format '#{format}')" unless :json.eql? format
-			result = []
-			page = 1
-			total = page + 1
-			nextPage = ""
-			while page <= total
-				# https://api.cloudally.com/v3/api-docs/v1
-				followingPage = { pageSize: page_size }
-				followingPage.merge!( { page: page, nextPageToken: nextPage } ) unless nextPage.empty?
-
-				response = request(:get, path, options.merge( followingPage ) )
-				data = response.body
-				d = data[ "data" ].map{ |e| Entity.new(e) }
-				if block_given?
-					yield( d )
-				else
-					result += d
-				end
-				page += 1
-				total = data["totalPages"].to_i
-				nextPage = data["nextPageToken"]
-			end
-			d unless block_given?
-		end
-
-		# Perform an HTTP POST request
-		def post(path, options={})
-			request(:post, path, options)
-		end
-
-		# Perform an HTTP PUT request
-		def put(path, options={})
-			request(:put, path, options)
-		end
-
-		# Perform an HTTP DELETE request
-		def delete(path, options={})
-			request(:delete, path, options)
-		end
-
-		private
-
-		# Perform an HTTP request
-		def request( method, path, options )
-			response = connection().send( method ) do |request|
-				uri = URI::Parser.new
-				case method
-				when :get, :delete
-					request.url( uri.escape( path ), options )
-				when :post, :put
-					request.headers['Content-Type'] = "application/#{format}"
-					request.path = uri.escape( path )
-					request.body = options.to_json unless options.empty?
-				end
-			end
-			response
-		end
-	end
-end
+require 'uri'
+require 'json'
+
+module CloudAlly
+  # Defines HTTP request methods
+  module Request
+    class Entity
+      attr_reader :attributes
+
+      def initialize attributes
+        @attributes = attributes.clone.transform_keys(&:to_s)
+      end
+
+      def method_missing(method_sym, *arguments, &block)
+        len = arguments.length
+        if method = method_sym[/.*(?==\z)/m]
+          # assignment
+          if len != 1
+            raise! ArgumentError, "wrong number of arguments (given #{len}, expected 1)", caller(1)
+          end
+          @attributes[method] = arguments[0]
+        elsif @attributes.include? method_sym.to_s
+          r = @attributes[method_sym.to_s]
+          case r
+          when Hash
+            r = @attributes[method_sym.to_s] = self.class.new(r)
+          when Array
+            # make deep copy
+            @attributes[method_sym.to_s] = r = r.map { |item|
+              self.class.new(item)
+            } if r.length > 0 && r[0].is_a?(Hash)
+            r
+          else
+            r
+          end
+        else
+          super
+        end
+      end
+
+      def respond_to?(method_sym, include_private = false)
+        if @attributes.include? method_sym.to_s
+          true
+        else
+          super
+        end
+      end
+    end
+
+    # Perform an HTTP GET request and return entity
+    def get(path, options = {})
+      response = request(:get, path, options)
+      :json.eql?(format) ? Entity.new(response.body) : response.body
+    end
+
+    # Perform an HTTP GET request for paged date sets responsind to
+    # Name			Description
+    # pageSize		The number of records to display per page
+    # page			The page number
+    # nextPageToken Next page token
+    def get_paged(path, options = {}, &block)
+      raise! ArgumentError,
+             "Pages requests should be json formatted (given format '#{format}')" unless :json.eql? format
+      result = []
+      page = 1
+      total = page + 1
+      nextPage = ""
+      while page <= total
+        # https://api.cloudally.com/v3/api-docs/v1
+        followingPage = { pageSize: page_size }
+        followingPage.merge!({ page: page, nextPageToken: nextPage }) unless nextPage.empty?
+
+        response = request(:get, path, options.merge(followingPage))
+        data = response.body
+        d = data["data"].map { |e| Entity.new(e) }
+        if block_given?
+          yield(d)
+        else
+          result += d
+        end
+        page += 1
+        total = data["totalPages"].to_i
+        nextPage = data["nextPageToken"]
+      end
+      d unless block_given?
+    end
+
+    # Perform an HTTP POST request
+    def post(path, options = {})
+      request(:post, path, options)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, options = {})
+      request(:put, path, options)
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, options = {})
+      request(:delete, path, options)
+    end
+
+    private
+
+    # Perform an HTTP request
+    def request(method, path, options)
+      response = connection().send(method) do |request|
+        uri = URI::Parser.new
+        case method
+        when :get, :delete
+          request.url(uri.escape(path), options)
+        when :post, :put
+          request.headers['Content-Type'] = "application/#{format}"
+          request.path = uri.escape(path)
+          request.body = options.to_json unless options.empty?
+        end
+      end
+      response
+    end
+  end
+end

data/lib/cloudally/version.rb

@@ -1,4 +1,5 @@
-# frozen_string_literal: true
-module CloudAlly
-	VERSION = '0.1.0'
-end
+# frozen_string_literal: true
+
+module CloudAlly
+  VERSION = '0.1.2'
+end

data/lib/cloudally.rb

@@ -1,26 +1,27 @@
-require File.expand_path('../cloudally/configuration', __FILE__)
-require File.expand_path('../cloudally/api', __FILE__)
-require File.expand_path('../cloudally/client', __FILE__)
-require File.expand_path('../cloudally/version', __FILE__)
-
-module CloudAlly
-	extend Configuration
-
-	# Alias for CloudAlly::Client.new
-	#
-	# @return [CloudAlly::Client]
-	def self.client(options={})
-		CloudAlly::Client.new(options)
-	end
-
-	# Delegate to CloudAlly::Client
-	def self.method_missing(method, *args, &block)
-		return super unless client.respond_to?(method)
-		client.send(method, *args, &block)
-	end
-
-	# Delegate to CloudAlly::Client
-	def self.respond_to?(method, include_all=false)
-		return client.respond_to?(method, include_all) || super
-	end
-end
+require File.expand_path('cloudally/configuration', __dir__)
+require File.expand_path('cloudally/api', __dir__)
+require File.expand_path('cloudally/client', __dir__)
+require File.expand_path('cloudally/version', __dir__)
+
+module CloudAlly
+  extend Configuration
+
+  # Alias for CloudAlly::Client.new
+  #
+  # @return [CloudAlly::Client]
+  def self.client(options = {})
+    CloudAlly::Client.new(options)
+  end
+
+  # Delegate to CloudAlly::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to CloudAlly::Client
+  def self.respond_to?(method, include_all = false)
+    client.respond_to?(method, include_all) || super
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudally
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Janco Tanis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-29 00:00:00.000000000 Z
+date: 2024-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,20 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -81,6 +75,9 @@ files:
 - ".env.template"
 - ".gitignore"
 - CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
 - cloudally.gemspec
 - lib/cloudally.rb
 - lib/cloudally/api.rb