blomming_api 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c2456b1f3eb51b26cc2aae945cef36703ca9db8
-  data.tar.gz: e1e42675078f500ce983a3693b8d956101fa208d
+  metadata.gz: 40ff555448ed2878816e332e6317be02736c8687
+  data.tar.gz: 65c583d94cc89a3bc7e132dbad16ad3b119b2bb4
 SHA512:
-  metadata.gz: 33ead1f763c3de18beae8866d348f52afe2651c7fc70817e87c97df7445459a42551c185ad02c0227e76457e0b06e79ea6fff0e45cd62cfcd12d0566a7788764
-  data.tar.gz: 8b5f3d687c512039f06cb3b462097ad24f5c2af0670dbae0cdb305434b5185b23866761eb93cd50e167b7dfdf1dbfd0863f55a870ebebdf1ead0fbff2463bce1
+  metadata.gz: b290a3bc6cd3febbcbad37da51a414c44460fb226b18cb242d977a482735b4a48663aec300beb1637944b21a727aa827672c284d5e051069b9dc3e98b1a336b8
+  data.tar.gz: e1b55e7819b70ff46867d89638825e58263bdf5822c54cbbc181e27f60c9ed1c58f3ea6c31b091d53b9cc80aa3ff2afa1031a90774b663ceec5b1c2bf120f49c

data/lib/blomming_api/private_helpers.rb

@@ -19,7 +19,23 @@ module BlommingApi
     end
 
     #
-    # private helper: manage RestClient exceptions. iterator.  
+    # load_or_retry: manage RestClient exceptions. iterator.
+    #
+    # === attributes
+    #
+    #  retry_seconds
+    #  number of seconds between a call and the successivem in case of a retry
+    #
+    #  &restclient_call_block
+    #  the block to be passed (containing call to RestCient method)
+    #
+    # === examples
+    #
+    #  load_or_retry { RestClient.get url, req }
+    #
+    #  load_or_retry(5) do 
+    #     RestClient.get url, req
+    #  end
     #
     def load_or_retry (retry_seconds=2, &restclient_call_block)
       begin    

data/lib/blomming_api/public_helpers.rb

@@ -8,12 +8,25 @@ module BlommingApi
     #
     # all_pages 
     # It's a Ruby block iterator that retrieve all items of all pages of any API endpoint.
-    # Usage example:
-    # all_pages { |page, per_page| 
+    # 
+    # === attributes
+    #
+    # +verbose+: :quite (silent mode)  
+    #            :stdout (verbose mode: stdout puts)
+    #
+    # +per_page+: :number of items returned from a single page  
+    #
+    #
+    # === examples
+    #
+    # all_pages(:stdout, 64) do |page, per_page| 
     #   client.shop_items(shop_id, {:page => page, :per_page => per_page}) 
-    # } 
+    # end 
+    # 
+    # all_pages { |page, per_page| c.sell_shop_items page: page, per_page: per_page } 
+    # 
     #
-    def all_pages (verbose=:stdout, per_page=16, &endpoint_call_block)
+    def all_pages (verbose=:quite, per_page=16, &endpoint_call_block)
       page = 1
       data = []
 

data/lib/blomming_api/version.rb

@@ -1,3 +1,3 @@
 module BlommingApi
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blomming_api
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Giorgio Robino