rakuten_web_service 0.1.1 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTMxYmJkZDY4MjE0MDI0MDIzZDIyOTRkN2EyMGU1NjRhMDMzMDg5NA==
+    ZjUxOTgxNTFiYTgyOGJhZTAyMDk5YTg3YzdlZGMyZTdmNGVlNjJkNw==
   data.tar.gz: !binary |-
-    ODY4NjQ2MGI2Mzc0OTE4ZDE0OWE4ZmIwNTZiNGYyN2UxMTFmOWJmNQ==
+    NGI5NGMyZDg5OGFiNTQwMmRiN2E4ZDg0ZGIxNzdmZjdmNjM5NzY0Yg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    M2ZhY2UzYmY0ZjlhZDAwNWY3OThkMWIzODVkZDZhMmUyNDczYjY0NDRjNzM3
-    M2IzYjM1NzY1NzBlNWFjODhlNWRiNTkyYjE4NmQ3ODE3MjI0ZjEwMWMwY2E3
-    NzNhM2YxZGZkYTQwYjA2MWUyMWJhZmQ2MGE2YmIyNzdkYzJjZjk=
+    Yzk0NzQxMzM1MmJmN2M5NTFmODFkMzEzMzdhZTRmOWY4NDBlZTUwYzE0NTJi
+    OWYyNTM1MzRmMGQyODNjYTI5MWFhZDUxMDA5MTUwN2QwMzcwNjBiNDFjODQ4
+    M2Q2NjZiNzdhNDA1YjgwMzQ2MmU4NDE2YmNlYmI1OTk4ZmYxODA=
   data.tar.gz: !binary |-
-    OGNjNzQzNWFlNTBhNjg1ZTZkNWYyMjk0ZjcyODcwMGM5ZDg5YzQ5MTVkOTBi
-    N2E0NTViMjc3MTg3MTAwNTkxYzZmMjhkMTQzODE0NjE0ZGEzNWFjYTY0NjNj
-    NWQ0MDJhYzZkMzMwMDc4MzUzMWE0YjUwZGRlMGYxM2FiMjQyZWU=
+    ZjEyYjRmMWNmOWMzMTM2MzIwMDIwZTE3YjgxNTI1MTRlNTU1NzQ1ZjliMzky
+    MjUxOWQ5MzVmMGQ4N2FmYTk0ODc0NzliNzY3MDdkYWM1MWJkZDY5ZGRmZGM5
+    MDIyM2Q4ODRiNzhmYzVkMGYwMWY5N2I3ZWFhZWVlMmMzMjNmOWY=

data/README.md

@@ -6,7 +6,9 @@
 
 Add this line to your application's Gemfile:
 
-    gem 'rakuten_web_service'
+```ruby
+  gem 'rakuten_web_service'
+```
 
 And then execute:
 
@@ -18,7 +20,54 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Now rakuten\_web\_service is supporting the following APIs: 
+
+* [Rakuten Ichiba Item Search API](http://webservice.rakuten.co.jp/api/ichibaitemsearch/)
+* [Rakuten Ichiba Genre Search API](http://webservice.rakuten.co.jp/api/ichibagenresearch/)
+* [Rakuten Ichiba Ranking API](http://webservice.rakuten.co.jp/api/ichibaitemranking/)
+
+### Configuration
+
+`RakutenWebService.configuration` allows you to specify your application's key called application\_id and your affiliate id(optional). 
+
+```ruby
+  RakutenWebService.configuration do |c|
+    c.application_id = YOUR_APPLICATION_ID
+    c.affiliate_id = YOUR_AFFILIATE_ID
+  end
+```
+
+### Search Ichiba Items
+
+```ruby
+  items = RakutenWebService::Ichiba::Item.search(:keyword => 'Ruby') # This returns Enamerable object
+  items.first(10).each do |item|
+    puts "#{item['itemName']}, #{item.price} yen" # You can refer to values as well as Hash. 
+  end
+```
+
+### Genre
+
+Genre class provides an interface to traverse sub genres.
+
+```ruby
+  root = RakutenWebService::Ichiba::Genre.root # root genre
+  # children returns sub genres
+  root.children.each do |child|
+    puts "[#{child.id}] #{child.name}"
+  end
+  
+  # Use genre id to fetch genre object
+  RakutenWebService::Ichiba::Genre[100316].name # => "水・ソフトドリンク"
+```
+
+
+### Ichiba Item Ranking
+
+```ruby
+  RakutenWebService::Ichiba::Item.ranking(:age => 30, :sex => 0) # returns the TOP 30 items for Male in 30s
+  RakutenWebService::Ichiba::Genre[100316].ranking # the TOP 30 items in "水・ソフトドリンク" genre
+```
 
 ## Contributing
 

data/lib/rakuten_web_service.rb

@@ -3,6 +3,7 @@ require 'rakuten_web_service/configuration'
 require 'rakuten_web_service/client'
 require 'rakuten_web_service/search_result'
 require 'rakuten_web_service/resource'
+require 'rakuten_web_service/ichiba/shop'
 require 'rakuten_web_service/ichiba/item'
 require 'rakuten_web_service/ichiba/genre'
 require 'rakuten_web_service/ichiba/ranking'

data/lib/rakuten_web_service/ichiba/item.rb

@@ -24,13 +24,21 @@ module RakutenWebService
         :affiliateRate,
         :startTime, :endTime,
         :reviewCount, :reviewAverage,
-        :pointRate, :pointRateStartTime, :pointRateEndTime<
+        :pointRate, :pointRateStartTime, :pointRateEndTime,
         :shopName, :shopCode, :shopUrl,
         :genreId
 
       def genre
         Genre[self.genre_id]
       end
+
+      def shop
+        Shop.new({
+          'shopName' => self.shop_name,
+          'shopCode' => self.shop_code,
+          'shopUrl' => self.shop_url
+        })
+      end
     end
   end
 end

data/lib/rakuten_web_service/ichiba/shop.rb

@@ -0,0 +1,12 @@
+module RakutenWebService
+  module Ichiba
+    class Shop < Resource
+      attribute :shopName, :shopCode, :shopUrl
+
+      def items(options={})
+        options = options.merge(:shop_code => self.code)
+        RakutenWebService::Ichiba::Item.search(options)
+      end
+    end
+  end
+end

data/lib/rakuten_web_service/resource.rb

@@ -5,7 +5,7 @@ module RakutenWebService
     class << self
       def attribute(*attributes)
         attributes.each do |attribute|
-          method_name = attribute.to_s.gsub(/([a-z]+)([A-Z]{1})/) do
+          method_name = attribute.to_s.gsub(/([a-z]+)([A-Z]{1})/) do |matched|
             "#{$1}_#{$2.downcase}"
           end
           method_name = method_name.sub(/^#{resource_name}_(\w+)$/) { $1 }

data/lib/rakuten_web_service/version.rb

@@ -1,3 +1,3 @@
 module RakutenWebService
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/spec/rakuten_web_service/ichiba/item_spec.rb

@@ -101,4 +101,24 @@ describe RakutenWebService::Ichiba::Item do
       expect { subject }.to_not raise_error
     end
   end
+
+  describe '#shop' do
+    let(:response) { JSON.parse(fixture('ichiba/item_search_with_keyword_Ruby.json')) }
+    let(:expected_item) { response['Items'][0]['Item'] }
+
+    before do
+      stub_request(:get, endpoint).with(:query => expected_query).
+        to_return(:body => response.to_json)
+    end
+
+    subject do
+      RakutenWebService::Ichiba::Item.search(:keyword => 'Ruby').first.shop
+    end
+
+    specify 'responds Shop object' do
+      expect(subject.name).to eq(expected_item['shopName'])
+      expect(subject.code).to eq(expected_item['shopCode'])
+      expect(subject.url).to eq(expected_item['shopUrl'])
+    end
+  end
 end

data/spec/rakuten_web_service/ichiba/shop_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+require 'rakuten_web_service'
+
+describe RakutenWebService::Ichiba::Shop do
+  let(:params) do
+    { 'shopName' => 'Hoge Shop',
+      'shopCode' => 'hogeshop',
+      'shopUrl' => 'http://www.rakuten.co.jp/hogeshop' }
+  end
+  let(:shop) { RakutenWebService::Ichiba::Shop.new(params) }
+  let(:endpoint) { 'https://app.rakuten.co.jp/services/api/IchibaItem/Search/20130805' }
+  let(:affiliate_id) { 'dummy_affiliate_id' }
+  let(:application_id) { 'dummy_application_id' }
+  let(:expected_query) do
+    {
+      'affiliateId' => affiliate_id,
+      'applicationId' => application_id,
+      'shopCode' => 'hogeshop'
+    }
+  end
+
+  before do
+    RakutenWebService.configuration do |c|
+      c.affiliate_id = affiliate_id
+      c.application_id = application_id
+    end
+  end
+
+  describe '.new' do
+    specify 'returned object should have methods to fetch values' do
+      expect(shop.name).to eq('Hoge Shop')
+      expect(shop.code).to eq('hogeshop')
+      expect(shop.url).to eq('http://www.rakuten.co.jp/hogeshop')
+    end
+  end
+
+  describe '#items' do
+    let(:response) do
+      { 'Items' => [] }
+    end
+
+    before do
+      @expected_request = stub_request(:get, endpoint).
+        with(:query => expected_query).to_return(:body => response.to_json)
+    end
+
+    specify 'call the endpoint with the shopCode' do
+      shop.items.first
+
+      expect(@expected_request).to have_been_made
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rakuten_web_service
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Tatsuya Sato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-29 00:00:00.000000000 Z
+date: 2013-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -128,6 +128,7 @@ files:
 - lib/rakuten_web_service/ichiba/genre.rb
 - lib/rakuten_web_service/ichiba/item.rb
 - lib/rakuten_web_service/ichiba/ranking.rb
+- lib/rakuten_web_service/ichiba/shop.rb
 - lib/rakuten_web_service/resource.rb
 - lib/rakuten_web_service/search_result.rb
 - lib/rakuten_web_service/version.rb
@@ -140,6 +141,7 @@ files:
 - spec/rakuten_web_service/ichiba/genre_spec.rb
 - spec/rakuten_web_service/ichiba/item_spec.rb
 - spec/rakuten_web_service/ichiba/ranking_spec.rb
+- spec/rakuten_web_service/ichiba/shop_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixture_suppot.rb
 homepage: http://webservice.rakuten.co.jp/
@@ -175,5 +177,6 @@ test_files:
 - spec/rakuten_web_service/ichiba/genre_spec.rb
 - spec/rakuten_web_service/ichiba/item_spec.rb
 - spec/rakuten_web_service/ichiba/ranking_spec.rb
+- spec/rakuten_web_service/ichiba/shop_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixture_suppot.rb