alexandrite 0.0.1 → 0.1.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1d0a59468bf1b22e33d17848c07d9af25172aadbc78723fbf014d42021bcd55
-  data.tar.gz: ffb2f6b45788d233ebb91b601f1ea256ba21b54da4bad154e548f4e20bb9f59b
+  metadata.gz: daf4377dc5fb6c1b1b122236cdd76e760863a575bd6e1bd177d20d98aab92508
+  data.tar.gz: ce9bfcf98c1142b5e539b52189962779c2286705a9c361ba3da7bfa76b80ac81
 SHA512:
-  metadata.gz: a706821501297809cad6e2c88c917ae8ea4fd276b5d9fde402b0fddf3aeac0094fdc13f42ac48edd551e397f0b7d34cadab6f3aed3ffa1c21abd1b8c02f7526c
-  data.tar.gz: f448f181f9980721ef93df28392ffcd8210687033c8257b470cde53693b07c63015f14807a15a70ce649f45789034c2d10fb3e306e007e96d9f083b77dd6d64e
+  metadata.gz: 370748c92b5a9db2b9942fa8b8d779a2324a3a3c95c3114059d708346ff4ef6ee3afa8405a6f5aee58312bfef674e93b14b120d0ed4ef5a6c1cfdbaa4c55bc92
+  data.tar.gz: b04df9e530984ad698e71ea0057a60911480ad5c423d83ecea46413b8eea13af96e7db0fae3cb7d6c96e538b7d50e4457bd63ca04d6176ac5e8282f18f221a31

data/.gitignore

@@ -22,3 +22,4 @@ tmp
 mkmf.log
 .idea
 .rvmrc
+.dump

data/README.md

@@ -1,12 +1,18 @@
-# gisbn GEM  [![Build Status](https://travis-ci.org/eftakhairul/gisbn.svg?branch=master)](https://travis-ci.org/eftakhairul/gisbn) [![GitHub issues](https://img.shields.io/github/issues/eftakhairul/gisbn.svg)](https://github.com/eftakhairul/gisbn/issues)  [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/eftakhairul/gisbn/master/LICENSE.txt)
+# Alexandrite GEM
+[![Gem Version](https://badge.fury.io/rb/alexandrite.svg)](https://badge.fury.io/rb/alexandrite)
 
-It fetches book's information by ISBN number based on Google Book API.
+Alexandrite is a gem that fetches book's data by ISBN number and other parameters from the [Google API](https://developers.google.com/books) and [OCLC API](http://classify.oclc.org/classify2/). It's intended to help librarians and bibliophiles to manage their bookshelves and classify their books.
 
-  - Easy to get all information by ISBN
-  - Structure data
+With Alexandrite, it's
 
-You don't have to call manually Google API with ISBN number. This gem will do everything for you.
+  - Easy to get all information by ISBN and other parameters
+  - Structure data
+  
+## Features
 
+- Retrieves Book data from Google API and OCLC API
+- Suggest a Dewey Decimal Classification or a Library of Congress Classification with OCLC Data.
+- Add data to a virtual collection
 
 
 ### Version
@@ -14,6 +20,7 @@ You don't have to call manually Google API with ISBN number. This gem will do ev
 
 
 ### Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -32,9 +39,13 @@ Or install it yourself as globally:
 gem install alexandrite
 ```
 
+## Usage
+
+Currently, Alexandrite is divided on four modules: Alexandrite, Alexandrite::Book, Alexandrite::GoogleAPI, and AlexandriteOCLCAPI. Require Alexandrite if you want to use an integration of all the modules, or use each module separately.
+
 
 ## Examples
-    book = Gisbn::Book.new "0262033844", "AIzaSyDKepjfaVBRcgsnPALw5s2UNyfOk-1FHUU", "ca"
+    book = Alexandrite.create_book("0262033844")
 
     book.title
     #=> "Introduction to Algorithms"
@@ -52,17 +63,7 @@ gem install alexandrite
     #=> 0262033844
 
     book.isbn_13
-    #=> 9780262033848
-
-    book.thumbnail
-    #=> http://books.google.com/books/content?id=i-bUBQAAQBAJ&printsec=frontcover&img=1&zoom=1&edge=curl&source=gbs_api
-
-    book.preview
-    #=> http://books.google.ca/books?id=i-bUBQAAQBAJ&printsec=frontcover&dq=isbn:0262033844&hl=&cd=1&source=gbs_api
-
-
-    book.gisbn.isbn = 9780321573513
-    book.fetch.title  => "Algorithms"
+    #=> 978026203384
 
 
 
@@ -100,11 +101,12 @@ Want to contribute? Great!
 
 Author
 -----------
-[Eftakhairul Islam](https://eftakhairul.com)
+[J. P. Pérez-Tejada](https://mx.linkedin.com/in/juanpaulopereztejada)
 
-Contributors
+Gem inspired on GISBN. Special greetings to:
 -----------
 [Matt Seeberger](https://github.com/thebeardedgeek)
+[Eftakhairul Islam](https://eftakhairul.com)
 
 License
 ----

data/bookshelf.dump

@@ -0,0 +1,10 @@
+o:Alexandrite::Bookshelf:@collection_nameI"Test Bookshelf:ET:@book_collection[
+I"Google API;T;I"Pedro Páramo;T;[I"Juan Rulfo;TI"Josephine Sacabo;TI"Margaret Sayers Peden;T;
+@;I".Todo queda en familia (All in the Family);T;[I"Dona Herweck Rice;T;
+@;I"Todo queda en familia;T;[I"Cristina Padilla Dieste;T;
+@	;0;0;
+o;	;
+@	;0;0;
+o;	;
+@;I" Cómo llegar a ser japonés;T;[I"Ramón Illán Bacca;T;
+@	;I"#Sociedad, naturaleza y turismo;T;I"
�Seminario Internacional Nuevas Alternativas del Turismo (4th : 2010 : Universidad de Guadalajara. Centro Universitario de la Costa) | Arnáiz Burne, Stella Maris [Author] | Virgen Aguilar, Carlos Rogelio [Author];T;

data/lib/alexandrite/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Alexandrite
-  VERSION = '0.0.1'
+  VERSION = '0.1.0-alpha'
 end

data/lib/alexandrite.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'alexandrite_books'
+require_relative 'alexandrite_book'
 require_relative 'alexandrite_google'
 require_relative 'alexandrite_oclc'
 require_relative 'error_type/errors'
@@ -20,8 +20,9 @@ module Alexandrite
     end
 
     # @return [Alexandrite::Book]
-    def self.create_book(isbn)
-      volume_info = get_volume_info(isbn)
+    def self.create_from_google(key, query)
+      volume_info = get_volume_info(key, query)
+
       Alexandrite::Book.new(volume_info)
     end
   end
@@ -38,7 +39,7 @@ module Alexandrite
     end
 
     # @return [Alexandrite::Book]
-    def self.create_book(type, identifier)
+    def self.create_from_oclc(type, identifier)
       query = Alexandrite::OCLC.new(type, identifier)
       response_code = get_response_code(query.result)
 
@@ -56,28 +57,30 @@ module Alexandrite
   end
 
   def create_book(key, query)
-    book = API[:google].create_book(query)
-    return API[:oclc].create_book(key, query) if book.error_message
+    book = API[:google].create_from_google(key, query)
+    return API[:oclc].create_from_oclc(key, query) if book.error_message
 
     book
   end
 
-  # @param isbns [Array]
-  # @return [Nil]
-  def bulk_create(isbns)
-    isbns.each do |isbn|
-      volume_info = volume_info(isbn)
-      book = Alexandrite::Book.new(volume_info)
-      add_to_collection(book)
+  # @param key [String]
+  # @param data [Array<String>]
+  # @return [Array<Alexandrite::Books]
+  def bulk_create(key, data)
+    bookshelf = []
+    data.each do |query|
+      book = create_book(key, query)
+      bookshelf << book
     end
-    nil
+
+    bookshelf
   end
 
   private
 
-  def get_volume_info(isbn)
-    query = search_by(:isbn, isbn)
-    return query[:books].first[:volume_info] unless query[:error_message]
+  def get_volume_info(key, query)
+    query = search_by(key, query)
+    return query[:books].first['volumeInfo'] unless query[:error_message]
 
     query
   end

data/lib/{alexandrite_books.rb → alexandrite_book.rb}

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'alexandrite'
+require 'nokogiri'
 
 module Alexandrite
   # Create a book objects

data/lib/alexandrite_bookshelf.rb

@@ -1,15 +1,53 @@
 # frozen_string_literal: true
 
 require_relative 'alexandrite'
-require_relative 'book'
+require_relative 'alexandrite_book'
+require_relative 'helpers/file_handler'
 
 # Create, Read, Update and Delete books in a book collection
 module Alexandrite
   # Create a collection of books
   class Bookshelf
-    def initialize
-      @book_collection = []
+    extend Alexandrite::Helpers::FileHandler
+
+    @@library = {}
+
+    attr_accessor :book_collection
+
+    attr_reader :collection_name
+
+    def initialize(collection_name, books = nil)
+      @collection_name = collection_name.to_sym
+      @book_collection = [books]
+    end
+
+    def save_bookshelf(file_path)
+      save(file_path, self)
+    end
+
+    def self.add_bookshelf(file_path)
+      bookshelf = open(file_path)
+      @@library[bookshelf.collection_name.to_sym] = bookshelf if bookshelf.instance_of?(Alexandrite::Bookshelf)
+    end
+
+    def self.charge_library(file_path)
+      bookshelves = open(file_path)
+      @@library = bookshelves if bookshelves.all?(Alexandrite::Bookshelf)
+    end
+
+    def self.save_library(file_path)
+      save(file_path, @@library)
+    end
+
+    def self.show_library
+      @@library
+    end
+
+    def self.find_bookshelf(bookshelf_name)
+      query = @@library[bookshelf_name.to_sym]
+      return "Bookshelf wasn't found. Check collection name" if query.nil?
+
+      query
     end
   end
-  def add_book(book) = @book_collection << book if book.instance_of?(Alexandrite::Book)
 end

data/lib/alexandrite_oclc.rb

@@ -50,6 +50,7 @@ module Alexandrite
 
     private
 
+    # @return [Integer]
     def get_response_code(result) = result.css('response').attribute('code').value.to_i
 
     def get_owis(result, length)
@@ -83,6 +84,7 @@ module Alexandrite
 
     def create_new_book(query)
       volume_info = get_book_data(query.result)
+
       Alexandrite::Book.new(volume_info)
     end
 
@@ -94,9 +96,9 @@ module Alexandrite
     end
 
     def handle_error_creating_book(query)
-      raise ErrorType::DataNotFound, response_cases(query, 0, 'none')
+      raise ErrorType::DataNotFound, response_cases(query.result, 0, 'none')
     rescue StandardError => e
-      Alexandrite::Book.new('error_message' => e.message)
+      Alexandrite::Book.new({ :error_message => e.message, 'origin' => 'OCLC API' })
     end
 
     # @param [Nokogiri::XML] result
@@ -104,7 +106,7 @@ module Alexandrite
     # @param [String] mode Possible: 'ddc' or 'lcc'
     # @return [String]
     def response_cases(result, length, mode)
-      code = get_response_code(result).to_i
+      code = get_response_code(result)
       case code
       when 0
         get_classification(result, mode)

data/lib/helpers/file_handler.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Alexandrite
+  module Helpers
+    # Save files of books
+    module FileHandler
+      # @param [String] file_name
+      # @param [Array<Object>] data
+      def save(file_name, data)
+        File.open(file_name, 'w') { |f| f.write Marshal.dump(data) }
+      end
+
+      def open(file_name)
+        file = File.open(file_name)
+        Marshal.load(file)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alexandrite
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0.pre.alpha
 platform: ruby
 authors:
 - J. P. Pérez-Tejada
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-21 00:00:00.000000000 Z
+date: 2023-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -152,13 +152,16 @@ files:
 - README.md
 - Rakefile
 - alexandrite.gemspec
+- bookshelf.dump
+- data.dump
 - lib/alexandrite.rb
 - lib/alexandrite/version.rb
-- lib/alexandrite_books.rb
+- lib/alexandrite_book.rb
 - lib/alexandrite_bookshelf.rb
 - lib/alexandrite_google.rb
 - lib/alexandrite_oclc.rb
 - lib/error_type/errors.rb
+- lib/helpers/file_handler.rb
 - lib/helpers/format.rb
 - lib/helpers/validation.rb
 - spec/alexandrite_spec.rb
@@ -166,6 +169,7 @@ files:
 - spec/helpers/format_spec.rb
 - spec/spec_helper.rb
 - spec/support/vcr_setup.rb
+- test_library.dump
 homepage: https://github.com/maclenn77/alexandrite
 licenses:
 - MIT
@@ -181,9 +185,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.3.3
 signing_key: