met_museum 1.3.2 → 1.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6721f358d59613112cfd9b6186b9bcf81eb4b06435d09b537373c72b313d4442
-  data.tar.gz: acab40da90fe181d92999e486510b1d80628bd97e13708047309c5ff64efa8a1
+  metadata.gz: 42eaa0e635711cb6b371d1a7cc524b552f40c402c7506b9cda10ef48487f7f3b
+  data.tar.gz: 1259dc15496c35bde977e5a66a0449dfb068d2bee0ef6914294bba38a474ae39
 SHA512:
-  metadata.gz: 680e3f5fcd99e49535d25cee9fddc1760056cc1e0b2adfd19148629dae57ba2544244d34894ac191cc818e196200be5cc0da39335be0a12591e6d7f781c68eea
-  data.tar.gz: 3e66b76b720089dac3c15e9b4f558f8544b51cd16d9e2443cc464b3cfaf7de4a618a278dd7f848d8f32277d1528d6689c6d152c51ec01fd6780213dd5e2f5bad
+  metadata.gz: 6d8fb6c6316e77adaf4d700e97f68b8af64bc0f9e24a508486252955387778644621e76dc0754f20aadcbd4aa7df1db89e00b6230ea10b1c5955f2bb4e8c9b50
+  data.tar.gz: 625e78ae82ad40f8f533e4cb9d3d94e293511ae411d9cbcf5008475770e76b71382efc7914e1f7d1592ad8d1a85b87b7c8f2f9dee64fb9e8987b61518bcf01c9

data/.github/workflows/ruby.yml

@@ -0,0 +1,32 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on: [push, pull_request]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.5', '2.6', '2.7' ]
+    name: Ruby ${{ matrix.ruby }} spec
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run spec
+      run: bundle exec rake

data/.rubocop.yml

@@ -0,0 +1,13 @@
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: true
+  Max: 20

data/.travis.yml

@@ -3,9 +3,9 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
+  - 2.7.1
   - 2.6.0
   - 2.5.0
-  - 2.4.2
 script:
   - bundle exec rspec spec/
 before_install:

data/Gemfile

@@ -1,7 +1,7 @@
 source "https://rubygems.org"
 
 group :development do
-  gem 'pry'
+  gem "pry"
 end
 
 # Specify your gem's dependencies in met_museum.gemspec

data/Gemfile.lock

@@ -1,24 +1,31 @@
 PATH
   remote: .
   specs:
-    met_museum (1.3.2)
+    met_museum (1.3.7)
       faraday
       oj
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.1)
     coderay (1.1.2)
     diff-lcs (1.3)
-    faraday (0.15.4)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
     method_source (0.9.2)
     multipart-post (2.1.1)
-    oj (3.7.12)
+    oj (3.10.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rake (10.5.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -34,6 +41,19 @@ GEM
     rspec-retry (0.6.1)
       rspec-core (> 3.3)
     rspec-support (3.8.0)
+    rubocop (0.86.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.1.0)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -42,9 +62,10 @@ DEPENDENCIES
   bundler (~> 2.0)
   met_museum!
   pry
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
   rspec-retry
+  rubocop
 
 BUNDLED WITH
-   2.0.1
+   2.0.2

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 hyuraku
+Copyright (c) 2020 hyuraku
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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,74 @@ 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 object_ids size and themselves with certain departmentId --< omit >--
+MetMuseum::Collection.new.search('flower', {departmentId: 12})
+=> {"total"=>7922,
+ "objectIDs"=>
+  [207138,
+   197555,
+   207151,
+   206979,
+   --< omit >--
+
+# show object_ids size and themselves which are isOnView
+MetMuseum::Collection.new.search('flower', {isOnView: true})
+=> => {"total"=>2066,
+ "objectIDs"=>
+  [207138,
+   3689,
+   11207,
+   252906,
+   252349,
+   --< omit >--
+
+# show object_ids size and themselves which are artistOrCulture
+MetMuseum::Collection.new.search('flower', {artistOrCulture: true})
+=>  {"total"=>5, "objectIDs"=>[207138, 3689, 196563, 196560, 198662]}
+
+
+# show object_ids size and themselves with certain medium
+MetMuseum::Collection.new.search('flower', {medium: "Paintings"})
+=> {"total"=>706,
+ "objectIDs"=>
+  [11207,
+   436121,
+   10481,
+   435882,
+   --< omit >--
+
+
+# show object_ids size and themselves which are hasImages
+MetMuseum::Collection.new.search('flower', {hasImages: true})
+=> {"total"=>18731,
+ "objectIDs"=>
+  [207138,
+   3689,
+   11207,
+   252906,
+   --< omit >--
+
+# show object_ids size and themselves with certain geoLocation
+MetMuseum::Collection.new.search('flower', {geoLocation: "Paris"})
+=> {"total"=>292,
+ "objectIDs"=>
+  [195320,
+   707455,
+   193814,
+   200432,
+   --< omit >--
+
+# show object_ids size and themselves with datarange
+MetMuseum::Collection.new.search('flower', {dateBegin: 1700,dateEnd: 1750})
+=> {"total"=>1444,
+ "objectIDs"=>
+  [9199,
+   3759,
+   398162,
+   666591,
+   --< omit >--
 ```
 </div>
 </details>

data/Rakefile

@@ -3,4 +3,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/met_museum/api_expections.rb

@@ -3,7 +3,6 @@ module MetMuseum
   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)

data/lib/met_museum/collection.rb

@@ -6,17 +6,18 @@ module MetMuseum
   class Collection
     # Return a listing of all valid Object IDs available to use
     # @param [Date] metadataDate Returns any objects with updated data after this date
+    # @param [DateTime] metadataDate Returns any objects with updated data after this date
     # @params [Integer] departmentIds Returns any objects in a specific department
     # @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 = {
+    def objects(**args)
+      options = {
         metadataDate: nil,
         departmentIds: nil
-      }
-      options = default_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]}
+      }.merge(args)
+      options[:metadataDate] = check_date(options[:metadataDate])
+      query = { metadataDate: options[:metadataDate], departmentIds: options[:departmentIds] }
+      response = new_faraday(API_ENDPOINT, PUBLIC_URI, query)
       return_response(response)
     end
 
@@ -72,8 +73,11 @@ module MetMuseum
     # @return [Hash<repository, String>]
     # @return [Hash<objectURL, String>] URL to object's page on metmuseum.org
     # @return [Hash<tags,  Array<String>>] An array of subject keyword tags associated with the object
-    def object(objectID)
-      response = Faraday.get "#{API_ENDPOINT}#{PUBLIC_URI}/#{objectID}"
+    # @return [Hash<objectWikidata_URL, string>] Wikidata URL for the object
+    # @return [Hash<isTimelineWork, boolean>] Whether the object is on the Timeline of Art History website
+
+    def object(object_id)
+      response = new_faraday(API_ENDPOINT, "#{PUBLIC_URI}/#{object_id}")
       return_response(response)
     end
 
@@ -82,41 +86,42 @@ module MetMuseum
     # @return [Integer] departments Department ID as an integer. The departmentId is to be used as a query parameter on the `/objects` endpoint
     # @return [String] departments Display name for a department
     def department
-      response = Faraday.get "#{API_ENDPOINT}#{DEPARTMENTS_URI}"
+      response = new_faraday(API_ENDPOINT, DEPARTMENTS_URI)
       return_response(response)
     end
 
     # 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)
-      response = Faraday.new(:url => API_ENDPOINT).get SEARCH_URI, {:q => query}
+    def search(query, **args)
+      options = default_search_options.merge(args)
+      response = new_faraday(API_ENDPOINT, SEARCH_URI, {
+                               q: query,
+                               isHighlight: options[:isHighlight],
+                               departmentId: options[:departmentId],
+                               isOnView: options[:isOnView],
+                               artistOrCulture: options[:artistOrCulture],
+                               medium: options[:medium]&.multi_option,
+                               hasImages: options[:hasImages],
+                               geoLocation: options[:geoLocation]&.multi_option,
+                               dateBegin: options[:dateBegin],
+                               dateEnd: options[:dateEnd]
+                             })
       origin_response = return_response(response)
+      limit = options[:limit].to_i
       return origin_response if limit <= 0
-      origin_response["objectIDs"][0..limit - 1].map{|id| MetMuseum::Collection.new.object(id)}
+
+      origin_response["objectIDs"][0..limit - 1].map { |id| MetMuseum::Collection.new.object(id) }
     end
 
     private
 
-    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
+    def new_faraday(url, dir, params = nil)
+      Faraday.new(url: url).get dir, params
     end
 
     def response_successful?(response)
@@ -124,7 +129,8 @@ module MetMuseum
     end
 
     def check_date(date)
-      return date.to_s if date.class == Date
+      return nil if date.nil?
+      return date.to_date.to_s if date.is_a? Date
 
       raise TypeError, "Write certain date"
     end
@@ -132,7 +138,29 @@ module MetMuseum
     def return_response(response)
       return Oj.load(response.body) if response_successful?(response)
 
-      raise error_class(response), "Code: #{response.status}, response: #{response.body}"
+      raise MetMuseum.error_class(response), "Code: #{response.status}, response: #{response.body}"
+    end
+
+    def multi_option
+      return self if is_a? String
+      return join("|") if is_a? Array
+
+      raise TypeError, "Write String or Array type"
+    end
+
+    def default_search_options
+      {
+        limit: 0,
+        isHighlight: false,
+        departmentId: nil,
+        isOnView: nil,
+        artistOrCulture: nil,
+        medium: nil,
+        hasImages: nil,
+        geoLocation: nil,
+        dateBegin: 0,
+        dateEnd: 2000
+      }
     end
   end
 end

data/lib/met_museum/http_status_code.rb

@@ -1,8 +1,25 @@
 module MetMuseum
-  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
+  HTTP_OK_CODE = 200
+  HTTP_BAD_REQUEST_CODE = 400
+  HTTP_UNAUTHORIZED_CODE = 401
+  HTTP_FORBIDDEN_CODE = 403
+  HTTP_NOT_FOUND_CODE = 404
+  HTTP_UNPROCESSABLE_ENTITY_CODE = 429
+
+  def self.error_class(response)
+    case response.status
+    when HTTP_BAD_REQUEST_CODE
+      BadRequestError
+    when HTTP_UNAUTHORIZED_CODE
+      UnauthorizedError
+    when HTTP_FORBIDDEN_CODE
+      ForbiddenError
+    when HTTP_NOT_FOUND_CODE
+      NotFoundError
+    when HTTP_UNPROCESSABLE_ENTITY_CODE
+      UnprocessableEntityError
+    else
+      ApiError
+    end
+  end
 end

data/lib/met_museum/version.rb

@@ -1,3 +1,3 @@
 module MetMuseum
-  VERSION = "1.3.2"
+  VERSION = "1.3.7".freeze
 end

data/met_museum.gemspec

@@ -1,5 +1,4 @@
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "met_museum/version"
 
@@ -9,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["hyuraku"]
   spec.email         = ["calenthird@gamil.com"]
 
-  spec.summary       = %q{MET museum api wrapper}
-  spec.description   = %q{The Metropolitan Museum of Art Collection API wrapper }
+  spec.summary       = "MET museum api wrapper"
+  spec.description   = "The Metropolitan Museum of Art Collection API wrapper "
   spec.homepage      = "https://github.com/hyuraku/met_museum"
   spec.license       = "MIT"
 
@@ -27,7 +26,7 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"
@@ -35,9 +34,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-retry"
+  spec.add_development_dependency "rubocop"
 
   spec.add_dependency "faraday"
   spec.add_dependency "oj"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: met_museum
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.7
 platform: ruby
 authors:
 - hyuraku
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-07 00:00:00.000000000 Z
+date: 2020-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -101,8 +115,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -139,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: MET museum api wrapper