rakuten_api 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rakuten_api.gemspec
+gemspec
+
+group :development, :test do
+  gem 'tapp', git: 'git://github.com/esminc/tapp.git'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'libnotify', require: false
+  gem 'rb-inotify', require: false
+  gem 'rb-fsevent', require: false
+  gem 'growl', require: false
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', all_after_pass: false, all_on_start: false, keep_failed: false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 kengos
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,151 @@
+# RakutenApi
+
+楽天ウェブサービス(http://webservice.rakuten.co.jp/) のAPIクライアントです。
+
+以下のAPIに対応しています。
+
+- [楽天商品検索API2](http://webservice.rakuten.co.jp/api/ichibaitemsearch/) (version:2012-07-23)
+- [楽天ジャンル検索API2](https://webservice.rakuten.co.jp/api/ichibagenresearch/) (version:2012-07-23)
+- [未実装] [楽天商品ランキングAPI2](https://webservice.rakuten.co.jp/api/ichibaitemranking/) (version:2012-09-27)
+
+## Supported Ruby Interpreters
+
+* MRI 1.9.3
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rakuten_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rakuten_api
+
+## Usage
+
+### 共通設定
+
+どこでもいいので、以下を追加します。
+
+Railsアプリケーション等の場合は、initializer等に登録してください。
+
+```ruby
+RakutenApi.configure do |config|
+  config.application_id = "[applicationId]"
+  config.affiliate_id = "[affiliateId]"
+end
+```
+
+### 商品検索API 2
+
+* keyword: 'りんご', hits: '2'(2商品だけ表示)での検索
+
+```ruby
+client = RakutenApi::GenreSearch::Client.new do |params|
+  params.add_param :keyword, 'りんご'
+  params.add_param :hits, 2
+end
+
+response = client.request
+
+p response.status # => 200
+p response.body # => APIのレスポンスBodyをJSONデコードした値が入っている
+p response.page_count # => 100 (取得可能なページ数)(この場合は100まで指定可能を意味する)
+p response.page # => 1 (現在のページ番号)
+p response.carrier # => 0 (キャリア) (0: PC, 1: 携帯, 2: スマートフォン)
+p response.first # => 1 (現在の表示商品始)(1つめを意味する)
+p response.last # => 2 (現在の表示商品終)(2つめを意味する)
+p response.simple_mapping
+# => [
+# #<RakutenApi::ItemSearch::Model:0x007fcb6cd6a350 @item_name="グルメ大賞2010 青森県産 りんご サンふじ...略", @catchcopy="【送料無料】りんご 青森産 サンふじ...略" @item_url="http://item.rakuten.co.jp/cameashi/10000323/", @affiliate_url="", @small_image_urls=["http://thumbnail.image.rakuten.co.jp/@0_mall/cameashi/cabinet/00473472/2012fuji-f5kgb.jpg?_ex=64x64", "http://thumbnail.image.rakuten.co.jp/@0_mall/cameashi/cabinet/00473472/img58491689.jpg?_ex=64x64", "http://thumbnail.image.rakuten.co.jp/@0_mall/cameashi/cabinet/00473472/img55339932.gif?_ex=64x64"], @medium_image_urls=["http://thumbnail.image.rakuten.co.jp/@0_mall/cameashi/cabinet/00473472/2012fuji-f5kgb.jpg?_ex=128x128", "http://thumbnail.image.rakuten.co.jp/@0_mall/cameashi/cabinet/00473472/img58491689.jpg?_ex=128x128", "http://thumbnail.image.rakuten.co.jp/@0_mall/cameashi/cabinet/00473472/img55339932.gif?_ex=128x128"], @image_flag=true, @availability=true, @tax_flag=false, @postage_flag=false, @creadit_card_flag=true, @shop_of_the_year_flag=false, @ship_overseas_flag=false, @asuraku_flag=false, @gift_flag=false, @ship_overseas_area="", @asuraku_closing_time="", @asuraku_area="", @affiliate_rate=1, @start_time="", @end_time="", @review_count=2371, @review_average=4.4, @point_rate=1, @point_rate_start_time="", @point_rate_end_time="", @shop_name="かめあし商店", @shop_code="cameashi", @shop_url="http://www.rakuten.co.jp/cameashi/", @genre_id="304637">
+# ...
+# ]
+```
+
+`simple_mapping`を呼び出すと、
+
+[RakutenApi::ItemSearch::Model](https://github.com/kengos/rakuten_api/blob/master/lib/rakuten_api/item_search/model.rb) の配列で返却されます。
+
+
+### add_param について
+
+楽天WebService上で表記されている`genreId`を指定する場合
+
+以下は全て同じパラメータを指定していることになる。
+
+```ruby
+params.add_param :genre_id, 0
+params.add_param :genreId, 0
+params.add_param 'genre_id', 0
+params.add_param 'genreId', 0
+```
+
+### ジャンル検索API 2
+
+* genre_id: 0での検索
+
+```ruby
+client = RakutenApi::GenreSearch::Client.new do |params|
+  params.add_param :genre_id, 0
+end
+
+response = client.request
+p response.current
+# => #<RakutenApi::GenreSearch::Model:0x007f956aba3fb8 @genre_id=0, @genre_name="", @genre_level=0>
+
+p response.parents
+# => []
+
+p response.children
+# => [
+#  #<RakutenApi::GenreSearch::Model:0x007f956aba1ec0 @genre_id=211742, @genre_name="TV・オーディオ・カメラ", @genre_level=1>,
+#  #<RakutenApi::GenreSearch::Model:0x007f956abcb360 @genre_id=100371, @genre_name="レディースファッション", @genre_level=1>,
+#  ...
+# ]
+```
+
+* genre_id: 551172での(genreLevel: 2)検索
+
+```ruby
+client = RakutenApi::GenreSearch::Client.new do |params|
+  params.add_param :genre_id, 551172
+end
+
+response = client.request
+p response.current
+# => <RakutenApi::GenreSearch::Model:0x007fe1a39a28b0 @genre_id=551172, @genre_name="医療計測器", @genre_level=2>
+
+p response.parents
+# => [#<RakutenApi::GenreSearch::Model:0x007fe1a39a2540 @genre_id=551169, @genre_name="医薬品・コンタクト・介護", @genre_level=1>]
+
+p response.children
+# => [
+#  #<RakutenApi::GenreSearch::Model:0x007fe1a39a21a8 @genre_id=208232, @genre_name="塩素計", @genre_level=3>,
+#  #<RakutenApi::GenreSearch::Model:0x007fe1a39a1fc8 @genre_id=551173, @genre_name="その他", @genre_level=3>,
+#  ...
+# ]
+#
+```
+
+## Dependencies
+
+* [faraday](https://github.com/lostisland/faraday)
+
+### Development dependencies
+
+* [rspec](https://github.com/rspec)
+* [vcr](https://github.com/vcr/vcr)
+* [webmock](https://github.com/bblimke/webmock)
+
+## 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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/examples/show_ranking.rb

@@ -0,0 +1,20 @@
+# coding: utf-8
+
+# You need
+# gem install rakuten_api
+# gem install faraday
+
+require 'rakuten_api'
+require 'faraday'
+
+RakutenApi.configure do |config|
+  config.application_id = "[Your application_id]"
+end
+
+client = RakutenApi::ItemRanking::Client.new
+response = client.request
+
+response.simple_mapping.each do |f|
+  # you need another parameters, see: https://webservice.rakuten.co.jp/api/ichibaitemranking/
+  puts f.rank.to_s + ' ' + f.item_name + "\n"
+end

data/lib/rakuten_api/base/client.rb

@@ -0,0 +1,41 @@
+# coding: utf-8
+
+module RakutenApi::Base
+  class Client
+    def initialize(application_id = nil, affiliate_id = nil)
+      init_params(application_id, affiliate_id)
+      yield @params if block_given?
+    end
+
+    def init_params(application_id, affiliate_id)
+      raise "not implement"
+    end
+
+    def get
+      raise "not implement"
+    end
+
+    def request
+      raise "not implement"
+    end
+
+    def connection
+      @connection ||= new_connection
+    end
+
+    def params
+      @params.to_hash
+    end
+
+    def add_param(name, value)
+      @params[name] = value
+    end
+
+    def new_connection
+      ::Faraday.new(url: ::RakutenApi::APPLICATION_END_POINT) do |faraday|
+        faraday.request  :url_encoded
+        faraday.adapter  Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/rakuten_api/base/item.rb

@@ -0,0 +1,55 @@
+# coding: utf-8
+
+module RakutenApi::Base
+  module Item
+    ITEM_CASTING = {
+      'smallImageUrls' => Proc.new{|o| o.map{|v| v["imageUrl"]}},
+      'mediumImageUrls' => Proc.new{|o| o.map{|v| v["imageUrl"]}},
+      'imageFlag' => Proc.new{|o| o == 1},
+      'availability' => Proc.new{|o| o == 1},
+      'taxFlag' => Proc.new{|o| o == 1},
+      'postageFlag' => Proc.new{|o| o == 1},
+      'creditCardFlag' => Proc.new{|o| o == 1},
+      'shopOfTheYearFlag' => Proc.new{|o| o == 1},
+      'shipOverseasFlag' => Proc.new{|o| o == 1},
+      'asurakuFlag' => Proc.new{|o| o == 1},
+      'giftFlag' => Proc.new{|o| o == 1},
+    }.freeze
+
+    attr_accessor :item_name
+    attr_accessor :catchcopy
+    attr_accessor :item_code
+    attr_accessor :item_price
+    attr_accessor :item_caption
+    attr_accessor :item_url
+    attr_accessor :affiliate_url
+    attr_accessor :small_image_urls
+    attr_accessor :medium_image_urls
+
+    attr_accessor :availability
+    attr_accessor :image_flag
+    attr_accessor :tax_flag
+    attr_accessor :postage_flag
+    attr_accessor :credit_card_flag
+    attr_accessor :shop_of_the_year_flag
+    attr_accessor :ship_overseas_flag
+    attr_accessor :asuraku_flag
+    attr_accessor :gift_flag
+
+    attr_accessor :ship_overseas_area
+    attr_accessor :asuraku_closing_time
+    attr_accessor :asuraku_area
+    attr_accessor :affiliate_rate
+    attr_accessor :start_time
+    attr_accessor :end_time
+    attr_accessor :review_count
+    attr_accessor :review_average
+    attr_accessor :point_rate
+    attr_accessor :point_rate_start_time
+    attr_accessor :point_rate_end_time
+    attr_accessor :shop_name
+    attr_accessor :shop_code
+    attr_accessor :shop_url
+    attr_accessor :genre_id
+  end
+end

data/lib/rakuten_api/base/model.rb

@@ -0,0 +1,41 @@
+# coding: utf-8
+
+module RakutenApi::Base
+  class Model
+    def to_hash
+      {}.tap do |h|
+        instance_variables.each do |sym|
+          h[sym.to_s.sub('@', '').to_sym] = instance_variable_get(sym)
+        end
+      end
+    end
+
+    class << self
+      def from_hash(hash)
+        obj = self.new
+        hash.each_pair do |k, v|
+          v = casting[k].call(v) if casting.include?(k)
+          attribute = mapping.include?(k) ? mapping[k] : downcase(k)
+          obj.send("#{attribute}=", v) if obj.respond_to?("#{attribute}=")
+        end
+        obj
+      end
+
+      def downcase(word)
+        _word = word.dup
+        _word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+        _word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+        _word.downcase!
+        _word
+      end
+
+      def mapping
+        {}
+      end
+
+      def casting
+        {}
+      end
+    end
+  end
+end

data/lib/rakuten_api/base/params.rb

@@ -0,0 +1,72 @@
+# coding: utf-8
+
+module RakutenApi::Base
+  class Params
+    BASE_VALID_NAMES = %w(applicationId affiliateId).freeze
+    attr_accessor :invalid_params_action
+
+    # Initialize
+    # @param [String] application_id Rakuten Web Service applicationId
+    #    If application_id is nil, application_id set to RakutenApi.config.application_id
+    # @param [String] affiliate_id Rakuten Web Service affiliateId
+    #    If affiliate_id is nil, affiliate_id set to RakutenApi.config.affiliate_id
+    # @param [Symbol] invalid_params_action :raise or :stdout or :none
+    #    If invalid_params_action is nil, invalid_params_action set to RakutenApi.config.invalid_params_action
+    def initialize(application_id = nil, affiliate_id = nil, invalid_params_action = nil)
+      init_params application_id || RakutenApi.config.application_id, affiliate_id || RakutenApi.config.affiliate_id
+      @invalid_params_action = invalid_params_action || RakutenApi.config.invalid_params_action
+    end
+
+    def init_params(application_id, affiliate_id)
+      @params = {}
+      add_param('applicationId', application_id)
+      add_param('affiliateId', affiliate_id)
+    end
+
+    def add_param(name, value)
+      _name = normalize(name)
+      if valid_name?(_name)
+        @params[_name] = value
+      else
+        if @invalid_params_action == :raise
+          raise ::RakutenApi::Error.new('passed invalid param: ' + name.to_s)
+        elsif @invalid_params_action == :stdout
+          puts "Warning: " + name.to_s + ' is invalid name'
+        end
+      end
+    end
+
+    def inspect
+      @params
+    end
+
+    def [](name)
+      _name = normalize(name)
+      @params[_name]
+    end
+
+    def []=(name, value)
+      add_param(name, value)
+    end
+
+    def to_hash
+      @params ||= {}
+      @params.reject!{|k,v| v.nil? }
+      @params
+    end
+
+    def valid_name?(name)
+      valid_names.include? name
+    end
+
+    def normalize(name)
+      name = name.to_s
+      name = name.split('_').tap{|names| break names.shift + names.map(&:capitalize).join } if name =~ /.+\_.+/
+      name
+    end
+
+    def valid_names
+      BASE_VALID_NAMES
+    end
+  end
+end

data/lib/rakuten_api/base/response.rb

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+module RakutenApi::Base
+  class Response
+    attr_reader :status
+    attr_reader :body
+
+    def initialize(faraday_response = nil)
+      raise RakutenApi::Error.new('not specified Faraday::Response') if !faraday_response.nil? && !faraday_response.kind_of?(::Faraday::Response)
+      @status = faraday_response.status
+      @body = json_parse(faraday_response.body)
+    end
+
+    def success?
+      @status == 200
+    end
+
+    def error?
+      !success?
+    end
+
+    def error_message
+      nil if success?
+      message = ''
+      message += @body['error'] + ': ' if @body.include? 'error'
+      message += @body['error_description'] if @body.include? 'error_description'
+      message == '' ? 'no error message' : message;
+    end
+
+    protected
+
+    def json_parse(data)
+      JSON.parse(data)
+    rescue JSON::ParserError
+      # @todo logger
+      {}
+    end
+  end
+end

data/lib/rakuten_api/configuration.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+module RakutenApi
+  class Configuration
+    # rakuten application_id (You can get from https://webservice.rakuten.co.jp/app/create)
+    attr_accessor :application_id
+    # rakuten affiliate_id
+    attr_accessor :affiliate_id
+    # behavior when passed an invalid params
+    attr_accessor :invalid_params_action
+    # RakutenApi::GenreSearch::Model include Module
+    attr_accessor :genre_model
+    # RakutenApi::ItemSearch::Model include Module
+    attr_accessor :item_model
+    # RakutenApi::ItemRanking::Model include Module
+    attr_accessor :item_ranking_module
+
+    def initialize
+      @application_id = nil
+      @affiliate_id = nil
+      @invalid_params_action = :stdout
+      @genre_model = 'RakutenApi::DummyModule'
+      @item_model = 'RakutenApi::DummyModule'
+      @item_ranking_module = 'RakutenApi::DummyModule'
+    end
+  end
+end

data/lib/rakuten_api/dummy_module.rb

@@ -0,0 +1,6 @@
+# coding: utf-8
+
+module RakutenApi
+  module DummyModule
+  end
+end

data/lib/rakuten_api/error.rb

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+module RakutenApi
+  class Error < ::StandardError
+  end
+
+  class ServerError < ::RakutenApi::Error
+    attr_reader :status
+    def initilize(message, status)
+      super(message)
+      @status = status
+    end
+  end
+end

data/lib/rakuten_api/genre_search/client.rb

@@ -0,0 +1,41 @@
+# coding: utf-8
+
+module RakutenApi
+  module GenreSearch
+    class Client < RakutenApi::Base::Client
+      REQUEST_PATH = "/services/api/IchibaGenre/Search/20120723"
+
+      def get
+        connection.get(REQUEST_PATH, params)
+      end
+
+      def request
+        Response.new(get)
+      end
+
+      # get rakuten root genres
+      # @param [String] application_id
+      # @param [String] affiliate_id
+      # @return [Array<RakutenApi::GenreSearch::Model>] 
+      def self.root_categories(application_id = nil, affiliate_id = nil)
+        response = self.new(application_id, affiliate_id) do |params|
+          params.add_param :genre_id, 0
+        end.request
+        raise ::RakutenApi::ServerError.new($response.error_message, $response.status) if response.error?
+        response.children
+      end
+
+      def init_params(application_id, affiliate_id)
+        @params = Params.new(application_id, affiliate_id)
+      end
+
+      class Params < ::RakutenApi::Base::Params
+        VALID_NAMES = %w(genreId genrePath).freeze
+
+        def valid_names
+          @@valid_names ||= (VALID_NAMES + BASE_VALID_NAMES).freeze
+        end
+      end
+    end
+  end
+end

data/lib/rakuten_api/genre_search/model.rb

@@ -0,0 +1,22 @@
+# coding: utf-8
+
+module RakutenApi
+  module GenreSearch
+    class Model < ::RakutenApi::Base::Model
+      include RakutenApi.constantize 'genre_model'
+
+      GENRE_SEARCH_CASTING = {
+        "genreId" => Proc.new{|o| o.to_i},
+        'genreLevel' => Proc.new{|o| o.to_i}
+      }.freeze
+
+      attr_accessor :genre_id
+      attr_accessor :genre_name
+      attr_accessor :genre_level
+
+      def self.casting
+        GENRE_SEARCH_CASTING
+      end
+    end
+  end
+end

data/lib/rakuten_api/genre_search/response.rb

@@ -0,0 +1,43 @@
+# coding: utf-8
+
+module RakutenApi
+  module GenreSearch
+    class Response < ::RakutenApi::Base::Response
+      def initialize(faraday_response = nil)
+        super(faraday_response)
+      end
+
+      def cache
+        @cache ||= {}
+      end
+
+      def parents
+        return cache['parents'] if cache.include? 'parents'
+        [] unless @body.include? 'parents'
+        cache['parents'] = [].tap do |result|
+          @body['parents'].each do |f|
+            next unless f.include? 'parent'
+            result << Model.from_hash(f['parent'])
+          end
+        end
+      end
+
+      def current
+        return cache['current'] if cache.include? 'current'
+        return Model.new unless @body.include? "current"
+        cache['current'] = Model.from_hash(@body['current'])
+      end
+
+      def children
+        return cache['children'] if cache.include? 'children'
+        [] unless @body.include? "children"
+        cache['children'] = [].tap do |result|
+          @body["children"].each do |f|
+            next unless f.include? 'child'
+            result << Model.from_hash(f['child'])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rakuten_api/item_ranking/client.rb

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+module RakutenApi
+  module ItemRanking
+    class Client < ::RakutenApi::Base::Client
+      REQUEST_PATH = "/services/api/IchibaItem/Ranking/20120927"
+
+      def get
+        connection.get(REQUEST_PATH, params)
+      end
+
+      def request
+        Response.new(get, params.clone)
+      end
+
+      def init_params(application_id, affiliate_id)
+        @params = Params.new(application_id, affiliate_id)
+      end
+
+      class Params < ::RakutenApi::Base::Params
+        VALID_NAMES = %w(genreId age sex carrier page period).freeze
+
+        def valid_names
+          @@valid_names ||= (VALID_NAMES + BASE_VALID_NAMES).freeze
+        end
+      end
+    end
+  end
+end