lhc 9.4.4 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35f64115a3a18dcad3d0494af2afe221aba124a22358f3be7b27dad63ccca55c
-  data.tar.gz: 14e25b16e6053a1db7db44dde741a1c48a715b0fc64e9865fe18cbd755baa976
+  metadata.gz: 97fdf362698642e8dccbd9263ee7253563d3dfa2cbcde0daea331fee79c6ad58
+  data.tar.gz: 62dba156d28e3d12ab4d4d73ff686088ae4752f11e67c8df5e74e9df2bd0eea1
 SHA512:
-  metadata.gz: 9fa8c49a2b87857e7f44746166f60ad0ab572520a005fbbce14e5a7909c2f661bd8ab1f3f6becc55a1d54b9d89879c3221d9062edf8c5575de38505e857e1323
-  data.tar.gz: 46d331a87f5acfdd8bbea6b139cb6d9dacbbce0a3757d2f8be36299bba544b5a78e5f0753504e31da12a92627718e2b49b59aaf9962b67297a54308af467a011
+  metadata.gz: 91745336ea808eb5a51f6a476bec8a36f017ccb65a4f2fda9fdda1c904f0b6f28e00f668947963acc207ab608bfbc8b2444548f55b5236a6fcb266d55a7a7687
+  data.tar.gz: 2591ed19fb8e34de1e423d58ed119faa0048c33a1300b8cceb569d94e377d63ea4981e220251434429cc13d14fdeed1a8897d5b943af5c2bc1b56b92bd9546be

data/README.md

@@ -44,6 +44,7 @@ use it like:
          * [Request URL encoding](#request-url-encoding)
          * [Request URL-Templates](#request-url-templates)
          * [Request timeout](#request-timeout)
+         * [Request Agent](#request-agent)
       * [Response](#response)
          * [Accessing response data](#accessing-response-data)
       * [Exceptions](#exceptions)
@@ -255,6 +256,20 @@ LHC.get('http://local.ch', timeout: 5, connecttimeout: 1)
 
 LHC provides a [timeout interceptor](#default-timeout-interceptor) that lets you apply default timeout values to all the requests that you are performig in your application.
 
+### Request Agent
+
+LHC identifies itself towards outher services, using the `User-Agent` header.
+
+```
+User-Agent LHC (9.4.2) [https://github.com/local-ch/lhc]
+```
+
+If LHC is used in an Rails Application context, also the application name is added to the `User-Agent` header.
+
+```
+User-Agent LHC (9.4.2; MyRailsApplicationName) [https://github.com/local-ch/lhc]
+```
+
 ## Response
 
 ```ruby

data/lib/lhc/concerns/lhc/request/user_agent_concern.rb

@@ -0,0 +1,17 @@
+require 'active_support'
+
+module LHC
+  class Request
+    module UserAgentConcern
+      extend ActiveSupport::Concern
+
+      included do
+        Typhoeus::Config.user_agent = begin
+          version = LHC::VERSION
+          application = defined?(Rails) ? Rails.application.class.parent_name : nil
+          "LHC (#{[version, application].compact.join('; ')}) [https://github.com/local-ch/lhc]"
+        end
+      end
+    end
+  end
+end

data/lib/lhc/request.rb

@@ -1,10 +1,12 @@
 require 'uri'
 require 'active_support/core_ext/object/deep_dup'
+require 'lhc/concerns/lhc/request/user_agent_concern'
 
 # The request is doing an http-request using typhoeus.
 # It provides functionalities to access and alter request data
 # and it communicates with interceptors.
 class LHC::Request
+  include UserAgentConcern
 
   TYPHOEUS_OPTIONS ||= [:params, :method, :body, :headers, :follow_location, :params_encoding]
 
@@ -109,8 +111,8 @@ class LHC::Request
   def generate_url_from_template!
     endpoint = LHC::Endpoint.new(options[:url])
     params =
-      if format && options[:body].present? && options[:body].respond_to?(:as_json) && options[:body].as_json.is_a?(Hash)
-        options[:body].as_json.merge(options[:params] || {}).deep_symbolize_keys
+      if format && options[:body]&.length && options[:body].is_a?(Hash)
+        options[:body].merge(options[:params] || {}).deep_symbolize_keys
       else
         options[:params]
       end

data/lib/lhc/version.rb

@@ -1,3 +1,3 @@
 module LHC
-  VERSION ||= '9.4.4'
+  VERSION ||= '10.0.0'
 end

data/spec/request/url_patterns_spec.rb

@@ -20,33 +20,4 @@ describe LHC::Request do
     stub_request(:post, "http://datastore:8080/v2/places/123")
     LHC.json.post('http://datastore:8080/v2/places/{id}', body: { id: 123 })
   end
-
-  context 'custom data structures that respond to as_json (like LHS data or record)' do
-    before do
-      class CustomStructure
-
-        def initialize(data)
-          @data = data
-        end
-
-        def as_json
-          @data.as_json
-        end
-
-        def to_json
-          as_json.to_json
-        end
-      end
-    end
-
-    let(:data) do
-      CustomStructure.new(id: '12345')
-    end
-
-    it 'compiles url from body params when body object respond_to(:as_json)' do
-      stub_request(:post, "http://datastore/places/12345")
-        .to_return(status: 200)
-      LHC.post('http://datastore/places/{id}', body: data)
-    end
-  end
 end

data/spec/request/user_agent_spec.rb

@@ -0,0 +1,24 @@
+require 'rails_helper'
+
+describe LHC::Request do
+  before do
+    LHC.send(:remove_const, :Request)
+    load('lhc/concerns/lhc/request/user_agent_concern.rb')
+    load('lhc/request.rb')
+  end
+
+  context 'default headers' do
+    context 'agent' do
+      it 'sets header agent information to be LHC' do
+        stub_request(:get, "http://local.ch/")
+          .with(
+            headers: {
+              'User-Agent' => "LHC (#{LHC::VERSION}; Dummy) [https://github.com/local-ch/lhc]"
+            }
+          )
+          .to_return(status: 200)
+        LHC.get('http://local.ch')
+      end
+    end
+  end
+end

data/spec/request/user_agent_without_rails_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe LHC::Request do
+  before do
+    Object.send(:remove_const, :Rails)
+    LHC.send(:remove_const, :Request)
+    load('lhc/concerns/lhc/request/user_agent_concern.rb')
+    load('lhc/request.rb')
+  end
+
+  context 'default headers' do
+    context 'agent' do
+      it 'sets header agent information to be LHC' do
+        stub_request(:get, "http://local.ch/")
+          .with(
+            headers: {
+              'User-Agent' => "LHC (#{LHC::VERSION}) [https://github.com/local-ch/lhc]"
+            }
+          )
+          .to_return(status: 200)
+        LHC.get('http://local.ch')
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 9.4.4
+  version: 10.0.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhc/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-15 00:00:00.000000000 Z
+date: 2018-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -196,6 +196,7 @@ files:
 - lib/lhc/concerns/lhc/basic_methods_concern.rb
 - lib/lhc/concerns/lhc/configuration_concern.rb
 - lib/lhc/concerns/lhc/formats_concern.rb
+- lib/lhc/concerns/lhc/request/user_agent_concern.rb
 - lib/lhc/config.rb
 - lib/lhc/endpoint.rb
 - lib/lhc/error.rb
@@ -324,6 +325,8 @@ files:
 - spec/request/params_encoding_spec.rb
 - spec/request/request_without_rails_spec.rb
 - spec/request/url_patterns_spec.rb
+- spec/request/user_agent_spec.rb
+- spec/request/user_agent_without_rails_spec.rb
 - spec/response/body_spec.rb
 - spec/response/code_spec.rb
 - spec/response/data_accessor_spec.rb
@@ -465,6 +468,8 @@ test_files:
 - spec/request/params_encoding_spec.rb
 - spec/request/request_without_rails_spec.rb
 - spec/request/url_patterns_spec.rb
+- spec/request/user_agent_spec.rb
+- spec/request/user_agent_without_rails_spec.rb
 - spec/response/body_spec.rb
 - spec/response/code_spec.rb
 - spec/response/data_accessor_spec.rb