glibrary 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3ebb0b283f8a02d344327ef0ddb6bb19bfb5e180aecb45403a21a08e182fc42b
+  data.tar.gz: a388772cb5f7b81ff05d08efd9ebbdde68114040076054a76268ad6ea879ea72
+SHA512:
+  metadata.gz: d305157edaf5fe228fc2c7134359d15057b8086404899619400177c06900dc0edd389ef1b3fc11c48dfb459f1c99f86079cb25a5ef718a8633cfb0d26738e566
+  data.tar.gz: 9bd4b1599e77b79ce5f4563776ad15ff1f0a01f93058ec4d20907de61aaf40de11d1c4b1b5c1fb98c125c81902fc72cef44ee32bd143441936b80c0d75a505eb

data/bin/glibrary

@@ -0,0 +1,120 @@
+#!/usr/bin/env ruby
+require 'json'
+require 'optparse'
+require 'io/console'
+
+require_relative '../common/api_query'
+require_relative '../common/google_api_url'
+require_relative '../classes/book_search'
+require_relative '../classes/user_book'
+require_relative '../classes/user_library'
+require_relative '../common/errors'
+
+ARGV << '-h' if ARGV.empty?
+
+#make sure the -l flag is process *after* the -f flag, by putting it at the end
+ARGV << ARGV.delete("-l") if ARGV.include?("-l")
+
+#default filename for saved reading list
+filename = File.dirname(File.expand_path(__FILE__)) + "/saved_libraries/library.json"
+
+#initialize the hash which will hold the search parameters
+o = {}
+
+#parse the command-line options
+OptionParser.new do |opts|
+  opts.banner = "Usage: ruby g_library.rb [options...] [query]"
+  #sets 'library-mode'
+  library = opts.default_argv.include?("-l")
+
+  opts.on("-t", "--title=TITLE", "Specify a title keyword") do |t|
+    o[:title] = t
+  end
+
+  opts.on("-a", "--author=AUTHOR", "Specify an author keyword") do |a|
+    o[:author] = a
+  end
+
+  opts.on("-p", "--publisher=PUBLISHER", "Specify a publisher keyword") do |p|
+    o[:publisher] = p
+  end
+
+  opts.on("-f", "--lib-file=LIBFILE", "Select a library save file") do |libfile|
+    filename = File.absolute_path(libfile)
+    unless File.exist?(filename)
+      (puts "Library file not found, cannot display."; exit) if library
+      puts "Creating new file"
+    end
+  end
+
+  opts.on("-l", "--library", "See your library; ignores all search options
+          \t\t\t\t\tdefault library file is [repository_root]/saved_libraries/library.json") do
+
+    #substitute \ for / if the machine is running windows
+    filename.gsub!(/\//, '\\') if ENV.values.any? { |v| v =~ /[A-Z]:\\Windows/i }
+
+
+    #print out the library and exit the program
+    l = UserLibrary.new(filename)
+    l.pretty_print
+    exit
+  end
+
+  opts.on("-h", "--help", "Prints this help") do
+    puts ""
+    puts opts
+    puts "[query]: all other arguments will be treated as general search keywords"
+    puts ""
+    exit
+  end
+
+end.parse!
+
+#substitute \ for / if the machine is running windows
+filename.gsub!(/\//, '\\') if ENV.values.any? { |v| v =~ /C:\\Windows/i }
+
+# Create or load the library, depending on whether or not the file already exists.
+l = UserLibrary.new(filename)
+
+#initialize the 
+#perform the search, and display the results.
+begin
+  s = BookSearch.new(search: ARGV.join('+'), title: o[:title], author: o[:author], publisher: o[:publisher])
+
+  #see BookSearch definition in classes/book_search.rb
+  #the each method (and all Enumerable methods, like map) only operate on
+  #the first five matches.
+  books = s.map { |info| UserBook.new(info) }
+
+  #print the resuls
+  puts ""
+  books.each_with_index do |b, i|
+    keys = %w[title author publisher]
+    n = i+1
+    puts "-"*5 + "Match ##{n}" + "-"*5 
+    keys.each do |k|
+      puts "%s: %s" % [k.capitalize, b[k]]
+    end
+    puts ""
+  end
+
+  print "Enter a number (1-5) to add a book to your reading list:\n(or any other key to quit)\n"
+
+  selection = STDIN.getch.chomp.to_i
+  i = selection - 1
+  puts ""
+  exit if i < 0 or i > 4
+
+  #add a book to the user's library
+  l << books[i]
+  l.save
+
+rescue SearchError 
+  puts "\nThere was an error with your query; be careful to format it well"
+  puts ""
+  exit
+rescue NoResults
+  puts "\nNo results."
+  puts ""
+  exit
+end

data/classes/book_search.rb

@@ -0,0 +1,101 @@
+require 'json'
+require_relative '../common/api_query'
+require_relative '../common/google_api_url'
+require_relative '../common/errors'
+
+class BookSearch
+  include ApiQuery
+  include Enumerable
+
+  attr_reader :selected_results, :full_results, :url
+
+  def initialize(args)
+    @args = args.dup
+    
+    #the number of results to show:
+    num_results = @args.delete(:num) || 5
+
+    #make sure at least one argument is searchable
+    raise ArgumentError unless @args.keys.any? do |k| 
+      %i[search title author publisher subject isbn lccn oclc].include?(k)
+    end
+
+    #map the keys and values to strings for ease of manipulation
+    @args = @args.map { |k, v| [k,v].map(&:to_s) }.to_h
+    #remove any empty values (nil values were converted to 
+    #empty strings by the last operation)
+    @args = @args.reject { |k, v| v.empty? }.to_h
+
+    #get a nicely formatted url; very important
+    @url = make_url
+
+    #check for successful response from the API
+    response = get_response(url)
+    raise SearchError unless response.code == "200"
+
+    #Puts the results into a hash
+    @full_results = JSON.parse(response.body)
+
+    num = full_results['totalItems']
+    raise NoResults unless num > 0
+
+    #the selected results:
+    @selected_results = full_results['items'].first(num_results)
+    #The following mapping gets the 'volumeInfo' property from the results,
+    #and adds the 'id' property.
+    @selected_results = @selected_results.map { |res| format_hash res }
+
+  end
+
+  #Only five results are iterated over; This behavior is easily changed by either
+  #passing a :num value when initializing a BookSearch, or by using full_results
+  #below, instead of selected_results
+  def each
+    return to_enum :each unless block_given?
+    selected_results.each { |r| yield(r) }
+  end
+
+  #Likewise, only five results are accessible here; see the previous note.
+  def [](index)
+    selected_results[index]
+  end
+
+  def to_json
+    JSON.pretty_generate(selected_results)
+  end
+
+  private 
+
+    def make_url_arg_list
+      url = ["?q="]
+
+      q = @args.delete('search')
+      url << q.to_s
+
+      url << @args.map do |k,v|
+        k = ("in" + k) if %w[title author publisher].include?(k)
+        "%s:%s" % [k, v] 
+      end
+
+      url.reject!(&:empty?)
+      url[0] + url[1, url.length-1].join("+")
+    end
+
+
+    #gets the 'volumeInfo' property from the results, and adds the 'id' property.
+    def format_hash(hash)
+      hash['volumeInfo'].merge( { 'id' => hash['id'] } )
+    end
+
+    #Add the base url and the formatted arg list together, and make sure
+    #there are no spaces
+    def make_url
+      (BASE_API_URL + make_url_arg_list).gsub(/ /, "+")
+    end
+
+    #for testing purposes only
+    def args
+      @args
+    end
+
+end

data/classes/user_book.rb

@@ -0,0 +1,42 @@
+require 'json'
+
+class Hash
+  def info
+    self
+  end
+end
+
+class UserBook
+
+  attr_accessor :title, :publisher, :info, :id
+
+  def initialize(book_data = {})
+    raise ArgumentError unless book_data.is_a?(Hash)
+
+    #The main attributes of the book:
+    @info = book_data
+
+    #The most commonly attributes, for ease of use
+    @id = info['id'] || ""
+    @title = info['title'] || ""
+    @authors = info['authors'] || [] 
+    @publisher = info['publisher'] || ""
+  end
+
+  #get any attribute, like with a hash
+  #ex self['title']
+  def [](key)
+    return authors if key =~ /authors?/i
+    info[key]
+  end
+
+  def authors
+    @authors.join(', ')
+  end
+
+  #Be a little bit forgiving if the user types "authors"
+  def author
+    authors
+  end
+
+end

data/classes/user_library.rb

@@ -0,0 +1,95 @@
+require 'json'
+require_relative '../common/errors'
+require_relative 'user_book'
+
+class UserLibrary
+  include Enumerable
+
+  attr_reader :books, :filename
+
+  def initialize(sourcefile = nil)
+
+    @books = []
+
+    if sourcefile
+      @filename = File.absolute_path(sourcefile)
+
+      #If the file already exists, it will be read and the
+      #@books array will be filled
+      if File.exist?(filename)
+        file = File.open(filename)
+        book_array = JSON.parse(file.read)
+        
+        #If the UserBook initialize method changes, so must this; This
+        #is the only place where there's an explicit dependency on UserBook.
+        #If this line is changed, the rest of the class may still work as long
+        #as the elements in @books respond to the ':info' message
+        @books = book_array.map { |d| UserBook.new(d) }
+      end
+
+    else
+      #the default filename
+      @filename = File.absolute_path("saved_libraries/library.json")
+    end
+
+    #If the wrong type of data is provided
+    raise ArgumentError "Invalid Data" unless books.all? { |b| valid?(b) }
+  end
+
+  def add(book)
+    (raise DataError "Invalid Data"; return) unless valid?(book)
+    @books << book
+  end
+
+  def <<(book)
+    add(book)
+  end
+
+  def save
+    File.write(filename, to_json)
+  end
+
+  #Iterates over ALL books
+  def each
+    return to_enum :each unless block_given?
+    @books.each { |b| yield(b) }
+  end
+
+  def [](index)
+    @books[index]
+  end
+
+  #For saving to files
+  def to_json
+    a = @books.map do |b| 
+      b.info 
+    end
+    JSON.pretty_generate(a)
+  end
+
+  #For printing to the console
+  def pretty_print
+    puts ""
+    each do |b|
+      puts "-"*5 + b['id'] + "-" * 5
+      %w[title author publisher].each do |ind|
+        puts "%s: %s" % [ind.capitalize, b[ind]]
+      end
+    puts ""
+    end
+    puts ""
+  end
+
+  private
+    #make sure whatever gets passed in responds to the ':info' message
+    def valid?(b)
+      b.respond_to?(:info)
+    end
+
+    #for testing purposes
+    def set_filename(name)
+      @filename = name
+    end
+
+end
+

data/common/api_query.rb

@@ -0,0 +1,22 @@
+module ApiQuery
+  require 'net/http'
+  require 'json'
+
+  private
+    def get_response(url)
+      Net::HTTP.get_response(URI.parse(url))
+    end
+
+    def get_response_hash(url)
+      JSON.parse(get_response_body(url))
+    end
+
+    def get_response_code(url)
+      get_response(url).code
+    end
+
+    def get_response_body(url)
+      get_response(url).body
+    end
+end
+

data/common/errors.rb

@@ -0,0 +1,8 @@
+class SearchError < StandardError
+end
+
+class NoResults < StandardError
+end
+
+class DataError < StandardError
+end

data/common/google_api_url.rb

@@ -0,0 +1 @@
+BASE_API_URL="https://www.googleapis.com/books/v1/volumes"

data/common/search_error.rb

@@ -0,0 +1,2 @@
+class SearchError < StandardError
+end

data/glibrary.rb

@@ -0,0 +1,120 @@
+#!/usr/bin/env ruby
+require 'json'
+require 'optparse'
+require 'io/console'
+
+require_relative 'common/api_query'
+require_relative 'common/google_api_url'
+require_relative 'classes/book_search'
+require_relative 'classes/user_book'
+require_relative 'classes/user_library'
+require_relative 'common/errors'
+
+ARGV << '-h' if ARGV.empty?
+
+#make sure the -l flag is process *after* the -f flag, by putting it at the end
+ARGV << ARGV.delete("-l") if ARGV.include?("-l")
+
+#default filename for saved reading list
+filename = File.dirname(File.expand_path(__FILE__)) + "/saved_libraries/library.json"
+
+#initialize the hash which will hold the search parameters
+o = {}
+
+#parse the command-line options
+OptionParser.new do |opts|
+  opts.banner = "Usage: ruby g_library.rb [options...] [query]"
+  #sets 'library-mode'
+  library = opts.default_argv.include?("-l")
+
+  opts.on("-t", "--title=TITLE", "Specify a title keyword") do |t|
+    o[:title] = t
+  end
+
+  opts.on("-a", "--author=AUTHOR", "Specify an author keyword") do |a|
+    o[:author] = a
+  end
+
+  opts.on("-p", "--publisher=PUBLISHER", "Specify a publisher keyword") do |p|
+    o[:publisher] = p
+  end
+
+  opts.on("-f", "--lib-file=LIBFILE", "Select a library save file") do |libfile|
+    filename = File.absolute_path(libfile)
+    unless File.exist?(filename)
+      (puts "Library file not found, cannot display."; exit) if library
+      puts "Creating new file"
+    end
+  end
+
+  opts.on("-l", "--library", "See your library; ignores all search options
+          \t\t\t\t\tdefault library file is [repository_root]/saved_libraries/library.json") do
+
+    #substitute \ for / if the machine is running windows
+    filename.gsub!(/\//, '\\') if ENV.values.any? { |v| v =~ /[A-Z]:\\Windows/i }
+
+
+    #print out the library and exit the program
+    l = UserLibrary.new(filename)
+    l.pretty_print
+    exit
+  end
+
+  opts.on("-h", "--help", "Prints this help") do
+    puts ""
+    puts opts
+    puts "[query]: all other arguments will be treated as general search keywords"
+    puts ""
+    exit
+  end
+
+end.parse!
+
+#substitute \ for / if the machine is running windows
+filename.gsub!(/\//, '\\') if ENV.values.any? { |v| v =~ /C:\\Windows/i }
+
+# Create or load the library, depending on whether or not the file already exists.
+l = UserLibrary.new(filename)
+
+#initialize the 
+#perform the search, and display the results.
+begin
+  s = BookSearch.new(search: ARGV.join('+'), title: o[:title], author: o[:author], publisher: o[:publisher])
+
+  #see BookSearch definition in classes/book_search.rb
+  #the each method (and all Enumerable methods, like map) only operate on
+  #the first five matches.
+  books = s.map { |info| UserBook.new(info) }
+
+  #print the resuls
+  puts ""
+  books.each_with_index do |b, i|
+    keys = %w[title author publisher]
+    n = i+1
+    puts "-"*5 + "Match ##{n}" + "-"*5 
+    keys.each do |k|
+      puts "%s: %s" % [k.capitalize, b[k]]
+    end
+    puts ""
+  end
+
+  print "Enter a number (1-5) to add a book to your reading list:\n(or any other key to quit)\n"
+
+  selection = STDIN.getch.chomp.to_i
+  i = selection - 1
+  puts ""
+  exit if i < 0 or i > 4
+
+  #add a book to the user's library
+  l << books[i]
+  l.save
+
+rescue SearchError 
+  puts "\nThere was an error with your query; be careful to format it well"
+  puts ""
+  exit
+rescue NoResults
+  puts "\nNo results."
+  puts ""
+  exit
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: glibrary
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Peter Engelbert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-26 00:00:00.000000000 Z
+dependencies: []
+description: A simple Google Books API Query program
+email: pmengelbert@gmail.com
+executables:
+- glibrary
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/glibrary
+- classes/book_search.rb
+- classes/user_book.rb
+- classes/user_library.rb
+- common/api_query.rb
+- common/errors.rb
+- common/google_api_url.rb
+- common/search_error.rb
+- glibrary.rb
+homepage: https://github.com/pmengelbert/g_library
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Glibrary
+test_files: []