rakumarket 0.1.0 → 0.2.0

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    rakumarket (0.0.3)
+    rakumarket (0.2.0)
       httparty (>= 0.1.0)
       nibbler (~> 1.3.0)
+      oj
 
 GEM
   remote: http://rubygems.org/
@@ -17,6 +18,7 @@ GEM
     multi_json (1.3.6)
     multi_xml (0.5.1)
     nibbler (1.3.0)
+    oj (1.2.11)
     rspec (2.8.0)
       rspec-core (~> 2.8.0)
       rspec-expectations (~> 2.8.0)
@@ -25,7 +27,6 @@ GEM
     rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
-    vcr (2.2.0)
     webmock (1.8.7)
       addressable (>= 2.2.7)
       crack (>= 0.1.7)
@@ -37,5 +38,4 @@ DEPENDENCIES
   bundler (>= 1.0.0)
   rakumarket!
   rspec (~> 2.6)
-  vcr
   webmock

data/README.rdoc

@@ -2,6 +2,8 @@
 
 A reader-friendly Ruby abstraction of the Rakuten Market API.
 
+See the {Github page}[http://bonsaiben.github.com/rakumarket] for detailed usage information.
+
 
 == Description
 
@@ -13,7 +15,7 @@ The goal was to abstract Rakuten's complex API away from users and provide a sim
 * Idiomatic Ruby
 * Simpler and more readable representation of the underlying API
 * Well-tested
-* Returns Hashie::Mash[https://github.com/intridea/hashie]
+* Concrete classes and methods
 
 
 == Goals
@@ -21,7 +23,6 @@ The goal was to abstract Rakuten's complex API away from users and provide a sim
 * Completeness
 * More simplerer
 * Better-tested
-* Concrete classes and methods?
 
 
 
@@ -41,14 +42,21 @@ A Rakuten developer ID is required.
 
 Please see the wiki for a more comprehensive documentation.
 
-=== {Item Search}[https://github.com/bonsaiben/rakumarket/wiki/Item-Search]
+=== Item Search
+
+  Rakumarket.item_search "roomba", :price => {:maximum => 30000}
 
-  Rakumarket.item_search "roomba", options
+=== Item Lookup
 
-=== {Genre Search}[https://github.com/bonsaiben/rakumarket/wiki/Genre-Search]
+  Rakumarket.item_lookup "act-corp:10000580"
+
+=== Genre Search
 
   Rakumarket.genre_search
 
+=== Item Ranking
+
+  Rakumarket.item_ranking :sex => :male, :age_range => (20..29)
 
 
 == Todo
@@ -58,13 +66,6 @@ Please see the wiki for a more comprehensive documentation.
 
 
 
-== Dependencies
-
-* HTTParty[https://github.com/jnunemaker/httparty]
-* Hashie::Mash[https://github.com/intridea/hashie]
-
-
-
 
 == License
 
@@ -94,4 +95,4 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 == Credit
 
-Rakumarket is inspired by multiple other Ruby API wrappers including groupon[https://github.com/pengwynn/groupon] and facebooker[https://github.com/mmangino/facebooker].
+Rakumarket is inspired by multiple other Ruby API wrappers including instagram[https://github.com/mislav/instagram], groupon[https://github.com/pengwynn/groupon] and facebooker[https://github.com/mmangino/facebooker].

data/lib/rakumarket.rb

@@ -20,6 +20,11 @@ module Rakumarket
     ItemLookupClient.request(params)
   end
 
+  def self.item_ranking(options={})
+    params = options.symbolify_keys!
+    ItemRankingClient.request(params)
+  end
+
 
   class << self
     attr_accessor :developer_id

data/lib/rakumarket/client.rb

@@ -39,15 +39,13 @@ private
   end
 
   class TrueToOne
-    def self.parse value
-      value ? "1" : "0"
-    end
+    def self.values; {true => "1", false => "0"} end
+    def self.parse(value) value ? "1" : "0" end
   end
 
   class TrueToZero
-    def self.parse value
-      value ? "0" : "1"
-    end
+    def self.values; {true => "0", false => "1"} end
+    def self.parse(value) value ? "0" : "1" end
   end
 
   class ItemSearchClient < Client
@@ -56,21 +54,23 @@ private
     VERSION = "2010-09-15"
 
     class SortOrder
-      def self.parse(value) ITEM_SEARCH_SORT_ORDERS[value.downcase] end
+      def self.values; ITEM_SEARCH_SORT_ORDERS end
+      def self.parse(value) values[value.downcase] end
     end
 
     class CountryCode
-      def self.parse(value) INTERNATIONAL_DELIVERY_AREA_CODES[value] end
+      def self.values; INTERNATIONAL_DELIVERY_AREA_CODES end
+      def self.parse(value) values[value] end
     end
 
     class NextDayAreaCode
-      def self.parse(value) ASURAKU_DELIVERY_AREA_CODES[value] end
+      def self.values; ASURAKU_DELIVERY_AREA_CODES end
+      def self.parse(value) values[value] end
     end
 
     class PurchaseType
-      def self.parse(value)
-        {"normal" => 0, "regular" => 1, "distribution" => 2}[value]
-      end
+      def self.values; {"normal" => 0, "regular" => 1, "distribution" => 2} end
+      def self.parse(value) values[value] end
     end
 
     parameter :operation, :with => lambda { OPERATION }
@@ -108,6 +108,7 @@ private
 
     def request
       response = super
+      response = response.dup['Body']['ItemSearch']
       ItemList.parse(response)
     end
 
@@ -125,7 +126,8 @@ private
 
     def request
       response = super
-      Genre.parse(response)
+      response = response.dup['Body']['GenreSearch'] if response['Body']
+      GenreFamily.parse(response)
     end
 
   end
@@ -141,8 +143,46 @@ private
 
     def request
       response = super
+      response = response.dup['Body']['ItemCodeSearch']['Items']['Item'].first if response['Body'] && response['Body']['ItemCodeSearch']
       Item.parse(response)
     end
   end
 
+  class ItemRankingClient < Client
+    OPERATION = "ItemRanking"
+    VERSION = "2010-08-05"
+
+    class AgeRange
+      def self.values
+        {
+          (10..19) => "10", 
+          (20..29) => "20", 
+          (30..39) => "30", 
+          (40..49) => "40", 
+          (50..120) => "50"
+        }
+      end
+
+      def self.parse(range) self.values[range] end
+    end
+
+    class Gender
+      def self.values; {'male' => '0', 'female' => '1'} end
+      def self.parse(range) values[range.to_s] end
+    end
+
+    parameter :operation, :with => lambda { OPERATION }
+    parameter :version, :with => lambda { VERSION }
+    parameter :genre_id => 'genreId'
+    parameter :age_range => 'age', :with => AgeRange
+    parameter :sex, :with => Gender
+    parameter :mobile => 'carrier', :with => TrueToOne
+
+    def request
+      response = super
+      response = response.dup['Body']['ItemRanking']
+      ItemList.parse(response)
+    end
+  end
+
 end

data/lib/rakumarket/models.rb

@@ -1,30 +1,49 @@
 # -*- encoding: utf-8 -*-
 
+class NibblerJSON
+  def self.inspect_attributes
+    attributes = {}
+    @rules.each do |k,v|
+      attributes[k] = if v[1].respond_to?(:inspect_attributes)
+        v[2] ? [v[1].inspect_attributes] : v[1].inspect_attributes
+      else
+        v[1].respond_to?(:values) ? v[1].values.values.join("|") : ""
+      end
+    end
+    attributes
+  end
+end
+
 module Rakumarket
   class Base < NibblerJSON
   end
 
   class OneToTrue
-    def self.parse(val) {"1" => true, "0" => false}[val.to_s] end
+    def self.values; {"1" => true, "0" => false} end
+    def self.parse(val) values[val.to_s] end
   end
 
   class ZeroToTrue
-    def self.parse(val) {"0" => true, "1" => false}[val.to_s] end
+    def self.values; {"0" => true, "1" => false} end
+    def self.parse(val) values[val.to_s] end
   end
 
   class ParseTime < Time
+    def self.values; {"accepts" => self.superclass.name} end
     def self.parse(val) super unless val.blank? end
   end
 
   class InternationalDeliveryCountryList
+    def self.values; INTERNATIONAL_DELIVERY_AREA_NAMES end
     def self.parse(val)
-      val.split('/').map{|a| INTERNATIONAL_DELIVERY_AREA_NAMES[a] || a} if val.respond_to?(:split)
+      val.split('/').map{|a| values[a] || a} if val.respond_to?(:split)
     end
   end
 
   class NextDayAreaList
+    def self.values; ASURAKU_DELIVERY_AREA_NAMES end
     def self.parse(val)
-      val.split('/').map{|a| ASURAKU_DELIVERY_AREA_NAMES[a] || a} if val.respond_to?(:split)
+      val.split('/').map{|a| values[a] || a} if val.respond_to?(:split)
     end
   end
 
@@ -47,6 +66,7 @@ module Rakumarket
     element 'itemPrice' => :price
     element 'itemCaption' => :caption
     element 'itemUrl' => :url
+    element 'rank' => :rank
     element 'genreId' => :genre_id
     element 'affiliateUrl' => :affiliate_url
     element 'imageFlag' => :has_image, :with => OneToTrue
@@ -78,7 +98,6 @@ module Rakumarket
     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'),
@@ -102,7 +121,6 @@ module Rakumarket
     elements :items, :with => Item
 
     def self.parse(response)
-      response = response.dup['Body']['ItemSearch']
       response['items'] = response.delete('Items')['Item']
       super(response)
     end
@@ -111,11 +129,15 @@ module Rakumarket
   class Genre < Base
     element 'genreId' => :id
     element 'genreName' => :name
+  end
+
+  class GenreFamily < 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)

data/lib/rakumarket/spitter.rb

@@ -25,6 +25,18 @@ module SpitterMethods
   # Process data by creating a new instance
   def parse(params) new(params).parse end
 
+  def inspect_options
+    options = {}
+    @rules.each do |k,v|
+      options[k] = if v[1].respond_to?(:inspect_options)
+        v[2] ? [v[1].inspect_options] : v[1].inspect_options
+      else
+        v[1].respond_to?(:values) ? v[1].values.keys.join('|') : ""
+      end
+    end
+    options
+  end
+
   private
 
   # Make subclasses inherit the parsing rules

data/lib/rakumarket/version.rb

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

data/rakumarket.gemspec

@@ -15,10 +15,10 @@ Gem::Specification.new do |s|
 
   s.add_dependency "nibbler", "~> 1.3.0"
   s.add_dependency "httparty", ">= 0.1.0"
+  s.add_dependency "oj"
   s.add_development_dependency "bundler", ">= 1.0.0"
   s.add_development_dependency "rspec", "~> 2.6"
   s.add_development_dependency "webmock"
-  s.add_development_dependency "vcr"
 
   s.files = `git ls-files`.split("\n")
   s.require_path = 'lib'

data/spec/fixtures/genre_search.json

@@ -0,0 +1,213 @@
+{
+  "Body": {
+    "GenreSearch": {
+      "child": [
+        {
+          "genreLevel": 1,
+          "genreName": "CD・DVD・楽器",
+          "genreId": 101240
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "インテリア・寝具・収納",
+          "genreId": 100804
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "おもちゃ・ホビー・ゲーム",
+          "genreId": 101164
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "キッズ・ベビー・マタニティ",
+          "genreId": 100533
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "日用品雑貨・文房具・手芸",
+          "genreId": 215783
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "ジュエリー・アクセサリー",
+          "genreId": 216129
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "スポーツ・アウトドア",
+          "genreId": 101070
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "ダイエット・健康",
+          "genreId": 100938
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "水・ソフトドリンク",
+          "genreId": 100316
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "パソコン・周辺機器",
+          "genreId": 100026
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "バッグ・小物・ブランド雑貨",
+          "genreId": 216131
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "レディースファッション",
+          "genreId": 100371
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "花・ガーデン・DIY",
+          "genreId": 100005
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "ペット・ペットグッズ",
+          "genreId": 101213
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "TV・オーディオ・カメラ",
+          "genreId": 211742
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "車・バイク",
+          "genreId": 101114
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "食品",
+          "genreId": 100227
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "美容・コスメ・香水",
+          "genreId": 100939
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "本・雑誌・コミック",
+          "genreId": 200162
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "旅行・出張・チケット",
+          "genreId": 101381
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "不動産・住まい",
+          "genreId": 200163
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "学び・サービス・保険",
+          "genreId": 101438
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "百貨店・総合通販・ギフト",
+          "genreId": 100000
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "デジタルコンテンツ",
+          "genreId": 402853
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "車用品・バイク用品",
+          "genreId": 503190
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "インナー・下着・ナイトウエア",
+          "genreId": 100433
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "日本酒・焼酎",
+          "genreId": 510901
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "ビール・洋酒",
+          "genreId": 510915
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "スイーツ・お菓子",
+          "genreId": 551167
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "医薬品・コンタクト・介護",
+          "genreId": 551169
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "メンズファッション",
+          "genreId": 551177
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "靴",
+          "genreId": 558885
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "腕時計",
+          "genreId": 558929
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "キッチン用品・食器・調理器具",
+          "genreId": 558944
+        },
+        {
+          "genreLevel": 1,
+          "genreName": "家電",
+          "genreId": 562637
+        }
+      ],
+      "current": [],
+      "parent": []
+    }
+  },
+  "Header": {
+    "Status": "Success",
+    "Args": {
+      "Arg": {
+        "apiVersion": {
+          "content": true,
+          "value": "30"
+        },
+        "operation": {
+          "content": true,
+          "value": "GenreSearch"
+        },
+        "developerId": {
+          "content": true,
+          "value": "***"
+        },
+        "genreId": {
+          "content": true,
+          "value": "0"
+        },
+        "version": {
+          "content": true,
+          "value": "2007-04-11"
+        }
+      }
+    },
+    "StatusMsg": ""
+  }
+}