arbor_peakflow_ruby 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5eba0729f4909869481ad52f89856838ba5f79d0
-  data.tar.gz: 10ec036972ae0b704f1cbe35175f22a34b1887e5
+  metadata.gz: 9d0cb86cdce4c6b9e050f079a60dea7fdc9c4fd8
+  data.tar.gz: d84fdcef51b993c25ceec09187ff1971b75fd065
 SHA512:
-  metadata.gz: 6589c77962c097f16e7d8a7cadcf64ad8ec2745a663ad992643e67235adf227d748962fa400f63bc86c7b5fa8d70c4a004b5cae36a64297c05aa19e035719bd2
-  data.tar.gz: fbafcba959b0461f9957a10bffc9addd51812c5c0609c0275bda572659ddea1f147a289170009de20556dd6b5ad53ddc58e2d44295615523a4a2b5c9af1da3e5
+  metadata.gz: 71d23cb845cb175d2c4b267116cfe20fd6617f498f4402f69a36ba36f0f350cda104529608f5470545e2bf7dbdf9d64137b765d162abd5d7c9fcd8faf0ec63cd
+  data.tar.gz: ef3a37836b57a5770c8f7454559b3747de6b122fb4f0253cf2a90438ecbca666087f7e42e7b3e6840863adceb7bf6869010ee7e9871a6b402956ced139478874

data/lib/arbor_peakflow_ruby/actions/alerts.rb

@@ -5,13 +5,9 @@ module Arbor
       # alert information.
       #
       # == Parameters:
-      # - filter: (Optional) Keywords by which you want to filter search
-      # results. You can enter the same search strings that you can enter in
-      # the Search box on the Alerts pages in the Web UI.
-      # - limit: (Optional) The maximum number of alerts to return that match
-      # the filter.
-      # - format: The format in which you want the data returned:
-      # 'json' or 'xml'
+      # - +filter+: (Optional) Keywords by which you want to filter search results. You can enter the same search strings that you can enter in the Search box on the Alerts pages in the Web UI.
+      # - +limit+: (Optional) The maximum number of alerts to return that match the filter.
+      # - +format+: The format in which you want the data returned: `json` or `xml`
       #
       # ==== Example
       #

data/lib/arbor_peakflow_ruby/actions/cp5500.rb

@@ -1,17 +1,11 @@
 module Arbor
   module Peakflow
     module CP5500
-      # The CP 5500 function allows you to view CP 5500 appliance configurations
-      # in JSON format. *Note:* This function is only available with
-      # appliance-based licensing for Traffic and Analysis Routing appliances
-      # (formally Collector Platform (CP) appliances).
+      # The CP 5500 function allows you to view CP 5500 appliance configurations in JSON format. *Note:* This function is only available with appliance-based licensing for Traffic and Analysis Routing appliances (formally Collector Platform (CP) appliances).
       #
       # == Parameters:
-      # - action: One of the following actions that you want to initiate:
-      # list, show_schema, update.
-      # - filter: (Optional) Keywords by which you want to filter search
-      # results. You can enter the same search strings that you can enter in
-      # the Search box on the Configure Routers page in the Web UI.
+      # - +action+: One of the following actions that you want to initiate: `list`, `show_schema`, `update`.
+      # - +filter+: (Optional) Keywords by which you want to filter search results. You can enter the same search strings that you can enter in the Search box on the Configure Routers page in the Web UI.
       #
       # ==== Example
       #

data/lib/arbor_peakflow_ruby/actions/managed_object.rb

@@ -1,13 +1,10 @@
 module Arbor
   module Peakflow
     module Managed_Object
-      # The managed object function allows you to view managed object
-      # configuration data in JSON format.
+      # The managed object function allows you to view managed object configuration data in JSON format.
       #
       # == Parameters:
-      # - filter: (Optional) Keywords by which you want to filter search
-      # results. You can enter the same search strings that you can enter in
-      # the Search box on the Managed Objects pages in the Web UI.
+      # - +filter+: (Optional) Keywords by which you want to filter search results. You can enter the same search strings that you can enter in the Search box on the Managed Objects pages in the Web UI.
       #
       # ==== Example
       #

data/lib/arbor_peakflow_ruby/actions/mitigations.rb

@@ -1,17 +1,12 @@
 module Arbor
   module Peakflow
     module Mitigations
-      # The mitigations function allows you to search for and retrieve JSON and
-      # XML mitigation information.
+      # The mitigations function allows you to search for and retrieve JSON and XML mitigation information.
       #
       # == Parameters:
-      # - filter: (Optional) Keywords by which you want to filter search
-      # results. You can enter the same search strings that you can enter in
-      # the Search box on the Mitigations pages in the Web UI.
-      # - limit: (Optional) The maximum number of mitigations to return that
-      # match the filter.
-      # - format: The format in which you want the data returned:
-      # 'json' or 'xml'
+      # - +filter+: (Optional) Keywords by which you want to filter search results. You can enter the same search strings that you can enter in the Search box on the Mitigations pages in the Web UI.
+      # - +limit+: (Optional) The maximum number of mitigations to return that match the filter.
+      # - +format+: The format in which you want the data returned: `json` or `xml`
       #
       # ==== Example
       #

data/lib/arbor_peakflow_ruby/actions/traffic.rb

@@ -25,33 +25,29 @@ module Arbor
         response = @conn.get do |req|
           req.url 'arborws/traffic'
           req.params['api_key'] = @api_key
-          req.params['query'] = encode_xml_for_url(query)
-          req.params['graph'] = encode_xml_for_url(graph) unless graph.nil?
+          req.params['query'] = remove_returns_and_spaces(query)
+          req.params['graph'] = remove_returns_and_spaces(graph) unless graph.nil?
         end
 
         response
       end
 
-      # The encode_xml_for_url function allows you to encode an XML file's
-      # content. This is used automatically when calling the traffic method.
+      # The remove_returns_and_spaces function allows you to remove newlines and spaces that are not within tags in XML.
       #
       # == Parameters:
-      # - file_contents: The XML content which should be encoded into a URL
-      # usable format.
+      # - file_contents: The XML content which should be cleaned in preparation for URL encoding.
       #
       # ==== Example
       #
       #    file = File.read('path/to/file.xml')
-      #    encoded_file_contents = client.encode_xml_for_url file
-      def encode_xml_for_url(file_contents)
-        encoded_file =
-          URI.encode(
+      #    clean_file = client.remove_returns_and_spaces file
+      def remove_returns_and_spaces(file_contents)
+        clean_file =
             file_contents
-              .gsub!(/\n+/, '')
-              .gsub!(/(\s+)(?![^<])/, '')
-          ).gsub!(/\?/, '%3F')
+            .gsub!(/\n+/, '')
+            .gsub!(/(\s+)(?![^<])/, '')
 
-        encoded_file
+        clean_file
       end
     end
   end

data/lib/arbor_peakflow_ruby/version.rb

@@ -1,5 +1,5 @@
 module Arbor
   module Peakflow
-    VERSION = '1.0.3'
+    VERSION = '1.0.4'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arbor_peakflow_ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Kevin Kirsche