web_merge 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae95c7b06804d65c4af0658a9d3276a5512c0164
-  data.tar.gz: 1ecfc7e14318902e71601e2a93172f383da15ebd
+  metadata.gz: bc7a10e1ae74d9250ab19f76d480191409df2a53
+  data.tar.gz: ffe5b449a036bc8efdc7b3d44ee028b098d4a68c
 SHA512:
-  metadata.gz: 03bcccc868d80c9a65c4cb052c33d6c2e3a78e980fb40ddf3a618ee7f439e3c24a7d6f2472e3845898fd53449ac498229891cb356d309d3e1c3491e6860c1a66
-  data.tar.gz: 7bc9f2ae4c2431ed0fffea3a47781fb7eeb1e695f190b9ad4e631ede4cd3ea6c435a378919e1807efaaac649c33671a6cd73071c41126650c2aec101f2ec9de5
+  metadata.gz: 537cc6e7452062a6342393c1ab6d063e41e0b21a7e82ef4f371741cc1b2f82c1710acf70abe0d7e08f54596c65cb84b19c5f10a0f921ec5739ce5a28d9833938
+  data.tar.gz: 4926a32d64c0b0924fb4aeaceb83b289a2bcce78cbab708abc5f28e53b5eb0657be337eb6e6c945a8461738d7c78a87d4dc84a5198e6929c2d944d29958cbeeb

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.0.3
+
+* Increased test coverage.
+* Added support for more document types.
+* Added support for the document file API endpoint.
+* Added support for JSON payload.
+* Raises an error if a document didn't save on WebMerge.
+
 ## 1.0.2
 
 * Update regex for single line match.

data/lib/web_merge/api.rb

@@ -35,6 +35,10 @@ module WebMerge
       get("#{WebMerge::Constants::DOCUMENTS}/#{doc_id}/fields", &block)
     end
 
+    def get_document_file(doc_id, &block)
+      get("#{WebMerge::Constants::DOCUMENTS}/#{doc_id}/file", &block)
+    end
+
     # doc_id	The Document ID
     #   example: 436346
     # doc_key	The Document Key
@@ -98,9 +102,9 @@ module WebMerge
       uri = URI.parse(url_string)
       Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
         action_klass = "Net::HTTP::#{verb.camelize}".constantize
-        request = action_klass.new(uri.request_uri)
+        request = action_klass.new(uri.request_uri, 'Content-Type' => 'application/json')
         request.basic_auth(@api_key, @api_secret)
-        request.set_form_data(form_data) if form_data.present?
+        request.body = form_data.to_json if form_data.present?
         http.request(request) do |response|
           if block_given?
             return block.call(response)

data/lib/web_merge/constants.rb

@@ -20,13 +20,15 @@ module WebMerge
     HTML = 'html'
     DOCX = 'docx'
     EMAIL = 'email'
+    PPTX = 'pptx'
+    XLSX = 'xlsx'
 
     SECURITY_LEVEL_LOW = 'low'
     SECURITY_LEVEL_MEDIUM = 'medium'
     SECURITY_LEVEL_HIGH = 'high'
 
-    SUPPORTED_TYPES = [HTML, PDF, DOCX]
-    SUPPORTED_OUTPUTS = [PDF, DOCX, EMAIL]
+    SUPPORTED_TYPES = [HTML, PDF, DOCX, PPTX, XLSX]
+    SUPPORTED_OUTPUTS = [PDF, DOCX, EMAIL, PPTX, XLSX]
 
     SECURITY_LEVELS = [SECURITY_LEVEL_LOW, SECURITY_LEVEL_MEDIUM, SECURITY_LEVEL_HIGH]
   end

data/lib/web_merge/document.rb

@@ -1,4 +1,7 @@
+
 module WebMerge
+  class DocumentError < RuntimeError; end;
+
   class Document
     include ::ActiveModel::Validations
 
@@ -21,8 +24,8 @@ module WebMerge
       @size_height = options[:size_height]
     end
 
-    def self.find(doc_id)
-      instance = empty_instance
+    def self.find(doc_id, client: required(:client))
+      instance = empty_instance(client)
       instance.send(:id=, doc_id)
       instance.reload
     end
@@ -33,9 +36,9 @@ module WebMerge
       end
     end
 
-    def self.all
-      @client.get_documents.map do |doc_hash|
-        instance = empty_instance
+    def self.all(client: required(:client))
+      client.get_documents.map do |doc_hash|
+        instance = empty_instance(client)
         instance.send(:update_instance, doc_hash)
         instance
       end
@@ -56,6 +59,8 @@ module WebMerge
       else
         @client.update_document(id, as_form_data)
       end
+      raise WebMerge::DocumentError.new(response['error']) if response['error'].present?
+
       update_instance(response.symbolize_keys)
       true
     end
@@ -112,8 +117,8 @@ module WebMerge
     private
     attr_writer :id, :key, :size, :active, :url
 
-    def self.empty_instance
-      new(name: "", type: "", output: "")
+    def self.empty_instance(client)
+      new(client: client, name: "", type: "", output: "")
     end
 
     def update_instance(response)

data/lib/web_merge/version.rb

@@ -1,3 +1,3 @@
 module WebMerge
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/spec/api_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require_relative '../lib/web_merge/constants'
+require_relative '../lib/web_merge/api'
+
+describe WebMerge::API do
+  let(:api) { described_class.new(secret: 'foo', key: 'bar', force_test_mode: true) }
+  let(:document) do
+    double(:document, id: 123, type: 'pdf', contents: 'things', updated_at: Time.now)
+  end
+
+  describe '#get_document_file' do
+
+    let(:url_string) { "#{WebMerge::Constants::DOCUMENTS}/#{document.id}/file" }
+    let(:response) do
+      { 'type' => document.type, 'last_update' => document.updated_at, 'contents' => document.contents }
+    end
+    it 'makes a get request' do
+      expect(api).to receive(:get).with(url_string).and_return(response)
+      expect(api.get_document_file(document.id)).to eq(response)
+    end
+  end
+end

data/spec/document_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+require_relative '../lib/web_merge/constants'
+require_relative '../lib/web_merge/document'
+
+describe WebMerge::Document do
+  describe '.find' do
+    let(:document) do
+      described_class.new(client: 'foo', name: 'foo', type: 'foo').tap do |document|
+        document.send(:id=, rand(1..10))
+      end
+    end
+    let(:client) { double(:client, get_document: response ) }
+    let(:response) { { foo: 'irrelevant' } }
+
+    it 'returns a document' do
+      finder = described_class.find(document.id, client: client)
+      expect(finder).to be_kind_of(described_class)
+    end
+  end
+
+  describe '.all' do
+    let(:client) { double(:client, get_documents: response ) }
+    let(:response) { [ first_document: 'foo', second_document: 'bar' ] }
+
+    it 'returns a collection of documents' do
+      finder = described_class.all(client: client)
+
+      finder.each do |doc|
+        expect(doc).to be_kind_of(described_class)
+      end
+    end
+  end
+
+  describe '#save' do
+    let(:client) { double(:client, create_document: response ) }
+    context 'document is valid' do
+      let(:response) do
+        {
+          "id":"234543",
+          "key":"firm3",
+          "type":"html",
+          "name":"1040 EZ",
+          "output":"pdf",
+          "size":"",
+          "size_width":"8.5",
+          "size_height":"11",
+          "active":"1",
+          "url":"https://www.webmerge.me/merge/234543/firm3",
+          "fields":[
+            {"key":"aflekjf409t3j4mg30m409m", "name":"FirstName"},
+            {"key":"3to3igj3g3gt94j9304jfqw", "name":"LastName"},
+            {"key":"t43j0grjaslkfje304vj9we", "name":"Email"}
+          ]
+        }
+      end
+
+      let(:valid_document) do
+        described_class.new(client: client, name: 'foo', type: 'docx')
+      end
+
+      it 'returns true' do
+        expect(valid_document.save).to eq(true)
+      end
+    end
+  end
+
+  describe '#save!' do
+    let(:client) { double(:client, create_document: response ) }
+    context 'document is valid' do
+      let(:response) do
+        {
+          "id":"234543",
+          "key":"firm3",
+          "type":"html",
+          "name":"1040 EZ",
+          "output":"pdf",
+          "size":"",
+          "size_width":"8.5",
+          "size_height":"11",
+          "active":"1",
+          "url":"https://www.webmerge.me/merge/234543/firm3",
+          "fields":[
+            {"key":"aflekjf409t3j4mg30m409m", "name":"FirstName"},
+            {"key":"3to3igj3g3gt94j9304jfqw", "name":"LastName"},
+            {"key":"t43j0grjaslkfje304vj9we", "name":"Email"}
+          ]
+        }
+      end
+
+      let(:valid_document) do
+        described_class.new(client: client, name: 'foo', type: 'docx')
+      end
+
+      it 'returns nil' do
+        expect(valid_document.save!).to be_nil
+      end
+    end
+
+    context 'document has merge field errors' do
+      let(:response) do
+        { 'error' => 'Error merging document: Syntax error in template...' }
+      end
+      let(:document_with_merge_field_errors) do
+        described_class.new(client: client, name: 'foo', type: 'docx')
+      end
+
+      it 'raises an error upon document save error' do
+        expect { document_with_merge_field_errors.save! }.to raise_error(WebMerge::DocumentError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'active_model'
+require 'rspec'

data/web_merge.gemspec

@@ -20,5 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "pry", "~> 0.10"
   spec.add_development_dependency "activemodel", ">= 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: web_merge
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Jeremy Clarke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-12 00:00:00.000000000 Z
+date: 2017-07-16 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: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -71,6 +99,9 @@ files:
 - lib/web_merge/document.rb
 - lib/web_merge/notification.rb
 - lib/web_merge/version.rb
+- spec/api_spec.rb
+- spec/document_spec.rb
+- spec/spec_helper.rb
 - web_merge.gemspec
 homepage: http://www.webmerge.me
 licenses:
@@ -92,8 +123,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: WebMerge REST API Wrapper
-test_files: []
+test_files:
+- spec/api_spec.rb
+- spec/document_spec.rb
+- spec/spec_helper.rb