jalc 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6906443971313b98068ef7816cfde731a473da34698637fafdaeeb99c2409150
-  data.tar.gz: 35272d82457609a1cb8238bbceb7b69b0b5bcfddb9b1d92a8cbc145459ca3ada
+  metadata.gz: eccd488a68365b574a6545965ead9f49c4f49102d4296be4d2dc01ca05201035
+  data.tar.gz: 369a77d191d672afae36aa01d404d0bfc7b79a89ea71225c84b8754cd8e8ad3e
 SHA512:
-  metadata.gz: 2b50fda5332b2cca03aeb53954f45cd734ed6122377b5fe363370948729e5023133203178e63b5f37723b352a778af5c5e302a3e487c668e37c77edf30a3156f
-  data.tar.gz: c87b1536b93b0766312f228425da6c97339a86f8b90eea24ea38ee7118bb796c40872bf22f67d738f9503187ec35634a64f70dcac9c4a01dcfef06e6c8d7a865
+  metadata.gz: 8a6a6882a2855ea1887600d6980419900a329c3ee9594704ae6ab8fbac0f0e60516475fe6d994975159e440afa6e6185be4e249cc462511a3acb39471998c94c
+  data.tar.gz: 20cc3fd0dae75d85d173b8be824421d3bf641ab154c4c7026d252380211b9b46adfb23c7e7fc23ebb24c5484d7b1dcf7cbda8dc809fe7e90c6dc4c007f0ff90b

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [2.1.1] - 2022-04-08
+
+- Fix a typo of a registration API parameter
+
+## [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`

data/README.md

@@ -50,6 +50,7 @@ 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

data/lib/jalc/registration/client.rb

@@ -9,22 +9,19 @@ 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)
         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_passwd: Faraday::Multipart::ParamPart.new(config.password, 'text/plain'),
             fname: Faraday::Multipart::FilePart.new(xml_file, 'text/xml'),
           },
         )
@@ -35,8 +32,8 @@ module JaLC
         response = conn.get(
           '/jalc/infoRegistry/registDataResult/index',
           {
-            login_id: @id,
-            login_password: @password,
+            login_id: config.id,
+            login_passwd: config.password,
             exec_id: exec_id,
           },
         )
@@ -47,15 +44,15 @@ module JaLC
 
       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,12 +9,11 @@ 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)
@@ -54,12 +53,12 @@ module JaLC
 
       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 = '2.0.0'
+  VERSION = '2.1.1'
 end

data/sig/jalc.rbs

@@ -27,7 +27,7 @@ module JaLC
       end
       type rexml_document = untyped
 
-      def initialize: (id: String, password: String, ?logger: _Logger?, ?base_url: String) -> void
+      def initialize: (Config config) -> void
       def post: (_IO xml_file) -> rexml_document
       def get_result: (Integer | String exec_id) -> rexml_document
     end
@@ -74,10 +74,10 @@ module JaLC
     end
     
     class Client
-      def initialize: (?logger: _Logger?, ?base_url: String) -> void
+      def initialize: (Config config) -> 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
+      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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jalc
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Takahiro Miyoshi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-10 00:00:00.000000000 Z
+date: 2022-04-08 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