gitbook-api 0.0.0.pre.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 95bed6cf4f2409bd3d05464e99ccfc67746888b3
+  data.tar.gz: 91e4f1a0a26d603f73ddb742cf725f7021e497e0
+SHA512:
+  metadata.gz: 77ec0e00ebe1acccb86a505104188ff6673678efb94e8c8481e693eae877cdbbff502e052eb626d83223aa5dcf059fe81ca97613fc8f2c74b80291224a5bdc31
+  data.tar.gz: 8093c14f4489bdff50800a122b9ecad8f2ce48f1a364d07c5c52bc750a561d8474726f1f0abc194be9f80eaaf2d07573e108c0c9bb3f363bc3ca5680e02d0436

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+/pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/Gemfile

@@ -0,0 +1,12 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in gitbook_api-gitbook.gemspec
+gemspec
+
+group :development, :test do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+  gem 'rb-fsevent'
+  gem 'growl'
+end

data/Guardfile

@@ -0,0 +1,10 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch('gitbook_api.gemspec')
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Calvin Huang
+
+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,20 @@
+# gitbook-api
+Ruby unofficial API for GitBook.
+
+- [ ] Add / Remove star.
+- [ ] Check is starred.
+- [x] Fetch starred books by specify username.
+- [ ] Fetch authenticated user's own books.
+- [ ] Oauth2 exchange to authenticate user (Maybe use omniauth-gitbook?).
+- [ ] Use username and password to authenticate user.
+- [ ] Create book.
+- [ ] Update book.
+- [ ] Manage book setting.
+- [ ] Search book in gitbook.com.
+- [ ] Fetch book's detail information.
+
+## Contribution
+I'm appreciate at any improvement, please feel free to open PR / Issue to this repo or you can contact [me](https://github.com/Calvin-Huang).
+
+## License
+Copyright (c) [Calvin Huang](https://github.com/Calvin-Huang). This software is licensed under the [MIT License](https://github.com/Calvin-Huang/CHRealHideUIView/blob/master/LICENSE).

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+desc 'Run specs'
+task :default => :spec

data/gitbook_api.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/gitbook_api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Calvin Huang"]
+  gem.email         = ["calvin.peak@capslock.tw"]
+  gem.description   = %q{Ruby unofficial API for gitbook.com.}
+  gem.summary       = %q{Ruby unofficial API for gitbook.com.}
+  gem.homepage      = "https://github.com/Calvin-Huang/gitbook-api"
+  gem.license       = "MIT"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "gitbook-api"
+  gem.require_paths = ["lib"]
+  gem.version       = GitBook::VERSION
+
+  gem.add_dependency 'omniauth', '~> 1.0'
+  gem.add_dependency 'omniauth-oauth2', '>= 1.1.1', '< 2.0'
+  gem.add_dependency 'omniauth-gitbook', '>= 1.0.0', '< 2.0'
+  gem.add_dependency 'nokogiri', '~> 1.0'
+  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'webmock'
+end

data/lib/gitbook_api.rb

@@ -0,0 +1,35 @@
+require 'rake'
+
+require 'gitbook_api/version'
+require 'gitbook_api/configurable'
+require 'gitbook_api/api'
+
+module GitBook
+  class << self
+    include GitBook::Configurable
+
+    def api
+      # Return a new instance if option in GitBook different to GItBook::API
+      return @api if defined?(@api) && @api.same_options?(options)
+      @api = GitBook::API.new(options)
+    end
+
+    def logger
+      # config.logger
+    end
+
+    private
+
+    def respond_to_missing?(method_name, include_private=false)
+      api.respond_to?(method_name, include_private)
+    end
+
+    def method_missing(method_name, *args, &block)
+      if api.respond_to?(method_name)
+        return api.send(method_name, *args, &block)
+      end
+
+      super
+    end
+  end
+end

data/lib/gitbook_api/api.rb

@@ -0,0 +1,15 @@
+require 'gitbook_api/configurable'
+require 'gitbook_api/api/stars'
+
+module GitBook
+  class API
+    include GitBook::Configurable
+    include GitBook::API::Stars
+
+    def initialize(options = {})
+      GitBook::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || GitBook.options.instance_variable_get(:"@#{key}"))
+      end
+    end
+  end
+end

data/lib/gitbook_api/api/stars.rb

@@ -0,0 +1,27 @@
+require 'faraday'
+require 'nokogiri'
+require 'json'
+
+module GitBook
+  class API
+    module Stars
+      def stars(username = nil)
+        response = Faraday.get "#{base_url}/@#{username}/starred"
+
+        html_doc = Nokogiri::HTML(response.body)
+        books = html_doc.css('#AuthorProfile .Books:first-child .Book')
+        books.map do |book|
+          anchor = book.css('h4.title > a')
+          book_infos = anchor.attr('href').text.split('/')
+
+          {
+              id: book_infos.last,
+              author: book_infos[book_infos.length - 2],
+              title: anchor.text,
+              description: book.css('p.description').text
+          }
+        end
+      end
+    end
+  end
+end

data/lib/gitbook_api/configurable.rb

@@ -0,0 +1,40 @@
+module GitBook
+  module Configurable
+    attr_accessor :base_url, :api_url, :username, :password, :access_token
+
+    def self.keys
+      @keys ||= [
+          :base_url,
+          :api_url,
+          :username,
+          :password,
+          :access_token,
+      ]
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      Hash[GitBook::Configurable.keys.map{ |key| [key, send(key)] }]
+    end
+
+    def same_options?(options_to_compare)
+      options_to_compare.hash == options.hash
+    end
+
+    def reset_configuration
+      GitBook::Configurable.keys.each { |key| send("#{key}=", nil) }
+    end
+
+    # Getter will assign default value
+    def base_url
+      @base_url ||= 'https://www.gitbook.com'
+    end
+
+    def api_url
+      @api_url ||= 'https://api.gitbook.com'
+    end
+  end
+end

data/lib/gitbook_api/version.rb

@@ -0,0 +1,3 @@
+module GitBook
+  VERSION = '0.0.0-alpha.1'
+end

data/spec/gitbook_api/api_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe GitBook::API do
+  let(:tester_username) { 'gitbookreader-tester' }
+
+  describe GitBook::API::Stars do
+    describe '#list' do
+      it "should request user's stars and convert to json format" do
+        stars = GitBook.api.stars tester_username
+        expected_data = [
+            {
+                id: 'test',
+                author: 'calvin-huang',
+                title: 'Test book for GitBookReader',
+                description: "iOS repo - https://github.com/Calvin-Huang/GitbookReader-iOS\r\nRails repo - https://github.com/Calvin-Huang/GitbookReader\r\nThis repo will not remove for unit test,",
+            }
+        ]
+
+        expect(stars).to eq(expected_data)
+      end
+    end
+  end
+end

data/spec/gitbook_api/configure_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe GitBook::Configurable do
+  describe '#options' do
+    api = GitBook::API.new
+
+    it 'should have options hash map and it have same value with variable' do
+      expect(api.options[:base_url]).to eq(api.base_url)
+      expect(api.options[:api_url]).to eq(api.api_url)
+      expect(api.options[:username]).to eq(api.username)
+      expect(api.options[:password]).to eq(api.password)
+      expect(api.options[:access_token]).to eq(api.access_token)
+    end
+  end
+
+  context 'Initialize GitBook::API with default settings' do
+    subject do
+      GitBook::API.new
+    end
+
+    it 'should have default base url' do
+      expect(subject.base_url).to eq('https://www.gitbook.com')
+      expect(subject.options[:base_url]).to eq('https://www.gitbook.com')
+    end
+
+    it 'should have default api url' do
+      expect(subject.api_url).to eq('https://api.gitbook.com')
+      expect(subject.options[:api_url]).to eq('https://api.gitbook.com')
+    end
+
+    it 'should not have usename default' do
+      expect(subject.username).to be_nil
+      expect(subject.options[:username]).to be_nil
+    end
+
+    it 'should not have password default' do
+      expect(subject.password).to be_nil
+      expect(subject.options[:password]).to be_nil
+    end
+
+    it 'should not have access token default' do
+      expect(subject.access_token).to be_nil
+      expect(subject.options[:access_token]).to be_nil
+    end
+  end
+
+  context 'Configure with block' do
+    let(:base_url) { 'https://enterprise.gitbook.com' }
+    let(:api_url) { 'https://api.enterprise.gitbook.com'}
+    let(:username) { 'foo' }
+    let(:password) { 'boo' }
+    let(:access_token) { 'ewjdo1zjqweo123@$6933' }
+
+    subject do
+      GitBook.configure do |config|
+        config.base_url = base_url
+        config.api_url = api_url
+        config.username = username
+        config.password = password
+        config.access_token = access_token
+      end
+
+      GitBook.api
+    end
+
+    it 'should match base url' do
+      expect(subject.base_url).to eq(base_url)
+      expect(subject.options[:base_url]).to eq(base_url)
+    end
+
+    it 'should match api url' do
+      expect(subject.api_url).to eq(api_url)
+      expect(subject.options[:api_url]).to eq(api_url)
+    end
+
+    it 'should match username' do
+      expect(subject.username).to eq(username)
+      expect(subject.options[:username]).to eq(username)
+    end
+
+    it 'should match password' do
+      expect(subject.password).to eq(password)
+      expect(subject.options[:password]).to eq(password)
+    end
+
+    it 'should match auth_token' do
+      expect(subject.access_token).to eq(access_token)
+      expect(subject.options[:access_token]).to eq(access_token)
+    end
+  end
+
+  after(:all) do
+    GitBook.reset_configuration
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rspec'
+require 'rack/test'
+# require 'webmock/rspec'
+require 'gitbook_api'
+
+RSpec.configure do |config|
+  # config.include WebMock::API
+  config.include Rack::Test::Methods
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: gitbook-api
+version: !ruby/object:Gem::Version
+  version: 0.0.0.pre.alpha.1
+platform: ruby
+authors:
+- Calvin Huang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-gitbook
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: Ruby unofficial API for gitbook.com.
+email:
+- calvin.peak@capslock.tw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- gitbook_api.gemspec
+- lib/gitbook_api.rb
+- lib/gitbook_api/api.rb
+- lib/gitbook_api/api/stars.rb
+- lib/gitbook_api/configurable.rb
+- lib/gitbook_api/version.rb
+- spec/gitbook_api/api_spec.rb
+- spec/gitbook_api/configure_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Calvin-Huang/gitbook-api
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Ruby unofficial API for gitbook.com.
+test_files:
+- spec/gitbook_api/api_spec.rb
+- spec/gitbook_api/configure_spec.rb
+- spec/spec_helper.rb