yahoo_store_api 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d9e908e0799aac49b3bc5165e24f167f8f01742e
-  data.tar.gz: '08bfd192bbc39794560aafdac3d8ffc9463ff05b'
+SHA256:
+  metadata.gz: b4f9d63dbb6b0abef96a88ac45a98cac48a80bb3ab7851e6228e02a7be76b040
+  data.tar.gz: 2ff5255dc7a35d7782d4354f255adb2455dde492c82e0df3349be3a5f74caf27
 SHA512:
-  metadata.gz: 5f1d2e26d94671091fcb770724aed351fc916efb38a10d75b2d0f3151a3dfd5afa07c66bb6b83bd22b29bc18279df741c57ae5870a39620e56068350b3ec7e5b
-  data.tar.gz: 0e55ad4a4794ff54a3394e54c83bb3710a2575cc318f62a4a6ec67fd4b1bf3045b1734e81b492cd2ae8ba9f19286b1c02efe21e0bdf4e535af67285ef3d2e5ed
+  metadata.gz: b91652ab266410d9ee3ce83c2d1b508c641c63483a5533a78dbeed22511fb5eb73515203e2f28172ce2ef44d99d006256f216f6f917b18489b20ece60c92295b
+  data.tar.gz: 7bd4f44e9dd8ce86415329435fe9a990cf6a8c400e70ec14b632dc26856a4fdc0f5285e883a86a3199d2f6a8d225f466d6432f1f567ae98417c696fef18c186e

data/.env.sample

@@ -0,0 +1,4 @@
+YOUR_SELLER_ID=YOUR_SELLER_ID
+YOUR_APPLICATION_ID=YOUR_APPLICATION_ID
+YOUR_APPLICATION_SECRET=YOUR_APPLICATION_SECRET
+YOUR_REFRESH_TOKEN=foobar

data/.gitignore

@@ -10,4 +10,4 @@
 
 .env
 .rbenv-gemsets
-sample.rb
+sample.rb

data/.travis.yml

@@ -1,12 +1,13 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.2.7
-  - 2.3.4
+  - 2.7.2
+  - 2.6.6
+  - 2.5.8
   - ruby-head
 
 matrix:
   allow_failures:
     - rvm: ruby-head
 
-before_install: gem install bundler -v 1.14.6
+before_install: gem install bundler -v 2.2.11

data/Gemfile

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

data/README.md

@@ -1,5 +1,6 @@
 # YahooStoreApi
 
+[![Gem Version](https://badge.fury.io/rb/yahoo_store_api.svg)](https://badge.fury.io/rb/yahoo_store_api)
 [![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)
 
@@ -12,7 +13,10 @@ Yahoo!ショッピング プロフェッショナル出店ストア向けAPIを
 * 商品に関連するAPI
   * 商品参照API(`get_item`)
   * 商品登録API(`set_item`)
+  * 商品アップロードAPI(`upload_item_file`)
   * 商品削除API(`delete_item`)
+* 画像に関連するAPI
+  * 商品画像一括アップロードAPI(`upload_item_image_pack`)
 * 在庫に関連するAPI
   * 在庫参照API(`get_stock`)
   * 在庫更新API(`set_stock`)
@@ -43,11 +47,14 @@ stateやnonceなどは[Authorizationエンドポイント](https://developer.yah
 
 ストアアカウント、上で登録したアプリケーションid、シークレット、取得した認証コードでインスタンスを生成します。
 
+redirect_uriにはアプリケーション登録時に設定したフルURL（もしくはカスタムURIスキーム）を指定してください。登録済みの戻り先URLが1つしかない場合は省略可能です。戻り先URLがない場合はoobを指定してください。
+
 ```ruby
 client = YahooStoreApi::Client.new(
   seller_id: YOUR_STORE_ID, # ストアアカウントid
   application_id: YOUR_APPLICATION_ID, # アプリケーションid
   application_secret: YOUR_SECRET, # シークレット
+  redirect_uri: 'oob', # 省略可能
   authorization_code: AUTHORIZATION_CODE # 認証コード
 )
 ```
@@ -84,9 +91,9 @@ item.price
 item.all
 ```
 
-### 商品情報の登録/更新
+### 商品情報の登録
 
-商品情報を登録・更新できます。
+項目については[Yahoo:商品登録API](https://developer.yahoo.co.jp/webapi/shopping/editItem.html)を参照してください。
 
 ```ruby
 item = client.edit_item({
@@ -100,6 +107,29 @@ item = client.edit_item({
 item.all
 ```
 
+### 商品情報の一括登録
+
+csvファイルをアップロードする事で商品情報の一括登録ができます。
+
+```ruby
+item = client.upload_item_file("your/upload/file.csv")
+```
+
+### 商品情報の更新
+
+:bangbang: APIの仕様で、更新したいカラムのみ送信して更新が **できません** :bangbang:
+
+商品を登録・更新する場合、**省略した項目はデフォルト値で上書きされるので注意してください**。
+
+なので、一度情報を取得し、必要な箇所を書き換えて送信する必要があります。
+
+```ruby
+data = client.get_item(code).all
+data["name"] = 'edit item'
+data["caption"] = 'edit caption'
+client.edit_item(data)
+```
+
 ### 在庫情報の参照
 
 ストアに登録されている商品の在庫情報を取得できます。

data/Rakefile

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

data/lib/yahoo_store_api/helper.rb

@@ -1,21 +1,28 @@
 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
+
+    def connection(method, with_seller_id: false)
+      url = ENDPOINT + method
+      if with_seller_id
+        url += "?seller_id=#{@seller_id}" if with_seller_id
+      end
+
+      Faraday.new(url: url) do |c|
+        c.request :multipart
+        c.request :url_encoded
+        c.adapter :net_http
+        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']
+      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
@@ -28,7 +35,7 @@ module YahooStoreApi
         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?}
+            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) {
@@ -41,14 +48,14 @@ module YahooStoreApi
             attributes[el.name.underscore] = el.text
             begin
               self.define_singleton_method(el.name.underscore) {
-                el.text.try!(:force_encoding, 'utf-8')
+                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') {
+        self.define_singleton_method("all") {
           attributes
         }
       end # xml.elements.each(xpoint)
@@ -57,15 +64,14 @@ module YahooStoreApi
 
     def error_parser(rexml)
       result = {
-        status: 'NG',
-        message: rexml.elements['Error/Message'].text
+        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.define_singleton_method("all") { result }
       self
     end
-
   end
 end

data/lib/yahoo_store_api/image/upload_item_image_pack.rb

@@ -0,0 +1,15 @@
+module YahooStoreApi
+  module Image
+    include YahooStoreApi::Helper
+
+    def upload_item_image_pack(zip_path)
+      request = {
+        file: Faraday::UploadIO.new(zip_path, "application/zip"),
+      }
+
+      handler connection("uploadItemImagePack", with_seller_id: true).post { |r|
+        r.body = request
+      }
+    end
+  end
+end

data/lib/yahoo_store_api/image.rb

@@ -0,0 +1 @@
+require "yahoo_store_api/image/upload_item_image_pack"

data/lib/yahoo_store_api/item/delete_item.rb

@@ -4,11 +4,10 @@ module YahooStoreApi
 
     def delete_item(str)
       request = "seller_id=#{@seller_id}&item_code=#{URI.encode_www_form_component(str)}"
-      
-      handler connection('deleteItem').post { |r|
+
+      handler connection("deleteItem").post { |r|
         r.body = request
       }
     end
-
   end
 end

data/lib/yahoo_store_api/item/edit_item.rb

@@ -4,11 +4,10 @@ module YahooStoreApi
 
     def edit_item(hash)
       request = "seller_id=#{@seller_id}&#{URI.encode_www_form(hash)}"
-      
-      handler connection('editItem').post { |r|
+
+      handler connection("editItem").post { |r|
         r.body = request
       }
     end
-
   end
 end

data/lib/yahoo_store_api/item/get_item.rb

@@ -3,11 +3,10 @@ module YahooStoreApi
     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
+      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/upload_item_file.rb

@@ -0,0 +1,16 @@
+module YahooStoreApi
+  module Item
+    include YahooStoreApi::Helper
+
+    def upload_item_file(file_path)
+      request = {
+        type: 1,
+        file: Faraday::UploadIO.new(file_path, "text/csv"),
+      }
+
+      handler connection("uploadItemFile", with_seller_id: true).post { |r|
+        r.body = request
+      }
+    end
+  end
+end

data/lib/yahoo_store_api/item.rb

@@ -1,3 +1,4 @@
-require 'yahoo_store_api/item/get_item'
-require 'yahoo_store_api/item/edit_item'
-require 'yahoo_store_api/item/delete_item'
+require "yahoo_store_api/item/get_item"
+require "yahoo_store_api/item/edit_item"
+require "yahoo_store_api/item/upload_item_file"
+require "yahoo_store_api/item/delete_item"

data/lib/yahoo_store_api/publish/reserve_publish.rb

@@ -8,10 +8,9 @@ module YahooStoreApi
       request << "mode=#{mode}"
       request << "seller_id=#{reserve_time}" if reserve_time
 
-      handler connection('reservePublish').post { |r|
-        r.body = request.join('&')
+      handler connection("reservePublish").post { |r|
+        r.body = request.join("&")
       }
     end
-
   end
 end

data/lib/yahoo_store_api/publish.rb

@@ -1 +1 @@
-require 'yahoo_store_api/publish/reserve_publish'
+require "yahoo_store_api/publish/reserve_publish"

data/lib/yahoo_store_api/stock/get_stock.rb

@@ -3,10 +3,9 @@ module YahooStoreApi
     include YahooStoreApi::Helper
 
     def get_stock(item_code)
-      handler connection('getStock').post { |r|
+      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

@@ -5,10 +5,9 @@ module YahooStoreApi
     def set_stock(hash)
       request = "seller_id=#{@seller_id}&#{URI.encode_www_form(hash)}"
 
-      handler connection('setStock').post { |r|
+      handler connection("setStock").post { |r|
         r.body = request
       }
     end
-
   end
 end

data/lib/yahoo_store_api/stock.rb

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

data/lib/yahoo_store_api/version.rb

@@ -1,3 +1,3 @@
 module YahooStoreApi
-  VERSION = "0.1.2"
+  VERSION = "0.2.1"
 end

data/lib/yahoo_store_api.rb

@@ -1,45 +1,50 @@
 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'
+require "yahoo_store_api/helper.rb"
+require "yahoo_store_api/item.rb"
+require "yahoo_store_api/image.rb"
+require "yahoo_store_api/stock.rb"
+require "yahoo_store_api/publish.rb"
+
+require "rexml/document"
+require "yaml"
+require "uri"
+require "cgi"
+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::Image
     include YahooStoreApi::Stock
     include YahooStoreApi::Publish
 
-    def initialize(seller_id:, application_id:, application_secret:, authorization_code: nil, refresh_token: nil)
+    def initialize(seller_id:, application_id:, application_secret:, authorization_code: nil, redirect_uri: nil, refresh_token: nil)
       @seller_id = seller_id
       @application_id = application_id
       @application_secret = application_secret
+      @redirect_uri = redirect_uri ? "&redirect_uri=" + CGI.escape(redirect_uri) : nil
       @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
+    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'
+        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}
+      param = "grant_type=authorization_code&code=#{authorization_code}#{@redirect_uri}"
+      obj = access_token_connection.post { |r| r.body = param }
       result = hash_converter(obj)
       @refresh_token = result[:refresh_token]
       result[:access_token]
@@ -47,7 +52,7 @@ module YahooStoreApi
 
     def reflesh_access_token(refresh_token)
       param = "grant_type=refresh_token&refresh_token=#{refresh_token}"
-      obj = access_token_connection.post{|r| r.body = param}
+      obj = access_token_connection.post { |r| r.body = param }
       result = hash_converter(obj)
       @refresh_token = refresh_token
       result[:access_token]
@@ -55,8 +60,7 @@ module YahooStoreApi
 
     def hash_converter(str)
       ary = str.body.delete('"{}').split(/[:,]/)
-      ary.each_slice(2).map{|k, v| [k.to_sym, v]}.to_h
+      ary.each_slice(2).map { |k, v| [k.to_sym, v] }.to_h
     end
-
   end
 end

data/yahoo_store_api.gemspec

@@ -1,33 +1,33 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'yahoo_store_api/version'
+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.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.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|
+  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.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", '>= 4.2.8'
-  spec.add_dependency "activemodel", '>= 4.2.8'
+  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_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "pry", "~> 0.10.4"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "minitest-reporters"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yahoo_store_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - t4traw
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-23 00:00:00.000000000 Z
+date: 2021-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -70,30 +70,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -185,6 +185,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.sample"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
@@ -193,10 +194,13 @@ files:
 - Rakefile
 - lib/yahoo_store_api.rb
 - lib/yahoo_store_api/helper.rb
+- lib/yahoo_store_api/image.rb
+- lib/yahoo_store_api/image/upload_item_image_pack.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/item/upload_item_file.rb
 - lib/yahoo_store_api/publish.rb
 - lib/yahoo_store_api/publish/reserve_publish.rb
 - lib/yahoo_store_api/stock.rb
@@ -222,8 +226,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.1.6
 signing_key: 
 specification_version: 4
 summary: Yahoo!ショッピング プロフェッショナル出店ストア向けAPIを簡単に叩けるrubyラッパー