opinionated_http 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5620005cf44985c98ebea7fb7ba774356f01594f84cd0ef3ca5106f0e067073c
-  data.tar.gz: 8b01af150130d9bf86b8919f857625f946fd7726b44ee8aa441db68af0e6680e
+  metadata.gz: 6279db8b72fbf65adbc3e271ea079be89b2c54227a343c5dd252cf79799e7adf
+  data.tar.gz: 6951e99ac22b9237ed2a2220bc858cb2e1f1c05b0cd15a4793631226b296ced9
 SHA512:
-  metadata.gz: 3f12118ae6659e39f68fa43df9843927cabda081cdb058404c3dfe5df8a38bd6ffe0ca966e396b6628e503667df9058366078161ee8dc6001a930f64d114bfec
-  data.tar.gz: ee2b01bf0f11b8d9b3e51f03936724c7ec2a779070540bd378aa03c8a0f5f7032a7060f498660046c1a08b463be82b4708af1de8574b9ffda2c67103bae1b5bb
+  metadata.gz: a1139e62e3fcf12a4ed985d96a9d561c4f7a3b9859fb2296699d5b70942aa53448a50fc0a1a7f3fb97cd7a9ee1bff528c9ef9fdc704ae25ec42eee845e31dd39
+  data.tar.gz: 954fe864fef5772be8658bbf78f20ec43e0fc32ed6d456025c1ed3bffbd0b638dd880c6c4e1efc66e1a9e2034930410b0f25e41952508891b51c909ee1977589

data/lib/opinionated_http/client.rb

@@ -49,22 +49,32 @@ module OpinionatedHTTP
       path = "/#{path}" unless path.start_with?("/")
       path = "#{path}?#{URI.encode_www_form(parameters)}" if parameters
 
-      request  = Net::HTTP::Get.new(path)
+      request  = generic_request(path: path, verb: 'Get')
       response = request_with_retry(action: action, path: path, request: request)
 
       response.body
     end
 
-    def post(action:, path: "/#{action}", parameters: nil)
+    def post(action:, path: "/#{action}", headers: nil, body: nil, form_data: nil, username: nil, password: nil)
       path    = "/#{path}" unless path.start_with?("/")
-      request = Net::HTTP::Post.new(path)
-      request.set_form_data(parameters) if parameters
+      request = generic_request(path: path, verb: 'Post', headers: headers, body: body, form_data: form_data, auth: auth)
 
       response = request_with_retry(action: action, path: path, request: request)
 
       response.body
     end
 
+    def generic_request(path:, verb:, headers: nil, body: nil, form_data: nil, username: nil, password: nil)
+      raise(ArgumentError, 'setting form data will overwrite supplied content-type') unless headers_and_form_data_compatible? headers, form_data
+      raise(ArgumentError, 'setting form data will overwrite supplied body') if body && form_data
+
+      request = Net::HTTP.const_get(verb).new(path, headers)
+      request.body = body if body
+      request.set_form_data form_data if form_data
+      request.basic_auth(username, password) if username && password
+      request
+    end
+
     private
 
     def request_with_retry(action:, path: "/#{action}", request:, try_count: 0)
@@ -113,5 +123,10 @@ module OpinionatedHTTP
       return 0 if retry_count <= 1
       (retry_multiplier ** (retry_count - 1)) * retry_interval
     end
+
+    def headers_and_form_data_compatible?(headers, form_data)
+      return true if headers.nil? || form_data.nil?
+      !headers.keys.map(&:downcase).include? 'content-type'
+    end
   end
 end

data/lib/opinionated_http/version.rb

@@ -1,3 +1,3 @@
 module OpinionatedHTTP
-  VERSION = "0.0.3".freeze
+  VERSION = "0.0.4".freeze
 end

data/test/client_test.rb

@@ -28,6 +28,83 @@ module OpinionatedHTTP
           # end
         end
       end
+
+      describe "generic_request" do
+        let(:path) { '/fake_action' }
+        let(:post_verb) { 'Post' }
+        let(:get_verb) { 'Get' }
+
+        it 'creates a request corresponding to the supplied verb' do
+          req  = http.generic_request(path: path, verb: post_verb)
+          req2 = http.generic_request(path: path, verb: get_verb)
+
+          assert_kind_of Net::HTTP::Post, req
+          assert_kind_of Net::HTTP::Get, req2
+        end
+
+        it 'returns a request with supplied headers' do
+          test_headers = {'test1' => 'yes_test_1', 'test2' => 'yes_test_2'}
+          req          = http.generic_request(path: path, verb: get_verb, headers: test_headers)
+
+          assert_equal test_headers['test1'], req['test1']
+          assert_equal test_headers['test2'], req['test2']
+        end
+
+        it 'returns a request with supplied body' do
+          test_body = "nice bod"
+          req       = http.generic_request(path: path, verb: get_verb, body: test_body)
+
+          assert_equal test_body, req.body
+        end
+
+        it 'returns a request with supplied form data in x-www-form-urlencoded Content-Type' do
+          test_data = {test1: 'yes', test2: 'no'}
+          expected_string = "test1=yes&test2=no"
+          req = http.generic_request(path: path, verb: post_verb, form_data: test_data)
+
+          assert_equal expected_string, req.body
+          assert_equal 'application/x-www-form-urlencoded', req['Content-Type']
+        end
+
+        it 'add supplied authentication to the request' do
+          test_un = 'admin'
+          test_pw = 'hunter2'
+          req = http.generic_request(path: path, verb: get_verb, username: test_un, password: test_pw)
+          req2 = Net::HTTP::Get.new(path)
+          req2.basic_auth test_un, test_pw
+
+          assert_equal req2['authorization'], req['authorization']
+        end
+
+        it 'raise an error if supplied content-type header would be overwritten by setting form_data' do
+          downcase_headers    = {'unimportant' => 'blank', 'content-type' => 'application/json'}
+          capitalized_headers = {'Unimportant' => 'blank', 'Content-Type' => 'application/json'}
+          no_conflict_headers = {'whatever' => 'blank', 'irrelevant' => 'test'}
+          form_data           = {thing1: 1, thing2: 2}
+
+          assert_raises ArgumentError do
+            http.generic_request(path: path, verb: post_verb, headers: downcase_headers, form_data: form_data)
+          end
+
+          assert_raises ArgumentError do
+            http.generic_request(path: path, verb: post_verb, headers: capitalized_headers, form_data: form_data)
+          end
+
+          assert http.generic_request(path: path, verb: post_verb, headers: no_conflict_headers, form_data: form_data)
+        end
+
+        it 'raise an error if there is a collision between supplied body and form_data' do
+          form_data = {thing1: 1, thing2: 2}
+          body      = "not form data"
+
+          assert_raises ArgumentError do
+            http.generic_request(path: path, verb: post_verb, body: body, form_data: form_data)
+          end
+
+          assert http.generic_request(path: path, verb: post_verb, body: body)
+          assert http.generic_request(path: path, verb: post_verb, form_data: form_data)
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opinionated_http
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-24 00:00:00.000000000 Z
+date: 2020-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: persistent_http
@@ -87,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Opinionated HTTP Client