pdfbucket 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d69835003ac37c1a070c0dca78860219ce255a5b
-  data.tar.gz: fd2d427153bba4db28df8a501f4aecdf281a9d34
+  metadata.gz: f06f7c98093bb540a3813a3f9d4fa5c1e29f6d7c
+  data.tar.gz: 1b40b8e0ec2860cd2a52c7efcdff1ed3a811a03b
 SHA512:
-  metadata.gz: 9aa6d13ee50b2c6801df7b2f8a75158f2f8ebd99cabc6eb5cf41d12e7d7b1e06e10eff61ac70b61f315a09a4860ea73da47f0acbc7618962742f7a3261106298
-  data.tar.gz: 62890495c4eccb68d0e8971dbb9cdb9f7d4421c777f76b85944ab6a9aceeae03e5b9b63c2b359e7a861dfc2807def2048fe5a02e2e1f91d8d862033aadc7af88
+  metadata.gz: 91be2d208c8392aeefcf75c7f9315b8789bab52ef2dd410629df94a2204f1760f853289e1720946787973d47da70abe6791789071981e5d48e7acf2882401e03
+  data.tar.gz: 703b38409fcce03b76bee8307dfa7de764eb60c42ed38b1bdc4f33afd52fb8122737090912468f5f861c13d90d1f0d34d64bd03112b9bac30156631858c78579

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+.byebug_history
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.3

data/README.md

@@ -27,20 +27,27 @@ pdf_bucket = PDFBucket::PDFBucket.new
 # You can also set any the api params, overwriting then ENV vars like this
 other_pdf_bucket = PDFBucket::PDFBucket.new(api_key: '123', api_secret: '321', api_host: 'api.example.com')
 
-# And you get the encrypted_url using the generate_url method
-encrypted_url = pdf_bucket.generate_url('http://example.com', :landscape, :a4, '2px', '0.7')
-```
+# And you get the encrypted_url using the generate_url method taking into account the following order:
 
-Also you can pass the plain URL to PDFBucket
+# Without pagination: (uri, orientation, page_size, margin, zoom)
+encrypted_url = pdf_bucket.generate_url('http://example.com', :landscape, :a4, '2px', '0.7')
 
-```ruby
-plain_url = pdf_bucket.generate_plain_url('http://example.com', :landscape, :a4, '2px', '0.7')
+# With pagination: (uri, orientation, page_size, margin, zoom, expires_in, pagination, position, alignment, cache)
+encrypted_url = pdf_bucket.generate_url('http://example.com', :landscape, :a4, '2px', '0.7', 0, true, :header, :center)
+          # Also you can pass the plain URL to PDFBucket
+plain_url = pdf_bucket.generate_plain_url('http://example.com', :landscape, :a4, '2px', '0.7', 0, true, :header, :center)
 ```
 
-* Possible values for orientation: :landscape, :portrait
-* Possible values for page size: :letter, :a4
-* Possible values for margin: https://developer.mozilla.org/en-US/docs/Web/CSS/margin#Formal_syntax
-* Possible values for zoom: https://developer.mozilla.org/en-US/docs/Web/CSS/@viewport/zoom#Formal_syntax
+**Possible values for the different params:**
+* **orientation:** `:landscape` or `:portrait`
+* **page size:** `:letter` or `:a4`
+* **margin:** https://developer.mozilla.org/en-US/docs/Web/CSS/margin#Formal_syntax
+* **zoom:** https://developer.mozilla.org/en-US/docs/Web/CSS/@viewport/zoom#Formal_syntax
+* **pagination:** `true` or `false`
+* **position:** `:header` or `:footer`
+* **alignment:** `:left`, `:center` or `:right`
+* **expires_in:** integer value in `seconds`
+* **cache:** `0` to disable cache
 
 
 ## Development

data/lib/pdfbucket.rb

@@ -7,7 +7,8 @@ require 'uri'
 
 # Main module
 module PDFBucket
-  DEFAULT_HOST = 'api.pdfbucket.io'
+  #DEFAULT_HOST = 'api.pdfbucket.io'
+  DEFAULT_HOST = '8ed3489f.ngrok.io'
   ORIENTATIONS = {
     portrait: 'portrait',
     landscape: 'landscape'
@@ -16,66 +17,76 @@ module PDFBucket
     a4: 'A4',
     letter: 'Letter'
   }
+  POSITIONS = {
+    header: 'header',
+    footer: 'footer'
+  }
+  ALIGNMENTS = {
+    left:   'left',
+    center: 'center',
+    right:  'right'
+  }
 
   # Main class
   class PDFBucket
     attr_reader :api_key, :api_secret, :api_host
 
     def initialize(
-      api_key: ENV['PDF_BUCKET_API_KEY'],
+      api_key:    ENV['PDF_BUCKET_API_KEY'],
       api_secret: ENV['PDF_BUCKET_API_SECRET'],
-      api_host: ENV['PDF_BUCKET_API_HOST'])
+      api_host:   ENV['PDF_BUCKET_API_HOST'])
 
       fail 'bucket api_key is required' if api_key.nil? || api_key.strip.empty?
       fail 'bucket api_secret is required' if api_secret.nil? || api_secret.strip.empty?
 
-      @api_host = api_host || DEFAULT_HOST
-      @api_key = api_key
+      @api_host   = api_host || DEFAULT_HOST
+      @api_key    = api_key
       @api_secret = api_secret
     end
 
-    def generate_url(url, orientation, page_size, margin, zoom)
+    def generate_url(url, orientation, page_size, margin, zoom, expires_in = 0, pagination = false, position = nil, alignment = nil, cache = nil)
       encrypted_uri = encrypt(api_secret, url)
 
-      query = URI.encode_www_form(
-        orientation: ORIENTATIONS[orientation],
-        page_size: PAGE_SIZES[page_size],
-        margin: margin,
-        zoom: zoom,
-        api_key: api_key,
-        encrypted_uri: encrypted_uri)
-
-      URI::HTTPS.build(
-        host: api_host,
-        path: '/api/convert',
-        query: query).to_s
+      params = {
+        orientation:    ORIENTATIONS[orientation],
+        page_size:      PAGE_SIZES[page_size],
+        margin:         margin,
+        zoom:           zoom,
+        expires_in:     expires_in,
+        api_key:        api_key,
+        encrypted_uri:  encrypted_uri
+      }
+      set_optional_params(params, pagination, position, alignment, cache)
+      build_uri(params)
     end
 
-    def generate_plain_url(url, orientation, page_size, margin, zoom)
-      signature = sign(api_secret, api_key, url, orientation, page_size, margin, zoom)
-      query = URI.encode_www_form(
-        orientation: ORIENTATIONS[orientation],
-        page_size: PAGE_SIZES[page_size],
-        margin: margin,
-        zoom: zoom,
-        api_key: api_key,
-        uri: url,
-        signature: signature)
-
-      URI::HTTPS.build(
-        host: api_host,
-        path: '/api/convert',
-        query: query).to_s
+    def generate_plain_url(url, orientation, page_size, margin, zoom, expires_in = 0, pagination = false, position = nil, alignment = nil, cache = nil)
+      signature = sign(api_secret, api_key, url, orientation, page_size, margin, zoom, pagination, position, alignment)
+
+      params = {
+        orientation:  ORIENTATIONS[orientation],
+        page_size:    PAGE_SIZES[page_size],
+        margin:       margin,
+        zoom:         zoom,
+        expires_in:   expires_in,
+        api_key:      api_key,
+        uri:          url,
+        signature:    signature
+      }
+      set_optional_params(params, pagination, position, alignment, cache)
+      build_uri(params)
     end
 
     private
-
-    def sign(api_secret, api_key, url, orientation, page_size, margin, zoom)
+    def sign(api_secret, api_key, url, orientation, page_size, margin, zoom, pagination, position, alignment)
       params = [
         api_key,
         url,
         ORIENTATIONS[orientation],
         PAGE_SIZES[page_size],
+        pagination.to_s,
+        POSITIONS[position],
+        ALIGNMENTS[alignment],
         margin,
         zoom
       ].join(',')
@@ -97,5 +108,23 @@ module PDFBucket
 
       Base64.strict_encode64(iv + cipher)
     end
+
+    def build_uri(params)
+      URI::HTTPS.build(
+        host: api_host,
+        path: '/api/convert',
+        query: URI.encode_www_form(params)).to_s
+    end
+
+    def set_optional_params(params, pagination, position, alignment, cache)
+      params.merge!(cache: cache) if cache
+      if pagination
+        params.merge!({
+          pagination: pagination,
+          position:   POSITIONS[position],
+          alignment:  ALIGNMENTS[alignment]
+        })
+      end
+    end
   end
 end

data/lib/pdfbucket/version.rb

@@ -1,3 +1,3 @@
 module PDFBucket
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/pdfbucket.gemspec

@@ -29,4 +29,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "byebug"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdfbucket
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - sanrodari
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-08 00:00:00.000000000 Z
+date: 2017-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: PDFBucket integration library to use PDFBucket service
 email:
 - santiago.rodriguez@kommit.co
@@ -46,6 +74,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
@@ -75,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: PDFBucket integration