kami 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a5342eb9b1cdbe018eabea5a31d2670f1bc9ad0f
+  data.tar.gz: 70404c9e0997fec6e700017cc2ee62b92ef941ca
+SHA512:
+  metadata.gz: b9d883bbbac8e54788eddd339c9c276a032c2eb4d23a25551a7ecc857286e5113b12d3d7c3fd1078b21781e7bb81dea9490f3a1d4d2a26082721f2405842694c
+  data.tar.gz: 44a85c42abab52b40bcd0eb4aa89bfc7ef92295dfbeeb304090ba1b36d9e8ff4e2504577aa811929e21f38c01680a0f7992e7379ee273dfdccb8fb3a4d9fdf29

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Joe Heth
+
+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,188 @@
+# Kami
+
+[![Build Status](https://travis-ci.org/jheth/kami.svg)](https://travis-ci.org/jheth/kami)
+[![Code Climate](https://codeclimate.com/github/jheth/kami/badges/gpa.svg)](https://codeclimate.com/github/jheth/kami)
+
+
+Formerly NotablePDF, [Kami](https://www.kamihq.com/) provides Beautiful Document Viewer and Annotation Software.
+
+API Overview: https://www.kamihq.com/api/
+
+API Documentation: http://docs.kamiembeddingapi.apiary.io/
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kami', github: 'jheth/kami'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kami
+
+## Usage
+
+### Create Client
+
+An API Key is required to communicate with Kami. Contact them for details.
+
+```ruby
+client = Kami::Client.new('ABC-vRXxiGb7Nty9mXYZ')
+```
+
+### List Documents
+
+Return a list of all documents previously uploaded.
+
+```ruby
+list = client.documents
+# =>
+[
+  {
+    "name": "example.pdf",
+    "document_identifier": "797003eeefa82bd465e9b806a592b005",
+    "file_status": "done",
+    "file_error_message": null,
+    "created_at": "2016-04-27T22:32:32.098Z"
+  }
+]
+```
+
+### Upload Document
+
+File uploads can be done from the local file system or via publicly available URLs.
+
+```ruby
+client.upload(name: 'sample.pdf', file: '/path/to/file')
+# OR
+client.upload(name: 'sample.pdf', document_url: 'https://path/to/file')
+
+# =>
+{
+  "name": "example.pdf",
+  "document_identifier": "797003eeefa82bd465e9b806a592b005",
+  "file_status": "processing",
+  "file_error_message": null,
+  "created_at": "2016-04-27T22:32:32.098Z"
+}
+```
+
+### Delete Document
+
+Delete document by passing the Kami document identifier
+
+```ruby
+client.delete_document('797003eeefa82bd465e9b806a592b005')
+```
+
+### Retrieve Document
+
+```ruby
+client.document('797003eeefa82bd465e9b806a592b005')
+# =>
+Kami::Document(document_id: '797003eeefa82bd465e9b806a592b005')
+```
+
+### Load Document
+
+```ruby
+document = Kami::Document.new('797003eeefa82bd465e9b806a592b005')
+```
+
+### Document Status
+
+```ruby
+document.status
+#=>
+{
+  "name": "example.pdf",
+  "document_identifier": "797003eeefa82bd465e9b806a592b005",
+  "file_status": "done",
+  "file_error_message": null,
+  "created_at": "2016-04-27T22:32:32.098Z"
+}
+```
+
+### Session View URL
+
+Creates an active viewer session and URL to be used in an embedded iframe.
+
+```ruby
+document.session_view_url
+#=>
+"https://embed.kamihq.com/web/viewer.html?source=embed_api..."
+```
+
+```ruby
+document.session_view
+#=>
+{
+  "view_session_key": "ANgoQRGNgj-YF8rdfoTk",
+  "viewer_url": "https://embed.kamihq.com/web/viewer.html?source=embed_api...",
+  "session_expiry": "2016-04-28T04:22:09.000Z"
+}
+```
+
+### Document Comments
+
+Returns list of authors and comments associated with the document.
+
+```ruby
+document.comments
+#=>
+{
+  "authors":  [{}, ...],
+  "comments": [{}, ...]
+}
+```
+
+### Create Document Export
+
+A Document is scheduled for export, which creates a unique job ID.
+
+```ruby
+document.create_export(type: 'annotation')
+
+#=>
+{
+  "id": '6cb4de71-c3d5-40c2-8b88-4774ea92db9a',
+  "status": 'pending',
+  "file_url": null,
+  "error_type": null
+}
+```
+
+### Get a Document Export
+
+```ruby
+document.export_file('6cb4de71-c3d5-40c2-8b88-4774ea92db9a')
+#=>
+{
+  "id": "6cb4de71-c3d5-40c2-8b88-4774ea92db9a",
+  "status": "done",
+  "file_url": "https://s3.amazonaws.com/FILE_URL",
+  "error_type": null
+}
+```
+
+## 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/jheth/kami.
+
+
+## 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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kami"
+
+# 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/kami.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kami/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kami"
+  spec.version       = Kami::VERSION
+  spec.authors       = ["Joe Heth"]
+  spec.email         = ["joeheth@gmail.com"]
+
+  spec.summary       = %q{A lightweight ruby client for the Kami REST API.}
+  spec.description   = %q{A lightweight ruby client for the Kami REST API.}
+  spec.homepage      = "https://github.com/jheth/kami"
+  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 "rest-client", ">= 1.8.0", "< 1.9.0"
+
+  spec.add_development_dependency "bundler", ">= 1.11", "< 2.0"
+  spec.add_development_dependency "rake", ">= 10.0", "< 12.0"
+  spec.add_development_dependency "rspec", ">= 3.0", "< 4.0"
+  spec.add_development_dependency "simplecov", ">= 0.11", "< 1.0"
+  spec.add_development_dependency "webmock", ">= 2.0.0", "< 3.0"
+  spec.add_development_dependency "vcr", ">= 2.9.3", "< 4.0"
+  spec.add_development_dependency "pry-byebug", ">= 3.3.0", "< 4.0"
+  spec.add_development_dependency "awesome_print", ">= 1.6.1", "< 2.0"
+end

data/lib/kami.rb

@@ -0,0 +1,10 @@
+require "kami/version"
+require "kami/client"
+require "kami/document"
+
+require 'json'
+require 'rest-client'
+
+module Kami
+  # Your code goes here...
+end

data/lib/kami/client.rb

@@ -0,0 +1,74 @@
+module Kami
+  class Client
+    HOSTNAME = 'api.notablepdf.com'.freeze
+
+    def initialize(key)
+      @kami_api_key = key
+    end
+
+    def documents
+      response = get('documents')
+      response['documents'].map do |hash|
+        Kami::Document.new(client: self, data: hash)
+      end
+    end
+
+    def document(id)
+      Kami::Document.new(client: self, id: id)
+    end
+
+    def upload(name: nil, document_url: nil, file: nil)
+      path = url('documents')
+
+      if document_url
+        payload = { name: name, document_url: document_url }
+      elsif file
+        payload = { name: name, document: File.open(file, 'rb'), multipart: true }
+        # Path changes for multipart uploads
+        path = base_url + '/upload/embed/documents'
+      end
+      raise 'Must provide document_url or file' if payload.nil?
+
+      post(path, payload)
+    end
+
+    def delete_document(document_id)
+      delete("documents/#{document_id}")
+      true
+    end
+
+    def get(path)
+      response = RestClient.get(url(path), request_headers)
+      JSON[response]
+    end
+
+    def post(path, payload)
+      data = payload[:multipart] ? payload : payload.to_json
+
+      path = path.include?(base_url) ? path : url(path)
+      response = RestClient.post(path, data, request_headers)
+
+      JSON[response]
+    end
+
+    def delete(path)
+      RestClient.delete(url(path), request_headers)
+    end
+
+    def url(path)
+      base_url + "/embed/#{path}"
+    end
+
+    def base_url
+      "https://#{HOSTNAME}"
+    end
+
+    def request_headers
+      {
+        accept: 'application/json',
+        content_type: 'application/json',
+        authorization: "Token #{@kami_api_key}"
+      }
+    end
+  end
+end

data/lib/kami/document.rb

@@ -0,0 +1,79 @@
+module Kami
+  class Document
+    attr_reader :name, :document_identifier, :file_status, :file_error_message,
+                :created_at, :session_view
+
+    def initialize(client: nil, id: nil, data: nil)
+      @client = client
+      @document_identifier = id
+      @raw_data = data
+
+      if data.is_a?(Hash)
+        @name = data['name']
+        @document_identifier = data['document_identifier']
+        @file_status = data['file_status']
+        @file_error_message = data['file_error_message']
+        @created_at = data['created_at']
+      end
+    end
+
+    def to_hash
+      @raw_data || status
+    end
+
+    def status
+      @status ||= @client.get("documents/#{@document_identifier}")
+    end
+
+    def create_export(type: 'annotation')
+      payload = {
+        document_identifier: @document_identifier,
+        export_type: type
+      }
+      @export = @client.post('exports', payload)
+    end
+
+    def export_file(id = nil)
+      export_id = id
+      export_id ||= @export['id'] if @export.is_a?(Hash)
+
+      @client.get("exports/#{export_id}")
+    end
+
+    def delete
+      @client.delete("documents/#{@document_identifier}")
+      true
+    end
+
+    def comments
+      @client.get("documents/#{@document_identifier}/comments")
+    end
+
+    def session_view(name: 'Guest', user_id: 0, expires_at: nil, theme: 'light', show_sync: true, show_save: true)
+      return unless @document_identifier
+
+      expires_at = (Time.now + (60 * 60)) if expires_at.nil?
+
+      payload = {
+        document_identifier: @document_identifier,
+        user: {
+          name: name,
+          user_id: user_id
+        },
+        expires_at: expires_at,
+        viewer_options: {
+          theme: theme,
+          show_sync: show_sync,
+          show_save: show_save
+        }
+      }
+
+      @session_view = @client.post('sessions', payload)
+    end
+
+    def session_view_url(name: 'Guest', user_id: 0, expires_at: nil, theme: 'light', show_sync: true, show_save: true)
+      view = session_view(name: name, user_id: user_id, expires_at: expires_at, theme: theme, show_sync: show_sync, show_save: show_save)
+      view['viewer_url']
+    end
+  end
+end

data/lib/kami/version.rb

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

metadata

@@ -0,0 +1,238 @@
+--- !ruby/object:Gem::Specification
+name: kami
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Joe Heth
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.11'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.11'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A lightweight ruby client for the Kami REST API.
+email:
+- joeheth@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kami.gemspec
+- lib/kami.rb
+- lib/kami/client.rb
+- lib/kami/document.rb
+- lib/kami/version.rb
+homepage: https://github.com/jheth/kami
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A lightweight ruby client for the Kami REST API.
+test_files: []