openlibrary-covers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3005d3300710dce10002ab997b887d1d7d8e57899f2d982e2f8a6ff19bf0e14f
+  data.tar.gz: 79e3c02feb45bb14a190a13530c30d55578a3e1ab7db0348fad88257a2e5d3ab
+SHA512:
+  metadata.gz: 2fc6b15a55356e037e6ab2794f4a18c002e12093878eef4c002925dd9919d7207544d747a7bc99ece856a42ae0a18e1eb1f142fa715b86b264dd8e302f819107
+  data.tar.gz: '0949b3817b23065a3fcfb9e6dfb4185c6dfe11dc8685ab9765376ead3663084a3c05634f6ed7725afe5efa4b92cf802d141cc564eb960491c683e1bd95774c5a'

data/.circleci/config.yml

@@ -0,0 +1,43 @@
+working_dir: &working_dir ~/app
+
+.build_template: &build_definition
+  steps:
+    - checkout
+    - run: gem install bundler:2.1.4
+    - run: bundle install --jobs=4 --retry=4 --path vendor/bundle
+    - run: bundle exec rake rubocop
+    - run:
+        name: Run tests
+        command: |
+          bundle exec rspec
+  working_directory: *working_dir
+
+version: 2.0
+
+jobs:
+  build:
+    docker:
+      - image: ruby
+    steps:
+      - checkout
+  build_ruby2_7:
+    <<: *build_definition
+    docker:
+      - image: ruby:2.7
+  build_ruby2_6:
+    <<: *build_definition
+    docker:
+      - image: ruby:2.6
+  build_ruby2_5:
+    <<: *build_definition
+    docker:
+      - image: ruby:2.5
+
+workflows:
+  version: 2
+  build_ruby_versions:
+    jobs:
+      - build
+      - build_ruby2_7
+      - build_ruby2_6
+      - build_ruby2_5

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,3 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in openlibrary-covers.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    openlibrary-covers (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    benchmark-malloc (0.2.0)
+    benchmark-perf (0.6.0)
+    benchmark-trend (0.4.0)
+    diff-lcs (1.4.4)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-benchmark (0.6.0)
+      benchmark-malloc (~> 0.2)
+      benchmark-perf (~> 0.6)
+      benchmark-trend (~> 0.4)
+      rspec (>= 3.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.1.0)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.8.1)
+      rubocop (>= 0.87.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (1.44.1)
+      rubocop (~> 0.87)
+      rubocop-ast (>= 0.7.1)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  openlibrary-covers!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rspec-benchmark (~> 0.6)
+  rubocop (> 0.93)
+  rubocop-performance (~> 1.8)
+  rubocop-rspec (~> 1.44)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jane Sandberg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# Openlibrary::Covers
+
+A very small gem that wraps the OpenLibrary's Covers API (https://openlibrary.org/dev/docs/api/covers).
+
+Note that OpenLibrary says that "a courtesy link back to Open Library is appreciated".
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openlibrary-covers'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install openlibrary-covers
+
+## Usage
+
+    require 'openlibrary-covers'
+    image = Openlibrary::Covers::Image.new '9780786965601'
+    image.found? # => true
+    image.url # => "http://covers.openlibrary.org/b/isbn/9780786965601-M.jpg"
+
+    image_by_oclc_number = Openlibrary::Covers::Image.new '798147823', :oclc
+    # Get a large image
+    image_by_oclc_number.url :L # => "http://covers.openlibrary.org/b/oclc/798147823-L.jpg"
+
+    invalid_image = Openlibrary::Covers::Image.new 'not-a-real-identifier'
+    invalid_image.found? # => false
+    invalid_image.url # => nil
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sandbergja/openlibrary-covers.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'openlibrary/covers'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/openlibrary/covers.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'openlibrary/covers/version'
+require 'net/http'
+
+module Openlibrary
+  module Covers
+    ##
+    # An Image from the OpenLibrary API, if one exists
+    class Image
+      ##
+      # @param [String, Array<string>] identifiers the actual values to look up
+      # @param [String, Symbol] identifier_type
+      def initialize(identifiers, identifier_type = :isbn)
+        identifiers = Array(identifiers)
+        @identifier_type = identifier_type
+
+        @found = false
+
+        @successful_identifier = identifiers.detect { |identifier| image_exists(identifier) }
+        @found = true if @successful_identifier
+      end
+
+      def found?
+        @found
+      end
+
+      ##
+      # @param [String, Symbol] size (can be 'S', 'M', 'L', :S, :M, :L)
+      def url(size = 'M')
+        @found ? openlibrary_url(@successful_identifier, size) : nil
+      end
+
+      private
+
+      def openlibrary_domain
+        'covers.openlibrary.org'
+      end
+
+      def openlibrary_port
+        80
+      end
+
+      def openlibrary_url(identifier, size, default_behavior: true)
+        "http://#{openlibrary_domain}#{openlibrary_path(identifier, size, default_behavior: default_behavior)}"
+      end
+
+      def openlibrary_path(identifier, size, default_behavior: true)
+        base_path = "/b/#{@identifier_type}/#{identifier}-#{size}.jpg"
+        default_behavior ? base_path : "#{base_path}?default=false"
+      end
+
+      def image_exists(identifier)
+        response = nil
+        Net::HTTP.start(openlibrary_domain, openlibrary_port) do |http|
+          response = http.head(openlibrary_path(identifier, :S, default_behavior: false))
+        end
+        return true if %w[200 301 302].include? response.code
+
+        false
+      end
+    end
+  end
+end

data/lib/openlibrary/covers/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Openlibrary
+  module Covers
+    VERSION = '0.1.0'
+  end
+end

data/openlibrary-covers.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/openlibrary/covers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'openlibrary-covers'
+  spec.version       = Openlibrary::Covers::VERSION
+  spec.authors       = ['Jane Sandberg']
+  spec.email         = ['sandbej@linnbenton.edu']
+
+  spec.summary       = 'Find cover images from openlibrary'
+  spec.description   = 'A small gem that quickly checks openlibrary to see if '\
+                       'a cover image exists for the identifiers you are interested in.'
+  spec.homepage      = 'https://github.com/sandbergja/openlibrary-covers'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rspec-benchmark', '~> 0.6'
+  spec.add_development_dependency 'rubocop', '> 0.93'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.8'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.44'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: openlibrary-covers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jane Sandberg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.93'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.93'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.44'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.44'
+description: A small gem that quickly checks openlibrary to see if a cover image exists
+  for the identifiers you are interested in.
+email:
+- sandbej@linnbenton.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/openlibrary/covers.rb
+- lib/openlibrary/covers/version.rb
+- openlibrary-covers.gemspec
+homepage: https://github.com/sandbergja/openlibrary-covers
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sandbergja/openlibrary-covers
+  source_code_uri: https://github.com/sandbergja/openlibrary-covers
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Find cover images from openlibrary
+test_files: []