sentofu 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b5960cd3b7ffcfe6824b87fb368fb50a7f780235bbc253962c3f4a4c2c981bd
-  data.tar.gz: 4f5ff2b170ce25c694bbbf7a9371183e60171a03b410989f20e70619c5b4e633
+  metadata.gz: 6561d6b8cc61b7109c2025d15f6d5753906840f7f0bdf0dd0790498afcf74a1b
+  data.tar.gz: e5da524f149e0dbd50e51c4690e8ab753cab0b4eecf12a053612732bbc8a0a6b
 SHA512:
-  metadata.gz: d3d393682b233664d071b45259ab59bb05504d52a013c16ede4f28fda80608bc1f6cf8a91b1a2ff5cdf12a433a242cb37621b2d5813472d3a02339e79f9464b8
-  data.tar.gz: 7e95877e0cd10deb29f684f0e31ce93f97a8b5f5a908b8a17aa8d406466cdf10571e5cf8b3a9e123ca68a30c9d04bbf48d72bb4ae7edebc994ca416b1f24ead7
+  metadata.gz: b990aeecef8189eb352b359a7aeb83904c68acda461cba81f17ac2a2c520dce414850309ee5c0ffaa96a71f33cfdb23a3763e01f5b755d039d01a8d490723fb1
+  data.tar.gz: 6b91e650302caf66fb3d3b665b0d0d1b01912a61b9ed2ea35e78186b5b038c63462e641b4d0f7024cf7a93b578f0b1a479de80eaa4e0803cd4f17d81a5b59c9f

data/CHANGELOG.md

@@ -2,6 +2,32 @@
 # CHANGELOG.md
 
 
+## sentofu 0.6.0  released 2021-01-05
+
+* Make error messages more informative
+* Stop passing the full URI to GET and POST
+
+
+## sentofu 0.5.6  released 2020-09-28
+
+* Report _code along _headers in response
+
+
+## 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

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2019-2019, John Mettraux, jmettraux+flor@gmail.com
+Copyright (c) 2019-2021, 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.2'
+  VERSION = '0.6.0'
 
   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

@@ -13,19 +13,23 @@ module Sentofu
 
         a = Base64.encode64("#{cs.id}:#{cs.secret}").strip
 
-        req = Net::HTTP::Post.new(Sentofu.auth_uri)
+        u = URI(Sentofu.auth_uri)
+
+        req = Net::HTTP::Post.new(u.path)
         req.add_field('Content-Type', 'application/json')
         req.add_field('Authorization', a)
 
         req.body = JSON.dump(
           grant_type: 'password', username: cs.user, password: cs.pass)
 
-        Sentofu::Token.new(request(Sentofu.auth_uri, req))
+        Sentofu::Token.new(request(u, req))
       end
 
       def get(uri, token=nil)
 
-        request(uri, make_get_req(uri, token))
+        u = URI(uri)
+
+        request(u, make_get_req(u, token))
       end
 
       def make_net_http(uri)
@@ -61,23 +65,23 @@ module Sentofu
 
       def request(uri, req)
 
-        u = uri.is_a?(String) ? URI(uri) : uri
-
         t0 = monow
 
-        http = make_net_http(u)
-#t.set_debug_output($stdout) if u.to_s.match(/search/)
+        http = make_net_http(uri)
+#http.set_debug_output($stderr)
 
         res = http.request(req)
 
-        fail "request returned a #{res.class} and not a Net::HTTPResponse" \
-          unless res.is_a?(Net::HTTPResponse)
-
         class << res
-          attr_accessor :_elapsed
+          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
@@ -86,19 +90,24 @@ module Sentofu
 
         res = get(uri, token)
 
-        fail 'something went wrong' \
-          unless res.header['content-type'].match(/^application\/json(;|$)/)
+        fail(
+          "#{WEBrick::HTTPStatus.reason_phrase(res.code) rescue ''} - " +
+          "#{res._uri.to_s}"
+        ) unless res.header['content-type'].match?(/^application\/json(;|$)/)
 
         JSON.parse(res.body)
           .merge!(
+            _uri: res._uri.to_s,
             _headers: res._headers,
-            _elapsed: res._elapsed)
+            _code: res.code.to_i,
+            _elapsed: res._elapsed,
+            _proxy: res._proxy)
 
       rescue => err
 
-        { uri: uri,
+        { uri: uri.to_s,
           code: (res.code.to_i rescue nil),
-          headers: res._headers,
+          headers: (res._headers rescue nil),
           message: (WEBrick::HTTPStatus.reason_phrase(res.code) rescue nil),
           error_class: err.class.to_s,
           error_message: err.message,
@@ -112,7 +121,10 @@ module Sentofu
 
       def make_get_req(uri, token)
 
-        req = Net::HTTP::Get.new(uri.to_s)
+        u = [ uri.path, uri.query ].compact.join('?')
+        u = '/' if u.length < 1
+
+        req = Net::HTTP::Get.new(u)
         req.instance_eval { @header.clear }
         def req.set_header(k, v); @header[k] = [ v ]; end
 
@@ -139,6 +151,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
 
@@ -148,7 +171,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?
@@ -158,7 +193,7 @@ module Sentofu
 
     def header_value
 
-      'Bearer ' + @h['access_token']
+      "Bearer #{@h['access_token'] || 'SENTOFU_INVALID_TOKEN_:-('}"
     end
   end
 end

data/sentofu.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.authors = [ 'John Mettraux' ]
   s.email = [ 'jmettraux@gmail.com' ]
-  s.homepage = 'http://github.com/jmettraux/sentofu'
+  s.homepage = 'https://github.com/jmettraux/sentofu'
   s.license = 'MIT'
   s.summary = 'A Ruby client to some of the 1.0.0 Sentifi.com APIs'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentofu
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - John Mettraux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-27 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -40,15 +40,15 @@ files:
 - lib/sentofu/explo.rb
 - lib/sentofu/http.rb
 - sentofu.gemspec
-homepage: http://github.com/jmettraux/sentofu
+homepage: https://github.com/jmettraux/sentofu
 licenses:
 - MIT
 metadata:
-  changelog_uri: http://github.com/jmettraux/sentofu/blob/master/CHANGELOG.md
-  documentation_uri: http://github.com/jmettraux/sentofu
-  bug_tracker_uri: http://github.com/jmettraux/sentofu/issues
-  homepage_uri: http://github.com/jmettraux/sentofu
-  source_code_uri: http://github.com/jmettraux/sentofu
+  changelog_uri: https://github.com/jmettraux/sentofu/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/jmettraux/sentofu
+  bug_tracker_uri: https://github.com/jmettraux/sentofu/issues
+  homepage_uri: https://github.com/jmettraux/sentofu
+  source_code_uri: https://github.com/jmettraux/sentofu
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -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