yahoo_store_api 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47cd02e692b7fcc3579822fd5f0a0791511780e55f99f9ab31236c8dfda17f9e
-  data.tar.gz: 7950d25213442f499447b2359d9c51f4ed48cb275e021d85d418140432446a5d
+  metadata.gz: f425884881906edb17b5b1901b37091ca193f0e14190bb6cacc1fc62c3d58856
+  data.tar.gz: 316bd70561649a4a1b7620c754fadc7d04138732fde60b3c46f9aca3421fafdb
 SHA512:
-  metadata.gz: 54a18a5461f9e4c447265d634f0f457194e2ccb45a9a8987b3b4c314367a77f549dc23a338b9cbb942fd402b9a5327cc8c0c771f69b8343e8af210bf613a0acd
-  data.tar.gz: af11055de003b61f67113f22144f5bbfc27e40db89e4792b61a046d788368059fb7e2f5e4e5ed692ec3e9e51e14c50ae63816654b14277fc5abc228388d8edea
+  metadata.gz: 3338a934453cdff5a9d72c2577784449966f78e50addbeb7fd1b5246200a82c705b2b58ff7c2d0c4358a4e44dc352c753d6e5f5f9b83fafda02e7eda076c6122
+  data.tar.gz: ff49e75c26dfef845a4af1c5cf6948c4763c9bfdbf00e813fe2425e7669b2775a0d875f90174035b9e93c7e75cd3a9a62e059740c6bf3ef6731fd58f24b2fbcd

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/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

@@ -12,6 +12,7 @@ Yahoo!ショッピング プロフェッショナル出店ストア向けAPIを
 * 商品に関連するAPI
   * 商品参照API(`get_item`)
   * 商品登録API(`set_item`)
+  * 商品アップロードAPI(`upload_item_file`)
   * 商品削除API(`delete_item`)
 * 在庫に関連するAPI
   * 在庫参照API(`get_stock`)
@@ -103,6 +104,14 @@ item = client.edit_item({
 item.all
 ```
 
+### 商品情報の一括登録
+
+csvファイルをアップロードする事で商品情報の一括登録ができます。
+
+```ruby
+item = client.upload_item_file("your/upload/file.csv")
+```
+
 ### 商品情報の更新
 
 :bangbang: APIの仕様で、更新したいカラムのみ送信して更新が **できません** :bangbang:

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/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.4"
+  VERSION = "0.2.0"
 end

data/lib/yahoo_store_api.rb

@@ -1,17 +1,17 @@
 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 "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 'cgi'
-require 'faraday'
-require 'active_support'
-require 'active_support/core_ext'
-require 'active_model'
+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
@@ -30,18 +30,19 @@ module YahooStoreApi
 
     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}"
-      obj = access_token_connection.post{|r| r.body = param}
+      obj = access_token_connection.post { |r| r.body = param }
       result = hash_converter(obj)
       @refresh_token = result[:refresh_token]
       result[:access_token]
@@ -49,7 +50,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]
@@ -57,8 +58,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,29 +1,29 @@
 # 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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yahoo_store_api
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - t4traw
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-05 00:00:00.000000000 Z
+date: 2021-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -185,6 +185,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.sample"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
@@ -197,6 +198,7 @@ files:
 - 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,7 +224,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Yahoo!ショッピング プロフェッショナル出店ストア向けAPIを簡単に叩けるrubyラッパー