base_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2f6ba9e27bf46cf201d84629e1aecb05c88bf1d99a91239e17efa30eaf031573
+  data.tar.gz: '08bb79a098243ac94bf58c5078c9b13dbb4ad0215b18bfb427e7e00ec8b00411'
+SHA512:
+  metadata.gz: fd214b36ca3748cbcffae1c724c94798bb8e9bee8b27238fd5f262199d373c6a01b71429961c9a6b1eecbdd672ee33726932a2585d5c03a379ac7e150b7b18c1
+  data.tar.gz: 1b6894d07fd8febae5a146566679d3a9c4ca87ec8e2ad958eff924cf604a6cca2c6ab368bbfd8d1d17d4358a47dde34757ab7e838ab19ffade9b3771aee9d2bb

data/.github/workflows/ruby.yml

@@ -0,0 +1,27 @@
+name: Rspec
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.6', '2.7' ]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Build and test with RSpec
+      env:
+        BASE_API_SHOP_URL: ${{ secrets.BASE_API_SHOP_URL }}
+        BASE_API_ACCESS_TOKEN: ${{ secrets.BASE_API_ACCESS_TOKEN }}
+        BASE_API_CLIENT_ID: ${{ secrets.BASE_API_CLIENT_ID }}
+        BASE_API_REDIRECT_URI: ${{ secrets.BASE_API_REDIRECT_URI }}
+        BASE_API_CLIENT_SECRET: ${{ secrets.BASE_API_CLIENT_SECRET }}
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rspec

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

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 yshunske@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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in base_api.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem 'pry-byebug'
+
+group :test do
+  gem 'vcr'
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    base_api (0.1.0)
+      httparty (>= 0.17.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (1.0.0)
+    httparty (0.17.3)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    method_source (0.9.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    multi_xml (0.6.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    public_suffix (4.0.3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    safe_yaml (1.0.5)
+    vcr (5.0.0)
+    webmock (3.8.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  base_api!
+  pry-byebug
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 yamashun
+
+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,83 @@
+# BaseApi
+![](https://github.com/yamashun/base_api/workflows/Rspec/badge.svg)
+
+A Ruby interface to the BASE API. (This library is unofficial.)
+
+[BASE API doc](https://docs.thebase.in/docs/api/)
+
+BASE is a Japanese service that allows you to easily open an online shop. Please check the [official page](https://thebase.in/) for details.
+
+[日本語版のREADME](https://github.com/yamashun/base_api/blob/master/README_JP.md)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'base_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install base_api
+
+## Usage
+### Basic usage
+
+```ruby
+# Initialize Client instance with bearer token issued with OAuth2.0
+client = BaseApi::Client.new(access_token: 'bearer token')
+
+# Fetch items
+response = client.items
+response['items']
+```
+
+### Default results per request
+Default results from the BASE API are 20. If you wish to change per request results number, you can set in three ways:
+
+```bash
+# Environment variable
+export BASE_API_LIMIT=30
+```
+
+or
+
+```ruby
+# Arguments for initialzie a client instance
+client = BaseApi::Client.new(access_token: 'bearer token', limit: 30)
+```
+
+or
+
+```ruby
+# Arguments for call api
+client = BaseApi::Client.new(access_token: 'bearer token')
+client.items({ limit: 30 })
+```
+
+### Pagination
+
+
+### Errors
+
+
+## Development
+TODO
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/base_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/base_api/blob/master/CODE_OF_CONDUCT.md).
+
+
+## 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 BaseApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/base_api/blob/master/CODE_OF_CONDUCT.md).

data/README_JP.md

@@ -0,0 +1,116 @@
+# BaseApi
+![](https://github.com/yamashun/base_api/workflows/Rspec/badge.svg)
+
+BASE APIのためのクライアントを提供するRuby gemです。（非公式です。）
+[BASE API doc](https://docs.thebase.in/docs/api/)
+
+BASEは簡単にネットショップを開設できる日本のサービスです。詳しくは公式ページ[公式ページ](https://thebase.in/)を確認してください。
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'base_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install base_api
+
+## Usage
+### Basic usage
+
+```ruby
+# OAuth2.0で払い出されたBearerトークンを使ってクライアントのインスタンスを生成します。
+client = BaseApi::Client.new(access_token: 'bearer token')
+
+# 商品の取得
+response = client.items
+response['items']
+```
+
+### リスト返却APIで取得する要素数
+リストを返すBASE APIで一度に返却される要素の個数はデフォルトで20となっています。変更したい場合は以下のいずれかの方法で変更できます。
+
+```bash
+# 環境変数に設定する
+export BASE_API_LIMIT=30
+```
+
+or
+
+```ruby
+# クライアントを生成時に引数に渡す
+client = BaseApi::Client.new(access_token: 'bearer token', limit: 30)
+```
+
+or
+
+```ruby
+# API呼び出し時に引数を渡す
+client = BaseApi::Client.new(access_token: 'bearer token')
+client.items({ limit: 30 })
+```
+
+### ページネーション
+ページネーション用に `fetch_next_page` を用意しています。
+
+```ruby
+client = BaseApi::Client.new(access_token: 'bearer token')
+# 1番目から20番目の要素を取得
+client.items
+
+# 21番目から40番目の要素を取得
+client.fetch_next_page
+```
+
+### コールバック
+ブロックを渡すことでAPIの結果に応じた処理が可能です。ブロックはレスポンス結果とエラーオブジェクトを引数にとります。
+
+```ruby
+client.items do |res, err|
+  if err
+    # エラーに応じた処理
+  else
+    # レスポンスに応じた処理
+  end
+end
+```
+
+## 未対応API
+現在以下のAPIは未対応
+- [GET /1/oauth/authorize](https://docs.thebase.in/docs/api/oauth/authorize)
+- [POST /1/orders/edit_status](https://docs.thebase.in/docs/api/orders/edit_status)
+- [GET /1/savings](https://docs.thebase.in/docs/api/savings/)
+- [GET /1/delivery_companies](https://docs.thebase.in/docs/api/delivery_companies/)
+- [GET /1/search](https://docs.thebase.in/docs/api/search/)
+- [GET /1/search/refresh](https://docs.thebase.in/docs/api/search/refresh)
+
+
+## TODO
+- 未対応APIの対応
+- Railsアプリ用の認可コード取得のためのMVCテンプレートとジェネレータ
+
+## 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]/base_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/base_api/blob/master/CODE_OF_CONDUCT.md).
+
+
+## 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 BaseApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/base_api/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/base_api.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/base_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "base_api"
+  spec.version       = BaseApi::VERSION
+  spec.authors       = ["yamashun"]
+  spec.email         = ["yshunske@gmail.com"]
+
+  spec.summary       = %q{A Ruby interface to the BASE API. (This library is unofficial.)}
+  spec.description   = %q{BASE is a Japanese service that allows you to easily open an online shop. Please check the official page(https://thebase.in/) for details}
+  spec.homepage      = "https://github.com/yamashun/base_api"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/yamashun/base_api"
+  spec.metadata["changelog_uri"] = "https://github.com/yamashun/base_api"
+
+  # 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_dependency 'httparty', '>= 0.17.3'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "base_api"
+
+# 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/base_api.rb

@@ -0,0 +1,17 @@
+require "base_api/version"
+require "base_api/client"
+require "base_api/configurable"
+require "base_api/default"
+
+module BaseApi
+  class Error < StandardError; end
+  # Your code goes here...
+
+  class << self
+    include BaseApi::Configurable
+
+    def client
+      @client = BaseApi::Client.new(options)
+    end
+  end
+end

data/lib/base_api/client.rb

@@ -0,0 +1,128 @@
+require 'base_api/configurable'
+require 'httparty'
+require 'base_api/error'
+require 'base_api/client/authorizations'
+require 'base_api/client/users'
+require 'base_api/client/items'
+require 'base_api/client/categories'
+require 'base_api/client/item_categories'
+require 'base_api/client/orders'
+
+module BaseApi
+  # TODO: 責務でクラス分ける
+  class Client
+    include HTTParty
+    include BaseApi::Configurable
+    include BaseApi::Client::Authorizations
+    include BaseApi::Client::Users
+    include BaseApi::Client::Items
+    include BaseApi::Client::Categories
+    include BaseApi::Client::ItemCategories
+    include BaseApi::Client::Orders
+
+    base_uri 'https://api.thebase.in'
+
+    attr_accessor :client_id, :client_secret, :code, :access_token, :refresh_token,
+                  :offset, :response
+
+    def initialize(options = {})
+      BaseApi::Configurable.keys.each do |key|
+        value = options.key?(key) ? options[key] : BaseApi.instance_variable_get(:"@#{key}")
+        instance_variable_set(:"@#{key}", value)
+      end
+
+      yield(self) if block_given?
+    end
+
+    def inspect
+      inspected = super
+
+      inspected.gsub! @code, '*******' if @code
+      inspected.gsub! @access_token, "#{'*'*28}#{@access_token[28..-1]}" if @access_token
+      inspected.gsub! @refresh_token, "#{'*'*28}#{@refresh_token[28..-1]}" if @refresh_token
+      inspected.gsub! @client_secret, "#{'*'*28}#{@client_secret[28..-1]}" if @client_secret
+
+      inspected
+    end
+
+    def fetch_next_page(&callback)
+      paginate(@last_page_args[:path], next_page_payload, &callback)
+    end
+
+    def reset_response
+      @response = nil
+      @last_page_args = nil
+    end
+
+    private
+
+    def call_post_api(path, payload = {}, &callback)
+      @response = self.class.post(path, { body: payload, headers: authorization_header })
+      handle_response(&callback)
+    end
+
+    def call_get_api(path, payload = {}, &callback)
+      @response = self.class.get(path, { query: payload, headers: authorization_header })
+      handle_response(&callback)
+    end
+
+    def handle_response(&callback)
+      check_status
+      success(response, &callback)
+    rescue => e
+      error(e, &callback)
+    end
+
+    def authorization_header
+      { Authorization: "Bearer #{access_token}" }
+    end
+
+    def paginate(path, payload = {}, &callback)
+      if different_path_request_called?(path)
+        reset_response
+      end
+
+      if payload[:offset].nil?
+        payload.merge!(offset: @offset)
+      end
+      if payload[:limit].nil?
+        payload.merge!(limit: @limit)
+      end
+
+      @last_page_args = { path: path, payload: payload }
+
+      call_get_api(path, payload, &callback)
+    end
+
+    def next_page_payload
+      next_offset = @last_page_args[:payload][:offset] + @last_page_args[:payload][:limit]
+      @last_page_args[:payload].merge(offset: next_offset)
+    end
+
+    def different_path_request_called?(path)
+      @last_page_args.is_a?(Hash) && @last_page_args[:path] != path
+    end
+
+    def check_status
+      if response.client_error?
+        raise BaseApi::ClientError.new(response)
+      elsif response.server_error?
+        raise BaseApi::ServerError.new(response)
+      end
+    end
+
+    def success(response, &block)
+      block.call(response, nil) if block_given?
+      response
+    end
+
+    def error(error, &block)
+      if block_given?
+        block.call(response, error)
+        response
+      else
+        raise error
+      end
+    end
+  end
+end

data/lib/base_api/client/authorizations.rb

@@ -0,0 +1,47 @@
+module BaseApi
+  class Client
+    module Authorizations
+      def oauth_access_token(&block)
+        call_post_api('/1/oauth/token', access_token_payload, &block)
+        if response.success?
+          @access_token = response['access_token']
+          @refresh_token = response['refresh_token']
+        end
+
+        response
+      end
+
+      def oauth_refresh_token(&block)
+        call_post_api('/1/oauth/token', refresh_token_payload, &block)
+        if response.success?
+          @access_token = response['access_token']
+          @refresh_token = response['refresh_token']
+        end
+
+        response
+      end
+
+      private
+
+      def access_token_payload
+        {
+          grant_type: 'authorization_code',
+          client_id: client_id,
+          client_secret: client_secret,
+          code: code,
+          redirect_uri: redirect_uri
+        }
+      end
+
+      def refresh_token_payload
+        {
+          grant_type: 'refresh_token',
+          client_id: client_id,
+          client_secret: client_secret,
+          refresh_token: refresh_token,
+          redirect_uri: redirect_uri
+        }
+      end
+    end
+  end
+end

data/lib/base_api/client/categories.rb

@@ -0,0 +1,34 @@
+module BaseApi
+  class Client
+    module Categories
+      # @return [HTTParty::Response]
+      # @see https://docs.thebase.in/docs/api/categories/
+      def categories(&block)
+        call_get_api('/1/categories', &block)
+      end
+
+      # @param [String] name
+      # @option param [Hash] option
+      # @return [HTTParty::Response]
+      # @see https://docs.thebase.in/docs/api/categories/add
+      def categories_add(name, option = {}, &block)
+        call_post_api('/1/categories/add',  { name: name }.merge(option), &block)
+      end
+
+      # @param [Integer|String] category_id
+      # @option param [Hash] option
+      # @return [HTTParty::Response]
+      # @see https://docs.thebase.in/docs/api/categories/edit
+      def categories_edit(category_id, option = {}, &block)
+        call_post_api('/1/categories/edit',  { category_id: category_id }.merge(option), &block)
+      end
+
+      # @param [Integer|String] category_id
+      # @return [HTTParty::Response]
+      # @see https://docs.thebase.in/docs/api/categories/delete
+      def categories_delete(category_id, &block)
+        call_post_api('/1/categories/delete', { category_id: category_id }, &block)
+      end
+    end
+  end
+end

data/lib/base_api/client/item_categories.rb

@@ -0,0 +1,27 @@
+module BaseApi
+  class Client
+    module ItemCategories
+      # @param [Integer|String] item_id
+      # @return [HTTParty::Response]
+      # @see https://docs.thebase.in/docs/api/item_categories/detail
+      def item_categories_detail(item_id, &block)
+        call_get_api("/1/item_categories/detail/#{item_id}", &block)
+      end
+
+      # @param [Integer|String] item_id
+      # @param [Integer|String] category_id
+      # @return [HTTParty::Response]
+      # @see https://docs.thebase.in/docs/api/item_categories/add
+      def item_categories_add(item_id, category_id, &block)
+        call_post_api('/1/item_categories/add', { item_id: item_id, category_id: category_id }, &block)
+      end
+
+      # @param [Integer|String] item_category_id
+      # @return [HTTParty::Response]
+      # @see https://docs.thebase.in/docs/api/item_categories/delete
+      def item_categories_delete(item_category_id, &block)
+        call_post_api('/1/item_categories/delete', { item_category_id: item_category_id }, &block)
+      end
+    end
+  end
+end

data/lib/base_api/client/items.rb

@@ -0,0 +1,78 @@
+module BaseApi
+  class Client
+    module Items
+      # @option params [Hash] option
+      # @return [HTTParty::Response]
+      # @see https://docs.thebase.in/docs/api/items/
+      def items(option = {}, &block)
+        paginate('/1/items', option, &block)
+      end
+
+      # @param [String] q: search word
+      # @option params [Hash] option
+      # @return [HTTParty::Response]
+      # @see https://docs.thebase.in/docs/api/items/search
+      def items_search(q, option = {}, &block)
+        paginate('/1/items/search', { q: q }.merge(option), &block)
+      end
+
+      # @param [Integer | String] item_id
+      # @return [HTTParty::Response]
+      # @see https://docs.thebase.in/docs/api/items/detail
+      def items_detail(item_id, &block)
+        call_get_api("/1/items/detail/#{item_id}", &block)
+      end
+
+      # @param [Hash] item
+      # @return [HTTParty::Response]
+      # @see https://docs.thebase.in/docs/api/items/add
+      def items_add(item, &block)
+        call_post_api('/1/items/add', item, &block)
+      end
+
+      # @param [Hash] item
+      # @return [HTTParty::Response]
+      # @see https://docs.thebase.in/docs/api/items/edit
+      def items_edit(item, &block)
+        call_post_api('/1/items/edit', item, &block)
+      end
+
+      # @param [Integer|String] item_id
+      # @return [HTTParty::Response]
+      # @see https://docs.thebase.in/docs/api/items/delete
+      def items_delete(item_id, &block)
+        call_post_api('/1/items/delete', { item_id: item_id }, &block)
+      end
+
+      # @param [Hash] item_image
+      # @return [HTTParty::Response]
+      # @see https://docs.thebase.in/docs/api/items/add_image
+      def items_add_image(item_image, &block)
+        call_post_api('/1/items/add_image', item_image, &block)
+      end
+
+      # @param [Integer|String] item_id
+      # @param [Integer|String] image_no: from 1 to 20
+      # @return [HTTParty::Response]
+      # @see https://docs.thebase.in/docs/api/items/delete_image
+      def items_delete_image(item_id, image_no, &block)
+        call_post_api('/1/items/delete_image', { item_id: item_id, image_no: image_no }, &block)
+      end
+
+      # @param [Hash] params
+      # @return [HTTParty::Response]
+      # @see https://docs.thebase.in/docs/api/items/edit_stock
+      def items_edit_stock(params, &block)
+        call_post_api('/1/items/edit_stock', params, &block)
+      end
+
+      # @param [Integer|String] item_id
+      # @param [Integer|String] variation_id
+      # @return [HTTParty::Response]
+      # @see https://docs.thebase.in/docs/api/items/delete_variation
+      def items_delete_variation(item_id, variation_id, &block)
+        call_post_api('/1/items/delete_variation', { item_id: item_id, variation_id: variation_id }, &block)
+      end
+    end
+  end
+end

data/lib/base_api/client/orders.rb

@@ -0,0 +1,24 @@
+module BaseApi
+  class Client
+    module Orders
+      # Get orders
+      #
+      # @option params [Hash] option
+      #   ex) { limit: 20, offset: 50 }
+      # @return [HTTParty::Response]
+      # @see https://docs.thebase.in/docs/api/orders/
+      def orders(option = {}, &block)
+        paginate('/1/orders', option, &block)
+      end
+
+      # Get a single order
+      #
+      # @param [String] unique_key
+      # @return [HTTParty::Response]
+      # @see https://docs.thebase.in/docs/api/orders/detail
+      def orders_detail(unique_key, &block)
+        call_get_api("/1/orders/detail/#{unique_key}", {}, &block)
+      end
+    end
+  end
+end

data/lib/base_api/client/users.rb

@@ -0,0 +1,9 @@
+module BaseApi
+  class Client
+    module Users
+      def users_me(&block)
+        call_get_api('/1/users/me', {}, &block)
+      end
+    end
+  end
+end

data/lib/base_api/configurable.rb

@@ -0,0 +1,39 @@
+module BaseApi
+  module Configurable
+    attr_accessor :client_id, :client_secret, :code, :access_token, :refresh_token,
+                  :limit, :offset, :redirect_uri
+
+    class << self
+      def keys
+        @keys ||= [
+          :client_id,
+          :client_secret,
+          :code,
+          :access_token,
+          :refresh_token,
+          :limit,
+          :offset,
+          :redirect_uri
+        ]
+      end
+    end
+
+    def configure
+      yield self
+    end
+
+    # Reset configuration options to default values
+    def reset!
+      BaseApi::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", BaseApi::Default.options[key])
+      end
+      self
+    end
+
+    private
+
+    def options
+      Hash[BaseApi::Configurable.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
+    end
+  end
+end

data/lib/base_api/default.rb

@@ -0,0 +1,45 @@
+require 'base_api/configurable'
+
+module BaseApi
+  class Default
+    class << self
+      # Configuration options
+      # @return [Hash]
+      def options
+        Hash[BaseApi::Configurable.keys.map{|key| [key, send(key)]}]
+      end
+
+      def client_id
+        ENV['BASE_API_CLIENT_ID']
+      end
+
+      def client_secret
+        ENV['BASE_API_CLIENT_SECRET']
+      end
+
+      def code
+        ENV['BASE_API_CODE']
+      end
+
+      def access_token
+        ENV['BASE_API_ACCESS_TOKEN']
+      end
+
+      def refresh_token
+        ENV['BASE_API_REFRESH_TOKEN']
+      end
+
+      def limit
+        ENV.fetch("BASE_API_LIMIT") { 20 }
+      end
+
+      def offset
+        ENV.fetch("BASE_API_OFFSET") { 0 }
+      end
+
+      def redirect_uri
+        ENV['BASE_API_REDIRECT_URI']
+      end
+    end
+  end
+end

data/lib/base_api/error.rb

@@ -0,0 +1,34 @@
+module BaseApi
+  class Error < StandardError
+    def initialize(response)
+      @response = response
+      super(build_error_message)
+    end
+
+    def response_status
+      @response.code
+    end
+
+    def response_headers
+      @response.headers
+    end
+
+    def response_body
+      @response.parsed_response
+    end
+
+    private
+
+    def build_error_message
+      message = "#{response_status}: "
+      message << "#{@response['error']} " if @response['error']
+      message << "#{@response['error_description']}" if @response['error_description']
+      message << " uri: #{@response.request.uri}"
+      message
+    end
+  end
+
+  class ClientError < Error; end
+
+  class ServerError < Error; end
+end

data/lib/base_api/version.rb

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

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: base_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yamashun
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.3
+description: BASE is a Japanese service that allows you to easily open an online shop.
+  Please check the official page(https://thebase.in/) for details
+email:
+- yshunske@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- README_JP.md
+- Rakefile
+- base_api.gemspec
+- bin/console
+- bin/setup
+- lib/base_api.rb
+- lib/base_api/client.rb
+- lib/base_api/client/authorizations.rb
+- lib/base_api/client/categories.rb
+- lib/base_api/client/item_categories.rb
+- lib/base_api/client/items.rb
+- lib/base_api/client/orders.rb
+- lib/base_api/client/users.rb
+- lib/base_api/configurable.rb
+- lib/base_api/default.rb
+- lib/base_api/error.rb
+- lib/base_api/version.rb
+homepage: https://github.com/yamashun/base_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yamashun/base_api
+  source_code_uri: https://github.com/yamashun/base_api
+  changelog_uri: https://github.com/yamashun/base_api
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A Ruby interface to the BASE API. (This library is unofficial.)
+test_files: []