perfect_audit 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d981203f21af5347251dc4ada125fc9c8299e266
-  data.tar.gz: 51776e29d04a1fb92d2d3e97bec6596dbdbb6cad
+  metadata.gz: 408a4d2075ee6a5c39a14be61cebda937a21c93b
+  data.tar.gz: 988f21058fbcfee727587d3c83230db4cceff208
 SHA512:
-  metadata.gz: a2059caca09c3b243c7bd80d44f9a2afa02d88564a8701d3f0013820e59f769b9f1a79ae8c1bb756278954e849838407329198761c48b2e174b93b5a5112d288
-  data.tar.gz: e740c2a8df7e9e9b5ecfae22c0116eaf40e949c27a5f3ee99b23bc6bb61e8cf580534e853a81ef6bf1248c8713ec571e250e1ceea8cb218316604c9333cb56fd
+  metadata.gz: ad33b115c75ca8ec8cb83d8975b087ef356eb33fdf0a985963280622f423b829ab3ac7b5430cd276496a3bfb7c41327e56c9d5bc3ec8f31171a114fad0f4e1f1
+  data.tar.gz: d3c85e5b35d54307dbb1f1d2bacb6accc013cfa4c3821a1ed8f1742e03953f95cdebc33982b45be27f81b2722b38bea1bb132f80039712775738d9a787b4ced2

data/README.md

@@ -1,5 +1,6 @@
 # PerfectAudit
 
+[![Gem Version](https://badge.fury.io/rb/perfect_audit.svg)](https://badge.fury.io/rb/perfect_audit)
 [![Build Status](https://travis-ci.org/igor-alexandrov/perfect_audit.svg?branch=master)](https://travis-ci.org/igor-alexandrov/perfect_audit)
 [![Maintainability](https://api.codeclimate.com/v1/badges/72f40b05552e16b9cd4f/maintainability)](https://codeclimate.com/github/igor-alexandrov/perfect_audit/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/72f40b05552e16b9cd4f/test_coverage)](https://codeclimate.com/github/igor-alexandrov/perfect_audit/test_coverage)

data/lib/perfect_audit/api/book.rb

@@ -31,6 +31,10 @@ module PerfectAudit
     def verification_complete?
       documents.all?(&:verification_complete?)
     end
+
+    def verification_failed?
+      documents.any?(&:failed?)
+    end
   end
 end
 

data/lib/perfect_audit/api/repositories.rb

@@ -12,6 +12,12 @@ module PerfectAudit
     DELETE_PATH = 'book/remove'.freeze
     EXCEL_EXPORT_PATH = 'book/export/xlsx/analytics'.freeze
 
+    # Create book in Perfect Audit
+    #
+    # @param name [String] name of book
+    # @param public [Boolean] should book be public ot not, `true` or `false`
+    # @return [PerfectAudit::Book] newly created book
+    # @raise [PerfectAudit::Error] if anything goes wrong during request
     def create(name, public = false)
       response = connection.post(CREATE_PATH,
         json: {
@@ -23,6 +29,10 @@ module PerfectAudit
       PerfectAudit::Book.new(response_parser.parse(response.body.to_s))
     end
 
+    # Get all books from Perfect Audit for account
+    #
+    # @return [Array<PerfectAudit::Book>]
+    # @raise [PerfectAudit::Error] if anything goes wrong during request
     def all
       response = connection.get(ALL_PATH)
 
@@ -31,6 +41,12 @@ module PerfectAudit
       }
     end
 
+
+    # Find book in Perfect Audit
+    #
+    # @param id [Integer] ID of book
+    # @return [PerfectAudit::Book]
+    # @raise [PerfectAudit::Error] if anything goes wrong during request
     def find(id)
       response = connection.get(FIND_PATH,
         params: {
@@ -41,6 +57,11 @@ module PerfectAudit
       PerfectAudit::Book.new(response_parser.parse(response.body.to_s))
     end
 
+    # Delete book in Perfect Audit
+    #
+    # @param id [Integer] ID of book
+    # @return [true]
+    # @raise [PerfectAudit::Error] if anything goes wrong during request
     def delete(book_or_id)
       id = book_or_id.is_a?(PerfectAudit::Book) ? book_or_id.id.to_s : book_or_id.to_s
       response = connection.post(DELETE_PATH,

data/lib/perfect_audit/version.rb

@@ -1,3 +1,3 @@
 module PerfectAudit
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.1'.freeze
 end

data/perfect_audit.gemspec

@@ -43,4 +43,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov'
 
   spec.add_development_dependency 'webmock'
+
+  spec.add_development_dependency 'yard'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: perfect_audit
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Igor Alexandrov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-23 00:00:00.000000000 Z
+date: 2018-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-auto_inject
@@ -206,6 +206,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: Perfect Audit API wrapper. https://www.perfectaudit.com/api_docs
 email:
 - igor.alexandrov@gmail.com