met_museum 1.3.6 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f6c889b04efc44af710a4bf5ee316ac4f1eb1f8c1c639854a51b6cc4e721052
-  data.tar.gz: 497b94cb694f008ba8df1023e8c4ba3e51e9e4574c1b9479a6a21b325af7dcfe
+  metadata.gz: 747d015331b55f840aa0065fbfc3e2822fda2f2f52a5a6ddede4b7f62ade5735
+  data.tar.gz: ac3158ff771e89fc1fb3d563920b02797c97c15be9dbd8a1ed5618649b53194b
 SHA512:
-  metadata.gz: 0acb38e8a3e368d04515b8fb36519022e965ce65634cf02d1ea9c9062d57d577b270a26f954f711022b424a95290095c5361857c8ee414e5cdda1005d5c66b42
-  data.tar.gz: bb2730f3aa1efa1f5f06520279e71eb187a6ff813906409fdbbd8340575a64102d0ae6e6875fbe0c3475954fa6f37b4d7264c15b276e8093166071f19cc19359
+  metadata.gz: c02a1a47672656535464183e79b4129b0d4b12632b48382afe8a3aff36d24af355620b51097324157f04342c361dcf62d74396916b52edf05359de6a011a37b1
+  data.tar.gz: 33eedda5f92fe536476dd03c0ba50aad36610f09440fcf15317b905baeac576108d3ac7993269a2619ed403c3ab5883a21193d87da2f72c3fb9e5358a67dd58f

data/.github/workflows/ruby.yml

@@ -0,0 +1,33 @@
+# 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.6', '2.7', '3.0', '3.1' ]
+    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 }}
+        bundler-cache: true
+    - 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,6 +3,7 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
+  - 2.7.1
   - 2.6.0
   - 2.5.0
 script:

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,32 @@
 PATH
   remote: .
   specs:
-    met_museum (1.3.5)
+    met_museum (1.4.1)
       faraday
       oj
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.1)
     coderay (1.1.2)
     diff-lcs (1.3)
-    faraday (0.17.1)
+    faraday (1.2.0)
       multipart-post (>= 1.2, < 3)
+      ruby2_keywords
     method_source (0.9.2)
     multipart-post (2.1.1)
-    oj (3.10.0)
+    oj (3.10.6)
+    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)
+    rainbow (3.0.0)
     rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.5)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -34,6 +42,20 @@ 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)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -45,6 +67,7 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   rspec-retry
+  rubocop
 
 BUNDLED WITH
    2.0.2

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 hyuraku
+Copyright (c) 2021 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

@@ -322,4 +322,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the MetMuseum project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/met_museum/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the MetMuseum project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hyuraku/met_museum/blob/master/CODE_OF_CONDUCT.md).

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/collection.rb

@@ -2,6 +2,9 @@ require "met_museum/api_expections"
 require "met_museum/endpoint"
 require "met_museum/http_status_code"
 
+require "faraday"
+require "oj"
+
 module MetMuseum
   class Collection
     # Return a listing of all valid Object IDs available to use
@@ -10,14 +13,16 @@ module MetMuseum
     # @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 = {})
+    def objects(**args)
       options = {
         metadataDate: nil,
         departmentIds: nil
-      }.merge(options)
+      }.merge(args)
+
       options[:metadataDate] = check_date(options[:metadataDate])
-      response = new_faraday(API_ENDPOINT, PUBLIC_URI, {:metadataDate => options[:metadataDate], :departmentIds => options[:departmentIds]})
-      return_response(response)
+      query = { metadataDate: options[:metadataDate], departmentIds: options[:departmentIds] }
+      response = create_request(API_ENDPOINT, PUBLIC_URI, query)
+      arrange_response(response)
     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)
@@ -53,6 +58,8 @@ module MetMuseum
     # @return [Hash<objectEndDate, string>] Machine readable date indicating the year the artwork was completed (may be the same year or different year than the objectBeginDate)
     # @return [Hash<medium, string>] Refers to the materials that were used to create the artwork
     # @return [Hash<dimensions, string>] Size of the artwork or object
+    # @return [Hash<dimensionsParsed, Array<Hash>>] 	Size of the artwork or object in centimeters, parsed
+    # @return [Hash<measurements, Array<Hash>>] 	Array of elements, each with a name, description, and set of measurements. Spatial measurements are in centimeters; weights are in kg.
     # @return [Hash<creditLine, String>] 	Text acknowledging the source or origin of the artwork and the year the object was acquired by the museum.
     # @return [Hash<geographyType, String>] 	Qualifying information that describes the relationship of the place catalogued in the geography fields to the object that is being catalogued
     # @return [Hash<city, String>] City where the artwork was created
@@ -74,10 +81,11 @@ module MetMuseum
     # @return [Hash<tags,  Array<String>>] An array of subject keyword tags associated with the object
     # @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(objectID)
-      response = new_faraday(API_ENDPOINT, "#{PUBLIC_URI}/#{objectID}")
-      return_response(response)
+    # @return [Hash<GalleryNumber, string>] Gallery number, where available
+
+    def object(object_id)
+      response = create_request(API_ENDPOINT, "#{PUBLIC_URI}/#{object_id}")
+      arrange_response(response)
     end
 
     # returns a listing of all departments
@@ -85,8 +93,8 @@ 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 = new_faraday(API_ENDPOINT, DEPARTMENTS_URI)
-      return_response(response)
+      response = create_request(API_ENDPOINT, DEPARTMENTS_URI)
+      arrange_response(response)
     end
 
     # returns a listing of all Object IDs for objects that contain the search query within the object’s data
@@ -96,57 +104,20 @@ module MetMuseum
     # @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, options = {})
-      options = {
-        limit: 0,
-        isHighlight: false,
-        departmentId: nil,
-        isOnView: nil,
-        artistOrCulture: nil,
-        medium: nil,
-        hasImages: nil,
-        geoLocation: nil,
-        dateBegin: 0,
-        dateEnd: 2000
-      }.merge(options)
-      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)
-      return origin_response if options[:limit] <= 0
-      origin_response["objectIDs"][0..options[:limit] - 1].map{|id| MetMuseum::Collection.new.object(id)}
+    def search(query, **args)
+      args.merge!({q: query})
+      response = create_request(API_ENDPOINT, SEARCH_URI, args)
+      origin_response = arrange_response(response)
+      limit = args[:limit].to_i
+      return origin_response if limit <= 0
+
+      origin_response["objectIDs"].lazy.map { |id| MetMuseum::Collection.new.object(id) }.first(limit)
     end
 
     private
 
-    def new_faraday(url, dir, params = nil)
-      Faraday.new(:url => url).get dir, params
-    end
-
-    def 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
+    def create_request(url, dir, params = nil)
+      Faraday.new(url: url).get dir, params
     end
 
     def response_successful?(response)
@@ -155,20 +126,21 @@ module MetMuseum
 
     def check_date(date)
       return nil if date.nil?
-      return date.to_date.to_s if date.kind_of? Date
+      return date.to_date.to_s if date.is_a? Date
 
       raise TypeError, "Write certain date"
     end
 
-    def return_response(response)
+    def arrange_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 self.kind_of? String
-      return self.join('|') if self.kind_of? Array
+      return self if is_a? String
+      return join("|") if is_a? Array
+
       raise TypeError, "Write String or Array type"
     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.6"
+  VERSION = "1.4.1".freeze
 end

data/lib/met_museum.rb

@@ -1,6 +1,3 @@
-require "faraday"
-require "oj"
-
 require "met_museum/collection"
 require "met_museum/version"
 

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"
@@ -38,6 +37,7 @@ Gem::Specification.new do |spec|
   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.6
+  version: 1.4.1
 platform: ruby
 authors:
 - hyuraku
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-13 00:00:00.000000000 Z
+date: 2022-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -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
@@ -124,7 +140,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/hyuraku/met_museum
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -139,8 +155,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: MET museum api wrapper
 test_files: []