miasma 0.3.4 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6ec4c699bde261e0e44469339a19cdcb55f58faad4c5ccbde0439321a22da83
-  data.tar.gz: d1d2c89ce389385c6e5a5a6462e201299e00b0f21da5d17ca9013e1149fe8df6
+  metadata.gz: a471e7134e77e97f6033f06d6824da13f855cbc19c168b02c31ea5793357d7c1
+  data.tar.gz: 51870ee9bab612af01b632be5316e585a22d508e94c398eb22042c52a96dca9d
 SHA512:
-  metadata.gz: 564daaf08564aff07e67fdd1fe0b117ab86dad1fa3a9f17a34baf9774e456fb771ee3351de708e719446fd3a5c316a1b3c8cbcd686de98fa2f1c76dec9a8f8ad
-  data.tar.gz: 10832fe2f29d56c4096384e2486f2b6e71c9c0c7bd741f315cc6fc3b5a54766f24f45c3a378969df59cedc225381343e274f6b24c2a0b455acf09059c05279e1
+  metadata.gz: 543ddacf9eaa53433430bde752406cefa6699ae850e9ee28ed82a23ba4ccd0c373e55f4de2bde3cfca359b54a10422aa2bbe529e7c7a04d063c45f2682a216bd
+  data.tar.gz: b4033baa376b004ad9caf250afe703866a18175962c282bead06eec01d1eddf53e4c207e6c93c9b9cbdf43c7c90f9740909c122919a155f194776c3f8a08db0b

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.3.6
+* Add logging to API
+
 # v0.3.4
 * Add queue modeling abstracts
 * Add orchestration stack plan abstracts

data/lib/miasma/types/api.rb

@@ -11,9 +11,11 @@ module Miasma
       # Maximum allowed HTTP request retries (for non-HTTP related errors)
       MAX_REQUEST_RETRIES = 5
 
+      include Bogo::Logger::Helpers
       include Miasma::Utils::Lazy
       include Miasma::Utils::Memoization
 
+      logger_name(:api)
       always_clean!
 
       # Create new API connection
@@ -25,7 +27,8 @@ module Miasma
         if creds.is_a?(Hash)
           load_data(creds)
         else
-          raise TypeError.new "Expecting `credentials` to be of type `Hash`. Received: `#{creds.class}`"
+          raise TypeError, "Expecting `credentials` to be of type `Hash`. " \
+                "Received: `#{creds.class}`"
         end
         after_setup(creds)
         connect
@@ -104,9 +107,7 @@ module Miasma
         end
         request_args = [].tap do |ary|
           _endpoint = args.delete(:endpoint) || endpoint
-          ary.push(
-            File.join(_endpoint, args[:path].to_s)
-          )
+          ary.push(File.join(_endpoint, args[:path].to_s))
           options = {}.tap do |opts|
             [:form, :params, :json, :body].each do |key|
               opts[key] = args[key] if args[key]
@@ -140,7 +141,8 @@ module Miasma
       def retryable_request(http_method, &block)
         Bogo::Retry.build(
           data.fetch(:retry_type, :exponential),
-          :max_attempts => retryable_allowed?(http_method) ? data.fetch(:retry_max, MAX_REQUEST_RETRIES) : 0,
+          :max_attempts => retryable_allowed?(http_method) ?
+            data.fetch(:retry_max, MAX_REQUEST_RETRIES) : 0,
           :wait_interval => data[:retry_interval],
           :ui => data[:retry_ui],
           :auto_run => false,
@@ -174,6 +176,7 @@ module Miasma
       #   override if things need to be done prior to
       #   the actual request (like signature generation)
       def make_request(connection, http_method, request_args)
+        logger.debug("making #{http_method.to_s.upcase} request - #{request_args.inspect}")
         connection.send(http_method, *request_args)
       end
 
@@ -185,16 +188,20 @@ module Miasma
       def format_response(result, extract_body = true)
         extracted_headers = Smash[result.headers.map { |k, v| [Utils.snake(k), v] }]
         if extract_body
+          logger.debug("extracting HTTP response body")
           body_content = result.body.to_s
           body_content.encode!("UTF-8", "binary",
                                :invalid => :replace,
                                :undef => :replace,
                                :replace => "")
           if extracted_headers[:content_type].to_s.include?("json")
+            logger.debug("unpacking HTTP response body using JSON")
             extracted_body = from_json(body_content) || body_content
           elsif extracted_headers[:content_type].to_s.include?("xml")
+            logger.debug("unpacking HTTP response body using XML")
             extracted_body = from_xml(body_content) || body_content
           else
+            logger.debug("unpacking HTTP response body using best effort")
             extracted_body = from_json(body_content) ||
                              from_xml(body_content) ||
                              body_content
@@ -203,6 +210,7 @@ module Miasma
         unless extracted_body
           # @note if body is over 100KB, do not extract
           if extracted_headers[:content_length].to_i < 102400
+            logger.warn("skipping body extraction and formatting due to size")
             extracted_body = result.body.to_s
           else
             extracted_body = result.body
@@ -222,7 +230,10 @@ module Miasma
       def from_json(string)
         begin
           MultiJson.load(string).to_smash
-        rescue MultiJson::ParseError
+        rescue MultiJson::ParseError => err
+          logger.error("failed to load JSON string - #{err.class}: #{err}")
+          logger.debug("JSON string load failure: #{string.inspect}")
+          logger.debug("JSON error - #{err.class}: #{err}\n#{err.backtrace.join("\n")}")
           nil
         end
       end
@@ -234,7 +245,10 @@ module Miasma
       def from_xml(string)
         begin
           MultiXml.parse(string).to_smash
-        rescue MultiXml::ParseError
+        rescue MultiXml::ParseError => err
+          logger.error("failed to load XML string - #{err.class}: #{err}")
+          logger.debug("XML string load failure: #{string.inspect}")
+          logger.debug("XML error - #{err.class}: #{err}\n#{err.backtrace.join("\n")}")
           nil
         end
       end

data/lib/miasma/version.rb

@@ -1,4 +1,4 @@
 module Miasma
   # current library version
-  VERSION = Gem::Version.new("0.3.4")
+  VERSION = Gem::Version.new("0.3.6")
 end

data/miasma.gemspec

@@ -10,11 +10,11 @@ Gem::Specification.new do |s|
   s.description = "Smoggy API"
   s.license = "Apache 2.0"
   s.require_path = "lib"
-  s.add_runtime_dependency "http", ">= 0.8.12", "< 2.0"
+  s.add_runtime_dependency "http", ">= 0.8.12", "< 4.0"
   s.add_runtime_dependency "multi_json"
   s.add_runtime_dependency "multi_xml"
   s.add_runtime_dependency "xml-simple"
-  s.add_runtime_dependency "bogo", ">= 0.2.2", "< 1.0"
+  s.add_runtime_dependency "bogo", ">= 0.2.12", "< 1.0"
   s.add_development_dependency "pry"
   s.add_development_dependency "minitest"
   s.add_development_dependency "rspec", "~> 3.5"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: miasma
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.6
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-03 00:00:00.000000000 Z
+date: 2018-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -19,7 +19,7 @@ dependencies:
         version: 0.8.12
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 0.8.12
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -78,7 +78,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.2.12
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -88,7 +88,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.2.12
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'