web_merge 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c514ab84c84abc4f88133dde2fce21ba8e2a1b81
+  data.tar.gz: 3bb31dea086300f008e05eac0f0d0981151eaeb7
+SHA512:
+  metadata.gz: f7a5c30238783927772bee0ebb347ac51bb5d81060d6a62954d1fd6ab57e69d1e761ffa69e38f088343c2e0aa5c37bd1fa326785598159e361d20afd9d929501
+  data.tar.gz: 514fb4ab7d9c16cc3b3cd669d5f176014e643072ce42e1d4f4aeb67a8d752c2c160b87fd79767e876a247797a637269a923a682ed0e8d36420fbf04f8c0686be

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+vendor

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in web_merge.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Joe Heth
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# WebMerge Ruby
+
+Manage and merge Documents using the WebMerge.me REST API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'web_merge'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install web_merge
+
+## Usage
+
+```ruby
+config = {
+  key: "N64EFIM0000000000000",
+  secret: "ABCDEFGH"
+}
+
+api = WebMerge::API.new(config)
+
+# Get Document List
+api.get_documents
+# => [{"id" => 1, "key" => "abcd", "type" => "pdf", ...}, ...]
+
+# Get Single Document
+api.get_document(30036)
+# => {"id" => 1, "key" => "abcd", "type" => "pdf", ...}
+
+# Merge Fields with Document
+fields = {
+  first_name: "John",
+  last_name: "Doe",
+}
+
+api.merge_document(doc_id=10000, key="4y7e1h", fields, {test: 1})
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/web_merge/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/web_merge/api.rb

@@ -0,0 +1,126 @@
+module WebMerge
+  class API
+
+    def initialize(options={})
+      @api_secret = options[:secret] || ENV['WEB_MERGE_API_SECRET']
+      @api_key = options[:key] || ENV['WEB_MERGE_API_KEY']
+      @force_test_mode = options[:force_test_mode] || ENV['WEB_MERGE_FORCE_TEST_MODE']
+      @verbose = options[:verbose] || false
+    end
+
+    #
+    # DOCUMENTS
+    #
+    def create_document(form_data, &block)
+      post("#{WebMerge::Constants::DOCUMENTS}", form_data, &block)
+    end
+
+    def update_document(doc_id, form_data, &block)
+      put("#{WebMerge::Constants::DOCUMENTS}/#{doc_id}", form_data, &block)
+    end
+
+    def delete_document(doc_id, &block)
+      delete("#{WebMerge::Constants::DOCUMENTS}/#{doc_id}", &block)
+    end
+
+    def get_documents(&block)
+      get("#{WebMerge::Constants::DOCUMENTS}", &block)
+    end
+
+    def get_document(doc_id, &block)
+      get("#{WebMerge::Constants::DOCUMENTS}/#{doc_id}", &block)
+    end
+
+    def get_document_fields(doc_id, &block)
+      get("#{WebMerge::Constants::DOCUMENTS}/#{doc_id}/fields", &block)
+    end
+
+    # doc_id	The Document ID
+    #   example: 436346
+    # doc_key	The Document Key
+    #   example: firm3
+    # field_mappings	The data to be merged in name/value pairs
+    #   example: { name: "John Smith", occupation: "Plumber" }
+    #
+    # options[:test] Merges the document in "test mode"
+    #   default: false.
+    # options[:download] Will return the merged document in response
+    #   default: false
+    #
+    def merge_document(doc_id, doc_key, field_mappings, options = {}, &block)
+      post("#{WebMerge::Constants::MERGE_ENDPOINT}/#{doc_id}/#{doc_key}?download=#{download(options)}&test=#{test(options)}", field_mappings, &block)
+    end
+
+    #
+    # ROUTES
+    #
+    def get_routes(&block)
+      get("#{WebMerge::Constants::ROUTES}", &block)
+    end
+
+    def get_route(route_id, &block)
+      get("#{WebMerge::Constants::ROUTES}/#{route_id}", &block)
+    end
+
+    def get_route_fields(route_id, &block)
+      get("#{WebMerge::Constants::ROUTES}/#{route_id}/fields", &block)
+    end
+
+    def merge_route(route_id, route_key, field_mappings, options = {}, &block)
+      post("#{WebMerge::Constants::ROUTE_ENDPOINT}/#{route_id}/#{route_key}?download=#{download(options)}&test=#{test(options)}", field_mappings, &block)
+    end
+
+    # internal helpers
+    def post(url_string, form_data, &block)
+      request("post", url_string, form_data, &block)
+    end
+
+    def put(url_string, form_data, &block)
+      request("put", url_string, form_data, &block)
+    end
+
+    def delete(url_string, &block)
+      request("delete", url_string, &block)
+    end
+
+    def get(url_string, &block)
+      request("get", url_string, &block)
+    end
+
+    def request(verb, url_string, form_data = nil, &block)
+      parsed_response_body = nil
+      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.basic_auth(@api_key, @api_secret)
+        request.set_form_data(form_data) if form_data.present?
+        http.request(request) do |response|
+          if block_given?
+            return block.call(response)
+          else
+            begin
+              parsed_response_body = JSON.parse(response.body)
+            rescue
+              parsed_response_body = "Unable to parse response body as JSON perhaps you'd like to pass a block to process the response?"
+              parsed_response_body << "#{response.body}"
+            end
+          end
+        end
+      end
+      parsed_response_body
+    end
+
+    def download(options)
+      options[:download] && true?(options[:download]) ? 1 : 0
+    end
+
+    def test(options)
+      true?(@force_test_mode) || (options[:test] && true?(options[:test])) ? 1 : 0
+    end
+
+    def true?(value)
+      value.to_s.match(/(true|t|yes|y|1)$/i).present?
+    end
+  end
+end

data/lib/web_merge/constants.rb

@@ -0,0 +1,33 @@
+module WebMerge
+  class Constants
+    WEB_MERGE = "https://www.webmerge.me"
+
+    API_ENDPOINT = "#{WEB_MERGE}/api"
+
+    MERGE_ENDPOINT = "#{WEB_MERGE}/merge"
+    ROUTE_ENDPOINT = "#{WEB_MERGE}/route"
+
+    DOCUMENTS = "#{API_ENDPOINT}/documents"
+
+    ROUTES = "#{API_ENDPOINT}/routes"
+
+    API_SECRET = ENV['WEB_MERGE_API_SECRET']
+    API_KEY = ENV['WEB_MERGE_API_KEY']
+
+    FORCE_TEST_MODE = ENV['WEB_MERGE_FORCE_TEST_MODE']
+
+    PDF = 'pdf'
+    HTML = 'html'
+    DOCX = 'docx'
+    EMAIL = 'email'
+
+    SECURITY_LEVEL_LOW = 'low'
+    SECURITY_LEVEL_MEDIUM = 'medium'
+    SECURITY_LEVEL_HIGH = 'high'
+
+    SUPPORTED_TYPES = [HTML, PDF, DOCX]
+    SUPPORTED_OUTPUTS = [PDF, DOCX, EMAIL]
+
+    SECURITY_LEVELS = [SECURITY_LEVEL_LOW, SECURITY_LEVEL_MEDIUM, SECURITY_LEVEL_HIGH]
+  end
+end

data/lib/web_merge/document.rb

@@ -0,0 +1,139 @@
+module WebMerge
+  class Document
+    include ::ActiveModel::Validations
+
+    attr_accessor :name, :type, :output, :output_name, :size_width, :size_height, :notification, :file_path
+    attr_reader :id, :key, :size, :active, :url
+
+    validates_presence_of :name, :type, :output
+    validates_presence_of :file_path
+    validates :type, inclusion: { in: WebMerge::Constants::SUPPORTED_TYPES }
+    validates :output, inclusion: { in: WebMerge::Constants::SUPPORTED_OUTPUTS }
+
+    def initialize(name: required(:name), type: required(:type), output: WebMerge::Constants::PDF, file_path: nil, options: {})
+      @name = name
+      @type = type
+      @output = output
+      @file_path = file_path
+      @output_name = options[:output_name]
+      @size_width = options[:size_width]
+      @size_height = options[:size_height]
+    end
+
+    def self.find(doc_id)
+      instance = empty_instance
+      instance.send(:id=, doc_id)
+      instance.reload
+    end
+
+    def self.each
+      all.each do |doc|
+        yield doc if block_given?
+      end
+    end
+
+    def self.all
+      WebMerge::API.get_documents.map do |doc_hash|
+        instance = empty_instance
+        instance.send(:update_instance, doc_hash)
+        instance
+      end
+    end
+
+    def html?
+      type == WebMerge::Constants::HTML
+    end
+
+    def new_document?
+      id.blank?
+    end
+
+    def save
+      return false unless valid?
+      response = if new_document?
+        WebMerge::API.create_document(as_form_data)
+      else
+        WebMerge::API.update_document(id, as_form_data)
+      end
+      update_instance(response.symbolize_keys)
+      true
+    end
+
+    def save!
+      raise "Document contains errors: #{errors.full_messages.join(", ")}" unless save
+    end
+
+    def reload
+      raise "Cannot reload a new document, perhaps you'd like to call `save' first?" if new_document?
+      response = WebMerge::API.get_document(id)
+      update_instance(response)
+      self
+    end
+
+    def delete
+      delete = false
+      WebMerge::API.delete_document(id) { |response| delete = JSON(response.body)["success"] } unless new_document?
+      delete
+    end
+
+    def fields
+      raise "Cannot fetch fields for an unpersisted document, perhaps you'd like to call `save' first?" if new_document?
+      @fields ||= WebMerge::API.get_document_fields(id)
+    end
+
+    def field_names
+      fields.map { |field| field["name"] }
+    end
+
+    def merge(field_mappings, options = {}, &block)
+      raise "Cannot merge an unpersisted document, perhaps you'd like to call `save' first?" if new_document?
+      WebMerge::API.merge_document(id, key, field_mappings, options, &block)
+    end
+
+    def as_form_data
+      request_params = {
+        name: name,
+        type: type,
+        output: output
+      }
+      [:output_name, :size_width, :size_height].each do |key|
+        value = send(key)
+        request_params.merge!(key => value) if value.present?
+      end
+      merge_file_contents!(request_params)
+      merge_notification!(request_params) if notification.present?
+      request_params
+    end
+
+    private
+    attr_writer :id, :key, :size, :active, :url
+
+    def self.empty_instance
+      new(name: "", type: "", output: "")
+    end
+
+    def update_instance(response)
+      response.each_pair do |key, value|
+        send("#{key}=".to_sym, value) if respond_to?("#{key}=".to_sym, true)
+      end
+    end
+
+    def merge_file_contents!(request_params)
+      if html?
+        html_string = IO.binread(file_path)
+        request_params.merge!(html: html_string)
+      else
+        encoded = Base64.encode64(IO.binread(file_path))
+        request_params.merge!(file_contents: encoded)
+      end
+      request_params
+    end
+
+    def merge_notification!(request_params)
+      notification.as_form_data.each_pair do |key, value|
+        request_params.merge!("notification[#{key}]" => value)
+      end
+    end
+
+  end
+end

data/lib/web_merge/notification.rb

@@ -0,0 +1,38 @@
+module WebMerge
+  class Notification
+    include ::ActiveModel::Validations
+
+    attr_accessor :to, :from, :subject, :html, :security, :password
+
+    validates_presence_of :to, :from
+    validates_format_of :to, :from, :with => /^(|(([A-Za-z0-9]+_+)|([A-Za-z0-9]+\-+)|([A-Za-z0-9]+\.+)|([A-Za-z0-9]+\++))*[A-Za-z0-9]+@((\w+\-+)|(\w+\.))*\w{1,63}\.[a-zA-Z]{2,6})$/i
+    validates_presence_of :password, if: :requires_password?
+    validates :security, inclusion: { in: WebMerge::Constants::SECURITY_LEVELS }
+
+    def initialize(to: required(:to), from: required(:from), subject: "WebMerge Notification", security: WebMerge::Constants::SECURITY_LEVEL_LOW, html: nil, password: nil)
+      @to = to
+      @from = from
+      @subject = subject
+      @security = security
+      @html = html
+      @password = password
+    end
+
+    def requires_password?
+      security == WebMerge::Constants::SECURITY_LEVEL_MEDIUM || security == WebMerge::Constants::SECURITY_LEVEL_HIGH
+    end
+
+    def as_form_data
+      request_params = {
+        to: to,
+        from: from,
+        subject: subject,
+        html: html,
+        security: security
+      }
+      request_params.merge!(password: password) if requires_password?
+      request_params
+    end
+
+  end
+end

data/lib/web_merge/version.rb

@@ -0,0 +1,3 @@
+module WebMerge
+  VERSION = "1.0.0"
+end

data/lib/web_merge.rb

@@ -0,0 +1,13 @@
+require "web_merge/version"
+
+require 'json'
+require 'active_model'
+
+require 'web_merge/api'
+require 'web_merge/constants'
+require 'web_merge/document'
+require 'web_merge/notification'
+
+module WebMerge
+
+end

data/web_merge.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'web_merge/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "web_merge"
+  spec.version       = WebMerge::VERSION
+  spec.authors       = ["Jeremy Clarke"]
+  spec.email         = ["JeremyClarke@webmerge.me"]
+  spec.summary       = %q{WebMerge REST API Wrapper}
+  spec.description   = %q{Manage and merge Documents using the WebMerge.me REST API}
+  spec.homepage      = "http://www.webmerge.me"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "activemodel", ">= 3.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: web_merge
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jeremy Clarke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Manage and merge Documents using the WebMerge.me REST API
+email:
+- JeremyClarke@webmerge.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/web_merge.rb
+- lib/web_merge/api.rb
+- lib/web_merge/constants.rb
+- lib/web_merge/document.rb
+- lib/web_merge/notification.rb
+- lib/web_merge/version.rb
+- web_merge.gemspec
+homepage: http://www.webmerge.me
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: WebMerge REST API Wrapper
+test_files: []