blomming_api 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40ff555448ed2878816e332e6317be02736c8687
-  data.tar.gz: 65c583d94cc89a3bc7e132dbad16ad3b119b2bb4
+  metadata.gz: 9c07beb77f338aba29431d8118ddd2c0ce5af7ad
+  data.tar.gz: 46c94be3f7d4c553293f309be85a0f637ec537a8
 SHA512:
-  metadata.gz: b290a3bc6cd3febbcbad37da51a414c44460fb226b18cb242d977a482735b4a48663aec300beb1637944b21a727aa827672c284d5e051069b9dc3e98b1a336b8
-  data.tar.gz: e1b55e7819b70ff46867d89638825e58263bdf5822c54cbbc181e27f60c9ed1c58f3ea6c31b091d53b9cc80aa3ff2afa1031a90774b663ceec5b1c2bf120f49c
+  metadata.gz: 8326c6580d05a960713a57c609396b69ab3e82578ac9c9d9b22fb88d40e059c83551b2d6e988381565cb505c0f7ff634229296128e177adc1dbfabf79a081916
+  data.tar.gz: edeeabbc466db4d3edacb3fce714811f3c6f3dfc4562ff312a6e54828ea1e38fbef4b99158010610c1becb57c6490047583bcbf7f02f60d98aaf208f2e03512f

data/lib/blomming_api.rb

@@ -41,6 +41,15 @@ module BlommingApi
   	# instance variables, read/write
     attr_accessor :currency, :locale, :verbose
 
+    # integer:
+    # number of seconds between a call and the successive 
+    # in case of a retry of an API call
+    attr_reader :retry_seconds
+
+    # boolean:
+    # if false, in case of exceptions, process die with exit
+    attr_reader :survive_on_fatal_error
+
     # new
     def initialize(config_filename)
       # read YAML configuration file

data/lib/blomming_api/config.rb

@@ -51,26 +51,39 @@ module BlommingApi
       @currency = config['default_currency']
       @locale = config['default_locale']
 
+
+      # assign default value: 2, 
+      # if parameter is not set in config file
+      @retry_seconds = config['retry_seconds']
+      @retry_seconds = 2 if @retry_seconds.nil?
+
+      # assign default value: false, 
+      # if parameter is not set in config file
+      @survive_on_fatal_error = config['survive_on_fatal_error']
+      @survive_on_fatal_error = false if @survive_on_fatal_error.nil?
+
       # other behaviours
       @verbose = config['verbose']
       @verbose_access_token = @verbose
+
       puts to_s(config_filename) if @verbose
     end
     private :read_config_file
 
-    def show_config_file (config_file)
-      "config file: #{config_file}\n\n" + 
-      "\tdescription: #@description\n" +   
-      "\tservices: #@services\n" + 
-      "\tusername: #@username\n"  +
-      "\tpassword: #@password\n" + 
-      "\tclient_id: #@client_id\n" + 
-      "\tclient_secret: #@client_secret\n" + 
-      "\tdomain: #@domain\n" +
-      "\tdefault_currency: #@currency\n" + 
-      "\tdefault_locale: #@locale\n\n" 
+    def show_config_file_attributes
+      "\n           description: #@description\n" +   
+      "              services: #@services\n" + 
+      "              username: #@username\n"  +
+      "              password: #@password\n" + 
+      "             client_id: #@client_id\n" + 
+      "         client_secret: #@client_secret\n" + 
+      "                domain: #@domain\n" +
+      "      default_currency: #@currency\n" + 
+      "        default_locale: #@locale\n" +
+      "survive_on_fatal_error: #@survive_on_fatal_error\n"  +
+      "         retry_seconds: #@retry_seconds\n\n"  
     end
-    public :show_config_file
+    public :show_config_file_attributes
 
   end
 end

data/lib/blomming_api/private_helpers.rb

@@ -7,7 +7,7 @@ module BlommingApi
     # build complete URL of any API request endpoint URI 
     #
     def api_url (api_endpoint_uri) 
-	  "#{@domain}#{@api_version}#{api_endpoint_uri}"
+	    "#{@domain}#{@api_version}#{api_endpoint_uri}"
     end  
 
   	#
@@ -15,17 +15,30 @@ module BlommingApi
     # embedding authentication token and all optional parameters
     # 
     def request_params(params={})
-	  { authorization: "Bearer #{@access_token}", params: params }
+	    { authorization: "Bearer #{@access_token}", params: params }
     end
 
     #
-    # load_or_retry: manage RestClient exceptions. iterator.
+    # load_or_retry:
+    # 
+    # 1. call RestClient verb, 
+    #    passed in a block (load_or_retry is an iterator)
     #
-    # === attributes
+    # 2. without any exception (http errors): 
+    #    return data (convert response data from JSON to Ruby Hash)
     #
-    #  retry_seconds
-    #  number of seconds between a call and the successivem in case of a retry
+    # 2. in case of exceptions: 
+    #    manage connection/RestClient exceptions 
+    #    (by example retry the API call in case of authentication token expired). 
+    #    
+    #    In case of fatal error: 
+    #      if @survive_on_fatal_error if false (default) 
+    #         process die with exit  
+    #      if @survive_on_fatal_error if true (must be specified in config file) 
+    #         load_or_retry return value: nil (no data returned!).  
     #
+    # === arguments
+    #  
     #  &restclient_call_block
     #  the block to be passed (containing call to RestCient method)
     #
@@ -33,62 +46,100 @@ module BlommingApi
     #
     #  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    
+    def load_or_retry (&restclient_call_block)
+      begin
+        # call RestClient verb
         json_data = restclient_call_block.call 
 
-        # IP connection error, wrong url, etc.
-        rescue SocketError => e
-          STDERR.puts "#{Time.now}: socket error: #{e}. Possible net connection problems. Retry in #{retry_seconds} seconds."
-          sleep retry_seconds
-          retry
-
-        # restclient exceptions
-        rescue => e
+      # IP connection error, wrong url
+      rescue SocketError => e
+        socket_error! e
+        retry
 
-        # 
-        # HTTP status code manager
-        #
-        if 401 == e.response.code
-          # Client authentication failed due to unknown client, no client authentication included, 
-          # or unsupported authentication method
-          # After your bearer token has expired, each request done with that stale token will return an HTTP code 401
-          STDERR.puts "#{Time.now}:  restclient error. http status code: #{e.response.code}: #{e.response.body}. Invalid or expired token. Retry in #{retry_seconds} seconds."
+      # RestClient exceptions, manage HTTP status code
+      rescue => e
 
-          # opinabile mettere la sleep qui, ma meglio per evitare loop stretto
-          sleep retry_seconds
-
-          # richiede il token daccapo. da rivedere.
-          authenticate :refresh
+        if http_status_code_401? e
+          authenticate_refresh e
           retry
 
-        elsif 404 == e.response.code
-          STDERR.puts "#{Time.now}: restclient error. http status code: #{e.response.code}: #{e.response.body}. Exit."
-          exit
+        elsif http_status_code_404? e
+          return fatal_error! e
 
-        # Invalid or blank request body given (selll services endpoints)
-        elsif 422 == e.response.code
-          STDERR.puts "#{Time.now}: restclient error. http status code: #{e.response.code}: #{e.response.body}. Exit."
-          exit
+        elsif http_status_code_422? e 
+          return fatal_error! e
 
-        elsif [500, 520].include? e.response.code
-          STDERR.puts "#{Time.now}: restclient error. http status code: #{e.response.code}: #{e.response.body}. Retry in #{retry_seconds} seconds."
-          sleep retry_seconds
-          retry
+        elsif http_status_code_5xx? e 
+          return fatal_error! e
 
+        # any other exception
         else
-          STDERR.puts "#{Time.now}: restclient error. http status code: #{e.response.code}: #{e.response.body}. Exit."
-          exit
+          return fatal_error! e
         end
       end
 
-      # HTTP status 200: return data (json to hash)
+      # HTTP status 200: return data (hash from JSON)!
       MultiJson.load json_data
     end
 
+
+    # Client authentication failed due to unknown client, 
+    # no client authentication included, 
+    # or unsupported authentication method
+    # After your bearer token has expired, 
+    # each request done with that stale token will return an HTTP code 401
+    def http_status_code_401?(e)
+      401 == e.response.code 
+    end  
+
+    def http_status_code_404?(e)
+      404 == e.response.code 
+    end  
+
+    # Invalid or blank request body given (sell services endpoints)
+    def http_status_code_422?(e)
+      422 == e.response.code 
+    end  
+
+    def http_status_code_5xx?(e)
+      [500, 520].include? e.response.code 
+    end  
+
+    #
+    # Errors managers
+    #
+    def authenticate_refresh(e)
+      STDERR.puts "#{Time.now}:  restclient error. http status code: #{e.response.code}: #{e.response.body}. Invalid or expired token. Retry in #{retry_seconds} seconds."
+
+      # sleep maybe useless here
+      sleep @retry_seconds
+
+      # authenticate with refresh token
+      authenticate :refresh
+    end
+
+
+    def socket_error!(e)
+      STDERR.puts "#{Time.now}: socket error: #{e}. Possible net connection problems. Retry in #{retry_seconds} seconds."
+      
+      sleep @retry_seconds
+    end
+
+
+    def fatal_error!(e)
+      STDERR.puts "#{Time.now}: restclient error. http status code: #{e.response.code}: #{e.response.body}. Exit."
+      
+      #
+      # survive_on_fatal_error initialized in config file  
+      #
+      unless @survive_on_fatal_error
+        # Process die!
+        exit
+      else
+        # no data!
+        return nil
+      end    
+    end
+
   end
 end

data/lib/blomming_api/public_helpers.rb

@@ -9,7 +9,7 @@ module BlommingApi
     # all_pages 
     # It's a Ruby block iterator that retrieve all items of all pages of any API endpoint.
     # 
-    # === attributes
+    # === arguments
     #
     # +verbose+: :quite (silent mode)  
     #            :stdout (verbose mode: stdout puts)

data/lib/blomming_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blomming_api
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Giorgio Robino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-05 00:00:00.000000000 Z
+date: 2014-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -140,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: www.blomming.com social commerce API's wrapper