mfkessai-ruby 1.0.0.beta3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cca1470e116b5a65390bc383b73fdad97589ba83333d0a9556826ac46117dfae
-  data.tar.gz: 03efa8136a3b0da021311f6a2a64ca72b253dca72f30b83d7e38b8e41c6b9973
+  metadata.gz: 5b8db5d505788d354f084d8e0fc1f28dce41ba9724f404e99798287cdc80116f
+  data.tar.gz: 83cd99a0a4573c5b9657a2d8fa9b05daa0ab55d5e77a9cb0a760ccf2b5e72b7d
 SHA512:
-  metadata.gz: ebcf881cad0c978bfc871ecc2d0b90d2550c3afd59fac10394fe295285551548596cc8da232b2db363fd549cfcbd4b1d5ccd729f045303ac9f970ea73e4e264f
-  data.tar.gz: ac6e42be69c8bb5455851c5a189967768739122620ae660b4e9e86b6178f7b76d560df9e1ec45e5b7d19ac29b2844d2265b97cf9d7eef7dee643ec0216c84db4
+  metadata.gz: 7077a9f411e3a554c4dee787dfe516336ec356202543700d474ad40024c3479b78fc21c3e7d2db556cfce63875e3d0ec12d022c9bccc8cd4a4a68593acf4489d
+  data.tar.gz: f7a8e9cd18d12caacf78c0ee5e2767076b1f5ed21381c9b3c17d2b6b9ddf0ac710d9795d3b0fb0a65a517c870eab5f333c9f50c9ef2c5bf934f8d12cf24a9fe7

data/.gitlab-ci.yml

@@ -0,0 +1,65 @@
+stages:
+  - test
+
+ruby2.3:rspec:
+  image: ruby:2.3-alpine
+
+  script:
+    - setup
+    - execute_rspec
+
+ruby2.4:rspec:
+  image: ruby:2.4-alpine
+
+  script:
+    - setup
+    - execute_rspec
+
+ruby2.5:rspec:
+  image: ruby:2.5-alpine
+
+  script:
+    - setup
+    - execute_rspec
+
+ruby2.5.1:rspec:
+  image: ruby:2.5.1-alpine
+
+  script:
+    - setup
+    - execute_rspec
+
+  allow_failure: true
+
+dependency_scanning:
+  image: docker:stable
+  variables:
+    DOCKER_DRIVER: overlay2
+  allow_failure: true
+  services:
+    - docker:stable-dind
+  script:
+    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - docker run
+        --env DEP_SCAN_DISABLE_REMOTE_CHECKS="${DEP_SCAN_DISABLE_REMOTE_CHECKS:-false}"
+        --volume "$PWD:/code"
+        --volume /var/run/docker.sock:/var/run/docker.sock
+        "registry.gitlab.com/gitlab-org/security-products/dependency-scanning:$SP_VERSION" /code
+  artifacts:
+    paths: [gl-dependency-scanning-report.json]
+
+.auto_devops: &auto_devops |
+  function execute_rspec() {
+    bundle exec rspec
+  }
+
+  function setup() {
+    apk --update --upgrade add $BUILD_PACKAGES
+    apk add git
+    gem install bundler --no-ri --no-rdoc
+    bundle check --path=${BUNDLE_CACHE} || bundle install --path=${BUNDLE_CACHE} --jobs=2 --retry=3
+    bundle clean
+  }
+
+before_script:
+  - *auto_devops

data/CHANGELOG.md

@@ -1 +1,5 @@
 # Changelog
+
+## 1.0 - 2018-06-18
+* 1 major enhancement:
+  * Initial release

data/Gemfile

@@ -1,6 +1,4 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
 # Specify your gem's dependencies in mfkessai-ruby.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mfkessai-ruby (1.0.0.beta3)
+    mfkessai-ruby (1.0.0)
       faraday (~> 0.10)
 
 GEM
@@ -36,4 +36,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.1
+   1.16.2

data/README.md

@@ -1,24 +1,22 @@
-### **！こちらのgemはまだbeta版です**
-
-# Mfkessai for Ruby
+# Mfkessai Ruby Library
 mfkessaiのapiを使用するための便利なアクセスをRubyで提供します
 
 こちらのgemは非公式なライブラリです
 
-対応API
+### 対応API
 
-- customer
-- destination
-- examination
-- ping
-- transaction
+- [customer](#customer)
+- [destination](#destination)
+- [examination](#examination)
+- [ping](#ping)
+- [transaction](#transaction)
 
 [詳しいAPIを参照する](https://mfkessai.co.jp/api_doc/endpoint.html)
 
 ## Installation
 
 ```
-$ gem install mfkessai -v 1.0.0.beta3 --pre
+$ gem install mfkessai-ruby
 ```
 
 ## Usage
@@ -52,6 +50,9 @@ Mfkessai.api_key = "mfkessai_test_..."
 
 # 顧客リストを取得
 Mfkessai::Customer.list
+
+# ページ番号、1ページあたりの件数を指定する
+Mfkessai::Customer.list(page: 3, per_page: 30)
 ```
 
 - Mfkessai::Customer.retrieve
@@ -99,7 +100,7 @@ Mfkessai::Destination.create(request_body: params)
 ```
 
 ## examination
-- Mfkessai::Destination.list
+- Mfkessai::Examination.list
 
 ```
 require "mfkessai"
@@ -107,10 +108,13 @@ Mfkessai.api_url = "https://sandbox"
 Mfkessai.api_key = "mfkessai_test_..."
 
 # 審査リストを取得
-Mfkessai::Destination.list
+Mfkessai::Examination.list
+
+# ページ番号、1ページあたりの件数を指定する
+Mfkessai::Examination.list(page: 3, per_page: 30)
 ```
 
-- Mfkessai::Destination.create
+- Mfkessai::Examination.create
 
 ```
 require "mfkessai"
@@ -138,10 +142,10 @@ params = {
   ]
 }
 
-Mfkessai::Destination.create(request_body: params)
+Mfkessai::Examination.create(request_body: params)
 ```
 
-- Mfkessai::Destination.retrieve
+- Mfkessai::Examination.retrieve
 
 ```
 require "mfkessai"
@@ -149,10 +153,10 @@ Mfkessai.api_url = "https://sandbox"
 Mfkessai.api_key = "mfkessai_test_..."
 
 # IDを指定して審査情報を取得
-Mfkessai::Destination.retrieve('destination_test_123')
+Mfkessai::Examination.retrieve('destination_test_123')
 ```
 
-- Mfkessai::Destination.create_transaction
+- Mfkessai::Examination.create_transaction
 
 ```
 require "mfkessai"
@@ -169,7 +173,7 @@ params = {
   "user_defined_id": "transaction00000001"
 }
 
-Mfkessai::Destination.create_transaction(id: 'test_123', request_body: params)
+Mfkessai::Examination.create_transaction(id: 'test_123', request_body: params)
 ```
 
 ## ping
@@ -197,6 +201,9 @@ Mfkessai.api_key = "mfkessai_test_..."
 # 取引リストを取得
 
 Mfkessai::Transaction.list
+
+# ページ番号、1ページあたりの件数を指定する
+Mfkessai::Transaction.list(page: 3, per_page: 30)
 ```
 
 - Mfkessai::Transaction.create
@@ -278,6 +285,47 @@ Mfkessai.api_key = "mfkessai_test_..."
 Mfkessai::Transaction.cancel("transation_test_123")
 ```
 
+## Handling errors
+
+```
+begin
+  # Use Mfkessai's library to make requests...
+rescue Mfkessai::BadRequestError => e
+  puts "Status is: #{e.http_status}"
+  puts "Message is: #{e.message}"
+  puts "http_body is: #{e.http_body}"
+  puts "json_body is: #{e.json_body}"
+rescue Mfkessai::AuthenticationError => e
+  puts "Status is: #{e.http_status}"
+  puts "Message is: #{e.message}"
+  puts "http_body is: #{e.http_body}"
+  puts "json_body is: #{e.json_body}"
+rescue Mfkessai::ForbiddenError => e
+  puts "Status is: #{e.http_status}"
+  puts "Message is: #{e.message}"
+  puts "http_body is: #{e.http_body}"
+  puts "json_body is: #{e.json_body}"
+rescue Mfkessai::NotFoundError => e
+  puts "Status is: #{e.http_status}"
+  puts "Message is: #{e.message}"
+  puts "http_body is: #{e.http_body}"
+  puts "json_body is: #{e.json_body}"
+rescue Mfkessai::APIConnectionError => e
+  puts "Status is: #{e.http_status}"
+  puts "Message is: #{e.message}"
+  puts "http_body is: #{e.http_body}"
+  puts "json_body is: #{e.json_body}"
+rescue Mfkessai::ServerError => e
+  puts "Status is: #{e.http_status}"
+  puts "Message is: #{e.message}"
+  puts "http_body is: #{e.http_body}"
+  puts "json_body is: #{e.json_body}"
+rescue => e
+   # Something else happened, completely unrelated to Mfkessai
+end
+
+```
+
 ## Development
 
 Run all tests:

data/lib/mfkessai/client.rb

@@ -56,6 +56,13 @@ module Mfkessai
       resp
     end
 
+    def list_filter_parameters(page, per_page)
+      params = {}
+      params[:page] = page if page
+      params[:per_page] = per_page if per_page
+      '?' + URI.encode_www_form(params)
+    end
+
     def request_headers
       headers = {
         "User-Agent" => "Mfkessai/v1 RubyBindings/#{Mfkessai::VERSION}",
@@ -124,32 +131,38 @@ module Mfkessai
       case error_response[:status]
       when 400
         data = JSON.parse(error_response[:body], symbolize_names: true)
-        raise BadRequestError.new(http_status: error_response[:status],
+        raise BadRequestError.new(message: data[:detail],
+                                  http_status: error_response[:status],
                                   http_body: error_response[:body],
                                   json_body: data)
       when 401
         data = JSON.parse(error_response[:body], symbolize_names: true)
-        raise AuthenticationError.new(http_status: error_response[:status],
+        raise AuthenticationError.new(message: data[:detail],
+                                      http_status: error_response[:status],
                                       http_body: error_response[:body],
                                       json_body: data)
       when 403
         data = JSON.parse(error_response[:body], symbolize_names: true)
-        raise ForbiddenError.new(http_status: error_response[:status],
+        raise ForbiddenError.new(message: data[:detail],
+                                 http_status: error_response[:status],
                                  http_body: error_response[:body],
                                  json_body: data)
       when 404
         data = JSON.parse(error_response[:body], symbolize_names: true)
-        raise NotFoundError.new(http_status: error_response[:status],
+        raise NotFoundError.new(message: data[:detail],
+                                http_status: error_response[:status],
                                 http_body: error_response[:body],
                                 json_body: data)
       when 500
         data = JSON.parse(error_response[:body], symbolize_names: true)
-        raise ServerError.new(http_status: error_response[:status],
+        raise ServerError.new(message: data[:detail],
+                              http_status: error_response[:status],
                               http_body: error_response[:body],
                               json_body: data)
       when 503
         data = JSON.parse(error_response[:body], symbolize_names: true)
-        raise ServerError.new(http_status: error_response[:status],
+        raise ServerError.new(message: data[:detail],
+                              http_status: error_response[:status],
                               http_body: error_response[:body],
                               json_body: data)
       else

data/lib/mfkessai/customer.rb

@@ -4,15 +4,15 @@ module Mfkessai
     extend Mfkessai::Client
 
     # ref: https://mfkessai.co.jp/api_doc/endpoint.html#/customer/customer_index
-    def self.list
-      request(url: '/v1/customers',
-              request_type: :get)
+    def self.list(page: nil, per_page: nil)
+      url = '/v1/customers'
+      url += list_filter_parameters(page, per_page) if !page.nil? || !per_page.nil?
+      request(url: url, request_type: :get)
     end
 
     # ref: https://mfkessai.co.jp/api_doc/endpoint.html#/customer/customer_show
     def self.retrieve(id)
-      request(url: "/v1/customers/#{id}",
-              request_type: :get)
+      request(url: "/v1/customers/#{id}", request_type: :get)
     end
   end
 end

data/lib/mfkessai/errors.rb

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 module Mfkessai
   class MfkessaiError < StandardError
-    attr_reader :message
-    attr_reader :http_status
-    attr_reader :http_body
-    attr_reader :json_body
+    attr_reader :message, :http_status, :http_body, :json_body
 
     def initialize(message: nil, http_status: nil, http_body: nil, json_body: nil)
       @message = message

data/lib/mfkessai/examination.rb

@@ -4,9 +4,10 @@ module Mfkessai
     extend Mfkessai::Client
 
     # ref: https://mfkessai.co.jp/api_doc/endpoint.html#/examination/examination_index
-    def self.list
-      request(url: '/v1/examinations',
-              request_type: :get)
+    def self.list(page: nil, per_page: nil)
+      url = '/v1/examinations'
+      url += list_filter_parameters(page, per_page) if !page.nil? || !per_page.nil?
+      request(url: url, request_type: :get)
     end
 
     # ref: https://mfkessai.co.jp/api_doc/endpoint.html#/examination/examination_create
@@ -18,8 +19,7 @@ module Mfkessai
 
     # ref: https://mfkessai.co.jp/api_doc/endpoint.html#/examination/examination_show
     def self.retrieve(id)
-      request(url: "/v1/examinations/#{id}",
-              request_type: :get)
+      request(url: "/v1/examinations/#{id}", request_type: :get)
     end
 
     # ref: https://mfkessai.co.jp/api_doc/endpoint.html#/examination/examination_create_transaction

data/lib/mfkessai/transaction.rb

@@ -4,9 +4,10 @@ module Mfkessai
     extend Mfkessai::Client
 
     # ref: https://mfkessai.co.jp/api_doc/endpoint.html#/transaction/transaction_index
-    def self.list
-      request(url: '/v1/transactions',
-              request_type: :get)
+    def self.list(page: nil, per_page: nil)
+      url = '/v1/transactions'
+      url += list_filter_parameters(page, per_page) if !page.nil? || !per_page.nil?
+      request(url: url, request_type: :get)
     end
 
     # ref: https://mfkessai.co.jp/api_doc/endpoint.html#/transaction/transaction_create
@@ -18,14 +19,12 @@ module Mfkessai
 
     # ref: https://mfkessai.co.jp/api_doc/endpoint.html#/transaction/transaction_show
     def self.retrieve(id)
-      request(url: "/v1/transactions/#{id}",
-              request_type: :get)
+      request(url: "/v1/transactions/#{id}", request_type: :get)
     end
 
     # ref: https://mfkessai.co.jp/api_doc/endpoint.html#/transaction/transaction_cancel
     def self.cancel(id)
-      request(url: "/v1/transactions/#{id}/cancel",
-              request_type: :post)
+      request(url: "/v1/transactions/#{id}/cancel", request_type: :post)
     end
   end
 end

data/lib/mfkessai/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Mfkessai
-  VERSION = "1.0.0.beta3"
+  VERSION = "1.0.0"
 end

data/mfkessai-ruby.gemspec

@@ -6,7 +6,7 @@ require "mfkessai/version"
 Gem::Specification.new do |spec|
   spec.name          = "mfkessai-ruby"
   spec.version       = Mfkessai::VERSION
-  spec.authors       = ["torufukui", "sora.inc"]
+  spec.authors       = ["torufukui"]
   spec.email         = ["fukui.development@gmail.com"]
 
   spec.summary = 'Ruby bindings for the Mfkessai API'

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mfkessai-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta3
+  version: 1.0.0
 platform: ruby
 authors:
 - torufukui
-- sora.inc
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-06 00:00:00.000000000 Z
+date: 2018-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -75,8 +74,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -110,9 +109,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.16.1