rakuten_web_service 0.6.3 → 1.0.0.rc1

data/examples/books_item_search.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+#
+# This is a sample script f Rakuten Books APIs. 
+# RWS Ruby SDK supports Books API. The inteface is similar to ones Ichiba API. 
+# If you want to search CDs dealt in Rakuten Books, you can do it with `RakutenWebService::Books::CD`. 
+# As for other resources, there are `RakutenWebService::Books::Book`, `RakutenWebService::Books::DVD` and so on. 
+# Please refer to the following documents if you want more detail of input/output parameters: 
+#   http://webservice.rakuten.co.jp/document/
+#
+
+require 'rakuten_web_service'
+
+application_id = ARGV.shift
+keyword = ARGV[0..-1].join(' ')
+
+RakutenWebService.configure do |c|
+  c.application_id = application_id
+end
+
+cds = RakutenWebService::Books::CD.search(:title => keyword)
+
+cds.first(10).each do |cd|
+  puts "#{cd.title} (#{cd.title_kana}):\n\t #{cd.play_list}"
+end

data/examples/gora_search.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+#
+# This is a sample script f Rakuten Gora APIs.
+# RWS Ruby SDK supports Gora API. The inteface is similar to ones Ichiba API.
+# If you want to search courses dealt in Rakuten Gora, you can do it with `RakutenWebService::Gora::Course`.
+# As for other resources, there are `RakutenWebService::Gora::CourseDetail`, `RakutenWebService::Gora::Plan` and so on.
+# Please refer to the following documents if you want more detail of input/output parameters:
+#   http://webservice.rakuten.co.jp/document/
+#
+
+require 'rakuten_web_service'
+require 'date'
+
+application_id = ARGV.shift
+keyword = ARGV.shift || '軽井沢'
+
+RakutenWebService.configure do |c|
+  c.application_id = application_id
+end
+
+c = RakutenWebService::Gora::Course.search(:keyword => keyword).first
+id = c.golf_course_id
+puts id
+puts c.golf_course_name
+puts c.address
+
+d = RakutenWebService::Gora::CourseDetail.find(id)
+puts d.green
+puts d.green_count
+puts d.course_distance
+puts d.long_driving_contest
+puts d.near_pin
+puts d.evaluation
+d.new_plans.each do |p|
+  puts "  #{p.month}: #{p.name}"
+end
+
+next_week = Date.today + 7
+chiba_and_kanagawa = '12,14'
+plans = RWS::Gora::Plan.search(:areaCode => chiba_and_kanagawa, :playDate => next_week.strftime('%Y-%m-%d'))
+plans.first(5).each { |p|
+  puts "#{p.golf_course_id}, #{p.golf_course_name}"
+  p.plan_info.each { |pi|
+    puts "  #{pi.plan_id}, #{pi.plan_name}, #{pi.price}"
+    ci = pi.call_info
+    puts "    #{ci.play_date}, #{ci.stock_status}"
+  }
+}

data/examples/ichiba_item_search.rb

@@ -1,11 +1,9 @@
-# encoding: utf-8
-
 require 'rakuten_web_service'
 
 application_id = ARGV.shift
 keyword = ARGV[0..-1].join(' ')
 
-RakutenWebService.configuration do |c|
+RakutenWebService.configure do |c|
   c.application_id = application_id
 end
 

data/lib/rakuten_web_service.rb

@@ -4,3 +4,5 @@ RWS = RakutenWebService
 require 'rakuten_web_service/ichiba'
 require 'rakuten_web_service/books'
 require 'rakuten_web_service/kobo'
+require 'rakuten_web_service/gora'
+require 'rakuten_web_service/recipe'

data/lib/rakuten_web_service/all_proxy.rb

@@ -0,0 +1,20 @@
+module RakutenWebService
+  class AllProxy
+    include Enumerable
+
+    def initialize(search_result)
+      @search_result = search_result
+    end
+
+    def each
+      search_result = @search_result
+      loop do
+        search_result.each do |resource|
+          yield resource
+        end
+        break unless search_result.has_next_page?
+        search_result = search_result.next_page
+      end
+    end
+  end
+end

data/lib/rakuten_web_service/client.rb

@@ -1,3 +1,4 @@
+require 'uri'
 require 'faraday'
 require 'faraday_middleware'
 
@@ -20,10 +21,9 @@ module RakutenWebService
       @path = url.path
     end
 
-    def get(query)
-      query = RakutenWebService.configuration.generate_parameters.merge(query)
-      query = convert_snake_key_to_camel_key(query)
-      response = connection.get(path, query)
+    def get(params)
+      params = RakutenWebService.configuration.generate_parameters(params)
+      response = connection.get(path, params)
       case response.status
       when 200
         return RakutenWebService::Response.new(@resource_class, response.body)
@@ -46,16 +46,9 @@ module RakutenWebService
       @connection = Faraday.new(:url => url) do |conn|
         conn.request :url_encoded
         conn.response :json
+        conn.response :logger if RakutenWebService.configuration.debug
         conn.adapter Faraday.default_adapter
-        conn.headers['User-Agent'] = "RakutenWebService SDK for Ruby-#{RWS::VERSION}"
-      end
-    end
-
-    def convert_snake_key_to_camel_key(params)
-      params.inject({}) do |h, (k, v)|
-        k = k.to_s.gsub(/([a-z]{1})_([a-z]{1})/) { "#{$1}#{$2.capitalize}" }
-        h[k] = v
-        h
+        conn.headers['User-Agent'] = "RakutenWebService SDK for Ruby v#{RWS::VERSION}(ruby-#{RUBY_VERSION} [#{RUBY_PLATFORM}])"
       end
     end
   end

data/lib/rakuten_web_service/configuration.rb

@@ -1,17 +1,36 @@
+require 'logger'
+
 module RakutenWebService
   class Configuration
-    attr_accessor :application_id, :affiliate_id, :max_retries
+    attr_accessor :application_id, :affiliate_id, :max_retries, :debug
 
     def initialize
       @max_retries = 5
     end
 
-    def generate_parameters
+    def generate_parameters(params)
+      convert_snake_key_to_camel_key(default_parameters.merge(params))
+    end
+
+    def default_parameters 
       { :application_id => application_id, :affiliate_id => affiliate_id }
     end
+
+    def debug_mode?
+      ENV.has_key?('RWS_SDK_DEBUG') || debug
+    end
+
+    private
+    def convert_snake_key_to_camel_key(params)
+      params.inject({}) do |h, (k, v)|
+        k = k.to_s.gsub(/([a-z]{1})_([a-z]{1})/) { "#{$1}#{$2.capitalize}" }
+        h[k] = v
+        h
+      end
+    end
   end
 
-  def configuration(&block)
+  def configure(&block)
     @configuration ||= Configuration.new
     if block
       if block.arity != 1
@@ -22,5 +41,10 @@ module RakutenWebService
     return @configuration
   end
 
-  module_function :configuration
+  def configuration(&block)
+    $stderr.puts "Warning: RakutenWebService.configuration is deprecated. Use RakutenWebService.configure." if block_given?
+    self.configure(&block)
+  end
+
+  module_function :configure, :configuration
 end

data/lib/rakuten_web_service/gora.rb

@@ -0,0 +1,3 @@
+require 'rakuten_web_service/gora/course'
+require 'rakuten_web_service/gora/course_detail'
+require 'rakuten_web_service/gora/plan'

data/lib/rakuten_web_service/gora/course.rb

@@ -0,0 +1,17 @@
+require 'rakuten_web_service/resource'
+
+module RakutenWebService
+  module Gora
+    class Course < Resource
+      endpoint 'https://app.rakuten.co.jp/services/api/Gora/GoraGolfCourseSearch/20131113'
+
+      set_parser do |response|
+        response['Items'].map { |item| self.new(item['Item']) }
+      end
+
+      attribute :golfCourseId, :golfCourseName, :golfCourseAbbr, :golfCourseNameKana, :golfCourseCaption,
+                :address, :latitude, :longitude, :highway, :golfCourseDetailUrl, :reserveCalUrl, :ratingUrl,
+                :golfCourseImageUrl, :evaluation
+    end
+  end
+end

data/lib/rakuten_web_service/gora/course_detail.rb

@@ -0,0 +1,55 @@
+require 'rakuten_web_service/resource'
+
+module RakutenWebService
+  module Gora
+    class CourseDetail < Resource
+      class << self
+        def find(golf_course_id)
+          search({golfCourseId: golf_course_id}).first
+        end
+      end
+
+      endpoint 'https://app.rakuten.co.jp/services/api/Gora/GoraGolfCourseDetail/20140410'
+
+      set_parser do |response|
+        [self.new(response['Item'])]
+      end
+
+      attribute :carrier, :golfCourseId, :golfCourseName, :golfCourseAbbr, :golfCourseNameKana, :golfCourseCaption,
+                :information, :highway, :ic, :icDistance, :latitude, :longitude, :postalCode, :address, :telephoneNo,
+                :faxNo, :openDay, :closeDay, :creditCard, :shoes, :dressCode, :practiceFacility, :lodgingFacility,
+                :otherFacility, :golfCourseImageUrl1, :golfCourseImageUrl2, :golfCourseImageUrl3, :golfCourseImageUrl4,
+                :golfCourseImageUrl5, :weekdayMinPrice, :baseWeekdayMinPrice, :holidayMinPrice, :baseHolidayMinPrice,
+                :designer, :courseType, :courseVerticalInterval, :dimension, :green, :greenCount, :holeCount, :parCount,
+                :courseName, :courseDistance, :longDrivingContest, :nearPin, :ratingNum, :evaluation, :staff, :facility,
+                :meal, :course, :costperformance, :distance, :fairway, :reserveCalUrl, :voiceUrl, :layoutUrl, :routeMapUrl
+
+      def ratings
+        get_attribute('ratings').map {|rating| Rating.new(rating['rating'])}
+      end
+
+      def new_plans
+        get_attribute('newPlans').map {|plan| Plan.new(plan['plan'])}
+      end
+
+      class Rating < Resource
+        class << self
+          def search(options)
+            raise 'There is no API endpoint for this resource.'
+          end
+        end
+        attribute :title, :nickName, :prefecture, :age, :sex, :times, :evaluation, :staff, :facility, :meal, :course,
+                  :costperformance, :distance, :fairway, :comment
+      end
+
+      class Plan < Resource
+        class << self
+          def search(options)
+            raise 'There is no API endpoint for this resource.'
+          end
+        end
+        attribute :month, :planName, :planDate, :service, :price, :basePrice, :salesTax, :courseUseTax, :otherTax
+      end
+    end
+  end
+end

data/lib/rakuten_web_service/gora/plan.rb

@@ -0,0 +1,47 @@
+require 'rakuten_web_service/resource'
+
+module RakutenWebService
+  module Gora
+    class Plan < Resource
+      endpoint 'https://app.rakuten.co.jp/services/api/Gora/GoraPlanSearch/20150706'
+
+      set_parser do |response|
+        response['Items'].map { |item| self.new(item['Item']) }
+      end
+
+      attribute :golfCourseId, :golfCourseName, :golfCourseAbbr, :golfCourseNameKana, :golfCourseCaption,
+                :address, :latitude, :longitude, :highway, :golfCourseDetailUrl, :reserveCalUrl, :ratingUrl,
+                :golfCourseImageUrl, :evaluation
+
+      def plan_info
+        get_attribute('planInfo').map {|plan| PlanInfo.new(plan['plan'])}
+      end
+
+      class PlanInfo < Resource
+        class << self
+          def search(options)
+            raise 'There is no API endpoint for this resource.'
+          end
+        end
+        attribute :planId, :planName, :planType, :limitedTimeFlag, :price, :basePrice, :salesTax, :courseUseTax,
+                  :otherTax, :playerNumMin, :playerNumMax, :startTimeZone, :round, :caddie, :cart, :assu2sum,:addFee2bFlag,
+                  :addFee2b, :assortment2bFlag, :addFee3bFlag, :addFee3b, :assortment3bFlag, :discount4sumFlag, :lunch,
+                  :drink, :stay, :lesson, :planOpenCompe, :compePlayGroupMin, :compePlayMemberMin, :compePrivilegeFree,
+                  :compeOption, :other, :pointFlag, :point
+
+        def call_info
+          CallInfo.new(get_attribute('callInfo'))
+        end
+
+        class CallInfo < Resource
+          class << self
+            def search(options)
+              raise 'There is no API endpoint for this resource.'
+            end
+          end
+          attribute :playDate, :stockStatus, :stockCount, :reservePageUrlPC, :reservePageUrlMobile
+        end
+      end
+    end
+  end
+end

data/lib/rakuten_web_service/ichiba/item.rb

@@ -8,8 +8,8 @@ module RakutenWebService
           RakutenWebService::Ichiba::RankingItem.search(options)
         end
       end
-      
-      endpoint 'https://app.rakuten.co.jp/services/api/IchibaItem/Search/20130805'
+
+      endpoint 'https://app.rakuten.co.jp/services/api/IchibaItem/Search/20140222'
 
       set_parser do |response|
         response['Items'].map { |item| Item.new(item['Item']) }
@@ -27,7 +27,7 @@ module RakutenWebService
         :startTime, :endTime,
         :reviewCount, :reviewAverage,
         :pointRate, :pointRateStartTime, :pointRateEndTime,
-        :shopName, :shopCode, :shopUrl,
+        :shopName, :shopCode, :shopUrl, :shopAffiliateUrl,
         :genreId
 
       def genre
@@ -38,7 +38,8 @@ module RakutenWebService
         Shop.new({
           'shopName' => self.shop_name,
           'shopCode' => self.shop_code,
-          'shopUrl' => self.shop_url
+          'shopUrl' => self.shop_url,
+          'shopAffiliateUrl' => self.shop_affiliate_url
         })
       end
     end

data/lib/rakuten_web_service/ichiba/shop.rb

@@ -4,7 +4,7 @@ require 'rakuten_web_service/ichiba/item'
 module RakutenWebService
   module Ichiba
     class Shop < Resource
-      attribute :shopName, :shopCode, :shopUrl
+      attribute :shopName, :shopCode, :shopUrl, :shopAffiliateUrl
 
       def items(options={})
         options = options.merge(:shop_code => self.code)

data/lib/rakuten_web_service/kobo/ebook.rb

@@ -5,9 +5,9 @@ require 'rakuten_web_service/resource'
 module RakutenWebService
   module Kobo
     class Ebook < RakutenWebService::Resource
-      endpoint 'https://app.rakuten.co.jp/services/api/Kobo/EbookSearch/20131010'
+      endpoint 'https://app.rakuten.co.jp/services/api/Kobo/EbookSearch/20140811'
 
-      attribute :title, :titleKana, :subTitle,
+      attribute :title, :titleKana, :subTitle, :seriesName,
         :author, :authorKana, :publisherName,
         :itemNumber, :itemCaption,
         :salesDate, :itemPrice,

data/lib/rakuten_web_service/recipe.rb

@@ -0,0 +1,28 @@
+require 'rakuten_web_service/configuration'
+
+require 'rakuten_web_service/recipe/category'
+
+module RakutenWebService
+  class Recipe < Resource
+    endpoint 'https://app.rakuten.co.jp/services/api/Recipe/CategoryRanking/20121121'
+
+    attribute :recipeId, :recipeTitle, :recipeUrl,
+      :foodImageUrl, :mediumImageUrl, :smallImageUrl,
+      :pickup, :shop, :nickname,
+      :recipeDescription, :recipeMaterial,
+      :recipeIndication, :recipeCost,
+      :recipePublishday, :rank
+
+    set_parser do |response|
+      response['result'].map { |r| Recipe.new(r) }
+    end
+
+    def self.ranking(category)
+      self.search(category_id: category)
+    end
+
+    class << self
+      protected :search
+    end
+  end
+end

data/lib/rakuten_web_service/recipe/category.rb

@@ -0,0 +1,60 @@
+module RakutenWebService
+  class Recipe < Resource
+
+    def self.large_categories
+      categories('large')
+    end
+
+    def self.medium_categories
+      categories('medium')
+    end
+
+    def self.small_categories
+      categories('small')
+    end
+
+    def self.categories(category_type)
+      @categories ||= {}
+      @categories[category_type] ||= Category.search(category_type: category_type).response['result'][category_type].map do |category|
+        Category.new(category.merge(categoryType: category_type))
+      end
+    end
+
+    class << self
+      protected :search
+    end
+
+    class Category < Resource
+      endpoint 'https://app.rakuten.co.jp/services/api/Recipe/CategoryList/20121121'
+
+      attribute :categoryId, :categoryName, :categoryUrl, :parentCategoryId, :categoryType
+
+      def ranking
+        Recipe.ranking(absolute_category_id)
+      end
+
+      def parent_category
+        return nil if parent_category_type.nil?
+        Recipe.categories(parent_category_type).find { |c| c.id.to_i === parent_category_id.to_i }
+      end
+
+      def absolute_category_id
+        if parent_category
+          [parent_category.absolute_category_id, id.to_s].join('-')
+        else
+          id.to_s
+        end
+      end
+
+      private
+        def parent_category_type
+          case type
+          when 'small' then 'medium'
+          when 'medium' then 'large'
+          else
+            nil
+          end
+        end
+    end
+  end
+end