jalc 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96ec63df2a4d939e8eb433fff06fe70d84536174ab759755314dbf67fd21c900
-  data.tar.gz: 25288558d0cfb086f73d72634051892d48bf9a21e64de7aa9bb06a72b44dc153
+  metadata.gz: 6906443971313b98068ef7816cfde731a473da34698637fafdaeeb99c2409150
+  data.tar.gz: 35272d82457609a1cb8238bbceb7b69b0b5bcfddb9b1d92a8cbc145459ca3ada
 SHA512:
-  metadata.gz: 286ab06114bd1b84518239c7b4e801f67a1a275d9e8b9f11e379df59dd66aaa319743849735495c5420f2811f8d5dba879ed162a00a15f805403ab26fd71ca05
-  data.tar.gz: b1fbb0ebed28715ea7dfaee774652eef36ccef399c2bc89c2fbe1d260e9a08d84937720fc144665afca3d8799ce325491ede9ce835701b27241e24623fdeec71
+  metadata.gz: 2b50fda5332b2cca03aeb53954f45cd734ed6122377b5fe363370948729e5023133203178e63b5f37723b352a778af5c5e302a3e487c668e37c77edf30a3156f
+  data.tar.gz: c87b1536b93b0766312f228425da6c97339a86f8b90eea24ea38ee7118bb796c40872bf22f67d738f9503187ec35634a64f70dcac9c4a01dcfef06e6c8d7a865

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [2.0.0] - 2022-01-10
+
+- Change the return values from `Faraday::Response` to its `#body`
+
 ## [1.2.0] - 2022-01-10
 
 - Filter password on logs

data/README.md

@@ -31,15 +31,15 @@ JaLC::REST.config.logger = MyLogger.new
 
 # GET /prefixes
 prefixes_res = JaLC::REST.prefixes(ra: 'JaLC', sort: 'siteId', order: 'desc')
-prefix = prefixes_res.body['data']['items'].first['prefix'] #=> "10.123"
+prefix = prefixes_res['data']['items'].first['prefix'] #=> "10.123"
 
 # GET /doilist/:prefix
 doilist_res = JaLC::REST.doilist(prefix, rows: 100)
-doi = doilist_res.body['data']['items'].last['dois']['doi'] #=> "10.123/abc"
+doi = doilist_res['data']['items'].last['dois']['doi'] #=> "10.123/abc"
 
 # GET /dois/:doi
 doi_res = JaLC::REST.doi(doi)
-doi_res.body['data']
+doi_res['data']
 ```
 
 ### JaLC Registration API
@@ -55,10 +55,8 @@ JaLC::Registration.configure do |config|
   config.logger = nil
 end
 
-res = JaLC::Registration.post(File.open('/path/to/xml'))
-
-# body is an REXML::Document
-res.body.root.elements['head/okcnt'].text #=> "1"
+res = JaLC::Registration.post(File.open('/path/to/xml')) # returns a REXML::Document
+res.root.elements['head/okcnt'].text #=> "1"
 
 # async registration (result_method=2)
 async_res = JaLC::Registration.post(StringIO.new(<<~XML))
@@ -73,10 +71,10 @@ async_res = JaLC::Registration.post(StringIO.new(<<~XML))
     </body
   </root>
 XML
-exec_id = async_res.body.root.elements['head/exec_id'].text #=> "12345"
+exec_id = async_res.root.elements['head/exec_id'].text #=> "12345"
 
 result_res = JaLC::Registration.get_result(exec_id)
-result_res.body.root.elements['head/status'].text #=> "2"
+result_res.root.elements['head/status'].text #=> "2"
 ```
 
 ## Development

data/lib/jalc/registration/client.rb

@@ -20,7 +20,7 @@ module JaLC
       end
 
       def post(xml_file)
-        conn.post(
+        response = conn.post(
           '/jalc/infoRegistry/registDataReceive/index',
           {
             login_id: Faraday::Multipart::ParamPart.new(@id, 'text/plain'),
@@ -28,10 +28,11 @@ module JaLC
             fname: Faraday::Multipart::FilePart.new(xml_file, 'text/xml'),
           },
         )
+        response.body
       end
 
       def get_result(exec_id)
-        conn.get(
+        response = conn.get(
           '/jalc/infoRegistry/registDataResult/index',
           {
             login_id: @id,
@@ -39,6 +40,7 @@ module JaLC
             exec_id: exec_id,
           },
         )
+        response.body
       end
 
       private

data/lib/jalc/rest/client.rb

@@ -18,7 +18,7 @@ module JaLC
       end
 
       def prefixes(ra: nil, sort: nil, order: nil)
-        conn.get(
+        response = conn.get(
           '/prefixes',
           {
             ra: ra,
@@ -26,10 +26,11 @@ module JaLC
             order: order,
           }.compact,
         )
+        response.body
       end
 
       def doilist(prefix, from: nil, to: nil, rows: nil, page: nil, sort: nil, order: nil)
-        conn.get(
+        response = conn.get(
           "/doilist/#{prefix}",
           {
             from: from,
@@ -40,11 +41,13 @@ module JaLC
             order: order,
           }.compact,
         )
+        response.body
       end
 
       def doi(doi)
         encoded_doi = URI.encode_www_form_component(URI.encode_www_form_component(doi))
-        conn.get("/dois/#{encoded_doi}")
+        response = conn.get("/dois/#{encoded_doi}")
+        response.body
       end
 
       private

data/lib/jalc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JaLC
-  VERSION = '1.2.0'
+  VERSION = '2.0.0'
 end

data/sig/jalc.rbs

@@ -1,6 +1,7 @@
-type faraday_response = untyped
-
 module JaLC
+  interface _Logger
+  end
+
   VERSION: String
 
   module Registration
@@ -24,22 +25,25 @@ module JaLC
     class Client
       interface _IO
       end
+      type rexml_document = untyped
 
-      def initialize: (id: String, password: String, ?logger: Logger?, ?base_url: String) -> void
-      def post: (_IO xml_file) -> faraday_response
-      def get_result: (Integer | String exec_id) -> faraday_response
+      def initialize: (id: String, password: String, ?logger: _Logger?, ?base_url: String) -> void
+      def post: (_IO xml_file) -> rexml_document
+      def get_result: (Integer | String exec_id) -> rexml_document
     end
 
     class Config
       attr_accessor id: String?
       attr_accessor password: String?
-      attr_accessor logger: Logger?
+      attr_accessor logger: _Logger?
       
       def initialize: -> void
     end
   end
 
   module REST
+    type response_body = Hash[String, untyped] | String | nil
+
     BASE_URL: String
 
     def self.configure: { (Config) -> void } -> void
@@ -49,8 +53,7 @@ module JaLC
     end
     
     class HTTPError < Error
-      type faraday_header = untyped
-      type response_hash = {status: Integer, headers: faraday_header, body: untyped, request: {method: Symbol, url: URI, headers: faraday_header, body: String?}}
+      type response_hash = {status: Integer, headers: Hash[String, String], body: response_body, request: {method: Symbol, url: URI, headers: Hash[String, String], body: String?}}
 
       attr_reader response: response_hash?
 
@@ -71,14 +74,14 @@ module JaLC
     end
     
     class Client
-      def initialize: (?logger: Logger?, ?base_url: String) -> void
-      def prefixes: (?ra: String?, ?sort: String?, ?order: String?) -> faraday_response
-      def doilist: (String, ?from: String?, ?to: String?, ?rows: Integer? | String?, ?page: Integer? | String?, ?sort: String?, ?order: String?) -> faraday_response
-      def doi: (String) -> faraday_response
+      def initialize: (?logger: _Logger?, ?base_url: String) -> void
+      def prefixes: (?ra: String?, ?sort: String?, ?order: String?) -> response_body
+      def doilist: (String, ?from: String?, ?to: String?, ?rows: Integer? | String?, ?page: Integer? | String?, ?sort: String?, ?order: String?) -> response_body
+      def doi: (String) -> response_body
     end
 
     class Config
-      attr_accessor logger: Logger?
+      attr_accessor logger: _Logger?
       
       def initialize: -> void
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jalc
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Takahiro Miyoshi