met_museum 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3166d79682a65468f1125eae072b225fe074956a14d46f519f614d005c546e0
-  data.tar.gz: ff4e0edf78eb5f1ee51ce033853e24b5df8d79f309ebf331cd2be3fd4f4446fe
+  metadata.gz: 7d58c6abf7f6b6ec0be35cf0d040d2fc792b94813ea1d29c24e53a2779b3e9ed
+  data.tar.gz: 328c2bec219470476da6835add05935feba2a699354baf7eb3f4289c41066e47
 SHA512:
-  metadata.gz: b3c5648e505cb4643486345315323677f782e0a27476ba2645f3db9728d2bd0c5ed64179ac3588173cd40126f69711d620e0d50469c29e144b2f11d46107ada0
-  data.tar.gz: d211eed392861e8e897d6d3e1abe7893ba162f4402345e10d266414c485af879dbebdaa9d2be98ed6a2705342311f344e901dffcb77cdafca9b1afd16abe1455
+  metadata.gz: 2f79e9a9a7b1a4b30b15d797630a1432be61ee75a5ed3c387524426151c5081762719a258568398ec451793aaeee4b6503971aa4600c918614e2c899d808ed1d
+  data.tar.gz: 58be9f19bf3252c924af639ec5e9deacbcc14d4d21dd1cdc373f7994cacf213c4776b18abf9af876cb2cb8b0a90056ef7172b412f08a0b35b72d8624a2b25346

data/Gemfile.lock

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

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"> <img src="http://inch-ci.org/github/hyuraku/met_museum.svg">
 # MetMuseum
 
 The Metropolitan Museum of Art Collection API Ruby wrapper
@@ -24,13 +24,19 @@ Or install it yourself as:
 
 ## Usage
 
-```
+```rb
 require 'met_museum'
 ```
+
 The description of the method is as follows
 
+<details>
+<summary>
 MetMuseum::Collection.objects
-```
+</summary>
+<div>
+
+```rb
 collection = MetMuseum::Collection.new()
 collection.objects
 => {"total"=>490607,
@@ -75,15 +81,20 @@ collection.objects(DateTime.new(2018,10,10))
 --< omit >--
    820613]}
 ```
+</div>
+</details>
+
+
 
 <details>
 <summary>
   MetMuseum::Collection.object
 </summary>
-<pre>
-```
+<div>
+
+```rb
 collection = MetMuseum::Collection.new()
-collection.object(1000)    
+collection.object(1000)
 => {"objectID"=>1000,
  "isHighlight"=>false,
  "accessionNumber"=>"10.149.99",
@@ -134,11 +145,17 @@ collection.object(1000)
  "objectURL"=>"https://www.metmuseum.org/art/collection/search/1000"}
  "tags"=>["Coat of Arms", "Dishes"]}
 ```
-</pre>
+</div>
 </details>
 
+<details class="sss">
+<summary>
 MetMuseum::Collection.search
-```
+</summary>
+<div>
+
+```rb
+# show object_ids size and themselves
 collection.search('ocean')
 => {"total"=>189,
  "objectIDs"=>
@@ -149,7 +166,63 @@ collection.search('ocean')
    8315,
    8317,
    --< omit >--
+
+# show specified number of objects 
+MetMuseum::Collection.search('akasaka', 1)
+=> [{"objectID"=>37231,
+  "isHighlight"=>false,
+  "accessionNumber"=>"JP787",
+  "isPublicDomain"=>true,
+  "primaryImage"=>"https://images.metmuseum.org/CRDImages/as/original/DP123261.jpg",
+  "primaryImageSmall"=>"https://images.metmuseum.org/CRDImages/as/web-large/DP123261.jpg",
+  "additionalImages"=>[],
+  "constituents"=>[{"role"=>"Artist", "name"=>"Utagawa Hiroshige"}],
+  "department"=>"Asian Art",
+  "objectName"=>"Print",
+  "title"=>"Akasaka",
+  "culture"=>"Japan",
+  "period"=>"Edo period (1615–1868)",
+  "dynasty"=>"",
+  "reign"=>"",
+  "portfolio"=>"",
+  "artistRole"=>"",
+  "artistPrefix"=>"",
+  "artistDisplayName"=>"",
+  "artistDisplayBio"=>"",
+  "artistSuffix"=>"",
+  "artistAlphaSort"=>"",
+  "artistNationality"=>"",
+  "artistBeginDate"=>"",
+  "artistEndDate"=>"",
+  "objectDate"=>"ca. 1840",
+  "objectBeginDate"=>1830,
+  "objectEndDate"=>1850,
+  "medium"=>"Polychrome woodblock print; ink and color on paper",
+  "dimensions"=>"Overall: 8 3/4 x 13 3/4in. (22.2 x 34.9cm)",
+  "creditLine"=>"The Francis Lathrop Collection, Purchase, Frederick C. Hewitt Fund, 1911",
+  "geographyType"=>"",
+  "city"=>"",
+  "state"=>"",
+  "county"=>"",
+  "country"=>"",
+  "region"=>"",
+  "subregion"=>"",
+  "locale"=>"",
+  "locus"=>"",
+  "excavation"=>"",
+  "river"=>"",
+  "classification"=>"Prints",
+  "rightsAndReproduction"=>"",
+  "linkResource"=>"",
+  "metadataDate"=>"2019-05-11T05:36:53.803Z",
+  "repository"=>"Metropolitan Museum of Art, New York, NY",
+  "objectURL"=>"https://www.metmuseum.org/art/collection/search/37231",
+  "tags"=>["Buildings", "Men", "Women"]}]
 ```
+</div>
+</details>
+
+***
 
 ## Contributing
 

data/lib/met_museum/collection.rb

@@ -72,16 +72,16 @@ module MetMuseum
     end
 
     # returns a listing of all Object IDs for objects that contain the search query within the object’s data
-    # @param [String] query 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
     # @return [Integer] total The total number of publicly-available objects
     # @return [Array<Integer>] objectIDs An array containing the object ID of publicly-available object
-    def search(query, show_number = 0)
+    # @return [Array<Object>] objects An array containing the objects that contain the search query within the object’s data
+    def search(query, limit = 0)
       response = Faraday.new(:url => API_ENDPOINT).get SEARCH_URI, {:q => query}
-      #error if show_number <= 0
       origin_response = return_response(response)
-      return origin_response if show_number.to_i <= 0 && show_number != 'all'
-      show_number = origin_response['total'].to_i if show_number == 'all'
-      origin_response["objectIDs"][0..show_number - 1].map{|id| object(id)}
+      return origin_response if limit <= 0
+      origin_response["objectIDs"][0..limit - 1].map{|id| object(id)}
     end
 
     private

data/lib/met_museum/version.rb

@@ -1,3 +1,3 @@
 module MetMuseum
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: met_museum
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - hyuraku
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-30 00:00:00.000000000 Z
+date: 2019-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler