houjin-bangou 0.0.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee36ec7484e838942889a688b5eee95e1b48c98b
-  data.tar.gz: e1e35549bd21ac840d3186b798f4feed886330ee
+  metadata.gz: c06f71c9299c43aee6ddae7d7090d79ceb901b10
+  data.tar.gz: 7815175acbf4c116d1deba51b57e55a0427752f8
 SHA512:
-  metadata.gz: ae632bdf71d31b2ae8f62fc195f9dc3ea18324cc90c22cf90e6719770265f2047a6457cc007ab3a8c2e9fd4a65d706600754bb5f681429cb996e7dd9510fc1e7
-  data.tar.gz: 716570897fb5f487a74c2f1a39bae4045f6da17719acc7d2908122d3c554eadd2548a5c9a8ae0790cd092bf86657d64b5ee4e1c89a1394424c691d50ee738bb1
+  metadata.gz: 327ed7f65b0a034976a705ac1955717a254acbff4906b2ac3fc10de6ea5a66265c32b7fa60af2fa42696a7cab866773b2d88b82d792080ac091b1691301a4301
+  data.tar.gz: b3b0ee0ab72d696c5ba4c15cba8315688cb05426d45a53c9ca4f77b2b230645379de86353cdf433f0226877427755afc9f07c50864fb47f31b8aa65963229328

data/Gemfile

@@ -6,6 +6,7 @@ group :development do
   gem 'rake', '~> 10.0'
   gem 'rspec', '~> 3.0'
   gem 'webmock', '~> 2.0'
+  gem 'vcr', '~> 3.0'
   gem 'pry'
   gem 'pry-byebug'
   gem 'guard'

data/Guardfile

@@ -0,0 +1,14 @@
+guard :rspec, cmd: 'bundle exec rspec --format Fuubar' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper)  { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/README.md

@@ -2,6 +2,7 @@
 
 [![GitHub](https://img.shields.io/badge/github-kissy2go/houjin--bangou-blue.svg)](https://github.com/kissy2go/houjin-bangou)
 
+[![Gem Version](https://badge.fury.io/rb/houjin-bangou.svg)](https://badge.fury.io/rb/houjin-bangou)
 [![wercker status](https://app.wercker.com/status/60de5f243a0940720d44ff8958410aa8/s/master "wercker status")](https://app.wercker.com/project/byKey/60de5f243a0940720d44ff8958410aa8)
 [![License](https://img.shields.io/badge/license-MIT-yellowgreen.svg)](#license)
 
@@ -26,7 +27,26 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+    HoujinBangou.application_id = YOUR_APPLICATION_ID
+
+    # Search by number
+    number = ... # String or Array
+    result = HoujinBangou::Num.search(number)
+    result.each do |record|
+      record #=> HoujinBangou::ResultSet::Record
+      record.corporate_number
+      record.name
+    end
+
+    # Search by date span
+    from = ... # Date, Time or String
+    to = ...   # Date, Time or String
+    result = HoujinBangou::Diff.search(from, to)
+    result.each do |record|
+      record #=> HoujinBangou::ResultSet::Record
+      record.corporate_number
+      record.name
+    end
 
 ## Development
 

data/bin/console

@@ -3,5 +3,7 @@
 require 'bundler/setup'
 require 'houjin-bangou'
 
+HoujinBangou.application_id = ENV['HOUJIN_BANGOU_APPLICATION_ID']
+
 require 'pry'
 Pry.start

data/lib/houjin-bangou.rb

@@ -1,5 +1,42 @@
+require 'csv'
+
 require 'houjin-bangou/version'
 
+require 'houjin-bangou/immutable_struct'
+require 'houjin-bangou/api_endpoint'
+require 'houjin-bangou/result_set'
+require 'houjin-bangou/util'
+
+# @see http://www.houjin-bangou.nta.go.jp/webapi
+# @see http://www.houjin-bangou.nta.go.jp/documents/k-web-api-kinou.pdf
 module HoujinBangou
-  # Your code goes here...
+  @base_url     = "https://api.houjin-bangou.nta.go.jp/#{API_VERSION}"
+  @open_timeout = 60
+  @read_timeout = 60
+
+  class << self
+    attr_accessor :base_url, :application_id, :open_timeout, :read_timeout
+  end
+
+  def self.request(url, query, src_encoding: Encoding::Shift_JIS)
+    query = { id: application_id }.merge(query)
+    url.query = URI.encode_www_form(query)
+
+    http = Net::HTTP.new(url.host, url.port)
+    http.use_ssl = true if url.scheme == 'https'
+    http.open_timeout = open_timeout
+    http.read_timeout = read_timeout
+
+    response = http.start do |http|
+      request = Net::HTTP::Get.new(url.request_uri)
+      http.request(request)
+    end
+
+    case response
+    when Net::HTTPSuccess
+      HoujinBangou::ResultSet.new(response.body, src_encoding)
+    else
+      response.value
+    end
+  end
 end

data/lib/houjin-bangou/api_endpoint.rb

@@ -0,0 +1,47 @@
+module HoujinBangou
+  def self.APIEndpoint(path)
+    Module.new do |m|
+      define_method :endpoint_url do
+        URI.parse(HoujinBangou.base_url + path)
+      end
+    end
+  end
+
+  module Num
+    extend HoujinBangou::APIEndpoint('/num')
+
+    RESPONSE_TYPE = '01' # CSV 形式 / Shift-JIS (JIS 第一及び第二水準)
+
+    def self.search(number, history: nil)
+      query = {}
+      query[:number]  = Array[*number].join(',')
+      query[:history] = history unless history.nil?
+      query[:type]    = RESPONSE_TYPE
+
+      HoujinBangou.request(endpoint_url, query)
+    end
+  end
+
+  module Diff
+    extend HoujinBangou::APIEndpoint('/diff')
+
+    KIND_COUNTRY         = '01' # 国の機関
+    KIND_LOCAL_GOVEMENTS = '02' # 地方公共団体
+    KIND_HOUJIN          = '03' # 設立登記法人
+    KIND_ETC             = '04' # 外国会社等・その他
+
+    RESPONSE_TYPE = '01' # CSV 形式 / Shift-JIS (JIS 第一及び第二水準)
+
+    def self.search(from, to, address: nil, kind: nil, divide: nil)
+      query = {}
+      query[:from]    = HoujinBangou::Util::Date.encode(from)
+      query[:to]      = HoujinBangou::Util::Date.encode(to)
+      query[:address] = address                unless address.nil?
+      query[:kind]    = Array[*kind].join(',') unless kind.nil?
+      query[:divide]  = divide                 unless divide.nil?
+      query[:type]    = RESPONSE_TYPE
+
+      HoujinBangou.request(endpoint_url, query)
+    end
+  end
+end

data/lib/houjin-bangou/immutable_struct.rb

@@ -0,0 +1,14 @@
+module HoujinBangou
+  class ImmutableStruct < Struct
+    private :[]=
+
+    def initialize(*)
+      super
+      members.each { |member| instance_eval { undef :"#{member}=" } }
+    end
+
+    def inspect
+      super.sub('struct', self.class.name)
+    end
+  end
+end

data/lib/houjin-bangou/result_set.rb

@@ -0,0 +1,77 @@
+module HoujinBangou
+  class ResultSet
+    include Enumerable
+
+    attr_reader :header
+
+    def initialize(response, src_encoding)
+      dst_encoding = Encoding.default_internal || Encoding::UTF_8
+      @csv_operator = CSV.new(response.encode(dst_encoding, src_encoding))
+      @header = Header.new(*@csv_operator.readline)
+    end
+
+    def each(&block)
+      return self.to_enum      unless block_given?
+      return @csv.each(&block) unless @csv.nil?
+
+      @csv = []
+      @csv_operator.each do |row|
+        @csv << record = Record.new(*row)
+        yield record
+      end
+      @csv
+    end
+
+    class Header < ImmutableStruct.new(
+        :last_update_date, # 最終更新年月日
+        :count,            # 総件数
+        :divide_number,    # 分割番号
+        :divide_size       # 分割数
+      )
+
+      def initialize(*)
+        super
+        self[:last_update_date] = HoujinBangou::Util::Date.decode(last_update_date)
+        self[:count]            = HoujinBangou::Util::Number.decode(count)
+        self[:divide_number]    = HoujinBangou::Util::Number.decode(divide_number)
+        self[:divide_size]      = HoujinBangou::Util::Number.decode(divide_size)
+      end
+    end
+
+    class Record < ImmutableStruct.new(
+        :sequence_number,            # 一連番号
+        :corporate_number,           # 法人番号
+        :process,                    # 処理区分
+        :correct,                    # 訂正区分
+        :update_date,                # 更新年月日
+        :change_date,                # 変更年月日
+        :name,                       # 商号又は名称
+        :name_image_id,              # 商号又は名称イメージ ID
+        :kind,                       # 法人種別
+        :prefecture_name,            # 国内所在地 (都道府県)
+        :city_name,                  # 国内所在地 (市区町村)
+        :street_number,              # 国内所在地 (丁目番地等)
+        :address_image_id,           # 国内所在地イメージ ID
+        :prefecture_code,            # 都道府県コード
+        :city_code,                  # 市区町村コード
+        :post_code,                  # 郵便番号
+        :address_outside,            # 国外所在地
+        :address_outside_image_id,   # 国外所在地イメージ ID
+        :close_date,                 # 登記記録の閉鎖等年月日
+        :close_cause,                # 登記記録の閉鎖等の事由
+        :successor_corporate_number, # 承継先法人番号
+        :change_cause,               # 変更事由の詳細
+        :assignment_date             # 法人番号指定年月日
+      )
+
+      def initialize(*)
+        super
+        self[:sequence_number] = HoujinBangou::Util::Number.decode(sequence_number)
+        self[:update_date]     = HoujinBangou::Util::Date.decode(update_date)
+        self[:change_date]     = HoujinBangou::Util::Date.decode(change_date)
+        self[:close_date]      = HoujinBangou::Util::Date.decode(close_date)
+        self[:assignment_date] = HoujinBangou::Util::Date.decode(assignment_date)
+      end
+    end
+  end
+end

data/lib/houjin-bangou/util.rb

@@ -0,0 +1,21 @@
+module HoujinBangou
+  module Util
+    module Date
+      DATE_FORMAT = '%Y-%m-%d'
+
+      def self.encode(date)
+        date.strftime(DATE_FORMAT) rescue date
+      end
+
+      def self.decode(string)
+        ::Date.strptime(string, DATE_FORMAT) rescue string
+      end
+    end
+
+    module Number
+      def self.decode(string)
+        Integer(string) rescue string
+      end
+    end
+  end
+end

data/lib/houjin-bangou/version.rb

@@ -1,3 +1,4 @@
 module HoujinBangou
-  VERSION = '0.0.0'
+  VERSION     = '1.0.0'
+  API_VERSION = '1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: houjin-bangou
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 1.0.0
 platform: ruby
 authors:
 - kissy2go
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-07 00:00:00.000000000 Z
+date: 2017-01-20 00:00:00.000000000 Z
 dependencies: []
 description: See http://www.houjin-bangou.nta.go.jp/webapi for details.
 email:
@@ -20,12 +20,17 @@ files:
 - ".gitignore"
 - ".rspec"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - houjin-bangou.gemspec
 - lib/houjin-bangou.rb
+- lib/houjin-bangou/api_endpoint.rb
+- lib/houjin-bangou/immutable_struct.rb
+- lib/houjin-bangou/result_set.rb
+- lib/houjin-bangou/util.rb
 - lib/houjin-bangou/version.rb
 - wercker.yml
 homepage: https://github.com/kissy2go/houjin-bangou