lead_router 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 17a035f4674e6553d64cb935952c7bf8753d3c235b1496438a8571a5be81abd9
+  data.tar.gz: b18e92f4decbd6423b1c121723ab2e628224cb4dfad1c759983cb50055300fbf
+SHA512:
+  metadata.gz: 75f5b8658161fc9980964e5816ab6f0d54345b7f1224fb48cdaf9c0ae1b88a28749098cba2ae6096dc57f919a58276d0345ed0e2a6088a075bfcf5c795ed1be2
+  data.tar.gz: 7b939161205bb713b52ec4610aca01c5f11a3fe44136edf59030cf47de7aee8a357251b64eecd608a317c2209ee53f28a918a319b22763f31699871a32133eb9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/spec/reports/
+/tmp/
+*.swp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) Real Geeks LLC
+
+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,76 @@
+# Ruby client to Real Geeks Leads API
+
+Send leads and activities to Lead Router, the Real Geeks Leads API.
+
+For more details see [our documentation](http://docs.realgeeks.com/outgoing_leads_api_developers).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lead_router'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lead_router
+
+## Usage
+
+First get a user and token from the `lead_router` project, it will identify your project and which permissions you have.
+
+If you're a Real Geeks client send a message to [support](https://www.realgeeks.com/support/) and we'll give you credentials.
+
+```ruby
+require 'lead_router'
+
+lr = LeadRouter.new("receivers.leadrouter.realgeeks.com", "user", "token")
+```
+
+with a client created use one the methods below. For details on which fields
+you can send for a `lead` or an `activity`, see our [API docs](http://docs.realgeeks.com/incoming_leads_api)
+
+#### `create_lead(site_uuid, lead)`
+
+Send a new lead.
+
+ - `site_uuid` is a string with the RG2 Site UUID
+ - `lead` id a dictionary with lead fields
+
+#### `update_lead(site_uuid, lead_uuid, lead)`
+
+Update an existing lead.
+
+ - `site_uuid` is a string with the RG2 Site UUID
+ - `lead_uuid` is a string with the Lead Manager Lead UUID
+ - `lead` id a dictionary with lead fields to be overriden
+
+#### `add_activities(site_uuid, lead_uuid, activities)`
+
+Add activities to an existing lead.
+
+ - `site_uuid` is a string with the RG2 Site UUID
+ - `lead_uuid` is a string with the Lead Manager Lead UUID
+ - `activities` is a list of dictionaries, each dictionary is an activitity
+
+#### `create_potential_seller_lead(site_uuid, lead)`
+
+Send a new potential seller lead.  Somebody who attempted to view a property valuation but didn't sign-up to give contact details. So all we have is the property they looked at.
+
+ - `site_uuid` is a string with the RG2 Site UUID
+ - `lead` id a dictionary with lead fields
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To run tests:
+
+    $ rake
+
+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).

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+    t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lead_router"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lead_router.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lead_router/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lead_router"
+  spec.version       = LeadRouter::VERSION
+  spec.authors       = ["Igor Sobreira"]
+  spec.email         = ["igor@realgeeks.com"]
+
+  spec.summary       = "Client to Real Geeks Leads API"
+  spec.description   = "Send Leads and Activities to Real Geeks"
+  spec.homepage      = "https://github.com/realgeeks/lead_router.rb"
+  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_runtime_dependency "rest-client", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.8"
+  spec.add_development_dependency "mocha", "~> 1.1"
+  spec.add_development_dependency "webmock", "~> 2.3.2"
+end

data/lib/lead_router.rb

@@ -0,0 +1,9 @@
+require "lead_router/version"
+require "lead_router/client"
+require "lead_router/exceptions"
+
+module LeadRouter
+  def self.new(host, user, token)
+    LeadRouter::Client.new(host, user, token)
+  end
+end

data/lib/lead_router/client.rb

@@ -0,0 +1,91 @@
+require "rest-client"
+
+module LeadRouter
+
+  class Client
+    def initialize(host, user, token)
+      @host = host
+      @user = user
+      @token = token
+    end
+
+    def create_lead(site_uuid, lead, destinations=[])
+      destinations ||= []
+      require_arg "site_uuid", site_uuid
+      dest_headers = destinations.empty? ? nil : { "X-ROUTER-DESTINATIONS" => destinations.join(",") }
+      request :post, "https://#{@host}/rest/sites/#{site_uuid}/leads", lead.to_json, dest_headers
+    end
+
+    def update_lead(site_uuid, lead_uuid, lead)
+      require_arg "site_uuid", site_uuid
+      require_arg "lead_uuid", lead_uuid
+      request :patch, "https://#{@host}/rest/sites/#{site_uuid}/leads/#{lead_uuid}", lead.to_json
+    end
+
+    def add_activities(site_uuid, lead_uuid, activities)
+      require_arg "site_uuid", site_uuid
+      require_arg "lead_uuid", lead_uuid
+      request :post, "https://#{@host}/rest/sites/#{site_uuid}/leads/#{lead_uuid}/activities", activities.to_json
+    end
+
+    def create_potential_seller_lead(site_uuid, lead)
+      require_arg "site_uuid", site_uuid
+      request :post, "https://#{@host}/rest/sites/#{site_uuid}/potential-seller-leads", lead.to_json
+    end
+
+    # Send a request to notify a user was updated in the Lead Manager
+    #
+    # Only the lead manager is allowed to send this request, every other
+    # client will get 403
+    #
+    # Must be called with the full user object, all fields. See all fields
+    # in: https://developers.realgeeks.com/users/
+    #
+    # 'name' could be provided as 'first_name' and 'last_name', they will be
+    # combined as 'name'
+    def update_user(site_uuid, user_id, user)
+      require_arg "site_uuid", site_uuid
+      require_arg "user_id", user_id
+
+      # if name not set try to use first_name and last_name
+      user = user.clone
+      first = user.delete(:first_name)
+      last  = user.delete(:last_name)
+      user['name'] ||= first unless first.nil?
+      user['name'] += " #{last}" unless last.nil?
+
+      request :put, "https://#{@host}/rest/sites/#{site_uuid}/users/#{user_id}", user.to_json
+    end
+
+    # Send a request to notify a user was deleted in the Lead Manager
+    #
+    # Only the lead manager is allowed to send this request, every other
+    # client will get 403
+    def delete_user(site_uuid, user_id)
+      request :delete, "http://#{@host}/rest/sites/#{site_uuid}/users/#{user_id}"
+    end
+
+    private
+
+    def request(method, url, body='', headers={})
+      headers ||= {}
+      headers.merge!({content_type: 'application/json', user_agent: "LeadRouterRuby/#{VERSION}"})
+
+      RestClient::Request.execute(
+        :method => method,
+        :url => url,
+        :payload => body,
+        :headers => headers,
+        :user => @user,
+        :password => @token
+      )
+    rescue ::Exception => ex
+      raise LeadRouter::Exception, ex
+    end
+
+    def require_arg(name, value)
+      raise LeadRouter::Exception, ArgumentError.new("#{name} cannot be nil") if value.nil?
+    end
+
+  end
+end

data/lib/lead_router/exceptions.rb

@@ -0,0 +1,34 @@
+module LeadRouter
+
+  # All possible exceptions raised by the LeadRouter::Client will be an instance
+  # of this class
+  #
+  # Use 'original_exception' method to access the original exception object , or
+  # just 'to_s' to display a nice error message
+  #
+  # If the error was an invalid HTTP status code, 'http_code' and 'http_body' methods
+  # will be available (they return 0 and "" otherwise)
+  class Exception < RuntimeError
+
+    attr_accessor :original_exception
+
+    def initialize(exception)
+      @original_exception = exception
+    end
+
+    def to_s
+      return "#{original_exception.to_s}: HTTP status #{http_code} with body #{http_body}" unless http_code == 0
+      original_exception.to_s
+    end
+
+    def http_code
+      original_exception.respond_to?(:http_code) ? original_exception.http_code : 0
+    end
+
+    def http_body
+      original_exception.respond_to?(:http_body) ? original_exception.http_body : ""
+    end
+
+  end
+
+end

data/lib/lead_router/version.rb

@@ -0,0 +1,3 @@
+module LeadRouter
+  VERSION = "1.4.0"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: lead_router
+version: !ruby/object:Gem::Version
+  version: 1.4.0
+platform: ruby
+authors:
+- Igor Sobreira
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+description: Send Leads and Activities to Real Geeks
+email:
+- igor@realgeeks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lead_router.gemspec
+- lib/lead_router.rb
+- lib/lead_router/client.rb
+- lib/lead_router/exceptions.rb
+- lib/lead_router/version.rb
+- pkg/lead_router-1.1.1.gem
+- pkg/lead_router-1.3.1.gem
+homepage: https://github.com/realgeeks/lead_router.rb
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Client to Real Geeks Leads API
+test_files: []