perfect_audit 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c27162da2493ec3c5cb9c76efba6afdf19c1d3d6
-  data.tar.gz: c6acc4f247e2ca65ac99fac7c0943b0181942e6e
+  metadata.gz: d981203f21af5347251dc4ada125fc9c8299e266
+  data.tar.gz: 51776e29d04a1fb92d2d3e97bec6596dbdbb6cad
 SHA512:
-  metadata.gz: 48185fc4598fdb07d82c608ecf3f0c8f3346a1006d2b2e90c5e232f720740488d5d319c4d016401af9958d2b6fc04112ca8cbb821b5acd74756c3c1271216e32
-  data.tar.gz: fe881555598c659e6d5dc0a10b39e74c9d6481def29d80efeb4bf09e9f757d24a1302a3e95f01a2e7d93ce3a2d989c075cd5da8f9ab367b88ed511111a6cc1e2
+  metadata.gz: a2059caca09c3b243c7bd80d44f9a2afa02d88564a8701d3f0013820e59f769b9f1a79ae8c1bb756278954e849838407329198761c48b2e174b93b5a5112d288
+  data.tar.gz: e740c2a8df7e9e9b5ecfae22c0116eaf40e949c27a5f3ee99b23bc6bb61e8cf580534e853a81ef6bf1248c8713ec571e250e1ceea8cb218316604c9333cb56fd

data/README.md

@@ -33,40 +33,84 @@ Or install it yourself as:
   end
 ```
 
+## Exception Handling
+
+If PerfectAudit will return anything different from 200 OK status code, `PerfectAudit::Error` will be raised. It contains `#message` and `#code` returned from API.
+
+For example with invalid credentials you will receive:
+
+``` ruby
+PerfectAudit.books.all
+#=> PerfectAudit::Error: Email and/or password not found [1306]
+```
+
+And if you will try to find a Book that does not exist, you will receive:
+
+``` ruby
+PerfectAudit.books.find(82087)
+#=> PerfectAudit::Error: Book not found [1401]
+```
+
 ## Usage
 
-### Books
+### Books Repository
 
-Get books list for your account:
+Get books list for your account
 
 ``` ruby
 PerfectAudit.books.all
+#=> [#<PerfectAudit::Book:0x00007ff51bbfbe28>, ...]
 ```
 
-Create a book:
+Create a book
 
 ``` ruby
-PerfectAudit.books.create(name: 'Test book', is_public: 'false')
+# Create a book with name=Test
+PerfectAudit.books.create('Test')
+#=> #<PerfectAudit::Book:0x00007ff51c8e4248 @id=0, @created_at="2018-03-22T20:21:25Z", @name="Test", @public=false ...>
+
+# Create a book with name=Test which is public
+PerfectAudit.books.create('Test', true)
+#=> #<PerfectAudit::Book:0x00007ff51c8e4248 @id=0, @created_at="2018-03-22T20:21:25Z", @name="Test", @public=true ...>
 ```
 
-Get book information:
+Find book by ID
 
 ``` ruby
-PerfectAudit.books.find(book_id)
+PerfectAudit.books.find(100)
+#=> #<PerfectAudit::Book:0x00007ff51c89f828 @id=100, @created_at="2018-03-22T20:48:54Z", @name="Test", @public=false ...>
 ```
 
-Delete a book:
+Delete a book
+
+``` ruby
+# To delete a book you can use either its ID or instance
+PerfectAudit.books.delete(100)
+#=> true
+
+book = PerfectAudit.books.find(100)
+PerfectAudit.books.delete(book)
+#=> true
+```
 
+Export book to Excel
 ``` ruby
-PerfectAudit.books.delete(book_or_id)
+book = PerfectAudit.books.find(100)
+File.write('./book.xlsx', PerfectAudit.books.to_excel(book))
 ```
 
-### Documents
+### Documents Repository
 
-Upload document to a book:
+Upload document to a book
 
 ``` ruby
-PerfectAudit.documents.create(book_or_id, file_or_io)
+# To upload documents to a book you can use book ID or its instance and File
+PerfectAudit.documents.create(100, File.open('./document.pdf'))
+#=> true
+
+book = PerfectAudit.books.find(100)
+PerfectAudit.documents.create(book, File.open('./document.pdf'))
+#=> true
 ```
 
 ## Credits

data/lib/perfect_audit/api/repositories.rb

@@ -10,6 +10,7 @@ module PerfectAudit
     ALL_PATH = 'books'.freeze
     FIND_PATH = 'book/info'.freeze
     DELETE_PATH = 'book/remove'.freeze
+    EXCEL_EXPORT_PATH = 'book/export/xlsx/analytics'.freeze
 
     def create(name, public = false)
       response = connection.post(CREATE_PATH,
@@ -52,16 +53,29 @@ module PerfectAudit
 
       true
     end
+
+    def to_excel(book_or_id)
+      id = book_or_id.is_a?(PerfectAudit::Book) ? book_or_id.id.to_s : book_or_id.to_s
+      response = connection.get(EXCEL_EXPORT_PATH,
+        params: {
+          pk: id.to_s
+        }
+      )
+
+      response.body.to_s
+    end
   end
 
   class DocumentsRepository
     include PerfectAudit::AutoInject[:connection]
     include PerfectAudit::AutoInject[:response_parser]
 
+    CREATE_PATH = 'book/upload'.freeze
+
     def create(book_or_id, file)
       id = book_or_id.is_a?(PerfectAudit::Book) ? book_or_id.id.to_s : book_or_id.to_s
 
-      response = connection.post('book/upload',
+      response = connection.post(CREATE_PATH,
         form: {
           pk: id,
           upload: HTTP::FormData::File.new(file)
@@ -78,18 +92,20 @@ module PerfectAudit
   #   include PerfectAudit::AutoInject[:connection]
   #   include PerfectAudit::AutoInject[:response_parser]
 
-  #   def find(book_or_id)
-  #     id = book_or_id.is_a?(PerfectAudit::Book) ? book_or_id.id.to_s : book_or_id.to_s
+  #   # def find(book_or_id)
+  #   #   id = book_or_id.is_a?(PerfectAudit::Book) ? book_or_id.id.to_s : book_or_id.to_s
+
+  #   #   response = connection.get('transaction',
+  #   #     params: {
+  #   #       book_pk: id
+  #   #     }
+  #   #   )
 
-  #     response = connection.get('transaction',
-  #       params: {
-  #         book_pk: id
-  #       }
-  #     )
+  #   #   response_parser.parse(response.body.to_s)[:bank_accounts].map do |id, params|
+  #   #     PerfectAudit::BankAccount.new(params.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo})
+  #   #   end
+  #   # end
 
-  #     response_parser.parse(response.body.to_s)[:bank_accounts].map do |id, params|
-  #       PerfectAudit::BankAccount.new(params.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo})
-  #     end
-  #   end
+  #   def
   # end
 end

data/lib/perfect_audit/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: perfect_audit
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Igor Alexandrov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-22 00:00:00.000000000 Z
+date: 2018-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-auto_inject
@@ -259,4 +259,3 @@ signing_key:
 specification_version: 4
 summary: Perfect Audit API wrapper.
 test_files: []
-has_rdoc: