seibii-http 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dfecc45546053e16000e455aeb59cb5bae730a8016dc832a7159f270bb399a3
-  data.tar.gz: 6855c9af527d966b3a9aef3474183732d395aedb22525244c390d726c96b3274
+  metadata.gz: '049d320d3ad81582683158b91dc868413b5c4e169125b31c2a44f96c23ece44d'
+  data.tar.gz: 5807f9ba69b6d4f8ee5e08ddf0164fe0fe57ae140316a8b5a41d3a9545d145e1
 SHA512:
-  metadata.gz: a3147076b8719d15a7418ff28f301795155f85a87ac82e765217d2ed40f6079c278fdefb0b080a408371f68803a27acb849c9c0f473a7617a2effcc9c5cf0bf9
-  data.tar.gz: 7d49c4bb540abd124d9f51cc4de1435ec8d29a979824b6fbaf204e24a6bf303fb117343b4a30e9f9dd340fcde87e0eeba367e98c2d25170e36e8d5d6e7e933ba
+  metadata.gz: c66ac55bb44a41272d1c77d0f57c328320307ed9077c4f8f32dcb92ee0487525fd0ee4d8a3e35b85a71b3a07b2a1abab0d707db8cd0cbff5c7327eb871016ea5
+  data.tar.gz: 445459558e6c883b0c5d8e921827469a87af65308aeefdd4eaa08ba0d36e516c2b4a7398bf48bcfa70843ee244c0ced97c57db1d82e630f271651ebaadc132d5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    seibii-http (0.1.0)
+    seibii-http (1.0.0)
       oj
 
 GEM

data/README.md

@@ -14,10 +14,15 @@ gem 'seibii-http'
 ### Base client
 ```ruby
 def get
-  Seibii::Http::Clients::Base.new(logger: ->() { |log| Rails.logger.debug(log) })
-    .request(method: :get, uri: URI.parse('https://example.com/example'), request_body: nil, headers: { Accept: '*/*' })
-    #=> response body String
-rescue Seibii::Http::ClientError => e
+  Seibii::Http::Clients::Base
+    .new(logger: ->() { |log| Rails.logger.debug(log) }) # logger is optional
+    .request(
+       method: :get, # required
+       uri: URI.parse('https://example.com/example'), # required
+       request_body: nil, # optional
+       headers: { Accept: '*/*' } # optional
+    ) #=> response body String
+rescue Seibii::Http::ClientError => e # 404 will not raise exception but just return nil response
   p e
   p e.response.status #=> 400..499
   p e.response.body
@@ -29,14 +34,22 @@ end
 ```
 
 ### Json client
+- `{ Content-Type: 'application/json`, Accept: 'application/json'}` headers will be added.
+- You can use hash to make request parameters and receive response
+
 ```ruby
 def post
-  Seibii::Http::Clients::Json.new(logger: ->() { |log| Rails.logger.debug(log) })
-    .request(method: :post, uri: URI.parse('https://example.com/example'), params: { a: 'b', c: 'd' }, headers: { Authorization: 'Bearer token' })
-    #=> response json hash
-rescue Seibii::Http::ClientError => e
+  Seibii::Http::Clients::Json
+    .new(logger: ->() { |log| Rails.logger.debug(log) }) # logger is optional
+    .request(
+       method: :post, # required
+       uri: URI.parse('https://example.com/example'), # required
+       params: { a: 'b', c: 'd' }, # optional
+       headers: { Authorization: 'Bearer token' } # optional
+    ) #=> response json hash
+rescue Seibii::Http::ClientError => e # 404 will not raise exception but just return nil response
   p e
-  p e.response.status #=> 400..499
+  p e.response.status #=> 400..499 
   p e.response.body
 rescue Seibii::Http::ServerError => e
   p e

data/lib/seibii/http/clients/base.rb

@@ -9,7 +9,8 @@ module Seibii
         end
 
         def request(method:, uri:, request_body: nil, headers: {})
-          with_logging(uri) { http(uri).request(request_object(method, uri, request_body, headers)) }
+          parsed_uri = URI.parse(uri)
+          with_logging(uri) { http(parsed_uri).request(request_object(method, parsed_uri, request_body, headers)) }
             .yield_self { |response| handle_http_status(response) }
         end
 

data/lib/seibii/http/version.rb

@@ -2,6 +2,6 @@
 
 module Seibii
   module Http
-    VERSION = '0.1.0'
+    VERSION = '1.0.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seibii-http
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Yuji Ueki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-25 00:00:00.000000000 Z
+date: 2020-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj