nutshell-crm 0.0.1

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+*.rbc
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in nutshell-crm.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+# bundle exec rspec spec/nutshell-crm_spec.rb 

data/lib/nutshell-crm.rb

@@ -0,0 +1,78 @@
+require "nutshell-crm/version"
+
+require 'json'
+require 'httparty'
+
+module NutshellCrm
+  class Client
+    attr_accessor :api_url
+    include HTTParty
+    format :json
+
+    def initialize(username, api_key)
+      @username = username
+      @api_key = api_key
+
+      result = exec_request(build_payload({:username => @username}), 'http://api.nutshell.com/v1/json')
+      api_host = result['api']
+      @api_url = "https://#{api_host}/api/v1/json"
+    end
+
+    def describe_custom_fields
+      exec_request build_payload
+    end
+
+    def find_leads(query, order_by = 'id', order_direction = 'ASC', limit = 50, page = 1, stub_responses = true)
+      params = {query: query, orderBy: order_by, orderDirection: order_direction, limit: limit, page: page, stubResponses: stub_responses}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    def find_tags
+      exec_request build_payload
+    end
+
+    def get_update_times
+      exec_request build_payload
+    end
+
+
+
+    private
+
+    def build_payload(params = nil)
+      method = caller[0][/`.*'/][1..-2]
+      method = 'getApiForUsername' if method == 'initialize'
+      payload = {:method => camelcase(method), :id => generate_request_id}
+      payload[:params] = params unless params.nil?
+      payload.to_json
+    end
+
+    def generate_request_id
+      Digest::MD5.hexdigest(Time.now.to_i.to_s).slice(0..8)
+    end
+
+    def exec_request(payload = nil, override_url = nil)
+      response = HTTParty.post(override_url.nil? ? @api_url : override_url,
+        :basic_auth => {:username => @username, :password => @api_key},
+        :body => payload,
+        :query => {:output => :json}
+      )
+
+      unless response['error'].nil?
+        error = response['error']
+        error_code = error['code']
+        error_msg = error['message']
+        raise "#{error_msg} (#{error_code})"
+      end
+
+      response['result']
+    end
+
+    def camelcase(method_name)
+      parts = []
+      method_name.split('_').each_with_index {|str, idx| parts << (idx == 0 ? str : str.capitalize)}
+      parts.join ''
+    end
+  end
+end

data/lib/nutshell-crm/version.rb

@@ -0,0 +1,3 @@
+module NutshellCrm
+  VERSION = "0.0.1"
+end

data/nutshell-crm.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "nutshell-crm/version"
+
+Gem::Specification.new do |s|
+  s.name        = "nutshell-crm"
+  s.version     = NutshellCrm::VERSION
+  s.authors     = ["Michael Shafrir"]
+  s.email       = ["mshafrir@gmail.com"]
+  s.homepage    = "https://github.com/mshafrir/nutshell-crm"
+  s.summary     = "Summary"
+  s.description = "Description"
+
+  s.add_development_dependency 'json'
+  s.add_development_dependency 'httparty'
+  s.add_development_dependency 'rspec'
+
+  s.rubyforge_project = "nutshell-crm"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/spec/nutshell-crm_spec.rb

@@ -0,0 +1,212 @@
+=begin
+
+  add ($num1, $num2)
+  For testing. 
+
+
+  addEmail ($emailString)
+  Saves the given e-mail message. 
+
+  describeCustomFields ()
+  Gets all of the custom fields available for Leads, Accounts and Contacts, including appropriate meta-information. 
+
+  editAccount ($accountId, $rev, $account)
+  Edit an account. 
+
+  editActivity ($activityId, $rev, $activity)
+  Edit an activity. 
+
+  editContact ($contactId, $rev, $contact)
+  Edit a contact. 
+
+  editLead ($leadId, $rev, $lead)
+  Edit a lead. 
+
+  editStep ($stepId, $rev, $step)
+  Update a process step. 
+
+  findAccounts ($query, $orderBy= 'name', $orderDirection= 'ASC', $limit=50, $page=1, $stubResponses=true)
+  Find accounts matching a specified query. 
+
+  findAccountTypes ($orderBy= 'name', $orderDirection= 'ASC', $limit=50, $page=1)
+  Get all active account types (to be applied to an account) 
+
+  findActivities ($query, $orderBy= 'name', $orderDirection= 'ASC', $limit=50, $page=1, $stubResponses=true)
+  Find activities matching a specified query. 
+
+  findActivityTypes ($orderBy= 'name', $orderDirection= 'ASC', $limit=50, $page=1)
+  Get all active activity types. 
+
+  findCompetitors ($orderBy= 'name', $orderDirection= 'ASC', $limit=50, $page=1)
+  Get all active Competitors. 
+
+  findContacts ($query=null, $orderBy= 'id', $orderDirection= 'ASC', $limit=50, $page=1, $stubResponses=true)
+  Find contacts associated with a specified account or lead. 
+
+  findDelays ($orderBy= 'name', $orderDirection= 'ASC', $limit=50, $page=1)
+  Get all active Delays (seen in Step responses in availableDelayIds) 
+
+  findIndustries ($orderBy= 'name', $orderDirection= 'ASC', $limit=50, $page=1)
+  Get all active Industries (to be applied to an account) 
+
+  findLead_Outcomes ($orderBy= 'description', $orderDirection= 'ASC', $limit=50, $page=1)
+  Get all possible outcomes for a closed lead. 
+
+  findLeads ($query, $orderBy= 'id', $orderDirection= 'ASC', $limit=50, $page=1, $stubResponses=true)
+  Find leads matching a specified query. 
+
+  findMarkets ($orderBy= 'name', $orderDirection= 'ASC', $limit=50, $page=1)
+  Get all active markets. 
+
+  findMilestones ($orderBy= 'name', $orderDirection= 'ASC', $limit=50, $page=1)
+  Get all active milestones. 
+
+  findOrigins ($orderBy= 'name', $orderDirection= 'ASC', $limit=50, $page=1)
+  Get all active Origins. 
+
+  findProducts ($orderBy= 'name', $orderDirection= 'ASC', $limit=50, $page=1, $stubResponses=true)
+  Get all active products. 
+
+  findSettings ($orderBy= 'name', $orderDirection= 'ASC', $limit=50, $page=1)
+  Return all publicly-visible settings. 
+
+  findSources ($orderBy= 'name', $orderDirection= 'ASC', $limit=50, $page=1)
+  Get all active Sources. 
+
+  findTeams ($orderBy= 'name', $orderDirection= 'ASC', $limit=50, $page=1)
+  Get all active Teams. 
+
+  findTerritories ($orderBy= 'name', $orderDirection= 'ASC', $limit=50, $page=1)
+  Get all territories. 
+
+  findTimeline ($query, $orderBy= 'time', $orderDirection= 'ASC', $limit=50, $page=1, $stubResponses=true)
+  Find timeline events (Activities, Emails and Notes) for an Entity. 
+
+  findUsers ($orderBy= 'last_name', $orderDirection= 'ASC', $limit=50, $page=1)
+  Get all active Users. 
+
+  getAccount ($accountId, $rev=null)
+  Get the specified Account. 
+
+  getActivity ($activityId, $rev=null)
+  Get the specified Activity. 
+
+  getAnalyticsReport ($reportType, $period, $filter=null, $options=null)
+  Returns graph data and overview information for various sales analytics reports. 
+
+  getContact ($contactId, $rev=null)
+  Get the specified Contact. 
+
+  getEmail ($emailId, $rev=null)
+  Get the specified Email. 
+
+  getLead ($leadId, $rev=null)
+  Get the specified lead. 
+
+  getMobileSettings ()
+  Return all mobile-related settings in a simple key-value array. 
+
+  getNote ($noteId, $rev=null)
+  Get the specified Note. 
+
+  getProduct ($productId, $rev=null)
+  Get all information for a product (including full price list). 
+
+  getUpdateTimes ()
+  Gets the last-updated times of each of the provisioning bins. 
+
+  getUser ($userId, $rev=null)
+  Get all info about a user. 
+
+  newAccount ($account)
+  Create a new account. 
+
+  newActivity ($activity)
+  Create a new activity. 
+
+  newContact ($contact)
+  Create a new contact. 
+
+  newLead ($lead)
+  Create a new Lead. 
+
+  newTag ($tag)
+  Create a new tag. 
+
+  searchAccounts ($string, $limit=10)
+  Return a list of Account stubs matching a given search string. 
+
+  searchByEmail ($emailAddressString)
+  Works just like searchUniversal, but only searches by email address. 
+
+  searchCompetitors ($string, $limit=10)
+  Return a list of Competitor stubs matching a given search string. 
+
+  searchContacts ($string, $limit=10)
+  Return a list of Contact stubs matching a given search string. 
+
+  searchContactsAndUsers ($string, $limit=10)
+  Return a list of Contact and User stubs matching a given search string. 
+
+  searchLeads ($string, $limit=40)
+  Return a list of Lead stubs matching a given search string. 
+
+  searchProducts ($string, $limit=10)
+  Return a list of Product stubs matching a given search string. 
+
+  searchSources ($string, $limit=10)
+  Return a list of Source stubs matching a given search string. 
+
+  searchUniversal ($string)
+  Return a list of Contact, Lead, and Account stubs matching a given search string. 
+
+  searchUsersAndTeams ($string, $limit=10)
+  Return a list of User and Team stubs matching a given search string. 
+=end
+
+require 'spec_helper'
+
+describe NutshellCrm::Client do
+  before :all do
+    @api_username = ENV['NUTSHELL_USERNAME']
+    @api_key = ENV['NUTSHELL_APIKEY']
+    @nutshell = NutshellCrm::Client.new @api_username, @api_key
+    @categories = ['Contacts', 'Accounts', 'Leads']
+  end
+
+  context 'client authentication errors' do
+    it 'should set up a new client instance with an invalid username and raise an error' do
+      lambda { NutshellCrm::Client.new('invalid@example.com', 'APIKEY123456') }.should raise_error
+    end
+
+    it 'should set up a new client instance with a valid username but invalid API key and raise an error' do
+      lambda { NutshellCrm::Client.new(@api_username, 'APIKEY123456').find_leads({status: 0}) }.should raise_error
+    end
+  end
+
+  subject { @nutshell }
+
+  context 'after a new Nutshell client has been instantiated' do
+    it 'should get a valid API service url that starts with https://' do
+      @nutshell.api_url.should match 'https://'
+    end
+
+    it 'should find open leads' do
+      @nutshell.find_leads({status: 0}).should_not be_empty
+    end
+
+    it 'should describe custom fields' do
+      custom_fields = @nutshell.describe_custom_fields
+      (custom_fields.all? {|k,v| @categories.include? k}).should be_true
+    end
+
+    it 'should find tags' do
+      tags = @nutshell.find_tags
+      (tags.all? {|k,v| @categories.include? k}).should be_true
+    end
+
+    it 'should get update times for each provisioning bin' do
+      @nutshell.get_update_times.should_not be_empty
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'nutshell-crm' # and any other gems you need
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

data/vendor/bundle/bin/autospec

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by RubyGems.
+#
+# The application 'rspec-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'rubygems'
+
+version = ">= 0"
+
+if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
+  version = $1
+  ARGV.shift
+end
+
+gem 'rspec-core', version
+load Gem.bin_path('rspec-core', 'autospec', version)

data/vendor/bundle/bin/htmldiff

@@ -0,0 +1,21 @@
+#!/bin/sh
+'exec' "ruby" '-x' "$0" "$@"
+#!/Users/mshafrir/.rbenv/versions/1.9.2-p290/bin/ruby -w
+#
+# This file was generated by RubyGems.
+#
+# The application 'diff-lcs' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'rubygems'
+
+version = ">= 0"
+
+if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
+  version = $1
+  ARGV.shift
+end
+
+gem 'diff-lcs', version
+load Gem.bin_path('diff-lcs', 'htmldiff', version)

data/vendor/bundle/bin/httparty

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by RubyGems.
+#
+# The application 'httparty' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'rubygems'
+
+version = ">= 0"
+
+if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
+  version = $1
+  ARGV.shift
+end
+
+gem 'httparty', version
+load Gem.bin_path('httparty', 'httparty', version)

data/vendor/bundle/bin/ldiff

@@ -0,0 +1,21 @@
+#!/bin/sh
+'exec' "ruby" '-x' "$0" "$@"
+#!/Users/mshafrir/.rbenv/versions/1.9.2-p290/bin/ruby -w
+#
+# This file was generated by RubyGems.
+#
+# The application 'diff-lcs' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'rubygems'
+
+version = ">= 0"
+
+if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
+  version = $1
+  ARGV.shift
+end
+
+gem 'diff-lcs', version
+load Gem.bin_path('diff-lcs', 'ldiff', version)