lhc 7.1.0 → 7.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad563c7a18adf9ec842d204bed81599304dac1c4
-  data.tar.gz: ef62b6ce7f4b80475ee0adbb4c502e6918706d8f
+  metadata.gz: 7dd0e9ffa97a410938b008214a1169dd92baad1a
+  data.tar.gz: 0c3e70e1aed73f71ab15cc8956f268c95ee4961e
 SHA512:
-  metadata.gz: cc1a310cd83690e9aeea40affabae0c47eda9abaccac038efb52440d806cb675b410b4dd0252989e88cb9b529fb6b9d4525029cb63d3a2f2385e3d9ed3750db5
-  data.tar.gz: 34307e36153349564b30d2e5aeb62aff588911cbcd0bd3646aab83ba0c05b484b39d00c5c6b1bb7774a97ef6e488d984c05b364c150a990939264d8266c10093
+  metadata.gz: b7ef93685b6321f92e3d211a15503b34f67acbaa6395ccf866f13b0ad1f03f14b42008a70e350950c124738ecd94e553f9aa0149026cac84b760287a18651be5
+  data.tar.gz: e348b6290e471eaec282c9cb883d129284029ea8644b4899fb5288f40c4c96ce24d03fb4c97ba30c1ded064df56945b2b77e96b212c2e24727b29ff606e395c4

data/README.md

@@ -98,6 +98,39 @@ Also consider setting the http header for content-type.
   )
 ```
 
+## Parameter
+
+When using LHC, try to pass params via `params` option. It's not recommended to build a url and attach the parameter yourself:
+
+DO
+```ruby
+LHC.get('http://local.ch', params: { q: 'Restaurant' })
+```
+
+DON'T
+```ruby
+LHC.get('http://local.ch?q=Restaurant')
+```
+
+## Encoding
+
+LHC, by default, encodes urls:
+
+```ruby
+LHC.get('http://local.ch?q=some space')
+# http://local.ch?q=some%20space
+
+LHC.get('http://local.ch', params: { q: 'some space' })
+# http://local.ch?q=some%20space
+```
+
+which can be disabled:
+
+```ruby
+LHC.get('http://local.ch?q=some space', url_encoding: false)
+# http://local.ch?q=some space
+```
+
 ## Configuration
 
 You can configure global endpoints, placeholders and interceptors.

data/lib/lhc/request.rb

@@ -52,8 +52,13 @@ class LHC::Request
 
   attr_accessor :iprocessor
 
+  def optionally_encoded_url(options)
+    return options[:url] unless options.fetch(:url_encoding, true)
+    encode_url(options[:url])
+  end
+
   def create_request
-    request = Typhoeus::Request.new(encode_url(options[:url]), typhoeusize(options))
+    request = Typhoeus::Request.new(optionally_encoded_url(options), typhoeusize(options))
     request.on_headers do
       iprocessor.intercept(:after_request, self)
       iprocessor.intercept(:before_response, self)

data/lib/lhc/version.rb

@@ -1,3 +1,3 @@
 module LHC
-  VERSION ||= '7.1.0'
+  VERSION ||= '7.2.0'
 end

data/spec/request/encoding_spec.rb

@@ -18,4 +18,18 @@ describe LHC::Request do
       LHC.get(url, params: { name: 'My name is rabbit' })
     end
   end
+
+  context 'skip encoding' do
+    let(:url) { 'http://local.ch/api/search?names[]=seba&names[]=david' }
+
+    it 'does not encode if encoding is skipped' do
+      stub_request(:get, 'http://local.ch/api/search?names%5B%5D%3Dseba%26names%5B%5D%3Ddavid')
+      LHC.get('http://local.ch/api/search?names%5B%5D%3Dseba%26names%5B%5D%3Ddavid', url_encoding: false)
+    end
+
+    it 'does double encoding, if you really want to' do
+      stub_request(:get, 'http://local.ch/api/search?names%255B%255D%253Dseba%2526names%255B%255D%253Ddavid')
+      LHC.get('http://local.ch/api/search?names%5B%5D%3Dseba%26names%5B%5D%3Ddavid')
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 7.1.0
+  version: 7.2.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhc/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-07 00:00:00.000000000 Z
+date: 2018-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus