boogle 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eef6b4fa7ee0f2a43dfd7b67ecf43e077f5faf67
-  data.tar.gz: 26f34e9ea8a84f292dc787f9c6ad0acec08a438a
+  metadata.gz: 240af5c6cda7443ced93e8e4f40cc361bf1f7cf2
+  data.tar.gz: aadf3010e3b63d7f39188284dfb163af1c85f674
 SHA512:
-  metadata.gz: 2d5b5b84d26beeac3c60ab9721483cec112e18db5053fb1ac5a85eb32b8401e3819ee0c06d2e3318dcdcacbe34e9dfb3b8680c8f44a8a5731050bc3bb0ac2a0c
-  data.tar.gz: d15c90229fd3a39b2f896df054fa28c53a9977d8cb1fbe86a58ea65fdd0a38baef9b8d5650e8333268b36eebd4fcd01bca3c22feeebe0bc2084d7e452a463749
+  metadata.gz: 1a1b13067929259131a322bab92ed214fdfb0b86cedb2f07c9e0848dc919dab019fc216e2c7b948f9396fbaa75ac52d10c604299cccfab86c15f24ed952c0b8a
+  data.tar.gz: 137ac017c58ee136fcb90773247231f54521a1d913246f74d7e03601e5503b56e0e6797c3ba3f7b2e77fadf8926e0f312b5aff028bf3b533b03b2e75fea4e030

data/README.md

@@ -1,9 +1,6 @@
 # Boogle
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/boogle`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
+Boogle is a gem that takes off your hands from the haslle of dealing with [google books APIs](https://www.google.com)
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -21,21 +18,66 @@ Or install it yourself as:
     $ gem install boogle
 
 ## Usage
+#### 1 - Set the base connection
+```ruby
+boogle = Boogle::Client.new(key: 'api_key')
+```
+
+#### 2 - search for books
+search by key word only
+```ruby
+boogle.volume.search(keyword: 'flowers')
+```
+you can choose to search in specific field by
+```ruby
+booble.volume.search(keyword: 'flower', field: 'intitle')
+```
+[here is a list of other feilds](https://developers.google.com/books/docs/v1/using#PerformingSearch)
 
-TODO: Write usage instructions here
+#### 3 - get book by id
+
+```ruby
+boogle.volume.find(id: '_oG_iTxP1pIC')
+```
+
+#### 4 - list of books
+```ruby
+boogle.volume.list(user_id: '', bookshelf_id: '')
+```
+#### 5 - return libarary books
+```ruby
+boogle.volume.mylibrary(auth_token: '',  bookshelf_id: '')
+```
+#### 6 - remove a book
+```ruby
+boogle.volume.remove(auth_token: '', book_id: '', bookshelf_id: '')
+```
+#### 7 - Clearing all volumes from my bookshelf
+```ruby
+boogle.volume.clear(auth_token: '', bookshelf_id: '')
+```
 
-## Development
+## Dealing with bookshelf
 
-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.
+#### 1- list user's bookshelves
+```ruby
+boogle.bookshelf.list(user_id: '')
+```
 
-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).
+#### 2 - find specific bookshelf
+```ruby
+boogle.bookshelf.find(user_id: '', bookshelf_id: '')
+```
 
+#### 3- my libarary bookshelves
+```ruby
+boogle.bookshelf.mylibarary(auth_token: '')
+```
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/boogle. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/hassantc/boogle. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/boogle.gemspec

@@ -20,8 +20,11 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-
+  spec.add_dependency('faraday')
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'mocha', '~> 1.0'
+  spec.add_development_dependency "fakeweb", ["~> 1.3"]
+  spec.add_development_dependency 'byebug'
 end

data/lib/boogle.rb

@@ -1,5 +1,17 @@
-require "boogle/version"
+require 'boogle/version'
+require 'boogle/client' # user will deal with it
+
+# google server will deal with those
+require 'boogle/service/connection'
+require 'boogle/service/request'
+
+# how the object will render
+require 'boogle/traits/volume'
+require 'boogle/traits/bookshelf'
+
+# object operations
+require 'boogle/volume'
+require 'boogle/bookshelf'
 
 module Boogle
-  # Your code goes here...
 end

data/lib/boogle/bookshelf.rb

@@ -0,0 +1,21 @@
+module Boogle
+  class Bookshelf
+    attr_accessor :key
+
+    def initialize(key)
+      @key = key
+    end
+
+    def list(user_id: '')
+      Boogle::Service::Request.search(@key, "users/#{user_id}/bookshelves", {})
+    end
+
+    def find(user_id: '', bookshelf_id: '')
+      Boogle::Service::Request.find(@key, "users/#{user_id}/bookshelves", bookshelf_id)
+    end
+
+    def mylibrary(auth_token: nil)
+      Boogle::Service::Request.mylibrary(auth_token, @key, 'mylibrary/bookshelves')
+    end
+  end
+end

data/lib/boogle/client.rb

@@ -0,0 +1,20 @@
+module Boogle
+  class MisconfiguredClientError < StandardError; end
+
+  class Client
+    attr_accessor :key
+
+    def initialize(key: nil)
+      raise MisconfiguredClientError if key.nil? || key.empty? || !key.is_a?(String)
+      @key = key
+    end
+
+    def volume
+      Boogle::Volume.new(key)
+    end
+
+    def bookshelf
+      Boogle::Bookshelf.new(key)
+    end
+  end
+end

data/lib/boogle/errors.rb

@@ -0,0 +1,20 @@
+module Boogle
+  # base class exception from which all public Google books exceptions
+  class BoogleErrors < StandardError; end
+  # 400: Bad Request
+  class BadRequest < BoogleErrors; end
+  # 400: Invalid Sharing Request
+  # 401: Invalid Credentials
+  class InvalidCredentials < BoogleError; end
+  # 403: Daily Limit Exceeded
+  # 403: User Rate Limit Exceeded
+  # 403: Rate Limit Exceeded
+  # 403: Sharing Rate Limit Exceeded
+  class LimitExceedeed < BoogleError; end
+  # 404: resource not found: {fileId}
+  class ResourceNotFound < BoogleError; end
+  # 429: Too Many Requests
+  class TooManyRequests < BoogleError; end
+  # 500: Backend Error
+  class UnexpectedError < BoogleError; end
+end

data/lib/boogle/service/connection.rb

@@ -0,0 +1,19 @@
+require 'faraday'
+require 'json'
+
+module Boogle
+  module Service
+    class Connection
+      BASE_URL = 'https://www.googleapis.com/books/v1/'
+
+      def self.api(key)
+        Faraday.new(url: BASE_URL) do |faraday|
+          faraday.response :logger
+          faraday.adapter Faraday.default_adapter
+          faraday.headers['Content-Type'] = 'application/json'
+          faraday.params['key'] = key
+        end
+      end
+    end
+  end
+end

data/lib/boogle/service/request.rb

@@ -0,0 +1,89 @@
+require 'byebug'
+
+module Boogle
+  module Service
+    class Request
+      class << self
+
+        def find(key, path, id)
+          response = api(key).get("#{path}/#{id}")
+          response.status == 200 ? handle_find_response(response.body) : errors(response)
+        end
+
+        def add(auth_token, key, path)
+          response = api(key).post do |req|
+            req.url path
+            req.headers['Authorization'] = auth_token
+          end
+          response.status == 200 ? true : errors(response)
+        end
+
+        def remove(auth_token, key, path)
+          response = api(key).post do |req|
+            req.url path
+            req.headers['Authorization'] = auth_token
+          end
+          response.status == 200 ? true : errors(response)
+        end
+
+        def clear(auth_token, key, path)
+          response = api(key).post do |req|
+            req.url path
+            req.headers['Authorization'] = auth_token
+          end
+          response.status == 200 ? true : errors(response)
+        end
+
+        def search(key, path, params)
+          response = api(key).get do |req|
+            req.url path, params
+          end
+          response.status == 200 ? handle_search_response(response.body) : errors(response)
+        end
+
+        def mylibrary(auth_token, key, path)
+          response = api(key).get do |req|
+            req.url path
+            req.headers['Authorization'] = auth_token
+          end
+          response.status == 200 ? handle_search_response(response.body) : errors(response)
+        end
+
+        def errors(response)
+          case response.status
+          when 400
+            raise Boogle::BadRequest, 'Bad rquest, please check your path again'
+          when 401
+            raise Boogle::InvalidCredentials, 'Check your Credentials'
+          when 403
+            raise Boogle::LimitExceedeed, 'you reached your limits'
+          when 404
+            raise Boogle::ResourceNotFound, 'Resource Not Found'
+          when 429
+            raise Boogle::TooManyRequests, 'Too many Requests'
+          else
+            raise Boogle::UnexpectedError, 'Something went wrong'
+          end
+        end
+
+        def handle_find_response(response)
+          response = JSON.parse(response)
+          response['kind'].include?('books#bookshelves') ? Boogle::Traits::Bookshelf.new(response) : Boogle::Traits::Volume.new(response)
+        end
+
+        def handle_search_response(response)
+          response = JSON.parse(response)
+          return [] unless response['items']
+          klass = response['kind'].include?('books#bookshelves') ? Boogle::Traits::Bookshelf : Boogle::Traits::Volume
+          response['items'].map do |item|
+            klass.new(item)
+          end
+        end
+
+        def api(key)
+          Boogle::Service::Connection.api(key)
+        end
+      end
+    end
+  end
+end

data/lib/boogle/traits/bookshelf.rb

@@ -0,0 +1,26 @@
+module Boogle
+  module Traits
+    class Bookshelf
+      attr_accessor :id, :kind, :self_link, :title, :description, :access
+      attr_accessor :created, :volume_count, :volumes_last_updated
+
+      def initialize(bookshelf_response)
+        convert_response_to_obj(bookshelf_response)
+      end
+
+      private
+
+      def convert_response_to_obj(bookshelf)
+        @id = bookshelf['id']
+        @kind = bookshelf['kind']
+        @self_link = bookshelf['selfLink']
+        @title = bookshelf['title']
+        @description = bookshelf['description']
+        @access = bookshelf['access']
+        @created = bookshelf['created']
+        @volume_count = bookshelf['volumeCount']
+        @volumes_last_updated = bookshelf['volumesLastUpdated']
+      end
+    end
+  end
+end

data/lib/boogle/traits/volume.rb

@@ -0,0 +1,57 @@
+module Boogle
+  module Traits
+    class Volume
+      attr_accessor :page_count, :printed_page_count, :print_type, :average_rating
+      attr_accessor :kind, :self_link, :etag, :authors, :published_date, :language
+      attr_accessor :allow_a_non_logging, :content_version, :panelization_summary
+      attr_accessor :publisher, :description, :industry_identifiers, :categories
+      attr_accessor :ratings_count, :maturity_rating, :image_links, :layer_info
+      attr_accessor :offers, :access_info, :quote_sharing_allowed, :volume_info
+      attr_accessor :id, :title, :access_view_status, :preview_link, :infoLink
+      attr_accessor :sale_info, :retail_price, :web_reader_link, :buy_link
+      attr_accessor :canonical_volume_link
+
+      def initialize(volume_response)
+        convert_response_to_obj(volume_response)
+      end
+
+      private
+
+      def convert_response_to_obj(volume)
+        @kind = volume['kind']
+        @id = volume['id']
+        @volume_info = volume['volumeInfo']
+        @title = volume['volumeInfo']['title']
+        @authors = volume['volumeInfo']['authors']
+        @publisher = volume['publisher']
+        @published_date = volume['publishedDate']
+        @description = volume['description']
+        @industry_identifiers = volume['industryIdentifiers']
+        @page_count = volume['pageCount']
+        @printed_page_count = volume['printedPageCount']
+        @print_type = volume['printType']
+        @categories = volume['categories']
+        @average_rating = volume['averageRating']
+        @ratings_count = volume['ratingsCount']
+        @maturity_rating = volume['maturityRating']
+        @allow_a_non_logging = volume['allowAnonLogging']
+        @content_version = volume['contentVersion']
+        @panelization_summary = volume['panelizationSummary']
+        @image_links = volume['imageLinks']
+        @language = volume['language']
+        @preview_link = volume['preview_link']
+        @info_link = volume['infoLink']
+        @canonical_volume_link = volume['canonicalVolumeLink']
+        @layer_info = volume['layerInfo']
+        @sale_info = volume['saleInfo']
+        @retail_price = volume['retailPrice']
+        @buy_link = volume['buyLink']
+        @offers = volume['offers']
+        @access_info = volume['accessInfo']
+        @web_reader_link = volume['webReaderLink']
+        @access_view_status = volume['accessViewStatus']
+        @quote_sharing_allowed = volume['quoteSharingAllowed']
+      end
+    end
+  end
+end

data/lib/boogle/version.rb

@@ -1,3 +1,3 @@
 module Boogle
-  VERSION = "0.0.0"
+  VERSION = "0.1.0"
 end

data/lib/boogle/volume.rb

@@ -0,0 +1,46 @@
+module Boogle
+  class Volume
+    attr_accessor :key
+    def initialize(key)
+      @key = key
+    end
+
+    def find(id: '')
+      Boogle::Service::Request.find(@key, 'volumes', id)
+    end
+
+    def search(keyword: '', field: nil, download: nil, filter: nil, page: 1, per_page: 5, order_by: nil, projection: nil, type: 'all')
+      search_params = { q: query(keyword, field), download: download,
+                        filter: filter, startIndex: page, maxResults: per_page,
+                        printType: type, projection: projection,
+                        orderBy: order_by }.reject { |_, v| v.nil? }
+      Boogle::Service::Request.search(@key, 'volumes', search_params)
+    end
+
+    def list(user_id: '', bookshelf_id: '')
+      Boogle::Service::Request.search(@key, "users/#{user_id}/bookshelves/#{bookshelf_id}/volumes", {})
+    end
+
+    def mylibrary(auth_token: nil, bookshelf_id: '')
+      Booogle::Service::Request.mylibrary(auth_token, @key, "mylibrary/bookshelves/#{bookshelf_id}/volumes")
+    end
+
+    def add(auth_token: nil, book_id: '', bookshelf_id: '')
+      Booogle::Service::Request.add(auth_token, @key, "mylibrary/bookshelves/#{bookshelf_id}/addVolume?volumeId=#{book_id}")
+    end
+
+    def remove(auth_token: nil, book_id: '', bookshelf_id: '')
+      Booogle::Service::Request.add(auth_token, @key, "mylibrary/bookshelves/#{bookshelf_id}/removeVolume?volumeId=#{book_id}")
+    end
+
+    def clear(auth_token: nil, bookshelf_id: '')
+      Booogle::Service::Request.clear(auth_token, @key, "mylibrary/bookshelves/#{bookshelf_id}/clearVolumes")
+    end
+
+    private
+
+    def query(keyword, field)
+      field ? "#{keyword}+#{field}:keys" : keyword
+    end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: boogle
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - HassanTC
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-25 00:00:00.000000000 Z
+date: 2017-12-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: boogle is a gem that handle the google books apis hassle
 email:
 - hassan.mahmoud1@outlook.com
@@ -59,6 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".byebug_history"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -71,7 +128,15 @@ files:
 - bin/setup
 - boogle.gemspec
 - lib/boogle.rb
+- lib/boogle/bookshelf.rb
+- lib/boogle/client.rb
+- lib/boogle/errors.rb
+- lib/boogle/service/connection.rb
+- lib/boogle/service/request.rb
+- lib/boogle/traits/bookshelf.rb
+- lib/boogle/traits/volume.rb
 - lib/boogle/version.rb
+- lib/boogle/volume.rb
 homepage: https://github.com/HassanTC/boogle
 licenses:
 - MIT