rms_item_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7bc421856e9768665f44c9684746309ab7b516bf
+  data.tar.gz: 16bc5288b7d512741cc0020ab7114f2e37fd1f43
+SHA512:
+  metadata.gz: bcb16ad734fc0041f595d2eb1972f7f4cd4c5bb77536786c667f864ab9e85736f0eef3e59fb31dc35ade1f3db54b3375de203dea854827bc99360c8645787f48
+  data.tar.gz: 1428d304e05437a8e95afb35fcf4ffa74666afe57f56ed15238131f84ce0651ad3a73f3fdb1c721cdea4d4ac4a0538a43ee822a6eae6027286ae12727c0ba1f2

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rms_item_api.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tatsuro Moriyama
+
+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,84 @@
+# RmsItemApi
+
+楽天市場に出店している店舗が使えるRMSの商品APIを叩くためのrubyラッパーです。シンプルなCRUD(作成、取得、更新、削除)のみを実装してあります。検索と複数更新は必要があれば追加したいと思います。
+
+## Installation
+
+```
+gem install rms_item_api
+```
+## Usage
+
+取得や更新する項目に関しては楽天RMS WEB APIのドキュメント(要ログイン)にて。
+https://webservice.rms.rakuten.co.jp/merchant-portal/view?page=document0002
+
+### Initialize
+
+RMS内の「[拡張サービス一覧＞WEB APIサービス＞利用設定](https://webservice.rms.rakuten.co.jp/merchant-portal/configurationApi)」にあるserviceSecretとlicenseKeyが必要です(事前にWEB APIの利用申し込みが必要)。
+
+```ruby
+client = RmsItemApi::RmsItemApi.new(
+  serviceSecret: "your_serviceSecret",
+  licenseKey: "your_licenseKey"
+  )
+```
+
+### Get
+
+この機能を利用すると、RMSに登録している商品情報を商品管理番号を指定して取得することができます。
+
+```ruby
+item = client.get('test123')
+
+# 商品名を取得
+item.item_name
+# 表示価格を取得
+item.item_price
+```
+
+### Insert
+
+この機能を利用すると、RMSに商品情報を登録することができます。
+
+```ruby
+item = client.insert({
+  item_url: 'test123',
+  item_name: 'api_insert_test_item',
+  item_price: '298000',
+  genreId: 564040,
+  images: {
+    image: {
+      image_url: 'http://image.rakuten.co.jp/your_shop_id/cabinet/test.jpg'
+    }
+  },
+  item_layout: 2,
+  is_included_postage: true
+  })
+```
+
+### Update
+
+この機能を利用すると、RMSに登録されている商品情報を更新することができます。
+
+```ruby
+item = client.update({
+  item_url: 'test123',
+  item_name: 'api_update_test_item',
+  item_price: '198000',
+  categories: {
+    categoryInfo: {
+      categoryId: '0000000123'
+    }
+  }
+  })
+```
+
+### Delete
+
+この機能を利用すると、RMSに登録されている商品情報を削除することができます。
+
+```ruby
+item = client.update({
+  item_url: 'test123',
+  })
+```

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 "rms_item_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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/field_name.yml

@@ -0,0 +1,63 @@
+501: '商品管理番号'
+502: '商品名'
+503: '販売価格'
+504: '全商品ディレクトリID'
+505: '商品情報レイアウト'
+506: '消費税'
+507: '送料'
+508: '代引き手数料'
+509: '在庫タイプ'
+510: '注文受付数'
+511: '倉庫指定'
+512: '注文ボタン'
+513: '資料請求ボタン'
+514: '商品問い合わせボタン'
+515: 'モバイル表示'
+516: 'のし対応'
+517: 'ポイント変倍率'
+518: 'ポイント変倍適応期間(開始)'
+518: 'ポイント変倍適応期間(終了)'
+519: '商品画像名（ALT）'
+520: '商品番号'
+521: 'PC用商品説明文'
+522: 'モバイル用商品説明文'
+523: '表示価格'
+524: '商品画像URL'
+525: '動画URL'
+526: 'PC用キャッチコピー'
+527: 'モバイル用キャッチコピー'
+528: 'PC用販売説明文'
+529: '個別送料'
+530: '送料区分１'
+531: '送料区分２'
+532: '期間限定販売フラグ'
+532: '期間限定販売開始日'
+532: '期間限定販売終了日'
+534: '在庫数表示'
+535: '項目選択肢別在庫用縦軸選択肢項目名'
+536: '項目選択肢別在庫用横軸選択肢項目名'
+537: '項目選択肢別在庫用残り表示閾値'
+540: 'カタログID'
+542: '在庫切れ時の注文受付'
+543: '在庫あり時納期管理番号'
+544: '在庫切れ時納期管理番号'
+552: 'タグID'
+553: 'レビュー表示'
+554: 'あす楽配送管理番号'
+556: 'サイズ表リンクコード'
+564: '再入荷のお知らせボタン'
+565: 'サーチ非表示'
+566: '医薬品説明文'
+567: '医薬品注意事項'
+568: '二重価格文言ID'
+570: 'スマートフォン用商品説明文'
+702: '選択肢スタイル'
+703: 'Select/Checkbox用項目名'
+704: 'Select/Checkbox用選択肢'
+705: '項目選択肢別在庫用横軸選択肢'
+706: '項目選択肢別在庫用横軸選択肢子番号'
+707: '項目選択肢別在庫用縦軸選択肢'
+708: '項目選択肢別在庫用縦軸選択肢子番号'
+709: '項目選択肢別在庫用取り寄せ可能表示'
+710: '在庫数'
+711: '在庫戻し設定'

data/lib/rms_item_api/version.rb

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

data/lib/rms_item_api.rb

@@ -0,0 +1,119 @@
+require "rms_item_api/version"
+
+require 'yaml'
+require 'faraday'
+require 'active_support'
+require 'active_support/core_ext'
+require 'active_model'
+require 'oga'
+require 'hashie'
+
+module RmsItemApi
+  class RmsItemApi
+    ENDPOINT = 'https://api.rms.rakuten.co.jp/es/1.0/item/'.freeze
+
+    def initialize(serviceSecret:, licenseKey:)
+      @serviceSecret = serviceSecret
+      @licenseKey = licenseKey
+    end
+
+    def get(item_data)
+      result = connection('get').get {|r| r.params['itemUrl'] = item_data}
+      parse_response(result.body, "Get")
+    end
+
+    def update(item_data)
+      request_xml = {itemUpdateRequest: {item: item_data}}.to_xml(
+        root: 'request', camelize: :lower, skip_types: true)
+      result = connection('update').post {|r| r.body = request_xml}
+      parse_response(result.body, "Update")
+    end
+
+    def insert(item_data)
+      request_xml = {itemInsertRequest: {item: item_data}}.to_xml(
+        root: 'request', camelize: :lower, skip_types: true)
+      result = connection('insert').post {|r| r.body = request_xml}
+      parse_response(result.body, "Insert")
+    end
+
+    def delete(item_data)
+      request_xml = {itemDeleteRequest: {item: item_data}}.to_xml(
+        root: 'request', camelize: :lower, skip_types: true)
+      result = connection('delete').post {|r| r.body = request_xml}
+      parse_response(result.body, "Delete")
+    end
+
+    private
+
+      def connection(method)
+        Faraday.new(url: ENDPOINT + method) do |conn|
+          conn.adapter(Faraday.default_adapter)
+          conn.headers['Authorization'] = encoded_key
+        end
+      end
+
+      def encoded_key
+        if @serviceSecret.blank? && @licenseKey.blank?
+          error_msg = "serviceSecret and licenseKey are required"
+          raise StandardError, error_msg
+        else
+          "ESA " + Base64.strict_encode64(@serviceSecret + ":" + @licenseKey)
+        end
+      end
+
+      def parse_response(result, method)
+        parsed_xml = Oga.parse_xml(result)
+        result_code = parsed_xml.xpath("result/item#{method}Result/code").text
+        case method
+        when 'Get'
+          puts "#{method} succeeded"
+          if result_code == 'N000'
+            xpoint = 'result/itemGetResult/item'
+            parsed_xml.xpath(xpoint).each do |xml|
+              xml.children.each_with_index do |x, index|
+                not_have_children = true
+
+                x.children.each do |y|
+                  y.children.each do |z|
+                    not_have_children = false
+                    begin
+                      self.define_singleton_method(z.name.underscore) {
+                        z.text.force_encoding('utf-8')
+                      }
+                    rescue => e
+                      puts e
+                    end
+                  end
+                end
+
+                if not_have_children
+                  self.define_singleton_method(x.name.underscore) {
+                    x.text.force_encoding('utf-8')
+                  }
+                end
+
+              end
+            end
+            return self
+          else
+            puts "指定された商品管理番号は存在しません"
+          end
+        when 'Update', 'Insert', 'Delete'
+          if result_code == 'N000'
+            puts "#{method} succeeded"
+          else
+            config_file = "#{File.dirname(__FILE__)}/../config/field_name.yml"
+            field_name = Hashie::Mash.new(YAML.load_file(config_file))
+            xpoint = "result/item#{method}Result/errormessages"
+            parsed_xml.xpath(xpoint).each do |xml|
+              xml.children.each do |x|
+                error_field = x.xpath('fieldId').text
+                error_description = x.xpath('msg').text.force_encoding('utf-8')
+                puts error_msg = "#{field_name[error_field]}:#{error_description}"
+              end
+            end
+          end
+        end # case method
+      end # def parse_response
+  end # class rms_item_api
+end # module rms_item_api

data/rms_item_api.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$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.version       = RmsItemApi::VERSION
+  spec.authors       = ["t4traw"]
+  spec.email         = ["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.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "activemodel"
+  spec.add_dependency "oga"
+  spec.add_dependency "hashie"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: rms_item_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- t4traw
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oga
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: RMSの商品APIを簡単に叩けるrubyラッパー
+email:
+- t4traw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/field_name.yml
+- lib/rms_item_api.rb
+- lib/rms_item_api/version.rb
+- rms_item_api.gemspec
+homepage: https://github.com/t4traw/rms_item_api
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: RMSの商品APIを簡単に叩けるrubyラッパー
+test_files: []