Merge pull request #9 from MarketDataApp/fix-enum-values

Fix enum values

Author: KerryJones

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## v0.4.4-beta
+
+Update options->option_chain to use enum values rather than the enum itself.
+
+## v0.4.3-beta
+
+Small bug fixes found from initial beta test
+
+- Typo fixed Range::OUT_THE_MONEY > Range::OUT_OF_THE_MONEY
+- Corrected stocks->quotes() endpoint url
+- Changes OptionChain response to group strikes under expiration date
+
 ## v0.4.2-beta
 
 This library is now in **beta**. Feel free to try it out and report any bugs you find back here.

src/Endpoints/Options.php

@@ -227,7 +227,7 @@ public function option_chain(
     ): OptionChains {
         return new OptionChains($this->client->execute(self::BASE_URL . "chain/$symbol", [
             'date'               => $date,
-            'expiration'         => $expiration,
+            'expiration'         => $expiration instanceof Expiration ? $expiration->value : $expiration,
             'from'               => $from,
             'to'                 => $to,
             'month'              => $month,
@@ -238,8 +238,8 @@ public function option_chain(
             'nonstandard'        => $non_standard,
             'dte'                => $dte,
             'delta'              => $delta,
-            'side'               => $side,
-            'range'              => $range,
+            'side'               => $side instanceof Side ? $side->value : $side,
+            'range'              => $range instanceof Range ? $range->value : $range,
             'strike'             => $strike,
             'strikeLimit'        => $strike_limit,
             'minBid'             => $min_bid,

tests/Integration/OptionsTest.php

@@ -11,6 +11,7 @@
 use MarketDataApp\Endpoints\Responses\Options\Quote;
 use MarketDataApp\Endpoints\Responses\Options\Quotes;
 use MarketDataApp\Endpoints\Responses\Options\Strikes;
+use MarketDataApp\Enums\Expiration;
 use MarketDataApp\Enums\Side;
 use PHPUnit\Framework\TestCase;
 
@@ -107,6 +108,50 @@ public function testOptionChain_success()
         $option_chain = array_pop($response->option_chains);
         $this->assertNotEmpty($option_chain);
 
+        // Verify each item in the response is an object of the correct type and has the correct values.
+        $option_strike = array_pop($option_chain);
+        $this->assertInstanceOf(OptionChainStrike::class, $option_strike);
+        $this->assertEquals('string', gettype($option_strike->option_symbol));
+        $this->assertEquals('string', gettype($option_strike->underlying));
+        $this->assertInstanceOf(Carbon::class, $option_strike->expiration);
+        $this->assertInstanceOf(Side::class, $option_strike->side);
+        $this->assertEquals('double', gettype($option_strike->strike));
+        $this->assertInstanceOf(Carbon::class, $option_strike->first_traded);
+        $this->assertEquals('integer', gettype($option_strike->dte));
+        $this->assertInstanceOf(Carbon::class, $option_strike->updated);
+        $this->assertEquals('double', gettype($option_strike->bid));
+        $this->assertEquals('integer', gettype($option_strike->bid_size));
+        $this->assertEquals('double', gettype($option_strike->mid));
+        $this->assertEquals('double', gettype($option_strike->ask));
+        $this->assertEquals('integer', gettype($option_strike->ask_size));
+        $this->assertTrue(in_array(gettype($option_strike->last), ['double', 'NULL']));
+        $this->assertEquals('integer', gettype($option_strike->open_interest));
+        $this->assertEquals('integer', gettype($option_strike->volume));
+        $this->assertEquals('boolean', gettype($option_strike->in_the_money));
+        $this->assertEquals('double', gettype($option_strike->intrinsic_value));
+        $this->assertEquals('double', gettype($option_strike->extrinsic_value));
+        $this->assertEquals('double', gettype($option_strike->implied_volatility));
+        $this->assertTrue(in_array(gettype($option_strike->delta), ['double', 'NULL']));
+        $this->assertEquals('double', gettype($option_strike->gamma));
+        $this->assertEquals('double', gettype($option_strike->theta));
+        $this->assertEquals('double', gettype($option_strike->vega));
+        $this->assertEquals('double', gettype($option_strike->rho));
+        $this->assertEquals('double', gettype($option_strike->underlying_price));
+    }
+    public function testOptionChain_expirationEnum_success()
+    {
+        $response = $this->client->options->option_chain(
+            symbol: 'AAPL',
+            expiration: Expiration::ALL,
+            side: Side::CALL,
+        );
+
+        // Verify that the response is an object of the correct type.
+        $this->assertInstanceOf(OptionChains::class, $response);
+        $this->assertNotEmpty($response->option_chains);
+        $option_chain = array_pop($response->option_chains);
+        $this->assertNotEmpty($option_chain);
+
         // Verify each item in the response is an object of the correct type and has the correct values.
         $option_strike = array_pop($option_chain);
         $this->assertInstanceOf(OptionChainStrike::class, $option_strike);