ja 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcd4bf55cd3c814844254a793f143790c3e8ea942be0f2a1cef41bc746448890
-  data.tar.gz: bbc1a6801f7d8eb280859f244a1b0b72f76460745e23d4201434aab13a6be499
+  metadata.gz: 79797ea17317f08a380c22f55d19e1785ae3f9721951927d9d508b1ab280cac7
+  data.tar.gz: c776feb143950eb918018b80bfc04741c55f2efd11dffbb195e4429991a2f637
 SHA512:
-  metadata.gz: 44a3b3358fd8724ca95b84006690cb6965a6f5b0a7d83ca4231fa773c80035487d4dc3c3a852fc1aca310836e2b32a28bea34eda0df65023db801f3ad3a10f88
-  data.tar.gz: d977da21532c1c40079d92615a13185abc09b17e43f3b1ea66620e40872445d6c8ee6ef8ca7383deee93483439893d0911ec08627b164bb7a645ccf92e5ad248
+  metadata.gz: 89b61d3719c61eb835213a6bfb99e21895e43b079efd24cf49a0df00b18c16ea3e2690c124c5422d52acde7e0b9502dd5b855cd1e2c60053de954ca920c18dbf
+  data.tar.gz: 77c1184f4b5ace74384d365fc142e90f17dc309efd705ac25fbb58c4255dd5fe99a527734510350b7e7bb19d980d40b363860e80b9c691b3ffea9da9f3535451

data/README.md

@@ -28,9 +28,18 @@ respoonse = my_service.get("widgets")
 Or by setting your own HTTP options:
 
 ``` ruby
-client = HTTP.basic_auth(user: "alice", pass: "secret")
-my_authenticated_service = Ja.api(client: client)
-my_authenticated_service.get("my-private-widgets")
+client = HTTP.headers("Content-Type" => "application/json")
+my_service = Ja.api(client: client)
+my_service.get("widgets")
+```
+
+### Authentication
+
+Ja will automatically recognize basic authentication in the URL, so you don't have to call `HTTP.basic_auth` manually.
+
+``` ruby
+my_authenticated_service = Ja.api(url: "https://username:secret@my-service.com")
+my_authenticated_service.get("settings")
 ```
 
 ### Raising errors
@@ -69,6 +78,8 @@ Ja.logger = Logger.new("log/http.log")
 
 To log the full request and full response, we need to do some monkey patching, so it is disabled by default. To enable it, call `Ja.enable_debug_logging!`. You may want to do this only for development/test but not on production, because it might mess with streaming responses. Full request logging will always log in `debug` log level and will always use the globally configered logger.
 
+If you have a logger that can accept hashes for some rich logging, you can enable that style by setting `Ja.enable_semantic_logging = true`
+
 ### Request ID
 
 One very helpful way to manage multiple services is to pass along a "request id". If you tag your logs with that value, you can use a centralized logging service to track a request as it propagates through your fleet of microservices.
@@ -115,6 +126,13 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Todo
+
+Some things that are on my mind of adding:
+
+* Add ja-style functionality via [generic features](https://github.com/httprb/http/pull/482)
+* Use native [logging and instrumation](https://github.com/httprb/http/pull/499)
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/iain/ja.

data/lib/ja.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "http"
 require "logger"
 
@@ -18,6 +20,14 @@ module Ja
     @logger = logger
   end
 
+  def self.enable_semantic_logging=(bool)
+    @enable_semantic_logging = bool
+  end
+
+  def self.enable_semantic_logging?
+    !!@enable_semantic_logging
+  end
+
   def self.api(*args, &block)
     API.new(*args, &block)
   end

data/lib/ja/api.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Ja
   class API
 
-    LOG_LINE = "%{verb} %{url} responded with %{status} %{reason}"
-
     include Methods
 
+    LOG_LINE = "%{verb} %{url} responded with %{status} %{reason}"
+
     def initialize(client:   HTTP,
                    url:      nil,
                    logger:   Ja.logger,
@@ -14,6 +16,16 @@ module Ja
       @logger = logger
       @log_line = log_line
       @url = url
+      if url
+        uri = URI.parse(url)
+        if uri.user || uri.password
+          @client = @client.basic_auth(uri.user, uri.password)
+          uri.user = nil
+          uri.password = nil
+          @url = uri.to_s
+        end
+      end
+      @semantic_logging = Ja.enable_semantic_logging? || (defined?(SemanticLogger) && logger.is_a?(SemanticLogger::Logger))
     end
 
     attr_reader :client, :logger, :log_line, :url
@@ -67,7 +79,7 @@ module Ja
 
       message = log_line % payload
 
-      if defined?(SemanticLogger) && logger.is_a?(SemanticLogger::Logger)
+      if @semantic_logging
         logger.public_send(log_level, message: message, duration: duration, payload: payload)
       else
         logger.public_send(log_level, "(%.2fms) %s" % [ duration, message ])

data/lib/ja/debug_logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ja
   module DebugLogger
 

data/lib/ja/error.rb

@@ -1,6 +1,17 @@
+# frozen_string_literal: true
+
 module Ja
   class Error < StandardError
 
+    # Base class for all errors
+    ResponseError = Class.new(Error)
+
+    # Base class for errors in the 4xx range
+    ClientError = Class.new(ResponseError)
+
+    # Base class for errors in the 5xx range
+    ServerError = Class.new(ResponseError)
+
     def self.to_exception(verb, uri, response)
       Error.fetch_error_class(response.status).new(verb, uri, response)
     end
@@ -35,15 +46,6 @@ module Ja
       response.status
     end
 
-    # Base class for all errors
-    ResponseError = Class.new(Error)
-
-    # Base class for errors in the 4xx range
-    ClientError = Class.new(ResponseError)
-
-    # Base class for errors in the 5xx range
-    ServerError = Class.new(ResponseError)
-
     HTTP::Response::Status::REASONS.each do |status, name|
       parent = status >= 500 ? ServerError : ClientError
       const_set(name.gsub(/\W/, ""), Class.new(parent))

data/lib/ja/methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ja
   module Methods
 

data/lib/ja/version.rb

@@ -1,3 +1,8 @@
+# frozen_string_literal: true
+
 module Ja
-  VERSION = "0.1.1"
+
+  VERSION = "0.2.0"
+  public_constant :VERSION
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ja
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - iain
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-31 00:00:00.000000000 Z
+date: 2019-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -164,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Opinionated helpers for making JSON calls with the http.rb gem