Versioning to 2.2.0

also make older version numbers semantic

Author: justinstern

woocommerce/api/class-sv-wc-api-base.php

@@ -32,7 +32,7 @@
  * This class provides a standardized framework for constructing an API wrapper
  * to external services. It is designed to be extremely flexible.
  *
- * @version 2.1-1
+ * @version 2.2.0
  */
 abstract class SV_WC_API_Base {
 
@@ -80,7 +80,7 @@ abstract class SV_WC_API_Base {
 	/**
 	 * Perform the request and return the parsed response
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @param object $request class instance which implements \SV_WC_API_Request
 	 * @throws Exception
 	 * @throws \SV_WC_API_Exception
@@ -121,7 +121,7 @@ protected function perform_request( $request ) {
 	 * and provide their own transport mechanism if needed, e.g. a custom
 	 * cURL implementation
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @param string $request_uri
 	 * @param string $request_args
 	 * @return array|WP_Error
@@ -134,7 +134,7 @@ protected function do_remote_request( $request_uri, $request_args ) {
 	/**
 	 * Handle and parse the response
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @param array|WP_Error $response response data
 	 * @throws \SV_WC_API_Exception network issues, timeouts, API errors, etc
 	 * @return object request class instance that implements SV_WC_API_Request
@@ -185,7 +185,7 @@ protected function handle_response( $response ) {
 	 * an exception, as it will be included in the broadcast_request() method
 	 * which is typically used to log requests.
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 */
 	protected function do_pre_parse_response_validation() {
 		// stub method
@@ -203,7 +203,7 @@ protected function do_pre_parse_response_validation() {
 	 *
 	 * Note: Response body sanitization is handled automatically
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 */
 	protected function do_post_parse_response_validation() {
 		// stub method
@@ -213,7 +213,7 @@ protected function do_post_parse_response_validation() {
 	/**
 	 * Return the parsed response object for the request
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @param string $raw_response_body
 	 * @return object response class instance which implements SV_WC_API_Request
 	 */
@@ -229,7 +229,7 @@ protected function get_parsed_response( $raw_response_body ) {
 	 * Alert other actors that a request has been performed. This is primarily used
 	 * for request logging.
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 */
 	private function broadcast_request() {
 
@@ -259,7 +259,7 @@ private function broadcast_request() {
 	/**
 	 * Get the request URI
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @return string
 	 */
 	protected function get_request_uri() {
@@ -270,7 +270,7 @@ protected function get_request_uri() {
 	/**
 	 * Get the request arguments in the format required by wp_remote_request()
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @return mixed|void
 	 */
 	protected function get_request_args() {
@@ -297,7 +297,7 @@ protected function get_request_args() {
 		 *
 		 * @param array $args request arguments
 		 * @param \SV_WC_API_Base class instance
-		 * @since 2.1-1
+		 * @since 2.2.0
 		 */
 		return apply_filters( 'wc_' . $this->get_api_id() . '_http_request_args', $args, $this );
 	}
@@ -306,7 +306,7 @@ protected function get_request_args() {
 	/**
 	 * Get the request method, POST by default
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @return string
 	 */
 	protected function get_request_method() {
@@ -317,7 +317,7 @@ protected function get_request_method() {
 	/**
 	 * Get the request HTTP version, 1.1 by default
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @return string
 	 */
 	protected function get_request_http_version() {
@@ -329,7 +329,7 @@ protected function get_request_http_version() {
 	/**
 	 * Get the request headers
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @return array
 	 */
 	protected function get_request_headers() {
@@ -346,7 +346,7 @@ protected function get_request_headers() {
 	 * Child classes that implement any custom authorization headers should
 	 * override this method to perform sanitization.
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @return array
 	 */
 	protected function get_sanitized_request_headers() {
@@ -366,7 +366,7 @@ protected function get_sanitized_request_headers() {
 	 *
 	 * Dasherized-Plugin-Name/Plugin-Version (WooCommerce/WC-Version; WordPress/WP-Version)
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @return string
 	 */
 	protected function get_request_user_agent() {
@@ -378,7 +378,7 @@ protected function get_request_user_agent() {
 	/**
 	 * Get the request duration in seconds, rounded to the 5th decimal place
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @return string
 	 */
 	protected function get_request_duration() {
@@ -392,7 +392,7 @@ protected function get_request_duration() {
 	/**
 	 * Get the response handler class name
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @return string
 	 */
 	protected function get_response_handler() {
@@ -403,7 +403,7 @@ protected function get_response_handler() {
 	/**
 	 * Get the response code
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @return string
 	 */
 	protected function get_response_code() {
@@ -414,7 +414,7 @@ protected function get_response_code() {
 	/**
 	 * Get the response message
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @return string
 	 */
 	protected function get_response_message() {
@@ -425,7 +425,7 @@ protected function get_response_message() {
 	/**
 	 * Get the response headers
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @return array
 	 */
 	protected function get_response_headers() {
@@ -436,7 +436,7 @@ protected function get_response_headers() {
 	/**
 	 * Get the raw response body, prior to any parsing or sanitization
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @return string
 	 */
 	protected function get_raw_response_body() {
@@ -448,7 +448,7 @@ protected function get_raw_response_body() {
 	 * Get the sanitized response body, provided by the response class
 	 * to_string_safe() method
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @return string|null
 	 */
 	protected function get_sanitized_response_body() {
@@ -462,7 +462,7 @@ protected function get_sanitized_response_body() {
 	/**
 	 * Returns the most recent request object
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @see \SV_WC_API_Request
 	 * @return object the most recent request object
 	 */
@@ -474,7 +474,7 @@ public function get_request() {
 	/**
 	 * Returns the most recent response object
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @see \SV_WC_API_Response
 	 * @return object the most recent response object
 	 */
@@ -487,7 +487,7 @@ public function get_response() {
 	 * Get the ID for the API, used primarily to namespace the action name
 	 * for broadcasting requests
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @return string
 	 */
 	protected function get_api_id() {
@@ -503,7 +503,7 @@ protected function get_api_id() {
 	 * \SV_WC_API_Request which should be used in the child class API methods
 	 * to build the request. This is then passed to self::perform_request()
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @param string $type optional request type
 	 * @return \SV_WC_API_Request
 	 */
@@ -518,7 +518,7 @@ abstract protected function get_new_request( $type = null );
 	 * This is used for defining the plugin ID used in filter names, as well
 	 * as the plugin name used for the default user agent.
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @return \SV_WC_Plugin
 	 */
 	abstract protected function get_plugin();
@@ -530,7 +530,7 @@ abstract protected function get_plugin();
 	/**
 	 * Set a header request
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @param string $name header name
 	 * @param string $value header value
 	 * @return string
@@ -544,7 +544,7 @@ protected function set_request_header( $name, $value ) {
 	/**
 	 * Set HTTP basic auth for the request
 	 *
-	 * Since 2.1-1
+	 * Since 2.2.0
 	 * @param string $username
 	 * @param string $password
 	 */
@@ -557,7 +557,7 @@ protected function set_http_basic_auth( $username, $password ) {
 	/**
 	 * Set the Content-Type request header
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @param string $content_type
 	 */
 	protected function set_request_content_type_header( $content_type ) {
@@ -568,7 +568,7 @@ protected function set_request_content_type_header( $content_type ) {
 	/**
 	 * Set the Accept request header
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @param $type
 	 */
 	protected function set_request_accept_header( $type ) {
@@ -582,7 +582,7 @@ protected function set_request_accept_header( $type ) {
 	 *
 	 * Note the class should implement SV_WC_API
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @param string $handler handle class name
 	 * @return array
 	 */

woocommerce/api/interface-sv-wc-api-request.php

@@ -35,7 +35,7 @@ interface SV_WC_API_Request {
 	/**
 	 * Returns the string representation of this request
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @return string the request
 	 */
 	public function to_string();
@@ -45,7 +45,7 @@ public function to_string();
 	 * Returns the string representation of this request with any and all
 	 * sensitive elements masked or removed
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @return string the request, safe for logging/displaying
 	 */
 	public function to_string_safe();

woocommerce/api/interface-sv-wc-api-response.php

@@ -35,7 +35,7 @@ interface SV_WC_API_Response {
 	/**
 	 * Returns the string representation of this request
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @return string the request
 	 */
 	public function to_string();
@@ -45,7 +45,7 @@ public function to_string();
 	 * Returns the string representation of this request with any and all
 	 * sensitive elements masked or removed
 	 *
-	 * @since 2.1-1
+	 * @since 2.2.0
 	 * @return string the request, safe for logging/displaying
 	 */
 	public function to_string_safe();

woocommerce/changelog.txt

@@ -1,6 +1,6 @@
 *** SkyVerge WooCommerce Plugin Framework Changelog ***
 
-2014.nn.nn - version 2.1-1
+2014.08.26 - version 2.2.0
  * Feature - Added API base class and automatic request logging
  * Feature - Introduced Helper class
  * Feature - Optional detailed customer decline messages on checkout
@@ -11,7 +11,7 @@
  * Tweak - Plugin active method now checks filename only
  * Fix - Fixed product page URLs
 
-2014.05.26 - version 2.1
+2014.05.26 - version 2.1.0
  * Feature - Implemented hosted payment gateway framework
  * Feature - Capture charge bulk order action for payment gateways
  * Tweak - Authorized charges are no longer automatically capture when changing order status from on-hold to processing/completed
@@ -26,10 +26,10 @@
 2014.01.29 - version 2.0.1
  * Tweak - Additional WC 2.1 compatibility helpers
 
-2014.01.20 - version 2.0
+2014.01.20 - version 2.0.0
  * Feature - Generalized Plugin Framework
  * Feature - Support for "tokenize with sale" gateways
  * Tweak - Improved handling for credit card capture request
 
-2013.11.11 - version 1.0
+2013.11.11 - version 1.0.0
  * First Release