resas-api 0.1.6 → 0.2.0

data/lib/resas/api/client_ext/request.rb

@@ -0,0 +1,60 @@
+require 'active_support'
+require 'active_support/core_ext'
+require 'active_support/concern'
+
+require 'uri'
+
+require_relative './../client/util/path_settings_normalizer'
+require_relative './../client/util/request_settings_normalizer'
+require_relative './../response/body'
+
+# RESAS (Regional Economy Society Analyzing System) に関する機能を格納する名前空間
+# @see {https://resas.go.jp/}
+module Resas
+
+  # RESAS API を扱うための Gem - トップの名前空間
+  # @see {https://opendata.resas-portal.go.jp/}
+  # @see {https://opendata.resas-portal.go.jp/docs/api/v1-rc.1/index.html}
+  module Api
+
+    module ClientExt
+
+      # RESAS API へのリクエストを処理するメソッドを格納するモジュール
+      module Request
+
+        extend ActiveSupport::Concern
+
+        included do
+          undef :post
+        end
+
+        # GET メソッドで RESAS API へアクセスするメソッド
+        # @return [Resas::Api::Response::Body]
+        def get( *args )
+          super
+        end
+
+        # @return [URI::HTTPS or URI::Generic]
+        def path( *args )
+          path, options, *others = Client::Util::PathSettingsNormalizer.process( args )
+          full = others.shift
+
+          uri = ( full ? URI( "#{ base_endpoint }/#{ path }" ) : URI( path ) )
+          uri.query = options.to_query if options.present?
+          uri
+        end
+
+        private
+
+        # @return [Resas::Api::Response::Body]
+        def request( method, *args )
+          _path, options, parse_json, generate_instance = Client::Util::RequestSettingsNormalizer.process( args )
+          con = connection( parse_json: parse_json, generate_instance: generate_instance )
+          response = __request__( con, method, _path, options )
+          Resas::Api::Response::Body.new( response.body, self, _path, options )
+        end
+
+      end
+    end
+  end
+end

data/lib/resas/api/response/base_error.rb

@@ -0,0 +1,22 @@
+# RESAS (Regional Economy Society Analyzing System) に関する機能を格納する名前空間
+# @see {https://resas.go.jp/}
+module Resas
+
+  # RESAS API を扱うための Gem - トップの名前空間
+  # @see {https://opendata.resas-portal.go.jp/}
+  # @see {https://opendata.resas-portal.go.jp/docs/api/v1-rc.1/index.html}
+  module Api
+
+    module Response
+
+      class BaseError < StandardError
+
+        def initialize(h)
+          @h = h
+        end
+
+      end
+
+    end
+  end
+end

data/lib/resas/api/response/body.rb

@@ -0,0 +1,101 @@
+# RESAS (Regional Economy Society Analyzing System) に関する機能を格納する名前空間
+# @see {https://resas.go.jp/}
+module Resas
+
+  # RESAS API を扱うための Gem - トップの名前空間
+  # @see {https://opendata.resas-portal.go.jp/}
+  # @see {https://opendata.resas-portal.go.jp/docs/api/v1-rc.1/index.html}
+  module Api
+
+    module Response
+
+      class Body
+
+        def initialize( h, client, path, options )
+          @h = h
+
+          @client = client
+          @path = path
+          @options = options
+
+          raise_error_if_needed
+        end
+
+        # @return [URI::HTTPS or URI::Generic]
+        def path( full: true )
+          options = @options.dup.merge( full: full )
+          @client.path( @path, options )
+        end
+
+        # @return [Array or nil]
+        def result
+          @h[ 'result' ]
+        end
+
+        # @return [String or nil]
+        def message
+          @h[ 'message' ]
+        end
+
+        # @return [Integer or nil]
+        def status_code
+          _status_code = @h[ 'statusCode' ]
+          _status_code.present? ? _status_code.to_i : nil
+        end
+
+        # @return [String or nil]
+        def description
+          @h[ 'description' ]
+        end
+
+        # @return [Boolean]
+        def has_message?
+          message.present?
+        end
+
+        # @return [Boolean]
+        def has_description?
+          description.present?
+        end
+
+        def method_missing( method_name, *args, &block )
+          return super unless @h.respond_to?( method_name )
+          @h.send( method, *args, &block )
+        rescue NoMethodError => e
+          e.message = <<-MSG
+            Resas::Api::Response::Body#method_missing
+            #{ e.message }
+              method_name: #{ method_name }, @h.class: #{ @h.class }
+          MSG
+          # binding.pry
+          raise e
+        end
+
+        def respond_to?( method, include_all = true )
+          return @h.respond_to?( method, include_all ) || super
+        end
+
+        private
+
+        def raise_error_if_needed
+          raise error_class.new( @h ) unless result.present?
+        end
+
+        def error_class
+          case status_code
+          when 403
+            Resas::Api::Response::Forbidden
+          when 404
+            Resas::Api::Response::NotFound
+          when 429
+            Resas::Api::Response::TooManyRequests
+          else
+            Resas::Api::Response::BaseError
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/resas/api/response/forbidden.rb

@@ -0,0 +1,17 @@
+# RESAS (Regional Economy Society Analyzing System) に関する機能を格納する名前空間
+# @see {https://resas.go.jp/}
+module Resas
+
+  # RESAS API を扱うための Gem - トップの名前空間
+  # @see {https://opendata.resas-portal.go.jp/}
+  # @see {https://opendata.resas-portal.go.jp/docs/api/v1-rc.1/index.html}
+  module Api
+
+    module Response
+
+      class Forbidden < BaseError
+      end
+
+    end
+  end
+end

data/lib/resas/api/response/not_found.rb

@@ -0,0 +1,17 @@
+# RESAS (Regional Economy Society Analyzing System) に関する機能を格納する名前空間
+# @see {https://resas.go.jp/}
+module Resas
+
+  # RESAS API を扱うための Gem - トップの名前空間
+  # @see {https://opendata.resas-portal.go.jp/}
+  # @see {https://opendata.resas-portal.go.jp/docs/api/v1-rc.1/index.html}
+  module Api
+
+    module Response
+
+      class NotFound < BaseError
+      end
+
+    end
+  end
+end

data/lib/resas/api/response/too_many_requests.rb

@@ -0,0 +1,17 @@
+# RESAS (Regional Economy Society Analyzing System) に関する機能を格納する名前空間
+# @see {https://resas.go.jp/}
+module Resas
+
+  # RESAS API を扱うための Gem - トップの名前空間
+  # @see {https://opendata.resas-portal.go.jp/}
+  # @see {https://opendata.resas-portal.go.jp/docs/api/v1-rc.1/index.html}
+  module Api
+
+    module Response
+
+      class TooManyRequests < BaseError
+      end
+
+    end
+  end
+end

data/lib/resas/api/tasks/make_methods.rake

@@ -0,0 +1,144 @@
+require 'active_support'
+require 'active_support/core_ext'
+
+namespace :make_methods do
+
+  desc 'Make methods of Resas::Api::Endpoint'
+  task :endpoints do
+    texts = []
+
+    # 共通
+
+    texts << <<-TXT
+    都道府県一覧 api/v1-rc.1/prefectures
+    市区町村一覧 api/v1-rc.1/cities
+    旧市区町村一覧 api/v1-rc.1/oldCities
+    TXT
+
+    texts << <<-TXT
+    産業大分類 api/v1-rc.1/industries/broad
+    産業中分類 api/v1-rc.1/industries/middle
+    産業小分類 api/v1-rc.1/industries/narrow
+    職業大分類 api/v1-rc.1/jobs/broad
+    職業中分類 api/v1-rc.1/jobs/middle
+    TXT
+
+    texts << <<-TXT
+    特許.技術分野 api/v1-rc.1/patents/broad
+    特許.技術テーマ api/v1-rc.1/patents/middle
+    税関 api/v1-rc.1/customs
+    輸出入花火図.取引国_地域 api/v1-rc.1/regions/broad
+    輸出入花火図.取引国_国 api/v1-rc.1/regions/middle
+    農業部門 api/v1-rc.1/regions/agricultureDepartments
+    特許権者の所在地 api/v1-rc.1/patents/locations
+    輸出入花火図.品目_大分類 api/v1-rc.1/tradeInfoItemTypes/broad
+    輸出入花火図.品目_中分類 api/v1-rc.1/tradeInfoItemTypes/middle
+    輸出入花火図.品目_小分類 api/v1-rc.1/tradeInfoItemTypes/narrow
+    TXT
+
+    # 産業
+
+    texts << <<-TXT
+    特許一覧 api/v1-rc.1/industry/patent/list
+    国、税関別輸出入 api/v1-rc.1/industry/export/fromTo
+    海外への企業進出動向 api/v1-rc.1/industry/globalmarket/perPref
+    産業別特化係数 api/v1-rc.1/industry/power/forIndustry
+    地域別特化係数 api/v1-rc.1/industry/power/forArea
+    製造業事業所単位分析_継続・参入・退出事業所別の推移 api/v1-rc.1/industry/power/forManufacturerEstablishments
+    TXT
+
+    # 農林水産業
+
+    texts << <<-TXT
+    農産物の出荷先別販売金額構成 api/v1-rc.1/agriculture/sales/shipValue
+    農産物の出荷先別経営体数割合 api/v1-rc.1/agriculture/sales/shipRatio
+    経営耕地面積 api/v1-rc.1/agriculture/land/forStacked
+    経営耕地面積規模別の経営体割合 api/v1-rc.1/agriculture/land/Ratio
+    農地流動化率 api/v1-rc.1/agriculture/land/forMobility
+    耕作放棄地率 api/v1-rc.1/agriculture/land/forAbandonment
+    農業部門別販売金額 api/v1-rc.1/agriculture/all/forStacked
+    年間延べ農作業日数 api/v1-rc.1/agriculture/crops/workingDays
+    農産物販売金額（人日あたり） api/v1-rc.1/agriculture/crops/sales
+    農業経営者・農業就業人口の年齢構成 api/v1-rc.1/agriculture/crops/farmersAgeStructure
+    農業経営者・農業就業人口の平均年齢 api/v1-rc.1/agriculture/crops/farmersAverageAge
+    農業生産関連事業の実施状況（経営体数） api/v1-rc.1/agriculture/crops/relatedBusiness
+    農業経営体の法人化率 api/v1-rc.1/agriculture/crops/averageOfCorporate
+    TXT
+
+    texts << <<-TXT
+    林業総収入（総額） api/v1-rc.1/forestry/income/forStacked
+    林産物販売金額（経営体あたり） api/v1-rc.1/forestry/income/forSales
+    林作業請負収入（経営体あたり） api/v1-rc.1/forestry/income/forContractRevenue
+    林産物販売金額帯別の経営体割合 api/v1-rc.1/forestry/income/forSalesRatio
+    林作業請負収入金額帯別の経営体割合 api/v1-rc.1/forestry/income/forContractRevenueRatio
+    主要林業部門別延べ経営体数 api/v1-rc.1/forestry/income/allPortfolio
+    主要林業部門別延べ経営体数構成 api/v1-rc.1/forestry/income/allForStacked
+    TXT
+
+    texts << <<-TXT
+    主要海面漁業種類別延べ経営体数構成 api/v1-rc.1/fishery/sea/staple
+    海面漁獲物等販売金額（総額） api/v1-rc.1/fishery/sea/totalSales
+    海面漁獲物等販売金額（経営体あたり） api/v1-rc.1/fishery/sea/managementUnitSales
+    海面漁獲物等販売金額帯別の経営体割合 api/v1-rc.1/fishery/sea/sales
+    海面漁獲物等出荷先別販売金額構成 api/v1-rc.1/fishery/sea/shipValue
+    海面漁獲物等出荷先別経営体数割合 api/v1-rc.1/fishery/sea/shipRatio
+    海面養殖販売金額（総額） api/v1-rc.1/fishery/sea/aquacultureTotalSales
+    海面養殖販売金額（経営体あたり） api/v1-rc.1/fishery/sea/aquacultureManagementUnitSales
+    海面養殖販売金額帯別の経営体割合 api/v1-rc.1/fishery/sea/aquacultureSales
+    TXT
+
+    # 観光
+
+    texts << <<-TXT
+    指定地域への国籍別訪問者数 api/v1-rc.1/tourism/foreigners/forFrom
+    指定国籍からの訪問者数 api/v1-rc.1/tourism/foreigners/forTo
+    TXT
+
+    # 人口
+
+    texts << <<-TXT
+    人口の自然増減 api/v1-rc.1/population/nature
+    人口構成 api/v1-rc.1/population/composition/perYear
+    人口ピラミッド api/v1-rc.1/population/composition/pyramid
+    人口増減率 api/v1-rc.1/population/sum/perYear
+    出生数・死亡数／転入数・転出数 api/v1-rc.1/population/sum/estimate
+    将来人口推計 api/v1-rc.1/population/future/cities
+    TXT
+
+    # 自治体比較
+
+    texts << <<-TXT
+    企業数 api/v1-rc.1/municipality/company/perYear
+    事業所数 api/v1-rc.1/municipality/plant/perYear
+    創業比率 api/v1-rc.1/municipality/foundation/perYear
+    一人当たり地方税 api/v1-rc.1/municipality/taxes/perYear
+    有効求人倍率 api/v1-rc.1/municipality/job/perYear
+    製造品出荷額 api/v1-rc.1/municipality/manufacture/perYear
+    従業者数（事業所単位） api/v1-rc.1/municipality/employee/perYear
+    付加価値額（企業単位） api/v1-rc.1/municipality/value/perYear
+    労働生産性（企業単位） api/v1-rc.1/municipality/labor/perYear
+    黒字赤字企業比率 api/v1-rc.1/municipality/surplus/perYear
+    一人当たり賃金 api/v1-rc.1/municipality/wages/perYear
+    年間商品販売額 api/v1-rc.1/municipality/sales/perYear
+    TXT
+
+
+    texts.each do | text |
+      rows = text.split( /\r\n|\r|\n/ )
+      rows.each do | row |
+        /\A\s*(.+)\s+api\/v1-rc\.1\/([a-zA-Z\/]+)/ =~ row
+        type, dirs = $1, $2
+        method_name = dirs.split( '/' ).map( &:underscore ).join( '_' )
+        puts <<-METHOD
+          \# #{ type } (#{ dirs })
+          def #{ method_name }( params = {} )
+            get( '#{ dirs }', params )
+          end
+        METHOD
+
+        puts ''
+      end
+    end
+  end
+
+end

data/lib/resas/api/version.rb

@@ -1,7 +1,15 @@
+# RESAS (Regional Economy Society Analyzing System) に関する機能を格納する名前空間
+# @see {https://resas.go.jp/}
 module Resas
+
+  # RESAS API を扱うための Gem - トップの名前空間
+  # @see {https://opendata.resas-portal.go.jp/}
+  # @see {https://opendata.resas-portal.go.jp/docs/api/v1-rc.1/index.html}
   module Api
 
-    VERSION = '0.1.6'
+    # この Gem のバージョン
+    # @return [String]
+    VERSION = '0.2.0'.freeze
 
   end
 end

data/resas-api.gemspec

@@ -4,15 +4,15 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'resas/api/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "resas-api"
-  spec.version       = Resas::Api::VERSION
-  spec.authors       = ["Shu Fujita"]
-  spec.email         = ["s.fujita@nard.tech"]
+  spec.name = 'resas-api'
+  spec.version = Resas::Api::VERSION
+  spec.authors = [ 'Shu Fujita' ]
+  spec.email = [ 's.fujita@nard.tech' ]
 
-  spec.summary       = 'API for RESAS'
-  spec.description   = 'RESAS (Regional Economy Society Analyzing System) is developed by Japanese government. (https://resas.go.jp/) This gem enables you to access to API more easily.'
-  spec.homepage      = 'https://github.com/nard-tech/resas-api'
-  spec.license       = "MIT"
+  spec.summary = 'Ruby Gem for RESAS (Regional Economy Society Analyzing System) API by Japanese government.'
+  spec.description = 'RESAS (Regional Economy Society Analyzing System) is developed by Japanese government. (https://resas.go.jp/) This gem enables you to access to API more easily.'
+  spec.homepage = 'https://github.com/nard-tech/resas-api'
+  spec.license = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -23,15 +23,20 @@ Gem::Specification.new do |spec|
       "public gem pushes."
   end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |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.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = [ 'lib' ]
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency 'activesupport', '~> 5.0', '>= 5.0.0.1'
+  spec.add_runtime_dependency 'activesupport', '~> 5.0', '>= 5.0.0.1'
+
+  spec.add_runtime_dependency 'nard-appi', '>= 0.1.0'
+  spec.add_runtime_dependency 'faraday', '= 0.10'
+  spec.add_runtime_dependency 'faraday_middleware', '= 0.10.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 end