velocify 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb9807a174a61d5c269b5a6c8c82a70518b1c1fd
-  data.tar.gz: fd1f26749f639632e8e76140e23d72b6fbe79dd7
+  metadata.gz: 8d7d3962780f0757bf6fecac5b63a2eb439f5193
+  data.tar.gz: 404519cd5a282183841b133a47c013b6cd2cb3f3
 SHA512:
-  metadata.gz: f6c4334483720f3e7e929b0fdd997b9a533b3000b7997377d1fdbcce9194240aba724c6fad3217f34ccdd8fe64020901269babcdf37f9314354622a0c2870bd1
-  data.tar.gz: 504b3bc13bbc1bffdce8be6d45f940846e0cb00f129112272aeb9364a1a431a46e0bc1f23ea88cb0be70c767b49c7a7989041b6ca78bc52a736ac22030938de2
+  metadata.gz: 58e5fe96161f78a37d785fbda604aa756facd93334c7abd9c2f545472d23bdc3e2c5b3d986e6bf49816781370d0173cef2430acef66fc317b7539c930703de8d
+  data.tar.gz: 3b7eedb6aca41a7df0593728f4ad4bfe727727eb6fd4b844b504f9ade20939a401a3d2a0e7c4ac1a480c38ecde45b907cd01a943d54bb57609b656d6baaeb237

data/lib/velocify.rb

@@ -6,14 +6,15 @@ Dotenv.load
 require "velocify/version"
 require "velocify/model"
 require "velocify/campaign"
+require "velocify/agent"
 require "velocify/field"
 require "velocify/field_type"
 require "velocify/lead"
 require "velocify/status"
 
 require "velocify/response_reader"
-require "velocify/lead_list"
-
+require "velocify/message_payload"
+require "velocify/add_leads_payload"
 
 module Velocify
 end

data/lib/velocify/add_leads_payload.rb

@@ -0,0 +1,34 @@
+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/agent.rb

@@ -0,0 +1,24 @@
+module Velocify
+  class Agent
+    include Model
+
+    # Retrieve the entire list of agents
+    #
+    def self.find_all destruct: false, return_array: false
+      verify_credentials!
+
+      request do
+        destruct_response? destruct
+        operation :get_agents
+        authenticate? true
+        transform do |resp|
+          if return_array
+            arrayify resp[:agents][:agent]
+          else
+            resp
+          end
+        end
+      end
+    end
+  end
+end

data/lib/velocify/campaign.rb

@@ -6,9 +6,9 @@ module Velocify
       verify_credentials!
 
       request do
-        enable_destructuring destruct
+        destruct_response? destruct
         operation :get_campaigns
-        authenticate true
+        authenticate? true
         transform do |resp|
           if return_array
             arrayify resp[:campaigns][:campaign]

data/lib/velocify/field.rb

@@ -8,9 +8,9 @@ module Velocify
       verify_credentials!
       
       request do
-        enable_destructuring destruct
+        destruct_response? destruct
         operation :get_fields
-        authenticate true
+        authenticate? true
         transform do |resp|
           if return_array
             arrayify resp[:fields][:field]

data/lib/velocify/field_type.rb

@@ -7,9 +7,9 @@ module Velocify
       verify_credentials!
       
       request do
-        enable_destructuring destruct
+        destruct_response? destruct
         operation :get_field_types
-        authenticate true
+        authenticate? true
         transform do |resp|
           if return_array
             arrayify resp[:field_types][:field_type]

data/lib/velocify/lead.rb

@@ -30,9 +30,10 @@ module Velocify
         verify_credentials!
 
         request do
-          enable_destructuring destruct
-          operation :add_leads_response
-          message leads: leads
+          destruct_response? destruct
+          operation :add_leads
+          authenticate? true
+          xml AddLeadsPayload.new(leads)
           transform do |resp|
             if return_array
               arrayify resp[:leads][:lead]
@@ -53,10 +54,10 @@ module Velocify
         verify_credentials!
 
         request do
-          enable_destructuring destruct
+          destruct_response? destruct
           operation :get_leads
           message from: from, to: to
-          authenticate true
+          authenticate? true
           transform do |resp|
             if return_array
               arrayify resp[:leads][:lead]
@@ -76,9 +77,9 @@ module Velocify
         verify_credentials!
 
         request do
-          enable_destructuring destruct
+          destruct_response? destruct
           operation :get_leads_by_email
-          authenticate true
+          authenticate? true
           message email: email
           transform do |resp|
             if return_array
@@ -99,10 +100,10 @@ module Velocify
         verify_credentials!
 
         request do
-          enable_destructuring destruct
+          destruct_response? destruct
           operation :get_leads_by_phone
           message phone: phone.gsub(/[()\- ]/, '')
-          authenticate true
+          authenticate? true
           transform do |resp|
             if return_array
               arrayify resp[:leads][:lead]
@@ -122,9 +123,9 @@ module Velocify
         verify_credentials!
         
         request do
-          enable_destructuring destruct
+          destruct_response? destruct
           operation :get_lead
-          authenticate true
+          authenticate? true
           message lead_id: id
           transform do |resp|
             if return_array
@@ -140,9 +141,9 @@ module Velocify
         verify_credentials!
         
         request do
-          enable_destructuring destruct
+          destruct_response? destruct
           operation :get_last_created_lead
-          authenticate true
+          authenticate? true
           transform do |resp|
             if return_array
               arrayify resp[:leads][:lead]
@@ -157,9 +158,9 @@ module Velocify
         verify_credentials!
         
         request do
-          enable_destructuring destruct
+          destruct_response? destruct
           operation :get_last_modified_lead
-          authenticate true
+          authenticate? true
           transform do |resp|
             if return_array
               arrayify resp[:leads][:lead]
@@ -174,9 +175,9 @@ module Velocify
         verify_credentials!
 
         request do
-          enable_destructuring destruct
+          destruct_response? destruct
           operation :remove_lead
-          authenticate true
+          authenticate? true
           message lead_id: id
           transform do |resp|
             if return_array
@@ -202,9 +203,9 @@ module Velocify
         verify_credentials!
         
         request do
-          enable_destructuring destruct
+          destruct_response? destruct
           operation :modify_lead_status
-          authenticate true
+          authenticate? true
           message lead_id: lead_id, status_id: status_id
           transform do |resp|
             if return_array
@@ -227,9 +228,9 @@ module Velocify
         verify_credentials!
       
         request do
-          enable_destructuring destruct
+          destruct_response? destruct
           operation :modify_lead_field
-          authenticate true
+          authenticate? true
           message field_id: field_id, lead_id: lead_id, new_value: new_value
           transform do |resp|
             if return_array

data/lib/velocify/message_payload.rb

@@ -0,0 +1,15 @@
+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

data/lib/velocify/model.rb

@@ -3,42 +3,32 @@ module Velocify
     class Client
       WSDL = 'http://service.leads360.com/ClientService.asmx?WSDL'
 
-      attr :spec, :client, :credentials
+      attr :request, :soap_client, :username, :password
       
-      def initialize spec, credentials: nil
-        @spec = spec
-        @credentials = credentials
-        @client = Savon.client wsdl: WSDL
+      def initialize request, username: nil, password: nil
+        @request = request
+        @username = username
+        @password = password
+        @soap_client = Savon.client wsdl: WSDL
       end
 
       def call
-        payload = {}
-
-        if spec.has_message?
-          payload = spec.__message
-        end
-        
-        if spec.requires_auth?
-          payload.merge! credentials
+        if request.requires_auth?
+          request.authenticate username: @username, password: @password
         end
 
-        raw_response = client.call(spec.__operation, { message: payload }).body
-        response_tag = "#{spec.__operation.to_s}_response".to_sym
-        result_tag = "#{spec.__operation.to_s}_result".to_sym
+        raw_response = soap_client.call(request.operation, request.payload).body
+        response_tag = "#{request.operation.to_s}_response".to_sym
+        result_tag = "#{request.operation.to_s}_result".to_sym
         response = raw_response[response_tag][result_tag]
-
-        if spec.has_transform?
-          spec.__transform.call response
-        else
-          response
-        end
+        request.transform.call response
       end
 
       private
 
-      def client; @client; end
-      
-      def credentials; @credentials; end
+      def soap_client; @soap_client ; end
+      def credentials; @credentials ; end
+      def request    ; @request     ; end
     end
 
     module RequestHelpers
@@ -51,72 +41,80 @@ module Velocify
       end
     end
     
-    class RequestSpecification
-      include RequestHelpers
-      
-      attr :destruct, :operation, :transform, :message, :credentials, :authenticate
+    class Request
+      attr_writer :payload, :requires_auth, :destruct_response
+      attr_accessor :transform
+      attr_accessor :operation
       
       def initialize
-        @destruct = false
+        @destruct_response = false
+        @requires_auth = false
       end
 
-      def enable_destructuring is_on
-        @destruct = is_on
+      def authenticate username:, password:
+        @payload.authenticate username: username, password: password
       end
 
-      def destruct?
-        @destruct
+      def transform= transform
+        @transform = transform
       end
-      
-      def authenticate is_on
-        @authenticate = is_on
-      end
-      
-      def message *msg
-        @message = Hash[ *msg ]
+
+      def payload
+        @payload.render
       end
+
+      def destruct_response? ; @destruct_response ; end
+      def requires_auth?     ; @requires_auth     ; end
+    end
+    
+    class RequestBuilder
+      include RequestHelpers
       
-      def operation op
-        @operation = op.to_sym
+      def initialize
+        @destruct = false
       end
 
-      def transform &block
-        @transform = block
+      def destruct_response? is_on
+        @destruct = is_on
       end
 
-      def has_message?
-        !@message.nil?
+      def authenticate? is_on
+        @authenticate = is_on
       end
 
-      def requires_auth?
-        !@authenticate.nil?
+      def transform &block
+        @transform = block
       end
 
-      def has_transform?
-        !@transform.nil?
+      def operation op
+        @operation = op.to_sym
       end
 
-      def __message
-        @message
+      def xml xml
+        @xml = xml
       end
 
-      def __operation
-        @operation
+      def message msg
+        @message = msg
       end
 
-      def __transform
-        @transform
+      def build
+        Request.new.tap do |req|
+          req.payload = @xml || MessagePayload.new(@message)
+          req.requires_auth = @authenticate
+          req.transform = @transform || -> (resp) { resp }
+          req.operation = @operation
+          req.destruct_response = @destruct          
+        end
       end
     end
-    
+        
     module ModelHelpers
-      attr :credentials
+      attr :username, :password
 
       def authenticate!
-        @credentials = {
-          username: ENV['VELOCIFY_USERNAME'],
-          password: ENV['VELOCIFY_PASSWORD']
-        }
+        @username = ENV['VELOCIFY_USERNAME']
+        @password = ENV['VELOCIFY_PASSWORD']
         valid_credentials?
       end
 
@@ -127,40 +125,37 @@ module Velocify
       private
       
       def verify_credentials!
-        if @credentials.nil?
+        if @username.nil? || @password.nil?
           raise Velocify::AuthenticationException, "You must export your credentials to the environment"
         end
       end
 
-      def authenticated_message msg
-        @credentials.merge(msg) unless @credentials.nil?
-      end
-
       def valid_credentials?
-        return false if @credentials.nil?
-        !@credentials[:username].empty? && !@credentials[:password].empty?
+        return false if @username.nil? || @password.nil?
+        !@username.empty? && !@password.empty?
       end
 
       def request destruct: false, &block
         begin
-          spec = RequestSpecification.new
-          spec.instance_eval(&block)
-          client = Client.new spec, credentials: @credentials
+          request_builder = RequestBuilder.new
+          request_builder.instance_eval(&block)
+          request = request_builder.build
+          client = Client.new request, username: @username, password: @password
 
-          if destruct || spec.destruct?
+          if destruct || request.destruct_response?
             result = client.call
             [true, result]
           else
             client.call
           end
         rescue Savon::SOAPFault => ex
-          if destruct || spec.destruct?
+          if destruct || request.destruct_response?
             [false, { message: ex.message }]
           else
             { message: ex.message }
           end
         rescue Net::ReadTimeout => ex
-          if destruct || spec.destruct?
+          if destruct || request.destruct_response?
             [false, { message: ex.message }]
           else
             { message: ex.message }

data/lib/velocify/response_reader.rb

@@ -12,8 +12,13 @@ module Velocify
       def read kind:, response:
         singular_key = kind.to_s
         plural_key = singular_key.pluralize
-        fields = response[plural_key.to_sym][singular_key.to_sym]
-        ResponseReader.new kind: kind, hash: fields
+        fields = response
+        
+        if response.instance_of? Hash
+          fields = response[plural_key.to_sym][singular_key.to_sym]
+        end
+          
+        ResponseReader.new kind: kind, elements: fields
       end
     end
 
@@ -23,40 +28,45 @@ module Velocify
     # @return [String] the id of the `kind` that matches the title you searched for
     #
     def find_id_by_title title
-      key = @hash.select { |f|
-        f["@#{kind}_title".to_sym] == title
-      }.pop
+      element = select_one_by_title title
+      element["@#{kind}_id".to_sym] if element
+    end
 
-      key["@#{kind}_id".to_sym] if key
+    def find_value_by_title title
+      element = select_one_by_title title
+      element["@value".to_sym] if element
     end
 
     def search_by_title title
-      key = @hash.select { |k|
-        k["@#{kind}_title".to_sym] =~ /#{title}/
+      element = @elements.select { |el|
+        el["@#{kind}_title".to_sym] =~ /#{title}/
       }
 
-      key if key
+      element if element
     end
 
     def find_by_title title
-      key = @hash.select { |k|
-        k["@#{kind}_title".to_sym] == title
-      }.pop
-
-      key if key
+      element = select_one_by_title title
+      element if element
     end
 
     # @return [String] a list of all the titles
     def all_titles
-      @hash.map { |k| k["@#{kind}_title".to_sym] }
+      @elements.map { |el| el["@#{kind}_title".to_sym] }
     end
 
     private
 
     attr :kind, :hash
     
-    def initialize kind:, hash:
-      @kind, @hash = kind.to_s, hash
+    def initialize kind:, elements:
+      @kind, @elements = kind.to_s, elements
+    end
+
+    def select_one_by_title title
+      @elements.select { |el|
+        el["@#{kind}_title".to_sym] == title
+      }.pop
     end
   end
 end

data/lib/velocify/status.rb

@@ -6,9 +6,9 @@ module Velocify
       verify_credentials!
 
       request do
-        enable_destructuring destruct
+        destruct_response? destruct
         operation :get_statuses
-        authenticate true
+        authenticate? true
         transform do |resp|
           if return_array
             arrayify resp[:statuses][:status]

data/lib/velocify/version.rb

@@ -1,3 +1,3 @@
 module Velocify
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/templates/add_leads.xml.erb

@@ -1,22 +1,32 @@
-<Leads>
-    <% @leads.each do |lead| %>
-	<Lead>
-	    <% if lead.status_id? %>
-		<Status StatusId="<%= lead.status_id %>"></Status>
-	    <% end %>
-	    <% if lead.campaign_id? %>
-		<Campaign CampaignId="<%= lead.campaign_id %>"></Campaign>
-	    <% end %>
-	    <% if lead.agent_id? %>
-		<Agent AgentId="<%= lead.agent_id %>"></Agent>
-	    <% end %>
-	    <% unless lead.fields.empty? %>
-		<Fields>
-		    <% lead.fields.each do |field| %>
-			<Field FieldId="<%= field[:id] %>" Value="<%= field[:value] %>"></Field>
+<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="https://service.leads360.com">
+    <env:Body>
+	<ser:AddLeads>
+	    <ser:username><%= @credentials[:username] %></ser:username>
+	    <ser:password><%= @credentials[:password] %></ser:password>
+	    <ser:leads>
+		<Leads>
+		    <% @leads.each do |lead| %>
+			<Lead>
+			    <% if lead.status_id? %>
+				<Status StatusId="<%= lead.status_id %>"></Status>
+			    <% end %>
+			    <% if lead.campaign_id? %>
+				<Campaign CampaignId="<%= lead.campaign_id %>"></Campaign>
+			    <% end %>
+			    <% if lead.agent_id? %>
+				<Agent AgentId="<%= lead.agent_id %>"></Agent>
+			    <% end %>
+			    <% unless lead.fields.empty? %>
+				<Fields>
+				    <% lead.fields.each do |field| %>
+					<Field FieldId="<%= field[:id] %>" Value="<%= field[:value] %>"></Field>
+				    <% end %>
+				</Fields>
+			    <% end %>
+			</Lead>
 		    <% end %>
-		</Fields>
-	    <% end %>
-	</Lead>
-    <% end %>
-</Leads>
+		</Leads>
+	    </ser:leads>
+	</ser:AddLeads>
+    </env:Body>
+</env:Envelope>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: velocify
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Daniel Dyba
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-24 00:00:00.000000000 Z
+date: 2015-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -126,11 +126,13 @@ 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/lead_list.rb
+- lib/velocify/message_payload.rb
 - lib/velocify/model.rb
 - lib/velocify/response_reader.rb
 - lib/velocify/status.rb

data/lib/velocify/lead_list.rb

@@ -1,25 +0,0 @@
-require 'erb'
-
-module Velocify
-  class LeadList
-    include ERB::Util
-    
-    attr :leads
-
-    def initialize
-      @leads = []
-    end
-
-    def add_lead lead
-      @leads << lead
-    end
-
-    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)
-      ERB.new(template).result binding
-    end
-  end
-end