rms_web_service 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb7f1ea6f7988ece4163aa6e2348519ba888c98b
-  data.tar.gz: 6539c446b7d4f32bff75671535d7f663fba222a0
+  metadata.gz: b70010ad1562606d5dd76723f560721bfdea10da
+  data.tar.gz: a080df81acd5d66b1d56d329d6a37661821eb161
 SHA512:
-  metadata.gz: 8c235fe917086bcfe5b579146412d8ad912f7a7d284ccb3cdbff4fd4b66d699e0ff3b2fa60fdab481c6cf3c936541a5eb7c5c2bdb93bb302479cb11c79bce081
-  data.tar.gz: 1ba6f120e7d6bf9e00aa3f6042f66e48c78cc8a6c43058d76b07bd73609bbc1e509d28041ce45ceedbdcd90edc32042d5b849ad3fc5c8e872e8372aaf447859a
+  metadata.gz: ba655891732259a65aeff28f41d57e8ca365482e52d0bcb8f63db4981bdb928ed8b1b2ac3e81471ae5113d7c4b6ee3f5768c0b48b255c0810a5bbc5be8ee8d71
+  data.tar.gz: 2380655709d20276c6ac55894b9b19476816bb117cb16e761b305d111617a6e8c317a837387b9cbeb71e818b38747a27b5f9a6682e28fc1fcf49590cf0c8a858

data/README.md

@@ -41,16 +41,14 @@ client = RmsWebService::Client::Item.new(service_secret: "dummy_service_secret",
 
 RmsWebService::Client::ItemのインスタンスがAPIの各メソッドを持っています。パラメータを渡す場合はハッシュ、複数のItemを渡す場合は配列を使用します。
 
-各メソッドのレスポンスがどのようなメソッドを持つかは公式ドキュメントをご覧ください。更新に失敗した場合のみ、`errorMessages`に設定されているエラー関係のメソッドをサポートします。
-
 ```ruby
 # item.get
 item = client.get(:item_url => "ed-60c-w")
-p item.item_name # => "ed-60c-w"
+# '.item_name'、'.item_price'等のメソッドを持ちます。属性については公式ドキュメントを見てください。
 
 # item.update
 item = client.update({:item_url => "ed-60c-w", :item_price => 43800})
-p item.system_status # => "OK"
+# '.success?'で成功したかどうかを判別できます。'.errors'でエラー内容を確認できます。
 
 # item.insert
 item = client.insert({
@@ -59,31 +57,22 @@ item = client.insert({
   :item_price => "100000",
   :genre_id => "211889",
 })
-p item.system_status # => "OK"
+# '.success?'で成功したかどうかを判別できます。'.errors'でエラー内容を確認できます。
 
 # item.delete
 item = client.delete(:item_url => "test001")
-p item.system_status # => "OK"
+# '.success?'で成功したかどうかを判別できます。'.errors'でエラー内容を確認できます。
 
 # item.search
 items = client.search(:item_name => "空気清浄機")
-items.each do |item|
-  p item.item_name
-end
+# item.getと同じ性質のインスタンスを要素として持つ配列を返します
 
 # items.update
 items = client.items_update([
   {:item_url => "ed-60c-w", :item_price => 43800},
   {:item_url => "noexist", :item_price => 10800}
 ])
-items.each do |item|
-  if item.code == 'N000'
-    p item.item_url # => "ed-60c-w" 
-  else
-    p item.error_id # => "335"
-    p item.msg # => "商品管理番号欄（商品URL）で指定された商品が見つかりません。更新・変更、削除の場合は、存在する商品の商品管理番号（商品URL）をご指定ください。"
-  end
-end
+# item.updateと同じ性質のインスタンスを要素として持つ配列を返します
 ```
 
 ## Contributing

data/lib/rms_web_service/response.rb

@@ -2,13 +2,5 @@ require 'rms_web_service/response/item'
 
 module RmsWebService
   module Response
-    def set_attributes(args)
-      args.each {|s| set_attribute(s.name, s.content)}
-    end
-
-    def set_attribute(name, content)
-      att = name.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').gsub(/([a-z\d])([A-Z])/,'\1_\2').tr("-", "_").downcase
-      self.define_singleton_method(att) {content}
-    end
   end
 end

data/lib/rms_web_service/response/item.rb

@@ -1,3 +1,6 @@
+require 'rms_web_service/response/item/parser'
+require 'rms_web_service/response/item/status'
+require 'rms_web_service/response/item/error'
 require 'rms_web_service/response/item/get'
 require 'rms_web_service/response/item/insert'
 require 'rms_web_service/response/item/update'

data/lib/rms_web_service/response/item/delete.rb

@@ -1,13 +1,15 @@
 module RmsWebService
   module Response
     module Item
-      class Delete
-        include ::RmsWebService::Response
+      class Delete < Parser
+        attr_accessor :code, :errors
         def initialize(xml)
-          xml = Nokogiri::XML.parse(xml)
-          set_attributes xml.xpath("//status").children
-          set_attributes xml.xpath("//item").children
-          set_attribute("code", xml.xpath("//code").first.content)
+          super
+          set_attributes @parsed_xml.xpath("//item").children
+        end
+
+        def success?
+          return @code == "N000" ? true : false
         end
       end
     end

data/lib/rms_web_service/response/item/error.rb

@@ -0,0 +1,11 @@
+module RmsWebService
+  module Response
+    module Item
+      class Error < Parser
+        def initialize(xml)
+          set_attributes Nokogiri::XML.parse(xml).xpath("//errorMessage").children
+        end
+      end
+    end
+  end
+end

data/lib/rms_web_service/response/item/get.rb

@@ -1,13 +1,15 @@
 module RmsWebService
   module Response
     module Item
-      class Get
-        include ::RmsWebService::Response
+      class Get < Parser
+        attr_accessor :code
         def initialize(xml)
-          xml = Nokogiri::XML.parse(xml)
-          set_attributes xml.xpath("//status").children
-          set_attributes xml.xpath("//item").children
-          set_attribute("code", xml.xpath("//code").first.content) if xml.xpath("//code").present?
+          super
+          set_attributes @parsed_xml.xpath("//item").children
+        end
+
+        def success?
+          return @code == "N000" ? true : false
         end
       end
     end

data/lib/rms_web_service/response/item/insert.rb

@@ -1,13 +1,15 @@
 module RmsWebService
   module Response
     module Item
-      class Insert
-        include ::RmsWebService::Response
+      class Insert < Parser
+        attr_accessor :code, :errors
         def initialize(xml)
-          xml = Nokogiri::XML.parse(xml)
-          set_attributes xml.xpath("//status").children
-          set_attributes xml.xpath("//item").children
-          set_attribute("code", xml.xpath("//code").first.content)
+          super
+          set_attributes @parsed_xml.xpath("//item").children
+        end
+
+        def success?
+          return @code == "N000" ? true : false
         end
       end
     end

data/lib/rms_web_service/response/item/items_update.rb

@@ -1,12 +1,10 @@
 module RmsWebService
   module Response
     module Item
-      class ItemsUpdate < Array
-        include ::RmsWebService::Response
+      class ItemsUpdate < Parser
         def initialize(xml)
-          xml = Nokogiri::XML.parse(xml)
-          set_attributes xml.xpath("//status").children
-          xml.xpath("//itemsUpdateResult").children.each {|item| self << Update.new(item.to_xml)}
+          super
+          @parsed_xml.xpath("//itemsUpdateResult").children.each {|item| self << Update.new(item.to_xml)}
         end
       end
     end

data/lib/rms_web_service/response/item/parser.rb

@@ -0,0 +1,25 @@
+module RmsWebService
+  module Response
+    module Item
+      class Parser < Array
+        attr_accessor :status
+        def initialize(xml)
+          @parsed_xml = Nokogiri::XML.parse(xml)
+          @status = Item::Status.new(xml)
+          @code = @parsed_xml.xpath("//code").first.content if @parsed_xml.xpath("//code").present?
+          @errors = []
+          @parsed_xml.xpath("//errorMessages").each {|error| @errors << Error.new(error)} if @parsed_xml.xpath("//errorMessages").present?
+        end
+
+        def set_attributes(args)
+          args.each {|s| set_attribute(s.name, s.content)}
+        end
+
+        def set_attribute(name, content)
+          att = name.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').gsub(/([a-z\d])([A-Z])/,'\1_\2').tr("-", "_").downcase
+          self.define_singleton_method(att) {content}
+        end
+      end
+    end
+  end
+end

data/lib/rms_web_service/response/item/search.rb

@@ -1,13 +1,15 @@
 module RmsWebService
   module Response
     module Item
-      class Search < ::Array
-        include ::RmsWebService::Response
+      class Search < Parser
+        attr_accessor :code
         def initialize(xml)
-          xml = Nokogiri::XML.parse(xml)
-          set_attributes xml.xpath("//status").children
-          set_attribute("code", xml.xpath("//code").first.content)
-          xml.xpath("//items").children.each {|item| self << Get.new(item.to_xml)}
+          super
+          @parsed_xml.xpath("//items").children.each {|item| self << Get.new(item.to_xml)}
+        end
+
+        def success?
+          return @code == "200-00" ? true : false
         end
       end
     end

data/lib/rms_web_service/response/item/status.rb

@@ -0,0 +1,11 @@
+module RmsWebService
+  module Response
+    module Item
+      class Status < Parser
+        def initialize(xml)
+          set_attributes Nokogiri::XML.parse(xml).xpath("//status").children
+        end
+      end
+    end
+  end
+end

data/lib/rms_web_service/response/item/update.rb

@@ -1,14 +1,15 @@
 module RmsWebService
   module Response
     module Item
-      class Update
-        include ::RmsWebService::Response
+      class Update < Parser
+        attr_accessor :code, :errors
         def initialize(xml)
-          xml = Nokogiri::XML.parse(xml)
-          set_attributes xml.xpath("//status").children
-          set_attributes xml.xpath("//item").children
-          set_attributes xml.xpath("//errorMessage").children if xml.xpath("//errorMessage").present?
-          set_attribute("code", xml.xpath("//code").first.content)
+          super
+          set_attributes @parsed_xml.xpath("//item").children
+        end
+
+        def success?
+          return @code == "N000" ? true : false
         end
       end
     end

data/lib/rms_web_service/version.rb

@@ -1,3 +1,3 @@
 module RmsWebService
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/fixtures/delete.xml

@@ -8,14 +8,7 @@
     <requests/>
   </status>
   <itemDeleteResult>
-    <code>code</code>
-    <errorMessages>
-      <errorId>errorId</errorId>
-      <fieldId>fieldId</fieldId>
-      <msg>error message</msg>
-      <listIndex>1</listIndex>
-      <listIndex2>2</listIndex2>
-    </errorMessages>
+    <code>code</code><errorMessages><errorMessage><errorId>errorId</errorId><fieldId>fieldId</fieldId><msg>error message</msg><listIndex>1</listIndex><listIndex2>2</listIndex2></errorMessage></errorMessages>
     <item>
       <itemUrl>yyy</itemUrl>
     </item>

data/spec/fixtures/get.xml

@@ -13,9 +13,8 @@
         <code>N000</code>
         <item>
             <itemUrl>aaa</itemUrl>
-            ・
-            ・
-            ・
+            <itemName>test</itemName>
+            <itemPrice>1000</itemPrice>
         </item>
     </itemGetResult>
 </result>

data/spec/fixtures/update.xml

@@ -9,15 +9,7 @@
   </status>
   <itemUpdateResult>
     <code>code</code>
-    <errorMessages>
-      <errorMessage>
-        <errorId>errorId</errorId>
-        <fieldId>fieldId</fieldId>
-        <msg>error message</msg>
-        <listIndex>1</listIndex>
-        <listIndex2>2</listIndex2>
-      </errorMessage>
-    </errorMessages>
+    <errorMessages><errorMessage><errorId>errorId</errorId><fieldId>fieldId</fieldId><msg>error message</msg><listIndex>1</listIndex><listIndex2>2</listIndex2></errorMessage></errorMessages>
     <item>
       <itemUrl>yyy</itemUrl>
     </item>

data/spec/rms_web_service/client/item_spec.rb

@@ -21,102 +21,63 @@ describe RmsWebService::Client::Item do
   end
 
   describe '.get' do
-    let(:api) {client.get(:item_url => 'test001')}
     before do
       stub_request(:get, "https://api.rms.rakuten.co.jp/es/1.0/item/get?itemUrl=test001")
       .to_return(:status => 200, body: fixture('get.xml'))
     end
-
-    it 'should have methods to return parameters of "get" response' do
-      expect(api).to be_a RmsWebService::Response::Item::Get
-      expect(api.respond_to?(:code)).to be_truthy
-      expect(api.respond_to?(:system_status)).to be_truthy
-      expect(api.respond_to?(:item_url)).to be_truthy
-    end
+    subject {client.get(:item_url => 'test001')}
+    it {is_expected.to be_a RWS::Response::Item::Get}
   end
 
   describe '.delete' do
-    let(:api) {client.delete(:item_url => 'test001')}
     before do
       stub_request(:post, "https://api.rms.rakuten.co.jp/es/1.0/item/delete")
       .to_return(:status => 200, body: fixture('delete.xml'))
     end
-
-    it 'should have methods to return parameters of "delete" response' do
-      expect(api).to be_a RmsWebService::Response::Item::Delete
-      expect(api.respond_to?(:code)).to be_truthy
-      expect(api.respond_to?(:system_status)).to be_truthy
-      expect(api.respond_to?(:item_url)).to be_truthy
-    end
+    subject {client.delete(:item_url => 'test001')}
+    it {is_expected.to be_a RWS::Response::Item::Delete}
   end
 
   describe '.insert' do
-    let(:api) {client.insert({
-      :item_url => 'test001',
-      :item_name => 'test001',
-      :genre_id => '560420'
-    })}
     before do
       stub_request(:post, "https://api.rms.rakuten.co.jp/es/1.0/item/insert")
       .to_return(:status => 200, body: fixture('insert.xml'))
     end
-
-    it 'should have methods to return parameters of "insert" response' do
-      expect(api).to be_a RmsWebService::Response::Item::Insert
-      expect(api.respond_to?(:code)).to be_truthy
-      expect(api.respond_to?(:system_status)).to be_truthy
-      expect(api.respond_to?(:item_url)).to be_truthy
-    end
+    subject {client.insert({
+      :item_url => 'test001',
+      :item_name => 'test001',
+      :genre_id => '560420'
+    })}
+    it {is_expected.to be_a RWS::Response::Item::Insert}
   end
 
   describe '.update' do
-    let(:api) {client.update({:item_url => 'test001', :item_price => '10000'})}
     before do
       stub_request(:post, "https://api.rms.rakuten.co.jp/es/1.0/item/update")
       .to_return(:status => 200, body: fixture('update.xml'))
     end
-
-    it 'should have methods to return parameters of "update" response' do
-      expect(api).to be_a RmsWebService::Response::Item::Update
-      expect(api.respond_to?(:code)).to be_truthy
-      expect(api.respond_to?(:system_status)).to be_truthy
-      expect(api.respond_to?(:item_url)).to be_truthy
-      expect(api.respond_to?(:error_id)).to be_truthy
-    end
+    subject {client.update({:item_url => 'test001', :item_price => '10000'})}
+    it {is_expected.to be_a RWS::Response::Item::Update}
   end
 
   describe '.search' do
-    let(:api) {client.search(:item_name => 'test001', :item_price_from => 1)}
     before do
       stub_request(:get, "https://api.rms.rakuten.co.jp/es/1.0/item/search?itemName=test001&itemPriceFrom=1")
       .to_return(:status => 200, body: fixture('search.xml'))
     end
-
-    it 'should have methods to return parameters of "search" response' do
-      expect(api).to be_a RmsWebService::Response::Item::Search
-      expect(api[0]).to be_a RmsWebService::Response::Item::Get
-      expect(api.respond_to?(:code)).to be_truthy
-      expect(api.respond_to?(:system_status)).to be_truthy
-      expect(api[0].respond_to?(:item_url)).to be_truthy
-    end
+    subject {client.search(:item_name => 'test001', :item_price_from => 1)}
+    it {is_expected.to be_a RWS::Response::Item::Search}
   end
 
   describe '.items_update' do
-    let(:api) {client.items_update([
-      {:item_url => 'test001', :item_price => 100},
-      {:item_url => 'test002', :item_price => 200}
-    ])}
     before do
       stub_request(:post, "https://api.rms.rakuten.co.jp/es/1.0/items/update")
       .to_return(:status => 200, body: fixture('items_update.xml'))
     end
-
-    it 'should have methods to return parameters of "items.update" response' do
-      expect(api).to be_a RmsWebService::Response::Item::ItemsUpdate
-      expect(api[0]).to be_a RmsWebService::Response::Item::Update
-      expect(api.respond_to?(:system_status)).to be_truthy
-      expect(api[0].respond_to?(:item_url)).to be_truthy
-      expect(api[0].respond_to?(:code)).to be_truthy
-    end
+    subject {client.items_update([
+      {:item_url => 'test001', :item_price => 100},
+      {:item_url => 'test002', :item_price => 200}
+    ])}
+    it {is_expected.to be_a RWS::Response::Item::ItemsUpdate}
   end
 end

data/spec/rms_web_service/response/item/delete_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+require 'rms_web_service'
+
+describe RmsWebService::Response::Item::Delete do
+  subject {described_class.new(fixture('delete.xml'))}
+  it {is_expected.to respond_to(:status, :code, :success?, :errors, :item_url)}
+end

data/spec/rms_web_service/response/item/error_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'rms_web_service'
+
+describe RWS::Response::Item::Error do
+  subject(:error) {described_class.new(fixture('update.xml'))}
+  it {is_expected.to be_a RWS::Response::Item::Error}
+  it {is_expected.to respond_to(:field_id)}
+end

data/spec/rms_web_service/response/item/get_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'rms_web_service'
+
+describe RmsWebService::Response::Item::Get do
+  subject {described_class.new(fixture('get.xml'))}
+  it {is_expected.to respond_to(:status, :code, :success?, :item_url, :item_name, :item_price)}
+  it {is_expected.not_to respond_to(:errors)}
+end

data/spec/rms_web_service/response/item/insert_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+require 'rms_web_service'
+
+describe RmsWebService::Response::Item::Insert do
+  subject {described_class.new(fixture('insert.xml'))}
+  it {is_expected.to respond_to(:status, :code, :success?, :errors, :item_url)}
+end

data/spec/rms_web_service/response/item/items_update_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'rms_web_service'
+
+describe RmsWebService::Response::Item::ItemsUpdate do
+  subject(:res) {described_class.new(fixture('items_update.xml'))}
+  it {is_expected.to respond_to(:status)}
+  it {is_expected.to_not respond_to(:code, :success?, :errors, :item_url)}
+  it 'should be an array of RWS::Response::Item::Update' do
+    expect(res[0]).to be_a RWS::Response::Item::Update
+  end
+end

data/spec/rms_web_service/response/item/search_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'rms_web_service'
+
+describe RmsWebService::Response::Item::Search do
+  subject(:res) {described_class.new(fixture('search.xml'))}
+  it {is_expected.to respond_to(:status, :success?, :code)}
+  it {is_expected.to_not respond_to(:item_url, :errors)}
+  it 'should be an array of RWS::Response::Item::Get' do
+    expect(res[0]).to be_a RWS::Response::Item::Get
+  end
+end

data/spec/rms_web_service/response/item/status_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+require 'rms_web_service'
+
+describe RmsWebService::Response::Item::Status do
+  subject {described_class.new(fixture('get.xml'))}
+  it {is_expected.to respond_to(:interface_id, :system_status)}
+end

data/spec/rms_web_service/response/item/update_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+require 'rms_web_service'
+
+describe RmsWebService::Response::Item::Update do
+  subject {described_class.new(fixture('update.xml'))}
+  it {is_expected.to respond_to(:status, :code, :success?, :errors, :item_url)}
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rms_web_service
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - kamiya54
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-12 00:00:00.000000000 Z
+date: 2014-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -144,10 +144,13 @@ files:
 - lib/rms_web_service/response.rb
 - lib/rms_web_service/response/item.rb
 - lib/rms_web_service/response/item/delete.rb
+- lib/rms_web_service/response/item/error.rb
 - lib/rms_web_service/response/item/get.rb
 - lib/rms_web_service/response/item/insert.rb
 - lib/rms_web_service/response/item/items_update.rb
+- lib/rms_web_service/response/item/parser.rb
 - lib/rms_web_service/response/item/search.rb
+- lib/rms_web_service/response/item/status.rb
 - lib/rms_web_service/response/item/update.rb
 - lib/rms_web_service/version.rb
 - rms_web_service.gemspec
@@ -160,6 +163,14 @@ files:
 - spec/fixtures/update.xml
 - spec/rms_web_service/client/item_spec.rb
 - spec/rms_web_service/configuration_spec.rb
+- spec/rms_web_service/response/item/delete_spec.rb
+- spec/rms_web_service/response/item/error_spec.rb
+- spec/rms_web_service/response/item/get_spec.rb
+- spec/rms_web_service/response/item/insert_spec.rb
+- spec/rms_web_service/response/item/items_update_spec.rb
+- spec/rms_web_service/response/item/search_spec.rb
+- spec/rms_web_service/response/item/status_spec.rb
+- spec/rms_web_service/response/item/update_spec.rb
 - spec/rms_web_service_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/kamiya54/rms_web_service
@@ -196,5 +207,13 @@ test_files:
 - spec/fixtures/update.xml
 - spec/rms_web_service/client/item_spec.rb
 - spec/rms_web_service/configuration_spec.rb
+- spec/rms_web_service/response/item/delete_spec.rb
+- spec/rms_web_service/response/item/error_spec.rb
+- spec/rms_web_service/response/item/get_spec.rb
+- spec/rms_web_service/response/item/insert_spec.rb
+- spec/rms_web_service/response/item/items_update_spec.rb
+- spec/rms_web_service/response/item/search_spec.rb
+- spec/rms_web_service/response/item/status_spec.rb
+- spec/rms_web_service/response/item/update_spec.rb
 - spec/rms_web_service_spec.rb
 - spec/spec_helper.rb