gbizinfo-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e8d7dcfab1378f851b365b6ba7059b19a86520627ebc408230dd96d715e684d
+  data.tar.gz: e590d4be152b21ff38be9538109fa4f8d377d03b0b472625c58ae49fe1e67ab5
+SHA512:
+  metadata.gz: 61621947e210f41d42c1c9abdb287c66018bdd6875e49fc60b9170daf9399bc25b868f9562c46c268c2a6b43cbf5483c05aa4c431c77527c9d35b9feb92b0d2e
+  data.tar.gz: 8920be6dfbc6bd2edee46baf444b511245ead25a1a992195488de1c0cb699cca968014c9a49e69fe00dbddadee8f21d8645b035bb30c57c6f792899eed8855e7

data/.github/workflows/ci.yml

@@ -0,0 +1,19 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 3.0
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0
+        bundler-cache: true
+    - run: bundle exec rake

data/.gitignore

@@ -0,0 +1,6 @@
+/.bundle/
+/vendor/bundle
+Gemfile.lock
+log
+.env
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+    - '*.gemspec'
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - lib/gbizinfo/api/error.rb
+
+Metrics/MethodLength:
+  Max: 20
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-12-15
+
+- Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Ryoma Ono
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# gBizINFO Ruby Client
+
+[![CI](https://github.com/ryoma123/gbizinfo-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/ryoma123/gbizinfo-ruby/actions/workflows/ci.yml)
+
+A Ruby client for gBizINFO APIs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gbizinfo-ruby'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install gbizinfo-ruby
+
+## Usage
+
+```ruby
+client = Gbizinfo::Client.new(
+  token: 'xxxxxxxxxx'
+)
+
+# Search for a corporation
+options = { name: '経済産業省' }
+client.hojin_search(options)
+
+# Fetch corporate information
+client.hojin(corporate_number: '4000012090001')
+```
+
+### Global Settings
+
+The following global settings are supported via `Gbizinfo.configure`.
+
+setting             | description
+--------------------|-------------------------------------------------------------------------------------------------
+token               | gBizINFO API token.
+user_agent          | User-agent.
+endpoint            | gBizINFO API endpoint.
+adapter             | Optional HTTP adapter to use, defaults to `Faraday.default_adapter`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ryoma123/gbizinfo-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/gbizinfo-ruby.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/gbizinfo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gbizinfo-ruby'
+  spec.version       = Gbizinfo::VERSION
+  spec.authors       = ['ryoma123']
+  spec.email         = ['ryoma.ono.2661@gmail.com']
+  spec.summary       = 'gBizINFO API client for Ruby.'
+  spec.description   = 'gBizINFO API client for Ruby.'
+  spec.homepage      = 'https://github.com/ryoma123/gbizinfo-ruby'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 3.0.3'
+
+  spec.metadata['source_code_uri'] = 'https://github.com/ryoma123/gbizinfo-ruby'
+  spec.metadata['changelog_uri'] = 'https://github.com/ryoma123/gbizinfo-ruby/blob/master/CHANGELOG.md'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+end

data/lib/gbizinfo/api/endpoints/hojin.rb

@@ -0,0 +1,18 @@
+module Gbizinfo
+  module Api
+    module Endpoints
+      module Hojin
+        #
+        # Returns the basic information of a given corporate number.
+        #
+        # @param [String] :corporate_number
+        #   A corporate number.
+        # @see https://info.gbiz.go.jp/hojin/swagger-ui.html
+        def hojin(corporate_number:)
+          throw ArgumentError.new('Required arguments :corporate_number missing') if corporate_number.nil?
+          get("hojin/#{corporate_number}")
+        end
+      end
+    end
+  end
+end

data/lib/gbizinfo/api/endpoints/hojin_certification.rb

@@ -0,0 +1,18 @@
+module Gbizinfo
+  module Api
+    module Endpoints
+      module HojinCertification
+        #
+        # Returns basic corporate information of a given corporate number.
+        #
+        # @param [String] :corporate_number
+        #   A corporate number.
+        # @see https://info.gbiz.go.jp/hojin/swagger-ui.html
+        def hojin_certification(corporate_number:)
+          throw ArgumentError.new('Required arguments :corporate_number missing') if corporate_number.nil?
+          get("hojin/#{corporate_number}/certification")
+        end
+      end
+    end
+  end
+end

data/lib/gbizinfo/api/endpoints/hojin_commendation.rb

@@ -0,0 +1,18 @@
+module Gbizinfo
+  module Api
+    module Endpoints
+      module HojinCommendation
+        #
+        # Returns the commendation information of a given corporate number.
+        #
+        # @param [String] :corporate_number
+        #   A corporate number.
+        # @see https://info.gbiz.go.jp/hojin/swagger-ui.html
+        def hojin_commendation(corporate_number:)
+          throw ArgumentError.new('Required arguments :corporate_number missing') if corporate_number.nil?
+          get("hojin/#{corporate_number}/commendation")
+        end
+      end
+    end
+  end
+end

data/lib/gbizinfo/api/endpoints/hojin_finance.rb

@@ -0,0 +1,18 @@
+module Gbizinfo
+  module Api
+    module Endpoints
+      module HojinFinance
+        #
+        # Returns the financial information of a given corporate number.
+        #
+        # @param [String] :corporate_number
+        #   A corporate number.
+        # @see https://info.gbiz.go.jp/hojin/swagger-ui.html
+        def hojin_finance(corporate_number:)
+          throw ArgumentError.new('Required arguments :corporate_number missing') if corporate_number.nil?
+          get("hojin/#{corporate_number}/finance")
+        end
+      end
+    end
+  end
+end

data/lib/gbizinfo/api/endpoints/hojin_patent.rb

@@ -0,0 +1,18 @@
+module Gbizinfo
+  module Api
+    module Endpoints
+      module HojinPatent
+        #
+        # Returns the patent information of a given corporate number.
+        #
+        # @param [String] :corporate_number
+        #   A corporate number.
+        # @see https://info.gbiz.go.jp/hojin/swagger-ui.html
+        def hojin_patent(corporate_number:)
+          throw ArgumentError.new('Required arguments :corporate_number missing') if corporate_number.nil?
+          get("hojin/#{corporate_number}/patent")
+        end
+      end
+    end
+  end
+end

data/lib/gbizinfo/api/endpoints/hojin_procurement.rb

@@ -0,0 +1,18 @@
+module Gbizinfo
+  module Api
+    module Endpoints
+      module HojinProcurement
+        #
+        # Returns the procurement information of a given corporate number.
+        #
+        # @param [String] :corporate_number
+        #   A corporate number.
+        # @see https://info.gbiz.go.jp/hojin/swagger-ui.html
+        def hojin_procurement(corporate_number:)
+          throw ArgumentError.new('Required arguments :corporate_number missing') if corporate_number.nil?
+          get("hojin/#{corporate_number}/procurement")
+        end
+      end
+    end
+  end
+end

data/lib/gbizinfo/api/endpoints/hojin_search.rb

@@ -0,0 +1,75 @@
+module Gbizinfo
+  module Api
+    module Endpoints
+      module HojinSearch
+        #
+        # Search for corporate information registered in gBizINFO.
+        #
+        # @option options [String] :corporate_number
+        #   A corporate number.
+        # @option options [String] :name
+        #   A corporate name.
+        # @option options [String] :exist_flg
+        #   A corporate activity information.
+        # @option options [String] :corporate_type
+        #   A corporate type.
+        # @option options [String] :prefecture
+        #   A location prefecture.
+        # @option options [String] :city
+        #   A location city.
+        # @option options [String] :capital_stock_from
+        #   A lower limit of capital.
+        # @option options [String] :capital_stock_to
+        #   An upper limit of capital.
+        # @option options [String] :employee_number_from
+        #   A lower limit of the number of employees.
+        # @option options [String] :employee_number_to
+        #   A maximum number of employees.
+        # @option options [String] :founded_year
+        #   A year of establishment.
+        # @option options [String] :sales_area
+        #   A business area.
+        # @option options [String] :business_item
+        #   A business items.
+        # @option options [String] :unified_qualification
+        #   A government unified participation qualification.
+        # @option options [String] :net_sales_summary_of_business_results_from
+        #   A lower limit of sales.
+        # @option options [String] :net_sales_summary_of_business_results_to
+        #   An upper limit of sales.
+        # @option options [String] :net_income_loss_summary_of_business_results_from
+        #   A lower limit of net income or net loss.
+        # @option options [String] :net_income_loss_summary_of_business_results_to
+        #   An upper limit of net income or net loss.
+        # @option options [String] :total_assets_summary_of_business_results_from
+        #   A lower limit of total assets.
+        # @option options [String] :total_assets_summary_of_business_results_to
+        #   A set an upper limit for total assets.
+        # @option options [String] :name_major_shareholders
+        #   A major shareholder name.
+        # @option options [String] :average_continuous_service_years
+        #   An average number of years of continuous service.
+        # @option options [String] :average_age
+        #   An average age of employees.
+        # @option options [String] :month_average_predetermined_overtime_hours
+        #   A monthly average overtime hours.
+        # @option options [String] :female_workers_proportion
+        #   A percentage of female workers among workers.
+        # @option options [String] :year
+        #   The year.
+        # @option options [String] :ministry
+        #   A ministry in charge.
+        # @option options [String] :source
+        #   A source.
+        # @option options [String] :page
+        #   A number of pages in search results.
+        # @option options [String] :limit
+        #   A number of search results per page.
+        # @see https://info.gbiz.go.jp/hojin/swagger-ui.html
+        def hojin_search(options = {})
+          get('hojin', options)
+        end
+      end
+    end
+  end
+end

data/lib/gbizinfo/api/endpoints/hojin_subsidy.rb

@@ -0,0 +1,18 @@
+module Gbizinfo
+  module Api
+    module Endpoints
+      module HojinSubsidy
+        #
+        # Returns the subsidy information of a given corporate number.
+        #
+        # @param [String] :corporate_number
+        #   A corporate number.
+        # @see https://info.gbiz.go.jp/hojin/swagger-ui.html
+        def hojin_subsidy(corporate_number:)
+          throw ArgumentError.new('Required arguments :corporate_number missing') if corporate_number.nil?
+          get("hojin/#{corporate_number}/subsidy")
+        end
+      end
+    end
+  end
+end

data/lib/gbizinfo/api/endpoints/hojin_update_info.rb

@@ -0,0 +1,23 @@
+module Gbizinfo
+  module Api
+    module Endpoints
+      module HojinUpdateInfo
+        #
+        # Returns basic corporate information added or updated within a given period.
+        #
+        # @option options [String] :from
+        #   Start date to retrieve the corporate information for, expressed as yyyyMMdd.
+        # @option options [String] :to
+        #   End date to retrieve the corporate information for, expressed as yyyyMMdd.
+        # @option options [String] :limit
+        #   Number of pages in search results.
+        # @see https://info.gbiz.go.jp/hojin/swagger-ui.html
+        def hojin_update_info(options = {})
+          throw ArgumentError.new('Required arguments :from missing') if options[:from].nil?
+          throw ArgumentError.new('Required arguments :to missing') if options[:to].nil?
+          get('hojin/updateInfo', options)
+        end
+      end
+    end
+  end
+end

data/lib/gbizinfo/api/endpoints/hojin_update_info_certification.rb

@@ -0,0 +1,23 @@
+module Gbizinfo
+  module Api
+    module Endpoints
+      module HojinUpdateInfoCertification
+        #
+        # Returns basic corporate information added or updated within a given period.
+        #
+        # @option options [String] :from
+        #   Start date to retrieve the corporate information for, expressed as yyyyMMdd.
+        # @option options [String] :to
+        #   End date to retrieve the corporate information for, expressed as yyyyMMdd.
+        # @option options [String] :limit
+        #   Number of pages in search results.
+        # @see https://info.gbiz.go.jp/hojin/swagger-ui.html
+        def hojin_update_info_certification(options = {})
+          throw ArgumentError.new('Required arguments :from missing') if options[:from].nil?
+          throw ArgumentError.new('Required arguments :to missing') if options[:to].nil?
+          get('hojin/updateInfo/certification', options)
+        end
+      end
+    end
+  end
+end

data/lib/gbizinfo/api/endpoints/hojin_update_info_commendation.rb

@@ -0,0 +1,23 @@
+module Gbizinfo
+  module Api
+    module Endpoints
+      module HojinUpdateInfoCommendation
+        #
+        # Returns the commendation information added or updated within a given period.
+        #
+        # @option options [String] :from
+        #   Start date to retrieve the corporate information for, expressed as yyyyMMdd.
+        # @option options [String] :to
+        #   End date to retrieve the corporate information for, expressed as yyyyMMdd.
+        # @option options [String] :limit
+        #   Number of pages in search results.
+        # @see https://info.gbiz.go.jp/hojin/swagger-ui.html
+        def hojin_update_info_commendation(options = {})
+          throw ArgumentError.new('Required arguments :from missing') if options[:from].nil?
+          throw ArgumentError.new('Required arguments :to missing') if options[:to].nil?
+          get('hojin/updateInfo/commendation', options)
+        end
+      end
+    end
+  end
+end

data/lib/gbizinfo/api/endpoints/hojin_update_info_finance.rb

@@ -0,0 +1,23 @@
+module Gbizinfo
+  module Api
+    module Endpoints
+      module HojinUpdateInfoFinance
+        #
+        # Returns the financial information added or updated within a given period.
+        #
+        # @option options [String] :from
+        #   Start date to retrieve the corporate information for, expressed as yyyyMMdd.
+        # @option options [String] :to
+        #   End date to retrieve the corporate information for, expressed as yyyyMMdd.
+        # @option options [String] :limit
+        #   Number of pages in search results.
+        # @see https://info.gbiz.go.jp/hojin/swagger-ui.html
+        def hojin_update_info_finance(options = {})
+          throw ArgumentError.new('Required arguments :from missing') if options[:from].nil?
+          throw ArgumentError.new('Required arguments :to missing') if options[:to].nil?
+          get('hojin/updateInfo/finance', options)
+        end
+      end
+    end
+  end
+end

data/lib/gbizinfo/api/endpoints/hojin_update_info_patent.rb

@@ -0,0 +1,23 @@
+module Gbizinfo
+  module Api
+    module Endpoints
+      module HojinUpdateInfoPatent
+        #
+        # Returns the patent information added or updated within a given period.
+        #
+        # @option options [String] :from
+        #   Start date to retrieve the corporate information for, expressed as yyyyMMdd.
+        # @option options [String] :to
+        #   End date to retrieve the corporate information for, expressed as yyyyMMdd.
+        # @option options [String] :limit
+        #   Number of pages in search results.
+        # @see https://info.gbiz.go.jp/hojin/swagger-ui.html
+        def hojin_update_info_patent(options = {})
+          throw ArgumentError.new('Required arguments :from missing') if options[:from].nil?
+          throw ArgumentError.new('Required arguments :to missing') if options[:to].nil?
+          get('hojin/updateInfo/patent', options)
+        end
+      end
+    end
+  end
+end

data/lib/gbizinfo/api/endpoints/hojin_update_info_procurement.rb

@@ -0,0 +1,23 @@
+module Gbizinfo
+  module Api
+    module Endpoints
+      module HojinUpdateInfoProcurement
+        #
+        # Returns the procurement information added or updated within a given period.
+        #
+        # @option options [String] :from
+        #   Start date to retrieve the corporate information for, expressed as yyyyMMdd.
+        # @option options [String] :to
+        #   End date to retrieve the corporate information for, expressed as yyyyMMdd.
+        # @option options [String] :limit
+        #   Number of pages in search results.
+        # @see https://info.gbiz.go.jp/hojin/swagger-ui.html
+        def hojin_update_info_procurement(options = {})
+          throw ArgumentError.new('Required arguments :from missing') if options[:from].nil?
+          throw ArgumentError.new('Required arguments :to missing') if options[:to].nil?
+          get('hojin/updateInfo/procurement', options)
+        end
+      end
+    end
+  end
+end

data/lib/gbizinfo/api/endpoints/hojin_update_info_subsidy.rb

@@ -0,0 +1,23 @@
+module Gbizinfo
+  module Api
+    module Endpoints
+      module HojinUpdateInfoSubsidy
+        #
+        # Returns the subsidy information added or updated within a given period.
+        #
+        # @option options [String] :from
+        #   Start date to retrieve the corporate information for, expressed as yyyyMMdd.
+        # @option options [String] :to
+        #   End date to retrieve the corporate information for, expressed as yyyyMMdd.
+        # @option options [String] :limit
+        #   Number of pages in search results.
+        # @see https://info.gbiz.go.jp/hojin/swagger-ui.html
+        def hojin_update_info_subsidy(options = {})
+          throw ArgumentError.new('Required arguments :from missing') if options[:from].nil?
+          throw ArgumentError.new('Required arguments :to missing') if options[:to].nil?
+          get('hojin/updateInfo/subsidy', options)
+        end
+      end
+    end
+  end
+end

data/lib/gbizinfo/api/endpoints/hojin_update_info_workplace.rb

@@ -0,0 +1,23 @@
+module Gbizinfo
+  module Api
+    module Endpoints
+      module HojinUpdateInfoWorkplace
+        #
+        # Returns the workplace information added or updated within a given period.
+        #
+        # @option options [String] :from
+        #   Start date to retrieve the corporate information for, expressed as yyyyMMdd.
+        # @option options [String] :to
+        #   End date to retrieve the corporate information for, expressed as yyyyMMdd.
+        # @option options [String] :limit
+        #   Number of pages in search results.
+        # @see https://info.gbiz.go.jp/hojin/swagger-ui.html
+        def hojin_update_info_workplace(options = {})
+          throw ArgumentError.new('Required arguments :from missing') if options[:from].nil?
+          throw ArgumentError.new('Required arguments :to missing') if options[:to].nil?
+          get('hojin/updateInfo/workplace', options)
+        end
+      end
+    end
+  end
+end

data/lib/gbizinfo/api/endpoints/hojin_workplace.rb

@@ -0,0 +1,18 @@
+module Gbizinfo
+  module Api
+    module Endpoints
+      module HojinWorkplace
+        #
+        # Returns the workplace information of a given corporate number.
+        #
+        # @param [String] :corporate_number
+        #   A corporate number.
+        # @see https://info.gbiz.go.jp/hojin/swagger-ui.html
+        def hojin_workplace(corporate_number:)
+          throw ArgumentError.new('Required arguments :corporate_number missing') if corporate_number.nil?
+          get("hojin/#{corporate_number}/workplace")
+        end
+      end
+    end
+  end
+end

data/lib/gbizinfo/api/endpoints.rb

@@ -0,0 +1,41 @@
+require_relative 'endpoints/hojin'
+require_relative 'endpoints/hojin_certification'
+require_relative 'endpoints/hojin_commendation'
+require_relative 'endpoints/hojin_finance'
+require_relative 'endpoints/hojin_patent'
+require_relative 'endpoints/hojin_procurement'
+require_relative 'endpoints/hojin_search'
+require_relative 'endpoints/hojin_subsidy'
+require_relative 'endpoints/hojin_update_info'
+require_relative 'endpoints/hojin_update_info_certification'
+require_relative 'endpoints/hojin_update_info_commendation'
+require_relative 'endpoints/hojin_update_info_finance'
+require_relative 'endpoints/hojin_update_info_patent'
+require_relative 'endpoints/hojin_update_info_procurement'
+require_relative 'endpoints/hojin_update_info_subsidy'
+require_relative 'endpoints/hojin_update_info_workplace'
+require_relative 'endpoints/hojin_workplace'
+
+module Gbizinfo
+  module Api
+    module Endpoints
+      include Hojin
+      include HojinCertification
+      include HojinCommendation
+      include HojinFinance
+      include HojinPatent
+      include HojinProcurement
+      include HojinSearch
+      include HojinSubsidy
+      include HojinUpdateInfo
+      include HojinUpdateInfoCertification
+      include HojinUpdateInfoCommendation
+      include HojinUpdateInfoFinance
+      include HojinUpdateInfoPatent
+      include HojinUpdateInfoProcurement
+      include HojinUpdateInfoSubsidy
+      include HojinUpdateInfoWorkplace
+      include HojinWorkplace
+    end
+  end
+end

data/lib/gbizinfo/api/error.rb

@@ -0,0 +1,73 @@
+module Gbizinfo
+  module Api
+    class Error < StandardError
+      def self.from_response(response)
+        klass =
+          case response.status
+          when 400      then Gbizinfo::Api::BadRequest
+          when 401      then Gbizinfo::Api::Unauthorized
+          when 403      then Gbizinfo::Api::Forbidden
+          when 404      then Gbizinfo::Api::NotFound
+          when 400..499 then Gbizinfo::Api::ClientError
+          when 500      then Gbizinfo::Api::InternalServerError
+          when 502      then Gbizinfo::Api::BadGateway
+          when 503      then Gbizinfo::Api::ServiceUnavailable
+          when 500..599 then Gbizinfo::Api::ServerError
+          end
+        klass&.new(response)
+      end
+
+      def initialize(response = nil)
+        @response = response
+        super(build_error_message)
+      end
+
+      private
+
+      def build_error_message
+        return nil if @response.nil?
+
+        message =  "#{@response.env.method.upcase} #{@response.env.url}"
+        message << " status_code: #{@response.status}" unless @response.status.nil?
+        message << " body: #{@response.body}"          unless @response.body.nil?
+        message
+      end
+    end
+
+    # A 4xx class HTTP error occurred.
+    class ClientError < Error
+    end
+
+    # A 400 HTTP error occurred.
+    class BadRequest < ClientError
+    end
+
+    # A 401 HTTP error occurred.
+    class Unauthorized < ClientError
+    end
+
+    # A 403 HTTP error occurred.
+    class Forbidden < ClientError
+    end
+
+    # A 404 HTTP error occurred.
+    class NotFound < ClientError
+    end
+
+    # A 5xx class HTTP error occurred.
+    class ServerError < Error
+    end
+
+    # A 500 HTTP error occurred.
+    class InternalServerError < ServerError
+    end
+
+    # A 502 HTTP error occurred.
+    class BadGateway < ServerError
+    end
+
+    # A 503 HTTP error occurred.
+    class ServiceUnavailable < ServerError
+    end
+  end
+end

data/lib/gbizinfo/client.rb

@@ -0,0 +1,27 @@
+module Gbizinfo
+  class Client
+    include Faraday::Connection
+    include Faraday::Request
+    include Api::Endpoints
+
+    attr_accessor(*Config::ATTRIBUTES)
+
+    def initialize(options = {})
+      Gbizinfo::Config::ATTRIBUTES.each do |key|
+        send("#{key}=", options.fetch(key, Gbizinfo.config.send(key)))
+      end
+
+      @token ||= Gbizinfo.config.token
+    end
+
+    class << self
+      def configure
+        block_given? ? yield(Config) : Config
+      end
+
+      def config
+        Config
+      end
+    end
+  end
+end

data/lib/gbizinfo/config.rb

@@ -0,0 +1,33 @@
+module Gbizinfo
+  module Config
+    extend self
+
+    ATTRIBUTES = %i[
+      user_agent
+      endpoint
+      token
+      adapter
+    ].freeze
+
+    attr_accessor(*Config::ATTRIBUTES)
+
+    def reset
+      self.endpoint = 'https://info.gbiz.go.jp/hojin/v1/'
+      self.user_agent = "gBizINFO Ruby Client/#{Gbizinfo::VERSION}"
+      self.token = nil
+      self.adapter = ::Faraday.default_adapter
+    end
+  end
+
+  class << self
+    def configure
+      block_given? ? yield(Config) : Config
+    end
+
+    def config
+      Config
+    end
+  end
+end
+
+Gbizinfo::Config.reset

data/lib/gbizinfo/faraday/connection.rb

@@ -0,0 +1,25 @@
+module Gbizinfo
+  module Faraday
+    module Connection
+      private
+
+      def connection
+        @connection ||=
+          begin
+            headers = {
+              'Accept' => 'application/json'
+            }
+
+            headers['User-Agent'] = user_agent if user_agent
+            headers['X-hojinInfo-api-token'] = token if token
+
+            ::Faraday.new(endpoint, headers: headers) do |builder|
+              builder.request :url_encoded
+              builder.response :json
+              builder.adapter ::Faraday.default_adapter
+            end
+          end
+      end
+    end
+  end
+end

data/lib/gbizinfo/faraday/request.rb

@@ -0,0 +1,27 @@
+module Gbizinfo
+  module Faraday
+    module Request
+      def get(path, options = {})
+        request(:get, path, options)
+      end
+
+      private
+
+      def request(method, path, options)
+        response = connection.send(method) do |request|
+          request.url(path, options)
+          request.options.merge!(options.delete(:request)) if options.key?(:request)
+        end
+
+        fail_or_return_response_body(response)
+      end
+
+      def fail_or_return_response_body(response)
+        error = Gbizinfo::Api::Error.from_response(response)
+        raise(error) if error
+
+        response.body
+      end
+    end
+  end
+end

data/lib/gbizinfo/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Gbizinfo
+  VERSION = '0.1.0'
+end

data/lib/gbizinfo.rb

@@ -0,0 +1,11 @@
+require_relative 'gbizinfo/version'
+
+require 'faraday'
+require 'faraday_middleware'
+
+require_relative 'gbizinfo/config'
+require_relative 'gbizinfo/faraday/connection'
+require_relative 'gbizinfo/faraday/request'
+require_relative 'gbizinfo/api/endpoints'
+require_relative 'gbizinfo/api/error'
+require_relative 'gbizinfo/client'

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: gbizinfo-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ryoma123
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: gBizINFO API client for Ruby.
+email:
+- ryoma.ono.2661@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- gbizinfo-ruby.gemspec
+- lib/gbizinfo.rb
+- lib/gbizinfo/api/endpoints.rb
+- lib/gbizinfo/api/endpoints/hojin.rb
+- lib/gbizinfo/api/endpoints/hojin_certification.rb
+- lib/gbizinfo/api/endpoints/hojin_commendation.rb
+- lib/gbizinfo/api/endpoints/hojin_finance.rb
+- lib/gbizinfo/api/endpoints/hojin_patent.rb
+- lib/gbizinfo/api/endpoints/hojin_procurement.rb
+- lib/gbizinfo/api/endpoints/hojin_search.rb
+- lib/gbizinfo/api/endpoints/hojin_subsidy.rb
+- lib/gbizinfo/api/endpoints/hojin_update_info.rb
+- lib/gbizinfo/api/endpoints/hojin_update_info_certification.rb
+- lib/gbizinfo/api/endpoints/hojin_update_info_commendation.rb
+- lib/gbizinfo/api/endpoints/hojin_update_info_finance.rb
+- lib/gbizinfo/api/endpoints/hojin_update_info_patent.rb
+- lib/gbizinfo/api/endpoints/hojin_update_info_procurement.rb
+- lib/gbizinfo/api/endpoints/hojin_update_info_subsidy.rb
+- lib/gbizinfo/api/endpoints/hojin_update_info_workplace.rb
+- lib/gbizinfo/api/endpoints/hojin_workplace.rb
+- lib/gbizinfo/api/error.rb
+- lib/gbizinfo/client.rb
+- lib/gbizinfo/config.rb
+- lib/gbizinfo/faraday/connection.rb
+- lib/gbizinfo/faraday/request.rb
+- lib/gbizinfo/version.rb
+homepage: https://github.com/ryoma123/gbizinfo-ruby
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/ryoma123/gbizinfo-ruby
+  changelog_uri: https://github.com/ryoma123/gbizinfo-ruby/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: gBizINFO API client for Ruby.
+test_files: []