RubyGems - google_book - Versions diffs - 0.2.0 - Mend

google_book 0.2.0

Files changed (11) hide show

checksums.yaml +7 -0
data/Gemfile +5 -0
data/README.md +130 -0
data/Rakefile +15 -0
data/lib/google_book.rb +3 -0
data/lib/google_book/base.rb +167 -0
data/lib/google_book/book_info.rb +37 -0
data/lib/google_book/book_item.rb +94 -0
data/spec/base_spec.rb +61 -0
data/spec/book_item_spec.rb +32 -0
metadata +51 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 34025d0e5be1f2a4b0ef1dd93f32d53af55f5899
+  data.tar.gz: 88ea8dc02c2e0f6d780919a49df67c32695c0128
+SHA512:
+  metadata.gz: bc827dacb2afeb540e7284cfd2db63fee4925c716bb2cc36688ddc05d6fb0b1f498cc0a47468b605d308c734d4e80f89c40db1e419ab4f8e119c7c6131396f7c
+  data.tar.gz: 935404e9528281c8da1315174e2fe8eb634e0042ab1142dc921699aeaa82146163b0a4fa407e358769080726debbfa3c32ef13c499f5d99ba1c70a9d3284f1af

data/Gemfile ADDED Viewed

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+gem 'rspec'
+gem 'rake'
+gem 'webmock'

data/README.md ADDED Viewed

@@ -0,0 +1,130 @@
+<html>
+<head>
+<title>Google Book API Integration</title>
+</head>
+<body>
+<div>
+<a href = "https://codeclimate.com/repos/51fa3a5356b102601a00d3e1/feed"><img src="https://codeclimate.com/repos/51fa3a5356b102601a00d3e1/badges/8db2d24d585c3d2ac1f1/gpa.png" /></a>
+ <a href = "https://travis-ci.org/rajcybage/google_book"><img src= "https://travis-ci.org/rajcybage/google_book.png"/></a>
+</div>
+<h1>Google Book ApI Integration</h1><br/>
+<p>You can use it in your web application as well as desktop application to fetch google books</p>
+<div>
+   <h2>Installation</h2>
+    <p>In Gemfile
+    <code>gem 'google_book', git: 'git@github.com:rajcybage/google_book.git'</code>
+    </p>
+</div>
+<div>
+ <h2>System Requirements</h2>
+ <code>Ruby >= 1.9.3 or jruby >=1.7.x</code>
+ <code>rails >= 3.0.x</code>
+</div>
+<div>
+ <h2>Usage</h2>
+ <p>
+ <code>
+   b=GoogleBook::Book.new(:api_key => "YOUR_GOOOGLE_API_KEY")
+ </code><br/>
+ <code>
+   b.search("Name of the book you want to search",type) #type should be a number
+ </code>
+ </p>
+  <ul>
+   <li> type = 1 ===> intitle: Returns results where the text following this keyword is found in the title.</li>
+   <li> type = 2  ===> inauthor: Returns results where the text following this keyword is found in the author.</li>
+   <li> type = 3 ====> inpublisher: Returns results where the text following this keyword is found in the publisher.</li>
+   <li>type = 4 ===> subject: Returns results where the text following this keyword is listed in the category list of the volume.</li>
+   <li>type = 5 ====>isbn: Returns results where the text following this keyword is the ISBN number.</li>
+   <li>ltype = 6 ====> ccn: Returns results where the text following this keyword is the Library of Congress Control Number.</li>
+   <li>type = 7 ===> oclc: Returns results where the text following this keyword is the Online Computer Library Center number.
+   <li> type = 8 ===> Returns the book which can be downloadable</li>
+   </li>
+  </ul>
+  <p>
+   <code>b=GoogleBook::Book.new(:api_key => "YOUR_GOOOGLE_API_KEY")</code> <br/>
+   <code> b.search("keyword or book name",1)</code> <br/>
+   <code>b.book_info.get_all_titles #to get the all titles of your search book</code> <br/>
+   <code>b.book_info.get_all_subtitles # to get all the subtitles of your search book</code>
+   <code>b.total_count #get the search results count</code>
+   </p>
+</div>
+<h2>If you want to access each and every book as an instance of book</h2>
+<p>you can then create a instance of books which was getting by search by following ways</p>
+<div>
+   <code>b=GoogleBook::Book.new(:api_key => "YOUR_GOOOGLE_API_KEY")</code> <br/>
+   <code> b.search("Name of the book you want to search",1)</code> <br/>
+   <code>b.books #create the instance of all the books of your search</code><br/>
+   <code>b.books.first.get_title #get the first book title</code><br/>
+   <code>b.books.first.get_sub_title#get the first book sub title</code><br/>
+   <code>b.books.first.authors #get the first book authors</code><br/>
+   <code>b.books.first.publish_date #get the first book published date</code><br/>
+   <code>b.books.first.preview_link #get the first book preview link</code><br/>
+   <code>b.books.first.info_link #get the first book information</code><br/>
+   <code>b.books.first.thumbnail_image #get the first book thumbnail image</code><br/>
+   <code>b.books.first.small_thumbnail_link #get the first book thumbnail image</code><br/>
+</div>
+<h2>Want to search Downloadable Books</h2>
+<p>
+ <div>
+   <code>b=GoogleBook::Book.new(:api_key => "YOUR_GOOOGLE_API_KEY")</code> <br/>
+   <code>b.search('downloadable book name',8)</code>
+   <code>b.books.first.downloadable?#check whther the book is downloadable</code><br/>
+   <code>b.books.first.buyable?#check whether the book is buyable</code><br/>
+   <code>b.books.first.buy_link</code><br/>
+   <code>b.books.first.download_link</code>
+ </div>
+</p>
+<h2>Want to get Magazines only</h2>
+<p>
+<div>
+   <code>b=GoogleBook::Book.new(:api_key => "YOUR_GOOOGLE_API_KEY")</code> <br/>
+   <code>b.search('downloadable book name',<b>9</b>) #type is 9 for only magazines</code>
+   <code>b.books #create the magaize instances</code><br/>
+   <code>b.books.first.magazine?</code><br/>
+  <span> so on..now get all the info(title,subtitle,author,preview....) of each and every magazine instanaces as stated above</span>
+</div>
+</p>
+<h2>Filter your Search</h2>
+<p>
+  <div>
+    <ul>
+      <li> filter_type = 1 free-ebooks - Only returns results that are free Google eBooks.</li>
+      <li> filter_type = 2 paid-ebooks - Only returns results that are Google eBooks with a price.</li>
+      <li> filter_type = 3 full - Only returns results where all of the text is viewable.</li>
+      <li> filter_type = 4 ebooks - Only returns results that are Google eBooks, paid or free.
+      Examples of non-eBooks would be publisher content that is available in limited preview and not for sale,
+      or magazines.</li>
+    </ul>
+  </div>
+  <div>
+    <code>b=GoogleBook::Book.new(:api_key => "YOUR_GOOOGLE_API_KEY")</code><br/>
+    <code>b.filter('ruby language', 1)#here one is <b>filter_type</b> as defined above</code><br/>
+    <span>Now create all books instance as usual</span><br/>
+    <code>b.books</code>
+    <span><b>If you select your filter as free ebook then it will be downloadable and buyable</b></span><br/>
+    <code>b.books.first.downloadable?#check whther the book is downloadable</code><br/>
+    <code>b.books.first.buyable?#check whether the book is buyable</code><br/>
+    <code>b.books.first.buy_link</code><br/>
+    <code>b.books.first.download_link</code>
+  </div>
+</p>
+</body>
+</html>

data/Rakefile ADDED Viewed

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rspec'
+require 'rspec/core'
+require 'rspec/mocks'
+require 'rspec/expectations'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/*_spec.rb'
+  t.rspec_opts ||= []
+  t.rspec_opts << '--color'
+  t.rspec_opts << '-f documentation'
+end
+task :default => :spec

data/lib/google_book.rb ADDED Viewed

@@ -0,0 +1,3 @@
+require "google_book/base.rb"
+require 'google_book/book_info.rb'
+require 'google_book/book_item.rb'

data/lib/google_book/base.rb ADDED Viewed

@@ -0,0 +1,167 @@
+require 'uri'
+require 'net/http'
+require 'openssl'
+require 'json'
+require_relative 'book_info.rb'
+require_relative 'book_item.rb'
+module GoogleBook
+  class Book
+    attr_accessor :api_key, :total_count, :items, :books
+    def initialize(api_key)
+      unless api_key.nil?
+        @api_key = api_key[:api_key]
+      else
+        raise "Api key can not be nil. Please given your api_key"
+      end
+    end
+    #Google books search
+    def search(query,type = nil)
+      checking_type(type)
+      type = set_type(type) unless type.nil?
+      if query.nil?
+        puts 'Enter the text to search'
+        text = gets
+      end
+      json = JSON.parse(connect_google(@api_key,type,query))
+      @total_count = json["totalItems"]
+      @items = json["items"]
+    end
+    #Google books filtration
+    def filter(query, type = nil)
+      checking_filter_type(type)
+      filter_type = set_filter_type(type) unless type.nil?
+      json = JSON.parse(connect_google(@api_key,nil,query,filter_type))
+      @total_count = json["totalItems"]
+      @items = json["items"]
+    end
+    #get all the books information
+    def book_info
+   	  BookInfo.new(items: @items)
+    end
+    #create all book instances
+    def books
+      @books = []
+      @items.each do |item|
+        @books << BookItem.new(item: item)
+      end
+      return @books
+    end
+    #use for rails application
+    def api_key
+      @api_key = YAML.load_file("#{Rails.root}/config/api_key_google_book.yml")[Rails.env]
+    end
+    def checking_filter_type(type)
+      if type.nil?
+        puts "How you want to filter your search?(example:1)?"
+        puts "1)Free ebooks"
+        puts "2)Paid ebboks"
+        puts "3)Full text"
+        f_type = gets
+      else
+        type = "1"
+      end
+    end
+    def set_filter_type(type)
+      case type.to_i
+      when 1
+        type = "free-ebooks"
+      when 2
+        type = "paid-ebooks"
+      when 3
+        type = "full"
+      else
+        type = "ebooks"
+      end
+    end
+    def checking_type(type)
+      if type.nil?
+        puts "How you want to search?input only list number(ex:1)\n"
+        puts "1)By Title\n"
+        puts "2)By Author Name\n"
+        puts "3)By Publisher\n"
+        puts "4)By Subject\n"
+        puts "5)By ISBN number:- \n"
+        puts "6)Library of Congress Control Number\n"
+        puts "7)By Online Computer Library Center number\n"
+        puts "8)Want to search Downloadable book"
+        puts "9)Want to search downloadable Magazines"
+        type = gets
+      else
+        type = "1"
+      end
+    end
+    def set_type(type)
+      case type.to_i
+      when 1
+        type = "intitle"
+      when 2
+        type = "inauthor"
+      when 3
+        type = "inpublisher"
+      when 4
+        type = "subject"
+      when 5
+        type = "isbn"
+      when 6
+        type = "lccn"
+      when 7
+        type = "oclc"
+      when 8
+        type = "download"
+      when 9
+        type = "magazine"
+      else
+        type =  "inauthor"
+      end
+      return type
+    end
+    def url_formation(api_key = nil,type = nil,search_param = nil, filter = nil)
+      main_url = "https://www.googleapis.com/books/v1/volumes"
+      if !type.nil?
+        url = set_normal_url(api_key, type, search_param, main_url)
+      elsif type.nil? && !filter.nil?
+        url = main_url+"?q=#{search_param.gsub(/\s+/, "+").strip}&filter=#{filter}&key=#{@api_key}"
+      else
+        url = main_url+"?q=#{search_param.gsub(/\s+/, "+").strip}&key=#{@api_key}"
+      end
+      puts "#{url}"
+      return URI(url)
+    end
+    def set_normal_url(api_key, type, search_param, main_url)
+      case type
+       when "download"
+        url = main_url+"?q=#{search_param.gsub(/\s+/, "+").strip}&download=epub&key=#{api_key}"
+       when "magazine"
+        url = main_url+"?q=#{search_param.gsub(/\s+/, "+").strip}&printType=magazines&key=#{api_key}"
+       else
+        url = main_url+"?q=#{search_param.gsub(/\s+/, "").strip}+#{type}:keyes&key=#{api_key}"
+      end
+      return url
+    end
+    def connect_google(key = nil,type = nil,search_param = nil,filter = nil)
+      uri = url_formation(key,type,search_param,filter)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl   = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      response = http.get(uri.request_uri)
+      #      response = Net::HTTP.get_response(uri)
+      return response.body
+    end
+  end
+end

data/lib/google_book/book_info.rb ADDED Viewed

@@ -0,0 +1,37 @@
+require_relative 'base.rb'
+require_relative 'book_item.rb'
+class BookInfo
+  attr_accessor :items, :titles, :subtitles, :book
+  @titles = []
+  @subtitles = []
+  def initialize(items=[])
+    @items = items
+  end
+  #return the all titles of those books
+  def get_all_titles
+    show_all_titles_and_subtitles("title")
+    return @titles
+  end
+  #return all the subtitles
+  def get_all_sub_titles
+    show_all_titles_and_subtitles("subtitle")
+    return @subtitles
+  end
+  #return the particular book
+  def get_book(params = {})
+    item = @items.detect{|i| i[params.keys.first] == params.values.first} || @items.detect{|i| i["volumeInfo"][params.keys.first] == params.values.first}
+    @book = BookItem.new(item: item)
+  end
+  private
+  def show_all_titles_and_subtitles(flag)
+    @items[:items].each do |item|
+      @titles << item["volumeInfo"]["title"]
+    end
+  end
+end

data/lib/google_book/book_item.rb ADDED Viewed

@@ -0,0 +1,94 @@
+require_relative 'book_info.rb'
+require_relative 'base.rb'
+class BookItem
+  attr_reader :item
+  def initialize(item)
+    @item = item
+  end
+  def get_title
+    @item[:item]["volumeInfo"]["title"]
+  end
+  def get_sub_title
+    @item[:item]["volumeInfo"]["subtitle"]
+  end
+  def authors
+    @item[:item]["volumeInfo"]["authors"]
+  end
+  def publish_date
+    @item[:item]["volumeInfo"]["publishedDate"]
+  end
+  def preview_link
+    @item[:item]["volumeInfo"]["previewLink"]
+  end
+  def info_link
+    @item[:item]["volumeInfo"]["infoLink"]
+  end
+  def canonical_volume_link
+    @item[:item]["volumeInfo"]["canonicalVolumeLink"]
+  end
+  def thubnail_image
+    @item[:item]["volumeInfo"]["imageLinks"]["thumbnail"]
+  end
+  def small_thumbnail_link
+    @item[:item]["volumeInfo"]["imageLinks"]["smallThumbnail"]
+  end
+  def pagecount
+    @item[:item]["volumeInfo"]["pageCount"]
+  end
+  def web_reader_link
+    @item[:item]["accessInfo"]["webReaderLink"]
+  end
+  def buy_link
+    if buyable?
+      @item[:item]["saleInfo"]["buyLink"]
+    else
+      "your book is not buyable"
+    end
+  end
+  def magazine?
+    if @item[:item]["volumeInfo"]["printType"].upcase == "MAGAZINE"
+      true
+    else
+      false
+    end
+  end
+  def downloadable?
+    unless @item[:item]["accessInfo"]["pdf"].nil? || @item[:item]["accessInfo"]["pdf"]["downloadLink"].nil?
+      true
+    else
+      false
+    end
+  end
+  def buyable?
+    if @item[:item]["saleInfo"]["isEbook"] != true ||  @item[:item]["saleInfo"]["buyLink"].nil?
+      false
+    else
+      true
+    end
+  end
+  def download_link
+    if downloadable?
+      @item[:item]["accessInfo"]["pdf"]["downloadLink"]
+    else
+      "your book is not downloadable"
+    end
+  end
+end

data/spec/base_spec.rb ADDED Viewed

@@ -0,0 +1,61 @@
+require_relative '../lib/google_book/base.rb'
+require_relative '../lib/google_book/book_item.rb'
+require_relative 'spec_helper.rb'
+describe "base" do
+  let(:api_key){"AIzaSyD82ugogyUN7bAZ4k2UaLlVCep5NxZVYNM"}
+  before(:all) do
+    @con_book = GoogleBook::Book.new(:api_key => api_key)
+  end
+  describe "google_connect" do
+    it "should connect google book" do
+      stub_request(:get, "https://www.googleapis.com/books/v1/volumes?q=flowers+inauthor:keyes&key=#{api_key}").to_return(:body => "abc")
+    end
+  end
+  describe "initialize" do
+    it "should connect googlebook api properly" do
+      @con_book.should_not be_nil
+      @con_book.should be_a_kind_of(Object)
+    end
+  end
+  describe "search" do
+    it "should  return anything type" do
+      @con_book.search('flowers',2).should_not be_nil
+      @con_book.search('flowers',2).should be_a_kind_of(Array)
+    end
+    it "should return all books items is eual to the items of the book object" do
+      @con_book.search('Flowers',2).should eq @con_book.items
+    end
+    it "should return magazines after giving filter" do
+      @con_book.search('Flowers',9)
+      @con_book.books.first.magazine?.should be_true
+    end
+  end
+  describe "filters" do
+    it "should return results while using diffferent filters" do
+     @con_book.filter('Ruby Language', 1).should_not be_nil
+     @con_book.books.first.buy_link.should_not be_nil
+    end
+    it "should also show downloadable books for free_ebook filter" do
+      @con_book.filter('Ruby Language', 1).should_not be_nil
+      @con_book.books.first.download_link.should_not be_nil
+    end
+  end
+  describe "books" do
+    before(:all) do
+      @con_book.search('Flowers',2)
+    end
+    it "should create all the books instance" do
+      @con_book.books.should be_a_kind_of(Array)
+      @con_book.books.first.should be_a_kind_of(Object)
+    end
+  end
+end

data/spec/book_item_spec.rb ADDED Viewed

@@ -0,0 +1,32 @@
+require_relative '../lib/google_book/base.rb'
+require_relative '../lib/google_book/book_item.rb'
+require_relative 'spec_helper.rb'
+describe "book_item" do
+  let(:api_key){"AIzaSyD82ugogyUN7bAZ4k2UaLlVCep5NxZVYNM"}
+  before(:all) do
+    @con_book = GoogleBook::Book.new(:api_key => api_key)
+    @con_book.search("Flowers",2)
+    @book_items = @con_book.books
+  end
+  describe "initialize" do
+    it "should have same instance" do
+      @book_items.first.should be_a_kind_of(Object)
+      @book_items.first.item[:item]["id"].should eq(BookItem.new(item: @con_book.search("Flowers",2).first).item[:item]["id"])
+    end
+  end
+  describe "get_title" do
+    it "should return proper title" do
+      @book_items.first.get_title.should eq(@book_items.first.item[:item]["volumeInfo"]["title"])
+    end
+  end
+  describe "get_sub_title" do
+    it "should return proper subtitle" do
+      @book_items.first.get_sub_title.should eq(@book_items.first.item[:item]["volumeInfo"]["subtitle"])
+    end
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: google_book
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Rajarshi Das
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-07-30 00:00:00.000000000 Z
+dependencies: []
+description: Integrate the google book api into your app
+email: rdasarminus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Gemfile
+- Rakefile
+- spec/base_spec.rb
+- spec/book_item_spec.rb
+- lib/google_book.rb
+- lib/google_book/base.rb
+- lib/google_book/book_info.rb
+- lib/google_book/book_item.rb
+homepage: https://github.com/rajcybage/google_book
+licenses: []
+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: []
+rubyforge_project:
+rubygems_version: 2.0.3
+signing_key:
+specification_version: 4
+summary: Google Book API integration
+test_files: []