lhc 10.0.2 → 10.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcff9d45e512c5c1a8c76aaffb710eb73d5a5b03909e167e5a584fc4614a6d19
-  data.tar.gz: 366dd2f2b123018ca3d06d21d2e3eafd75923a292f363a54e1c8163f78753286
+  metadata.gz: e5027043fdf2d3bd3354777f95b1dd21438f4068170634c5788a8d40120002f6
+  data.tar.gz: e7916e8fc0d2a55ecee4d2ceacc6372011ebdb6e809eddb25291089d7728b553
 SHA512:
-  metadata.gz: 9f57d6a94e86a60ec2866aefdf15f472353e270e0a8df7f88bbbded053f2d84dd59e7e3ff9027b9f629aa7a355e905a407dc41c7727996c53b35c6e76ebc09dc
-  data.tar.gz: d94e275d67dad755be1a0ce290eca7ff7a1defeaadf30ea202d6659eca9a14d23e14fc220b8992d4087278e806f851b36b0be28aa7b71873b6266f4dde6658c3
+  metadata.gz: e405825ed3e030dc051b3c26d6855ff6facf9745855b07b59aa7258885135a0443c6e84d27635413d3cae53c1613b708fe37dfb140a6f1358327199238ad0b88
+  data.tar.gz: 714d29fbd0b77416b6e2fa6a56d1189bea68311e14f8c516b84b129e7e3c0c3a45ff50eddc7e0244c3e22b878e888cb5006f7552c4ad7d8333316bfef16de1e0

data/README.md

@@ -36,6 +36,9 @@ use it like:
       * [Basic methods](#basic-methods)
       * [Request](#request)
          * [Formats](#formats)
+            * [Default format](#default-format)
+            * [Unformatted requests](#unformatted-requests)
+               * [Upload with LHC](#upload-with-lhc)
          * [Parallel requests](#parallel-requests)
          * [Follow redirects](#follow-redirects)
          * [Transfer data through the request body](#transfer-data-through-the-request-body)
@@ -123,7 +126,7 @@ You can use any of the basic methods in combination with a format like `json`:
 LHC.json.get(options)
 ```
 
-Currently supported formats: `json`
+Currently supported formats: `json`, `multipart`, `plain` (for no formatting)
 
 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:
 
@@ -134,6 +137,29 @@ LHC.json.post('http://slack', body: { text: 'Hi there' })
 # Translates body to "{\"text\":\"Hi there\"}" before sending
 ```
 
+#### Default format
+
+If you use LHC's basic methods `LHC.get`, `LHC.post` etc. without any explicit format, `JSON` will be chosen as the default format.
+
+#### Unformatted requests
+
+In case you need to send requests without LHC formatting headers or the body, use `plain`:
+
+```ruby
+LHC.plain.post('http://endpoint', body: { weird: 'format%s2xX' })
+```
+
+##### Upload with LHC
+
+If you want to upload data with LHC, it's recommended to use the `multipart` format:
+
+```ruby
+response = LHC.multipart.post('http://upload', body: { file })
+response.headers['Location']
+# Content-Type: multipart/form-data
+# Leaves body unformatted
+```
+
 ### Parallel requests
 
 If you pass an array of requests to `LHC.request`, it will perform those requests in parallel.

data/lib/lhc/concerns/lhc/formats_concern.rb

@@ -6,6 +6,14 @@ module LHC
       def json
         LHC::Formats::JSON
       end
+
+      def multipart
+        LHC::Formats::Multipart
+      end
+
+      def plain
+        LHC::Formats::Plain
+      end
     end
   end
 end

data/lib/lhc/formats.rb

@@ -1,3 +1,5 @@
 module LHC::Formats
   autoload :JSON, 'lhc/formats/json'
+  autoload :Multipart, 'lhc/formats/multipart'
+  autoload :Plain, 'lhc/formats/plain'
 end

data/lib/lhc/formats/multipart.rb

@@ -0,0 +1,38 @@
+module LHC::Formats
+  class Multipart
+    include LHC::BasicMethodsConcern
+
+    def self.request(options)
+      options[:headers] ||= {}
+      options[:headers]['Content-Type'] = 'multipart/form-data'
+      options[:format] = new
+      super(options)
+    end
+
+    def as_json(input)
+      parse(input)
+    end
+
+    def as_open_struct(input)
+      parse(input)
+    end
+
+    def to_body(input)
+      input
+    end
+
+    def to_s
+      'multipart'
+    end
+
+    def to_sym
+      to_s.to_sym
+    end
+
+    private
+
+    def parse(input)
+      input
+    end
+  end
+end

data/lib/lhc/formats/plain.rb

@@ -0,0 +1,36 @@
+module LHC::Formats
+  class Plain
+    include LHC::BasicMethodsConcern
+
+    def self.request(options)
+      options[:format] = new
+      super(options)
+    end
+
+    def as_json(input)
+      parse(input)
+    end
+
+    def as_open_struct(input)
+      parse(input)
+    end
+
+    def to_body(input)
+      input
+    end
+
+    def to_s
+      'plain'
+    end
+
+    def to_sym
+      to_s.to_sym
+    end
+
+    private
+
+    def parse(input)
+      input
+    end
+  end
+end

data/lib/lhc/request.rb

@@ -16,7 +16,7 @@ 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
+    self.format = options.delete(:format) || LHC::Formats::JSON.new
     use_configured_endpoint!
     generate_url_from_template!
     self.interceptors = LHC::Interceptors.new(self)

data/lib/lhc/version.rb

@@ -1,3 +1,3 @@
 module LHC
-  VERSION ||= '10.0.2'
+  VERSION ||= '10.1.0'
 end

data/spec/formats/multipart_spec.rb

@@ -0,0 +1,29 @@
+require 'rails_helper'
+
+describe LHC do
+  context 'multipart' do
+    let(:file) do
+      ActionDispatch::Http::UploadedFile.new(
+        tempfile: Tempfile.new,
+        filename: 'image.jpg',
+        type: 'image/jpeg',
+        head: %q{Content-Disposition: form-data; name="files[]"; filename="image.jpg"\r\nContent-Type: image/jpeg\r\n}
+      )
+    end
+    let(:body) { { size: 2231 }.to_json }
+    let(:location) { 'http://local.ch/uploads/image.jpg' }
+
+    it 'leaves plains requests unformatted' do
+      stub_request(:post, 'http://local.ch/') do |request|
+        raise 'Content-Type header wrong' unless request.headers['Content-Type'] == 'multipart/form-data'
+        raise 'Body wrongly formatted' unless request.body.match(/file=%23%3CActionDispatch%3A%3AHttp%3A%3AUploadedFile%3A.*%3E&type=Image/)
+      end.to_return(status: 200, body: body, headers: { 'Location' => location })
+      response = LHC.multipart.post(
+        'http://local.ch',
+        body: { file: file, type: 'Image' }
+      )
+      expect(response.body).to eq body
+      expect(response.headers['Location']).to eq location
+    end
+  end
+end

data/spec/formats/plain_spec.rb

@@ -0,0 +1,32 @@
+require 'rails_helper'
+
+describe LHC do
+  context 'plain' do
+    let(:file) do
+      ActionDispatch::Http::UploadedFile.new(
+        tempfile: Tempfile.new,
+        filename: 'image.jpg',
+        type: 'image/jpeg',
+        head: %q{Content-Disposition: form-data; name="files[]"; filename="image.jpg"\r\nContent-Type: image/jpeg\r\n}
+      )
+    end
+
+    it 'leaves plains requests unformatted' do
+      stub_request(:post, 'http://local.ch/')
+        .with(body: /file=%23%3CActionDispatch%3A%3AHttp%3A%3AUploadedFile%3A.*%3E&type=Image/)
+        .to_return do |request|
+          expect(request.headers['Content-Type']).to be_blank
+
+          { status: 204 }
+        end
+      response = LHC.plain.post(
+        'http://local.ch',
+        body: { file: file, type: 'Image' }
+      )
+      expect(lambda {
+        response.body
+        response.data
+      }).not_to raise_error
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 10.0.2
+  version: 10.1.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-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -207,6 +207,8 @@ files:
 - lib/lhc/errors/unknown_error.rb
 - lib/lhc/formats.rb
 - lib/lhc/formats/json.rb
+- lib/lhc/formats/multipart.rb
+- lib/lhc/formats/plain.rb
 - lib/lhc/interceptor.rb
 - lib/lhc/interceptors.rb
 - lib/lhc/interceptors/auth.rb
@@ -287,6 +289,8 @@ files:
 - spec/error/timeout_spec.rb
 - spec/error/to_s_spec.rb
 - spec/formats/json_spec.rb
+- spec/formats/multipart_spec.rb
+- spec/formats/plain_spec.rb
 - spec/interceptors/after_request_spec.rb
 - spec/interceptors/after_response_spec.rb
 - spec/interceptors/auth/basic_auth_spec.rb
@@ -430,6 +434,8 @@ test_files:
 - spec/error/timeout_spec.rb
 - spec/error/to_s_spec.rb
 - spec/formats/json_spec.rb
+- spec/formats/multipart_spec.rb
+- spec/formats/plain_spec.rb
 - spec/interceptors/after_request_spec.rb
 - spec/interceptors/after_response_spec.rb
 - spec/interceptors/auth/basic_auth_spec.rb