jalc 1.2.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96ec63df2a4d939e8eb433fff06fe70d84536174ab759755314dbf67fd21c900
-  data.tar.gz: 25288558d0cfb086f73d72634051892d48bf9a21e64de7aa9bb06a72b44dc153
+  metadata.gz: a5925914098939b17ec3a6743ea89d5c4ffd2d0eee02a6953f82154b2c16f5fe
+  data.tar.gz: 4cd2066ea1a7c87959bb69ac6daa04dee66eaec8510a496630b06f4b33f4f55b
 SHA512:
-  metadata.gz: 286ab06114bd1b84518239c7b4e801f67a1a275d9e8b9f11e379df59dd66aaa319743849735495c5420f2811f8d5dba879ed162a00a15f805403ab26fd71ca05
-  data.tar.gz: b1fbb0ebed28715ea7dfaee774652eef36ccef399c2bc89c2fbe1d260e9a08d84937720fc144665afca3d8799ce325491ede9ce835701b27241e24623fdeec71
+  metadata.gz: ef5428a39e9a9164678f47f53ec0db79c15523f8f09d6f0e066f24d0071655834adb68476c120a262f2a9f24424235b03bce0462ab28193f7484f04aac91c77a
+  data.tar.gz: 907e630e36856c8624da546b67971c9e37937b68b560415dfb2309efb448de5ab7376b41d61ed82f97b25bdce4bf152a1cb9175dd3bd5526573409b038f3a81f

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [2.1.0] - 2022-04-07
+
+- Update the constructor arguments of REST::Client and Registration::Client
+
+## [2.0.1] - 2022-03-06
+
+- Make the registration error messages Japanese
+
+## [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
@@ -50,15 +50,14 @@ See https://japanlinkcenter.org/top/doc/JaLC_tech_interface_doc.pdf for API deta
 require 'jalc'
 
 JaLC::Registration.configure do |config|
+  config.base_url = 'https://japanlinkcenter.org' # default
   config.id = 'sankichi92'
   config.password = ENV['JALC_PASSWORD']
   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 +72,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

@@ -9,51 +9,50 @@ require_relative 'middleware/raise_error'
 
 module JaLC
   module Registration
-    BASE_URL = 'https://japanlinkcenter.org'
-
     class Client
-      def initialize(id:, password:, logger: nil, base_url: BASE_URL)
-        @id = id
-        @password = password
-        @logger = logger
-        @base_url = base_url
+      attr_reader :config
+
+      def initialize(config)
+        @config = config
       end
 
       def post(xml_file)
-        conn.post(
+        response = conn.post(
           '/jalc/infoRegistry/registDataReceive/index',
           {
-            login_id: Faraday::Multipart::ParamPart.new(@id, 'text/plain'),
-            login_password: Faraday::Multipart::ParamPart.new(@password, 'text/plain'),
+            login_id: Faraday::Multipart::ParamPart.new(config.id, 'text/plain'),
+            login_password: Faraday::Multipart::ParamPart.new(config.password, 'text/plain'),
             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,
-            login_password: @password,
+            login_id: config.id,
+            login_password: config.password,
             exec_id: exec_id,
           },
         )
+        response.body
       end
 
       private
 
       def conn
         @conn ||= Faraday.new(
-          url: @base_url,
+          url: config.base_url,
           headers: { 'User-Agent' => "jalc-ruby v#{VERSION}" },
         ) do |f|
           f.request :multipart
           f.use Middleware::RaiseError
           f.use Middleware::ParseXML
           f.response :raise_error
-          if @logger
-            f.response :logger, @logger, { headers: false } do |logger|
+          if config.logger
+            f.response :logger, config.logger, { headers: false } do |logger|
               logger.filter(/(password=)\w+/, '\1[FILTERED]')
             end
           end

data/lib/jalc/registration/config.rb

@@ -5,9 +5,12 @@ require 'logger'
 module JaLC
   module Registration
     class Config
-      attr_accessor :id, :password, :logger
+      DEFAULT_BASE_URL = 'https://japanlinkcenter.org'
+
+      attr_accessor :base_url, :id, :password, :logger
 
       def initialize
+        @base_url = DEFAULT_BASE_URL
         @id = nil
         @password = nil
         @logger = ::Logger.new($stdout)

data/lib/jalc/registration/middleware/raise_error.rb

@@ -12,11 +12,11 @@ module JaLC
           case env.body.root.elements['head/errcd']&.text
           when '*'
             raise AuthenticationError,
-                  'Wrong login_id/login_password or non-registered IP address request (errcd=*)'
+                  'IDとパスワードの組合せが間違っているか、アクセス元のIPアドレスがJaLCに登録されているIPアドレスと異なっている可能性があります (errcd=*)'
           when '#'
-            raise InvalidXMLError, 'XML format is invalid or any required params are blank (errcd=#)'
+            raise InvalidXMLError, 'XMLファイルの構造に誤りがあるか、login_id、login_passwd、fnameのパラメータに未設定のものがある可能性があります (errcd=#)'
           when '+'
-            raise RegistrationError, 'Non-XML file, non UTF-8 encoding or other error (errcd=+)'
+            raise RegistrationError, 'fnameで指定したファイルがXMLファイルでないか、XMLファイルの文字コードがUTF-8でない可能性があります (errcd=+)'
           end
         end
       end

data/lib/jalc/registration.rb

@@ -23,11 +23,7 @@ module JaLC
       private
 
       def client
-        @client ||= Client.new(
-          id: config.id,
-          password: config.password,
-          logger: config.logger,
-        )
+        @client ||= Client.new(config)
       end
     end
   end

data/lib/jalc/rest/client.rb

@@ -9,16 +9,15 @@ require_relative '../version'
 
 module JaLC
   module REST
-    BASE_URL = 'https://api.japanlinkcenter.org'
-
     class Client
-      def initialize(logger: nil, base_url: BASE_URL)
-        @logger = logger
-        @base_url = base_url
+      attr_reader :config
+
+      def initialize(config)
+        @config = config
       end
 
       def prefixes(ra: nil, sort: nil, order: nil)
-        conn.get(
+        response = conn.get(
           '/prefixes',
           {
             ra: ra,
@@ -26,10 +25,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,23 +40,25 @@ 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
 
       def conn
         @conn ||= Faraday.new(
-          url: @base_url,
+          url: config.base_url,
           headers: { 'User-Agent' => "jalc-ruby v#{VERSION}" },
         ) do |f|
           f.use Middleware::RaiseError
           f.response :json
-          f.response :logger, @logger, { headers: false } if @logger
+          f.response :logger, config.logger, { headers: false } if config.logger
         end
       rescue Faraday::Error => e
         raise e unless e.message.match?(/is not registered/)

data/lib/jalc/rest/config.rb

@@ -5,9 +5,12 @@ require 'logger'
 module JaLC
   module REST
     class Config
-      attr_accessor :logger
+      DEFAULT_BASE_URL = 'https://api.japanlinkcenter.org'
+
+      attr_accessor :base_url, :logger
 
       def initialize
+        @base_url = DEFAULT_BASE_URL
         @logger = ::Logger.new($stdout)
       end
     end

data/lib/jalc/rest.rb

@@ -23,7 +23,7 @@ module JaLC
       private
 
       def client
-        @client ||= Client.new(logger: config.logger)
+        @client ||= Client.new(config)
       end
     end
   end

data/lib/jalc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JaLC
-  VERSION = '1.2.0'
+  VERSION = '2.1.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: (Config config) -> 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: (Config config) -> void
+      def prefixes: (?ra: String?, ?sort: String?, ?order: String?) -> response_body
+      def doilist: (String prefix, ?from: String?, ?to: String?, ?rows: Integer? | String?, ?page: Integer? | String?, ?sort: String?, ?order: String?) -> response_body
+      def doi: (String doi) -> response_body
     end
 
     class Config
-      attr_accessor logger: Logger?
+      attr_accessor logger: _Logger?
       
       def initialize: -> void
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jalc
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Takahiro Miyoshi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-10 00:00:00.000000000 Z
+date: 2022-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -114,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: JaLC (Japan Link Center) API Client