velocify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 97f15fb45f36d32865f86c664f2fd251ce441619
+  data.tar.gz: d564c72f7a58df8870a73be0adf13e079905cf60
+SHA512:
+  metadata.gz: db057c074748a81574b5323dda98b6cef55ac129affde7a2ba0a1cf5224db72134b788799484a597deb8270100b22781b11fa0d7b43c540b778675c6a36dac70
+  data.tar.gz: 9223d5c1869477f446a1b8c23ee4fa4aa331736d57141e896eef0942637973855271cbb64123e3d3f16dbaf564b50a111b7b3f24e51eca99747108acd32844f6

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*~
+.env

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Daniel Dyba
+
+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,44 @@
+# Velocify
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/velocify`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'velocify'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install velocify
+
+## Usage
+
+Before getting started, you must export two environment variables: ```VELOCIFY_USERNAME``` and ```VELOCIFY_PASSWORD```.
+
+``` ruby
+require 'velocify'
+
+statuses = Velocify::Status.find_all
+dormant_id = Velocify::ResponseReader.read(kind: :status, statuses).find_id_by_title 'Dormant'
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pennymac/velocify. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/velocify.rb

@@ -0,0 +1,19 @@
+require "savon"
+require "dotenv"
+
+Dotenv.load
+
+require "velocify/version"
+require "velocify/model"
+require "velocify/campaign"
+require "velocify/field"
+require "velocify/field_type"
+require "velocify/lead"
+require "velocify/status"
+
+require "velocify/response_reader"
+require "velocify/lead_list"
+
+
+module Velocify
+end

data/lib/velocify/campaign.rb

@@ -0,0 +1,16 @@
+module Velocify
+  class Campaign
+    include Model
+
+    operations :get_campaigns
+
+    def self.find_all
+      verify_credentials!
+
+      request do
+        response = get_campaigns(message: @credentials)
+        response.body[:get_campaigns_response][:get_campaigns_result]
+      end
+    end
+  end
+end

data/lib/velocify/field.rb

@@ -0,0 +1,18 @@
+module Velocify
+  class Field
+    include Model
+
+    operations :get_fields
+
+    # @return [Hash] a list of fields
+    #
+    def self.find_all
+      verify_credentials!
+      
+      request do
+        response = get_fields(message: @credentials)
+        response.body[:get_fields_response][:get_fields_result]
+      end
+    end
+  end
+end

data/lib/velocify/field_type.rb

@@ -0,0 +1,17 @@
+module Velocify  
+  class FieldType
+    include Model
+
+    operations :get_field_types
+    
+    # @return [Hash] a list of fields
+    def self.find_all
+      verify_credentials!
+      
+      request do
+        response = get_field_types(message: authenticated_message({}))
+        response.body[:get_field_types_response][:get_field_types_result]
+      end
+    end
+  end
+end

data/lib/velocify/lead.rb

@@ -0,0 +1,153 @@
+module Velocify
+  class Lead
+    include Model
+
+    operations :get_lead,
+      :get_leads,
+      :get_last_created_lead,
+      :get_leads_by_email,
+      :get_last_modified_lead,
+      :modify_lead_field,
+      :modify_lead_status,
+      :add_leads
+
+    attr :fields
+    attr_accessor :campaign_id, :agent_id, :status_id
+
+    def initialize body: {}
+      @body = body
+    end
+
+    def add_field id:, value:
+      @fields = [] if @fields.nil?
+      @fields << { id: id, value: value }
+    end
+
+    def campaign_id?; !@campaign_id.nil?; end
+
+    def agent_id?; !@agent_id.nil?; end
+
+    def status_id?; !@status_id.nil?; end
+
+    class << self
+      # Adds a lead or leads
+      #
+      # @param leads [String] The string representation of the XML document
+      #                       containing the new leads
+      #
+      def add leads:
+        verify_credentials!
+
+        request do
+          response = add_leads(message: authenticated_message({ leads: leads }))
+          response.body[:add_leads_response][:add_leads_result]
+        end
+      end
+      
+      # Retrieves all leads
+      #
+      # @param from [String] The start date
+      # @param to [String] The end date
+      # @return [Hash] The leads between the `from:` and `to:` dates
+      #
+      def find_all from:, to:
+        verify_credentials!
+
+        m = { from: from, to: to }
+
+        request do
+          response = get_leads(message: authenticated_message(m))
+          response.body
+        end
+      end
+
+      # Retrieves a lead using an email address
+      #
+      # @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
+        verify_credentials!
+
+        request do
+          response = get_leads_by_email(message: authenticated_message({ email: email }))
+          response.body[:get_leads_by_email_response][:get_leads_by_email_result]
+        end
+      end
+
+      # Retrieves a lead by an id
+      #
+      # @param id [String] the id of the lead
+      # @return [Hash] The lead with the matching id
+      #
+      def find_by_id id
+        verify_credentials!
+        
+        request do
+          response = get_lead(message: authenticated_message({ lead_id: id }))
+          response.body[:get_lead_response][:get_lead_result]
+        end
+      end
+      
+      def find_last_created
+        verify_credentials!
+        
+        request do
+          response = get_last_created_lead(message: authenticated_message({}))
+          response.body[:get_last_created_lead_response][:get_last_created_lead_result]
+        end
+      end
+
+      def find_last_modified
+        verify_credentials!
+        
+        request do
+          response = get_last_modified_lead(message: authenticated_message({}))
+          response.body[:get_last_modified_lead_response][:get_last_modified_lead_result]
+        end
+      end
+
+      # Updates the status of a lead.
+      #
+      # Use the `Velocify::Status.find_all` method to retrieve the id of the status
+      #
+      # @see Velocify::Status.find_all
+      #
+      # @param lead_id [String] The id of the lead
+      # @param status_id [String] The id of the status
+      # @return [Hash] The response containing the updated lead
+      #
+      def update_status lead_id:, status_id:
+        verify_credentials!
+        
+        request 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]
+        end
+      end
+
+      # Updates a field for a lead
+      #
+      # @param lead_id [String] The id of the lead to be updated
+      # @param field_id [String] The id of the field to be updated
+      # @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:
+        verify_credentials!
+        
+        request 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]
+        end
+      end
+    end
+  end
+end

data/lib/velocify/lead_list.rb

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

data/lib/velocify/model.rb

@@ -0,0 +1,53 @@
+module Velocify
+  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
+    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 &block
+      begin
+        yield block
+      rescue Savon::SOAPFault => ex
+        { message: ex.message }
+      rescue Net::ReadTimeout => ex
+        { message: ex.message }
+      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.authenticate!
+    end
+  end
+end

data/lib/velocify/response_reader.rb

@@ -0,0 +1,62 @@
+require 'active_support/core_ext/string/inflections'
+
+module Velocify
+  class ResponseReader
+    class << self
+      # Convenience method to create a ResponseReader
+      #
+      # @param kind [Symbol] Choose from [:field]
+      # @param response [Hash] The SOAP response received as returned by the other
+      # Velocify model objects
+      #
+      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
+      end
+    end
+
+    # Retrieve the id of a `kind` given a title
+    #
+    # @param title [String] the title of the `kind`
+    # @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
+
+      key["@#{kind}_id".to_sym] if key
+    end
+
+    def search_by_title title
+      key = @hash.select { |k|
+        k["@#{kind}_title".to_sym] =~ /#{title}/
+      }
+
+      key if key
+    end
+
+    def find_by_title title
+      key = @hash.select { |k|
+        k["@#{kind}_title".to_sym] == title
+      }.pop
+
+      key if key
+    end
+
+    # @return [String] a list of all the titles
+    def all_titles
+      @hash.map { |k| k["@#{kind}_title".to_sym] }
+    end
+
+    private
+
+    attr :kind, :hash
+    
+    def initialize kind:, hash:
+      @kind, @hash = kind.to_s, hash
+    end
+  end
+end

data/lib/velocify/status.rb

@@ -0,0 +1,16 @@
+module Velocify
+  class Status
+    include Model
+
+    operations :get_statuses
+
+    def self.find_all
+      verify_credentials!
+
+      request do
+        response = get_statuses(message: authenticated_message({}))
+        response.body[:get_statuses_response][:get_statuses_result]
+      end
+    end
+  end
+end

data/lib/velocify/version.rb

@@ -0,0 +1,3 @@
+module Velocify
+  VERSION = "0.1.0"
+end

data/templates/add_leads.xml.erb

@@ -0,0 +1,23 @@
+<!-- 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 %>"/>
+	    <% end %>
+	    <% if lead.campaign_id? %>
+		<Campaign CampaignId="<%= lead.campaign_id %>"/>
+	    <% end %>
+	    <% unless lead.fields.empty? %>
+		<Fields>
+		    <% lead.fields.each do |field| %>
+			<Field FieldId="<%= field[:id] %>" Value="<%= field[:value] %>"/>
+		    <% end %>
+		</Fields>
+	    <% end %>
+	</Lead>
+    <% end %>
+</Leads>

data/velocify.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'velocify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "velocify"
+  spec.version       = Velocify::VERSION
+  spec.authors       = ["Daniel Dyba"]
+  spec.email         = ["daniel.dyba@gmail.com"]
+
+  spec.summary       = %q{A library to communicate with Velocify's API.}
+  spec.description   = %q{A library to communicate with Velocify's API.}
+  spec.homepage      = "http://github.com/pennymac/velocify"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "savon", "~> 2.10"
+  spec.add_dependency "activesupport", "~> 4.2"
+  spec.add_dependency "dotenv", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "yard", "~> 0.8.7.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.8"
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: velocify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Dyba
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+description: A library to communicate with Velocify's API.
+email:
+- daniel.dyba@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/velocify.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/model.rb
+- lib/velocify/response_reader.rb
+- lib/velocify/status.rb
+- lib/velocify/version.rb
+- templates/add_leads.xml.erb
+- velocify.gemspec
+homepage: http://github.com/pennymac/velocify
+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.1
+signing_key: 
+specification_version: 4
+summary: A library to communicate with Velocify's API.
+test_files: []
+has_rdoc: