Merge pull request #4 from onoi/tidy

Tidy some method names
onoi · Sep 21, 2016 · b8eebcb · b8eebcb
2 parents 2902cd8 + d775877
commit b8eebcb
Show file tree

Hide file tree

Showing 20 changed files with 94 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -49,7 +49,7 @@ $crossRefFilteredHttpResponseParser = $filteredHttpResponseParserFactory->newCro
 	new FilteredRecord()
 )
 
-$crossRefFilteredHttpResponseParser->doFilterResponseFor( '10.1126/science.1152662' );
+$crossRefFilteredHttpResponseParser->doFilterResponseById( '10.1126/science.1152662' );
 
 $filteredRecord = new FilteredRecord();
 $filteredRecord->setRedactedFields( array( 'pages', 'abstract' ) );
@@ -58,12 +58,12 @@ $pubMedFilteredHttpResponseParser = $filteredHttpResponseParserFactory->newNcbiP
 	$filteredRecord
 )
 
-$pubMedFilteredHttpResponseParser->doFilterResponseFor( '19782018' );
+$pubMedFilteredHttpResponseParser->doFilterResponseById( '19782018' );
 ```
 The `FilteredHttpResponseParser` (implementing the `ResponseParser` interface) returns a
 simple `array` filtered from a REST response.
 
-`FilteredHttpResponseParser::doFilterResponseFor` is not expected to make any input validation (in terms of
+`FilteredHttpResponseParser::doFilterResponseById` is not expected to make any input validation (in terms of
 format or range) for the requested response therefore the implementing class is responsible for an appropriate
 validation process.
 

diff --git a/src/CrossRef/CrossRefFilteredHttpResponseParser.php b/src/CrossRef/CrossRefFilteredHttpResponseParser.php
@@ -23,7 +23,7 @@ class CrossRefFilteredHttpResponseParser extends FilteredHttpResponseParser {
 	 *
 	 * {@inheritDoc}
 	 */
-	public function getRawResponse( $doi ) {
+	public function getRawResponseById( $doi ) {
 		return $this->requestResponseFor( $doi );
 	}
 
@@ -32,7 +32,7 @@ public function getRawResponse( $doi ) {
 	 *
 	 * {@inheritDoc}
 	 */
-	public function doFilterResponseFor( $doi ) {
+	public function doFilterResponseById( $doi ) {
 
 		$json = json_decode(
 			$this->requestResponseFor( $doi ),

diff --git a/src/FilteredHttpResponseParser.php b/src/FilteredHttpResponseParser.php
@@ -71,6 +71,15 @@ public function getFilteredRecord() {
 	 * {@inheritDoc}
 	 */
 	public function usesCache() {
+		return $this->isFromCache();
+	}
+
+	/**
+	 * @since 0.1
+	 *
+	 * {@inheritDoc}
+	 */
+	public function isFromCache() {
 		return method_exists( $this->httpRequest, 'isCached' ) ? $this->httpRequest->isCached() : false;
 	}
 
@@ -79,13 +88,31 @@ public function usesCache() {
 	 *
 	 * {@inheritDoc}
 	 */
-	abstract public function doFilterResponseFor( $query );
+	public function doFilterResponseFor( $id ) {
+		return $this->doFilterResponseById( $id );
+	}
 
 	/**
 	 * @since 0.1
 	 *
 	 * {@inheritDoc}
 	 */
-	abstract public function getRawResponse( $query );
+	public function getRawResponse( $id ) {
+		return $this->getRawResponseById( $id );
+	}
+
+	/**
+	 * @since 0.3
+	 *
+	 * {@inheritDoc}
+	 */
+	abstract public function doFilterResponseById( $id );
+
+	/**
+	 * @since 0.3
+	 *
+	 * {@inheritDoc}
+	 */
+	abstract public function getRawResponseById( $id );
 
 }
diff --git a/src/Ncbi/NcbiPubMedFilteredHttpResponseParser.php b/src/Ncbi/NcbiPubMedFilteredHttpResponseParser.php
@@ -26,7 +26,7 @@ class NcbiPubMedFilteredHttpResponseParser extends FilteredHttpResponseParser {
 	 *
 	 * {@inheritDoc}
 	 */
-	public function getRawResponse( $id ) {
+	public function getRawResponseById( $id ) {
 
 		$db = $this->filteredRecord->get( 'ncbi-dbtype' );
 
@@ -38,7 +38,7 @@ public function getRawResponse( $id ) {
 	 *
 	 * {@inheritDoc}
 	 */
-	public function doFilterResponseFor( $id ) {
+	public function doFilterResponseById( $id ) {
 
 		$db = $this->filteredRecord->get( 'ncbi-dbtype' );
 

diff --git a/src/NullResponseParser.php b/src/NullResponseParser.php
@@ -51,13 +51,38 @@ public function usesCache() {
 		return false;
 	}
 
+	/**
+	 * @since 0.3
+	 *
+	 * {@inheritDoc}
+	 */
+	public function isFromCache() {
+		return false;
+	}
+
+	/**
+	 * @since 0.3
+	 *
+	 * {@inheritDoc}
+	 */
+	public function doFilterResponseById( $query ) {}
+
 	/**
 	 * @since 0.1
 	 *
 	 * {@inheritDoc}
 	 */
 	public function doFilterResponseFor( $query ) {}
 
+	/**
+	 * @since 0.3
+	 *
+	 * {@inheritDoc}
+	 */
+	public function getRawResponseById( $query ) {
+		return '';
+	}
+
 	/**
 	 * @since 0.1
 	 *

diff --git a/src/Oclc/OclcFilteredHttpResponseParser.php b/src/Oclc/OclcFilteredHttpResponseParser.php
@@ -23,7 +23,7 @@ class OclcFilteredHttpResponseParser extends FilteredHttpResponseParser {
 	 *
 	 * {@inheritDoc}
 	 */
-	public function getRawResponse( $oclcID ) {
+	public function getRawResponseById( $oclcID ) {
 		return $this->requestResponseFor( $oclcID );
 	}
 
@@ -32,7 +32,7 @@ public function getRawResponse( $oclcID ) {
 	 *
 	 * {@inheritDoc}
 	 */
-	public function doFilterResponseFor( $oclcID ) {
+	public function doFilterResponseById( $oclcID ) {
 
 		$text = $this->requestResponseFor( $oclcID );
 

diff --git a/src/OpenLibrary/OLFilteredHttpResponseParser.php b/src/OpenLibrary/OLFilteredHttpResponseParser.php
@@ -23,7 +23,7 @@ class OLFilteredHttpResponseParser extends FilteredHttpResponseParser {
 	 *
 	 * {@inheritDoc}
 	 */
-	public function getRawResponse( $olID ) {
+	public function getRawResponseById( $olID ) {
 		return $this->requestResponseFor( $olID );
 	}
 
@@ -32,7 +32,7 @@ public function getRawResponse( $olID ) {
 	 *
 	 * {@inheritDoc}
 	 */
-	public function doFilterResponseFor( $olID ) {
+	public function doFilterResponseById( $olID ) {
 
 		$text = $this->requestResponseFor( $olID );
 

diff --git a/src/ResponseParser.php b/src/ResponseParser.php
@@ -29,13 +29,15 @@ public function getMessages();
 	 *
 	 * @return boolean
 	 */
+	//public function isFromCache();
 	public function usesCache();
 
 	/**
 	 * @since 0.1
 	 *
 	 * @param string $id
 	 */
+	//public function doFilterResponseById( $id );
 	public function doFilterResponseFor( $id );
 
 	/**
@@ -45,6 +47,7 @@ public function doFilterResponseFor( $id );
 	 *
 	 * @return string
 	 */
+	//public function getRawResponseById( $id );
 	public function getRawResponse( $id );
 
 }
diff --git a/src/Viaf/ViafFilteredHttpResponseParser.php b/src/Viaf/ViafFilteredHttpResponseParser.php
@@ -24,7 +24,7 @@ class ViafFilteredHttpResponseParser extends FilteredHttpResponseParser {
 	 *
 	 * {@inheritDoc}
 	 */
-	public function getRawResponse( $viafID ) {
+	public function getRawResponseById( $viafID ) {
 		return $this->requestResponseFor( $viafID );
 	}
 
@@ -33,7 +33,7 @@ public function getRawResponse( $viafID ) {
 	 *
 	 * {@inheritDoc}
 	 */
-	public function doFilterResponseFor( $viafID ) {
+	public function doFilterResponseById( $viafID ) {
 
 		$xml = $this->requestResponseFor( $viafID );
 

diff --git a/tests/phpunit/Integration/CrossRef/CrossRefCannedResponseParserTest.php b/tests/phpunit/Integration/CrossRef/CrossRefCannedResponseParserTest.php
@@ -44,10 +44,10 @@ public function testParser( $id, $httpRequestFile, $expectedResultFile ) {
 
 		$this->assertEquals(
 			$contents,
-			$instance->getRawResponse( $id )
+			$instance->getRawResponseById( $id )
 		);
 
-		$instance->doFilterResponseFor( $id );
+		$instance->doFilterResponseById( $id );
 
 		$this->assertJsonStringEqualsJsonFile(
 			$expectedResultFile,

diff --git a/tests/phpunit/Integration/Ncbi/PubMedCannedResponseParserTest.php b/tests/phpunit/Integration/Ncbi/PubMedCannedResponseParserTest.php
@@ -37,10 +37,10 @@ public function testPMIDParser( $id, $httpJsonRequestFile, $httpXmlRequestFile,
 
 		$this->assertEquals(
 			$jsonContents . $xmlContents,
-			$instance->getRawResponse( $id )
+			$instance->getRawResponseById( $id )
 		);
 
-		$instance->doFilterResponseFor( $id );
+		$instance->doFilterResponseById( $id );
 
 		$this->assertJsonStringEqualsJsonFile(
 			$expectedResultFile,
@@ -70,10 +70,10 @@ public function testPMCIDParser( $id, $httpJsonRequestFile, $httpXmlRequestFile,
 
 		$this->assertEquals(
 			$jsonContents . $xmlContents,
-			$instance->getRawResponse( $id )
+			$instance->getRawResponseById( $id )
 		);
 
-		$instance->doFilterResponseFor( $id );
+		$instance->doFilterResponseById( $id );
 
 		$this->assertJsonStringEqualsJsonFile(
 			$expectedResultFile,

diff --git a/tests/phpunit/Integration/Oclc/OclcCannedResponseParserTest.php b/tests/phpunit/Integration/Oclc/OclcCannedResponseParserTest.php
@@ -44,10 +44,10 @@ public function testParser( $id, $httpRequestFile, $expectedResultFile ) {
 
 		$this->assertEquals(
 			$contents,
-			$instance->getRawResponse( $id )
+			$instance->getRawResponseById( $id )
 		);
 
-		$instance->doFilterResponseFor( $id );
+		$instance->doFilterResponseById( $id );
 
 		$this->assertJsonStringEqualsJsonFile(
 			$expectedResultFile,

diff --git a/tests/phpunit/Integration/OpenLibrary/OLCannedResponseParserTest.php b/tests/phpunit/Integration/OpenLibrary/OLCannedResponseParserTest.php
@@ -44,10 +44,10 @@ public function testParser( $id, $httpRequestFile, $expectedResultFile ) {
 
 		$this->assertEquals(
 			$contents,
-			$instance->getRawResponse( $id )
+			$instance->getRawResponseById( $id )
 		);
 
-		$instance->doFilterResponseFor( $id );
+		$instance->doFilterResponseById( $id );
 
 		$this->assertJsonStringEqualsJsonFile(
 			$expectedResultFile,

diff --git a/tests/phpunit/Integration/Viaf/ViafCannedResponseParserTest.php b/tests/phpunit/Integration/Viaf/ViafCannedResponseParserTest.php
@@ -44,10 +44,10 @@ public function testParser( $id, $httpRequestFile, $expectedResultFile ) {
 
 		$this->assertEquals(
 			$contents,
-			$instance->getRawResponse( $id )
+			$instance->getRawResponseById( $id )
 		);
 
-		$instance->doFilterResponseFor( $id );
+		$instance->doFilterResponseById( $id );
 
 		$this->assertJsonStringEqualsJsonFile(
 			$expectedResultFile,

diff --git a/tests/phpunit/Unit/CrossRef/CrossRefFilteredHttpResponseParserTest.php b/tests/phpunit/Unit/CrossRef/CrossRefFilteredHttpResponseParserTest.php
@@ -50,7 +50,7 @@ public function testFailedResponse() {
 			$filteredRecord
 		);
 
-		$instance->doFilterResponseFor( 'foo' );
+		$instance->doFilterResponseById( 'foo' );
 
 		$this->assertEquals(
 			array( array(
@@ -81,7 +81,7 @@ public function testNullResponse() {
 			$filteredRecord
 		);
 
-		$instance->doFilterResponseFor( 'foo' );
+		$instance->doFilterResponseById( 'foo' );
 
 		$this->assertEquals(
 			array( array(

diff --git a/tests/phpunit/Unit/Ncbi/NcbiPubMedFilteredHttpResponseParserTest.php b/tests/phpunit/Unit/Ncbi/NcbiPubMedFilteredHttpResponseParserTest.php
@@ -50,7 +50,7 @@ public function testFailedResponse() {
 			$filteredRecord
 		);
 
-		$instance->doFilterResponseFor( 'foo' );
+		$instance->doFilterResponseById( 'foo' );
 
 		$this->assertEquals(
 			array( array(
@@ -81,7 +81,7 @@ public function testNullResponse() {
 			$filteredRecord
 		);
 
-		$instance->doFilterResponseFor( 'foo' );
+		$instance->doFilterResponseById( 'foo' );
 
 		$this->assertEquals(
 			array( array(

diff --git a/tests/phpunit/Unit/NullResponseParserTest.php b/tests/phpunit/Unit/NullResponseParserTest.php
@@ -49,11 +49,11 @@ public function testCommonMethods() {
 		);
 
 		$this->assertNull(
-			$instance->doFilterResponseFor( 42 )
+			$instance->doFilterResponseById( 42 )
 		);
 
 		$this->assertEmpty(
-			$instance->getRawResponse( 42 )
+			$instance->getRawResponseById( 42 )
 		);
 	}
 

diff --git a/tests/phpunit/Unit/Oclc/OclcFilteredHttpResponseParserTest.php b/tests/phpunit/Unit/Oclc/OclcFilteredHttpResponseParserTest.php
@@ -50,7 +50,7 @@ public function testFailedResponse() {
 			$filteredRecord
 		);
 
-		$instance->doFilterResponseFor( 'foo' );
+		$instance->doFilterResponseById( 'foo' );
 
 		$this->assertEquals(
 			array( array(
@@ -81,7 +81,7 @@ public function testNullResponse() {
 			$filteredRecord
 		);
 
-		$instance->doFilterResponseFor( 'foo' );
+		$instance->doFilterResponseById( 'foo' );
 
 		$this->assertEquals(
 			array( array(

diff --git a/tests/phpunit/Unit/OpenLibrary/OLFilteredHttpResponseParserTest.php b/tests/phpunit/Unit/OpenLibrary/OLFilteredHttpResponseParserTest.php
@@ -50,7 +50,7 @@ public function testFailedResponse() {
 			$filteredRecord
 		);
 
-		$instance->doFilterResponseFor( 'foo' );
+		$instance->doFilterResponseById( 'foo' );
 
 		$this->assertEquals(
 			array( array(
@@ -81,7 +81,7 @@ public function testNullResponse() {
 			$filteredRecord
 		);
 
-		$instance->doFilterResponseFor( 'foo' );
+		$instance->doFilterResponseById( 'foo' );
 
 		$this->assertEquals(
 			array( array(