cloudally 0.1.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68a94c91f6e5622ce7e6bec6df252666c423e26b713ee198833ee61c653fee61
-  data.tar.gz: a3e801fc1226015b89f5223f019272bf7a9a53820787f397d0ea6dfdafbe4801
+  metadata.gz: f2f46745c7981091945d40c86bd68e6004dff4ea39ecaa436225c9d5df00a535
+  data.tar.gz: 2bf09895b3b8df0b1741f87b41c1f8d2a16c4b5fbb53c0047b9eaa5adcc7e399
 SHA512:
-  metadata.gz: c2b4077a590dd0fba1788cf845396ef793944a1c032003fd5e84bc84102f34132494f5ff3c85aba33958ab0aa2a09951d867b5081031021c2c7ce6e7bd620471
-  data.tar.gz: c96283aa619293b887fc5299db06dbda3c613196de65504230ab8a692fff4359ae020d2a19d67c56ed235474f11492c5af6c52a9d9a22276524355bb4a869965
+  metadata.gz: '068f074ab511b4f91073553debfb77f96a81a0e7e82f1c3f02d02618be89c50217acb19fa18f964ee73270e9cb740654b426a159d60d84b846bed9eadceabc2e'
+  data.tar.gz: 78b7f883e82d2e0bd2e25654d74223c3409ace9bc1f64d6f374b3ca8e5b565bfece1de7bd822e3ec6d0891ec4102939358d56e91c270380288461d120dd0735a

data/CHANGELOG.md

@@ -11,3 +11,9 @@
 
 ## [0.1.3] - 2024-01-30
 -  Fix defect in request paging to return all pages when no block is given
+
+## [0.2.0] - 2024-01-30
+-  json return for entities
+
+## [0.2.1] - 2024-01-30
+-  use wrapi gem

data/README.md

@@ -33,8 +33,9 @@ CloudAlly.configure do |config|
 	config.password = ENV["CLOUDALLY_PASSWORD"]
 	config.logger = Logger.new( "./cloudally-http.log" )
 end
-CloudAlly.partner_login
+ 
 client = CloudAlly.client
+client.partner_login
 ```
 
 ## Resources

data/cloudally.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.platform = Gem::Platform::RUBY
   s.add_runtime_dependency 'faraday'
+  s.add_runtime_dependency 'wrapi', ">= 0.1.3"
   s.add_development_dependency 'dotenv'
   s.add_development_dependency 'minitest'
   s.add_development_dependency 'rubocop'

data/lib/cloudally/api.rb

@@ -1,17 +1,16 @@
-require File.expand_path('connection', __dir__)
-require File.expand_path('request', __dir__)
+require "wrapi"
 require File.expand_path('authentication', __dir__)
 
 module CloudAlly
   # @private
   class API
     # @private
-    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+    attr_accessor *WrAPI::Configuration::VALID_OPTIONS_KEYS
 
     # Creates a new API
     def initialize(options = {})
       options = CloudAlly.options.merge(options)
-      Configuration::VALID_OPTIONS_KEYS.each do |key|
+      WrAPI::Configuration::VALID_OPTIONS_KEYS.each do |key|
         send("#{key}=", options[key])
       end
     end
@@ -24,8 +23,9 @@ module CloudAlly
       conf
     end
 
-    include Connection
-    include Request
+    include WrAPI::Connection
+    include WrAPI::Request
+    include WrAPI::Authentication
     include Authentication
   end
 end

data/lib/cloudally/authentication.rb

@@ -1,53 +1,29 @@
+
 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)
+      api_auth('/auth', options)
     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)
+      api_refresh('/auth/refresh', token)
     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)
+      api_auth('/auth/partner', options)
     end
     alias partner_login auth_partner
-
-    private
-
-    def access_token_params
+  private
+    def api_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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CloudAlly
-  VERSION = '0.1.3'
+  VERSION = '0.2.1'
 end

data/lib/cloudally.rb

@@ -1,27 +1,29 @@
-require File.expand_path('cloudally/configuration', __dir__)
+require "wrapi"
+
 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
+  extend WrAPI::Configuration
+  extend WrAPI::RespondTo
+
+  DEFAULT_ENDPOINT  = 'https://api.cloudally.com/v1/'.freeze
+  DEFAULT_USERAGENT = "CloudAlly Ruby API wrapper #{CloudAlly::VERSION}".freeze
 
   # 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)
+    CloudAlly::Client.new({
+      endpoint: DEFAULT_ENDPOINT,
+      user_agent: DEFAULT_USERAGENT
+    }.merge(options))
   end
-
-  # Delegate to CloudAlly::Client
-  def self.respond_to?(method, include_all = false)
-    client.respond_to?(method, include_all) || super
+  
+  def self.reset
+    super
+    self.endpoint = DEFAULT_ENDPOINT
+    self.user_agent = DEFAULT_USERAGENT
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudally
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.1
 platform: ruby
 authors:
 - Janco Tanis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-30 00:00:00.000000000 Z
+date: 2024-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: wrapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -84,9 +98,6 @@ files:
 - lib/cloudally/authentication.rb
 - lib/cloudally/client.rb
 - lib/cloudally/client/partners.rb
-- lib/cloudally/configuration.rb
-- lib/cloudally/connection.rb
-- lib/cloudally/request.rb
 - lib/cloudally/version.rb
 homepage: https://rubygems.org/gems/cloudally
 licenses:

data/lib/cloudally/configuration.rb

@@ -1,86 +0,0 @@
-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,42 +0,0 @@
-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,121 +0,0 @@
-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
-      result 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