rakumarket 0.0.3 → 0.1.0

data/lib/rakumarket/client.rb

@@ -1,89 +1,148 @@
+# -*- encoding: utf-8 -*-
 module Rakumarket
-  class Client
+  class Client < Spitter
     attr_accessor :developer_id
     include HTTParty
     base_uri "http://api.rakuten.co.jp/rws/3.0"
     format :json
 
-    def initialize(options={})
-      @developer_id = options[:developer_id] || Rakumarket.developer_id
+    parameter :developer_id => 'developerId'
+
+    def self.request(params) new(params).request end
+
+    def initialize(params={})
+      @developer_id = params[:developer_id] || Rakumarket.developer_id
+      super params.merge(default_options)
     end
 
-    def request(query={})
-      @options = default_options.merge(query).slice(*valid_request_keys)
-      transform_request!
-      @response = self.class.get("/json",:query => @options)
-      respond
+    def request
+      @response = self.class.get("/json", :query => parse)
     end
 
 private
-    def transform_request!
-      transform_request_keys!
-      transform_request_values!
+    def default_options 
+      { :developer_id => @developer_id,
+        :operation => nil, 
+        :version => nil }
     end
 
-    def transform_request_keys!
-      transform_keys! @options, request_keys_to_transform
-    end
+    def self.get(*args); handle_response super end
+    def self.post(*args); handle_response super end
 
-    def transform_request_values!
-      transform_values! @options, request_values_to_transform
+    def self.handle_response(response)
+      case response["Header"]["Status"]
+      when "Success"; response
+      else; raise RakumarketError.new({:status => response["Header"]["Status"], :status_msg => response["Header"]["StatusMsg"]})
+      end
+      response
     end
+  end
 
-    def respond
-      transform_response!
+  class TrueToOne
+    def self.parse value
+      value ? "1" : "0"
     end
+  end
 
-    def transform_response!
-      transform_response_values!
-      transform_response_keys!
+  class TrueToZero
+    def self.parse value
+      value ? "0" : "1"
     end
+  end
 
-    def transform_response_keys!
-      transform_keys! @response, response_keys_to_transform
-    end
+  class ItemSearchClient < Client
+
+    OPERATION = "ItemSearch"
+    VERSION = "2010-09-15"
 
-    def transform_response_values!
-      transform_values! @response, response_values_to_transform
+    class SortOrder
+      def self.parse(value) ITEM_SEARCH_SORT_ORDERS[value.downcase] end
     end
 
-    def request_keys_to_transform; {} end
-    def request_values_to_transform; {} end
-    def response_keys_to_transform; {} end
-    def response_values_to_transform; {} end
+    class CountryCode
+      def self.parse(value) INTERNATIONAL_DELIVERY_AREA_CODES[value] end
+    end
 
-    def transform_keys! hash, transformation_index
-      transformation_index.each do |k,v|
-        hash[v] = hash.delete(k) if hash.has_key?(k)
-      end
-      hash
+    class NextDayAreaCode
+      def self.parse(value) ASURAKU_DELIVERY_AREA_CODES[value] end
     end
 
-    def transform_values! hash, transformation_index
-      transformation_index.each do |k,v|
-        hash[k] = v[hash[k]] if hash.has_key?(k) && v.has_key?(hash[k])
+    class PurchaseType
+      def self.parse(value)
+        {"normal" => 0, "regular" => 1, "distribution" => 2}[value]
       end
-      hash
     end
 
-    def custom_transform(hash,key)
-      yield hash, key if block_given? && hash.has_key?(key)
+    parameter :operation, :with => lambda { OPERATION }
+    parameter :version, :with => lambda { VERSION }
+    parameter :keyword
+    parameter :page
+    parameters :price do
+      parameter :minimum => 'minPrice'
+      parameter :maximum => 'maxPrice'
     end
-    def custom_transform!(hash,key)
-      hash[key] = yield hash, key if block_given? && hash.has_key?(key)
+    parameters :shipping do
+      parameter :must_ship_international => 'shipOverseasFlag', :with => TrueToOne
+      parameter :country => 'shipOverseasArea', :with => CountryCode
+      parameter :must_ship_next_day => 'asurakuFlag', :with => TrueToOne
+      parameter :next_day_area => 'asurakuArea', :with => NextDayAreaCode
+      parameter :must_include_cost => 'postageFlag', :with => TrueToOne
+    end
+    parameter :affiliate_id => 'affiliateId'
+    parameter :call_back => 'callBack'
+    parameter :items_per_page => 'hits'
+    parameter :shop_code => 'shopCode'
+    parameter :genre_id => 'genreId'
+    parameter :order => 'sort', :with => SortOrder
+    parameter :must_be_available => 'availability', :with => TrueToOne
+    parameter :deep_search => 'field', :with => TrueToZero
+    parameter :mobile => 'carrier', :with => TrueToOne
+    parameter :must_have_image => 'imageFlag', :with => TrueToOne
+    parameter :or_search => 'orFlag', :with => TrueToOne
+    parameter :exclude_keyword => 'NGKeyword'
+    parameter :include_genre_info => 'genreInformationFlag', :with => TrueToOne
+    parameter :purchase_type => 'purchaseType', :with => PurchaseType
+    parameter :must_have_point_multiplication => 'pointRateFlag', :with => TrueToOne
+    parameter :point_multiplication_factor => 'pointRate'
+    parameter :must_accept_credit_cards => 'creditCardFlag', :with => TrueToOne
+
+    def request
+      response = super
+      ItemList.parse(response)
     end
 
-    def self.get(*args); handle_response super end
-    def self.post(*args); handle_response super end
+  end
 
-    def self.handle_response(response)
-      case response["Header"]["Status"]
-      when "Success"; response
-      else; raise RakumarketError.new(Hashie::Mash.new({:status => response["Header"]["Status"], :status_msg => response["Header"]["StatusMsg"]}))
-      end
+  class GenreSearchClient < Client
 
-      Hashie::Mash.new(response)
+    OPERATION = "GenreSearch"
+    VERSION = "2007-04-11"
 
+    parameter :operation, :with => lambda { OPERATION }
+    parameter :version, :with => lambda { VERSION }
+    parameter :genre_id => 'genreId'
+    parameter :return_immediate_parent => 'genrePath', :with => TrueToZero
+
+    def request
+      response = super
+      Genre.parse(response)
+    end
+
+  end
+
+  class ItemLookupClient < Client
+    OPERATION = "ItemCodeSearch"
+    VERSION = "2010-08-05"
+
+    parameter :operation, :with => lambda { OPERATION }
+    parameter :version, :with => lambda { VERSION }
+    parameter :code => 'itemCode'
+    parameter :mobile => 'carrier', :with => TrueToOne
+
+    def request
+      response = super
+      Item.parse(response)
     end
   end
+
 end

data/lib/rakumarket/constants.rb

@@ -0,0 +1,222 @@
+# -*- encoding: utf-8 -*-
+module Rakumarket
+
+  INTERNATIONAL_DELIVERY_AREA_CODES = {
+    "worldwide" => "ALL",
+    "usa" => "US",
+    "argentina" => "AR",
+    "brazil" => "BR",
+    "canada" => "CA",
+    "mexico" => "MX",
+    "austria" => "AT",
+    "belgium" => "BE",
+    "denmark" => "DK",
+    "france" => "FR",
+    "germany" => "DE",
+    "greece" => "GR",
+    "italy" => "IT",
+    "morocco" => "MA",
+    "netherlands" => "NL",
+    "poland" => "PL",
+    "portugal" => "PT",
+    "russia" => "RU",
+    "spain" => "ES",
+    "sweden" => "SE",
+    "switzerland" => "CH",
+    "turkey" => "TR",
+    "england" => "GB",
+    "australia" => "AU",
+    "china" => "CN",
+    "hong kong" => "HK",
+    "india" => "IN",
+    "indonesia" => "ID",
+    "south korea" => "KR",
+    "malaysia" => "MY",
+    "new zealand" => "NZ",
+    "philipines" => "PH",
+    "singapore" => "SG",
+    "taiwan" => "TW",
+    "thailand" => "TH",
+    "vietnam" => "VN"
+  }
+
+  INTERNATIONAL_DELIVERY_AREA_NAMES = {
+    "ワールドワイド" => "worldwide",
+    "アメリカ" => "usa",
+    "アルゼンチン" => "argentina",
+    "ブラジル" => "brazil",
+    "カナダ" => "canada",
+    "メキシコ" => "mexico",
+    "オーストリア" => "austria",
+    "ベルギー" => "belgium",
+    "デンマーク" => "denmark",
+    "フランス" => "france",
+    "ドイツ" => "germany",
+    "ギリシャ" => "greece",
+    "イタリア" => "italy",
+    "モロッコ" => "morocco",
+    "オランダ" => "netherlands",
+    "ポーランド" => "poland",
+    "ポルトガル" => "portugal",
+    "ロシア" => "russia",
+    "スペイン" => "spain",
+    "スウェーデン" => "sweden",
+    "スイス" => "switzerland",
+    "トルコ" => "turkey",
+    "英国" => "england",
+    "オーストラリア" => "australia",
+    "中国" => "china",
+    "香港" => "hong kong",
+    "インド" => "india",
+    "インドネシア" => "indonesia",
+    "韓国" => "south korea",
+    "マレーシア" => "malaysia",
+    "ニュージーランド" => "new zealand",
+    "フィリピン" => "philipines",
+    "シンガポール" => "singapore",
+    "台湾" => "taiwan",
+    "タイ" => "thailand",
+    "ベトナム" => "vietnam",
+  }
+
+  ASURAKU_DELIVERY_AREA_CODES = {
+    "all" => "0",
+    "hokkaido" => "1",
+    "tohoku" => "101",
+    "aomori" => "2",
+    "iwate" => "3",
+    "miyagi" => "4",
+    "akita" => "5",
+    "yamagata" => "6",
+    "fukushima" => "7",
+    "kanto" => "102",
+    "ibaraki" => "8",
+    "tochigi" => "9",
+    "gunma" => "10",
+    "saitama" => "11",
+    "chiba" => "12",
+    "tokyo" => "13",
+    "kanagawa" => "14",
+    "koshinetsu" => "103",
+    "niigata" => "15",
+    "yamanashi" => "19",
+    "nagano" => "20",
+    "hokuriku" => "104",
+    "toyama" => "16",
+    "ishikawa" => "17",
+    "fukui" => "18",
+    "tokai" => "105",
+    "gifu" => "21",
+    "shizuoka" => "22",
+    "aichi" => "23",
+    "mie" => "24",
+    "kansai" => "106",
+    "shiga" => "25",
+    "kyoto" => "26",
+    "osaka" => "27",
+    "hyogo" => "28",
+    "nara" => "29",
+    "wakayama" => "30",
+    "chugoku" => "107",
+    "tottori" => "31",
+    "shimane" => "32",
+    "okayama" => "33",
+    "hiroshima" => "34",
+    "yamaguchi" => "35",
+    "shikoku" => "108",
+    "tokushima" => "36",
+    "kagawa" => "37",
+    "ehime" => "38",
+    "kochi" => "39",
+    "kyushu" => "109",
+    "fukuoka" => "40",
+    "saga" => "41",
+    "nagasaki" => "42",
+    "kumamoto" => "43",
+    "ooita" => "44",
+    "miyaza" => "45",
+    "kagoshima" => "46",
+    "okinawa" => "47"
+  }
+
+  ASURAKU_DELIVERY_AREA_NAMES = {
+    "全地域" => "all",
+    "北海道エリアのすべて" => "hokkaido",
+    "北海道" => "hokkaido",
+    "東北エリアのすべて" => "tohoku",
+    "青森県" => "aomori",
+    "岩手県" => "iwate",
+    "宮城県" => "miyagi",
+    "秋田県" => "akita",
+    "山形県" => "yamagata",
+    "福島県" => "fukushima",
+    "関東エリアのすべて" => "kanto",
+    "茨城県" => "ibaraki",
+    "栃木県" => "tochigi",
+    "群馬県" => "gunma",
+    "埼玉県" => "saitama",
+    "千葉県" => "chiba",
+    "東京都" => "tokyo",
+    "神奈川県" => "kanagawa",
+    "甲信越エリアのすべて" => "koshinetsu",
+    "新潟県" => "niigata",
+    "山梨県" => "yamanashi",
+    "長野県" => "nagano",
+    "北陸エリアのすべて" => "hokuriku",
+    "富山県" => "toyama",
+    "石川県" => "ishikawa",
+    "福井県" => "fukui",
+    "東海エリアのすべて" => "tokai",
+    "岐阜県" => "gifu",
+    "静岡県" => "shizuoka",
+    "愛知県" => "aichi",
+    "三重県" => "mie",
+    "関西エリアのすべて" => "kansai",
+    "滋賀県" => "shiga",
+    "京都府" => "kyoto",
+    "大阪府" => "osaka",
+    "兵庫県" => "hyogo",
+    "奈良県" => "nara",
+    "和歌山県" => "wakayama",
+    "中国エリアのすべて" => "chugoku",
+    "鳥取県" => "tottori",
+    "島根県" => "shimane",
+    "岡山県" => "okayama",
+    "広島県" => "hiroshima",
+    "山口県" => "yamaguchi",
+    "四国エリアのすべて" => "shikoku",
+    "徳島県" => "tokushima",
+    "香川県" => "kagawa",
+    "愛媛県" => "ehime",
+    "高知県" => "kochi",
+    "九州エリアのすべて" => "kyushu",
+    "福岡県" => "fukuoka",
+    "佐賀県" => "saga",
+    "長崎県" => "nagasaki",
+    "熊本県" => "kumamoto",
+    "大分県" => "ooita",
+    "宮崎県" => "miyaza",
+    "鹿児島県" => "kagoshima",
+    "沖縄エリアのすべて" => "okinawa",
+    "沖縄県" => "okinawa"
+  }
+
+  ITEM_SEARCH_SORT_ORDERS = { 
+    "affiliate_rate" => "+affiliateRate",
+    "affiliate_rate asc" => "+affiliateRate",
+    "affiliate_rate desc" => "-affiliateRate",
+    "review_count" => "+reviewCount",
+    "review_count asc" => "+reviewCount",
+    "review_count desc" => "-reviewCount",
+    "review_average" => "+reviewAverage",
+    "review_average asc" => "+reviewAverage",
+    "review_average desc" => "-reviewAverage",
+    "price" => "+itemPrice",
+    "price asc" => "+itemPrice",
+    "price desc" => "-itemPrice",
+    "updated_at" => "+updateTimestamp",
+    "updated_at asc" => "+updateTimestamp",
+    "updated_at desc" => "-updateTimestamp" 
+  }
+
+end

data/lib/rakumarket/models.rb

@@ -0,0 +1,125 @@
+# -*- encoding: utf-8 -*-
+
+module Rakumarket
+  class Base < NibblerJSON
+  end
+
+  class OneToTrue
+    def self.parse(val) {"1" => true, "0" => false}[val.to_s] end
+  end
+
+  class ZeroToTrue
+    def self.parse(val) {"0" => true, "1" => false}[val.to_s] end
+  end
+
+  class ParseTime < Time
+    def self.parse(val) super unless val.blank? end
+  end
+
+  class InternationalDeliveryCountryList
+    def self.parse(val)
+      val.split('/').map{|a| INTERNATIONAL_DELIVERY_AREA_NAMES[a] || a} if val.respond_to?(:split)
+    end
+  end
+
+  class NextDayAreaList
+    def self.parse(val)
+      val.split('/').map{|a| ASURAKU_DELIVERY_AREA_NAMES[a] || a} if val.respond_to?(:split)
+    end
+  end
+
+  class Shipping < Base
+    element 'postageFlag' => :cost_included, :with => ZeroToTrue
+    element 'shipOverseasFlag' => :international, :with => OneToTrue
+    element 'shipOverseasArea' => :countries, :with => InternationalDeliveryCountryList
+    element 'asurakuFlag' => :next_day, :with => OneToTrue
+    element 'asurakuArea' => :next_day_areas, :with => NextDayAreaList
+
+    def cost_included?; cost_included end
+    def international?; international end
+    def next_day?; next_day end
+  end
+
+  class Item < Base
+    element 'itemName' => :name
+    element 'catchcopy' => :catchphrase
+    element 'itemCode' => :code
+    element 'itemPrice' => :price
+    element 'itemCaption' => :caption
+    element 'itemUrl' => :url
+    element 'genreId' => :genre_id
+    element 'affiliateUrl' => :affiliate_url
+    element 'imageFlag' => :has_image, :with => OneToTrue
+    element 'smallImageUrl' => :small_image_url
+    element 'mediumImageUrl' => :medium_image_url
+    element 'availability' => :available, :with => OneToTrue
+    element 'taxFlag' => :tax_included, :with => ZeroToTrue
+    element 'creditCardFlag' => :credit_cards_accepted, :with => OneToTrue
+    element 'shopOfTheYearFlag' => :shop_of_the_year, :with => OneToTrue
+    element 'affiliateRate' => :affiliate_rate
+    element 'startTime' => :start_time, :with => ParseTime
+    element 'endTime' => :end_time, :with => ParseTime
+    element 'reviewCount' => :review_count
+    element 'reviewAverage' => :review_average
+    element 'pointRate' => :point_multiplication_factor
+    element 'pointRateStartTime' => :point_multiplication_start_time, :with => ParseTime
+    element 'pointRateEndTime' => :point_multiplication_end_time, :with => ParseTime
+    element :shop do
+      element 'shopName' => :name
+      element 'shopCode' => :code
+      element 'shopUrl' => :url
+    end
+    element :shipping, :with => Shipping
+
+    def has_image?; has_image end
+    def available?; available end
+    def tax_included?; tax_included end
+    def credit_cards_accepted?; credit_cards_accepted end
+    def shop_of_the_year?; shop_of_the_year end
+
+    def self.parse(response)
+      response = response.dup['Body']['ItemCodeSearch']['Items']['Item'].first if response['Body'] && response['Body']['ItemCodeSearch']
+      response['shop'] = {
+        'shopName' => response.delete('shopName'),
+        'shopCode' => response.delete('shopCode'),
+        'shopUrl' => response.delete('shopUrl')
+      }
+      response['shipping'] = {
+        'postageFlag' => response.delete('postageFlag'),
+        'shipOverseasFlag' => response.delete('shipOverseasFlag'),
+        'shipOverseasArea' => response.delete('shipOverseasArea'),
+        'asurakuFlag' => response.delete('asurakuFlag'),
+        'asurakuArea' => response.delete('asurakuArea')
+      }
+      super(response)
+    end
+  end
+
+  class ItemList < Base
+    element 'count' => :total_item_count
+    element 'pageCount' => :page_count
+    element :page
+    elements :items, :with => Item
+
+    def self.parse(response)
+      response = response.dup['Body']['ItemSearch']
+      response['items'] = response.delete('Items')['Item']
+      super(response)
+    end
+  end
+
+  class Genre < Base
+    element 'genreId' => :id
+    element 'genreName' => :name
+    element :parent, :with => Genre
+    elements 'child' => :children, :with => Genre
+
+    def self.parse(response)
+      response = response.dup['Body']['GenreSearch'] if response['Body']
+      response['genreId'] = response['current'].first['genreId'] if response['current'] && response['current'].any?
+      response['genreName'] = response['current'].first['genreName'] if response['current'] && response['current'].any?
+      super(response)
+    end
+  end
+
+end

data/lib/rakumarket/spitter.rb

@@ -0,0 +1,102 @@
+# DSL for defining data extraction rules from an abstract document object
+module SpitterMethods
+  def self.extended(base)
+    base.send(:include, InstanceMethods) if base.is_a? Class
+  end
+
+  # Declare a singular spitting rule
+  def parameter(*args, &block)
+    key, name, delegate = parse_rule_declaration(*args, &block)
+    rules[key] = [name, delegate]
+    key
+  end
+
+  # Declare a plural spitting rule
+  def parameters(*args, &block)
+    key = parameter(*args, &block)
+    rules[key] << true
+  end
+
+  # Parsing rules declared with `parameter` or `parameters`
+  def rules
+    @rules ||= {}
+  end
+
+  # Process data by creating a new instance
+  def parse(params) new(params).parse end
+
+  private
+
+  # Make subclasses inherit the parsing rules
+  def inherited(subclass)
+    super
+    subclass.rules.update self.rules
+  end
+
+  # Rule declaration forms:
+  #
+  #   { :key => 'property', :with => delegate }
+  #     #=> [:key, 'property', delegate]
+  #
+  #   :title
+  #     #=> [:title, 'title', nil]
+  def parse_rule_declaration(*args, &block)
+    options, name = Hash === args.last ? args.pop : {}, args.first
+    delegate = options.delete(:with)
+    key, property = name ? [name.to_sym, name.to_s] : options.to_a.flatten
+    property = property[key.to_s] if property.is_a?(Proc)
+    property = property.method(property.respond_to?(:call) ? :call : :parse)[key.to_s] if property.is_a?(Class)
+    raise ArgumentError, "invalid rule declaration: #{args.inspect}" unless property
+    # eval block in context of a new scraper subclass
+    delegate = Class.new(Spitter, &block) if block_given?
+    return key, property, delegate
+  end
+
+  def base_parser_class
+    klass = self
+    klass = klass.superclass until klass.superclass == Object
+    klass
+  end
+
+  module InstanceMethods
+
+    # Initialize the parser with a parameters
+    def initialize(params)
+      @params = params
+    end
+
+    def params
+      @params ||= {}
+    end
+
+    def parse
+      request_params = {}
+      self.class.rules.each do |target, (key, delegate, plural)|
+        if @params.has_key?(target)
+          if plural
+            request_params.merge!(delegate.parse(@params[target]))
+          else
+            request_params[key] = parse_result(@params[target], delegate)
+          end
+        end
+      end
+      request_params
+    end
+
+    protected
+
+    # `delegate` is optional, but should respond to `call` or `parse`
+    def parse_result(node, delegate)
+      if delegate
+        method = delegate.is_a?(Proc) ? delegate : delegate.method(delegate.respond_to?(:call) ? :call : :parse)
+        method.arity == 1 ? method[node] : (method.arity == 2 ? method[node, self] : method[])
+      else
+        node
+      end
+    end
+  end
+end
+
+class Spitter
+  extend SpitterMethods
+end

data/lib/rakumarket/version.rb

@@ -1,3 +1,3 @@
 module Rakumarket
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end