Add activate_session and clear_session methods to ShopifyResource.

These methods can be used instead of setting ShopifyResource.site directly
for forward comptiblity with the coming OAuth2 changes.

Author: dylanahsmith

CHANGELOG

@@ -1,3 +1,10 @@
+== Version 0.4.0
+
+* Using setup.py no longer requires all dependancies
+* More compatiblity fixes for using the latest pyactiveresource
+* ShopifyResource.activate_session is not recommended over setting site
+directly for forward compatibility with coming OAuth2 changes.
+
 == Version 0.3.1
 
 * Compatiblity fixes for using latest (unreleased) pyactiveresource

MANIFEST.in

@@ -1,4 +1,4 @@
 include LICENSE
 include CHANGELOG
-include README.rdoc
+include README.md
 include bin/shopify_api.py

README.md

@@ -64,38 +64,53 @@ these steps:
     ```
 
 3.  For application to access a shop via the API, they first need a
-    "token" specific to the shop, which is obtained from Shopify after
-    the owner has granted the application access to the shop. This can
-    be done by redirecting the shop owner to permission URL obtained
-    as follows:
+    "access token" specific to the shop, which is obtained from
+    Shopify after the owner has granted the application access to the
+    shop. This can be done by redirecting the shop owner to a
+    permission URL, obtained as follows:
 
     ```python
     shop_url = "yourshopname.myshopify.com"
     permission_url = shopify.Session.create_permission_url(shop_url)
     ```
 
 4.  After visiting this URL, the shop redirects the owner to a custom
-    URL of your application where the `token` gets sent to (it's param
-    name is just `t`) along with other parameters to ensure it was sent
-    by Shopify. That token is used to instantiate the session so that it
-    is ready to make calls to that particular shop.
+    URL of your application where the encoded access token gets sent
+    as the `t` param. The following code will validate taht the request
+    came from Shopify, then decode the permanent access token which
+    can be used to make API requests for this shop.
 
     ```python
     session = shopify.Session(shop_url, params)
     ```
 
-5.  Now you can finally get the fully authorized URL for that shop.
-    Use that URL to configure ActiveResource and you're set:
+5.  Activate the session to use the access token for following API
+    requests for the shop it was authorized for.
 
     ```python
-    shopify.ShopifyResource.site = session.site
+    shopify.ShopifyResource.activate_session(session)
     ```
 
-6.  Get data from that shop (returns ActiveResource instances):
+6.  Start making authorized API requests for that shop. Data is returned as
+    ActiveResource instances:
 
     ```python
-    shop = shopify.Shop.current()
-    latest_orders = shopify.Order.find()
+    # Get a list of products
+    products = shopify.Product.find()
+
+    # Get a specific product
+    product = shopify.Product.find(632910)
+
+    # Create a new product
+    new_product = shopify.Product()
+    new_product.title = "Burton Custom Freestlye 151"
+    new_product.product_type = "Snowboard"
+    new_product.vendor = "Burton"
+    new_product.save()
+
+    # Update a product
+    product.handle = "burton-snowboard"
+    product.save()
     ```
 
 ### Console
@@ -148,8 +163,9 @@ easy_install dist/ShopifyAPI-*.tar.gz
 
 ## Limitations
 
-Currently there is not support for:
+Currently there is no support for:
 
+* OAuth2
 * python 3
 * asynchronous requests
 * persistent connections

RELEASING

@@ -1,7 +1,7 @@
 Releasing shopify_python_api
 
 1. Check the Semantic Versioning page for info on how to version the new release: http://semver.org
-2. Updates version in shopify/__init__.py
+2. Update version in shopify/version.py
 3. Update CHANGELOG entry for the release.
 4. Commit the changes
     git commit -m "Release vX.Y.Z"

shopify/base.py

@@ -149,3 +149,13 @@ def __set_id(self, value):
     def save(self):
         self.errors.clear() # Bug in pyactiveresource v1.0.1, but fixed in trunk at revision 96
         return super(ShopifyResource, self).save()
+
+    @classmethod
+    def activate_session(cls, session):
+        cls.site = session.site
+
+    @classmethod
+    def clear_session(cls):
+        cls.site = None
+        cls.user = None
+        cls.password = None

shopify/version.py

@@ -1 +1 @@
-VERSION = '0.3.1'
+VERSION = '0.4.0'