pandago 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b496baf2827941a7ab499913c8fca16712e59d3b
+  data.tar.gz: c63e53c21576c4243bce1d4b8ba4c026d5b1a3e6
+SHA512:
+  metadata.gz: c5189be34f79d40b261043a98611f6a64a12958b1e23388184650fe7326808ec966cebb0e606fc7b99c298c37bd4c94cbffc97461cccec2c6e4cc402f919345c
+  data.tar.gz: d6c15de0d20286e52270ca2b57b2920271017787c68319bff1344d55abfb6845c654ced90ee3ba5baa4b33f3107aceb7a898079ce1bedf630e95dd5c524baa9f

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tonyta.tt@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tony Ta
+
+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,70 @@
+# PandaGo Ruby
+
+A lightweight Ruby wrapper for [PandaGo](https://github.com/Scripted/pandago).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "pandago", "~> 1.0.0"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pandago
+
+## Configuration
+
+You must to have a [PandaGo](https://github.com/Scripted/pandago) server running.
+
+``` ruby
+PandaGo.configure do |config|
+  config.url = "http://your-pandago-instance.herokuapp.com"
+  config.timeout = 10 # default is 5 seconds
+end
+```
+
+## Usage
+
+Given the file `hello_world.html`, just pass it into `#convert` with the input
+and output formats.
+
+``` ruby
+file = File.open("hello_world.html")
+file.read
+# => "<h1>Hello, World!</h1>\n<p>Here's looking at you.</p>\n"
+
+io = PandaGo.convert(file, from: :html, to: :markdown)
+io.read
+# => "Hello, World!\n=============\n\nHere's looking at you.\n"
+```
+
+You can also convert strings by wrapping them in a `StringIO` object.
+
+``` ruby
+string = "<h1>So Long!</h1><p>And thanks for all the fish.</p>"
+input_io = StringIO.new(string)
+
+io = PandaGo.convert(input_io, from: :html, to: :markdown)
+io.read
+# => "So Long!\n========\n\nAnd thanks for all the fish.\n"
+```
+
+## Development
+
+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.
+
+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/scripted/pandago. 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pandago"
+
+# 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.
+
+require "pry"
+Pry.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/lib/pandago.rb

@@ -0,0 +1,20 @@
+require "pandago/version"
+require "pandago/configuration"
+require "pandago/converter"
+require "pandago/errors"
+
+module PandaGo
+  class << self
+    def configure
+      yield configuration if block_given?
+    end
+
+    def configuration
+      @configuration ||= self::Configuration.new
+    end
+
+    def convert(file, from:, to:)
+      self::Converter.new(file, from, to, configuration).convert
+    end
+  end
+end

data/lib/pandago/configuration.rb

@@ -0,0 +1,26 @@
+require "uri"
+
+module PandaGo
+  class Configuration
+    DEFAULT_TIMEOUT = 5
+
+    attr_reader :url
+    def url=(url)
+      @url = URI(url)
+      self.url
+    end
+
+    def port
+      url&.port
+    end
+
+    def host
+      url&.host
+    end
+
+    def timeout
+      @timeout || DEFAULT_TIMEOUT
+    end
+    attr_writer :timeout
+  end
+end

data/lib/pandago/content_types.rb

@@ -0,0 +1,15 @@
+require "pandago/errors"
+
+module PandaGo
+  module ContentTypes
+    TYPES = {
+      "markdown" => "text/markdown; charset=UTF-8",
+      "html" => "text/html; charset=utf-8",
+      "docx" => "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+    }
+
+    def self.[](name)
+      TYPES.fetch(name.to_s) { |name| raise ContentTypeNotSupportedError, name }
+    end
+  end
+end

data/lib/pandago/converter.rb

@@ -0,0 +1,65 @@
+require "net/http"
+require "pandago/content_types"
+
+module PandaGo
+  class Converter
+    BOUNDARY = "__X_PANDAGO_BOUNDARY_QYcwwbmfzj3rfKcMk7AWNw__"
+
+    attr_reader :source_io, :read_format, :write_format, :config
+
+    def initialize(source_io, read_format, write_format, config)
+      @source_io, @read_format, @write_format = source_io, read_format, write_format
+      @config = config
+    end
+
+    def convert
+      if response.code == "200"
+        StringIO.new(response.body)
+      else
+        raise RequestError, response
+      end
+    end
+
+    def request
+      return @request if defined? @request
+      @request = Net::HTTP::Post.new("/convert", header)
+      @request.body = body
+      @request
+    end
+
+    def response
+      return @response if defined? @response
+      raise UrlNotSetError if config.url.nil?
+      http = Net::HTTP.new(config.host, config.port)
+      http.read_timeout = config.timeout
+      @response = http.request(request)
+    rescue Net::ReadTimeout
+      raise TimeoutError
+    end
+
+    def header
+      { "content-type" => "multipart/form-data; charset=utf-8; boundary=#{ BOUNDARY }" }
+    end
+
+    def body
+      source_io.rewind
+      <<~BODY
+        --#{ BOUNDARY }
+        Content-Disposition: form-data; name="from"
+
+        #{ read_format }
+        --#{ BOUNDARY }
+        Content-Disposition: form-data; name="to"
+
+        #{ write_format }
+        --#{ BOUNDARY }
+        Content-Disposition: form-data; name="payload"; filename="payload"
+        Content-Type: #{ ContentTypes[read_format] }
+
+        #{ source_io.read }
+
+        --#{ BOUNDARY }--
+      BODY
+    end
+  end
+end

data/lib/pandago/errors.rb

@@ -0,0 +1,30 @@
+module PandaGo
+  class Error < StandardError; end
+
+  class ContentTypeNotSupportedError < Error
+    def initialize(type_name)
+      super("Content-Type not supported for: #{ type_name }")
+    end
+  end
+
+  class UrlNotSetError < Error
+    def initialize
+      super("PandaGo url has not been configured")
+    end
+  end
+
+  class RequestError < Error
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+      super("#{ response.code } #{ response.message }")
+    end
+  end
+
+  class TimeoutError < Error
+    def initialize
+      super("Request took longer than #{ PandaGo.configuration.timeout } seconds")
+    end
+  end
+end

data/lib/pandago/version.rb

@@ -0,0 +1,3 @@
+module PandaGo
+  VERSION = "1.0.0"
+end

data/pandago.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pandago/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pandago"
+  spec.version       = PandaGo::VERSION
+  spec.authors       = ["Tony Ta"]
+  spec.email         = ["tonyta.tt@gmail.com"]
+
+  spec.summary       = "A lightweight Ruby Wrapper for PandaGo (Pandoc served with Go)"
+  spec.homepage      = "https://github.com/scripted/pandago-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.3.0'
+
+  spec.add_development_dependency "bundler", "~> 1.13.3"
+  spec.add_development_dependency "rake", "~> 10.5.0"
+  spec.add_development_dependency "rspec", "~> 3.5.0"
+  spec.add_development_dependency "rspec-its", "~> 1.2.0"
+  spec.add_development_dependency "pry", "~> 0.10.4"
+  spec.add_development_dependency "pry-byebug", "~> 3.4.0"
+  spec.add_development_dependency "webmock", "~> 2.1.0"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: pandago
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tony Ta
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: 
+email:
+- tonyta.tt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pandago.rb
+- lib/pandago/configuration.rb
+- lib/pandago/content_types.rb
+- lib/pandago/converter.rb
+- lib/pandago/errors.rb
+- lib/pandago/version.rb
+- pandago.gemspec
+homepage: https://github.com/scripted/pandago-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.7
+signing_key: 
+specification_version: 4
+summary: A lightweight Ruby Wrapper for PandaGo (Pandoc served with Go)
+test_files: []