RubyGems - jalc - Versions diffs - 1.0.0 → 1.1.0 - Mend

jalc 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (17) hide show

checksums.yaml +4 -4
data/.rubocop.yml +3 -0
data/CHANGELOG.md +4 -0
data/README.md +34 -0
data/jalc.gemspec +2 -0
data/lib/jalc/registration/client.rb +60 -0
data/lib/jalc/registration/config.rb +17 -0
data/lib/jalc/registration/error.rb +8 -0
data/lib/jalc/registration/middleware/parse_xml.rb +15 -0
data/lib/jalc/registration/middleware/raise_error.rb +29 -0
data/lib/jalc/registration.rb +34 -0
data/lib/jalc/rest/client.rb +2 -2
data/lib/jalc/rest/error.rb +1 -28
data/lib/jalc/rest/{response → middleware}/raise_error.rb +29 -1
data/lib/jalc/version.rb +1 -1
data/lib/jalc.rb +1 -0
metadata +23 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fdce5e853ede1ac804e51da6a9bf0b7532837ff1498aa6add35eceaee2d0687
-  data.tar.gz: ad553fdc076b4ae3ad9b17b22f2b0286f676a342bae260c890e9a9c4c304a773
+  metadata.gz: 0dc45fa2ad1bb26e588c4b99dcd4b79ce9ef6eb1b1ce758fc241b1aefcf553a1
+  data.tar.gz: 4ab4bd89829b7ad3af731359e9bf0424585e2991255e4a6e29564991937d94d5
 SHA512:
-  metadata.gz: 40bda7b62fb1957ef8642c84df04d9181445f98762c130637e7f23140b7021efc8688159774456ea3a5d4318654988cfb68360d54b74ec81be20d8d3ad774fcb
-  data.tar.gz: e372dc2f3c0ac7982b72f551a5f9901289a3c56229c6b4c1b892b3f5abcbf88553557aca262c15f81d62a7540a769432083086bf05ddbe0e0352e2885d070cf7
+  metadata.gz: b105bfbf4b983932942144f965d45016ed7d64df42448d425ac94d53479f030f9ddd9bbbc3bdfcb5951fc13365233cdb888fe04478a377caba897d9f5f5e6feb
+  data.tar.gz: 3465ba5121e720647d40f0dca8b8060990736ea0d712a06b0d6f926a5700966a731f28a1382c84562246498c188b0c22b9ba5d0c01384d27bb2a225e94735bfd

data/.rubocop.yml CHANGED Viewed

@@ -22,6 +22,9 @@ Naming/MethodParameterName:
 Style/Documentation:
   Enabled: false
+Style/NumericLiterals:
+  Enabled: false
 Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: consistent_comma

data/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,9 @@
 ## [Unreleased]
+## [1.1.0] - 2022-01-10
+- Add JaLC::Registration for the registration API
 ## [1.0.0] - 2022-01-09
 - Initial release

data/README.md CHANGED Viewed

@@ -42,6 +42,40 @@ doi_res = JaLC::REST.doi(doi)
 doi_res.body['data']
 ```
+### JaLC Registration API
+See https://japanlinkcenter.org/top/doc/JaLC_tech_interface_doc.pdf for API detail
+```ruby
+require 'jalc'
+JaLC::Registration.configure do |config|
+  config.id = 'sankichi92'
+  config.password = ENV['JALC_PASSWORD']
+end
+res = JaLC::Registration.post(File.open('/path/to/xml'))
+# response.body is an instance of REXML::Document
+res.body.root.elements['head/okcnt'].text #=> 1
+# With XML head/result_method=2 (Async)
+async_res = JaLC::Registration.post(StringIO.new(<<~XML))
+  <?xml version="1.0" encoding="UTF-8"?>
+  <root>
+    <head>
+      <result_method>2</result_method>
+    </head>
+    <body>
+      ...
+    </body
+  </root>
+XML
+exec_id = async_res.body.root.elements['head/exec_id'].text #=> 12345
+result_res = JaLC::Registration.get_result(exec_id)
+res.body.root.elements['head/status'].text
+```
 ## Development
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/jalc.gemspec CHANGED Viewed

@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/sankichi92/jalc-ruby'
   spec.metadata['changelog_uri'] = 'https://github.com/sankichi92/jalc-ruby/blob/main/CHANGELOG.md'
+  spec.metadata['github_repo'] = 'https://github.com/sankichi92/jalc-ruby.git'
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -30,6 +31,7 @@ Gem::Specification.new do |spec|
   # Uncomment to register a new dependency of your gem
   spec.add_dependency 'faraday', '>= 1.0', '< 3.0'
+  spec.add_dependency 'faraday-multipart', '~> 1.0'
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/jalc/registration/client.rb ADDED Viewed

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+require 'faraday'
+require 'faraday/multipart'
+require_relative '../version'
+require_relative 'middleware/parse_xml'
+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
+      end
+      def post(xml_file)
+        conn.post(
+          '/jalc/infoRegistry/registDataReceive/index',
+          {
+            login_id: Faraday::Multipart::ParamPart.new(@id, 'text/plain'),
+            login_password: Faraday::Multipart::ParamPart.new(@password, 'text/plain'),
+            fname: Faraday::Multipart::FilePart.new(xml_file, 'text/xml'),
+          },
+        )
+      end
+      def get_result(exec_id)
+        conn.get(
+          '/jalc/infoRegistry/registDataResult/index',
+          {
+            login_id: @id,
+            login_password: @password,
+            exec_id: exec_id,
+          },
+        )
+      end
+      private
+      def conn
+        @conn ||= Faraday.new(
+          url: @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
+          f.response :logger, @logger, { headers: false } if @logger
+        end
+      end
+    end
+  end
+end

data/lib/jalc/registration/config.rb ADDED Viewed

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require 'logger'
+module JaLC
+  module Registration
+    class Config
+      attr_accessor :id, :password, :logger
+      def initialize
+        @id = nil
+        @password = nil
+        @logger = ::Logger.new($stdout)
+      end
+    end
+  end
+end

data/lib/jalc/registration/error.rb ADDED Viewed

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module JaLC
+  module Registration
+    class Error < StandardError
+    end
+  end
+end

data/lib/jalc/registration/middleware/parse_xml.rb ADDED Viewed

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+require 'rexml'
+module JaLC
+  module Registration
+    module Middleware
+      class ParseXML < Faraday::Middleware
+        def on_complete(env)
+          env[:body] = REXML::Document.new(env[:body].to_s)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+require 'faraday'
+require_relative '../error'
+module JaLC
+  module Registration
+    module Middleware
+      class RaiseError < Faraday::Middleware
+        def on_complete(env)
+          case env.body.root.elements['head/errcd']&.text
+          when '*'
+            raise AuthenticationError,
+                  'Wrong login_id/login_password or non-registered IP address request (errcd=*)'
+          when '#'
+            raise InvalidXMLError, 'XML format is invalid or any required params are blank (errcd=#)'
+          when '+'
+            raise RegistrationError, 'Non-XML file, non UTF-8 encoding or other error (errcd=+)'
+          end
+        end
+      end
+    end
+    class RegistrationError < Error; end
+    class AuthenticationError < RegistrationError; end
+    class InvalidXMLError < RegistrationError; end
+  end
+end

data/lib/jalc/registration.rb ADDED Viewed

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+require 'forwardable'
+require_relative 'registration/client'
+require_relative 'registration/config'
+module JaLC
+  module Registration
+    class << self
+      extend Forwardable
+      def_delegators :client, :post, :get_result
+      def configure
+        yield config
+      end
+      def config
+        @config ||= Config.new
+      end
+      private
+      def client
+        @client ||= Client.new(
+          id: config.id,
+          password: config.password,
+          logger: config.logger,
+        )
+      end
+    end
+  end
+end

data/lib/jalc/rest/client.rb CHANGED Viewed

@@ -4,7 +4,7 @@ require 'uri'
 require 'faraday'
-require_relative 'response/raise_error'
+require_relative 'middleware/raise_error'
 require_relative '../version'
 module JaLC
@@ -54,7 +54,7 @@ module JaLC
           url: @base_url,
           headers: { 'User-Agent' => "jalc-ruby v#{VERSION}" },
         ) do |f|
-          f.use Response::RaiseError
+          f.use Middleware::RaiseError
           f.response :json
           f.response :logger, @logger, { headers: false } if @logger
         end

data/lib/jalc/rest/error.rb CHANGED Viewed

@@ -1,35 +1,8 @@
 # frozen_string_literal: true
-require 'faraday'
 module JaLC
   module REST
-    class Error < StandardError; end
-    class HTTPError < Error
-      attr_reader :response
-      def initialize(msg = nil, response: nil)
-        @response = response
-        msg ||= response[:body].dig('message', 'errors', 'message') if response && response[:body].respond_to?(:dig)
-        msg ||= "the server responded with status #{response[:status]}" if response
-        super(msg)
-      end
-      def inspect
-        if response
-          %(#<#{self.class} response=#{response.inspect}>)
-        else
-          super
-        end
-      end
+    class Error < StandardError
     end
-    class ClientError < HTTPError; end
-    class BadRequestError < ClientError; end
-    class ResourceNotFound < ClientError; end
-    class ServerError < HTTPError; end
-    class NilStatusError < ServerError; end
   end
 end

data/lib/jalc/rest/{response → middleware}/raise_error.rb RENAMED Viewed

@@ -6,7 +6,7 @@ require_relative '../error'
 module JaLC
   module REST
-    class Response
+    class Middleware
       class RaiseError < Faraday::Middleware
         def on_complete(env)
           case env[:status]
@@ -26,6 +26,8 @@ module JaLC
           end
         end
+        private
         def response_values(env)
           {
             status: env.status,
@@ -41,5 +43,31 @@ module JaLC
         end
       end
     end
+    class HTTPError < Error
+      attr_reader :response
+      def initialize(msg = nil, response: nil)
+        @response = response
+        msg ||= response[:body].dig('message', 'errors', 'message') if response && response[:body].respond_to?(:dig)
+        msg ||= "the server responded with status #{response[:status]}" if response
+        super(msg)
+      end
+      def inspect
+        if response
+          %(#<#{self.class} response=#{response.inspect}>)
+        else
+          super
+        end
+      end
+    end
+    class ClientError < HTTPError; end
+    class BadRequestError < ClientError; end
+    class ResourceNotFound < ClientError; end
+    class ServerError < HTTPError; end
+    class NilStatusError < ServerError; end
   end
 end

data/lib/jalc/version.rb CHANGED Viewed

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

data/lib/jalc.rb CHANGED Viewed

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require_relative 'jalc/registration'
 require_relative 'jalc/rest'
 require_relative 'jalc/version'

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jalc
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Takahiro Miyoshi
@@ -30,6 +30,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description:
 email:
 - takahiro-miyoshi@sankichi.net
@@ -49,11 +63,17 @@ files:
 - bin/setup
 - jalc.gemspec
 - lib/jalc.rb
+- lib/jalc/registration.rb
+- lib/jalc/registration/client.rb
+- lib/jalc/registration/config.rb
+- lib/jalc/registration/error.rb
+- lib/jalc/registration/middleware/parse_xml.rb
+- lib/jalc/registration/middleware/raise_error.rb
 - lib/jalc/rest.rb
 - lib/jalc/rest/client.rb
 - lib/jalc/rest/config.rb
 - lib/jalc/rest/error.rb
-- lib/jalc/rest/response/raise_error.rb
+- lib/jalc/rest/middleware/raise_error.rb
 - lib/jalc/version.rb
 - sig/jalc/rest.rbs
 homepage: https://github.com/sankichi92/jalc-ruby
@@ -63,6 +83,7 @@ metadata:
   homepage_uri: https://github.com/sankichi92/jalc-ruby
   source_code_uri: https://github.com/sankichi92/jalc-ruby
   changelog_uri: https://github.com/sankichi92/jalc-ruby/blob/main/CHANGELOG.md
+  github_repo: https://github.com/sankichi92/jalc-ruby.git
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []