shopify_api 1.2.2 → 1.2.5

data/CHANGELOG

@@ -1,3 +1,17 @@
+== Version 1.2.5
+
+* Fix for Article#comments
+
+== Version 1.2.4
+
+* Added Article#comments
+* Added Order#cancel
+* Added Comment#restore, #not_spam
+
+== Version 1.2.3
+
+* Added Customer, CustomerGroup support
+
 == Version 1.2.2
 
 * Added ScriptTag support

data/lib/shopify_api.rb

@@ -252,19 +252,26 @@ module ShopifyAPI
   end
 
   class Order < Base
-    def close; load_attributes_from_response(post(:close)); end
+    def close;  load_attributes_from_response(post(:close, {}, only_id)); end
+    def open;   load_attributes_from_response(post(:open, {}, only_id)); end
 
-    def open; load_attributes_from_response(post(:open)); end
+    def cancel(options = {})
+      load_attributes_from_response(post(:cancel, options, only_id))
+    end
 
     def transactions
       Transaction.find(:all, :params => { :order_id => id })
     end
-    
+
     def capture(amount = "")
       Transaction.create(:amount => amount, :kind => "capture", :order_id => id)
     end
+
+    def only_id
+      encode(:only => :id, :include => [], :methods => [], :fields => [])
+    end
   end
-  
+
   class Product < Base
 
     # Share all items of this store with the 
@@ -345,6 +352,10 @@ module ShopifyAPI
   
   class Article < Base
     self.prefix = "/admin/blogs/:blog_id/"
+    
+    def comments
+      Comment.find(:all, :params => { :article_id => id })
+    end
   end
   
   class Metafield < Base
@@ -362,13 +373,19 @@ module ShopifyAPI
 
   end
 
-  class Comment < Base 
-    def remove; load_attributes_from_response(post(:remove)); end
-    def ham; load_attributes_from_response(post(:ham)); end
-    def spam; load_attributes_from_response(post(:spam)); end
-    def approve; load_attributes_from_response(post(:approve)); end        
+  class Comment < Base
+    def remove;   load_attributes_from_response(post(:remove, {}, only_id)); end
+    def ham;      load_attributes_from_response(post(:ham, {}, only_id)); end
+    def spam;     load_attributes_from_response(post(:spam, {}, only_id)); end
+    def approve;  load_attributes_from_response(post(:approve, {}, only_id)); end
+    def restore;  load_attributes_from_response(post(:restore, {}, only_id)); end
+    def not_spam; load_attributes_from_response(post(:not_spam, {}, only_id)); end
+
+    def only_id
+      encode(:only => :id)
+    end
   end
-  
+
   class Province < Base
     self.prefix = "/admin/countries/:country_id/"
   end
@@ -388,6 +405,12 @@ module ShopifyAPI
     end
   end
   
+  class Customer < Base
+  end
+
+  class CustomerGroup < Base
+  end
+  
   # Assets represent the files that comprise your theme.
   # There are different buckets which hold different kinds
   # of assets, each corresponding to one of the folders

data/shopify_api.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{shopify_api}
-  s.version = "1.2.2"
+  s.version = "1.2.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tobias L\303\274tke", "Cody Fauser", "Dennis Theisen", "Edward Ocampo-Gooding"]
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
 
 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 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.
 
 
 == Usage

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 2
-  - 2
-  version: 1.2.2
+  - 5
+  version: 1.2.5
 platform: ruby
 authors: 
 - "Tobias L\xC3\xBCtke"
@@ -24,6 +24,7 @@ dependencies:
   name: activeresource
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -38,6 +39,7 @@ dependencies:
   name: thor
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -52,6 +54,7 @@ dependencies:
   name: mocha
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -62,26 +65,63 @@ dependencies:
         version: 0.9.8
   type: :development
   version_requirements: *id003
-description: "= Shopify API\n\n\
-  The Shopify API gem allows Ruby developers to programmatically access the admin section of Shopify stores.\n\n\
-  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\xE2\x80\x99ve tried to make the API follow the REST principles as much as possible.\n\n\n\
-  == Usage\n\n\
-  === Requirements\n\n\
-  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:\n\n\
-  * Shop owners can create applications for themselves through their own admin (under the Preferences > Applications tab).\n\
-  * Shopify Partners create applications through their admin: http://app.shopify.com/services/partners \n\n\
-  For more information and detailed documentation about the API visit http://api.shopify.com\n\n\
-  === Getting Started\n\n\
-  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:\n\n\
-  1. First create a new application in either the partners admin or your store admin and write down your API_KEY and SHARED_SECRET.\n\n\
-  2. You will need to supply two parameters to the Session class before you instantiate it:\n\n    ShopifyAPI::Session.setup({:api_key => API_KEY, :secret => SHARED_SECRET})\n\n\
-  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:\n\n    session = ShopifyAPI::Session.new(\"yourshopname.myshopify.com\")\n    session.valid?  # returns false\n\n\
-  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:\n\n    url = session.create_permission_url\n\n\
-  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.\n\n    token = params[:t]\n    session = ShopifyAPI::Session.new(\"yourshopname.myshopify.com\", token)\n    session.valid?  # returns true\n\n\
-  6. Now you can finally get the fully authorized URL for that shop. Use that URL to configure ActiveResource and you're set:\n\n     ActiveResource::Base.site = session.site\n\n\
-  7. Get data from that shop (returns ActiveResource instances):\n\n     shop = ShopifyAPI::Shop.current\n     latest_orders = ShopifyAPI::Order.find(:all)\n\n\
-  == Copyright\n\n\
-  Copyright (c) 2009 \"JadedPixel inc.\". See LICENSE for details.\n"
+description: |
+  = Shopify API
+  
+  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.
+  
+  
+  == Usage
+  
+  === Requirements
+  
+  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).
+  * 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
+  
+  === 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.
+  
+  2. 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. 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:
+  
+      session = ShopifyAPI::Session.new("yourshopname.myshopify.com")
+      session.valid?  # returns false
+  
+  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:
+  
+      url = session.create_permission_url
+  
+  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.
+  
+      token = params[:t]
+      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:
+  
+       ActiveResource::Base.site = session.site
+  
+  7. Get data from that shop (returns ActiveResource instances):
+  
+       shop = ShopifyAPI::Shop.current
+       latest_orders = ShopifyAPI::Order.find(:all)
+  
+  == Copyright
+  
+  Copyright (c) 2009 "JadedPixel inc.". See LICENSE for details.
+
 email: developers@jadedpixel.com
 executables: 
 - shopify
@@ -103,6 +143,7 @@ files:
 - test/order_test.rb
 - test/shopify_api_test.rb
 - test/test_helper.rb
+- bin/shopify
 has_rdoc: true
 homepage: http://github.com/Shopify/shopify_api
 licenses: []
@@ -113,6 +154,7 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -120,6 +162,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -129,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: shopify-api
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: ShopifyAPI is a lightweight gem for accessing the Shopify admin REST web services