sentofu 0.5.0 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc1b63ccb50a7452fa826049c091e5f0cd989f2060ec670b91352601eea74ef1
-  data.tar.gz: 2edb5a28019ceb9de9081851e60b183e0fdaa03ee057340749bd40e7c1df632c
+  metadata.gz: a22c27c7dbd12ccf93283de4c58bb65497a17638d013929ad1557a91c1dfac2b
+  data.tar.gz: 037d542183584b6ced637afafbae8fc98febf971413dc5846fbff6fbbd44cad5
 SHA512:
-  metadata.gz: 6da37664e8512e07d13780af65fe4470389b71a1f5cf902a00a17d7b55b91eebea56a73a85b59428d7159490ba0a7ffd057185e8d1b0355ae0fe3250579627f0
-  data.tar.gz: 0ad3181e2d696bb627025f4de4fa61a4903260c83872239d693a5cb27669680b4e600d63dfeb5977ba663e7ca276125e9414fb7c824998c617a0a4b3f3eb9841
+  metadata.gz: 23f8ed539f585372700227f4f42b947166d55f47b80ad180fb08e6ccc7eeeb1dd0a2e1031b1dea9915b8583b79ee63b7380e113c090d93b95c1910804bea7a23
+  data.tar.gz: e6526c9c327d68c8b27e0b8ad8b1c7bd02d8a8a66c9f7cd5936622a342efcd8bc7733df572ee0c4229530fed8480062f876f3796249032f15d068032fc2e60d4

data/CHANGELOG.md

@@ -2,6 +2,32 @@
 # CHANGELOG.md
 
 
+## sentofu 0.5.5  released 2020-09-25
+
+* Report _uri and _proxy along _headers in response
+
+
+## sentofu 0.5.4  released 2020-06-03
+
+* Prevent failure on missing GET parameters list
+
+
+## sentofu 0.5.3  released 2019-11-07
+
+* Tighten request error interception
+
+
+## sentofu 0.5.2  released 2019-09-27
+
+* Tighten request error interception
+
+
+## sentofu 0.5.1  released 2019-09-10
+
+* Keep track of :_headers in result hashes
+* Revise error handling
+
+
 ## sentofu 0.5.0  released 2019-08-02
 
 * Introduce Sentofu.ssl_verify_mode attr accessor

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2019-2019, John Mettraux, jmettraux+flor@gmail.com
+Copyright (c) 2019-2020, John Mettraux, jmettraux@gmail.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Makefile

@@ -31,7 +31,7 @@ build: gemspec_validate
 	mv $(NAME)-$(VERSION).gem pkg/
 
 push: build
-	gem push pkg/$(NAME)-$(VERSION).gem
+	gem push --otp "$(OTP)" pkg/$(NAME)-$(VERSION).gem
 
 spec:
 	bundle exec rspec

data/lib/sentofu.rb

@@ -15,7 +15,7 @@ require 'sentofu/explo'
 
 module Sentofu
 
-  VERSION = '0.5.0'
+  VERSION = '0.5.5'
 
   USER_AGENT =
     "Sentofu #{Sentofu::VERSION} - " +

data/lib/sentofu/api.rb

@@ -102,7 +102,7 @@ module Sentofu
             end
           h }
 
-      point['get']['parameters']
+      (point['get']['parameters'] || [])
         .each { |par|
 
           next if par['in'] != 'query'
@@ -146,7 +146,15 @@ module Sentofu
 
     def initialize(name, spec)
 
-      super(nil, spec['servers'].first['url'])
+      u = spec['servers'].first['url'] rescue nil
+      unless u.is_a?(String) && u.match?(/\Ahttps?:\/\//)
+#p name; pp spec; p u
+        c = spec['code'] rescue -1
+        m = spec['message'] rescue '(no message)'
+        fail "cannot setup #{name.inspect} API - HTTP #{c} - #{m.inspect}"
+      end
+
+      super(nil, u)
 
       @name = name
       @spec = spec

data/lib/sentofu/explo.rb

@@ -33,10 +33,19 @@ module Sentofu
       puts
 
       list_apis.each do |h|
-        n = h['n']; n = "auth" if n.match(/auth/i)
+
+        n =
+          case nn = h['n']
+          when /auth/i then 'auth'
+          when /ESG Score API/ then 'escore'
+          else nn
+          end
+
         fn = "api_#{n}_#{h['v']}.yaml"
+
         res = Sentofu::Http.get(h['u'] + '/swagger.yaml')
         File.open(fn, 'wb') { |f| f.write(res.body) }
+
         puts "  wrote #{fn}"
       end
     end

data/lib/sentofu/http.rb

@@ -66,12 +66,20 @@ module Sentofu
         t0 = monow
 
         http = make_net_http(u)
-#t.set_debug_output($stdout) if u.to_s.match(/search/)
+#t.set_debug_output($stdout) if u.to_s.match?(/search/)
 
         res = http.request(req)
 
-        class << res; attr_accessor :_elapsed; end
+        class << res
+          attr_accessor :_uri, :_elapsed, :_proxy
+          def _headers; each_header.inject({}) { |h, (k, v)| h[k] = v; h }; end
+        end
+        res._uri = uri.to_s
         res._elapsed = monow - t0
+        res._proxy = detail_proxy(http)
+
+        fail "request returned a #{res.class} and not a Net::HTTPResponse" \
+          unless res.is_a?(Net::HTTPResponse)
 
         res
       end
@@ -79,21 +87,27 @@ module Sentofu
       def get_and_parse(uri, token=nil)
 
         res = get(uri, token)
-        r = JSON.parse(res.body)
-        r[:_elapsed] = res._elapsed
-
-        r
-
-      rescue JSON::ParserError => pe
 
-        h = {}
-        h[:code] = res.code.to_i
-        h[:message] = WEBrick::HTTPStatus.reason_phrase(res.code)
-        h[:error_class] = pe.class.to_s
-        h[:error_message] = pe.message
-        h[:body] = res.body unless res.body.index('</html>')
-
-        h
+        fail 'something went wrong' \
+          unless res.header['content-type'].match?(/^application\/json(;|$)/)
+
+        JSON.parse(res.body)
+          .merge!(
+            _uri: res._uri,
+            _headers: res._headers,
+            _elapsed: res._elapsed,
+            _proxy: res._proxy)
+
+      rescue => err
+
+        { uri: uri,
+          code: (res.code.to_i rescue nil),
+          headers: (res._headers rescue nil),
+          message: (WEBrick::HTTPStatus.reason_phrase(res.code) rescue nil),
+          error_class: err.class.to_s,
+          error_message: err.message,
+          error_trace: err.backtrace,
+          body: ((res.body.index('</html>') ? '<html>' : res.body) rescue nil) }
       end
 
       protected
@@ -129,6 +143,17 @@ module Sentofu
 
         OpenStruct.new(YAML.load(File.read(fname)))
       end
+
+      def detail_proxy(http)
+
+        if http.proxy_address
+          { address: http.proxy_address,
+            port: http.proxy_port,
+            user: http.proxy_user }
+        else
+          nil
+        end
+      end
     end
   end
 
@@ -138,7 +163,19 @@ module Sentofu
 
       @h = JSON.parse(res.body)
       @h[:_elapsed] = res._elapsed
-      @expires_at = Time.now + @h['expires_in']
+      @h[:_proxy] = res._proxy
+
+      @expires_at = @h['expires_in'] ? Time.now + @h['expires_in'] : 0
+    end
+
+    def errors
+
+      @h['errors'] || []
+    end
+
+    def sound?
+
+      errors.empty?
     end
 
     def not_expired?
@@ -148,7 +185,7 @@ module Sentofu
 
     def header_value
 
-      'Bearer ' + @h['access_token']
+      "Bearer #{@h['access_token'] || 'SENTOFU_INVALID_TOKEN_:-('}"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentofu
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.5
 platform: ruby
 authors:
 - John Mettraux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-02 00:00:00.000000000 Z
+date: 2020-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -64,8 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A Ruby client to some of the 1.0.0 Sentifi.com APIs