jalc 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5112d02828c77713d27f6f817b8360b2ba4d7f494116e6e29c7c838a467f612
-  data.tar.gz: c2e4c484221e81cbcc41538a7773a61aab622ce9c463a5887897f71fafc92373
+  metadata.gz: a5925914098939b17ec3a6743ea89d5c4ffd2d0eee02a6953f82154b2c16f5fe
+  data.tar.gz: 4cd2066ea1a7c87959bb69ac6daa04dee66eaec8510a496630b06f4b33f4f55b
 SHA512:
-  metadata.gz: 164852ecb1e72be40a39e609a055de250a3d69446a317ca71a76ae9895c7003c2215b1bdd3a65b1c9a72faffe91247cfdb160e640acce4cf2de5d43a4d5056dd
-  data.tar.gz: 6ef81e529ec75c794a66605698a5aadb2c632fe2149df97d7b1f237c488bf9348e09c7757af376c17a4348bd2c95004fd7c5556c484e6985ef035b31faf8b165
+  metadata.gz: ef5428a39e9a9164678f47f53ec0db79c15523f8f09d6f0e066f24d0071655834adb68476c120a262f2a9f24424235b03bce0462ab28193f7484f04aac91c77a
+  data.tar.gz: 907e630e36856c8624da546b67971c9e37937b68b560415dfb2309efb448de5ab7376b41d61ed82f97b25bdce4bf152a1cb9175dd3bd5526573409b038f3a81f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [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

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_password: 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_password: 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.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.1'
+  VERSION = '2.1.0'
 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,7 +74,7 @@ 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 prefix, ?from: String?, ?to: String?, ?rows: Integer? | String?, ?page: Integer? | String?, ?sort: String?, ?order: String?) -> response_body
       def doi: (String doi) -> response_body

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jalc
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Takahiro Miyoshi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-06 00:00:00.000000000 Z
+date: 2022-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday