velocify 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7dfb40bb9964cb7848245548804fbf1afa856aaa
-  data.tar.gz: bac9230a7f0ffd5f32e76bcb53f44da4b48fa644
+  metadata.gz: ee1603a4f06f0f08e5d8328494e33032d7f5b5fb
+  data.tar.gz: 72a7393f07db8068fad64e459d6d911721276dcf
 SHA512:
-  metadata.gz: 712b29bccf0070f6ec4c6d8515f06d21d5814ab0d5fe74940920345b79aa2887666700aef244f1b21422e7a13c2a3efc7b88697f39f36e0ea7754c033f6e9763
-  data.tar.gz: 70d94b691523358baf9cbe4f80a5afd1a790193ee9829a351edf54026678fbefe04e03c09efae6523dfafce020f1121e131ed3f056a25366174ab9dfde1d4232
+  metadata.gz: 5b6bbebb0e2ae3dd963ead916315f8b2993fde6dff387852b4a27c4c9a481e323dafcd56d4c9dceb15a22520f4192641768baacda8937e9095bd27d1cc6294bb
+  data.tar.gz: 338374623b65744e64537aeedd1e82c3a66e463920c1324a494a5c6e71ab53262b78a0005b4a0d858b0c08d73b7a248afa1a652dde530befe1cc93c8333bc3a8

data/.gitignore

@@ -11,4 +11,6 @@
 .env
 *.gem
 .ruby-version
+.rbenv-gemsets
 *.swp
+.gems

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# Changes in 0.1.7
+
+* Supports adding filter items to the template_values option when retrieving report results
+
+```
+require 'ostruct'
+
+item = OpenStruct.new field_title: 'Last Status Change Date', value: '4/12/2016 12:00:00'
+Velocify::Report.find_results report_id: 123, template_values: [ item ]
+```
+
 # Changes in 0.1.6
 
 * Supports programmatic configuration of Velocify credentials:

data/Gemfile

@@ -2,4 +2,6 @@ source 'https://rubygems.org'
 
 gem "codeclimate-test-reporter", group: :test, require: nil
 
+gem 'pry'
+
 gemspec

data/bin/console

@@ -3,12 +3,5 @@
 require "bundler/setup"
 require "velocify"
 
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start
+require "pry"
+Pry.start

data/lib/velocify.rb

@@ -37,5 +37,4 @@ require "velocify/status"
 require "velocify/report"
 
 require "velocify/response_reader"
-require "velocify/message_payload"
-require "velocify/add_leads_payload"
+require "velocify/payload"

data/lib/velocify/payload.rb

@@ -0,0 +1,77 @@
+require 'erb'
+
+module Velocify
+  class MessagePayload
+    def initialize msg
+      @msg = msg || {}
+    end
+    
+    def authenticate username:, password:
+      @msg.merge!({ username: username, password: password })
+    end
+
+    def render
+      { message: @msg }
+    end
+  end
+
+  class AddLeadsPayload
+    include ERB::Util
+    
+    # Creates a new request to add leads
+    #
+    # @param leads [Array<Lead>] A list of leads to be added
+    def initialize leads
+      @leads = leads
+      @credentials = {}
+    end
+
+    # Stores credentials for making an authenticated request
+    #
+    # @param username [String]
+    # @param password [String]
+    # @return [Hash]
+    def authenticate username:, password:
+      @credentials = Hash[:username, username, :password, password]
+    end
+
+    # @return [String] The XML payload to send to Velocify's AddLeads operation
+    def render
+      relative_path = File.join '..', '..', 'templates', 'add_leads.xml.erb'
+      current_dir = File.dirname(__FILE__)
+      path = File.expand_path relative_path, current_dir
+      template = File.read(path)
+      xml_str = ERB.new(template).result binding
+      { xml: xml_str.gsub(/[\n\t]*/, '').gsub(/[ ]{2,}/, '') }
+    end
+  end
+
+  class GetReportResultsPayload
+    include ERB::Util
+
+    def initialize report_id, filter_items
+      @filter_items = filter_items
+      @report_id = report_id
+      @credentials = {}
+    end
+
+    # Stores credentials for making an authenticated request
+    #
+    # @param username [String]
+    # @param password [String]
+    # @return [Hash]
+    def authenticate username:, password:
+      @credentials = Hash[:username, username, :password, password]
+    end
+
+    # @return [String] The XML payload to send to Velocify's GetReportResults operation
+    def render
+      relative_path = File.join '..', '..', 'templates', 'get_report_results.xml.erb'
+      current_dir = File.dirname(__FILE__)
+      path = File.expand_path relative_path, current_dir
+      template = File.read(path)
+      xml_str = ERB.new(template).result binding
+      { xml: xml_str.gsub(/[\n\t]*/, '').gsub(/[ ]{2,}/, '') }
+    end
+  end
+end

data/lib/velocify/report.rb

@@ -1,3 +1,5 @@
+require 'ostruct'
+
 module Velocify
   class Report
     include Model
@@ -20,17 +22,35 @@ module Velocify
         end
       end
 
-      def find_results report_id:, template_values: nil, destruct: false, return_array: false
+      # Retrieves report results with or without a filter
+      #
+      # @param report_id [Number] The id of the report
+      #
+      # @param template_values [Array<#field_title, #value>] (Optional) A list of filter items
+      #
+      # @example Including a filter item for retrieving report results with a last status change date filter
+      #   require 'ostruct'
+      #
+      #   item = OpenStruct.new field_title: 'Last Status Change Date', value: '4/12/2016 12:00:00'
+      #   Velocify::Report.find_results report_id: 123, template_values: [ item ]
+      #
+      # @note The template_values option must contain an array of filter items. Filter items are objects that must respond to #field_title and #value.
+      #
+      def find_results report_id:, template_values: [], destruct: false, return_array: false
         verify_credentials!
 
         request do
           destruct_response? destruct
           operation :get_report_results
           authenticate? true
-          message report_id: report_id
+          xml GetReportResultsPayload.new(report_id, template_values)
           transform do |resp|
             if return_array
-              arrayify resp[:report_results][:result]
+              if template_values.empty?
+                arrayify resp[:report_results][:result]
+              else
+                arrayify resp[:report_results]
+              end
             else
               resp
             end

data/lib/velocify/version.rb

@@ -1,3 +1,3 @@
 module Velocify
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/templates/get_report_results.xml.erb

@@ -0,0 +1,18 @@
+<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="https://service.leads360.com">
+    <env:Body>
+	<ser:GetReportResults>
+	    <ser:username><%= @credentials[:username] %></ser:username>
+	    <ser:password><%= @credentials[:password] %></ser:password>
+	    <ser:reportId><%= @report_id %></ser:reportId>
+            <% unless @filter_items.empty? %>
+	    <ser:templateValues>
+		<FilterItems>
+		    <% @filter_items.each do |item| %>
+                        <FilterItem FieldTitle="<%= item.field_title %>"><%= item.value %></FilterItem>
+		    <% end %>
+		</FilterItems>
+	    </ser:templateValues>
+            <% end %>
+	</ser:GetReportResults>
+    </env:Body>
+</env:Envelope>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: velocify
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Daniel Dyba
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-16 00:00:00.000000000 Z
+date: 2016-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -126,19 +126,19 @@ files:
 - bin/console
 - bin/setup
 - lib/velocify.rb
-- lib/velocify/add_leads_payload.rb
 - lib/velocify/agent.rb
 - lib/velocify/campaign.rb
 - lib/velocify/field.rb
 - lib/velocify/field_type.rb
 - lib/velocify/lead.rb
-- lib/velocify/message_payload.rb
 - lib/velocify/model.rb
+- lib/velocify/payload.rb
 - lib/velocify/report.rb
 - lib/velocify/response_reader.rb
 - lib/velocify/status.rb
 - lib/velocify/version.rb
 - templates/add_leads.xml.erb
+- templates/get_report_results.xml.erb
 - velocify.gemspec
 homepage: http://github.com/pennymac/velocify
 licenses:

data/lib/velocify/add_leads_payload.rb

@@ -1,34 +0,0 @@
-require 'erb'
-
-module Velocify
-  class AddLeadsPayload
-    include ERB::Util
-    
-    # Creates a new request to add leads
-    #
-    # @param leads [Array<Lead>] A list of leads to be added
-    def initialize leads
-      @leads = leads
-      @credentials = {}
-    end
-
-    # Stores credentials for making an authenticated request
-    #
-    # @param username [String]
-    # @param password [String]
-    # @return [Hash]
-    def authenticate username:, password:
-      @credentials = Hash[:username, username, :password, password]
-    end
-
-    # @return [String] The XML payload to send to Velocify's AddLeads operation
-    def render
-      relative_path = File.join '..', '..', 'templates', 'add_leads.xml.erb'
-      current_dir = File.dirname(__FILE__)
-      path = File.expand_path relative_path, current_dir
-      template = File.read(path)
-      xml_str = ERB.new(template).result binding
-      { xml: xml_str.gsub(/[\n\t]*/, '').gsub(/[ ]{2,}/, '') }
-    end
-  end
-end

data/lib/velocify/message_payload.rb

@@ -1,15 +0,0 @@
-module Velocify
-  class MessagePayload
-    def initialize msg
-      @msg = msg || {}
-    end
-    
-    def authenticate username:, password:
-      @msg.merge!({ username: username, password: password })
-    end
-
-    def render
-      { message: @msg }
-    end
-  end
-end