rms_item_api 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: db548f1cb04895fc295e0cc7c5fdca585a1aae9a
-  data.tar.gz: 7b76321f7b39685a08abc2a68aa14157e453e328
+SHA256:
+  metadata.gz: f202d4d6dbf0a616c2e432073c8570b9ab70bfaf69a1e3807eccca3fe6f310e9
+  data.tar.gz: 9c15ba5c1a4fa8d65ada2daffed8f2e315f310635982ba6e1df23ff271a46446
 SHA512:
-  metadata.gz: 5a17abb8227c3ce50b2877902a01cb7fca16747804681757809a72dce8340fa970459cad06ebddcf16e4065c6a56728ff8df51ddc574e9e5bf1a73b0b9589769
-  data.tar.gz: bc3c07b5896806ce3381a090717cf3a22b2812639aa7925401d133fa5b62917ae866180e22101407fa6c28b5aade7aef83aad40f9ef3cad77f17c54116581ff0
+  metadata.gz: 29bbbdc7f419eec0ad700c525b0cd0152f4e9ddaacacef03f06d7ee6a387e3ad746e60eb30b59e7765ee10d8a4555ac6868545a12da2920df5913a06bbc6e9ef
+  data.tar.gz: d8da979ed29348ae4b530248c6cc06a75e49c68a6dcce6106fb6c36be9a00c93f4ca870c3f895e833404e4b927fae3f69722c71ea075a54f409ea9fa1fc80a25

data/.rubocop.yml

@@ -0,0 +1,33 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  Exclude:
+    - "test/**/*"
+
+Metrics/LineLength:
+  Max: 120
+
+# 3.0で文字列がデフォルトでfrozenになるか不明
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# コメントの日本語を許可
+Style/AsciiComments:
+  Enabled: false
+
+# 明示的に else で nil を返すのはわかりやすいので許可
+Style/EmptyElse:
+  EnforcedStyle: empty
+
+Style/Documentation:
+  Enabled: false
+
+Style/PredicateName:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/VariableName:
+  Enabled: false

data/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/t4traw/rms_item_api.svg?branch=master)](https://travis-ci.org/t4traw/rms_item_api)
 [![Code Climate](https://codeclimate.com/github/t4traw/rms_item_api/badges/gpa.svg)](https://codeclimate.com/github/t4traw/rms_item_api)
 
-楽天市場に出店している店舗が使えるRMSの商品APIを叩くためのrubyラッパーです。シンプルなCRUD(作成、取得、更新、削除)のみを実装してあります。検索と複数更新は必要があれば追加したいと思います。
+楽天市場に出店している店舗が使える RMS の商品 API を叩くための ruby ラッパーです。シンプルな CRUD(作成、取得、更新、削除)のみを実装してあります。検索と複数更新は必要があれば追加したいと思います。
 
 ## Installation
 
@@ -12,13 +12,14 @@ Add this line to your application's Gemfile:
 ```ruby
 gem 'rms_item_api'
 ```
+
 ## Usage
 
-取得や更新する項目に関しては楽天RMS WEB APIのドキュメント「拡張サービス一覧＞WEB APIサービス＞RMS WEB SERVICE : ItemAPI」(要ログイン)にて。
+取得や更新する項目に関しては楽天 RMS WEB API のドキュメント「拡張サービス一覧＞ WEB API サービス＞ RMS WEB SERVICE : ItemAPI」(要ログイン)にて。
 
 ### Initialize
 
-RMS内の「拡張サービス一覧＞WEB APIサービス＞利用設定」にあるserviceSecretとlicenseKeyが必要です(事前にWEB APIの利用申し込みが必要です)。
+RMS 内の「拡張サービス一覧＞ WEB API サービス＞利用設定」にある serviceSecret と licenseKey が必要です(事前に WEB API の利用申し込みが必要です)。
 
 ```ruby
 client = RmsItemApi::Client.new(
@@ -29,7 +30,7 @@ client = RmsItemApi::Client.new(
 
 ### Get
 
-RMSに登録している商品情報を商品管理番号を指定して取得することができます。
+RMS に登録している商品情報を商品管理番号を指定して取得することができます。
 
 ```ruby
 item = client.get('test123')
@@ -47,7 +48,7 @@ item.all
 
 ### Insert
 
-RMSに商品情報を登録することができます。
+RMS に商品情報を登録することができます。
 
 ```ruby
 item = client.insert({
@@ -70,7 +71,7 @@ item.is_success?
 
 ### Update
 
-RMSに登録されている商品情報を更新することができます。
+RMS に登録されている商品情報を更新することができます。
 
 ```ruby
 item = client.update({
@@ -87,7 +88,7 @@ item = client.update({
 
 ### Delete
 
-RMSに登録されている商品情報を削除することができます。
+RMS に登録されている商品情報を削除することができます。
 
 ```ruby
 item = client.delete({

data/Rakefile

@@ -1,10 +1,10 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
+  t.libs << 'test'
+  t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/lib/rms_item_api.rb

@@ -1,4 +1,4 @@
-require "rms_item_api/version"
+require 'rms_item_api/version'
 require 'rms_item_api/helper.rb'
 require 'rms_item_api/item.rb'
 
@@ -18,7 +18,6 @@ module RmsItemApi
       @serviceSecret = serviceSecret
       @licenseKey = licenseKey
     end
-
   end
 end
 

data/lib/rms_item_api/helper.rb

@@ -1,6 +1,5 @@
 module RmsItemApi
   module Helper
-
     ENDPOINT = 'https://api.rms.rakuten.co.jp/es/1.0/item/'.freeze
     def connection(method)
       Faraday.new(url: ENDPOINT + method) do |conn|
@@ -15,20 +14,10 @@ module RmsItemApi
 
     def handler(response)
       rexml = REXML::Document.new(response.body)
-      self.define_singleton_method(:all) { convert_xml_into_json(response.body) }
-
-      if rexml.elements["result/status/systemStatus"].text == "NG"
-        raise rexml.elements["result/status/message"].text
-      end
-
-      status_parser(rexml)
-      case response.env.method
-      when :get
-        get_response_parser(rexml)
-      # when :post
-      #   post_response_parser(rexml)
-      end
-
+      define_singleton_method(:all) { convert_xml_into_json(response.body) }
+      check_system_status(rexml)
+      status_parser(response_code: get_response_code(rexml), error_messages: get_error_messages(rexml))
+      get_response_parser(rexml) if response.env.method == :get
       self
     end
 
@@ -36,81 +25,79 @@ module RmsItemApi
 
     def encoded_key
       if @serviceSecret.blank? && @licenseKey.blank?
-        error_msg = "serviceSecret and licenseKey are required"
+        error_msg = 'serviceSecret and licenseKey are required'
         raise StandardError, error_msg
       else
-        "ESA " + Base64.strict_encode64(@serviceSecret + ":" + @licenseKey)
+        'ESA ' + Base64.strict_encode64(@serviceSecret + ':' + @licenseKey)
+      end
+    end
+
+    def check_system_status(rexml)
+      systemStatus = rexml.elements['result/status/systemStatus'].text
+      raise rexml.elements['result/status/message'].text if systemStatus == 'NG'
+    end
+
+    def get_response_code(rexml)
+      endpoint = get_endpoint(rexml)[:camel]
+      rexml.elements["result/#{endpoint}Result/code"].text
+    end
+
+    def get_error_messages(rexml)
+      endpoint = get_endpoint(rexml)[:camel]
+      err_point = "result/#{endpoint}Result/errorMessages/errorMessage/msg"
+      result = []
+      rexml.elements.each(err_point) do |element|
+        result << element.text
       end
+      result
     end
 
     def get_endpoint(rexml)
       result = {}
-      interfaceId = rexml.elements["result/status/interfaceId"].text
+      interfaceId = rexml.elements['result/status/interfaceId'].text
       result[:api] = interfaceId.split('.')[0]
       result[:method] = interfaceId.split('.')[1]
       result[:camel] = "#{result[:api]}#{result[:method].capitalize}"
       result
     end
 
-    def status_parser(rexml)
-      endpoint = get_endpoint(rexml)
-      xpoint = "result/#{endpoint[:camel]}Result/code"
-      response_code = rexml.elements[xpoint].text
-
-      yml = "#{File.dirname(__FILE__)}/../../config/response_codes.yml"
-      response_codes = YAML.load_file(yml)
-
-      self.define_singleton_method(:is_success?) { response_code == 'N000' ? true : false }
-      self.define_singleton_method(:message) { response_codes[response_code] }
-
-      err_point = "result/#{endpoint[:camel]}Result/errorMessages/errorMessage/msg"
-      err_msg = []
-      rexml.elements.each(err_point) do |element|
-        err_msg << element.text
-      end
-      self.define_singleton_method(:errors) { err_msg }
-
-      self.is_success?
+    def status_parser(response_code:, error_messages:)
+      response_codes = YAML.load_file("#{File.dirname(__FILE__)}/../../config/response_codes.yml")
+      define_singleton_method(:is_success?) { response_code == 'N000' }
+      define_singleton_method(:message) { response_codes[response_code] }
+      define_singleton_method(:errors) { error_messages }
     end
 
     def get_response_parser(rexml)
-      endpoint = get_endpoint(rexml)
-      xpoint = "result/#{endpoint[:camel]}Result/item"
+      xpoint = "result/#{get_endpoint(rexml)[:camel]}Result/item"
       rexml.elements.each(xpoint) do |result|
         result.children.each do |el|
           next if el.to_s.strip.blank?
-          if el.has_elements?
-            begin
-              self.define_singleton_method(el.name.underscore) {
-                Hash.from_xml(el.to_s)
-              }
-            rescue => e
-              puts e
-            end
-          else
-            begin
-              self.define_singleton_method(el.name.underscore) {
-                el.text.try!(:force_encoding, 'utf-8')
-              }
-            rescue => e
-              puts e
-            end
-          end
+
+          define_element_method(el)
         end
       end
       self
     end
 
-    def post_response_parser(rexml)
-      self
+    def define_element_method(el)
+      define_singleton_method(el.name.underscore) do
+        if el.has_elements?
+          Hash.from_xml(el.to_s)
+        else
+          el.text.try!(:force_encoding, 'utf-8')
+        end
+      end
     end
 
+    def post_response_parser(_rexml)
+      self
+    end
   end
 end
 
 class Hash
   class << self
-
     def from_xml(rexml)
       xml_elem_to_hash rexml.root
     end
@@ -118,19 +105,18 @@ class Hash
     private
 
     def xml_elem_to_hash(el)
-      value = if el.has_elements?
-        children = {}
-        el.each_element do |e|
-          children.merge!(xml_elem_to_hash(e)) do |k,v1,v2|
-            v1.is_a?(Array) ?  v1 << v2 : [v1,v2]
-          end
-        end
-        children
-      else
-        el.text
-      end
+      value = el.has_elements? ? merged_children(el) : el.text
       { el.name.to_sym => value }
     end
 
+    def merged_children(el)
+      result = {}
+      el.each_element do |e|
+        result.merge!(xml_elem_to_hash(e)) do |_k, v1, v2|
+          v1.is_a?(Array) ? v1 << v2 : [v1, v2]
+        end
+      end
+      result
+    end
   end
 end

data/lib/rms_item_api/item/delete.rb

@@ -3,12 +3,11 @@ module RmsItemApi
     include RmsItemApi::Helper
 
     def delete(item_data)
-      request_xml = {itemDeleteRequest: {item: item_data}}.to_xml(
+      request_xml = { itemDeleteRequest: { item: item_data } }.to_xml(
         root: 'request', camelize: :lower, skip_types: true
       )
-      response = connection('delete').post {|r| r.body = request_xml}
+      response = connection('delete').post { |r| r.body = request_xml }
       handler response
     end
-
   end
 end

data/lib/rms_item_api/item/get.rb

@@ -3,9 +3,8 @@ module RmsItemApi
     include RmsItemApi::Helper
 
     def get(item_data)
-      response = connection('get').get {|r| r.params['itemUrl'] = item_data}
+      response = connection('get').get { |r| r.params['itemUrl'] = item_data }
       handler response
     end
-
   end
 end

data/lib/rms_item_api/item/insert.rb

@@ -3,12 +3,11 @@ module RmsItemApi
     include RmsItemApi::Helper
 
     def insert(item_data)
-      request_xml = {itemInsertRequest: {item: item_data}}.to_xml(
+      request_xml = { itemInsertRequest: { item: item_data } }.to_xml(
         root: 'request', camelize: :lower, skip_types: true
       )
-      response = connection('insert').post {|r| r.body = request_xml}
+      response = connection('insert').post { |r| r.body = request_xml }
       handler response
     end
-
   end
 end

data/lib/rms_item_api/item/update.rb

@@ -3,12 +3,11 @@ module RmsItemApi
     include RmsItemApi::Helper
 
     def update(item_data)
-      request_xml = {itemUpdateRequest: {item: item_data}}.to_xml(
+      request_xml = { itemUpdateRequest: { item: item_data } }.to_xml(
         root: 'request', camelize: :lower, skip_types: true
       )
-      response = connection('update').post {|r| r.body = request_xml}
+      response = connection('update').post { |r| r.body = request_xml }
       handler response
     end
-
   end
 end

data/lib/rms_item_api/version.rb

@@ -1,3 +1,3 @@
 module RmsItemApi
-  VERSION = "0.2.3"
+  VERSION = '0.2.5'.freeze
 end

data/rms_item_api.gemspec

@@ -1,34 +1,34 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rms_item_api/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "rms_item_api"
+  spec.name          = 'rms_item_api'
   spec.version       = RmsItemApi::VERSION
-  spec.authors       = ["t4traw"]
-  spec.email         = ["t4traw@gmail.com"]
+  spec.authors       = %w[t4traw]
+  spec.email         = %w[t4traw@gmail.com]
 
-  spec.summary       = %q{RMSの商品APIを簡単に叩けるrubyラッパー}
-  spec.description   = %q{RMSの商品APIを簡単に叩けるrubyラッパー}
-  spec.homepage      = "https://github.com/t4traw/rms_item_api"
+  spec.summary       = 'RMSの商品APIを簡単に叩けるrubyラッパー'
+  spec.description   = 'RMSの商品APIを簡単に叩けるrubyラッパー'
+  spec.homepage      = 'https://github.com/t4traw/rms_item_api'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = %w[lib]
 
-  spec.add_dependency "faraday", '>= 0.12.1'
-  spec.add_dependency "activesupport", '>= 4.2.8'
-  spec.add_dependency "activemodel", '>= 4.2.8'
-  spec.add_dependency "builder"
+  spec.add_dependency 'activemodel', '>= 4.2.8'
+  spec.add_dependency 'activesupport', '>= 4.2.8'
+  spec.add_dependency 'builder'
+  spec.add_dependency 'faraday', '>= 0.12.1'
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "minitest-reporters"
-  spec.add_development_dependency "webmock"
-  spec.add_development_dependency "vcr"
-  spec.add_development_dependency "dotenv"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rms_item_api
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.5
 platform: ruby
 authors:
 - t4traw
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-23 00:00:00.000000000 Z
+date: 2020-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.1
+        version: 4.2.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.1
+        version: 4.2.8
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -39,33 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.2.8
 - !ruby/object:Gem::Dependency
-  name: activemodel
+  name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.8
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.8
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: builder
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -81,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +137,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -165,7 +179,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -187,6 +201,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rbenv-gemsets"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE
@@ -220,8 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: RMSの商品APIを簡単に叩けるrubyラッパー