rakuten_web_service 0.2.2 → 0.2.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTVjZWM1MjZhMWRmZDZhMzZkYmZhZThjNjJiZGE1NzNkZjNmYTYyMw==
+    MTJhM2YwOGVjMzRkZTUyNmQyMjhiZTVjZWNiNzE4NmNmN2FkMzI2Mw==
   data.tar.gz: !binary |-
-    YjUzZDE3YzY0NGQxYjVjOTdmOGQ1ODAzYzU5Yzc2ZGI3MjhiNzZiYQ==
+    YWRlNjc0MDE4NjI2OWE3YzQxNTM2MGRlZGRmNDQ4ZGU1NDZmNDU3Yw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MTY4NDM0OGQwZmEyYTc3MzE2YjJhZDA4MGRjYWQwYjQwNGY1MWQ0YzU2NGVm
-    MzgzODI3ZTRjZmY5NGQ2ZWEwNThmZjE0MzQ4YzM3MjczYTljYWFjMWNkODEz
-    NGEyNzk1NjgzNjgxZmYzNWNiMWM0MTg0YTk3ZGRjZGQxN2E1ZGQ=
+    YmY2NWI2NzcwZDhkMTBhMDMwNmUzNTc5YTFjNDcyMmEyN2I2ZmQyMjI1ZDg1
+    YWI1NjhlNjc5NTAxM2M2ZGI5MjkwN2MzMjZhYjY4ZWZlMzhlNGM5YzBhZDk3
+    MjRjOTc0YWMwMjFjMDU3M2Q0NDhjYzMwNDU0YmU1YzA5NGFjNWQ=
   data.tar.gz: !binary |-
-    MzM0NGQ2NmZmZWRiNjU2Y2QxYjgyNWM1NThjNWNlZmE3NDVlNDc1ZjM0MmVk
-    YjA0ODA1ZWJmOTM1YzA0MWMwZTQwZjM0YzI3MzcxZTc3MjUxOGM3NmE4NmFl
-    ZTM3MDY3NGI5MzZhNTNjYzYxYTk1MjViYjliNWU3ZTdmMjU0ZTQ=
+    ZjQxMjk4MGRjNzZiNzRhZWRiMDE0ZThiYWZiYmMyNzQwNjg3YTYxOTcxZWE3
+    ZmViYmIwY2YxNGFmMGM3MzJkYjc0MWM2MmQ5YTgxM2I3MDU2ZGVmNzc1ZWNj
+    ZGUwZDhmMTJiZTJlOGM2MzJjZTYyODZiMWM5NzIwNDUxMmE0OGM=

data/README.en.md

@@ -0,0 +1,79 @@
+# RakutenWebService
+
+[![Build Status](https://travis-ci.org/rakuten-ws/rws-ruby-sdk.png?branch=master)](https://travis-ci.org/rakuten-ws/rws-ruby-sdk) [![Gem Version](https://badge.fury.io/rb/rakuten_web_service.png)](http://badge.fury.io/rb/rakuten_web_service)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+  gem 'rakuten_web_service'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rakuten_web_service
+
+## Usage
+
+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
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/README.md

@@ -1,34 +1,41 @@
 # RakutenWebService
 
-[![Build Status](https://travis-ci.org/satoryu/rakuten_web_service.png?branch=master)](https://travis-ci.org/satoryu/rakuten_web_service) [![Gem Version](https://badge.fury.io/rb/rakuten_web_service.png)](http://badge.fury.io/rb/rakuten_web_service)
+[![Build Status](https://travis-ci.org/rakuten-ws/rws-ruby-sdk.png?branch=master)](https://travis-ci.org/rakuten-ws/rws-ruby-sdk) [![Gem Version](https://badge.fury.io/rb/rakuten_web_service.png)](http://badge.fury.io/rb/rakuten_web_service)
 
-## Installation
+rakuten\_web\_serviceは、 Rubyから楽天が提供しているAPIに簡単にアクセスできるSDK(Software Development Kit)です。
 
-Add this line to your application's Gemfile:
+English version is [here](http://github.com/rakuten-ws/rws-ruby-sdk/blob/master/README.en.md).
+
+## インストール方法
+
+bundlerを利用したアプリケーションの場合、Gemfileに以下の1行を追加します。
 
 ```ruby
   gem 'rakuten_web_service'
 ```
 
-And then execute:
+そして`bundle`コマンドでインストール。
 
     $ bundle
 
-Or install it yourself as:
+もしくは、`gem`コマンドにより
 
     $ gem install rakuten_web_service
 
-## Usage
+とすることでインストールできます。
+
+## 使用方法
 
 Now rakuten\_web\_service is supporting the following APIs: 
+現在rakuten\_web\_serviceは下記のAPIをサポートしています。
 
 * [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). 
+`RakutenWebService.configuration` メソッドを使い、Application IDとAffiliate ID（オプション）を指定することができます。
 
 ```ruby
   RakutenWebService.configuration do |c|
@@ -37,7 +44,7 @@ Now rakuten\_web\_service is supporting the following APIs:
   end
 ```
 
-### Search Ichiba Items
+### 市場商品の検索
 
 ```ruby
   items = RakutenWebService::Ichiba::Item.search(:keyword => 'Ruby') # This returns Enamerable object
@@ -46,9 +53,9 @@ Now rakuten\_web\_service is supporting the following APIs:
   end
 ```
 
-### Genre
+### ジャンル
 
-Genre class provides an interface to traverse sub genres.
+Genreクラスは、`children`や`parent`といったジャンル階層を辿るインターフェースを持っています。 
 
 ```ruby
   root = RakutenWebService::Ichiba::Genre.root # root genre
@@ -62,11 +69,11 @@ Genre class provides an interface to traverse sub genres.
 ```
 
 
-### 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
+  RakutenWebService::Ichiba::Item.ranking(:age => 30, :sex => 0) # 30代男性 のランキングTOP 30
+  RakutenWebService::Ichiba::Genre[100316].ranking # "水・ソフトドリンク" ジャンルのTOP 30
 ```
 
 ## Contributing

data/lib/rakuten_web_service/client.rb

@@ -44,6 +44,7 @@ module RakutenWebService
         conn.request :url_encoded
         conn.response :json
         conn.adapter Faraday.default_adapter
+        conn.headers['User-Agent'] = "RakutenWebService SDK for Ruby-#{RWS::VERSION}"
       end
     end
 

data/lib/rakuten_web_service/version.rb

@@ -1,3 +1,3 @@
 module RakutenWebService
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/spec/rakuten_web_service/client_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'rakuten_web_service/client'
+require 'rakuten_web_service'
 
 describe RakutenWebService::Client do
   let(:endpoint) { 'http://api.example.com/resources' }
@@ -15,7 +15,7 @@ describe RakutenWebService::Client do
 
   before do
     @expected_request = stub_request(:get, endpoint).
-      with(:query => expected_query).
+      with(:query => expected_query, headers: { 'User-Agent' => "RakutenWebService SDK for Ruby-#{RakutenWebService::VERSION}" }).
       to_return(expected_response)
 
     RakutenWebService.configuration do |c|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rakuten_web_service
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Tatsuya Sato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-12 00:00:00.000000000 Z
+date: 2013-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -119,6 +119,7 @@ files:
 - .travis.yml
 - Gemfile
 - LICENSE.txt
+- README.en.md
 - README.md
 - Rakefile
 - examples/ichiba_item_search.rb