lhc 8.1.1 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b44be8ec6523410f4c54ef36a395e1087030257a
-  data.tar.gz: 27f513d349a857372dba50b22b70bd36b9c5766d
+  metadata.gz: 7db64d4475586e832f57e7eda776d657d4d01971
+  data.tar.gz: bceb7e12c53148d19dff2909cef16d41f8d5094b
 SHA512:
-  metadata.gz: f37ea9b11ecb0385761daefbe496be873c3a171c7f89ef04ce4e47e547e7cd5ed355905372d1f90dffe8cf24871a229260614a1001354c4b9eb4603a9df5dc1b
-  data.tar.gz: afca207fb2293a769242ad8ee9d80b5b9db4625cbe7ab6962c0128f15b2db0f0fa6141ace620d6d3c4bc1b59f35d16e47b40cb6c90357f071de91142bd2c2986
+  metadata.gz: c2303382dcfa92216ee760eb7cd2daf53e58df1f3e026e1b6ebda16b1da786d0344992e1a133ed35c4c6bff7d2915ac761e9e8a46b237ac2caa87ba97de20ca9
+  data.tar.gz: 704a83dcf65173dffbb9cd7458a81c1bef2e5f4718688a0dc588d54d2694b1ca8a259e7043eb8545978b4aeedcaf94702db99a3d325548737ca3eae2fc66ca46

data/README.md

@@ -31,6 +31,15 @@ LHC.json.get(options)
 
 Currently supported formats: `json`
 
+If formats are used, headers for `Content-Type` and `Accept` are set by lhc, but also http bodies are translated by LHC, so you can pass bodies as ruby objects:
+
+```ruby
+LHC.json.post('http://slack', body: { text: 'Hi there' })
+# Content-Type: application/json
+# Accept: application/json
+# Translates body to "{\"text\":\"Hi there\"}" before sending
+```
+
 ## A request from scratch
 
 ```ruby
@@ -88,12 +97,13 @@ LHC.get('http://local.ch', followlocation: true)
 
 ## Transfer data through the body
 
-Data that is transfered using the HTTP request body is transfered as you provide it.
-Also consider setting the http header for content-type.
+Data that is transfered using the HTTP request body is transfered using the selected format, or the default `json`, so you need to provide it as a ruby object.
+
+Also consider setting the http header for content-type or use one of the provided formats, like `LHC.json`.
 
 ```ruby
   LHC.post('http://datastore/v2/feedbacks',
-    body: feedback.to_json,
+    body: feedback,
     headers: { 'Content-Type' => 'application/json' }
   )
 ```

data/lib/lhc/formats/json.rb

@@ -10,12 +10,16 @@ module LHC::Formats
       super(options)
     end
 
-    def as_json(response)
-      parse(response, Hash)
+    def as_json(input)
+      parse(input, Hash)
     end
 
-    def as_open_struct(response)
-      parse(response, OpenStruct)
+    def as_open_struct(input)
+      parse(input, OpenStruct)
+    end
+
+    def to_body(input)
+      input.to_json
     end
 
     def to_s
@@ -28,10 +32,10 @@ module LHC::Formats
 
     private
 
-    def parse(response, object_class)
-      ::JSON.parse(response.body, object_class: object_class)
+    def parse(input, object_class)
+      ::JSON.parse(input, object_class: object_class)
     rescue ::JSON::ParserError => e
-      raise LHC::ParserError.new(e.message, response)
+      raise LHC::ParserError.new(e.message, input)
     end
   end
 end

data/lib/lhc/interceptors/zipkin.rb

@@ -11,16 +11,13 @@ class LHC::Zipkin < LHC::Interceptor
   def before_request
     return unless dependencies?
     ZipkinTracer::TraceContainer.with_trace_id(trace_id) do
-      # add headers even if the current trace_id should not be sampled
       B3_HEADERS.each { |method, header| request.headers[header] = trace_id.send(method).to_s }
-      # only sample the current call if we're instructed to do so
       start_trace! if ::Trace.tracer && trace_id.sampled?
     end
   end
 
   def after_response
-    # only sample the current call if we're instructed to do so
-    return unless dependencies? && trace_id.sampled?
+    return unless dependencies?
     end_trace!
   end
 
@@ -42,7 +39,6 @@ class LHC::Zipkin < LHC::Interceptor
     @trace_id ||= ZipkinTracer::TraceGenerator.new.next_trace_id
   end
 
-  # register a new span with zipkin tracer
   def span
     @span ||= ::Trace.tracer.start_span(trace_id, url.path)
   end

data/lib/lhc/request.rb

@@ -14,12 +14,12 @@ class LHC::Request
     self.errors_ignored = options.fetch(:ignored_errors, [])
     self.options = options.deep_dup || {}
     self.error_handler = options.delete :error_handler
+    self.format = options.delete('format') || LHC::Formats::JSON.new
     use_configured_endpoint!
     generate_url_from_template!
     self.interceptors = LHC::Interceptors.new(self)
     interceptors.intercept(:before_raw_request)
     self.raw = create_request
-    self.format = options.delete('format') || LHC::Formats::JSON.new
     interceptors.intercept(:before_request)
     run! if self_executing && !response
   end
@@ -58,7 +58,10 @@ class LHC::Request
   end
 
   def create_request
-    request = Typhoeus::Request.new(optionally_encoded_url(options), typhoeusize(options))
+    request = Typhoeus::Request.new(
+      optionally_encoded_url(options),
+      translate_body(typhoeusize(options))
+    )
     request.on_headers do
       interceptors.intercept(:after_request)
       interceptors.intercept(:before_response)
@@ -67,6 +70,12 @@ class LHC::Request
     request
   end
 
+  def translate_body(options)
+    return options if options.fetch(:body, nil).blank?
+    options[:body] = format.to_body(options[:body])
+    options
+  end
+
   def encode_url(url)
     return url if url.nil?
     URI.escape(url)
@@ -100,8 +109,8 @@ class LHC::Request
   def generate_url_from_template!
     endpoint = LHC::Endpoint.new(options[:url])
     params =
-      if options[:body] && options[:body].length && (options[:headers] || {}).fetch('Content-Type', nil) == 'application/json'
-        JSON.parse(options[:body]).merge(options[:params] || {}).deep_symbolize_keys
+      if format && options[:body]&.length
+        options[:body].merge(options[:params] || {}).deep_symbolize_keys
       else
         options[:params]
       end

data/lib/lhc/response/data/base.rb

@@ -2,7 +2,7 @@
 # but made accssible in the ruby world
 module LHC::Response::Data::Base
   def as_json
-    @json ||= (@data || response.format.as_json(response))
+    @json ||= (@data || response.format.as_json(response.body))
   end
 
   def as_open_struct
@@ -10,7 +10,7 @@ module LHC::Response::Data::Base
       if @data
         JSON.parse(@data.to_json, object_class: OpenStruct)
       else
-        response.format.as_open_struct(response)
+        response.format.as_open_struct(response.body)
       end
   end
 

data/lib/lhc/version.rb

@@ -1,3 +1,3 @@
 module LHC
-  VERSION ||= '8.1.1'
+  VERSION ||= '9.0.0'
 end

data/spec/basic_methods/post_spec.rb

@@ -17,23 +17,23 @@ describe LHC do
     end
 
     it 'does a post request when providing a complete url' do
-      LHC.post('http://datastore/v2/feedbacks', body: feedback.to_json)
+      LHC.post('http://datastore/v2/feedbacks', body: feedback)
     end
 
     it 'does a post request when providing the name of a configured endpoint' do
       url = 'http://{+datastore}/v2/feedbacks'
       options = { params: { datastore: 'datastore' } }
       LHC.configure { |c| c.endpoint(:feedbacks, url, options) }
-      LHC.post(:feedbacks, body: feedback.to_json)
+      LHC.post(:feedbacks, body: feedback)
     end
 
     it 'it makes response data available in a rails way' do
-      response = LHC.post('http://datastore/v2/feedbacks', body: feedback.to_json)
+      response = LHC.post('http://datastore/v2/feedbacks', body: feedback)
       expect(response.data.source_id).to eq 'aaa'
     end
 
     it 'provides response headers' do
-      response = LHC.post('http://datastore/v2/feedbacks', body: feedback.to_json)
+      response = LHC.post('http://datastore/v2/feedbacks', body: feedback)
       expect(response.headers).to be
     end
   end

data/spec/basic_methods/put_spec.rb

@@ -23,23 +23,23 @@ describe LHC do
     end
 
     it 'does a post request when providing a complete url' do
-      LHC.put('http://datastore/v2/feedbacks', body: change.to_json)
+      LHC.put('http://datastore/v2/feedbacks', body: change)
     end
 
     it 'does a post request when providing the name of a configured endpoint' do
       url = 'http://{+datastore}/v2/feedbacks'
       options = { params: { datastore: 'datastore' } }
       LHC.configure { |c| c.endpoint(:feedbacks, url, options) }
-      LHC.put(:feedbacks, body: change.to_json)
+      LHC.put(:feedbacks, body: change)
     end
 
     it 'it makes response data available in a rails way' do
-      response = LHC.put('http://datastore/v2/feedbacks', body: change.to_json)
+      response = LHC.put('http://datastore/v2/feedbacks', body: change)
       expect(response.data.recommended).to eq false
     end
 
     it 'provides response headers' do
-      response = LHC.put('http://datastore/v2/feedbacks', body: change.to_json)
+      response = LHC.put('http://datastore/v2/feedbacks', body: change)
       expect(response.headers).to be
     end
   end

data/spec/basic_methods/request_without_rails_spec.rb

@@ -19,7 +19,7 @@ describe LHC do
       options = {
         url: "http://datastore/v2/feedbacks",
         method: :post,
-        body: "{}",
+        body: {},
         headers: { 'Content-Type' => 'application/json' }
       }
       expect { LHC.request(options) }.not_to raise_error

data/spec/interceptors/zipkin/distributed_tracing_spec.rb

@@ -13,7 +13,7 @@ describe LHC::Zipkin do
         trace_id: 'trace_id',
         parent_id: 'parent_id',
         span_id: 'span_id',
-        sampled: true,
+        sampled: 'sampled',
         flags: 'flags'
       )
     end
@@ -23,7 +23,7 @@ describe LHC::Zipkin do
       expect(headers['X-B3-TraceId']).to eq('trace_id')
       expect(headers['X-B3-ParentSpanId']).to eq('parent_id')
       expect(headers['X-B3-SpanId']).to eq('span_id')
-      expect(headers['X-B3-Sampled']).to eq('true')
+      expect(headers['X-B3-Sampled']).to eq('sampled')
       expect(headers['X-B3-Flags']).to eq('flags')
     end
   end
@@ -49,60 +49,4 @@ describe LHC::Zipkin do
       expect(headers['X-B3-Flags']).to be_nil
     end
   end
-
-  describe 'creating new spans' do
-    context 'sampled? is false' do
-      before(:all) do
-        ::ZipkinTracer::TraceContainer.setup_mock(
-          trace_id: 'trace_id',
-          parent_id: 'parent_id',
-          span_id: 'span_id',
-          sampled: false,
-          flags: 'flags'
-        )
-      end
-
-      it 'adds the proper X-B3 headers' do
-        headers = LHC.get(:local).request.headers
-        expect(headers['X-B3-TraceId']).to eq('trace_id')
-        expect(headers['X-B3-ParentSpanId']).to eq('parent_id')
-        expect(headers['X-B3-SpanId']).to eq('span_id')
-        expect(headers['X-B3-Sampled']).to eq('false')
-        expect(headers['X-B3-Flags']).to eq('flags')
-      end
-
-      it 'does not register a new span' do
-        # ensure no span was registered, by checking no call on span
-        expect_any_instance_of(described_class).not_to receive(:span).and_call_original
-        LHC.get(:local)
-      end
-    end
-
-    context 'sampled? is true' do
-      before(:all) do
-        ::ZipkinTracer::TraceContainer.setup_mock(
-          trace_id: 'trace_id',
-          parent_id: 'parent_id',
-          span_id: 'span_id',
-          sampled: true,
-          flags: 'flags'
-        )
-      end
-
-      it 'adds the proper X-B3 headers' do
-        headers = LHC.get(:local).request.headers
-        expect(headers['X-B3-TraceId']).to eq('trace_id')
-        expect(headers['X-B3-ParentSpanId']).to eq('parent_id')
-        expect(headers['X-B3-SpanId']).to eq('span_id')
-        expect(headers['X-B3-Sampled']).to eq('true')
-        expect(headers['X-B3-Flags']).to eq('flags')
-      end
-
-      it 'does register a new span' do
-        # ensure a span was registered, by checking call on span
-        expect_any_instance_of(described_class).to receive(:span).at_least(1).times.and_call_original
-        LHC.get(:local)
-      end
-    end
-  end
 end

data/spec/request/url_patterns_spec.rb

@@ -18,6 +18,6 @@ describe LHC::Request do
 
   it 'considers body when compiling urls' do
     stub_request(:post, "http://datastore:8080/v2/places/123")
-    LHC.json.post('http://datastore:8080/v2/places/{id}', body: { id: 123 }.to_json)
+    LHC.json.post('http://datastore:8080/v2/places/{id}', body: { id: 123 })
   end
 end

data/spec/support/zipkin_mock.rb

@@ -42,7 +42,7 @@ module ZipkinTracer
     end
 
     def sampled
-      ZipkinTracer::TraceContainer.current.sampled
+      'sampled'
     end
 
     def flags
@@ -50,7 +50,7 @@ module ZipkinTracer
     end
 
     def sampled?
-      ZipkinTracer::TraceContainer.current.sampled
+      true
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 8.1.1
+  version: 9.0.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhc/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-19 00:00:00.000000000 Z
+date: 2018-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -368,7 +368,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Ruby >= 2.0.0
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: LocalHttpClient