leadsquared 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4457c15176528bf134ce7a7508d6d9c1aa5aa314
+  data.tar.gz: a6f8e10a837e2700a48fd7d0fa2724942a3c6b5f
+SHA512:
+  metadata.gz: f236634bb8f198e5a1596f0dff7952fa77afb384e9292686ddef94a1b7e042d49bdfeb4a9fd25fcb024d67e915c596bba5b99dcb942ad7e009281b1ed8c6930a
+  data.tar.gz: 7613afb63bc28d440e1e673a96463daaff4a650b6386d3cb88bacbd3e4a8c2b43c3c19202bf7065c05c8fc38cf628a05caa28e5826a33d3edd466d435e438d64

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.2.0
+  - 2.2.1
+  - 2.2.2
+  - 2.2.3
+
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+
+gem 'activesupport'
+gem 'faraday'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development, :test do
+  gem "rspec"
+  gem "rdoc"
+  gem "bundler"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov"
+  gem "pry-byebug"
+  gem "webmock"
+  gem "timecop"
+  gem "codeclimate-test-reporter", require: nil
+end

data/Gemfile.lock

@@ -0,0 +1,120 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.8)
+    builder (3.2.2)
+    byebug (5.0.0)
+      columnize (= 0.9.0)
+    codeclimate-test-reporter (0.4.8)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.0)
+    columnize (0.9.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.12.4)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.6)
+      oauth2
+    hashdiff (0.2.2)
+    hashie (3.4.2)
+    highline (1.7.8)
+    i18n (0.7.0)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.3)
+    jwt (1.5.1)
+    method_source (0.8.2)
+    mini_portile (0.6.2)
+    minitest (5.8.1)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.2.0)
+      byebug (~> 5.0)
+      pry (~> 0.10)
+    rack (1.6.4)
+    rake (10.4.2)
+    rdoc (4.2.0)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    safe_yaml (1.0.4)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    thread_safe (0.3.5)
+    timecop (0.8.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    webmock (1.22.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bundler
+  codeclimate-test-reporter
+  faraday
+  jeweler (~> 2.0.1)
+  pry-byebug
+  rdoc
+  rspec
+  simplecov
+  timecop
+  webmock
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 David Paluy
+
+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,40 @@
+# leadsquared gem
+
+This is a simple Ruby wrapper to [Leadsquared](http://apidocs.leadsquared.com/) API
+
+[![Gem Version](https://badge.fury.io/rb/leadsquared.png)](http://badge.fury.io/rb/leadsquared)
+[![Build Status](https://secure.travis-ci.org/dpaluy/leadsquared.png)](http://travis-ci.org/dpaluy/leadsquared)
+[![Code Climate](https://codeclimate.com/github/dpaluy/leadsquared/badges/gpa.svg)](https://codeclimate.com/github/dpaluy/leadsquared)
+[![Dependency Status](https://gemnasium.com/dpaluy/leadsquared.svg)](https://gemnasium.com/dpaluy/leadsquared)
+
+## Usage
+
+`gem 'leadsquared'`
+
+You just need to provide the authentication details in you configuration, and you're set. For example, in Rails that would go into config/initializers/leadsquared.rb:
+
+```
+Leadsquared.configure do |config|
+  config.key    = 'mylogin'
+  config.secret = 'secret'
+  config.logger = Rails.logger
+end
+```
+
+### NOTE
+
+This version implements only [LeadManagement](http://apidocs.leadsquared.com/meta-data/) and [ActivityManagement](http://apidocs.leadsquared.com/get-activities-of-a-lead/)
+
+## Contributing to leadsquared
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2015 David Paluy. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "leadsquared"
+  gem.homepage = "http://github.com/dpaluy/leadsquared"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby framework for integration with Leadsquared API}
+  gem.description = %Q{Ruby framework for integration with Leadsquared. Leadsquared API: http://apidocs.leadsquared.com/}
+  gem.email = "dpaluy@gmail.com"
+  gem.authors = ["David Paluy"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "leadsquared #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/leadsquared.gemspec

@@ -0,0 +1,93 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: leadsquared 0.2.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "leadsquared"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["David Paluy"]
+  s.date = "2015-10-26"
+  s.description = "Ruby framework for integration with Leadsquared. Leadsquared API: http://apidocs.leadsquared.com/"
+  s.email = "dpaluy@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "leadsquared.gemspec",
+    "lib/leadsquared.rb",
+    "lib/leadsquared/activity.rb",
+    "lib/leadsquared/api_connection.rb",
+    "lib/leadsquared/client.rb",
+    "lib/leadsquared/config.rb",
+    "lib/leadsquared/engine.rb",
+    "lib/leadsquared/invalid_request_error.rb",
+    "lib/leadsquared/lead.rb",
+    "spec/leadsquared/activity_spec.rb",
+    "spec/leadsquared/client_spec.rb",
+    "spec/leadsquared/lead_spec.rb",
+    "spec/leadsquared_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/dpaluy/leadsquared"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.5.1"
+  s.summary = "Ruby framework for integration with Leadsquared API"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<faraday>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<pry-byebug>, [">= 0"])
+      s.add_development_dependency(%q<webmock>, [">= 0"])
+      s.add_development_dependency(%q<timecop>, [">= 0"])
+      s.add_development_dependency(%q<codeclimate-test-reporter>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<faraday>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<pry-byebug>, [">= 0"])
+      s.add_dependency(%q<webmock>, [">= 0"])
+      s.add_dependency(%q<timecop>, [">= 0"])
+      s.add_dependency(%q<codeclimate-test-reporter>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<faraday>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<pry-byebug>, [">= 0"])
+    s.add_dependency(%q<webmock>, [">= 0"])
+    s.add_dependency(%q<timecop>, [">= 0"])
+    s.add_dependency(%q<codeclimate-test-reporter>, [">= 0"])
+  end
+end
+

data/lib/leadsquared.rb

@@ -0,0 +1,15 @@
+require 'leadsquared/config'
+require 'leadsquared/client'
+require 'leadsquared/api_connection'
+require 'leadsquared/lead'
+require 'leadsquared/activity'
+require 'leadsquared/invalid_request_error'
+require 'leadsquared/engine' if defined?(Rails)
+
+module Leadsquared
+  VERSION = File.read(File.expand_path('../../VERSION', __FILE__)).strip.freeze
+
+  def self.logger
+    config.logger
+  end
+end

data/lib/leadsquared/activity.rb

@@ -0,0 +1,71 @@
+require 'json'
+require 'active_support/core_ext/object/try'
+
+module Leadsquared
+  class Activity < ApiConnection
+    SERVICE = '/v2/ProspectActivity.svc/'.freeze
+
+    def initialize
+      super(SERVICE)
+    end
+
+    def get_activities(lead_id, activity_event_id, offset = 0, row_count = 10)
+      url = url_with_service("Retrieve")
+      body = {
+        "Parameter" => {"ActivityEvent" => activity_event_id},
+        "Paging" => {"Offset" => offset, "RowCount" => row_count}
+      }
+      response = connection.post(url, {leadId: lead_id}, body.to_json)
+      handle_response response
+    end
+
+    # direction - Use ‘1’ as direction for Outbound Activity and ‘0’ for Inbound Activity
+    def create_activity_type(name, score, description, direction = 0)
+      url = url_with_service("CreateType")
+      body = {
+        "ActivityEventName" => name,
+        "Score" => score,
+        "Description" => description,
+        "Direction" => direction
+      }
+      response = connection.post(url, {}, body.to_json)
+      parsed_response = handle_response response
+      parsed_response["Message"]["Id"]
+    end
+
+    def create_lead_activity(lead_id, event_id, notes = nil)
+      url = url_with_service("Create")
+      body = {
+        "RelatedProspectId" => lead_id,
+        "ActivityEvent"     => event_id,
+        "ActivityNote"      => notes,
+        "ActivityDateTime"  => current_utc_time
+      }
+      response = connection.post(url, {leadId: lead_id}, body.to_json)
+      parsed_response = handle_response response
+      parsed_response["Message"]["Id"]
+    end
+
+    def create(email, event_id, notes = nil, first_name = nil, last_name = nil)
+      url = url_with_service("Create")
+      body = {
+        "EmailAddress"      => email,
+        "ActivityEvent"     => event_id,
+        "ActivityNote"      => notes,
+        "ActivityDateTime"  => current_utc_time,
+        "FirstName"         => first_name,
+        "LastName"          => last_name
+      }
+      response = connection.post(url, {}, body.to_json)
+      parsed_response = handle_response response
+      parsed_response["Message"]["Id"]
+    end
+
+    private
+
+    def current_utc_time
+      Time.now.utc.to_s.gsub(/ UTC$/, "")
+    end
+  end
+end
+