Updated CHANGELOG.md and generated documentation

CHANGELOG.md

@@ -21,6 +21,14 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 ### Security
 - Nothing
 
+## 1.1.8 - 2016-03-16
+
+### Added
+- Created `Http\UrlParserTrait` and moved methods `SecureRequestMiddleware::getPath()` and `SecureRequestMiddleware::getParams()` to it.
+
+### Fixed
+- Changed namespace `Entities` to `Repositories`.
+
 ## 1.1.7 - 2016-03-15
 
 ### Fixed

docs/Larabros/Elogram/Client.rst

@@ -38,39 +38,39 @@ Larabros\\Elogram\\Client
 
     .. php:method:: users()
 
-        Returns the current instance of :php:class:`User`.
+        Returns the current instance of :php:class:`UsersRepository`.
 
-        :returns: User
+        :returns: UsersRepository
 
     .. php:method:: media()
 
-        Returns the current instance of :php:class:`Media`.
+        Returns the current instance of :php:class:`MediaRepository`.
 
-        :returns: Media
+        :returns: MediaRepository
 
     .. php:method:: comments()
 
-        Returns the current instance of :php:class:`Comment`.
+        Returns the current instance of :php:class:`CommentsRepository`.
 
-        :returns: Comment
+        :returns: CommentsRepository
 
     .. php:method:: likes()
 
-        Returns the current instance of :php:class:`LikeRepository`.
+        Returns the current instance of :php:class:`LikesRepository`.
 
-        :returns: LikeRepository
+        :returns: LikesRepository
 
     .. php:method:: tags()
 
-        Returns the current instance of :php:class:`Tag`.
+        Returns the current instance of :php:class:`TagsRepository`.
 
-        :returns: Tag
+        :returns: TagsRepository
 
     .. php:method:: locations()
 
-        Returns the current instance of :php:class:`Location`.
+        Returns the current instance of :php:class:`LocationsRepository`.
 
-        :returns: Location
+        :returns: LocationsRepository
 
     .. php:method:: request($method, $uri, $parameters = [])
 

docs/Larabros/Elogram/Helpers/RedirectLoginHelper.rst

@@ -10,17 +10,17 @@ Larabros\\Elogram\\Helpers\\RedirectLoginHelper
 
     .. php:attr:: provider
 
-        protected ProviderInterface
+        protected AdapterInterface
 
     .. php:attr:: store
 
         protected DataStoreInterface
 
-    .. php:method:: __construct(ProviderInterface $provider, DataStoreInterface $store)
+    .. php:method:: __construct(AdapterInterface $provider, DataStoreInterface $store)
 
         Creates an instance of :php:class:`RedirectLoginHelper`.
 
-        :type $provider: ProviderInterface
+        :type $provider: AdapterInterface
         :param $provider:
         :type $store: DataStoreInterface
         :param $store:

docs/Larabros/Elogram/Http/Middleware/SecureRequestMiddleware.rst

@@ -28,19 +28,14 @@ Larabros\\Elogram\\Http\\Middleware\\SecureRequestMiddleware
         :param $request:
         :param $options:
 
-    .. php:method:: getPath($path)
-
-        :param $path:
-
-    .. php:method:: getParams($query)
-
-        :param $query:
-
     .. php:method:: generateSig($endpoint, $params, $secret)
 
+        Generates a ``sig`` value for a request.
+
         :param $endpoint:
         :param $params:
         :param $secret:
+        :returns: string
 
     .. php:method:: create(ConfigInterface $config)
 
@@ -50,6 +45,27 @@ Larabros\\Elogram\\Http\\Middleware\\SecureRequestMiddleware
         :param $config:
         :returns: Closure
 
+    .. php:method:: getPath(UriInterface $uri)
+
+        Gets the path from a ``UriInterface`` instance after removing the version
+        prefix.
+
+        :type $uri: UriInterface
+        :param $uri:
+        :returns: string
+
+    .. php:method:: getQueryParams(UriInterface $uri, $exclude = ['sig'], $params = [])
+
+        Gets the query parameters as an array from a ``UriInterface`` instance.
+
+        :type $uri: UriInterface
+        :param $uri:
+        :type $exclude: array
+        :param $exclude:
+        :type $params: array
+        :param $params:
+        :returns: array
+
     .. php:method:: __construct($nextHandler, ConfigInterface $config)
 
         Creates an instance of :php:class:`AbstractMiddleware`.

docs/Larabros/Elogram/Http/OAuth2/ProviderInterface.rst → docs/Larabros/Elogram/Http/OAuth2/Providers/AdapterInterface.rst

@@ -1,10 +1,10 @@
---------------------------------------------------
-Larabros\\Elogram\\Http\\OAuth2\\ProviderInterface
---------------------------------------------------
+------------------------------------------------------------
+Larabros\\Elogram\\Http\\OAuth2\\Providers\\AdapterInterface
+------------------------------------------------------------
 
-.. php:namespace: Larabros\\Elogram\\Http\\OAuth2
+.. php:namespace: Larabros\\Elogram\\Http\\OAuth2\\Providers
 
-.. php:interface:: ProviderInterface
+.. php:interface:: AdapterInterface
 
     An interface for OAuth2 providers.
 

docs/Larabros/Elogram/Http/OAuth2/LeagueProvider.rst → docs/Larabros/Elogram/Http/OAuth2/Providers/LeagueAdapter.rst

@@ -1,12 +1,12 @@
------------------------------------------------
-Larabros\\Elogram\\Http\\OAuth2\\LeagueProvider
------------------------------------------------
+---------------------------------------------------------
+Larabros\\Elogram\\Http\\OAuth2\\Providers\\LeagueAdapter
+---------------------------------------------------------
 
-.. php:namespace: Larabros\\Elogram\\Http\\OAuth2
+.. php:namespace: Larabros\\Elogram\\Http\\OAuth2\\Providers
 
-.. php:class:: LeagueProvider
+.. php:class:: LeagueAdapter
 
-    An OAuth2 provider for the League OAuth2 package.
+    An OAuth2 provider for the League Instagram OAuth2 package.
 
     .. php:method:: getAuthorizationUrl($options = [])
 

docs/Larabros/Elogram/Http/OAuth2/Providers/index.rst

@@ -0,0 +1,10 @@
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Larabros\\Elogram\\Http\\OAuth2\\Providers
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. php:namespace: Larabros\\Elogram\\Http\\OAuth2\\Providers
+
+.. toctree::
+
+   AdapterInterface
+   LeagueAdapter

docs/Larabros/Elogram/Http/UrlParserTrait.rst

@@ -0,0 +1,30 @@
+---------------------------------------
+Larabros\\Elogram\\Http\\UrlParserTrait
+---------------------------------------
+
+.. php:namespace: Larabros\\Elogram\\Http
+
+.. php:trait:: UrlParserTrait
+
+    Adds utility classes for parsing parts of a URL.
+
+    .. php:method:: getPath(UriInterface $uri)
+
+        Gets the path from a ``UriInterface`` instance after removing the version
+        prefix.
+
+        :type $uri: UriInterface
+        :param $uri:
+        :returns: string
+
+    .. php:method:: getQueryParams(UriInterface $uri, $exclude = ['sig'], $params = [])
+
+        Gets the query parameters as an array from a ``UriInterface`` instance.
+
+        :type $uri: UriInterface
+        :param $uri:
+        :type $exclude: array
+        :param $exclude:
+        :type $params: array
+        :param $params:
+        :returns: array

docs/Larabros/Elogram/Http/index.rst

@@ -11,3 +11,4 @@ Larabros\\Elogram\\Http
    OAuth2/index
    Response
    Sessions/index
+   UrlParserTrait

docs/Larabros/Elogram/Repositories/AbstractRepository.rst

@@ -0,0 +1,20 @@
+---------------------------------------------------
+Larabros\\Elogram\\Repositories\\AbstractRepository
+---------------------------------------------------
+
+.. php:namespace: Larabros\\Elogram\\Repositories
+
+.. php:class:: AbstractRepository
+
+    An abstract repository class. Any new endpoints should extend this class.
+
+    .. php:attr:: client
+
+        protected AdapterInterface
+
+    .. php:method:: __construct(AdapterInterface $client)
+
+        Creates a new instance of :php:class:`AbstractRepository`.
+
+        :type $client: AdapterInterface
+        :param $client:

docs/Larabros/Elogram/Entities/Comment.rst → docs/Larabros/Elogram/Repositories/CommentsRepository.rst

@@ -1,12 +1,12 @@
-------------------------------------
-Larabros\\Elogram\\Entities\\Comment
-------------------------------------
+---------------------------------------------------
+Larabros\\Elogram\\Repositories\\CommentsRepository
+---------------------------------------------------
 
-.. php:namespace: Larabros\\Elogram\\Entities
+.. php:namespace: Larabros\\Elogram\\Repositories
 
-.. php:class:: Comment
+.. php:class:: CommentsRepository
 
-    Comment
+    CommentsRepository
 
     .. php:attr:: client
 
@@ -31,7 +31,7 @@ Larabros\\Elogram\\Entities\\Comment
 
         :param $mediaId:
         :type $text: string
-        :param $text: Text to post as a comment on the media object as specified by `$mediaId`
+        :param $text: Text to post as a comment on the media object
         :returns: Response
 
     .. php:method:: delete($mediaId, $commentId)
@@ -46,7 +46,7 @@ Larabros\\Elogram\\Entities\\Comment
 
     .. php:method:: __construct(AdapterInterface $client)
 
-        Creates a new instance of :php:class:`AbstractEntity`.
+        Creates a new instance of :php:class:`AbstractRepository`.
 
         :type $client: AdapterInterface
         :param $client:

docs/Larabros/Elogram/Entities/LikeRepository.rst → docs/Larabros/Elogram/Repositories/LikesRepository.rst

@@ -1,12 +1,12 @@
--------------------------------------------
-Larabros\\Elogram\\Entities\\LikeRepository
--------------------------------------------
+------------------------------------------------
+Larabros\\Elogram\\Repositories\\LikesRepository
+------------------------------------------------
 
-.. php:namespace: Larabros\\Elogram\\Entities
+.. php:namespace: Larabros\\Elogram\\Repositories
 
-.. php:class:: LikeRepository
+.. php:class:: LikesRepository
 
-    LikeRepository class.
+    LikesRepository class.
 
     .. php:attr:: client
 
@@ -38,7 +38,7 @@ Larabros\\Elogram\\Entities\\LikeRepository
 
     .. php:method:: __construct(AdapterInterface $client)
 
-        Creates a new instance of :php:class:`AbstractEntity`.
+        Creates a new instance of :php:class:`AbstractRepository`.
 
         :type $client: AdapterInterface
         :param $client:

docs/Larabros/Elogram/Entities/Location.rst → docs/Larabros/Elogram/Repositories/LocationsRepository.rst

@@ -1,12 +1,12 @@
--------------------------------------
-Larabros\\Elogram\\Entities\\Location
--------------------------------------
+----------------------------------------------------
+Larabros\\Elogram\\Repositories\\LocationsRepository
+----------------------------------------------------
 
-.. php:namespace: Larabros\\Elogram\\Entities
+.. php:namespace: Larabros\\Elogram\\Repositories
 
-.. php:class:: Location
+.. php:class:: LocationsRepository
 
-    Location
+    LocationsRepository
 
     .. php:attr:: client
 
@@ -61,7 +61,7 @@ Larabros\\Elogram\\Entities\\Location
 
     .. php:method:: __construct(AdapterInterface $client)
 
-        Creates a new instance of :php:class:`AbstractEntity`.
+        Creates a new instance of :php:class:`AbstractRepository`.
 
         :type $client: AdapterInterface
         :param $client: