yahoo_store_api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b74be565c454130d107b1bd5705a7ef39afa9396
+  data.tar.gz: ba27dbbccbe6b8f7487baabd81385a3112a6893b
+SHA512:
+  metadata.gz: 0753da206fbf5b090afa7a748662b5ea13cd6902cb13ef90ef654177099ec48aeb0ad1811f6be8450c3d02cd0f04a7dc220dfa13980da73ae0e3442c8fcc78c6
+  data.tar.gz: 4428a024aa947261f26b852bb0a20e19f3beedc2c8fca285f45fcbbf72968b3144225879df91695820d1b437f47ad10144a0d4110b728ff04e530e2b5fc1297e

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.env
+.rbenv-gemsets
+sample.rb

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.7
+  - 2.3.4
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/README.md

@@ -0,0 +1,123 @@
+# YahooStoreApi
+
+[![Build Status](https://travis-ci.org/t4traw/yahoo_store_api.svg?branch=master)](https://travis-ci.org/t4traw/yahoo_store_api)
+[![Code Climate](https://codeclimate.com/github/t4traw/yahoo_store_api/badges/gpa.svg)](https://codeclimate.com/github/t4traw/yahoo_store_api)
+
+Yahoo!ショッピング プロフェッショナル出店ストア向けAPIを簡単に叩けるrubyラッパーです。
+
+現在開発中です🐛 まだ商品情報のCRUDと在庫情報の取得・更新、反映予約しかできません。順次機能追加をしていきたいと思います。
+
+## できること
+
+* 商品に関連するAPI
+  * 商品参照API(`get_item`)
+  * 商品登録API(`set_item`)
+  * 商品削除API(`delete_item`)
+* 在庫に関連するAPI
+  * 在庫参照API(`get_stock`)
+  * 在庫更新API(`set_stock`)
+* 出品管理に関連するAPI
+  * 全反映予約API(`reserve_publish`)
+
+## Installation
+
+```ruby
+gem 'yahoo_store_api'
+```
+
+## 事前準備
+
+事前にストア出品アカウントと連携した認証コードが必要になります。
+
+まず、Yahooデベロッパーネットワークの[Yahoo!ショッピングのストア運営をサポートするAPIを利用したアプリケーション](https://e.developer.yahoo.co.jp/shopping/register)にアプリケーションを登録します。
+
+登録が終えたら、次に[認可コードを取得](https://developer.yahoo.co.jp/yconnect/server_app/explicit/authorization.html)する必要があります。ページに表示するかリダイレクトした時のパラメーターにある認証コードを取得します。
+
+※シンプルにページ上に認証コードを表示させる例: https://auth.login.yahoo.co.jp/yconnect/v1/authorization?response_type=code+id_token&client_id=[上で登録したアプリケーションID]&state=foobar&redirect_uri=oob&nonce=hogehoge
+
+stateやnonceなどは[Authorizationエンドポイント](https://developer.yahoo.co.jp/yconnect/server_app/explicit/authorization.html)に詳細がありますので、適宜変更してください。
+
+## Initialize
+
+ストアアカウント、上で登録したアプリケーションid、シークレット、取得した認証コードでインスタンスを生成します。
+
+```ruby
+client = RmsItemApi::Client.new(
+  seller_id: YOUR_STORE_ID, # ストアアカウントid
+  application_id: YOUR_APPLICATION_ID, # アプリケーションid
+  application_secret: YOUR_SECRET, # シークレット
+  authorization_code: AUTHORIZATION_CODE # 認証コード
+)
+```
+
+なお、この認証コードは1回のみ使用可能で、次からはリフレッシュトークンを使用するか、再度認証コードを取得する必要があります。リフレッシュトークンは生成したインスタンスから取得する事ができます。
+
+```ruby
+puts client.refresh_token
+```
+
+```ruby
+client = RmsItemApi::Client.new(
+  seller_id: YOUR_STORE_ID, # ストアアカウントid
+  application_id: YOUR_APPLICATION_ID, # アプリケーションid
+  application_secret: YOUR_SECRET, # シークレット
+  refresh_token: YOUR_REFRESH_TOKEN # リフレッシュトークン
+)
+```
+
+## Usage
+
+### 商品情報の参照
+
+ストアに登録されている商品情報を取得できます。
+
+```ruby
+item = client.get_item('test123')
+
+# 商品名を取得
+item.name
+# 通常販売価格を取得
+item.price
+# 取得したすべての情報をhashで出力
+item.all
+```
+
+### 商品情報の登録/更新
+
+商品情報を登録・更新できます。
+
+```ruby
+item = client.edit_item({
+  item_code: 'test1234',
+  name: 'test_item',
+  path: 'test_category',
+  price: 1000,
+})
+
+# 送信結果をhashで出力
+item.all
+```
+
+### 在庫情報の参照
+
+ストアに登録されている商品の在庫情報を取得できます。
+
+```ruby
+stock = client.get_stock('test123')
+
+# 在庫数の取得
+stock.quantity
+# 取得したすべての情報をhashで出力
+stock.all
+```
+
+### 全反映予約
+
+反映予約をします。
+
+```ruby
+pub = client.reserve_publish
+
+# 結果を取得
+stock.status
+```

data/Rakefile

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

data/lib/yahoo_store_api/helper.rb

@@ -0,0 +1,71 @@
+module YahooStoreApi
+  module Helper
+
+    ENDPOINT = "https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/".freeze
+    def connection(method)
+      Faraday.new(url: ENDPOINT + method) do |c|
+        c.adapter Faraday.default_adapter
+        c.headers['Authorization'] = "Bearer " + @access_token
+      end
+    end
+
+    def handler(response)
+      rexml = REXML::Document.new(response.body)
+      if rexml.elements['ResultSet/Result']
+        response_parser(rexml, xpoint: 'ResultSet/Result')
+      elsif rexml.elements['ResultSet/Status']
+        response_parser(rexml, xpoint: 'ResultSet')
+      elsif rexml.elements['Error/Message']
+        error_parser(rexml)
+      else
+        puts rexml
+      end
+    end
+
+    def response_parser(rexml, xpoint:)
+      attributes = {}
+      rexml.elements.each(xpoint) do |result|
+        result.children.each do |el|
+          next if el.to_s.strip.blank?
+          if el.has_elements?
+            el_ary = el.children.reject{|v| v.to_s.blank?}.map{|v| v.text.try!(:force_encoding, 'utf-8')}.reject{|v| v.to_s.blank?}
+            attributes[el.name.underscore] = el_ary
+            begin
+              self.define_singleton_method(el.name.underscore) {
+                el_ary
+              }
+            rescue => e
+              puts e
+            end # begin
+          else
+            attributes[el.name.underscore] = el.text
+            begin
+              self.define_singleton_method(el.name.underscore) {
+                el.text.try!(:force_encoding, 'utf-8')
+              }
+            rescue => e
+              puts e
+            end
+          end # if el.has_elements?
+        end # result.children.each
+        self.define_singleton_method('all') {
+          attributes
+        }
+      end # xml.elements.each(xpoint)
+      self
+    end # def response_parser
+
+    def error_parser(rexml)
+      result = {
+        status: 'NG',
+        message: rexml.elements['Error/Message'].text
+      }
+      result.each do |k, v|
+        self.define_singleton_method(k) { v }
+      end
+      self.define_singleton_method('all') { result }
+      self
+    end
+
+  end
+end

data/lib/yahoo_store_api/item/delete_item.rb

@@ -0,0 +1,14 @@
+module YahooStoreApi
+  module Item
+    include YahooStoreApi::Helper
+
+    def delete_item(str)
+      request = "seller_id=#{@seller_id}&item_code=#{URI.encode_www_form_component(str)}"
+      
+      handler connection('deleteItem').post { |r|
+        r.body = request
+      }
+    end
+
+  end
+end

data/lib/yahoo_store_api/item/edit_item.rb

@@ -0,0 +1,14 @@
+module YahooStoreApi
+  module Item
+    include YahooStoreApi::Helper
+
+    def edit_item(hash)
+      request = "seller_id=#{@seller_id}&#{URI.encode_www_form(hash)}"
+      
+      handler connection('editItem').post { |r|
+        r.body = request
+      }
+    end
+
+  end
+end

data/lib/yahoo_store_api/item/get_item.rb

@@ -0,0 +1,13 @@
+module YahooStoreApi
+  module Item
+    include YahooStoreApi::Helper
+
+    def get_item(item_code)
+      handler connection('getItem').get { |r|
+        r.params['seller_id'] = @seller_id
+        r.params['item_code'] = item_code
+      }
+    end
+
+  end
+end

data/lib/yahoo_store_api/item.rb

@@ -0,0 +1,3 @@
+require 'yahoo_store_api/item/get_item'
+require 'yahoo_store_api/item/edit_item'
+require 'yahoo_store_api/item/delete_item'

data/lib/yahoo_store_api/publish/reserve_publish.rb

@@ -0,0 +1,17 @@
+module YahooStoreApi
+  module Publish
+    include YahooStoreApi::Helper
+
+    def reserve_publish(mode: 1, reserve_time: nil)
+      request = []
+      request << "seller_id=#{@seller_id}"
+      request << "mode=#{mode}"
+      request << "seller_id=#{reserve_time}" if reserve_time
+
+      handler connection('reservePublish').post { |r|
+        r.body = request.join('&')
+      }
+    end
+
+  end
+end

data/lib/yahoo_store_api/publish.rb

@@ -0,0 +1 @@
+require 'yahoo_store_api/publish/reserve_publish'

data/lib/yahoo_store_api/stock/get_stock.rb

@@ -0,0 +1,12 @@
+module YahooStoreApi
+  module Stock
+    include YahooStoreApi::Helper
+
+    def get_stock(item_code)
+      handler connection('getStock').post { |r|
+        r.body = "seller_id=#{@seller_id}&item_code=#{item_code}"
+      }
+    end
+
+  end
+end

data/lib/yahoo_store_api/stock/set_stock.rb

@@ -0,0 +1,14 @@
+module YahooStoreApi
+  module Stock
+    include YahooStoreApi::Helper
+
+    def set_stock(hash)
+      request = "seller_id=#{@seller_id}&#{URI.encode_www_form(hash)}"
+
+      handler connection('setStock').post { |r|
+        r.body = request
+      }
+    end
+
+  end
+end

data/lib/yahoo_store_api/stock.rb

@@ -0,0 +1,2 @@
+require 'yahoo_store_api/stock/get_stock'
+require 'yahoo_store_api/stock/set_stock'

data/lib/yahoo_store_api/version.rb

@@ -0,0 +1,3 @@
+module YahooStoreApi
+  VERSION = "0.1.1"
+end

data/lib/yahoo_store_api.rb

@@ -0,0 +1,62 @@
+require "yahoo_store_api/version"
+require 'yahoo_store_api/helper.rb'
+require 'yahoo_store_api/item.rb'
+require 'yahoo_store_api/stock.rb'
+require 'yahoo_store_api/publish.rb'
+
+require 'rexml/document'
+require 'yaml'
+require 'uri'
+require 'faraday'
+require 'active_support'
+require 'active_support/core_ext'
+require 'active_model'
+
+module YahooStoreApi
+  class Client
+    attr_reader :refresh_token
+    include YahooStoreApi::Item
+    include YahooStoreApi::Stock
+    include YahooStoreApi::Publish
+
+    def initialize(seller_id:, application_id:, application_secret:, authorization_code: nil, refresh_token: nil)
+      @seller_id = seller_id
+      @application_id = application_id
+      @application_secret = application_secret
+      @access_token = reflesh_access_token(refresh_token) || get_access_token(authorization_code)
+    end
+
+    private
+
+    ACCESS_TOKEN_ENDPOINT = 'https://auth.login.yahoo.co.jp/yconnect/v1/token'.freeze
+    def access_token_connection
+      Faraday.new(url: ACCESS_TOKEN_ENDPOINT) do |c|
+        c.adapter Faraday.default_adapter
+        c.authorization :Basic, Base64.strict_encode64("#{@application_id}:#{@application_secret}")
+        c.headers['Content-Type'] = 'application/x-www-form-urlencoded;charset=UTF-8'
+      end
+    end
+
+    def get_access_token(authorization_code)
+      param = "grant_type=authorization_code&code=#{authorization_code}&redirect_uri=oob"
+      obj = access_token_connection.post{|r| r.body = param}
+      result = hash_converter(obj)
+      @refresh_token = result[:refresh_token]
+      result[:access_token]
+    end
+
+    def reflesh_access_token(refresh_token)
+      param = "grant_type=refresh_token&refresh_token=#{refresh_token}"
+      obj = access_token_connection.post{|r| r.body = param}
+      result = hash_converter(obj)
+      @refresh_token = refresh_token
+      result[:access_token]
+    end
+
+    def hash_converter(str)
+      ary = str.body.delete('"{}').split(/[:,]/)
+      ary.each_slice(2).map{|k, v| [k.to_sym, v]}.to_h
+    end
+
+  end
+end

data/yahoo_store_api.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yahoo_store_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yahoo_store_api"
+  spec.version       = YahooStoreApi::VERSION
+  spec.authors       = ["t4traw"]
+  spec.email         = ["t4traw@gmail.com"]
+
+  spec.summary       = %q{Yahoo!ショッピング プロフェッショナル出店ストア向けAPIを簡単に叩けるrubyラッパー}
+  spec.description   = %q{Yahoo!ショッピング プロフェッショナル出店ストア向けAPIを簡単に叩けるrubyラッパー}
+  spec.homepage      = "https://github.com/t4traw/yahoo_store_api"
+
+  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_dependency "faraday", '~> 0.12.1'
+  spec.add_dependency "activesupport", '~> 5.1.0'
+  spec.add_dependency "activemodel", '~> 5.1.0'
+  spec.add_dependency "builder"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry", "~> 0.10.4"
+  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"
+end

metadata

@@ -0,0 +1,229 @@
+--- !ruby/object:Gem::Specification
+name: yahoo_store_api
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- t4traw
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: builder
+  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.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  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: webmock
+  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: vcr
+  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: dotenv
+  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: Yahoo!ショッピング プロフェッショナル出店ストア向けAPIを簡単に叩けるrubyラッパー
+email:
+- t4traw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/yahoo_store_api.rb
+- lib/yahoo_store_api/helper.rb
+- lib/yahoo_store_api/item.rb
+- lib/yahoo_store_api/item/delete_item.rb
+- lib/yahoo_store_api/item/edit_item.rb
+- lib/yahoo_store_api/item/get_item.rb
+- lib/yahoo_store_api/publish.rb
+- lib/yahoo_store_api/publish/reserve_publish.rb
+- lib/yahoo_store_api/stock.rb
+- lib/yahoo_store_api/stock/get_stock.rb
+- lib/yahoo_store_api/stock/set_stock.rb
+- lib/yahoo_store_api/version.rb
+- yahoo_store_api.gemspec
+homepage: https://github.com/t4traw/yahoo_store_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.5.2
+signing_key: 
+specification_version: 4
+summary: Yahoo!ショッピング プロフェッショナル出店ストア向けAPIを簡単に叩けるrubyラッパー
+test_files: []