rakuten_web_service 1.10.0 → 1.13.1

data/lib/rakuten_web_service/response.rb

@@ -33,6 +33,7 @@ module RakutenWebService
     def genre_information
       return unless @resource_class.respond_to?(:genre_class)
       return if self['GenreInformation'].empty?
+
       RWS::GenreInformation.new(self['GenreInformation'][0], @resource_class.genre_class)
     end
 
@@ -40,12 +41,12 @@ module RakutenWebService
       @resources ||= @resource_class.parse_response(@json)
     end
 
-    def has_next_page?
-      page && (not last_page?)
+    def next_page?
+      page && !last_page?
     end
 
-    def has_previous_page?
-      page && (not first_page?)
+    def previous_page?
+      page && !first_page?
     end
 
     def first_page?

data/lib/rakuten_web_service/search_result.rb

@@ -43,20 +43,19 @@ module RakutenWebService
 
     def order(options)
       new_params = params.dup
-      if options.is_a? Hash
-        key, sort_order = *options.to_a.last
-        key = key.to_s.to_camel
-        new_params[:sort] = case sort_order.to_s.downcase
-                            when 'desc'
-                              "-#{key}"
-                            when 'asc'
-                              "+#{key}"
-                            end
-      elsif options.to_s == 'standard'
+      if options.to_s == 'standard'
         new_params[:sort] = 'standard'
-      else
+        return self.class.new(new_params, @resource_class)
+      end
+      unless options.is_a? Hash
         raise ArgumentError, "Invalid Sort Option: #{options.inspect}"
       end
+
+      key, sort_order = *options.to_a.last
+      case sort_order.to_s.downcase
+      when 'desc' then new_params[:sort] = "-#{key}".to_camel
+      when 'asc' then new_params[:sort] = "+#{key}".to_camel
+      end
       self.class.new(new_params, @resource_class)
     end
 
@@ -69,16 +68,16 @@ module RakutenWebService
       @response ||= query
     end
 
-    def has_next_page?
-      response.has_next_page?
+    def next_page?
+      response.next_page?
     end
 
     def next_page
       search(page: response.page + 1)
     end
 
-    def has_previous_page?
-      response.has_previous_page?
+    def previous_page?
+      response.previous_page?
     end
 
     def previous_page

data/lib/rakuten_web_service/travel/area_class.rb

@@ -1,30 +1,26 @@
+# frozen_string_literal: true
+
 require 'rakuten_web_service/travel/resource'
 
 module RakutenWebService
   module Travel
     module AreaClass
-      def search(options={})
+      def search(options = {})
         Base.search(options)
       end
 
       def [](class_code)
-        LargeClass[class_code] or
-          MiddleClass[class_code] or
-          SmallClass[class_code] or
+        LargeClass[class_code] ||
+          MiddleClass[class_code] ||
+          SmallClass[class_code] ||
           DetailClass[class_code]
       end
       module_function :search, :[]
-    end
-  end
-end
 
-module RakutenWebService
-  module Travel
-    module AreaClass
       class Base < RakutenWebService::Travel::Resource
         endpoint 'https://app.rakuten.co.jp/services/api/Travel/GetAreaClass/20131024'
 
-        set_parser do |response|
+        parser do |response|
           response['areaClasses']['largeClasses'].map do |data|
             LargeClass.new(data)
           end
@@ -66,25 +62,17 @@ module RakutenWebService
 
         attr_reader :parent, :children
 
-        def initialize(data, parent=nil)
+        def initialize(class_data, parent = nil)
           @parent = parent
-          class_data = data
-          @params, @children = *(case class_data
-                              when Array
-                                class_data.first(2)
-                              when Hash
-                                [class_data, nil]
-                              end)
-
-          if !(children.nil?) and !(children.empty?)
-            children_class = children.keys.map { |k| k[/\A(\w*)Classes\Z/, 1] }.first rescue data.tapp
-            @params["#{children_class}Classes"] = children["#{children_class}Classes"].map do |child_data|
-              Base.area_classes[children_class].new(child_data["#{children_class}Class"], self)
-            end
-            @children = @params["#{children_class}Classes"]
-          else
-            @children = []
+          case class_data
+          when Array
+            @params = class_data.shift
+            @children = class_data.shift
+          when Hash
+            @params = class_data
+            @children = nil
           end
+          parse_children_attributes
         end
 
         def area_level
@@ -105,11 +93,24 @@ module RakutenWebService
           query
         end
 
-        def search(params={})
+        def search(params = {})
           params = to_query.merge(params)
 
           Hotel.search(params)
         end
+
+        private
+
+        def parse_children_attributes
+          return @children = [] if children.nil? || children.empty?
+
+          children_class = children.keys.first[/\A(\w*)Classes\Z/, 1]
+          class_name = "#{children_class}Classes"
+          params[class_name] = children[class_name].map do |child_data|
+            Base.area_classes[children_class].new(child_data["#{children_class}Class"], self)
+          end
+          @children = params[class_name]
+        end
       end
 
       class LargeClass < Base

data/lib/rakuten_web_service/travel/hotel.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rakuten_web_service/travel/resource'
 
 module RakutenWebService
@@ -5,7 +7,7 @@ module RakutenWebService
     class Hotel < RakutenWebService::Travel::Resource
       endpoint 'https://app.rakuten.co.jp/services/api/Travel/SimpleHotelSearch/20170426'
 
-      set_parser do |response|
+      parser do |response|
         response['hotels'].map do |hotel_info|
           Hotel.new(hotel_info)
         end

data/lib/rakuten_web_service/travel/search_result.rb

@@ -16,7 +16,7 @@ module RakutenWebService
         end
       end
 
-      def has_next_page?
+      def next_page?
         (page < page_count)
       end
 

data/lib/rakuten_web_service/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RakutenWebService
-  VERSION = '1.10.0'.freeze
+  VERSION = '1.13.1'
 end

data/lib/rakuten_web_service.rb

@@ -1,6 +1,22 @@
 # frozen_string_literal: true
 
-module RakutenWebService; end
+require 'rakuten_web_service/configuration'
+
+module RakutenWebService
+  def configure(&block)
+    raise ArgumentError, 'Block is required' unless block
+    raise ArgumentError, 'Block is required to have one argument' if block.arity != 1
+    yield configuration
+
+    configuration
+  end
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  module_function :configure, :configuration
+end
 RWS = RakutenWebService
 
 require 'rakuten_web_service/ichiba'

data/rakuten_web_service.gemspec

@@ -15,12 +15,14 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files`.split($/)
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.3.0'
+  spec.required_ruby_version = '>= 2.5.0'
 
+  spec.add_dependency 'json', '~> 2.3'
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake', '~> 12.3.0'
-  spec.add_development_dependency 'rspec', '~> 3.8.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rexml', '~> 3.2'
+  spec.add_development_dependency 'rspec', '~> 3.9'
   spec.add_development_dependency 'tapp', '~> 1.5.1'
   spec.add_development_dependency 'terminal-table', '~> 1.8.0'
-  spec.add_development_dependency 'webmock', '~> 3.5.0'
+  spec.add_development_dependency 'webmock', '~> 3.9'
 end

data/spec/fixtures/ichiba/item_search_with_no_items.json

@@ -0,0 +1,8 @@
+{
+  "count": 0,
+  "page": 1,
+  "first": 0,
+  "last": 0,
+  "hits": 0,
+  "pageCount": 0
+}

data/spec/fixtures/ichiba/tag_search.json

@@ -0,0 +1,15 @@
+{
+  "tagGroups": [
+    {
+      "tags": [
+        {
+          "parentTagId": 0,
+          "tagName": "SS",
+          "tagId": 1000317
+        }
+      ],
+      "tagGroupId": 1000041,
+      "tagGroupName": "サイズ（S/M/L）"
+    }
+  ]
+}

data/spec/rakuten_web_service/configuration_spec.rb

@@ -23,58 +23,6 @@ describe RakutenWebService::Configuration do
     end
   end
 
-  describe '.configure' do
-    context 'given block has one arity' do
-      before do
-        RakutenWebService.configure do |c|
-          c.affiliate_id = 'dummy_affiliate_id'
-          c.application_id = 'dummy_application_id'
-        end
-      end
-
-      subject { RakutenWebService.configuration }
-
-      describe '#affiliate_id' do
-        subject { super().affiliate_id }
-        it { is_expected.to eq('dummy_affiliate_id') }
-      end
-
-      describe '#application_id' do
-        subject { super().application_id }
-        it { is_expected.to eq('dummy_application_id') }
-      end
-    end
-
-    context 'given block has more or less one arity' do
-      specify 'raise ArgumentError' do
-        expect do
-          RakutenWebService.configure do
-          end
-        end.to raise_error(ArgumentError)
-
-        expect do
-          RakutenWebService.configure do |c, _|
-            c.affiliate_id = 'dummy_affiliate_id'
-            c.application_id = 'dummy_application_id'
-          end
-        end.to raise_error(ArgumentError)
-      end
-    end
-  end
-
-  describe '.configuration' do
-    context 'When calling with a block' do
-      specify 'should show warning message' do
-        $stderr = StringIO.new
-        RakutenWebService.configuration do |c|
-          c.application_id = 'dummy_affiliate_id'
-        end
-        expect($stderr.string).to match(/Warning: /)
-        $stderr = STDERR
-      end
-    end
-  end
-
   describe '#debug_mode?' do
     let(:configuration) { RakutenWebService.configuration }
 

data/spec/rakuten_web_service/genre_spec.rb

@@ -42,7 +42,7 @@ describe RakutenWebService::BaseGenre do
 
     Class.new(RakutenWebService::BaseGenre) do
       endpoint "https://api.example.com/dummy_genre"
-      set_resource_name 'dummy_genre'
+      self.resource_name = 'dummy_genre'
       root_id 0
       attribute :dummyGenreId, :dummyGenreName, :genreLevel
     end

data/spec/rakuten_web_service/ichiba/item_spec.rb

@@ -130,6 +130,19 @@ describe RakutenWebService::Ichiba::Item do
     end
   end
 
+  describe '.search(no items)' do
+    before do
+      response = JSON.parse(fixture('ichiba/item_search_with_no_items.json'))
+      @expected_request = stub_request(:get, endpoint).with(query: expected_query).to_return(body: response.to_json)
+    end
+
+    subject { RakutenWebService::Ichiba::Item.search(keyword: 'Ruby').first(1) }
+    specify '' do
+      expect { subject }.to_not raise_error
+    end
+    it { is_expected.to eq [] }
+  end
+
   describe '.all' do
     before do
       response = JSON.parse(fixture('ichiba/item_search_with_keyword_Ruby.json'))

data/spec/rakuten_web_service/ichiba/tag_group_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'rakuten_web_service/ichiba/tag_group'
+
+describe RakutenWebService::Ichiba::TagGroup do
+  let(:endpoint) { 'https://app.rakuten.co.jp/services/api/IchibaTag/Search/20140222' }
+  let(:affiliate_id) { 'affiliate_id' }
+  let(:application_id) { 'application_id' }
+  let(:expected_query) do
+    {
+      affiliateId: affiliate_id,
+      applicationId: application_id,
+      formatVersion: '2',
+      tagId: '1000317'
+    }
+  end
+
+  before do
+    response = JSON.parse(fixture('ichiba/tag_search.json'))
+    @expected_request = stub_request(:get, endpoint).
+      with(query: expected_query).to_return(body: response.to_json)
+
+    RakutenWebService.configure do |c|
+      c.affiliate_id = affiliate_id
+      c.application_id = application_id
+    end
+  end
+
+  describe '.search' do
+    let(:expected_json) do
+      response = JSON.parse(fixture('ichiba/tag_search.json'))
+      response['tagGroups'][0]
+    end
+
+    before do
+      @tag_group = RakutenWebService::Ichiba::TagGroup.search({tagId: '1000317'}).first
+    end
+
+    subject { @tag_group }
+
+    specify 'should call the endpoint once' do
+      expect(@expected_request).to have_been_made.once
+    end
+
+    specify 'should be access by key' do
+      expect(subject['tagGroupId']).to eq(expected_json['tagGroupId'])
+      expect(subject['tag_group_id']).to eq(expected_json['tagGroupId'])
+    end
+  end
+
+  describe '#tags' do
+    let(:response) { JSON.parse(fixture('ichiba/tag_search.json')) }
+    let(:expected_tag) { response['tagGroups'][0]['tags'][0] }
+
+    before do
+      @tag_group = RakutenWebService::Ichiba::TagGroup.search(tagId: '1000317').first
+    end
+
+    subject { @tag_group.tags }
+
+    specify 'responds Tags object' do
+      subject.map do |tag|
+        expect(tag.id).to eq(expected_tag['tagId'])
+        expect(tag.name).to eq(expected_tag['tagName'])
+        expect(tag['parentTagId']).to eq(expected_tag['parentTagId'])
+      end
+    end
+  end
+end

data/spec/rakuten_web_service/ichiba/tag_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe RakutenWebService::Ichiba::Tag do
+  let(:params) do
+    { 'tagId' => 100,
+      'tagName' => 'SS',
+      'parentTagId' => 1 }
+  end
+  let(:tag) { RakutenWebService::Ichiba::Tag.new(params) }
+
+  describe '.new' do
+    specify 'returned object should have methods to fetch values' do
+      expect(tag.id).to eq(100)
+      expect(tag.name).to eq('SS')
+      expect(tag['parentTagId']).to eq(1)
+    end
+  end
+
+  describe '#search' do
+    context 'When no given additional parameters' do
+      specify 'it calls Ichiba::Item.search with its tag id' do
+        expect(RWS::Ichiba::Item).to receive(:search).with({tagId: params['tagId']}).and_return([])
+
+        tag.search
+      end
+    end
+    context 'When given required parameter' do
+      specify 'it calls Ichiba::Item.search with the given parameters and its tag id' do
+        expect(RWS::Ichiba::Item).to receive(:search).with({keyword: 'Ruby', tagId: params['tagId']}).and_return([])
+
+        tag.search(keyword: 'Ruby')
+      end
+    end
+  end
+end