shopify_api 3.0.0 → 3.0.1

data/.gitignore

@@ -2,4 +2,5 @@
 .DS_Store
 coverage
 rdoc
+doc
 pkg

data/CHANGELOG

@@ -1,3 +1,13 @@
+== Version 3.0.1
+
+* Fix saving nested resources in ActiveResource 3.1+
+
+== Version 3.0.0
+
+* Added support for OAuth Authentication
+* Removal of support for Legacy Authentication
+* Added Cart resource
+
 == Version 2.3.0
 
 * Fix double root bug with ActiveSupport 3.2.0

data/README.rdoc

@@ -26,26 +26,39 @@ ShopifyAPI uses ActiveResource to communicate with the REST web service. ActiveR
 
     ShopifyAPI::Session.setup({:api_key => API_KEY, :secret => SHARED_SECRET})
 
-3. Create a new Session for a specific shop. That session is not fully valid yet, but it can be used to create a URL that you will redirect your users to:
+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:
 
-    session = ShopifyAPI::Session.new("yourshopname.myshopify.com")
-    session.valid?  # returns false
+     GET https://SHOP_NAME.myshopify.com/admin/oauth/authorize
 
-4. To access the API shop owners need a "token" from that specific shop. In order to get this token they need to authorize with that shop first. The URL to redirect your user to can be generated via:
+   with the following parameters:
 
-    url = session.create_permission_url
+   * 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
 
-5. 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"). Use that token to instantiate a "valid" session, that is ready to make calls to that particular shop.
+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:
 
-    token = params[:t]
+    POST https://SHOP_NAME.myshopify.com/admin/oauth/access_token
+
+   with the following parameters:
+   
+   * client_id – Required – The API key for your app
+   * client_secret – Required – The shared secret for your app
+   * code – Required – The token you received in step 3
+
+   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.
+
+    token = params[:code]
     session = ShopifyAPI::Session.new("yourshopname.myshopify.com", token)
     session.valid?  # returns true
 
-6. Now you can finally get the fully authorized URL for that shop. Use that URL to configure ActiveResource and you're set:
+5. Now you can activate the session and you're set:
 
-     ActiveResource::Base.site = session.site
+     ShopifyAPI::Base.activate_session(session)
 
-7. Get data from that shop (returns ActiveResource instances):
+6. Get data from that shop (returns ActiveResource instances):
 
      shop = ShopifyAPI::Shop.current
      latest_orders = ShopifyAPI::Order.find(:all)
@@ -54,7 +67,18 @@ ShopifyAPI uses ActiveResource to communicate with the REST web service. ActiveR
 
     latest_orders = ShopifyAPI::Session.temp("yourshopname.myshopify.com", token) { ShopifyAPI::Order.find(:all) }
 
+7. Finally, you can also clear the session (for example if you want to work with another shop):
+
+     ShopifyAPI::Base.clear_session
+
+== Questions or Problems?
+
+http://api.shopify.com <= Read the tech docs!
+
+http://wiki.shopify.com/Developer_Home <= Read the wiki!
+
+http://stackoverflow.com/questions/tagged/shopify <= Ask questions on Stack Overflow!
 
 == Copyright
 
-Copyright (c) 2011 "JadedPixel inc.". See LICENSE for details.
+Copyright (c) 2012 "Shopify inc.". See LICENSE for details.

data/lib/shopify_api/resources/base.rb

@@ -28,7 +28,11 @@ module ShopifyAPI
         self.site = nil
         self.headers.delete('X-Shopify-Access-Token')
       end
-    end                  
+    end
+
+    def persisted?
+      !id.nil?
+    end
 
     private
     def only_id

data/lib/shopify_api/version.rb

@@ -1,3 +1,3 @@
 module ShopifyAPI
-  VERSION = "3.0.0"
+  VERSION = "3.0.1"
 end

data/test/fixtures/product.json

@@ -23,6 +23,7 @@
       {
         "position": 1,
         "price": "199.00",
+        "product_id": 632910392,
         "created_at": "2011-10-20T14:05:13-04:00",
         "requires_shipping": true,
         "title": "Pink",
@@ -43,6 +44,7 @@
       {
         "position": 2,
         "price": "199.00",
+        "product_id": 632910392,
         "created_at": "2011-10-20T14:05:13-04:00",
         "requires_shipping": true,
         "title": "Red",
@@ -63,6 +65,7 @@
       {
         "position": 3,
         "price": "199.00",
+        "product_id": 632910392,
         "created_at": "2011-10-20T14:05:13-04:00",
         "requires_shipping": true,
         "title": "Green",
@@ -83,6 +86,7 @@
       {
         "position": 4,
         "price": "199.00",
+        "product_id": 632910392,
         "created_at": "2011-10-20T14:05:13-04:00",
         "requires_shipping": true,
         "title": "Black",

data/test/product_test.rb

@@ -27,4 +27,12 @@ class ProductTest < Test::Unit::TestCase
     assert_equal 2, metafields.length
     assert metafields.all?{|m| m.is_a?(ShopifyAPI::Metafield)}
   end
+
+  def test_update_loaded_variant
+    fake "products/632910392/variants/808950810", :method => :put, :status => 200, :body => load_fixture('variant')
+
+    variant = @product.variants.first
+    variant.price = "0.50"
+    variant.save
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-05 00:00:00.000000000 Z
+date: 2012-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
-  requirement: &70215153027780 !ruby/object:Gem::Requirement
+  requirement: &2168463760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70215153027780
+  version_requirements: *2168463760
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70215153026900 !ruby/object:Gem::Requirement
+  requirement: &2168479620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 0.14.4
   type: :runtime
   prerelease: false
-  version_requirements: *70215153026900
+  version_requirements: *2168479620
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70215153026040 !ruby/object:Gem::Requirement
+  requirement: &2168479160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 0.9.8
   type: :development
   prerelease: false
-  version_requirements: *70215153026040
+  version_requirements: *2168479160
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70215153062680 !ruby/object:Gem::Requirement
+  requirement: &2168478780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70215153062680
+  version_requirements: *2168478780
 description: The Shopify API gem allows Ruby developers to programmatically access
   the admin section of Shopify stores. The API is implemented as JSON or XML over
   HTTP using all four verbs (GET/POST/PUT/DELETE). Each resource, like Order, Product,
@@ -185,3 +185,4 @@ specification_version: 3
 summary: ShopifyAPI is a lightweight gem for accessing the Shopify admin REST web
   services
 test_files: []
+has_rdoc: