Merge pull request #54 from MindscapeHQ/unify-message-casing

Unify message casing
MindscapeHQ · Oct 30, 2014 · bd3d46c · bd3d46c
2 parents ae37a7b + 7cee7c8
commit bd3d46c
Show file tree

Hide file tree

Showing 6 changed files with 63 additions and 62 deletions.
diff --git a/README.md b/README.md
@@ -203,6 +203,7 @@ If, when running a PHP script from the command line on *nix operating systems, y
 
 ## Changelog
 
+- 1.5.3: Unify property casing (internal change)
 - 1.5.2: Prevent error when query_string isn't present in $_SERVER
 - 1.5.1: Guard against intermittent user id cookie being null; overload for disabling user tracking
 - 1.5.0: Add enhanced user data support; fix null backtrace frames that could occur in 1.4

diff --git a/src/Raygun4php/RaygunClient.php b/src/Raygun4php/RaygunClient.php
@@ -392,25 +392,25 @@ function filterParamsFromMessage($message, $replace = '[filtered]') {
         }
       };
 
-      if($message->Details->Request->form) {
-        array_walk_recursive($message->Details->Request->form, $walkFn);
+      if($message->Details->Request->Form) {
+        array_walk_recursive($message->Details->Request->Form, $walkFn);
       }
 
-      if($message->Details->Request->headers) {
-        array_walk_recursive($message->Details->Request->headers, $walkFn);
+      if($message->Details->Request->Headers) {
+        array_walk_recursive($message->Details->Request->Headers, $walkFn);
       }
 
-      if($message->Details->Request->data) {
-        array_walk_recursive($message->Details->Request->data, $walkFn);
+      if($message->Details->Request->Data) {
+        array_walk_recursive($message->Details->Request->Data, $walkFn);
       }
 
       if($message->Details->UserCustomData) {
         array_walk_recursive($message->Details->UserCustomData, $walkFn);
       }
 
       // Unset raw HTTP data since we can't accurately filter it
-      if($message->Details->Request->rawData) {
-        $message->Details->Request->rawData = null;
+      if($message->Details->Request->RawData) {
+        $message->Details->Request->RawData = null;
       }
 
       return $message;

diff --git a/src/Raygun4php/RaygunClientMessage.php b/src/Raygun4php/RaygunClientMessage.php
@@ -3,15 +3,15 @@
 {
     class RaygunClientMessage
     {
-        public $name;
-        public $version;
-        public $clientUrl;
+        public $Name;
+        public $Version;
+        public $ClientUrl;
 
         public function __construct()
         {
-            $this->name = "Raygun4php";
-            $this->version = "1.5.2";
-            $this->clientUrl = "https://github.com/MindscapeHQ/raygun4php";
+            $this->Name = "Raygun4php";
+            $this->Version = "1.5.3";
+            $this->ClientUrl = "https://github.com/MindscapeHQ/raygun4php";
         }
     }
 }
diff --git a/src/Raygun4php/RaygunEnvironmentMessage.php b/src/Raygun4php/RaygunEnvironmentMessage.php
@@ -3,17 +3,17 @@
 {
     class RaygunEnvironmentMessage
     {
-        public $utcOffset = 0;
+        public $UtcOffset = 0;
 
         public function __construct()
         {
             if (ini_get('date.timezone'))
             {
-                $this->utcOffset = @date('Z') / 3600;
+                $this->UtcOffset = @date('Z') / 3600;
             }
 
-            $this->utcOffset = max($this->utcOffset, -24);
-            $this->utcOffset = min($this->utcOffset, 24);
+            $this->UtcOffset = max($this->UtcOffset, -24);
+            $this->UtcOffset = min($this->UtcOffset, 24);
         }
     }
 }
diff --git a/src/Raygun4php/RaygunRequestMessage.php b/src/Raygun4php/RaygunRequestMessage.php
@@ -3,36 +3,36 @@
 {
     class RaygunRequestMessage
     {
-        public $hostName;
-        public $url;
-        public $httpMethod;
-        public $ipAddress;
-        public $queryString;
-        public $headers;
-        public $data;
-        public $form;
-        public $rawData;
+        public $HostName;
+        public $Url;
+        public $HttpMethod;
+        public $IpAddress;
+        public $QueryString;
+        public $Headers;
+        public $Data;
+        public $Form;
+        public $RawData;
 
         public function __construct()
         {
             if (php_sapi_name() !== 'cli') {
-                $this->hostName = $_SERVER['HTTP_HOST'];
-                $this->httpMethod = $_SERVER['REQUEST_METHOD'];
-                $this->url = $_SERVER['REQUEST_URI'];
-                $this->ipAddress = $_SERVER['REMOTE_ADDR'];
+                $this->HostName = $_SERVER['HTTP_HOST'];
+                $this->HttpMethod = $_SERVER['REQUEST_METHOD'];
+                $this->Url = $_SERVER['REQUEST_URI'];
+                $this->IpAddress = $_SERVER['REMOTE_ADDR'];
 
                 if (array_key_exists('QUERY_STRING', $_SERVER))
                 {
-                  parse_str($_SERVER['QUERY_STRING'], $this->queryString);
+                  parse_str($_SERVER['QUERY_STRING'], $this->QueryString);
 
-                  if (empty($this->queryString))
+                  if (empty($this->QueryString))
                   {
-                      $this->queryString = null;
+                      $this->QueryString = null;
                   }
                 }
             }
 
-            $this->headers = $this->emu_getAllHeaders();
+            $this->Headers = $this->emu_getAllHeaders();
 
             $utf8_convert = function($value) use (&$utf8_convert) {
                 return is_array($value) ?
@@ -46,9 +46,9 @@ public function __construct()
                 iconv('UTF-8', 'UTF-8', utf8_encode($value));
             };
 
-            $this->form = array_map($utf8_convert, $_POST);
+            $this->Form = array_map($utf8_convert, $_POST);
 
-            $this->data = array_map($utf8_convert_server, $_SERVER);
+            $this->Data = array_map($utf8_convert_server, $_SERVER);
 
             if (php_sapi_name() !== 'cli')
             {
@@ -75,7 +75,7 @@ public function __construct()
                     $raw = substr($raw, 0, 4095);
                   }
 
-                  $this->rawData = iconv('UTF-8', 'UTF-8//IGNORE', $raw);
+                  $this->RawData = iconv('UTF-8', 'UTF-8//IGNORE', $raw);
                 }
             }
         }

diff --git a/tests/RaygunClientTest.php b/tests/RaygunClientTest.php
@@ -19,27 +19,27 @@ public function testGetFilteredParamsRemovesByKey() {
         'MyParam' => true
     ));
     $message = $this->getEmptyMessage();
-    $message->Details->Request->form = array(
+    $message->Details->Request->Form = array(
         'MyParam' => 'secret',
     );
-    $message->Details->Request->headers = array(
+    $message->Details->Request->Headers = array(
         'MyParam' => 'secret',
     );
-    $message->Details->Request->data = array(
+    $message->Details->Request->Data = array(
         'MyParam' => 'secret',
     );
 
     $filteredMessage = $client->filterParamsFromMessage($message);
     $this->assertEquals(
-        $filteredMessage->Details->Request->form, 
+        $filteredMessage->Details->Request->Form,
         array('MyParam' => '[filtered]',)
     );
     $this->assertEquals(
-        $filteredMessage->Details->Request->headers, 
+        $filteredMessage->Details->Request->Headers,
         array('MyParam' => '[filtered]',)
     );
     $this->assertEquals(
-        $filteredMessage->Details->Request->data, 
+        $filteredMessage->Details->Request->Data,
         array('MyParam' => '[filtered]',)
     );
   }
@@ -48,11 +48,11 @@ public function testGetFilteredParamsIgnoresCase() {
     $client = new \Raygun4php\RaygunClient("some-api-key", true);
     $client->setFilterParams(array('myparam' => true));
     $message = $this->getEmptyMessage();
-    $message->Details->Request->form = array('MyParam' => 'secret',);
+    $message->Details->Request->Form = array('MyParam' => 'secret',);
 
     $filteredMessage = $client->filterParamsFromMessage($message);
     $this->assertEquals(
-        $filteredMessage->Details->Request->form, 
+        $filteredMessage->Details->Request->Form,
         array('MyParam' => '[filtered]',)
     );
   }
@@ -63,13 +63,13 @@ public function testGetFilteredParamsAcceptsCustomFunctions() {
         'MyParam' => function($key, $val) {return strrev($val);},
     ));
     $message = $this->getEmptyMessage();
-    $message->Details->Request->form = array(
+    $message->Details->Request->Form = array(
         'MyParam' => 'secret',
     );
 
     $filteredMessage = $client->filterParamsFromMessage($message);
     $this->assertEquals(
-        $filteredMessage->Details->Request->form, 
+        $filteredMessage->Details->Request->Form,
         array(
             'MyParam' => 'terces',
         )
@@ -79,28 +79,28 @@ public function testGetFilteredParamsAcceptsCustomFunctions() {
   public function testGetFilteredParamsRemovesRawData() {
     $client = new \Raygun4php\RaygunClient("some-api-key", true);
     $message = $this->getEmptyMessage();
-    $message->Details->Request->rawData = 'some-data';
+    $message->Details->Request->RawData = 'some-data';
 
     $filteredMessage = $client->filterParamsFromMessage($message);
-    $this->assertEquals($filteredMessage->Details->Request->rawData, 'some-data');
+    $this->assertEquals($filteredMessage->Details->Request->RawData, 'some-data');
 
     $client->setFilterParams(array('MySensitiveParam' => true));
     $filteredMessage = $client->filterParamsFromMessage($message);
-    $this->assertNull($filteredMessage->Details->Request->rawData);
+    $this->assertNull($filteredMessage->Details->Request->RawData);
   }
 
   public function testGetFilteredParamsParsesRegex() {
     $client = new \Raygun4php\RaygunClient("some-api-key", true);
     $client->setFilterParams(array('/MyRegex.*/' => true,));
     $message = $this->getEmptyMessage();
-    $message->Details->Request->form = array(
+    $message->Details->Request->Form = array(
         'MyParam' => 'some val',
         'MyRegexParam' => 'secret',
     );
 
     $filteredMessage = $client->filterParamsFromMessage($message);
     $this->assertEquals(
-        $filteredMessage->Details->Request->form, 
+        $filteredMessage->Details->Request->Form,
         array(
             'MyParam' => 'some val',
             'MyRegexParam' => '[filtered]',
@@ -110,15 +110,15 @@ public function testGetFilteredParamsParsesRegex() {
 
   protected function getEmptyMessage() {
     $requestMessage = new Raygun4php\RaygunRequestMessage();
-    $requestMessage->hostName = null;
-    $requestMessage->url = null;
-    $requestMessage->httpMethod = null;
-    $requestMessage->ipAddress = null;
-    $requestMessage->queryString = null;
-    $requestMessage->headers = null;
-    $requestMessage->data = null;
-    $requestMessage->rawData = null;
-    $requestMessage->form = null;
+    $requestMessage->HostName = null;
+    $requestMessage->Url = null;
+    $requestMessage->HttpMethod = null;
+    $requestMessage->IpAddress = null;
+    $requestMessage->QueryString = null;
+    $requestMessage->Headers = null;
+    $requestMessage->Data = null;
+    $requestMessage->RawData = null;
+    $requestMessage->Form = null;
     $message = new Raygun4php\RaygunMessage(0);
     $message->Details->Request = $requestMessage;