nta_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 016b092b6106e61e584fe28f41552dca94a76e8004c45f577f6b55c958f4aefb
+  data.tar.gz: eeb58f017fa8b3e80bb92f9412f814a0fd2772de483f0781d2765855e2079563
+SHA512:
+  metadata.gz: beb401d014dfce3987f561e4e05c57fb58f9fb792ad67a1201048a3794101934e97f50a21302db01ee65bc3f13fabf43230e6fd6d2d2e5763671804ff29b13a3
+  data.tar.gz: e04d4b13c12866b9f08697007a443d2d7202b163c819be292e047410280d706b45d5e94fcb29d82adce80626a1db511715dde7c02b735a817afab2f142963641

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.7
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at shinter61@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in nta_ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 shinter61
+
+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,89 @@
+# NtaRuby
+
+国税庁APIで企業情報を取得するためのgemです。各種情報がobjectとして扱えるようになります。
+
+## インストール
+
+この行をgemfileに追記して、
+
+```ruby
+gem 'nta_ruby'
+```
+
+これを実行してください。
+
+    $ bundle
+
+もしくは、以下のコマンドをシェルから実行してください。
+
+    $ gem install nta_ruby
+
+## 使用法
+
+国税庁へのAPIのリクエストを送りたいファイルで、まずこの行を追加し、国税庁とのネットワークを確立してください。
+
+```ruby
+# AAAAAAAA: あなたの国税庁APIの認証ID
+# 4: 利用したい国税庁APIのバージョン
+conn = NtaRuby.new(id: 'AAAAAAAAA', version: 4)
+```
+
+接続できたら、検索条件を指定するとそれに応じたレスポンスが加工されて返却されます。
+```ruby
+resp = conn.throw_request(type: :diff, divide: 2, from: Time.zone.local(2019, 9, 1), to: Time.zone.local(2019, 10, 1))
+resp.first.name # => '株式会社○△□'
+```
+
+### 法人番号検索
+
+法人番号が「1111111111111」のもので検索したい場合
+```ruby
+resp = conn.throw_request(type: :number, divide: false, number: 1111111111111)
+resp.size # => 1
+resp.first.name # => '株式会社○△□'
+```
+
+法人番号が「1111111111111」のもので検索したい場合(履歴付き)
+```ruby
+resp = conn.throw_request(type: :number, divide: false, number: 1111111111111, history: true)
+resp.size # => 3
+resp.first.name # => '株式会社○△□'
+resp[1].name # => '株式会社×××'
+```
+
+### 期間検索
+
+2019年9月1日から2019年10月1日の間に更新されたもので検索したい場合
+```ruby
+resp = conn.throw_request(type: :diff, divide: 2, from: Time.zone.local(2019, 9, 1), to: Time.zone.local(2019, 10, 1))
+resp.size # => 2000
+resp.first.name # => '株式会社○△□'
+```
+
+### 名称検索
+
+名前が「test」のもので検索したい場合(前方一致)
+```ruby
+resp = conn.throw_request(type: :name, divide: false, history: true, mode: 1)
+resp.size # => 600
+resp.first.name # => 'test株式会社'
+```
+
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/nta_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the NtaRuby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/nta_ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nta_ruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nta_ruby.rb

@@ -0,0 +1,15 @@
+require "nta_ruby/version"
+require "nta_ruby/connection"
+require "nta_ruby/response"
+require "nta_ruby/options"
+require "faraday"
+require "csv"
+require "time"
+
+module NtaRuby
+  class << self
+    def new(id, version = 4)
+      NtaRuby::Connection.new(id: id, version: version)
+    end
+  end
+end

data/lib/nta_ruby/connection.rb

@@ -0,0 +1,70 @@
+module NtaRuby
+  class ConnectionNotFoundError < StandardError; end
+  class InvalidRequestTypeError < StandardError; end
+
+  class Connection
+    attr_reader :conn, :id, :version
+
+    def initialize(id:, version:)
+      @conn = Faraday.new(:url => 'https://api.houjin-bangou.nta.go.jp') do |builder|
+        builder.request  :url_encoded
+        builder.response :logger
+        builder.adapter  :net_http
+      end
+      @id = id
+      @version = version
+    end
+
+    def throw_request(type:, divide:, **option)
+      raise ConnectionNotFoundError.new unless conn
+
+      search_condition = Options.new(type: type, **option).to_h
+      search_condition.merge!({ id: id })
+
+      response = []
+      case type
+      when :number
+        raw_resp = conn.get "#{version}/num", search_condition
+        result, _ = NtaRuby::Response.parse(raw_resp)
+
+        response.concat result
+      when :diff
+        raw_resp = conn.get "#{version}/diff", search_condition
+        result, divide_size = NtaRuby::Response.parse(raw_resp)
+
+        response.concat result
+
+        return response if divide.is_a? Integer
+
+        (1..divide_size).each do |divide_number|
+          next if divide_number == 1
+
+          raw_resp = conn.get "#{version}/diff", search_condition.merge({ divide: divide_number })
+          result, _ = NtaRuby::Response.parse(raw_resp)
+
+          response.concat result
+        end
+      when :name
+        raw_resp = conn.get "#{version}/name", search_condition
+        result, divide_size = NtaRuby::Response.parse(raw_resp)
+
+        response.concat result
+
+        return response if divide.is_a? Integer
+
+        (1..divide_size).each do |divide_number|
+          next if divide_number == 1
+
+          raw_resp = conn.get "#{version}/name", search_condition.merge({ divide: divide_number })
+          result, _ = NtaRuby::Response.parse(raw_resp)
+
+          response.concat result
+        end
+      else
+        raise InvalidRequestTypeError.new
+      end
+
+      response
+    end
+  end
+end

data/lib/nta_ruby/options.rb

@@ -0,0 +1,60 @@
+module NtaRuby
+  class Options
+    SEARCH_CONDITION_KINDS = %w[
+      number
+      history
+      from
+      to
+      req_type
+      resp_type
+      name
+      address
+      mode
+      kind
+      close
+      divide
+    ]
+
+    attr_accessor *SEARCH_CONDITION_KINDS
+
+    alias change history
+
+    def initialize(type:, **option)
+      @number = option[:number] if option[:number]
+      @history = option[:history] === true ? 1 : 0
+      @from = option[:from]&.strftime('%Y-%m-%d') if option[:from]
+      @to = option[:to]&.strftime('%Y-%m-%d') if option[:to]
+      @req_type = type
+      @resp_type = '02'
+      @name = option[:name] if option[:name]
+      @address = option[:address] if option[:address]
+      @mode = option[:mode] if option[:mode]
+      @kind = option[:kind] if option[:kind]
+      @close = option[:close] === true ? 1 : 0
+      @divide = option[:divide]&.to_i || 1
+    end
+
+    def to_h
+      search_hash = {
+        number: number,
+        from: from,
+        to: to,
+        type: resp_type,
+        name: name,
+        address: address,
+        mode: mode,
+        kind: kind,
+        close: close,
+        divide: divide
+      }
+
+      if req_type == :number
+        search_hash.merge({ history: history })
+      elsif req_type == :name
+        search_hash.merge({ change: change })
+      else
+        search_hash
+      end
+    end
+  end
+end

data/lib/nta_ruby/response.rb

@@ -0,0 +1,89 @@
+module NtaRuby
+  class Response
+    RAW_RESPONSE_COLUMN = %w[
+      sequence_number
+      corporate_number
+      process
+      correct
+      update_date
+      change_date
+      name
+      name_image_id
+      kind
+      prefecture_name
+      city_name
+      street_number
+      address_image_id
+      prefecture_code
+      city_code
+      post_code
+      address_outside
+      address_outside_image_id
+      close_date
+      close_cause
+      successor_corporate_number
+      change_cause
+      assignment_date
+      latest
+      en_name
+      en_prefecture_name
+      en_city_name
+      en_address_outside
+      furigana
+      hihyoji
+    ].freeze
+
+    HEADER_COLUMN = %w[
+      last_update_date
+      count
+      divide_number
+      divide_size
+    ].freeze
+
+    TIME_COLUMN = %w[
+      update_date
+      change_date
+      close_date
+      assignment_date
+      last_update_date
+    ].freeze
+
+    INTEGER_COLUMN = %w[
+      sequence_number
+      corporate_number
+      count
+      divide_number
+      divide_size
+    ].freeze
+
+    attr_accessor *RAW_RESPONSE_COLUMN
+    attr_accessor *HEADER_COLUMN
+
+    class << self
+      def parse(raw_resp)
+        parsed_csv = CSV.parse(raw_resp.body)
+        csv_header = parsed_csv.shift
+
+        result = parsed_csv.map { |column| new(column, csv_header) }
+        divide_size = csv_header[3].to_i
+
+        [result, divide_size]
+      end
+    end
+
+    def initialize(column, csv_header)
+      RAW_RESPONSE_COLUMN.each_with_index do |attr, idx|
+        target_val = column[idx]
+        target_val = target_val.to_i if INTEGER_COLUMN.include?(attr) && target_val
+        target_val = Time.parse(target_val) if TIME_COLUMN.include?(attr) && target_val
+        send("#{attr}=", target_val)
+      end
+      HEADER_COLUMN.each_with_index do |attr, idx|
+        target_val = csv_header[idx]
+        target_val = target_val.to_i if INTEGER_COLUMN.include?(attr) && target_val
+        target_val = Time.parse(target_val) if TIME_COLUMN.include?(attr) && target_val
+        send("#{attr}=",target_val)
+      end
+    end
+  end
+end

data/lib/nta_ruby/version.rb

@@ -0,0 +1,3 @@
+module NtaRuby
+  VERSION = "0.1.0"
+end

data/nta_ruby.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nta_ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nta_ruby"
+  spec.version       = NtaRuby::VERSION
+  spec.authors       = ["shinter61"]
+  spec.email         = ["shinter61@gmail.com"]
+
+  spec.summary       = %q{国税庁APIをrubyで利用するためのgem}
+  spec.description   = %q{国税庁の提供する企業情報を取得するためのAPIを、rubyで扱いやすくするためのgemです。法人番号、期間、名称検索などがオプションで指定できます。}
+  spec.homepage      = "https://shinter61.github.io/nta_ruby"
+  spec.license       = "MIT"
+
+  # 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.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "faraday", "~> 0.17.1"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: nta_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- shinter61
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+description: 国税庁の提供する企業情報を取得するためのAPIを、rubyで扱いやすくするためのgemです。法人番号、期間、名称検索などがオプションで指定できます。
+email:
+- shinter61@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nta_ruby.rb
+- lib/nta_ruby/connection.rb
+- lib/nta_ruby/options.rb
+- lib/nta_ruby/response.rb
+- lib/nta_ruby/version.rb
+- nta_ruby.gemspec
+homepage: https://shinter61.github.io/nta_ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: 国税庁APIをrubyで利用するためのgem
+test_files: []