pdf4me 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5cab03031af5c80c55ae0c20a0bd35ea2da1566
-  data.tar.gz: 39616938411754524c95e452ac15328cda1771e7
+  metadata.gz: db3d182d3b4af74c5ff907eb49e4285a1cecfb43
+  data.tar.gz: 371372c8ca58d1dd7fb5c44692298b81b0dd98b0
 SHA512:
-  metadata.gz: 7809803d64511e1abb269457fedfa97ba27b1774b0ac55970ac88408cc0b5d97d2697c90f79d7f2814521fec505ded8140489f4a0eae5622c051e949b10a1079
-  data.tar.gz: 871941878cfca1d14d6497053bcc1f7e34b2d8ff9f120ca9badac0622a3128bec2a1ee45646d314f27d1c404b1348e125cf6de46e79b2cc1908114d392e8eef4
+  metadata.gz: 42dffb34be3838d87978197c9fc32f65717a1b7654977c1ffdd44dd54c3c408b11f488959154142304f53e30e8587015c08d58524d9dfd2fc3ed00444478246a
+  data.tar.gz: b0850f533a3839c904ffa9296c28b1f20f4a5507cc39898a3783a98aee0896f162c7ae01a33733f1ea2f24ca2838084c39f16e01a26790eaccccc52951969319

data/README.md

@@ -1,3 +1,5 @@
+## Note
+This documention is for Gem version 2.x.x, for documentation of Version 1.x.x, please refer the following [README](https://github.com/pdf4me/pdf4me-clientapi-ruby/tree/1-0-stable)
 # pdf4me
 
 **Pdf4me** is a PDF utility tool for Ruby and other languages.
@@ -157,16 +159,13 @@ a.run
 
 
 ## Advanced Usage
-> These methods are more complex than the Basic Wrapper methods. The development of which is still a Work in Progress. Currently there are two methods that you can use.
+> These methods are more complex than the Basic Wrapper methods.
 >
 > By default all the Advanced methods run in blocking mode -
 > i.e you wait for the server to send you the response.
 >
 > If you want to run the operation asynchronously - you will be notified by a webhook over the result -
-then please set `get_notification` to `true` in `Pdf4me::Notification`.
->
-> When the `Pdf4me::Notification` object is set, it will overwrite what is the default behaviour
-defined on the application/api level.
+then please configure the notification at the dashboard
 >
 >See Pdf4me-Developer page to configure the webhook on application level.
 
@@ -176,7 +175,7 @@ defined on the application/api level.
 `convert_file_to_pdf`. The request is instantiated as a hash with the `:req` key,
 that takes in `Pdf4me::ConvertToPdf` model.
 
-> The action takes three different models `:document`,  `:convert_to_pdf_action` and `:notification` and returns
+> The action takes two different models `:document`,  `:convert_to_pdf_action`  and returns
 `Pdf4me::ConvertToPdfRes`
 
 > To get more information regarding the models, please refer the provided [model definition](https://pdf4medoc.blob.core.windows.net/doc/index.html?java#converttopdfreq)
@@ -189,8 +188,7 @@ that takes in `Pdf4me::ConvertToPdf` model.
       doc_data: Base64.encode64(File.open(file_path, 'rb', &:read)),
       name: "TestDocToConvert.docx"
     ),
-    convert_to_pdf_action: Pdf4me::ConvertToPdfAction.new,
-    notification: Pdf4me::Notification.new(get_notification: true) # async, set false to invoke blocking mode.
+    convert_to_pdf_action: Pdf4me::ConvertToPdfAction.new
   )
   response = action.run
 
@@ -204,7 +202,7 @@ that takes in `Pdf4me::ConvertToPdf` model.
 
 > Given a PDF document, Optimize the document and return `Pdf4me::OptimizeRes`
 >
-> `:optimize` takes three different models `document`, `optimize_action` and `notification`
+> `:optimize` takes two different models `document` and `optimize_action`
 >
 > `Pdf4me::OptimizeAction` takes multiple arguments, important amongst them being `profile`
 >  * profile, valid values are `default`, `web`, `print`, `max`, `mRC`
@@ -234,10 +232,9 @@ that takes in `Pdf4me::ConvertToPdf` model.
 ### extract
 >  Extract out pages from PDF. You can choose from the pages you want to get.
 
-> `extract` takes three model arguments
+> `extract` takes two model arguments
 > * `extract_action`
 > * `document`
-> * `notification` - non mandatory
 
 > To list all possible options for the models please refer the  [model definition](https://pdf4medoc.blob.core.windows.net/doc/index.html?curl#extractreq)
 
@@ -250,8 +247,7 @@ that takes in `Pdf4me::ConvertToPdf` model.
         ),
         extract_action: Pdf4me::ExtractAction.new(
           extract_pages: [1, 2, 5]
-        ),
-        notification: Pdf4me::Notification.new(get_notification: true) # async
+        )
     )
     response = action.run
 
@@ -265,10 +261,9 @@ that takes in `Pdf4me::ConvertToPdf` model.
 > Creates images from the PDF Document. This is useful if you want to create thumbnails for the PDF.<br>
 > The options are highly configurable to get the desired output.
 > The output would be a base64 encoded object that you have to save.
-> `create_images` takes three different arguments.
+> `create_images` takes two different arguments.
 > * `document`
 > * `image_action`
-> * `notification` - non mandatory
 
 > Each model has their own set of attributes and hence can be configured further.
 The full documentation of model attributes are available at [model definition](https://pdf4medoc.blob.core.windows.net/doc/index.html?curl#createimagesreq)
@@ -305,10 +300,9 @@ The full documentation of model attributes are available at [model definition](h
 
 ### merge
 > Merges two or more PDF and gives MergeRes, a Base64 Encoded file
-> `merge` takes three model arguments
+> `merge` takes two model arguments
 > * `documents` - An Array of `Pdf4me::Document`
 > * `merge_action` - `Pdf4me::MergeAction` model - non mandatory
-> * `notification` - `Pdf4me::Notification` model - non mandatory
 
 > To list all possible options for the models please refer the  [model definition](https://pdf4medoc.blob.core.windows.net/doc/index.html?curl#mergereq)
 
@@ -341,10 +335,9 @@ The full documentation of model attributes are available at [model definition](h
 
 ### pdf_a
 > Creates PDF/A Documents from normal PDF document.
-> `pdf_a` takes three model arguments.
+> `pdf_a` takes two model arguments.
 > * `document` - a valid instance of `Pdf4me::Document`
 > * `pdf_a_action` - a valid instance of `Pdf4me::PdfAAction`
-> * `notification` - a valid instance of `Pdf4me::Notification` - non mandatory
 >
 > To list all possible options for the models please refer the  [model definition](https://pdf4medoc.blob.core.windows.net/doc/index.html?curl#createpdfareq)
 ```ruby
@@ -373,10 +366,9 @@ The full documentation of model attributes are available at [model definition](h
 
 ### split
 > Given a PDF, split the PDF into parts
-> `split` takes up three models
+> `split` takes up two models
 > * `document` - a valid instance of `Pdf4me::Document`
 > * `split_action` - a valid instance of `Pdf4me::SplitAction` which defines the number of parts the PDF splits into
-> * `notification` - non mandatory, an instance of `Pdf4me::Notification`
 >
 > To list all possible options for the models please refer the  [model definition](https://pdf4medoc.blob.core.windows.net/doc/index.html?curl#splitreq)
 
@@ -406,10 +398,9 @@ The full documentation of model attributes are available at [model definition](h
 > You can stamp either a text or image to PDF, There are two separate methods defined to help you with stamping
 >  - Stamp PDF with image
 >  - Stamp PDF with Text
-> `stamp` takes three model arguments
+> `stamp` takes two model arguments
 * `document` - a valid instance of `Pdf4me::Document`
 > * `stamp_action` - a valid instance of `Pdf4me::StampAction` which defines the stamp type, and position.
-> * `notification` - non mandatory, an instance of `Pdf4me::Notification`
 >
 > To list all possible options for the models please refer the  [model definition](https://pdf4medoc.blob.core.windows.net/doc/index.html?curl#stampreq)
 
@@ -422,8 +413,10 @@ The full documentation of model attributes are available at [model definition](h
       ),
       stamp_action: Pdf4me::StampAction.new(
         image: Pdf4me::Image.new(
-          image_data: Base64.encode64(File.open(image_path, 'rb', &:read))
-        )
+          image_data: Base64.encode64(File.open(image_path, 'rb', &:read)),
+          recetangle: Pdf4me::Rectangle.new(width: 200, height: 200)
+        ),
+
       )
     )
   response = action.run

data/lib/pdf4me.rb

@@ -68,7 +68,7 @@ require 'pdf4me/models/text'
 require 'pdf4me/models/transform'
 require 'pdf4me/models/translate'
 require 'pdf4me/models/image'
-
+require 'pdf4me/models/rectangle'
 
 
 module Pdf4me

data/lib/pdf4me/actions/complex_action.rb

@@ -1,6 +1,5 @@
 module Pdf4me
   class ComplexAction
-    attr_accessor :notification
     attr_reader :client
 
     def client
@@ -38,10 +37,6 @@ module Pdf4me
       errors.flatten
     end
 
-    def notification
-      @notification || Pdf4me::Notification.new
-    end
-
     protected
 
     def attributes

data/lib/pdf4me/actions/merge.rb

@@ -16,19 +16,17 @@ module Pdf4me
 
     def valid_objects?
       documents.is_a?(Array) &&
-        merge_action.is_a?(Pdf4me::MergeAction) &&
-        notification.is_a?(Pdf4me::Notification)
+        merge_action.is_a?(Pdf4me::MergeAction)
     end
 
     def valid_instances?
-      notification.valid? && merge_action.valid?
+      merge_action.valid?
     end
 
     def serialize_attributes
       {
         documents: documents.map { |document| document.attributes },
-        merge_action: merge_action.attributes,
-        notification: notification.attributes
+        merge_action: merge_action.attributes
       }
     end
   end

data/lib/pdf4me/client.rb

@@ -32,7 +32,6 @@ module Pdf4me
     end
 
     def post(path, params)
-      logger.debug(params)
       request = Typhoeus::Request.new(
         request_url(path),
         method: :post,
@@ -41,7 +40,7 @@ module Pdf4me
           'Accept': 'application/json',
           'Content-Type': 'application/json',
           'Authorization': "Basic #{config.token}",
-          'User-Agent': "Pdf4meClient/#{VERSION}/ruby"
+          'User-Agent': "Pdf4me/ruby/#{VERSION}"
         },
         timeout: 0,
         ssl_verifypeer: true,
@@ -65,7 +64,7 @@ module Pdf4me
           'Accept': 'application/octet-stream',
           'Content-Type': 'multipart/form-data',
           'Authorization': "Basic #{config.token}",
-          'User-Agent': "Pdf4meClient/#{VERSION}/ruby"
+          'User-Agent': "Pdf4me/ruby/#{VERSION}"
         },
         timeout: 0,
         ssl_verifypeer: true,

data/lib/pdf4me/models/document.rb

@@ -13,5 +13,9 @@ module Pdf4me
     }
     attr_accessor *ATTRIBUTES.keys
     validates_presence_of :doc_data
+
+    def inspect
+      "#<#{self.class}:0x#{object_id.to_s(16)}>"
+    end
   end
 end

data/lib/pdf4me/models/image.rb

@@ -2,10 +2,27 @@ module Pdf4me
   class Image < Base
     ATTRIBUTES = {
       image_data: 'String',
-      image_type: 'String'
+      image_type: 'String',
+      rectangle: 'Rectangle',
+      file_name: 'String',
+      compression: 'String',
+      rotate: 'Rotate',
+      translate: 'Translate',
+      transform: 'Transform'
     }
     attr_accessor *ATTRIBUTES.keys
 
     validates_presence_of :image_data
+    validates_inclusion_of :compression, in: %w|cCITTFax flate dCT|
+
+    def inspect
+      "#<#{self.class}:0x#{object_id.to_s(16)}>"
+    end
+
+    def defaults
+      {
+        compression: 'flate'
+      }
+    end
   end
 end

data/lib/pdf4me/models/rectangle.rb

@@ -0,0 +1,15 @@
+module Pdf4me
+  class Rectangle < Base
+    ATTRIBUTES = {
+      x: 'Integer',
+      y: 'Integer',
+      width: 'Integer',
+      height: 'Integer'
+    }
+
+    attr_accessor *ATTRIBUTES.keys
+    validates_presence_of :width, :height
+  end
+end
+
+

data/lib/pdf4me/version.rb

@@ -1,3 +1,3 @@
 module Pdf4me
-  VERSION = "2.0.4"
+  VERSION = "2.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdf4me
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
 platform: ruby
 authors:
 - arpanlepcha
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-14 00:00:00.000000000 Z
+date: 2018-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -176,6 +176,7 @@ files:
 - lib/pdf4me/models/pdf_a_action.rb
 - lib/pdf4me/models/pdf_a_res.rb
 - lib/pdf4me/models/pdf_font.rb
+- lib/pdf4me/models/rectangle.rb
 - lib/pdf4me/models/rgb_set.rb
 - lib/pdf4me/models/rotate.rb
 - lib/pdf4me/models/split_action.rb
@@ -258,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Pdf4me Ruby Gem