bookshark 1.0.0.alpha.2 → 1.0.0.alpha.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd72b117f3ad276a049e9e273461125a5080de60
-  data.tar.gz: dc0ece907de78acddf1e2077c98ef56b8c45bd0b
+  metadata.gz: d1a505294880b3816fc6382b9d48035d0e780e85
+  data.tar.gz: 5cc5432c462fea9ab4781bf91bfa9cef9ffa2e2d
 SHA512:
-  metadata.gz: 7469001e1d4a3117d10fa05da6316b704033300ebc8fed1da636886789cd90b3536d1d1fdf9aa7cfecc2a743b1a294ee8fc1020f9529694dcf3992df89f926eb
-  data.tar.gz: daa1103bd41e5f5d0b374d794b078a9ae38dbbfddcf86ff0c1acb2ac9224032a626b92c1b69dce2e6c8f1eca29e3aebcfa0f89d366c50937dc19544afae5d49f
+  metadata.gz: aeee746c931f9171c58c1594145cdaa91d89fda5de4671a4e9a5cf92b3e3d09bffaea863b555326b2224594b901b3859ffff8eacc0a078acd600fc9fee005a7c
+  data.tar.gz: f6f5061c6a636e4eb558508000cb572fd2cd34a59802146a45f6f9bea89f6fa30e14e13a1de54e49a067bae8217b6b9685bc6d124a0d1ac31c3fbb800ea738ab

data/README.md

@@ -21,10 +21,12 @@ Or install it yourself as:
 
     $ gem install bookshark --pre
 
-## Usage
-Include bookshark in your class/module.
+Require and include bookshark in your class/module.
 ```ruby
-include Bookshark
+require 'bookshark'
+class Foo
+  include Bookshark
+end
 ```
 Alternatively you can use this syntax
 ```ruby
@@ -35,7 +37,8 @@ include Bookshark
 Extractor.new
 ```
 
-### Extractor
+## Extractor
+An extractor object must be created in order to perform any metadata extractions.
 
 Create an extractor object
 ```ruby
@@ -52,7 +55,7 @@ Extractor.new(format: 'hash', site: 'biblionet')
 * site : The site from where the metadata will be extracted
   * biblionet (default and currently the only available, so it can be skipped)
 
-#### Extract Book Data
+### Extract Book Data
 
 You need book's id on biblionet website or its uri.
 Currently more advanced search functions based on title and author are not available, but they will be until the stable version 1.0.0 release.
@@ -86,7 +89,7 @@ extractor.book(id: 103788, local: true)
   * pretty_json
 * eager : Perform eager extraction? (Boolean - default is false)
 
-**Eager Extraction:**
+#### Eager Extraction
 
 Each book has some attributes such as authors, contributors, categories etc which are actually references to other objects.   
 By default when extracting a book, you get only names of these objects and references to their pages.   
@@ -153,7 +156,7 @@ The expected result of a book extraction is something like this:
 ```
 Here is a [Book Sample](https://gist.github.com/dklisiaris/a6f3d6f37806186f3c79) extracted with eager option enabled.
 
-#### Extract Author Data
+### Extract Author Data
 
 You need author's id on biblionet website or his uri
 ```ruby
@@ -195,7 +198,7 @@ The expected result of an author extraction is something like this:
 The convention here is that there is never just a single author, but instead the author hash is stored inside an array. 
 So, it is easy to include metadata for multiple authors or even for multiple types of entities such as publishers or books on the same json file.
 
-#### Extract Publisher Data
+### Extract Publisher Data
 Methods are pretty same as author:
 ```ruby
 # Create a new extractor object with pretty json format.
@@ -266,7 +269,7 @@ The expected result of an author extraction is something like this:
   ]
 }
 ```
-#### Extract Categories
+### Extract Categories
 Biblionet's categories are based on [Dewey Decimal Classification](http://en.wikipedia.org/wiki/Dewey_Decimal_Classification). It is possible to extract these categories also as seen below.
 ```ruby
 # Create a new extractor object with pretty json format.

data/lib/bookshark.rb

@@ -43,7 +43,7 @@ module Bookshark
       author = author_extractor.load_and_extract_author(uri) 
           
       response = {}      
-      response[:author] = [author]
+      response[:author] = !author.nil? ? [author] : []
       response = change_format(response, options[:format])
       return response
     end
@@ -56,7 +56,7 @@ module Bookshark
       publisher = publisher_extractor.load_and_extract_publisher(uri)
       
       response = {}      
-      response[:publisher] = [publisher]
+      response[:publisher] = !publisher.nil? ? [publisher] : []
       response = change_format(response, options[:format])
       response = publisher_extractor.decode_text(response)
 
@@ -78,7 +78,7 @@ module Bookshark
       end
 
       response = {}      
-      response[:book] = [book]
+      response[:book] = !book.nil? ? [book] : []
       response = change_format(response, options[:format])
       response = book_extractor.decode_text(response)
       
@@ -93,7 +93,7 @@ module Bookshark
       category = category_extractor.extract_categories_from(uri)
 
       response = {}      
-      response[:category] = [category]
+      response[:category] = !category.nil? ? [category] : []
       response = change_format(response, options[:format])
       
       return response        

data/lib/bookshark/version.rb

@@ -1,3 +1,3 @@
 module Bookshark
-  VERSION = "1.0.0.alpha.2"
+  VERSION = "1.0.0.alpha.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bookshark
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.2
+  version: 1.0.0.alpha.3
 platform: ruby
 authors:
 - Dimitris Klisiaris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-22 00:00:00.000000000 Z
+date: 2015-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri