bookboon 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d030df759978c463fe5a49e2dd3f190a20895fd1
+  data.tar.gz: f11f661c5bb898a902c94585255ab039f12bd16a
+SHA512:
+  metadata.gz: 398edc351767c54cc13e26a946a13e5a7fef5b2827816f63251a73e0c7c0c7ec12f7cc60f2e596a351e83e187e659bd775b9b48da4c70122d6ea6500558e7900
+  data.tar.gz: 7121ab926ab706525e07fc4bcc1d8d4831f6b348207203f06b5d109af1f820085176566c29de001d8b5a9832bcc2a981e1ee0e9f213543d58f7470e28c6649ae

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at dennispaagman@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bookboon.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Springest
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+# Bookboon
+
+This gem is a simple API wrapper for the [Bookboon API](https://github.com/bookboon/api).
+> Bookboon.com is the world’s largest publisher of online educational literature. We provide free textbooks for university students, premium eBooks for business professionals and learning solutions for companies.
+
+For access to the API please consult Bookboon directly.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bookboon'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bookboon
+
+## Usage
+
+### Set up
+
+```ruby
+client = Bookboon::Client.new do |config|
+  config.id = "..."
+  config.secret = "..."
+end
+```
+
+Additional config settings are available:
+
+```ruby
+config.language = "..." # Defaults to "en", see Bookboon API reference for available languages
+config.branding_id = "..." # Defaults to nil
+config.rotation = "..." # Defaults to nil
+```
+
+### Available methods
+
+Please refer to the official [Bookboon API Reference](https://github.com/bookboon/api/blob/master/Reference.md) for structure of the output. Right now no transformation of any kind is done, we just return the output from Bookboon as pure JSON, except for the `download_book` method, which returns a temporary URL to download the book directly.
+
+* `client.categories`
+* `client.category(id)`
+* `client.search(term)`
+* `client.book(id)`
+* `client.download_book(id, handle)`
+
+### To be implemented
+
+1. Questions
+2. Recommendations
+
+Want to help implementing these end points? Check out the Contributing part below.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bookboon. 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/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bookboon"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bookboon.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bookboon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bookboon"
+  spec.version       = Bookboon::VERSION
+  spec.authors       = ["Dennis Paagman"]
+  spec.email         = ["dennispaagman@gmail.com"]
+
+  spec.summary       = %q{Ruby API wrapper for the Bookboon API}
+  spec.homepage      = "https://github.com/springest/bookboon"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "httparty", " ~> 0.13"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "webmock", "~> 2.1"
+end

data/lib/bookboon.rb

@@ -0,0 +1,8 @@
+require "httparty"
+require "bookboon/version"
+require "bookboon/config"
+require "bookboon/client"
+
+module Bookboon
+  # Your code goes here...
+end

data/lib/bookboon/client.rb

@@ -0,0 +1,65 @@
+module Bookboon
+  class Client
+    attr_accessor :last_request
+
+    def initialize
+      if block_given?
+        yield(config)
+      end
+    end
+
+    def categories
+      get("categories")
+    end
+
+    def category(id)
+      get("categories/#{id}")
+    end
+
+    def search(term)
+      get("search", query: { q: term })
+    end
+
+    def book(id)
+      get("books/#{id}")
+    end
+
+    def download_book(id, handle)
+      request = post("books/#{id}/download", body: { handle: handle })
+
+      request.headers['location']
+    end
+
+    # TODO: Implement /questions
+    # TODO: Implement /recommendations
+
+    protected
+
+    def config
+      @config ||= Bookboon::Config.new
+    end
+
+    def request(method, path, options)
+      uri = URI("https://bookboon.com/api/#{path}")
+
+      options = {
+        basic_auth: {
+          username: config.id,
+          password: config.secret,
+        },
+        headers: config.headers,
+        follow_redirects: false,
+      }.merge(options)
+
+      HTTParty.send(method, uri, options)
+    end
+
+    def get(path, options = {})
+      request(:get, path, options)
+    end
+
+    def post(path, options = {})
+      request(:post, path, options)
+    end
+  end
+end

data/lib/bookboon/config.rb

@@ -0,0 +1,19 @@
+module Bookboon
+  class Config
+    attr_accessor :id, :secret, :branding_id, :rotation_id, :language
+
+    def initialize
+      @language = "en"
+    end
+
+    def headers
+      _headers = {}
+
+      _headers["Accept-Language"] = @language
+      _headers["X-Bookboon-Branding"] = branding_id if branding_id
+      _headers["X-Bookboon-Rotation"] = rotation_id if rotation_id
+
+      _headers
+    end
+  end
+end

data/lib/bookboon/version.rb

@@ -0,0 +1,3 @@
+module Bookboon
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: bookboon
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dennis Paagman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: 
+email:
+- dennispaagman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bookboon.gemspec
+- lib/bookboon.rb
+- lib/bookboon/client.rb
+- lib/bookboon/config.rb
+- lib/bookboon/version.rb
+homepage: https://github.com/springest/bookboon
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby API wrapper for the Bookboon API
+test_files: []
+has_rdoc: