met_museum 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6721f358d59613112cfd9b6186b9bcf81eb4b06435d09b537373c72b313d4442
-  data.tar.gz: acab40da90fe181d92999e486510b1d80628bd97e13708047309c5ff64efa8a1
+  metadata.gz: e78d1ef3d724c81c274a2b009c09df3f296e319de8da098ffe466f5546c54667
+  data.tar.gz: abf44fecf0f446fb111a5df5730509b55c2dc9fc22aaa74f3e4ff2047da410d7
 SHA512:
-  metadata.gz: 680e3f5fcd99e49535d25cee9fddc1760056cc1e0b2adfd19148629dae57ba2544244d34894ac191cc818e196200be5cc0da39335be0a12591e6d7f781c68eea
-  data.tar.gz: 3e66b76b720089dac3c15e9b4f558f8544b51cd16d9e2443cc464b3cfaf7de4a618a278dd7f848d8f32277d1528d6689c6d152c51ec01fd6780213dd5e2f5bad
+  metadata.gz: b71d5ec05575b2e26e4e75bed317aa73399d552f769ea2c816f120b9098ac86e8798d76ade64a1b0685124e7cfa495b77b09aeef4053b152684c5b2f32afea6e
+  data.tar.gz: 36df1c3a70cf2c806a0a5cf74c21dbccc946062cc9f56dc4f9b5a0bf6060662c37565841946678b954318d6d1192f445232a987c3ed9757bde89e8a32ec0bc2e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    met_museum (1.3.2)
+    met_museum (1.3.3)
       faraday
       oj
 
@@ -14,7 +14,7 @@ GEM
       multipart-post (>= 1.2, < 3)
     method_source (0.9.2)
     multipart-post (2.1.1)
-    oj (3.7.12)
+    oj (3.9.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -47,4 +47,4 @@ DEPENDENCIES
   rspec-retry
 
 BUNDLED WITH
-   2.0.1
+   2.0.2

data/README.md

@@ -1,5 +1,5 @@
 <img src="https://img.shields.io/travis/hyuraku/met_museum.svg"> <img src="https://img.shields.io/github/license/hyuraku/met_museum.svg">
- <img src="https://img.shields.io/gem/v/met_museum.svg"> <img src="http://inch-ci.org/github/hyuraku/met_museum.svg">
+ <img src="https://img.shields.io/gem/v/met_museum.svg">
 # MetMuseum
 
 The Metropolitan Museum of Art Collection API Ruby wrapper
@@ -92,8 +92,7 @@ collection.objects(metadataDate: Date.new(2018,10,10),departmentIds: 1)
 <div>
 
 ```rb
-collection = MetMuseum::Collection.new()
-collection.object(1000)
+MetMuseum::Collection.new.object(1000)
 => {"objectID"=>1000,
  "isHighlight"=>false,
  "accessionNumber"=>"10.149.99",
@@ -155,7 +154,7 @@ MetMuseum::Collection.department
 
 ```rb
 # show object_ids size and themselves
-collection.department
+MetMuseum::Collection.new.department
 => {"departments"=>
   [{"departmentId"=>1, "displayName"=>"American Decorative Arts"},
    {"departmentId"=>3, "displayName"=>"Ancient Near Eastern Art"},
@@ -177,7 +176,7 @@ MetMuseum::Collection.search
 
 ```rb
 # show object_ids size and themselves
-collection.search('ocean')
+MetMuseum::Collection.new.search('ocean')
 => {"total"=>189,
  "objectIDs"=>
   [250487,
@@ -189,7 +188,7 @@ collection.search('ocean')
    --< omit >--
 
 # show specified number of objects
-MetMuseum::Collection.search('akasaka', 1)
+MetMuseum::Collection.new.search('akasaka', {limit: 1})
 => [{"objectID"=>37231,
   "isHighlight"=>false,
   "accessionNumber"=>"JP787",
@@ -239,6 +238,11 @@ MetMuseum::Collection.search('akasaka', 1)
   "repository"=>"Metropolitan Museum of Art, New York, NY",
   "objectURL"=>"https://www.metmuseum.org/art/collection/search/37231",
   "tags"=>["Buildings", "Men", "Women"]}]
+
+
+# show specified number of objects
+MetMuseum::Collection.new.search('akasaka', {isHighlight: true})
+=> {"total"=>9, "objectIDs"=>[36572, 37231, 37023, 29953, 55713, 56937, 36708, 36958, 55684]}
 ```
 </div>
 </details>

data/lib/met_museum/collection.rb

@@ -10,11 +10,10 @@ module MetMuseum
     # @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 objects(options = {})
-      default_options = {
+      options = {
         metadataDate: nil,
         departmentIds: nil
-      }
-      options = default_options.merge(options)
+      }.merge(options)
       options[:metadataDate] = check_date(options[:metadataDate]) unless options[:metadataDate].nil?
       response = Faraday.new(:url => API_ENDPOINT).get PUBLIC_URI, {:metadataDate => options[:metadataDate], :departmentIds => options[:departmentIds]}
       return_response(response)
@@ -89,14 +88,19 @@ module MetMuseum
     # returns a listing of all Object IDs for objects that contain the search query within the object’s data
     # @param [String] query search term e.g. sunflowers
     # @param [Interger] limit number of objects zthat contain the search query within the object’s data
+    # @param [Boolean] Returns objects that match the query and are designated as highlights. Highlights are selected works of art from The Met Museum’s permanent collection representing different cultures and time periods.
     # @return [Integer] total The total number of publicly-available objects
     # @return [Array<Integer>] objectIDs An array containing the object ID of publicly-available object
     # @return [Array<Object>] objects An array containing the objects that contain the search query within the object’s data
-    def search(query, limit = 0)
+    def search(query, options = {})
+      options = {
+        limit: 0,
+        isHighlight: false
+      }.merge(options)
       response = Faraday.new(:url => API_ENDPOINT).get SEARCH_URI, {:q => query}
       origin_response = return_response(response)
-      return origin_response if limit <= 0
-      origin_response["objectIDs"][0..limit - 1].map{|id| MetMuseum::Collection.new.object(id)}
+      return origin_response if options[:limit] <= 0
+      origin_response["objectIDs"][0..options[:limit] - 1].map{|id| MetMuseum::Collection.new.object(id)}
     end
 
     private

data/lib/met_museum/version.rb

@@ -1,3 +1,3 @@
 module MetMuseum
-  VERSION = "1.3.2"
+  VERSION = "1.3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: met_museum
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
 platform: ruby
 authors:
 - hyuraku
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-07 00:00:00.000000000 Z
+date: 2019-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler