resas_kit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 62842cb3c7638d750f33360cd8cee37235d72a50
+  data.tar.gz: 188ac6fdeed7353f58a08cba562e4ee07e08dc3b
+SHA512:
+  metadata.gz: 96211856215f98bbbc205c77ff2a1ee9358e05b29d75937456f0fdab260cdfaccca2b2f0ab8fa13db8346c335bf9f94f6cc9342d6bbfc00a788bc92d459b3952
+  data.tar.gz: 267a696479e7826dd1f9441ca6f14f814cfae7048cfe3bc100027f919d8ba6b6f790cb358c45a9386dfe34255b5a8f3213a805bfaa3a168b80e8a4bc2284443d

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,39 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  DisplayCopNames: true
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - '*.gemspec'
+
+Metrics/LineLength:
+  Max: 100
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/ExtraSpacing:
+  Exclude:
+    - '*.gemspec'
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/SpaceAroundOperators:
+  Exclude:
+    - '*.gemspec'
+
+Style/UnneededPercentQ:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,18 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-12-03 11:46:59 +0900 using RuboCop version 0.45.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 6
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/resas_kit/hash_extensions.rb'
+    - 'lib/resas_kit/resource.rb'
+    - 'lib/resas_kit/response.rb'
+    - 'lib/resas_kit/response/middleware.rb'
+    - 'lib/resas_kit/response/raise_error.rb'

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.10
+  - 2.2.6
+  - 2.3.3
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in resas_kit.gemspec
+gemspec
+
+if Gem::Version.create(RUBY_VERSION) < Gem::Version.create('2.2.2')
+  gem 'activesupport', '< 5.0.0'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 emsk
+
+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,64 @@
+# ResasKit
+
+[![Build Status](https://travis-ci.org/emsk/resas_kit.svg?branch=master)](https://travis-ci.org/emsk/resas_kit)
+[![Coverage Status](https://coveralls.io/repos/github/emsk/resas_kit/badge.svg?branch=master)](https://coveralls.io/github/emsk/resas_kit)
+[![Code Climate](https://codeclimate.com/github/emsk/resas_kit/badges/gpa.svg)](https://codeclimate.com/github/emsk/resas_kit)
+[![Dependency Status](https://gemnasium.com/badges/github.com/emsk/resas_kit.svg)](https://gemnasium.com/github.com/emsk/resas_kit)
+[![Inline docs](http://inch-ci.org/github/emsk/resas_kit.svg?branch=master)](http://inch-ci.org/github/emsk/resas_kit)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.txt)
+
+Ruby wrapper for the [RESAS API](https://opendata.resas-portal.go.jp).
+
+## Usage
+
+```ruby
+require 'resas_kit'
+
+client = ResasKit::Client.new(api_key: '1234567890ABCDEFGHIJ1234567890abcdefghij')
+
+response = client.get('prefectures')
+response.body # get body
+response.headers # get headers
+response.status # get status
+
+client.get('tourism/foreigners/forFrom', year: 2016, pref_code: '32', purpose: 2, add_area: '31,33') # underscored key
+client.get('tourism/foreigners/forFrom', year: 2016, prefCode: '32', purpose: 2, addArea: '31,33') # camelized key
+
+client.get('prefectures').body.result[0].pref_name # method chaining
+```
+
+## ENV
+
+| ENV Variable | Description |
+| :----------- | :---------- |
+| `RESAS_API_KEY` | Your RESAS API KEY |
+| `RESAS_API_VERSION` | Target RESAS API VERSION |
+
+You can create instance more easily.
+
+```ruby
+client = ResasKit::Client.new
+```
+
+## Supported RESAS API Version
+
+RESAS API [v1-rc.1](https://opendata.resas-portal.go.jp/docs/api/v1-rc.1/index.html)
+
+## Supported Ruby Versions
+
+* Ruby 2.0.0
+* Ruby 2.1
+* Ruby 2.2
+* Ruby 2.3
+
+## Contributing
+
+1. Fork it ( https://github.com/emsk/resas_kit/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+[MIT](LICENSE.txt)

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 'resas_kit'
+
+# 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

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/resas_kit/client.rb

@@ -0,0 +1,72 @@
+require 'resas_kit/error'
+require 'resas_kit/response'
+require 'resas_kit/version'
+require 'resas_kit/response/raise_error'
+require 'resas_kit/hash_extensions'
+
+module ResasKit
+  # Client for the RESAS API
+  #
+  # @see https://opendata.resas-portal.go.jp
+  class Client
+    API_ENDPOINT = 'https://opendata.resas-portal.go.jp'.freeze
+    API_VERSION  = 'v1-rc.1'.freeze
+    USER_AGENT   = "ResasKit Ruby Gem #{ResasKit::VERSION}".freeze
+
+    attr_accessor :api_key, :api_version
+
+    # Initialize a new Client object with given options
+    #
+    # @param options [Hash] Initialize options
+    # @option options [String] :api_key RESAS API key
+    # @option options [String] :api_version RESAS API version
+    def initialize(options = {})
+      @api_key     = ENV['RESAS_API_KEY']
+      @api_version = ENV['RESAS_API_VERSION']
+
+      options.each do |key, value|
+        instance_variable_set(:"@#{key}", value)
+      end
+    end
+
+    # Make a HTTP GET request
+    #
+    # @param path [String] Path for request
+    # @param params [Hash] Request parameters
+    # @return [ResasKit::Response] Response from API server
+    def get(path, params = {})
+      request(:get, path, params)
+    end
+
+    private
+
+    def request(method, path, params = {})
+      params.camelize_keys!
+      faraday_response = connection.send(method, request_path(path), params)
+      ResasKit::Response.new(faraday_response)
+    rescue Faraday::ConnectionFailed => e
+      raise ResasKit::Error, "#{ResasKit::ConnectionError.name.demodulize} - #{e.message}"
+    end
+
+    def connection
+      Faraday.new(url: API_ENDPOINT, headers: request_headers) do |faraday|
+        faraday.request(:url_encoded)
+        faraday.response(:json, content_type: /application\/json/)
+        faraday.response(:error)
+        faraday.adapter(Faraday.default_adapter)
+      end
+    end
+
+    def request_headers
+      { 'User-Agent' => USER_AGENT, 'X-API-KEY' => @api_key }
+    end
+
+    def request_path(path)
+      "/api/#{request_api_version}/#{URI.escape(path)}"
+    end
+
+    def request_api_version
+      @api_version || API_VERSION
+    end
+  end
+end

data/lib/resas_kit/error.rb

@@ -0,0 +1,25 @@
+module ResasKit
+  # Custom error class for rescuing from RESAS errors
+  class Error < StandardError
+    # Make a custom error message
+    #
+    # @param response [Hash] Error response
+    # @return [String] Error message
+    def self.build_error_message(response)
+      status_code = response['statusCode'].to_s
+      description = response['description'].to_s
+
+      message = "#{name.demodulize} - #{response['message']}"
+      message += " (STATUS CODE: #{status_code})" unless status_code.empty?
+      message += " (DESCRIPTION: #{description})" unless description.empty?
+      message
+    end
+  end
+
+  class ConnectionError < Error; end
+  class UnexpectedError < Error; end
+  class BadRequestError < Error; end
+  class ForbiddenError < Error; end
+  class NotFoundError < Error; end
+  class TooManyRequestsError < Error; end
+end

data/lib/resas_kit/hash_extensions.rb

@@ -0,0 +1,19 @@
+require 'active_support/core_ext/hash/keys'
+
+class Hash
+  # Camelize all keys of the hash
+  #
+  # @return [Hash] The hash with camelized keys
+  def camelize_keys!
+    deep_transform_keys! do |key|
+      key.to_s
+        .split(/(_*\d+_*)/)
+        .reject(&:empty?)
+        .map { |k| k.camelize(:lower) }
+        .join('_')
+        .to_sym
+    end
+
+    self
+  end
+end

data/lib/resas_kit/resource.rb

@@ -0,0 +1,77 @@
+module ResasKit
+  class Resource
+    def initialize(raw_data = {})
+      @attributes = {}
+
+      raw_data.each do |key, value|
+        @attributes[key.to_sym] = process_value(value)
+      end
+
+      eigenclass = class << self; self; end
+      eigenclass.send(:define_accessors, raw_data.keys)
+    end
+
+    class << self
+      def define_accessors(attributes)
+        attributes.each do |attribute|
+          define_reader(attribute)
+          define_writer(attribute)
+          define_boolean_method(attribute)
+        end
+      end
+
+      def define_reader(attribute)
+        class_eval do
+          define_method(attribute) do
+            @attributes[attribute.to_sym]
+          end
+
+          alias_method(attribute.underscore, attribute)
+        end
+      end
+
+      def define_writer(attribute)
+        method_name = "#{attribute}="
+        alias_method_name = "#{attribute.underscore}="
+
+        class_eval do
+          define_method(method_name) do |value|
+            @attributes[attribute.to_sym] = value
+          end
+
+          alias_method(alias_method_name, method_name)
+        end
+      end
+
+      def define_boolean_method(attribute)
+        method_name = "#{attribute}?"
+        alias_method_name = "#{attribute.underscore}?"
+
+        class_eval do
+          define_method(method_name) do
+            !!@attributes[attribute.to_sym]
+          end
+
+          alias_method(alias_method_name, method_name)
+        end
+      end
+    end
+
+    private_class_method(
+      :define_accessors,
+      :define_reader,
+      :define_writer,
+      :define_boolean_method
+    )
+
+    private
+
+    def process_value(value)
+      case value
+      when Hash  then self.class.new(value)
+      when Array then value.map { |v| process_value(v) }
+      else value
+      end
+    end
+  end
+end

data/lib/resas_kit/response/middleware.rb

@@ -0,0 +1,13 @@
+module ResasKit
+  class Response
+    class Middleware < Faraday::Response::Middleware
+      attr_reader(:headers, :status, :body)
+
+      def on_complete(env)
+        @headers = env.response_headers
+        @status  = env.status
+        @body    = env.body
+      end
+    end
+  end
+end

data/lib/resas_kit/response/raise_error.rb

@@ -0,0 +1,36 @@
+require 'resas_kit/response/middleware'
+
+module ResasKit
+  class Response
+    class RaiseError < ResasKit::Response::Middleware
+      CODE_ERRORS = {
+        400 => ResasKit::BadRequestError,
+        403 => ResasKit::ForbiddenError,
+        404 => ResasKit::NotFoundError,
+        429 => ResasKit::TooManyRequestsError
+      }.freeze
+
+      def on_complete(env)
+        super
+        raise ResasKit::Error, error_message unless success?
+      end
+
+      private
+
+      def success?
+        json_body.key?('result')
+      end
+
+      def error_message
+        klass = CODE_ERRORS[json_body['statusCode'].to_i] || ResasKit::UnexpectedError
+        klass.build_error_message(json_body)
+      end
+
+      def json_body
+        @json_body ||= JSON.parse(body)
+      end
+    end
+
+    Faraday::Response.register_middleware(error: RaiseError)
+  end
+end

data/lib/resas_kit/response.rb

@@ -0,0 +1,24 @@
+require 'resas_kit/resource'
+
+module ResasKit
+  class Response
+    attr_reader(:headers, :status, :body)
+
+    def initialize(response)
+      @headers = process(response.headers)
+      @status  = process(response.status)
+      @body    = process(response.body)
+    end
+
+    private
+
+    def process(raw)
+      case raw
+      when Hash   then Resource.new(raw)
+      when Array  then raw.map { |hash| process(hash) }
+      when String then Resource.new
+      else raw
+      end
+    end
+  end
+end

data/lib/resas_kit/version.rb

@@ -0,0 +1,3 @@
+module ResasKit
+  VERSION = '0.1.0'.freeze
+end

data/lib/resas_kit.rb

@@ -0,0 +1,4 @@
+require 'active_support/core_ext/string/inflections'
+require 'faraday'
+require 'faraday_middleware'
+require 'resas_kit/client'

data/resas_kit.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resas_kit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'resas_kit'
+  spec.version       = ResasKit::VERSION
+  spec.authors       = ['emsk']
+  spec.email         = ['emsk1987@gmail.com']
+
+  spec.summary       = %q{Wrapper for the RESAS API.}
+  spec.description   = %q{Client library for the RESAS API.}
+  spec.homepage      = 'https://github.com/emsk/resas_kit'
+  spec.license       = 'MIT'
+
+  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.add_runtime_dependency 'activesupport', '>= 4.2.7.1'
+  spec.add_runtime_dependency 'faraday', '~> 0.10.0'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 0.10.1'
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'coveralls', '~> 0.8.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.45.0'
+  spec.add_development_dependency 'simplecov', '~> 0.12.0'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: resas_kit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- emsk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.7.1
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.16
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.16
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.45.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.45.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Client library for the RESAS API.
+email:
+- emsk1987@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/resas_kit.rb
+- lib/resas_kit/client.rb
+- lib/resas_kit/error.rb
+- lib/resas_kit/hash_extensions.rb
+- lib/resas_kit/resource.rb
+- lib/resas_kit/response.rb
+- lib/resas_kit/response/middleware.rb
+- lib/resas_kit/response/raise_error.rb
+- lib/resas_kit/version.rb
+- resas_kit.gemspec
+homepage: https://github.com/emsk/resas_kit
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Wrapper for the RESAS API.
+test_files: []