met_museum 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 900cb94a372a90f0d57977e7f6ac59288016387db01674fb8ad8289781674fc1
-  data.tar.gz: 4872ea946934abcd6f33e774940ea913f26f5bd322e8de0f3e9a07be270cb9de
+  metadata.gz: e3ac1a24a596274e2252ecc37f739f06e0e2ed55aa98e3cc12d16adac23f97c0
+  data.tar.gz: 0f8e891db7317c98f83ed46c81eac19e380aed302a22caacefc243582fb191b2
 SHA512:
-  metadata.gz: 51254a6caafca44ad8a797a10ce992a71ccfaa9b1069c87644fbc269489dd991f059b7a66a0cdf05aab4d555e14ef7728367a86f9c037a148ec2fe53e5abbf3a
-  data.tar.gz: 38c930bd7f2ebbf65d3bd4232608060c4c71634a6aeaedb6166467bf9f5ea1157910efb717c19c7cf079e6194aa40bfb9a25340ce94ac67e7dc58a550d44c562
+  metadata.gz: 91b57da1c9bdcee4674f558e6bc89f0f01b9d60b9f353df2e6a1f8cd6a81bd48c690d821cd786b88827bc811ad8a55b58e40570d758e932491ec6e75534b83ac
+  data.tar.gz: e5242fd7a3f2a39b569b1e828e99b0767007b2c2693f5c153cb832445d1705ff5b7db6e3aa0c5617154b200caf3aa4bff7583be8c00448015d0740f8052f9870

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    met_museum (0.1.2)
+    met_museum (1.0.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -32,7 +32,9 @@ The description of the method is as follows
 </summary>
 <pre>
 ```
-MetMuseum::Collection.objects
+collection = MetMuseum::Collection.new()
+
+collection.objects
 => {"total"=>490607,
  "objectIDs"=>
   [1,
@@ -45,7 +47,8 @@ MetMuseum::Collection.objects
    8,
 --< omit >--
   820613]}
-MetMuseum::Collection.objects('2018-10-10')
+
+collection.objects('2018-10-10')
 =>{"total"=>88232,
  "objectIDs"=>
   [33,
@@ -65,7 +68,9 @@ MetMuseum::Collection.objects('2018-10-10')
 </summary>
 <pre>
 ```
-MetMuseum::Collection.object(1000)    
+collection = MetMuseum::Collection.new()
+
+collection.object(1000)    
 => {"objectID"=>1000,
  "isHighlight"=>false,
  "accessionNumber"=>"10.149.99",

data/lib/met_museum/collection.rb

@@ -1,16 +1,36 @@
 module MetMuseum
   class Collection
+    MetMuseumError = Class.new(StandardError)
+    BadRequestError = Class.new(MetMuseumError)
+    UnauthorizedError = Class.new(MetMuseumError)
+    ForbiddenError = Class.new(MetMuseumError)
+    ApiRequestsQuotaReachedError = Class.new(MetMuseumError)
+    NotFoundError = Class.new(MetMuseumError)
+    UnprocessableEntityError = Class.new(MetMuseumError)
+    ApiError = Class.new(MetMuseumError)
+
     API_ENDPOINT = "https://collectionapi.metmuseum.org".freeze
     PUBLIC_URI = "/public/collection/v1/objects".freeze
 
+    HTTP_OK_CODE = 200.freeze
+
+    HTTP_BAD_REQUEST_CODE = 400.freeze
+    HTTP_UNAUTHORIZED_CODE = 401.freeze
+    HTTP_FORBIDDEN_CODE = 403.freeze
+    HTTP_NOT_FOUND_CODE = 404.freeze
+    HTTP_UNPROCESSABLE_ENTITY_CODE = 429.freeze
+
+
     # Return a listing of all valid Object IDs available to use
     # @param [String] metadataDate Returns any objects with updated data after this date
     # @return [Hash<total, Integer>] The total number of publicly-available objects
     # @return [Hash<objectIDs, Array<Integer>>] An array containing the object ID of publicly-available object
-    def self.objects(metadataDate = nil)
+    def objects(metadataDate = nil)
       conn = Faraday.new(:url => API_ENDPOINT)
       response = conn.get PUBLIC_URI, {:metadataDate => metadataDate}
-      Oj.load(response.body)
+      Oj.load(response.body) if response_successful?(response)
+
+      raise error_class(response), "Code: #{response.status}, response: #{response.body}"
     end
 
     # returns a record for an object, containing all open access data about that object, including its image (if the image is available under Open Access)
@@ -65,9 +85,33 @@ module MetMuseum
     # @return [Hash<repository, String>]
     # @return [Hash<objectURL, String>] URL to object's page on metmuseum.org
     # @return [Hash<total, String>] The total number of publicly-available objects
-    def self.object(objectID)
+    def object(objectID)
       response = Faraday.get "#{API_ENDPOINT}#{PUBLIC_URI}/#{objectID}"
-      Oj.load(response.body)
+      Oj.load(response.body)if response_successful?(response)
+
+      raise error_class(response), "Code: #{response.status}, response: #{response.body}"
+    end
+
+    def error_class(response)
+      case response.status
+      when HTTP_BAD_REQUEST_CODE
+        BadRequestError
+      when HTTP_UNAUTHORIZED_CODE
+        UnauthorizedError
+      when HTTP_FORBIDDEN_CODE
+        return ApiRequestsQuotaReachedError if api_requests_quota_reached?
+        ForbiddenError
+      when HTTP_NOT_FOUND_CODE
+        NotFoundError
+      when HTTP_UNPROCESSABLE_ENTITY_CODE
+        UnprocessableEntityError
+      else
+        ApiError
+      end
+    end
+
+    def response_successful?(response)
+      response.status == HTTP_OK_CODE
     end
   end
 end

data/lib/met_museum/version.rb

@@ -1,3 +1,3 @@
 module MetMuseum
-  VERSION = "0.1.2"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: met_museum
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - hyuraku
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-31 00:00:00.000000000 Z
+date: 2019-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler