blomming_api 0.4.6 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7e0c7366da5aff6c926bcee806c8594392d9744
-  data.tar.gz: d9057aa9d300dce1dd2c331216fc58c6dffbf718
+  metadata.gz: ef281dfa6f26763582a9689b0538f068517e4ba0
+  data.tar.gz: 522da850bc418c5f24f5047f3ae037adb22cda4b
 SHA512:
-  metadata.gz: 2d3406fb988cc61bc21bcce750bae444842fd72868a53787013537c848fbd6a87fe9db88e28487fc87756807c3d5bd4d7b62e828389ea36c637c33a12be93433
-  data.tar.gz: 68ba5da8c950751188f5bda3d85757234838bf9a1e8c6f21e84ca5acbcb82c987b60d0f05b0ff42f606e00573669392a996973e7da79867691b71fb53d081907
+  metadata.gz: ff0ad8e69dd1181907b9508f6554a1f10143b82c2b602fa25e69685d24ac9d99a949e51a490a32511bf033f3aa6b36537ad723a6493a8f38856947c347f1a37d
+  data.tar.gz: 59b9c907352eeae6a1021eeef33714a440652294cbe424ccf175deb5dca3ea1dc2ad32c1568da5737ac4d46fcb1039a0a627b9dab7ffc3693f82247ba8855363

data/bin/blomming_api

@@ -30,7 +30,7 @@ elsif option == "-a"
   puts
 elsif option == "-e"
   puts
-  puts "Endpoints methods list:\n"
+  puts "Endpoints methods list:\n\n"
   BlommingApi::endpoints_help
   puts
 else

data/lib/blomming_api/buy_endpoints.rb

@@ -5,49 +5,71 @@ require 'rest_client'
 module BlommingApi
   module BuyEndpoints
     #
+    # BUY
     # CARTS
     #
 
+    #
+    # Create a new Cart on the server, as present in the home page of the web site.
+    # It also redirects to the Cart URL.
+    #
     def carts_create(sku_id, params={})
-      url = api_url '/carts'
+      url = api_url "/carts"
       req = request_params({currency: @currency}.merge(params)) 
         
       # with a hash sends parameters as a urlencoded form body
-      load = {:sku_id => sku_id, :multipart => true}
-
-      # debug
-      #puts req
-      #RestClient.log = 'stdout'
+      load = {sku_id: sku_id, multipart: true}
 
       feed_or_retry do
         RestClient.post url, load, req
       end  
     end
 
+    #
+    # Returns the Cart with the given ID, as returned from the create cart API.
+    #
+    def carts_find(cart_id, params={})
+      url = api_url "/carts/#{cart_id}"
+      req = request_params({currency: @currency, locale: @locale}.merge(params))
+
+      feed_or_retry do
+        RestClient.get url, req
+      end  
+    end
+
+    #
+    # Add multiple SKUs to the Cart.
+    #
     def carts_add(*skus, cart_id, params)
       url = api_url "/carts/#{cart_id}/add"
       req = request_params({currency: @currency, locale: @locale}.merge(params))
       
       # with a hash sends parameters as a urlencoded form body
-      load = {:skus => skus.join(','), :multipart => true}
+      load = {skus: skus.join(','), multipart: true}
 
       feed_or_retry do
         RestClient.put url, load, req
       end  
     end
 
+    #
+    # Remove multiple SKUs from the Cart. 
+    #
     def carts_remove(*skus, cart_id, params)
       url = api_url "/carts/#{cart_id}/remove"
       req = request_params({currency: @currency, locale: @locale}.merge(params))
       
       # with a hash sends parameters as a urlencoded form body
-      load = {:skus => skus.join(','), :multipart => true}
+      load = {skus: skus.join(','), multipart: true}
 
       feed_or_retry do
         RestClient.put url, load, req
       end  
     end
 
+    #
+    # Remove all SKUs from the Cart. 
+    #
     def carts_clear(cart_id, params={})
       url = api_url "/carts/#{cart_id}/clear"
       req = request_params({currency: @currency, locale: @locale}.merge(params))
@@ -58,59 +80,92 @@ module BlommingApi
       end  
     end
 
-    def carts_checkout(order, params={})
-      url = api_url '/carts/checkout'
+    #
+    # Returns countries to which this Cart can be shipped to.
+    #
+    def carts_shipping_countries(cart_id, params={})
+      url = api_url "/carts/#{cart_id}/shipping_countries"
       req = request_params({currency: @currency, locale: @locale}.merge(params))
-      load = MultiJson.dump order
-      
-      feed_or_retry do
-        # POST with raw JSON payloads ?
-        RestClient.post url, load, req
-      end  
-    end
 
-    def carts_place_paypal_order(paypal_order, params={})
-      url = api_url '/carts/place_paypal_order'
-      req = request_params({currency: @currency, locale: @locale}.merge(params))
-      load = MultiJson.dump paypal_order
-      
       feed_or_retry do
-        RestClient.post url, load, req
+        RestClient.get url, req
       end  
     end
 
+    #
+    # order_example = {
+    #  ship_to_first_name: "Andrea",
+    #  ship_to_last_name: "Salicetti",
+    #  ship_to_address: "via%20Teodosio%2065",
+    #  ship_to_postal_code: 20100,
+    #  ship_to_city: "Milano",
+    #  ship_to_province: "MI",
+    #  ship_to_country: "Italy",
+    #  bill_is_ship: "false",
+    #  bill_to_first_name: "Nicola%20Junior",
+    #  bill_to_last_name: "Vitto",
+    #  bill_to_address: "via%20Teodosio%2065",
+    #  bill_to_postal_code: "20100",
+    #  bill_to_city: "Milano",
+    #  bill_to_province: "MI",
+    #  bill_to_country: "Italy",
+    #  bill_to_company: "Blomming%20SpA",
+    #  bill_to_vat_number: "IT07199240966",
+    #  phone_number3: ""
+    # }
+    #
 
-    def carts_shipping_countries(params={})
-      url = api_url '/carts/shipping_countries'
-      req = request_params({currency: @currency, locale: @locale}.merge(params))
+    #
+    # Returns the Cart with the given ID, as returned from the create cart API. 
+    #
+    def carts_validate_order(cart_id, order, payment_type, params={})
+      url = api_url "/carts/#{cart_id}/validate/#{payment_type}"
+      req = request_params({order: order, currency: @currency, locale: @locale}.merge(params))
 
       feed_or_retry do
         RestClient.get url, req
       end  
     end
 
-    def carts_show(cart_id, params={})
-      url = api_url '/carts/#{cart_id}/show'
+    #
+    # Checkout of the Cart.
+    #
+    def carts_checkout_order(cart_id, order, payment_type, params={})
+      url = api_url "/carts/#{cart_id}/checkout/#{payment_type}"
       req = request_params({currency: @currency, locale: @locale}.merge(params))
 
+      # with a hash sends parameters as a urlencoded form body
+      load = {order: order, multipart: true}
+      
       feed_or_retry do
-        RestClient.get url, req
+        RestClient.post url, load, req
       end  
     end
 
-    def carts_validate(cart_id, params={})
-      url = api_url '/carts/#{cart_id}/validate'
+    #
+    # Complete a PayPal transaction
+    #
+    def carts_place_paypal_order(cart_id, order_id, paypal_token, paypal_payer_id, params={})
+      url = api_url "/carts/#{cart_id}/order/#{order_id}/place_paypal"
       req = request_params({currency: @currency, locale: @locale}.merge(params))
+      
+      # with a hash sends parameters as a urlencoded form body
+      load = {token: paypal_token, PayerID: paypal_payer_id, multipart: true}
 
       feed_or_retry do
-        RestClient.get url, req
+        RestClient.post url, load, req
       end  
     end
 
 
     #
+    # BUY
     # CATEGORIES
     #
+
+    #
+    # Returns the categories
+    #
     def categories(params={})
       url = api_url '/categories'
       req = request_params({currency: @currency, locale: @locale}.merge(params))
@@ -120,6 +175,9 @@ module BlommingApi
       end  
     end
 
+    #
+    # Returns all the Items (paged) belonging to a certain category.
+    #
     def category_items (category_id, params={})
       url = api_url "/categories/#{category_id}/items" 
       req = request_params({currency: @currency, locale: @locale}.merge(params))
@@ -130,8 +188,13 @@ module BlommingApi
     end
 
     #
+    # BUY 
     # COLLECTIONS
     #
+
+    #
+    # Returns the collections
+    #
     def collections(params={})
       url = api_url '/collections'
       req = request_params({currency: @currency, locale: @locale}.merge(params))
@@ -141,6 +204,9 @@ module BlommingApi
       end  
     end
 
+    #
+    # Returns the Items of a shop.
+    #
     def collection_items (collection_id, params={})
       url = api_url "/collections/#{collection_id}/items"
       req = request_params({currency: @currency, locale: @locale}.merge(params))
@@ -151,8 +217,13 @@ module BlommingApi
     end
 
     #
+    # BUY
     # COUNTRIES
     #
+
+    #
+    # Get the full list of the possible Countries, localized.
+    #
     def countries(params={})
       url = api_url '/countries'
       req = request_params({locale: @locale}.merge(params))
@@ -163,8 +234,13 @@ module BlommingApi
     end
 
     #
+    # BUY
     # CURRENCIES
     #
+
+    #
+    # Returns currencies accepted by Blomming
+    #
     def currencies(params={})
       url = api_url '/currencies'
       req = request_params({locale: @locale}.merge(params))
@@ -175,8 +251,13 @@ module BlommingApi
     end
     
     #
+    # BUY
     # ITEMS
     #
+
+    #
+    # Returns the “discounted” Items, as present in the home page of the web site
+    #
     def items_discounted(params={})
       url = api_url '/items/discounted'
       req = request_params({currency: @currency, locale: @locale}.merge(params))
@@ -186,6 +267,9 @@ module BlommingApi
       end  
     end
 
+    #
+    # Returns the “featured” Items, as present in the home page of the web site.
+    #
     def items_featured(params={})
       url = api_url '/items/featured'
       req = request_params({currency: @currency, locale: @locale}.merge(params))
@@ -195,6 +279,9 @@ module BlommingApi
       end     
     end
 
+    #
+    # Returns the “hand picked” Items, as present in the home page of the web site.
+    #
     def items_hand_picked(params={})
       url = api_url '/items/hand_picked'
       req = request_params({currency: @currency, locale: @locale}.merge(params))
@@ -204,6 +291,9 @@ module BlommingApi
       end   
     end
 
+    #
+    # Returns the Items with the specified ids. 
+    #
     def items_list (item_id, params={})
       url = api_url '/items/list'
       req = request_params({id: item_id, currency: @currency, locale: @locale}.merge(params))
@@ -213,6 +303,9 @@ module BlommingApi
       end  
     end
 
+    #
+    # Returns the “most_liked” Items, as present in the home page of the web site.
+    #
     def items_most_liked(params={})
       url = api_url '/items/most_liked'
       req = request_params({currency: @currency, locale: @locale}.merge(params))
@@ -222,6 +315,9 @@ module BlommingApi
       end  
     end
 
+    #
+    # Search Blomming for items that respond to a query.
+    #
     def items_search (keyword, params={})
       url = api_url '/items/search'
       req = request_params({q: keyword, currency: @currency, locale: @locale}.merge(params))
@@ -232,8 +328,13 @@ module BlommingApi
     end
 
     #
+    # BUY
     # MACROCATEGORIES
     #
+
+    #
+    # Returns the Macrocategories
+    #
     def macrocategories(params={})
       url = api_url '/macrocategories'
       req = request_params({locale: @locale}.merge(params))
@@ -243,6 +344,9 @@ module BlommingApi
       end  
     end
 
+    #
+    # Returns the Categories included in the given Macrocategory.
+    #
     def macrocategory_categories (macrocategory_id​, params={})
       url = api_url "/macrocategories​/:macrocategory_id​/categories" 
       req = request_params({locale: @locale}.merge(params))
@@ -252,6 +356,9 @@ module BlommingApi
       end    
     end
 
+    #
+    # Returns the Items inside a Macrocategory.
+    #
     def macrocategory_items (macrocategory_id​, params={})
       url = api_url "/macrocategories​/:macrocategory_id​/items" 
       req = request_params({locale: @locale}.merge(params))
@@ -263,8 +370,15 @@ module BlommingApi
 
 
     #
+    # BUY
     # PASSWORD_RESETS
     #
+
+    #
+    # Perform a password reset request to Blomming.
+    # If it does succeed, an email is sent to the user 
+    # with the link to renew his passowrd for Blomming.
+    #
     def password_resets (email_of_user, params={})
       url = api_url "/password_resets"    
       
@@ -276,8 +390,13 @@ module BlommingApi
 
 
     #
+    # BUY
     # PROVINCES
     #
+
+    #
+    # Retruns the provinces list for a given Country.
+    #
     def provinces (province_country_code, params={})
       url = api_url "/provinces/#{province_country_code}"    
       
@@ -287,8 +406,13 @@ module BlommingApi
     end
 
     #
+    # BUY
     # SHOPS
     #
+
+    #
+    # Returns the Shops list
+    #
     def shops (params={})
       url = api_url '/shops'
       
@@ -297,6 +421,11 @@ module BlommingApi
       end  
     end
 
+    #
+    # Returns the Items of a Shop. 
+    # :shop_id is the Shop id (the User’s login owner of the Shop) 
+    # as returned from the /shops endpoint.
+    #
     def shop_items (shop_id, params={})
       url = api_url "/shops/#{shop_id}/items"
       
@@ -308,6 +437,9 @@ module BlommingApi
       data
     end
 
+    #
+    # Returns the details of an Item.
+    #
     def shop_item (shop_id, item_id, params={})
       url = api_url "/shops/#{shop_id}/items/#{item_id}"
       
@@ -316,6 +448,11 @@ module BlommingApi
       end  
     end
 
+    #
+    # Get the details of a single Shop. 
+    # :id is the Shop id (the User’s login owner of the Shop) 
+    # as returned from the /shops endpoint.
+    #
     def shops_find (shop_id, params={})
       url = api_url "/shops/#{shop_id}"
       
@@ -325,8 +462,13 @@ module BlommingApi
     end
 
     #
+    # BUY 
     # TAGS
     #
+
+    #
+    # Retrieve the tags.
+    #
     def tags (params={})
       url = api_url "/tags"
       
@@ -335,6 +477,9 @@ module BlommingApi
       end  
     end
 
+    #
+    # Returns the Items with a specific tag.
+    #
     def tags_items (tag_id, params={})
       url = api_url "/tags/#{tag_id}/items"
       

data/lib/blomming_api/help.rb

@@ -16,7 +16,8 @@ module BlommingApi
   end
 
   def BlommingApi::endpoints_help
-    puts "BUY endpoints available methods:\n\n"
+    puts "BUY ENDPOINTS METHODS"
+    puts "=====================\n"
 
     buy_endpoints_methods = BlommingApi::BuyEndpoints.instance_methods(false)
     
@@ -24,7 +25,8 @@ module BlommingApi
       display_method_info method_name
     end 
 
-    puts "SELL endpoints available methods:\n\n"
+    puts "SELL ENDPOINTS METHODS"
+    puts "======================\n"
 
     sell_endpoints_methods = BlommingApi::SellEndpoints.instance_methods(false)
     
@@ -43,7 +45,7 @@ module BlommingApi
     method_def = method_source.split("\n").first.strip[/def (?<match>.*)/,"match"]
     location = BlommingApi::Client.instance_method(method_name.to_sym).source_location
 
-    puts "#{method_comment}"
+    puts "\n#{method_comment}"
     puts "\t#{method_def}"
     puts "\tfile: #{location.first}"
     puts "\tline: #{location.last}"

data/lib/blomming_api/sell_endpoints.rb

@@ -6,8 +6,13 @@ module BlommingApi
   module SellEndpoints
 
     #
+    # SELL
     # PAYMENT_TYPES
     #
+
+    #
+    # Get the current Payment Type
+    #
     def sell_payment_types_find (params={})
       url = api_url "/sell/payment_types​/user_list"
       req = request_params(params)
@@ -17,9 +22,12 @@ module BlommingApi
       end  
     end
 
-    def sell_payment_types_create (payload, params={})
+    #
+    # Create a new Payment Type
+    #
+    def sell_payment_types_create (email, params={})
       url = api_url "/sell/payment_types​/new"
-      load = MultiJson.dump payload
+      load = MultiJson.dump email: email
       req = request_params(params)
 
       feed_or_retry do
@@ -27,9 +35,12 @@ module BlommingApi
       end  
     end
 
-    def sell_payment_types_update (id, payload, params={})
-      url = api_url "/sell/payment_types​/#{id}"
-      load = MultiJson.dump payload
+    #
+    # Edit a Payment Type
+    #
+    def sell_payment_types_update (payment_type_id, email, params={})
+      url = api_url "/sell/payment_types​/#{payment_type_id}"
+      load = MultiJson.dump email: email
       req = request_params(params)
 
       feed_or_retry do
@@ -37,8 +48,11 @@ module BlommingApi
       end  
     end
 
-    def sell_payment_types_delete (id, params={})
-      url = api_url "/sell/payment_types​/#{id}"
+    #
+    # Delete a Payment Type
+    #
+    def sell_payment_types_delete (payment_type_id, params={})
+      url = api_url "/sell/payment_types​/#{payment_type_id}"
       req = request_params(params)
 
       feed_or_retry do
@@ -47,8 +61,13 @@ module BlommingApi
     end
 
     #
+    # SELL
     # REGISTER
     #
+
+    #
+    # Register a new account to blomming 
+    #
     def sell_register (payload, params={})
       url = api_url "/sell/register"
       load = MultiJson.dump payload
@@ -60,11 +79,16 @@ module BlommingApi
     end
 
     #
+    # SELL
     # SHIPPING_COUNTRIES
     #
+
+    #
+    # Get the full list of the possible Countries
+    # for the shipping profile, localized.
+    #
     def sell_shipping_countries_all (params={})
-      url = api_url "/sell/shipping_countries​​/all"
-      req = request_params({locale: @locale}.merge(params))
+     req = request_params({locale: @locale}.merge(params))
 
       feed_or_retry do
         RestClient.get url, req
@@ -72,9 +96,13 @@ module BlommingApi
     end
 
     #
+    # SELL
     # SHIPPING_PROFILES
     #
- 
+
+    #
+    # Get all the shipping profiles associated to the user
+    # 
     def sell_shipping_profiles (params={})
       url = api_url "/sell/shipping_profiles"
       req = request_params(params)
@@ -84,6 +112,9 @@ module BlommingApi
       end
     end
 
+    #
+    # Create a new Shipping Profile
+    # 
     def sell_shipping_profile_create (payload, params={})
       url = api_url "/sell/shipping_profiles"
       load = MultiJson.dump payload
@@ -94,19 +125,10 @@ module BlommingApi
       end  
     end
 
-=begin
-    def sell_shipping_profile_update (payload, params={})
-      url = api_url "/sell/shipping_profiles"
-      load = MultiJson.dump payload
-      req = request_params(params)
-
-      feed_or_retry do
-        RestClient.put url, load, req 
-      end  
-    end
-=end
-
-    def sell_shipping_profile_update (payload, params={})
+    #
+    # Edit a Shipping Profile
+    #
+    def sell_shipping_profile_update (id, payload, params={})
       url = api_url "/sell/shipping_profiles/#{id}"
       load = MultiJson.dump payload
       req = request_params(params)
@@ -116,8 +138,11 @@ module BlommingApi
       end  
     end
 
+    #
+    # Delete a Shipping Profile
+    #
     def sell_shipping_profile_delete (id, params={})
-      url = api_url "/sell/payment_types​/#{id}"
+      url = api_url "/sell/shipping_profiles/#{id}"
       req = request_params(params)
 
       feed_or_retry do
@@ -125,8 +150,11 @@ module BlommingApi
       end  
     end
 
+    #
+    # Get the shipping profile that has the id given
+    #
     def sell_shipping_profile_find (id, params={})
-      url = api_url "/sell/payment_types​/#{id}"
+      url = api_url "/sell/shipping_profiles/#{id}"
       req = request_params(params)
 
       feed_or_retry do
@@ -134,6 +162,9 @@ module BlommingApi
       end  
     end
 
+    #
+    # Create a Shipping Profile and assign it to an Item
+    #
     def sell_shipping_profile_item_create (payload, item_id, params={})
       url = api_url "/sell/shipping_profiles/items​/#{item_id}"
       load = MultiJson.dump payload
@@ -146,8 +177,14 @@ module BlommingApi
 
 
     #
+    # SELL
     # SHIPPING_REGIONS
     #
+
+    #
+    # Get the full list of the possible Regions 
+    # for the shipping profile, localized.
+    # 
     def sell_shipping_regions (params={})
       url = api_url "/sell/shipping_regions​/all"
       req = request_params({locale: @locale}.merge(params))
@@ -158,8 +195,14 @@ module BlommingApi
     end
 
     #
+    # SELL
     # SHOP_DASHBOARD
     #
+
+    #
+    # Get shop dashboard details, 
+    # that are products count, orders count and total revenue
+    #
     def sell_shop_dashboard (params={})
       url = api_url "/sell/shop/dashboard"
       req = request_params({locale: @locale}.merge(params))
@@ -170,8 +213,14 @@ module BlommingApi
     end
 
     #
+    # SELL
     # SHOP_ITEMS
     #
+
+    #
+    # Returns an ordered, paginated list of all the items 
+    # (pubished or not) present on a given shop.
+    #
     def sell_shop_items (params={})
       url = api_url '/sell/shop/items'
       req = request_params(params)
@@ -181,6 +230,9 @@ module BlommingApi
       end  
     end
 
+    #
+    # Create a new shop item
+    #
     def sell_shop_item_create (payload, params={})
       url = api_url '/sell/shop/items/new'
       load = MultiJson.dump payload
@@ -191,6 +243,9 @@ module BlommingApi
       end  
     end
 
+    #
+    # Returns one of shop products’ details
+    #
     def sell_shop_item_find (item_id, params={})
       url = api_url "/sell/shop/items/#{item_id}"
       req = request_params(params)
@@ -200,6 +255,9 @@ module BlommingApi
       end  
     end
 
+    #
+    # Update some of the properties of the Item
+    #
     def sell_shop_item_update (item_id, payload, params={})
       url = api_url "/sell/shop/items/#{item_id}"
       load = MultiJson.dump payload
@@ -210,6 +268,9 @@ module BlommingApi
       end    
     end
 
+    #
+    # Delete an item given an id
+    #
     def sell_shop_item_delete (item_id, params={})
       url = api_url "/sell/shop/items/#{item_id}"
       req = request_params(params)
@@ -219,35 +280,113 @@ module BlommingApi
       end  
     end
 
-    def sell_shop_item_tags_add(*tags, item_id, params)
+    #
+    # Add one or more Tag to an Item.
+    #
+    def sell_shop_item_tags_add(item_id, *tags, params)
       url = api_url "/sell/shop/items/#{item_id}/add_tags"
+      load = {tag_list: tags.join(','), multipart: true}
       req = request_params({currency: @currency, locale: @locale}.merge(params))
       
-      # with a hash sends parameters as a urlencoded form body
-      load = {:tags => tags.join(','), :multipart => true}
-
       feed_or_retry do
         RestClient.post url, load, req
       end  
     end
 
-    def sell_shop_item_tags_remove(*tags, item_id, params)
+    #
+    # Remove one or more Tag to an Item.
+    #
+    def sell_shop_item_tags_remove(item_id, *tags, params)
       url = api_url "/sell/shop/items/#{item_id}/remove_tag"
       req = request_params({currency: @currency, locale: @locale}.merge(params))
       
       # with a hash sends parameters as a urlencoded form body
-      load = {:tags => tags.join(','), :multipart => true}
+      load = {tag: tags.join(','), multipart: true}
 
       feed_or_retry do
         RestClient.post url, load, req
       end  
     end    
 
+    #
+    # SELL
+    # SHOP_SECTIONS
+    #
 
+    #
+    # Return all sections of current shop
+    #
+    def sell_shop_sections (params={})
+      url = api_url "/sell/shop/sections"
+      req = request_params(params)
 
+      feed_or_retry do
+        RestClient.get url, req
+      end  
+    end
+  
+    #
+    # Creates a new section for current shop
     #
+    def sell_shop_section_create (section_name, params={})
+      url = api_url "/sell/shop/sections"
+      req = request_params(params)
+      load = MultiJson.dump name: section_name
+
+      feed_or_retry do
+        RestClient.post url, load, req
+      end  
+    end
+
+    #
+    # Update the section name from a given section_id of the current shop
+    #
+    def sell_shop_section_update (section_id, section_name, params={})
+      url = api_url "/sell/shop/sections/#{section_id}"
+      req = request_params(params)
+      load = MultiJson.dump name: section_name
+
+      feed_or_retry do
+        RestClient.put url, load, req
+      end  
+    end
+
+    #
+    # Delete a section with a given section_id of the current shop
+    # 
+    def sell_shop_section_delete (section_id, params={})
+      url = api_url "/sell/shop/sections/#{section_id}"
+      req = request_params(params)
+
+      feed_or_retry do
+        RestClient.delete url, req
+      end  
+    end
+
+    #
+    # Returns an ordered, paginated list of all the items (pubished or not) 
+    # present on a given shop section.
+    #
+    def sell_shop_section_items (section_id, params={})
+      url = api_url "/sell/shop/sections/#{section_id}/items"
+      req = request_params(params)
+
+      feed_or_retry do
+        RestClient.get url, req
+      end  
+    end
+
+    #
+    # SELL
     # SHOP_ORDERS
     #
+
+    #
+    # Returns the valid order states 
+    # (for filtering purpose on API Orders requests).
+    # This is a dictionary endpoint: it should never change 
+    # and its response body may be long cached on API clients
+    #
     def sell_shop_orders_states (params={})
       url = api_url "/sell/shop/orders/states"
       req = request_params(params)
@@ -257,6 +396,9 @@ module BlommingApi
       end  
     end
 
+    #
+    # Returns a collection of orders received by the shop
+    #
     def sell_shop_orders (order_status, params={})
       url = api_url "/sell/shop/orders"
       req = request_params({ order_status: order_status, currency: @currency, locale: @locale}.merge(params))
@@ -266,6 +408,9 @@ module BlommingApi
       end  
     end
 
+    #
+    # Returns the details for the specific Order (uniquely identified by :order_number)
+    #
     def sell_shop_orders_find (order_number, params={})
       url = api_url "/sell/shop/orders/#{order_number}"
       req = request_params(params)
@@ -275,31 +420,41 @@ module BlommingApi
       end  
     end
 
+    #
+    # Cause a transaction in the Order state 
+    # to the new state specified by state request param.
+    #
     def sell_shop_orders_change_state (order_number, state, params={})
       url = api_url "/sell/shop/orders/#{order_number}/change_state"
       req = request_params({state: state}.merge(params))
 
       feed_or_retry do
-        # POST with a hash sends parameters as a urlencoded form body
         RestClient.post url, req
       end  
     end
 
-
+    #
+    # Foreward an Order cancellation request to Blomming staff.
+    # The request parameter set MUST be passed into the request Body as a JSON object.
+    #
     def sell_shop_orders_request_cancellation (order_number, reason_string, params={})
       url = api_url "/sell/shop/orders/#{order_number}/request_cancellation"
       req = request_params(params)
       load = MultiJson.dump reason: reason_string
 
       feed_or_retry do
-        # POST with raw payloads
         RestClient.post url, load, req
       end  
     end
 
     #
+    # SELL
     # SHOP_SHIPPING_PROFILES
     #
+
+    #
+    # Returns all the shipping profiles of the shop.
+    #
     def sell_shop_shipping_profiles (params={})
       url = api_url "/sell/shop/shipping_profiles"
       req = request_params({locale: @locale}.merge(params))
@@ -310,8 +465,13 @@ module BlommingApi
     end
 
     #
+    # SELL
     # SHOP_USER_DETAILS
     #
+
+    # 
+    # Get details about current user and his shop.
+    #
     def sell_shop_user_details (params={})
       url = api_url "/sell/shop/user_details"
       req = request_params({locale: @locale}.merge(params))

data/lib/blomming_api/version.rb

@@ -1,3 +1,3 @@
 module BlommingApi
-  VERSION = "0.4.6"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blomming_api
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.5.0
 platform: ruby
 authors:
 - Giorgio Robino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-14 00:00:00.000000000 Z
+date: 2014-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source