gurunavi 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0428f1e1ebefbec105b2246c4d2a78c8227435db'
-  data.tar.gz: b428992ca7c991d1666f430a3a881316b995cd5f
+  metadata.gz: 52cc104865af1a3821ac74a30115293154046f87
+  data.tar.gz: 5b3a0a1fe1798b1de197666da2b9cd3113c52c2e
 SHA512:
-  metadata.gz: '08caa035e3ad7f02aeb3a8281c0abb04f79280d38ae9c10adeee6e1e8d9cd79ddc340fb86a3ca634717a2b3c041d045276e4233b725746ba547424d969323ecf'
-  data.tar.gz: e3c2e43d354e45bdf022166f498a9ecc08e511518b018627cfd90a95fadfaa2360a4a70dd3b672a02489f655bbe7890356e4cd273de06bd96b9c8130c8eb3989
+  metadata.gz: 4c9c5357c178c9462244d4de6ba4b4064719d277a0a5b952528bd77bf55d02822d6728b0cdf440452b8942a4ec493cb99c581af7f2101da0bfd2734609af0d46
+  data.tar.gz: 5948be2c21d9354644ac4eba8025a48a88a113fbb47f33d432b2336fe406a54770f5dffa51c2451d14cb83d4e5f3cc2cd9999025cf73646f6403159ca61f113c

data/Gemfile

@@ -1,10 +1,4 @@
 source "https://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
 
 gem 'faraday', '~> 0.8'
 gem 'faraday_middleware', '>= 0.8'

data/Rakefile

@@ -17,8 +17,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "gurunavi"
   gem.homepage = "http://github.com/kobayang/gurunavi"
   gem.license = "MIT"
-  gem.summary = %Q{A Gurunavi API wrapper of ruby gems}
-  gem.description = %Q{A Gurunavi API wrapper of ruby gems}
+  gem.summary = %Q{A Ruby wrapper for the Gurunavi API}
+  gem.description = %Q{A Ruby wrapper for the Gurunavi API}
   gem.email = "naokiod@gmail.com"
   gem.authors = ["kobayang"]
   # dependencies defined in Gemfile

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.1.0

data/gurunavi.gemspec

@@ -2,17 +2,17 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: gurunavi 0.0.2 ruby lib
+# stub: gurunavi 0.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "gurunavi".freeze
-  s.version = "0.0.2"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["kobayang".freeze]
-  s.date = "2017-02-03"
-  s.description = "A Gurunavi API wrapper of ruby gems".freeze
+  s.date = "2017-02-12"
+  s.description = "A Ruby wrapper for the Gurunavi API".freeze
   s.email = "naokiod@gmail.com".freeze
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -42,8 +42,8 @@ Gem::Specification.new do |s|
     "test/fixtures/areas/area_search.json",
     "test/fixtures/categories/category_large_search.json",
     "test/fixtures/categories/category_small_search.json",
-    "test/fixtures/errors/error.json",
-    "test/fixtures/errors/error_gnavi.json",
+    "test/fixtures/errors/601_error.json",
+    "test/fixtures/errors/601_error_gnavi.json",
     "test/fixtures/photos/photo_search.json",
     "test/fixtures/prefs/pref_search.json",
     "test/fixtures/rests/foreign_rest_search.json",
@@ -53,6 +53,7 @@ Gem::Specification.new do |s|
     "test/test_areas.rb",
     "test/test_categories.rb",
     "test/test_client.rb",
+    "test/test_errors.rb",
     "test/test_photos.rb",
     "test/test_prefs.rb",
     "test/test_rests.rb"
@@ -60,7 +61,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/kobayang/gurunavi".freeze
   s.licenses = ["MIT".freeze]
   s.rubygems_version = "2.5.2".freeze
-  s.summary = "A Gurunavi API wrapper of ruby gems".freeze
+  s.summary = "A Ruby wrapper for the Gurunavi API".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4

data/lib/gurunavi/api_error.rb

@@ -1,16 +1,67 @@
 module Gurunavi
-  class APIError < StandardError
 
+  class APIErrorFactory
+    class << self
+      # error responces document is bellow:
+      # http://api.gnavi.co.jp/api/manual/restsearch/#errors
+      ERRORS = {
+        "429" => "TooManyAccess",
+        "600" => "NoShop",
+        "601" => "InvalidAccess",
+        "602" => "InvalidShopNumber",
+        "603" => "InvalidType",
+        "604" => "InternalServerError",
+      }.freeze
+
+      def call_api_errors(code, message)
+        if ERRORS.include?(code.to_s)
+          return Gurunavi.const_get(ERRORS[code.to_s]).new(code, message)
+        end
+        # no definition status in ERRORS, return APIError
+        return Gurunavi::APIError.new(code, message)
+      end
+    end
+  end
+
+  # Custom error class for rescuing from all Gurunavi API errors
+  class APIError < StandardError
     attr_reader :code, :message
 
-    def initialize(error)
-      @code   = error.code
-      @message = error.message
+    def initialize(code, message)
+      @code = code
+      @message = message
     end
 
     def message
-       "#{@code} - #{@message}"
+      "#{@code} - #{@message}"
     end
     alias :to_s :message
   end
+
+  # ClientError is base for api errors of client error
+  # Raised when Gurunavi returns a 4xx HTTP status code
+  class ClientError < APIError; end
+
+  # Raised when Gurunavi returns the HTTP status code 429
+  class TooManyAccess < ClientError; end
+
+  # ServerError is base for api errors of server error
+  # Raised when Gurunavi returns a 6xx HTTP status code
+  class ServerError < APIError; end
+
+  # Raised when Gurunavi returns the HTTP status code 600
+  class NoShop < ServerError; end
+
+  # Raised when Gurunavi returns the HTTP status code 601
+  class InvalidAccess < ServerError; end
+
+  # Raised when Gurunavi returns the HTTP status code 602
+  class InvalidShopNumber < ServerError; end
+
+  # Raised when Gurunavi returns the HTTP status code 603
+  class InvalidType < ServerError; end
+
+  # Raised when Gurunavi returns the HTTP status code 604
+  class InternalServerError < ServerError; end
+
 end

data/lib/gurunavi/client.rb

@@ -68,8 +68,13 @@ module Gurunavi
     #
     # Added just for convenience to avoid having to traverse farther down the response just to get to returned data.
     def return_error_or_body(response, response_body)
-      raise Gurunavi::APIError.new(response.body["error"]) if response.body["error"]
-      raise Gurunavi::APIError.new(response.body["gnavi"]["error"]) if response.body["gnavi"] && response.body["gnavi"]["error"]
+      error_status = nil
+      error_status = response_body["error"] if response.body["error"]
+      error_status = response_body["gnavi"]["error"] if response.body["gnavi"] && response.body["gnavi"]["error"]
+
+      if error_status
+        raise Gurunavi::APIErrorFactory.call_api_errors(error_status.code, error_status.message)
+      end
       response_body
     end
 

data/lib/gurunavi/photos.rb

@@ -6,7 +6,56 @@ module Gurunavi
       response = connection.get do |req|
         req.url "PhotoSearchAPI/#{@api_version}", options
       end
-      return_error_or_body(response, response.body.response)
+      # if error happens, raise APIError from return_error_or_body function.
+      body = return_error_or_body(response, response.body.response)
+      map_photos_from_response(body)
+    end
+
+    # photo api json format is different from other api schemes.
+    # rest api response scheme:
+    # {
+    #   "@attributes": {
+    #     "api_version": "..."
+    #   },
+    #   "total_hit_count": "...",
+    #   "hit_per_page": "...",
+    #   "page_offset": "...",
+    #   "rest": [
+    #     ...
+    #    ]
+    #   }
+    # }
+
+    # photo api response scheme:
+    # {
+    #   "response": {
+    #     "@attributes": {
+    #       "api_version": "20150630"
+    #     },
+    #     "total_hit_count": 2,
+    #     "hit_per_page": 2,
+    #     "0": {
+    #       "photo": {
+    #         ...
+    #       }
+    #     },
+    #     "1": ...
+    #   }
+    # }
+
+    # therefore convert response for photos, it means convert response to that:
+    # [
+    #    {photo hashie},
+    #    ...
+    # ]
+    def map_photos_from_response(res)
+      index = 0
+      photos = Hashie::Array.new
+      while res.include?(index.to_s)
+        photos.push(res[index.to_s].photo)
+        index += 1
+      end
+      photos
     end
 
   end

data/test/test_client.rb

@@ -10,24 +10,4 @@ class TestGurunavi < Test::Unit::TestCase
       @client.keyid.should == keyid_test
     end
   end
-
-  context "When returning a unsucessful response(error)" do
-    should "raise Gurunavi::Error with error.json" do
-      response = Faraday::Response.new(body: fixture_file('errors/error.json', parse: true))
-      client   = Gurunavi::Client.new
-
-      assert_raises(Gurunavi::APIError) do
-        client.return_error_or_body(response, response.body)
-      end
-    end
-
-    should "raise Gurunavi::Error with gnavi error json" do
-      response = Faraday::Response.new(body: fixture_file('errors/error_gnavi.json', parse: true))
-      client   = Gurunavi::Client.new
-
-      assert_raises(Gurunavi::APIError) do
-        client.return_error_or_body(response, response.body)
-      end
-    end
-  end
 end

data/test/test_errors.rb

@@ -0,0 +1,67 @@
+require 'helper'
+
+class TestGurunavi < Test::Unit::TestCase
+  context "test raise API error with status code" do
+    should "raise TooManyAccess error with 429 status code" do
+      assert_raises(Gurunavi::TooManyAccess) do
+        raise Gurunavi::APIErrorFactory.call_api_errors(429, "")
+      end
+    end
+
+    should "raise NoShop error with 600 status code" do
+      assert_raises(Gurunavi::NoShop) do
+        raise Gurunavi::APIErrorFactory.call_api_errors(600, "")
+      end
+    end
+
+    should "raise InvalidAccess error with 601 status code" do
+      assert_raises(Gurunavi::InvalidAccess) do
+        raise Gurunavi::APIErrorFactory.call_api_errors(601, "")
+      end
+    end
+
+    should "raise InvalidShopNumber error with 602 status code" do
+      assert_raises(Gurunavi::InvalidShopNumber) do
+        raise Gurunavi::APIErrorFactory.call_api_errors(602, "")
+      end
+    end
+
+    should "raise InvalidType error with 603 status code" do
+      assert_raises(Gurunavi::InvalidType) do
+        raise Gurunavi::APIErrorFactory.call_api_errors(603, "")
+      end
+    end
+
+    should "raise InternalServerError error with 603 status code" do
+      assert_raises(Gurunavi::InternalServerError) do
+        raise Gurunavi::APIErrorFactory.call_api_errors(604, "")
+      end
+    end
+
+    should "raise APIError error with other status code" do
+      assert_raises(Gurunavi::APIError) do
+        raise Gurunavi::APIErrorFactory.call_api_errors(1000, "")
+      end
+    end
+  end
+
+  context "When returning a unsucessful response(error)" do
+    should "raise Gurunavi::InvalidAccess with error.json status is 601" do
+      response = Faraday::Response.new(body: fixture_file('errors/601_error.json', parse: true))
+      client   = Gurunavi::Client.new
+
+      assert_raises(Gurunavi::InvalidAccess) do
+        client.return_error_or_body(response, response.body)
+      end
+    end
+
+    should "raise Gurunavi::InvalidAccess with gnavi error json status is 601" do
+      response = Faraday::Response.new(body: fixture_file('errors/601_error_gnavi.json', parse: true))
+      client   = Gurunavi::Client.new
+
+      assert_raises(Gurunavi::InvalidAccess) do
+        client.return_error_or_body(response, response.body)
+      end
+    end
+  end
+end

data/test/test_photos.rb

@@ -12,7 +12,9 @@ class TestGurunavi < Test::Unit::TestCase
 
       assert_not_nil(photos)
 
-      # Note: PhotoSearchAPI result is different for other API?
+      photos.count.should == 2
+
+      photos[0].vote_id.should == "1855607"
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gurunavi
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - kobayang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-03 00:00:00.000000000 Z
+date: 2017-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -198,7 +198,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A Gurunavi API wrapper of ruby gems
+description: A Ruby wrapper for the Gurunavi API
 email: naokiod@gmail.com
 executables: []
 extensions: []
@@ -229,8 +229,8 @@ files:
 - test/fixtures/areas/area_search.json
 - test/fixtures/categories/category_large_search.json
 - test/fixtures/categories/category_small_search.json
-- test/fixtures/errors/error.json
-- test/fixtures/errors/error_gnavi.json
+- test/fixtures/errors/601_error.json
+- test/fixtures/errors/601_error_gnavi.json
 - test/fixtures/photos/photo_search.json
 - test/fixtures/prefs/pref_search.json
 - test/fixtures/rests/foreign_rest_search.json
@@ -240,6 +240,7 @@ files:
 - test/test_areas.rb
 - test/test_categories.rb
 - test/test_client.rb
+- test/test_errors.rb
 - test/test_photos.rb
 - test/test_prefs.rb
 - test/test_rests.rb
@@ -266,5 +267,5 @@ rubyforge_project:
 rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: A Gurunavi API wrapper of ruby gems
+summary: A Ruby wrapper for the Gurunavi API
 test_files: []