Merge pull request #80 from Shopify/updating_readme

Updating readme & add stuff to session

CHANGELOG

@@ -1,6 +1,8 @@
 == Version 3.1.8
 
 * Expose `Location`
+* Added create_permission_url and create_auth_url methods
+* Edited the readme to better describe the getting started procedure
 
 == Version 3.1.7
 

README.rdoc

@@ -2,7 +2,7 @@
 
 The Shopify API gem allows Ruby developers to programmatically access the admin section of Shopify stores.
 
-The API is implemented as XML over HTTP using all four verbs (GET/POST/PUT/DELETE). Each resource, like Order, Product, or Collection, has its own URL and is manipulated in isolation. In other words, we’ve tried to make the API follow the REST principles as much as possible.
+The API is implemented as JSON over HTTP using all four verbs (GET/POST/PUT/DELETE). Each resource, like Order, Product, or Collection, has its own URL and is manipulated in isolation. In other words, we’ve tried to make the API follow the REST principles as much as possible.
 
 
 == Usage
@@ -11,32 +11,60 @@ The API is implemented as XML over HTTP using all four verbs (GET/POST/PUT/DELET
 
 All API usage happens through Shopify applications, created by either shop owners for their own shops, or by Shopify Partners for use by other shop owners:
 
-* Shop owners can create applications for themselves through their own admin (under the Preferences > Applications tab).
+* Shop owners can create applications for themselves through their own admin: http://docs.shopify.com/api/tutorials/creating-a-private-app
 * Shopify Partners create applications through their admin: http://app.shopify.com/services/partners 
 
 For more information and detailed documentation about the API visit http://api.shopify.com
 
+
+=== Installation
+
+To easily install or upgrade to the latest release, use {gem}[http://rubygems.org/]
+
+    gem install shopify_api
+
+
 === Getting Started
 
 ShopifyAPI uses ActiveResource to communicate with the REST web service. ActiveResource has to be configured with a fully authorized URL of a particular store first. To obtain that URL you can follow these steps:
 
-1. First create a new application in either the partners admin or your store admin and write down your API_KEY and SHARED_SECRET.
+1. First create a new application in either the partners admin or your store admin. For a private App you'll need the API_KEY and the PASSWORD otherwise you'll need the API_KEY and SHARED_SECRET.
+
+2. For a private App you just need to set the base site url as follows:
+    
+    shop_url = "https://#{API_KEY}:#{PASSWORD}@SHOP_NAME.myshopify.com/admin"
+    ShopifyAPI::Base.site = shop_url
 
-2. You will need to supply two parameters to the Session class before you instantiate it:
+   That's it you're done, skip to step 7 and start using the API!
+
+   For a partner app you will need to supply two parameters to the Session class before you instantiate it:
 
     ShopifyAPI::Session.setup({:api_key => API_KEY, :secret => SHARED_SECRET})
 
-3. To access a shop's data apps need an access token from that specific shop. This is a two-stage process. Before interacting with a shop for the first time an app should redirect the user to the following URL:
+3. In order to access a shop's data, apps need an access token from that specific shop. This is a two-stage process. Before interacting with a shop for the first time an app should redirect the user to the following URL:
 
-     GET https://SHOP_NAME.myshopify.com/admin/oauth/authorize
+    GET https://SHOP_NAME.myshopify.com/admin/oauth/authorize
 
    with the following parameters:
 
    * client_id – Required – The API key for your app
-   * scope – Required – The list of required scopes (explained below)
-   * redirect_uri – Optional – The URL that the merchant will be sent to once authentication is complete. Must be the same host as the Return URL specified in the application settings
+   * scope – Required – The list of required scopes (explained here: http://docs.shopify.com/api/tutorials/oauth)
+   * redirect_uri – Optional – The URL that the merchant will be sent to once authentication is complete. Defaults to the URL specified in the application settings and must be the same host as that URL.
+
+   We've added the create_permision_url method to make this easier, first instantiate your session object:
+    
+    session = ShopifyAPI::Session.new("SHOP_NAME.myshopify.com")
 
-4. Once authorized, the shop redirects the owner to the return URL of your application with a parameter named 'code'. This is a temporary token the the app can exchange for a permanent access token. Make the following call:
+  Then call:
+
+    scope = ["write_products"]
+    permission_url = session.create_permission_url(scope)
+
+  or if you want a custom redirect_uri:  
+
+    permission_url = session.create_permission_url(scope, "https://my_redirect_uri.com")
+
+4. Once authorized, the shop redirects the owner to the return URL of your application with a parameter named 'code'. This is a temporary token that the app can exchange for a permanent access token. Make the following call:
 
     POST https://SHOP_NAME.myshopify.com/admin/oauth/access_token
 
@@ -48,34 +76,75 @@ ShopifyAPI uses ActiveResource to communicate with the REST web service. ActiveR
 
    and you'll get your permanent access token back in the response.
 
-5. Use that token to instantiate a session that is ready to make calls to the given shop.
+   There is a method to make the request and get the token for you:
+
+    token = session.request_token(code)
+
+   Which will request the token, save it to the session object and return it. For future sessions simply pass the token in when creating the session object:
+
+    session = ShopifyAPI::Session.new("SHOP_NAME.myshopify.com", token)
+
+5. The session must be activated before use:
 
-    token = params[:access_token]
-    session = ShopifyAPI::Session.new("yourshopname.myshopify.com", token)
-    session.valid?  # returns true
+    ShopifyAPI::Base.activate_session(session)
 
-5. Now you can activate the session and you're set:
+6. Now you're ready to make authorized API requests to your shop! Data is returned as ActiveResource instances:
 
-     ShopifyAPI::Base.activate_session(session)
+    shop = ShopifyAPI::Shop.current
 
-6. Get data from that shop (returns ActiveResource instances):
+    # Get a specific product
+    product = ShopifyAPI::Product.find(179761209)
 
-     shop = ShopifyAPI::Shop.current
-     latest_orders = ShopifyAPI::Order.find(:all)
+    # Create a new product
+    new_product = ShopifyAPI::Product.new
+    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
 
    Alternatively, you can use #temp to initialize a Session and execute a command which also handles temporarily setting ActiveResource::Base.site:
 
-    latest_orders = ShopifyAPI::Session.temp("yourshopname.myshopify.com", token) { ShopifyAPI::Order.find(:all) }
+    products = ShopifyAPI::Session.temp("SHOP_NAME.myshopify.com", token) { ShopifyAPI::Product.find(:all) }
 
-7. Finally, you can also clear the session (for example if you want to work with another shop):
+8. If you want to work with another shop, you'll first need to clear the session::
 
-     ShopifyAPI::Base.clear_session
+    ShopifyAPI::Base.clear_session
 
-== Questions or Problems?
 
-http://api.shopify.com <= Read the tech docs!
+=== Console
+
+This package also includes the `shopify` executable to make it easy to open up an interactive console to use the API with a shop.
+
+1. Obtain a private API key and password to use with your shop (step 2 in "Getting Started")
+
+2. Use the `shopify` script to save the credentials for the shop to quickly log in.
+
+    shopify add yourshopname
+
+   Follow the prompts for the shop domain, API key and password.
+
+3. Start the console for the connection.
 
-http://wiki.shopify.com/Developer_Home <= Read the wiki!
+    shopify console
+
+4. To see the full list of commands, type:
+
+    shopify help
+
+
+== Using Development Version
+
+Download the source code and run:
+    
+    rake install
+
+== Additional Resources
+
+http://api.shopify.com <= Read the tech docs!
 
 http://ecommerce.shopify.com/c/shopify-apis-and-technology <= Ask questions on the forums!
 

lib/shopify_api/session.rb

@@ -68,7 +68,25 @@ module ShopifyAPI
         end
       end
     end
-    
+
+    def create_permission_url(scope, redirect_uri = nil)
+      params = {:client_id => api_key, :scope => scope.join(',')}
+      params[:redirect_uri] = redirect_uri if redirect_uri
+      "#{protocol}://#{url}/admin/oauth/authorize?#{parameterize(params)}"
+    end
+
+    def request_token(code)
+      return token if token
+      
+      response = access_token_request(code)
+
+      if response.code == "200"
+        token = JSON.parse(response.body)['access_token']
+      else
+        raise RuntimeError, response.msg
+      end
+    end
+
     def shop
       Shop.current
     end
@@ -81,5 +99,18 @@ module ShopifyAPI
       url.present? && token.present?
     end
   
+    private
+      def parameterize(params)
+        URI.escape(params.collect{|k,v| "#{k}=#{v}"}.join('&'))
+      end
+
+      def access_token_request(code)
+        uri = URI.parse("#{protocol}://#{url}/admin/oauth/access_token")      
+        https = Net::HTTP.new(uri.host, uri.port)
+        https.use_ssl = true
+        request = Net::HTTP::Post.new(uri.request_uri)
+        request.set_form_data({"client_id" => api_key, "client_secret" => secret, "code" => code})
+        https.request(request)
+      end
   end
 end

test/session_test.rb

@@ -53,6 +53,55 @@ class SessionTest < Test::Unit::TestCase
       assert_equal 'https://fakeshop.myshopify.com/admin', ShopifyAPI::Base.site.to_s
     end
 
+    should "create_permission_url returns correct url with single scope no redirect uri" do
+      ShopifyAPI::Session.setup(:api_key => "My_test_key", :secret => "My test secret")
+      session = ShopifyAPI::Session.new('http://localhost.myshopify.com')
+      scope = ["write_products"]
+      permission_url = session.create_permission_url(scope)
+      assert_equal "https://localhost.myshopify.com/admin/oauth/authorize?client_id=My_test_key&scope=write_products", permission_url
+    end
+
+    should "create_permission_url returns correct url with single scope and redirect uri" do
+      ShopifyAPI::Session.setup(:api_key => "My_test_key", :secret => "My test secret")
+      session = ShopifyAPI::Session.new('http://localhost.myshopify.com')
+      scope = ["write_products"]
+      permission_url = session.create_permission_url(scope, "http://my_redirect_uri.com")
+      assert_equal "https://localhost.myshopify.com/admin/oauth/authorize?client_id=My_test_key&scope=write_products&redirect_uri=http://my_redirect_uri.com", permission_url
+    end
+
+    should "create_permission_url returns correct url with dual scope no redirect uri" do
+      ShopifyAPI::Session.setup(:api_key => "My_test_key", :secret => "My test secret")
+      session = ShopifyAPI::Session.new('http://localhost.myshopify.com')
+      scope = ["write_products","write_customers"]
+      permission_url = session.create_permission_url(scope)
+      assert_equal "https://localhost.myshopify.com/admin/oauth/authorize?client_id=My_test_key&scope=write_products,write_customers", permission_url
+    end
+
+    should "create_permission_url returns correct url with no scope no redirect uri" do
+      ShopifyAPI::Session.setup(:api_key => "My_test_key", :secret => "My test secret")
+      session = ShopifyAPI::Session.new('http://localhost.myshopify.com')
+      scope = []
+      permission_url = session.create_permission_url(scope)
+      assert_equal "https://localhost.myshopify.com/admin/oauth/authorize?client_id=My_test_key&scope=", permission_url
+    end
+
+    should "request token should get token" do
+      ShopifyAPI::Session.setup(:api_key => "My test key", :secret => "My test secret")
+      session = ShopifyAPI::Session.new('http://localhost.myshopify.com')
+      fake nil, :url => 'https://localhost.myshopify.com/admin/oauth/access_token',:method => :post, :body => '{"access_token" : "token"}'
+      assert_equal "token", session.request_token("code")
+    end
+
+    should "raise exception if code invalid in request token" do
+      ShopifyAPI::Session.setup(:api_key => "My test key", :secret => "My test secret")
+      session = ShopifyAPI::Session.new('http://localhost.myshopify.com')
+      fake nil, :url => 'https://localhost.myshopify.com/admin/oauth/access_token',:method => :post, :status => 404, :body => '{"error" : "invalid_request"}'
+      assert_raises(RuntimeError) do
+        session.request_token("bad_code")
+      end
+      assert_equal false, session.valid?
+    end
+
     should "#temp reset ShopifyAPI::Base.site to original value when using a non-standard port" do
       ShopifyAPI::Session.setup(:api_key => "key", :secret => "secret")
       session1 = ShopifyAPI::Session.new('fakeshop.myshopify.com:3000', 'token1')

test/test_helper.rb

@@ -58,8 +58,13 @@ class Test::Unit::TestCase
     format = options.delete(:format) || :json
     method = options.delete(:method) || :get
     extension = ".#{options.delete(:extension)||'json'}" unless options[:extension]==false
-
-    url = "http://localhost/admin/#{endpoint}#{extension}"
+    
+    url = if options.has_key?(:url)
+      options[:url]
+    else  
+      "http://localhost/admin/#{endpoint}#{extension}"
+    end
+    
     FakeWeb.register_uri(method, url, {:body => body, :status => 200, :content_type => "text/#{format}", :content_length => 1}.merge(options))
   end
 end