jalc 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eccd488a68365b574a6545965ead9f49c4f49102d4296be4d2dc01ca05201035
-  data.tar.gz: 369a77d191d672afae36aa01d404d0bfc7b79a89ea71225c84b8754cd8e8ad3e
+  metadata.gz: f6ef2b1726c1a8125061c025f1a0541575a4ee32db0a3b2ea5b33f83e07a60e1
+  data.tar.gz: 58155b4c3b29f9e01008ef6dffe0de0d5d1ef8a01420e1ad5dbefaa2a37df595
 SHA512:
-  metadata.gz: 8a6a6882a2855ea1887600d6980419900a329c3ee9594704ae6ab8fbac0f0e60516475fe6d994975159e440afa6e6185be4e249cc462511a3acb39471998c94c
-  data.tar.gz: 20cc3fd0dae75d85d173b8be824421d3bf641ab154c4c7026d252380211b9b46adfb23c7e7fc23ebb24c5484d7b1dcf7cbda8dc809fe7e90c6dc4c007f0ff90b
+  metadata.gz: 6af032f2082c19d0db3898818198cd053264595d8cce4b56dca119a32b00879cff23fa2ff4ad0e102d6040bb2e72f2bf60fa5235eeb6aea113dfdd337b21d6e4
+  data.tar.gz: 172cae3930c2444266d88abc2c08528964eaee60112840951b5d3d363b0cd09fbc8bc349b8c70a2807b95234188e5afebb8dc46d4775ce8974b702d91668a219

data/.devcontainer/devcontainer.json

@@ -0,0 +1,31 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ruby
+{
+	"name": "Ruby",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/ruby:0-2.7",
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": "gem i bundler && bin/setup",
+
+	// Configure tool-specific properties.
+	"customizations": {
+		"vscode": {
+      "extensions": [
+				"KoichiSasada.vscode-rdbg",
+				"castwide.solargraph",
+				"soutaro.rbs-syntax",
+				"soutaro.steep-vscode"
+			]
+    }
+	}
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

data/.rubocop.yml

@@ -2,9 +2,15 @@ require:
   - rubocop-rake
   - rubocop-rspec
 
+inherit_mode:
+  merge:
+    - Exclude
+
 AllCops:
   TargetRubyVersion: 2.7
   NewCops: enable
+  Exclude:
+    - gem_rbs_collection/**/*
 
 Metrics/BlockLength:
   Exclude:

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [2.2.0] - 2023-02-03
+
+- Stop using HTTP GET for Registration API
+- Use `errmsg` element for error messages
+
+## [2.1.2] - 2022-04-13
+
+- Fix the condition of log filtering
+
 ## [2.1.1] - 2022-04-08
 
 - Fix a typo of a registration API parameter

data/Gemfile

@@ -12,4 +12,6 @@ gem 'rspec'
 gem 'rubocop'
 gem 'rubocop-rake'
 gem 'rubocop-rspec'
+gem 'solargraph'
+gem 'steep'
 gem 'webmock'

data/Steepfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+D = Steep::Diagnostic
+
+target :lib do
+  signature 'sig', 'sig-private'
+  repo_path 'gem_rbs_collection/gems'
+
+  check 'lib'
+
+  library 'forwardable', 'logger', 'uri'
+  library 'faraday'
+
+  configure_code_diagnostics do |hash|
+    hash[D::Ruby::NoMethod] = :information
+    hash[D::Ruby::UnknownConstant] = :information
+
+    hash[D::Ruby::MethodDefinitionMissing] = nil # To supress noisy VS Code extension message.
+  end
+end

data/lib/jalc/registration/client.rb

@@ -29,12 +29,12 @@ module JaLC
       end
 
       def get_result(exec_id)
-        response = conn.get(
+        response = conn.post(
           '/jalc/infoRegistry/registDataResult/index',
           {
-            login_id: config.id,
-            login_passwd: config.password,
-            exec_id: exec_id,
+            login_id: Faraday::Multipart::ParamPart.new(config.id, 'text/plain'),
+            login_passwd: Faraday::Multipart::ParamPart.new(config.password, 'text/plain'),
+            exec_id: Faraday::Multipart::ParamPart.new(exec_id, 'text/plain'),
           },
         )
         response.body
@@ -51,11 +51,7 @@ module JaLC
           f.use Middleware::RaiseError
           f.use Middleware::ParseXML
           f.response :raise_error
-          if config.logger
-            f.response :logger, config.logger, { headers: false } do |logger|
-              logger.filter(/(password=)\w+/, '\1[FILTERED]')
-            end
-          end
+          f.response :logger, config.logger, { headers: false } if config.logger
         end
       end
     end

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

@@ -11,18 +11,26 @@ module JaLC
         def on_complete(env)
           case env.body.root.elements['head/errcd']&.text
           when '*'
-            raise AuthenticationError,
-                  'IDとパスワードの組合せが間違っているか、アクセス元のIPアドレスがJaLCに登録されているIPアドレスと異なっている可能性があります (errcd=*)'
+            raise AuthenticationError.new(doc: env.body)
           when '#'
-            raise InvalidXMLError, 'XMLファイルの構造に誤りがあるか、login_id、login_passwd、fnameのパラメータに未設定のものがある可能性があります (errcd=#)'
+            raise InvalidXMLError.new(doc: env.body)
           when '+'
-            raise RegistrationError, 'fnameで指定したファイルがXMLファイルでないか、XMLファイルの文字コードがUTF-8でない可能性があります (errcd=+)'
+            raise RegistrationError.new(doc: env.body)
           end
         end
       end
     end
 
-    class RegistrationError < Error; end
+    class RegistrationError < Error
+      attr_reader :doc
+
+      def initialize(msg = nil, doc:)
+        @doc = doc
+        msg ||= "#{doc.root.elements['head/errmsg']&.text} (errcd=#{doc.root.elements['head/errcd']&.text})"
+        super(msg)
+      end
+    end
+
     class AuthenticationError < RegistrationError; end
     class InvalidXMLError < RegistrationError; end
   end

data/lib/jalc/rest/client.rb

@@ -66,8 +66,8 @@ module JaLC
         begin
           require 'faraday_middleware'
         rescue LoadError
-          raise LoadError, 'faraday_middleware gem is required when using Faraday v1.' \
-                           " Please add `gem 'faraday_middleware'` to your Gemfile."
+          raise LoadError, 'faraday_middleware gem is required when using Faraday v1. ' \
+                           "Please add `gem 'faraday_middleware'` to your Gemfile."
         end
 
         retry

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

@@ -44,7 +44,7 @@ module JaLC
 
       def initialize(msg = nil, response: nil)
         @response = response
-        msg ||= response[:body].dig('message', 'errors', 'message') if response && response[:body].respond_to?(:dig)
+        msg ||= response[:body].dig('message', 'errors', 'message') if response && response[:body].is_a?(Hash)
         msg ||= "the server responded with status #{response[:status]}" if response
 
         super(msg)

data/lib/jalc/version.rb

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

data/sig/jalc.rbs

@@ -1,11 +1,9 @@
 module JaLC
-  interface _Logger
-  end
-
   VERSION: String
 
   module Registration
-    BASE_URL: String
+    self.@config: Config
+    self.@client: Client
 
     def self.configure: { (Config) -> void } -> void
     def self.config: -> Config
@@ -14,6 +12,9 @@ module JaLC
     end
     
     class RegistrationError < Error
+      def initialize: (?String? msg, doc: untyped) -> void
+                    
+      attr_reader doc: untyped # REXML::Document
     end
     
     class AuthenticationError < RegistrationError
@@ -23,28 +24,52 @@ module JaLC
     end
 
     class Client
-      interface _IO
-      end
-      type rexml_document = untyped
-
       def initialize: (Config config) -> void
-      def post: (_IO xml_file) -> rexml_document
-      def get_result: (Integer | String exec_id) -> rexml_document
+      
+      attr_reader config: Config
+      @conn: Faraday::Connection
+
+      def post: (IO | StringIO xml_file) -> untyped # REXML::Document
+      def get_result: (Integer | String exec_id) -> untyped # REXML::Document
+                    
+      private
+
+      def conn: -> Faraday::Connection
     end
 
     class Config
-      attr_accessor id: String?
-      attr_accessor password: String?
-      attr_accessor logger: _Logger?
+      DEFAULT_BASE_URL: String
       
       def initialize: -> void
+      
+      attr_accessor base_url: String
+      attr_accessor id: String?
+      attr_accessor password: String?
+      attr_accessor logger: Logger?
+    end
+
+    module Middleware
+      class ParseXML < Faraday::Middleware
+        def on_complete: (untyped env) -> void
+      end
+
+      class RaiseError < Faraday::Middleware
+        def on_complete: (untyped env) -> void
+      end
     end
   end
 
   module REST
-    type response_body = Hash[String, untyped] | String | nil
-
-    BASE_URL: String
+    type response_body = (Hash[String, untyped] | String)?
+    type response_hash = {
+      status: Integer,
+      headers: Hash[String, String],
+      body: response_body,
+      request: { method: Symbol, url: URI, headers: Hash[String, String], body: String? }
+    }
+                       
+    self.@config: Config
+    self.@client: Client
 
     def self.configure: { (Config) -> void } -> void
     def self.config: -> Config
@@ -53,11 +78,10 @@ module JaLC
     end
     
     class HTTPError < Error
-      type response_hash = {status: Integer, headers: Hash[String, String], body: response_body, request: {method: Symbol, url: URI, headers: Hash[String, String], body: String?}}
+      def initialize: (?String? msg, ?response: response_hash?) -> void
 
       attr_reader response: response_hash?
 
-      def initialize: (?String? msg, ?response: response_hash?) -> void
       def inspect: -> String
     end
 
@@ -75,15 +99,36 @@ module JaLC
     
     class Client
       def initialize: (Config config) -> void
+      
+      attr_reader config: Config
+      @conn: Faraday::Connection
+
       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
+             
+      private
+
+      def conn: -> Faraday::Connection
     end
 
     class Config
-      attr_accessor logger: _Logger?
+      DEFAULT_BASE_URL: String
       
       def initialize: -> void
+      
+      attr_accessor base_url: String
+      attr_accessor logger: Logger?  
+    end
+
+    module Middleware
+      class RaiseError < Faraday::Middleware
+        def on_complete: (untyped env) -> void
+                       
+        private
+
+        def response_values: (untyped env) -> response_hash
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jalc
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Takahiro Miyoshi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-08 00:00:00.000000000 Z
+date: 2023-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -65,6 +65,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".devcontainer/devcontainer.json"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -73,6 +74,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - bin/console
 - bin/setup
 - jalc.gemspec
@@ -114,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: JaLC (Japan Link Center) API Client