velocify 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3f8637807ba83f0fffa648a0672a075b4414a75
-  data.tar.gz: 5ac014642b7032104cbd11d633f1ecc3fdf4397c
+  metadata.gz: cb9807a174a61d5c269b5a6c8c82a70518b1c1fd
+  data.tar.gz: fd1f26749f639632e8e76140e23d72b6fbe79dd7
 SHA512:
-  metadata.gz: 7fd417d8fec9ec1ced275d3348cc09ebc07d52891fcab22475573edf0e16165f8e0cbecf8983c9240f2efb1b8f97177076ee268617a5c2db26b96a3c77fb83fa
-  data.tar.gz: 51df44628159511a6130665b2c520a20cc56ca16363726a2825451ec9e93c83dffcce1f58c5c91a9e751289df27f25a023feaf3118ee2a8b33a5ebfc49f47eb0
+  metadata.gz: f6c4334483720f3e7e929b0fdd997b9a533b3000b7997377d1fdbcce9194240aba724c6fad3217f34ccdd8fe64020901269babcdf37f9314354622a0c2870bd1
+  data.tar.gz: 504b3bc13bbc1bffdce8be6d45f940846e0cb00f129112272aeb9364a1a431a46e0bc1f23ea88cb0be70c767b49c7a7989041b6ca78bc52a736ac22030938de2

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changes in 0.1.3
+
+* All model classes now support the optional keyword argument ```return_array:``` if you want to receive
+  a response that wraps the results in an array:
+
+``` ruby
+leads = Velocify::Lead.find_by_email 'hi@example.org', return_array: true
+# Every element in the array would contain a lead
+# => [{ ... }, ... ]
+```
+
+## Breaking Changes
+
+* ```Velocify::Lead.find_all``` by default returns a response like so ```{leads=>{lead=> ... }```
+  instead of ```{get_leads_response=>{get_leads_result=>{leads=>lead=> ... }```.
+

data/README.md

@@ -21,14 +21,60 @@ Or install it yourself as:
 ## Usage
 
 Before getting started, you must export two environment variables: ```VELOCIFY_USERNAME``` and ```VELOCIFY_PASSWORD```.
+This gem uses Dotenv, so you can add these variables to your ```.env``` file in the root folder of your project.
 
 ``` ruby
 require 'velocify'
 
 statuses = Velocify::Status.find_all
-dormant_id = Velocify::ResponseReader.read(kind: :status, statuses).find_id_by_title 'Dormant'
+# => {statuses=>status=>[{...}, ...]}
+
+dormant_id = Velocify::ResponseReader.read(kind: :status, response: statuses).find_id_by_title 'Dormant'
+# => 31
+
+statuses_with_name = Velocify::ResponseReader.read(kind: :status, response: statuses).search_by_title 'Name'
+# => [{...}, ...]
+
+leads = Velocify::Lead.find_last_created
+# => {leads=>lead=>{...}}
+
+# There's also support for destructuring
+
+success, leads = Velocify::Lead.find_all from: '2000-01-01T00:00:00', to: '2000-02-01T00:00:00', destruct: true
+# => [true, {leads=>lead=>[{...}]}]
+success
+# => true
+payload
+# => {leads=>lead=>[{ ... }]}
+
+# You can even have your results returned as an array
+
+success, leads = Velocify::Lead.find_all from: '2000-01-01T00:00:00', to: '2000-02-01T00:00:00', destruct: true, return_array: true
+# => [true, [{...}, ... }]
+
+# Pushing leads to Velocify
+campaign_id = Velocify::ResponseReader.read(kind: :campaign, response: Velocify::Campaign.find_all).find_id_by_title 'Test Campaign'
+status_id = Velocify::ResponseReader.read(kind: :status, response: Velocify::Status.find_all).find_id_by_title 'Active'
+last_name_id = Velocify::ResponseReader.read(kind: :field, response: Velocify::Field.find_all).find_id_by_title 'Last Name'
+first_name_id = Velocify::ResponseReader.read(kind: :field, response: Velocify::Field.find_all).find_id_by_title 'First Name'
+
+lead = Lead.new
+lead.campaign_id = campaign_id
+lead.status_id = status_id
+lead.add_field id: first_name_id, value: "Joe"
+lead.add_field id: last_name_id, value: "Bo"
+
+list = Velocify::LeadList.new
+list.add_lead lead
+xml_payload = list.render # Renders xml output
+
+Velocify::Lead.add leads: xml_payload
 ```
 
+## Changes
+
+For a list of changes in each release, read the CHANGELOG.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/velocify/campaign.rb

@@ -2,14 +2,20 @@ module Velocify
   class Campaign
     include Model
 
-    operations :get_campaigns
-
-    def self.find_all destruct: false
+    def self.find_all destruct: false, return_array: false
       verify_credentials!
 
-      request(destruct: destruct) do
-        response = get_campaigns(message: @credentials)
-        response.body[:get_campaigns_response][:get_campaigns_result]
+      request do
+        enable_destructuring destruct
+        operation :get_campaigns
+        authenticate true
+        transform do |resp|
+          if return_array
+            arrayify resp[:campaigns][:campaign]
+          else
+            resp
+          end
+        end
       end
     end
   end

data/lib/velocify/field.rb

@@ -2,16 +2,22 @@ module Velocify
   class Field
     include Model
 
-    operations :get_fields
-
     # @return [Hash] a list of fields
     #
-    def self.find_all destruct: false
+    def self.find_all destruct: false, return_array: false
       verify_credentials!
       
-      request(destruct: destruct) do
-        response = get_fields(message: @credentials)
-        response.body[:get_fields_response][:get_fields_result]
+      request do
+        enable_destructuring destruct
+        operation :get_fields
+        authenticate true
+        transform do |resp|
+          if return_array
+            arrayify resp[:fields][:field]
+          else
+            resp
+          end
+        end
       end
     end
   end

data/lib/velocify/field_type.rb

@@ -2,15 +2,21 @@ module Velocify
   class FieldType
     include Model
 
-    operations :get_field_types
-    
     # @return [Hash] a list of fields
-    def self.find_all destruct: false
+    def self.find_all destruct: false, return_array: false
       verify_credentials!
       
-      request(destruct: destruct) do
-        response = get_field_types(message: authenticated_message({}))
-        response.body[:get_field_types_response][:get_field_types_result]
+      request do
+        enable_destructuring destruct
+        operation :get_field_types
+        authenticate true
+        transform do |resp|
+          if return_array
+            arrayify resp[:field_types][:field_type]
+          else
+            resp
+          end
+        end
       end
     end
   end

data/lib/velocify/lead.rb

@@ -2,16 +2,6 @@ module Velocify
   class Lead
     include Model
 
-    operations :get_lead,
-      :get_leads,
-      :get_last_created_lead,
-      :get_leads_by_email,
-      :get_last_modified_lead,
-      :get_leads_by_phone,
-      :modify_lead_field,
-      :modify_lead_status,
-      :add_leads
-
     attr :fields
     attr_accessor :campaign_id, :agent_id, :status_id
 
@@ -36,12 +26,20 @@ module Velocify
       # @param leads [String] The string representation of the XML document
       #                       containing the new leads
       #
-      def add leads:, destruct: false
+      def add leads:, destruct: false, return_array: false
         verify_credentials!
 
-        request(destruct: destruct) do
-          response = add_leads(message: authenticated_message({ leads: leads }))
-          response.body[:add_leads_response][:add_leads_result]
+        request do
+          enable_destructuring destruct
+          operation :add_leads_response
+          message leads: leads
+          transform do |resp|
+            if return_array
+              arrayify resp[:leads][:lead]
+            else
+              resp
+            end
+          end
         end
       end
       
@@ -51,14 +49,21 @@ module Velocify
       # @param to [String] The end date
       # @return [Hash] The leads between the `from:` and `to:` dates
       #
-      def find_all from:, to:, destruct: false
+      def find_all from:, to:, destruct: false, return_array: false
         verify_credentials!
 
-        m = { from: from, to: to }
-
-        request(destruct: destruct) do
-          response = get_leads(message: authenticated_message(m))
-          response.body
+        request do
+          enable_destructuring destruct
+          operation :get_leads
+          message from: from, to: to
+          authenticate true
+          transform do |resp|
+            if return_array
+              arrayify resp[:leads][:lead]
+            else
+              resp
+            end
+          end
         end
       end
 
@@ -67,12 +72,21 @@ module Velocify
       # @param email [String] The email address used to search for a lead
       # @return [Hash] The leads having the matching email address
       #
-      def find_by_email email, destruct: false
+      def find_by_email email, destruct: false, return_array: false
         verify_credentials!
 
-        request(destruct: destruct) do
-          response = get_leads_by_email(message: authenticated_message({ email: email }))
-          response.body[:get_leads_by_email_response][:get_leads_by_email_result]
+        request do
+          enable_destructuring destruct
+          operation :get_leads_by_email
+          authenticate true
+          message email: email
+          transform do |resp|
+            if return_array
+              arrayify resp[:leads][:lead]
+            else
+              resp
+            end
+          end
         end
       end
 
@@ -81,12 +95,21 @@ module Velocify
       # @param phone [String] The phone number used to search for a lead
       # @return [Hash] The leads having the matching phone number
       #
-      def find_by_phone phone, destruct: false
+      def find_by_phone phone, destruct: false, return_array: false
         verify_credentials!
-        
-        request(destruct: destruct) do
-          response = get_leads_by_phone(message: authenticated_message({ phone: phone.gsub(/[()\- ]/, '') }))
-          response.body[:get_leads_by_phone_response][:get_leads_by_phone_result]
+
+        request do
+          enable_destructuring destruct
+          operation :get_leads_by_phone
+          message phone: phone.gsub(/[()\- ]/, '')
+          authenticate true
+          transform do |resp|
+            if return_array
+              arrayify resp[:leads][:lead]
+            else
+              resp
+            end
+          end
         end
       end
 
@@ -95,30 +118,73 @@ module Velocify
       # @param id [String] the id of the lead
       # @return [Hash] The lead with the matching id
       #
-      def find_by_id id, destruct: false
+      def find_by_id id, destruct: false, return_array: false
         verify_credentials!
         
-        request(destruct: destruct) do
-          response = get_lead(message: authenticated_message({ lead_id: id }))
-          response.body[:get_lead_response][:get_lead_result]
+        request do
+          enable_destructuring destruct
+          operation :get_lead
+          authenticate true
+          message lead_id: id
+          transform do |resp|
+            if return_array
+              arrayify resp[:leads][:lead]
+            else
+              resp
+            end
+          end
         end
       end
       
-      def find_last_created destruct: false
+      def find_last_created destruct: false, return_array: false
         verify_credentials!
         
-        request(destruct: destruct) do
-          response = get_last_created_lead(message: authenticated_message({}))
-          response.body[:get_last_created_lead_response][:get_last_created_lead_result]
+        request do
+          enable_destructuring destruct
+          operation :get_last_created_lead
+          authenticate true
+          transform do |resp|
+            if return_array
+              arrayify resp[:leads][:lead]
+            else
+              resp
+            end
+          end
         end
       end
 
-      def find_last_modified destruct: false
+      def find_last_modified destruct: false, return_array: false
         verify_credentials!
         
-        request(destruct: destruct) do
-          response = get_last_modified_lead(message: authenticated_message({}))
-          response.body[:get_last_modified_lead_response][:get_last_modified_lead_result]
+        request do
+          enable_destructuring destruct
+          operation :get_last_modified_lead
+          authenticate true
+          transform do |resp|
+            if return_array
+              arrayify resp[:leads][:lead]
+            else
+              resp
+            end
+          end
+        end
+      end
+
+      def remove id:, destruct: false, return_array: false
+        verify_credentials!
+
+        request do
+          enable_destructuring destruct
+          operation :remove_lead
+          authenticate true
+          message lead_id: id
+          transform do |resp|
+            if return_array
+              arrayify resp[:response][:removals] # also [:lead] ?
+            else
+              resp
+            end
+          end
         end
       end
 
@@ -132,15 +198,21 @@ module Velocify
       # @param status_id [String] The id of the status
       # @return [Hash] The response containing the updated lead
       #
-      def update_status lead_id:, status_id:, destruct: false
+      def update_status lead_id:, status_id:, destruct: false, return_array: false
         verify_credentials!
         
-        request(destruct: destruct) do
-          response = modify_lead_status(message: authenticated_message({
-            lead_id: lead_id,
-            status_id: status_id
-          }))
-          response.body[:modify_lead_status_response][:modify_lead_status_result]
+        request do
+          enable_destructuring destruct
+          operation :modify_lead_status
+          authenticate true
+          message lead_id: lead_id, status_id: status_id
+          transform do |resp|
+            if return_array
+              arrayify resp[:leads][:lead]
+            else
+              resp
+            end
+          end
         end
       end
 
@@ -151,18 +223,26 @@ module Velocify
       # @param new_value [String] The new value of the field
       # @return [Hash] The response containing the updated lead
       #
-      def update_field lead_id:, field_id:, new_value:, destruct: false
+      def update_field lead_id:, field_id:, new_value:, destruct: false, return_array: false
         verify_credentials!
-        
-        request(destruct: destruct) do
-          response = modify_lead_field(message: authenticated_message({
-            field_id: field_id,
-            lead_id: lead_id,
-            new_value: new_value
-          }))
-          response.body[:modify_lead_field_response][:modify_lead_field_result]
+      
+        request do
+          enable_destructuring destruct
+          operation :modify_lead_field
+          authenticate true
+          message field_id: field_id, lead_id: lead_id, new_value: new_value
+          transform do |resp|
+            if return_array
+              arrayify resp[:leads][:lead]
+            else
+              resp
+            end
+          end
         end
       end
+
+      alias_method :last_created, :find_last_created
+      alias_method :last_modified, :find_last_modified
     end
   end
 end

data/lib/velocify/model.rb

@@ -1,65 +1,176 @@
 module Velocify
-  module ModelHelpers
-    attr :credentials
-
-    def authenticate!
-      @credentials = {
-        username: ENV['VELOCIFY_USERNAME'],
-        password: ENV['VELOCIFY_PASSWORD']
-      }
-      valid_credentials?
-    end
+  module Model
+    class Client
+      WSDL = 'http://service.leads360.com/ClientService.asmx?WSDL'
 
-    def authenticated?
-      valid_credentials?
-    end
+      attr :spec, :client, :credentials
+      
+      def initialize spec, credentials: nil
+        @spec = spec
+        @credentials = credentials
+        @client = Savon.client wsdl: WSDL
+      end
+
+      def call
+        payload = {}
+
+        if spec.has_message?
+          payload = spec.__message
+        end
+        
+        if spec.requires_auth?
+          payload.merge! credentials
+        end
 
-    private
+        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
+        response = raw_response[response_tag][result_tag]
 
-    def verify_credentials!
-      if @credentials.nil?
-        raise Velocify::AuthenticationException, "You must export your credentials to the environment"
+        if spec.has_transform?
+          spec.__transform.call response
+        else
+          response
+        end
       end
+
+      private
+
+      def client; @client; end
+      
+      def credentials; @credentials; end
     end
 
-    def authenticated_message msg
-      @credentials.merge(msg) unless @credentials.nil?
+    module RequestHelpers
+      def arrayify data
+        if data.instance_of? Array
+          data
+        else
+          [data]
+        end
+      end
     end
+    
+    class RequestSpecification
+      include RequestHelpers
+      
+      attr :destruct, :operation, :transform, :message, :credentials, :authenticate
+      
+      def initialize
+        @destruct = false
+      end
+
+      def enable_destructuring is_on
+        @destruct = is_on
+      end
+
+      def destruct?
+        @destruct
+      end
+      
+      def authenticate is_on
+        @authenticate = is_on
+      end
+      
+      def message *msg
+        @message = Hash[ *msg ]
+      end
+      
+      def operation op
+        @operation = op.to_sym
+      end
+
+      def transform &block
+        @transform = block
+      end
 
-    def valid_credentials?
-      return false if @credentials.nil?
-      !@credentials[:username].empty? && !@credentials[:password].empty?
+      def has_message?
+        !@message.nil?
+      end
+
+      def requires_auth?
+        !@authenticate.nil?
+      end
+
+      def has_transform?
+        !@transform.nil?
+      end
+
+      def __message
+        @message
+      end
+
+      def __operation
+        @operation
+      end
+
+      def __transform
+        @transform
+      end
     end
     
-    def request destruct: false, &block
-      begin
-        if destruct
-          result = yield block
-          [true, result]
-        else
-          yield block
-        end
-      rescue Savon::SOAPFault => ex
-        if destruct
-          [false, { message: ex.message }]
-        else
-          { message: ex.message }
+    module ModelHelpers
+      attr :credentials
+
+      def authenticate!
+        @credentials = {
+          username: ENV['VELOCIFY_USERNAME'],
+          password: ENV['VELOCIFY_PASSWORD']
+        }
+        valid_credentials?
+      end
+
+      def authenticated?
+        valid_credentials?
+      end
+
+      private
+      
+      def verify_credentials!
+        if @credentials.nil?
+          raise Velocify::AuthenticationException, "You must export your credentials to the environment"
         end
-      rescue Net::ReadTimeout => ex
-        if destruct
-          [false, { message: ex.message }]
-        else
-          { message: ex.message }
+      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?
+      end
+
+      def request destruct: false, &block
+        begin
+          spec = RequestSpecification.new
+          spec.instance_eval(&block)
+          client = Client.new spec, credentials: @credentials
+
+          if destruct || spec.destruct?
+            result = client.call
+            [true, result]
+          else
+            client.call
+          end
+        rescue Savon::SOAPFault => ex
+          if destruct || spec.destruct?
+            [false, { message: ex.message }]
+          else
+            { message: ex.message }
+          end
+        rescue Net::ReadTimeout => ex
+          if destruct || spec.destruct?
+            [false, { message: ex.message }]
+          else
+            { message: ex.message }
+          end
         end
       end
     end
-  end
-
-  module Model
+    
     def self.included mod
-      mod.extend Savon::Model
-      mod.client wsdl: 'http://service.leads360.com/ClientService.asmx?WSDL'
-      mod.extend Velocify::ModelHelpers
+      mod.extend ModelHelpers
       mod.authenticate!
     end
   end

data/lib/velocify/status.rb

@@ -2,14 +2,20 @@ module Velocify
   class Status
     include Model
 
-    operations :get_statuses
-
-    def self.find_all destruct: false
+    def self.find_all destruct: false, return_array: false
       verify_credentials!
 
-      request(destruct: destruct) do
-        response = get_statuses(message: authenticated_message({}))
-        response.body[:get_statuses_response][:get_statuses_result]
+      request do
+        enable_destructuring destruct
+        operation :get_statuses
+        authenticate true
+        transform do |resp|
+          if return_array
+            arrayify resp[:statuses][:status]
+          else
+            resp
+          end
+        end
       end
     end
   end

data/lib/velocify/version.rb

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

data/templates/add_leads.xml.erb

@@ -1,20 +1,19 @@
-<!-- sample XML payload for AddLeads webmethod -->
 <Leads>
     <% @leads.each do |lead| %>
 	<Lead>
 	    <% if lead.status_id? %>
-		<Status StatusId="<%= lead.status_id %>"/>
-	    <% end %>
-	    <% if lead.agent_id? %>
-		<Agent AgentId="<%= lead.agent_id %>"/>
+		<Status StatusId="<%= lead.status_id %>"></Status>
 	    <% end %>
 	    <% if lead.campaign_id? %>
-		<Campaign CampaignId="<%= 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 FieldId="<%= field[:id] %>" Value="<%= field[:value] %>"></Field>
 		    <% end %>
 		</Fields>
 	    <% end %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: velocify
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Daniel Dyba
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-17 00:00:00.000000000 Z
+date: 2015-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -117,6 +117,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt