panda_doc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ebb23e4abe4534d913bab229afc9e8881a62b53
+  data.tar.gz: d7f6f1562bd1187790e78ce70a2a262d4f1a5b2a
+SHA512:
+  metadata.gz: 56b872850b068389570cc8d2662967aba03b84d727666660724656ae1693b022213f928564519d38ff08d754e0d3a2060be1169d58af70fd778d5e75a46f80cf
+  data.tar.gz: 620ad9bab0834711147428a159c5a84539079117a180feff08885fad886364fe7553721d93642cb766fdf7f5ebef61931632535261553596cafa5c45a871a362

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+
+cache:
+  - bundler
+
+rvm:
+  - 2.2.4
+  - 2.3.0
+
+addons:
+  code_climate:
+    repo_token: d1d9c0636042863489880dbdf1c8865721b9b70f4199d612d77ee2dcfc803704

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+
+## 0.0.1 (2016-02-03)
+
+- Initial release
+
+[Unreleased]: https://github.com/opti/panda_doc/compare/v0.0.1...HEAD

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in panda_doc.gemspec
+gemspec
+
+gem "bundler", "~> 1.11"
+gem "rake",    "~> 10.0"
+gem "rspec",   "~> 3.4"
+gem "byebug"
+
+group :test do
+  gem "codeclimate-test-reporter", require: false
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Igor Pstyga
+
+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,144 @@
+# PandaDoc
+
+PandaDoc gem is a simple wrapper for PandaDoc.com API. Please check the official
+API [documenation](https://developers.pandadoc.com) for more details.
+
+[![Build Status](https://travis-ci.org/opti/panda_doc.svg?branch=master)](http://travis-ci.org/opti/panda_doc)
+[![Code Climate](https://codeclimate.com/github/opti/panda_doc/badges/gpa.svg)](https://codeclimate.com/github/opti/panda_doc)
+[![Test Coverage](https://codeclimate.com/github/opti/panda_doc/badges/coverage.svg)](https://codeclimate.com/github/opti/panda_doc/coverage)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'panda_doc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install panda_doc
+
+## Configuration
+
+Please refer to the [Authentication](https://developers.pandadoc.com/#authentication)
+documentation to get the idea how to get an access token.
+
+```ruby
+PandaDoc.configure do |config|
+  config.access_token = "an access token"
+end
+```
+
+## Usage
+
+Every response wrapped into a ruby object with values coerced in corresponding types.
+
+#### Creating a document
+
+```ruby
+PandaDoc::Document.create(
+  name: "Sample Document",
+  url: "url_to_a_document",
+  recipients: [
+    {
+      email: "john.appleseed@yourdomain.com",
+      first_name: "John",
+      last_name: "Appleseed",
+      role: "Signer",
+      default: false
+    }
+  ],
+  fields: {
+    field_id: {
+      title: "Field 1"
+    }
+  }
+)
+
+document.uuid # => "oovHPtkwDqEAvaKmdud"
+document.name # => "Sample Document"
+document.status # => "document.uploaded"
+document.created_at # => #<DateTime: 2016-02-03T14:56:21-08:00>
+document.updated_at # => #<DateTime: 2016-02-03T14:56:21-08:00>
+```
+
+#### Creating a document from a template
+
+```ruby
+document = PandaDoc::Document.create(
+  name: "Sample Document",
+  template_uuid: "uuid_of_the_template",
+  recipients: [
+    {
+      email: "john.appleseed@yourdomain.com",
+      first_name: "John",
+      last_name: "Appleseed",
+      role: "Signer",
+      default: false
+    }
+  ],
+  fields: {
+    field_id: {
+      value: "Field 1"
+    }
+  }
+)
+```
+
+#### Sending a document
+
+```ruby
+PandaDoc::Document.send("UUID", message: "A message to include into the email")
+```
+
+#### Ccreating a View Session
+
+```ruby
+session = PandaDoc::Document.session("UUID",
+  recipient: "john.applessed@yourdoamin.com",
+  lifetime: 300
+)
+
+session.id # => "adssdAvyDXBS"
+session.expires_at # => #<DateTime: 2016-02-03T14:56:21-08:00>
+```
+
+#### Error handling
+
+If an error occurs during an API request it will be wrapped into a plain ruby
+object as well.
+
+```ruby
+response = PandaDoc::Document.create(name: "Sample Document")
+
+if response.success?
+  uuid = response.uuid
+else
+  puts response.error.message
+end
+```
+
+## 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/opti/panda_doc.
+
+1. Fork it ( https://github.com/opti/panda_doc/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## 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,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.verbose = false
+end
+
+task default: :spec

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "panda_doc"
+
+require "irb"
+require "irb/completion"
+require "byebug"
+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/lib/panda_doc/api_client.rb

@@ -0,0 +1,43 @@
+module PandaDoc
+  class ApiClient
+
+    class << self
+      def request(verb, path, **data)
+        new.public_send(verb, path, data)
+      end
+    end
+
+    attr_reader :connection
+
+    attr_reader :url_prefix
+    private :url_prefix
+
+    def initialize
+      @url_prefix = "/public/v1"
+      @connection = Faraday.new(PandaDoc.configuration.endpoint) do |conn|
+        conn.authorization :Bearer, PandaDoc.configuration.access_token
+        conn.request       :json
+        conn.response      :json, content_type: /\bjson$/
+        conn.adapter       Faraday.default_adapter
+      end
+    end
+
+    def post(path, **data)
+      connection.post(normalized_path(path), data)
+    end
+
+    def get(path, **data)
+      connection.get(normalized_path(path), data)
+    end
+
+    private
+
+    def normalized_path(path)
+      url_prefix + normalize_path(path)
+    end
+
+    def normalize_path(path)
+      Faraday::Utils.normalize_path(path)
+    end
+  end
+end

data/lib/panda_doc/configuration.rb

@@ -0,0 +1,23 @@
+module PandaDoc
+  class Configuration
+    attr_accessor :access_token
+
+    def endpoint
+      "https://api.pandadoc.com"
+    end
+  end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configuration=(config)
+      @configuration = config
+    end
+
+    def configure
+      yield configuration
+    end
+  end
+end

data/lib/panda_doc/document.rb

@@ -0,0 +1,30 @@
+module PandaDoc
+  module Document
+    extend self
+
+    def create(data)
+      respond(ApiClient.request(:post, "/documents", data))
+    end
+
+    def send(uuid, **data)
+      respond(ApiClient.request(:post, "/documents/#{uuid}/send", data))
+    end
+
+    def session(uuid, **data)
+      respond(
+        ApiClient.request(:post, "/documents/#{uuid}/session", data),
+        type: :session
+      )
+    end
+
+    private
+
+    def respond(response, type: :document)
+      return FailureResult.new(response) unless response.success?
+
+      SuccessResult.new(
+        ResponseFactory.new(type).build.from_hash(response.body)
+      )
+    end
+  end
+end

data/lib/panda_doc/failure_result.rb

@@ -0,0 +1,16 @@
+module PandaDoc
+  class FailureResult
+    extend Forwardable
+    def_delegators :response, :status, :success?
+
+    attr_reader :error
+
+    attr_reader :response
+    private :response
+
+    def initialize(response)
+      @response = response
+      @error = Responses::Error.new(Objects::Error.new).from_hash(response.body)
+    end
+  end
+end

data/lib/panda_doc/objects/document.rb

@@ -0,0 +1,14 @@
+module PandaDoc
+  module Objects
+    class Document
+      include Virtus.model
+
+      attribute :uuid,       String
+      attribute :status,     String
+      attribute :name,       String
+      attribute :recipients, Array[Objects::Recipient]
+      attribute :created_at, DateTime
+      attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/panda_doc/objects/error.rb

@@ -0,0 +1,11 @@
+module PandaDoc
+  module Objects
+    class Error
+      include Virtus.model
+
+      attribute :type,    String
+      attribute :message, String
+      attribute :code,    String
+    end
+  end
+end

data/lib/panda_doc/objects/recipient.rb

@@ -0,0 +1,13 @@
+module PandaDoc
+  module Objects
+    class Recipient
+      include Virtus.model
+
+      attribute :email,          String
+      attribute :first_name,     String
+      attribute :last_name,      String
+      attribute :recipient_type, String
+      attribute :has_completed,  Axiom::Types::Boolean
+    end
+  end
+end

data/lib/panda_doc/objects/session.rb

@@ -0,0 +1,10 @@
+module PandaDoc
+  module Objects
+    class Session
+      include Virtus.model
+
+      attribute :id,         String
+      attribute :expires_at, DateTime
+    end
+  end
+end

data/lib/panda_doc/response_factory.rb

@@ -0,0 +1,28 @@
+module PandaDoc
+  class ResponseFactory
+    attr_reader :type
+    private :type
+
+    def initialize(type)
+      @type = type.capitalize
+    end
+
+    def build
+      response_class.new(object_class.new)
+    end
+
+    private
+
+    def response_class
+      class_for("Responses")
+    end
+
+    def object_class
+      class_for("Objects")
+    end
+
+    def class_for(namespace)
+      Object.const_get("PandaDoc::#{namespace}::#{type}")
+    end
+  end
+end

data/lib/panda_doc/responses/document.rb

@@ -0,0 +1,21 @@
+module PandaDoc
+  module Responses
+    class Document < Representable::Decorator
+      include Representable::Hash
+
+      property :uuid
+      property :status
+      property :name
+      property :created_at, as: :date_created
+      property :updated_at, as: :date_modified
+
+      collection :recipients, class: PandaDoc::Objects::Recipient do
+        property :email
+        property :first_name
+        property :last_name
+        property :recipient_type
+        property :has_completed
+      end
+    end
+  end
+end

data/lib/panda_doc/responses/error.rb

@@ -0,0 +1,14 @@
+module PandaDoc
+  module Responses
+    class Error < Representable::Decorator
+      include Representable::Hash
+
+      property :type
+
+      nested :detail do
+        property :message
+        property :code
+      end
+    end
+  end
+end

data/lib/panda_doc/responses/session.rb

@@ -0,0 +1,10 @@
+module PandaDoc
+  module Responses
+    class Session < Representable::Decorator
+      include Representable::Hash
+
+      property :id
+      property :expires_at
+    end
+  end
+end

data/lib/panda_doc/success_result.rb

@@ -0,0 +1,26 @@
+module PandaDoc
+  class SuccessResult
+    attr_reader :object
+    private :object
+
+    def initialize(object)
+      @object = object
+    end
+
+    def success?
+      true
+    end
+
+    def method_missing(method_name, *arguments, &block)
+      if object.respond_to?(method_name)
+        object.send(method_name, *arguments, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      object.respond_to?(method_name) || super
+    end
+  end
+end

data/lib/panda_doc/version.rb

@@ -0,0 +1,3 @@
+module PandaDoc
+  VERSION = "0.0.1"
+end

data/lib/panda_doc.rb

@@ -0,0 +1,26 @@
+require "forwardable"
+
+require "faraday"
+require "faraday_middleware"
+require "virtus"
+require "representable/hash"
+
+require "panda_doc/api_client"
+require "panda_doc/configuration"
+require "panda_doc/failure_result"
+require "panda_doc/success_result"
+require "panda_doc/document"
+require "panda_doc/response_factory"
+require "panda_doc/objects/recipient"
+require "panda_doc/objects/document"
+require "panda_doc/objects/error"
+require "panda_doc/objects/session"
+require "panda_doc/responses/document"
+require "panda_doc/responses/error"
+require "panda_doc/responses/session"
+
+require "panda_doc/version"
+
+module PandaDoc
+  # Your code goes here...
+end

data/panda_doc.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'panda_doc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "panda_doc"
+  spec.version       = PandaDoc::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ["Igor Pstyga"]
+  spec.email         = ["igor.pstyga@gmail.com"]
+
+  spec.summary       = %q{Ruby wrapper for PandaDoc.com API}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/opti/panda_doc"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = "~> 2.2"
+  spec.add_dependency "faraday", "~> 0.9.2"
+  spec.add_dependency "faraday_middleware", "~> 0.10.0"
+  spec.add_dependency "virtus", "~> 1.0", ">= 1.0.5"
+  spec.add_dependency "representable", ">= 3.0.0"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: panda_doc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Igor Pstyga
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: representable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Ruby wrapper for PandaDoc.com API
+email:
+- igor.pstyga@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/panda_doc.rb
+- lib/panda_doc/api_client.rb
+- lib/panda_doc/configuration.rb
+- lib/panda_doc/document.rb
+- lib/panda_doc/failure_result.rb
+- lib/panda_doc/objects/document.rb
+- lib/panda_doc/objects/error.rb
+- lib/panda_doc/objects/recipient.rb
+- lib/panda_doc/objects/session.rb
+- lib/panda_doc/response_factory.rb
+- lib/panda_doc/responses/document.rb
+- lib/panda_doc/responses/error.rb
+- lib/panda_doc/responses/session.rb
+- lib/panda_doc/success_result.rb
+- lib/panda_doc/version.rb
+- panda_doc.gemspec
+homepage: https://github.com/opti/panda_doc
+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.2'
+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 wrapper for PandaDoc.com API
+test_files: []