nutshell-crm 0.0.1 → 0.0.2

data/Rakefile

@@ -1,2 +1,5 @@
 require "bundler/gem_tasks"
-# bundle exec rspec spec/nutshell-crm_spec.rb 
+
+task :test do
+  exec "bundle exec rspec spec/nutshell-crm_spec.rb"
+end

data/lib/nutshell-crm.rb

@@ -3,6 +3,7 @@ require "nutshell-crm/version"
 require 'json'
 require 'httparty'
 
+# @author Michael Shafrir
 module NutshellCrm
   class Client
     attr_accessor :api_url
@@ -13,46 +14,313 @@ module NutshellCrm
       @username = username
       @api_key = api_key
 
+      puts "Username: #{username}"
+      puts "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 add_email(email_string)
+      exec_request build_payload({emailString: email_string})
+    end
+
+    # Gets all of the custom fields available for Leads, Accounts and Contacts, including appropriate meta-information.
+    #
+    # @return [json] the custom fields available for Leads, Accounts and Contacts, including appropriate meta-information 
     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)
+    def edit_account(account_id, rev, account)
+      exec_request build_payload({:accountId => account_id, :rev => rev, :account => account})
+    end
+
+    def edit_activity(activity_id, rev, activity)
+      exec_request build_payload({:activityId => activity_id, :rev => rev, :activity => activity})
+    end
+
+    def edit_contact(contact_id, rev, contact)
+      exec_request build_payload({:contactId => contact_id, :rev => rev, :contact => contact})
+    end
+
+    def edit_lead(lead_id, rev, lead)
+      exec_request build_payload({:leadId => lead_id, :rev => rev, :lead => lead})
+    end
+
+    def edit_step(step_id, rev, step)
+      exec_request build_payload({:stepId => step_id, :rev => rev, :step => step})
+    end
+
+    def find_accounts(query, order_by = nil, order_direction = nil, limit = nil, page = nil, stub_responses = nil)
+      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_account_types(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {orderBy: order_by, orderDirection: order_direction, limit: limit, page: page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    def find_activities(query, order_by = nil, order_direction = nil, limit = nil, page = nil, stub_responses = nil)
       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_activity_types(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {orderBy: order_by, orderDirection: order_direction, limit: limit, page: page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    def find_competitors(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {orderBy: order_by, orderDirection: order_direction, limit: limit, page: page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    def find_contacts(query, order_by = nil, order_direction = nil, limit = nil, page = nil, stub_responses = nil)
+      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_delays(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {orderBy: order_by, orderDirection: order_direction, limit: limit, page: page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    def find_industries(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {orderBy: order_by, orderDirection: order_direction, limit: limit, page: page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    def find_lead_outcomes(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {orderBy: order_by, orderDirection: order_direction, limit: limit, page: page}
+      payload = build_payload params, 'findLead_Outcomes'
+      exec_request(payload)
+    end
+
+    def find_leads(query, order_by = nil, order_direction = nil, limit = nil, page = nil, stub_responses = nil)
+      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_markets(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {orderBy: order_by, orderDirection: order_direction, limit: limit, page: page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    def find_milestones(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {orderBy: order_by, orderDirection: order_direction, limit: limit, page: page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    def find_origins(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {orderBy: order_by, orderDirection: order_direction, limit: limit, page: page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    def find_products(order_by = nil, order_direction = nil, limit = nil, page = nil, stub_responses = nil)
+      params = {orderBy: order_by, orderDirection: order_direction, limit: limit, page: page, stubResponses: stub_responses}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    def find_settings(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {orderBy: order_by, orderDirection: order_direction, limit: limit, page: page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    def find_sources(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {orderBy: order_by, orderDirection: order_direction, limit: limit, page: page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
     def find_tags
       exec_request build_payload
     end
 
+    def find_teams(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {orderBy: order_by, orderDirection: order_direction, limit: limit, page: page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    def find_territories(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {orderBy: order_by, orderDirection: order_direction, limit: limit, page: page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    def find_timeline(query, order_by = nil, order_direction = nil, limit = nil, page = nil, stub_responses = nil)
+      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_users(order_by = nil, order_direction = nil, limit = nil, page = nil)
+      params = {orderBy: order_by, orderDirection: order_direction, limit: limit, page: page}
+      payload = build_payload params
+      exec_request(payload)
+    end
+
+    def get_account(account_id, rev = nil)
+      params = {:accountId => account_id, :rev => rev}
+      exec_request build_payload(params)
+    end
+
+    def get_activity(activity_id, rev = nil)
+      params = {:activityId => activity_id, :rev => rev}
+      exec_request build_payload(params)
+    end
+
+    def getAnalyticsReport(report_type, period, filter_entity = nil, options = nil)
+      params = {:reportType => report_type, :period => period, :filter => filter_entity, :options => options}
+      exec_request build_payload(params)
+    end
+
+    def get_contact(contact_id, rev = nil)
+      params = {:contactId => contact_id, :rev => rev}
+      exec_request build_payload(params)
+    end
+
+    def get_email(email_id, rev = nil)
+      params = {:emailId => email_id, :rev => rev}
+      exec_request build_payload(params)
+    end
+
+    def get_lead(lead_id, rev = nil)
+      params = {:leadId => lead_id, :rev => rev}
+      exec_request build_payload(params)
+    end
+
+    def get_mobile_settings
+      exec_request build_payload
+    end
+
+    def get_note(note_id, rev = nil)
+      params = {:noteId => note_id, :rev => rev}
+      exec_request build_payload(params)
+    end
+
+    def get_product(product_id, rev = nil)
+      params = {:productId => product_id, :rev => rev}
+      exec_request build_payload(params)
+    end
+
     def get_update_times
       exec_request build_payload
     end
 
+    def get_user(user_id = nil, rev = nil)
+      params = {:userId => user_id, :rev => rev}
+      exec_request build_payload(params)
+    end
+
+    def new_account(account)
+      exec_request build_payload({account: account})
+    end
+
+    def new_activity(activity)
+      exec_request build_payload({activity: activity})
+    end
+
+    def new_contact(contact)
+      exec_request build_payload({contact: contact})
+    end
+
+    def new_lead(lead)
+      exec_request build_payload({lead: lead})
+    end
+
+    def new_tag(tag)
+      exec_request build_payload({tag: tag})
+    end
+
+    def search_accounts(query, limit = nil)
+      exec_request build_payload({:string => query, :limit => limit})
+    end
+
+    def search_by_email(email_address)
+      exec_request build_payload({:emailAddressString => email_address})
+    end
+
+    def search_competitors(query, limit = nil)
+      exec_request build_payload({:string => query, :limit => limit})
+    end
+
+    def search_contacts(query, limit = nil)
+      exec_request build_payload({:string => query, :limit => limit})
+    end
+
+    def search_contacts_and_users(query, limit = nil)
+      exec_request build_payload({:string => query, :limit => limit})
+    end
+
+    def search_leads(query, limit = nil)
+      exec_request build_payload({:string => query, :limit => limit})
+    end
+
+    def search_products(query, limit = nil)
+      exec_request build_payload({:string => query, :limit => limit})
+    end
+
+    def search_sources(query, limit = nil)
+      exec_request build_payload({:string => query, :limit => limit})
+    end
+
+    def search_universal(query)
+      exec_request build_payload({:string => query})
+    end
+
+    def search_users_and_teams(query, limit = nil)
+      exec_request build_payload({:string => query, :limit => limit})
+    end
+
+
 
 
     private
 
-    def build_payload(params = nil)
-      method = caller[0][/`.*'/][1..-2]
-      method = 'getApiForUsername' if method == 'initialize'
+    def build_payload(params = nil, override_method = nil)
+      # Calculate the Nutshell API method name based on the Ruby method name (with a few exceptions)
+      if override_method.nil?
+        method = caller[0][/`.*'/][1..-2]
+        method = 'getApiForUsername' if method == 'initialize'
+      else
+        method = override_method
+      end
+
+      # Create the payload
       payload = {:method => camelcase(method), :id => generate_request_id}
-      payload[:params] = params unless params.nil?
+
+      # Filter out keys with nil values.
+      payload[:params] = params.reject {|k,v| v.nil?} unless params.nil?
+
+      # Return as JSON
       payload.to_json
     end
 
+
+    # All Nutshell API requests need a request id.
     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)
+    def exec_request(payload, override_url = nil)
       response = HTTParty.post(override_url.nil? ? @api_url : override_url,
         :basic_auth => {:username => @username, :password => @api_key},
         :body => payload,

data/lib/nutshell-crm/version.rb

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

data/nutshell-crm.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |s|
   s.summary     = "Summary"
   s.description = "Description"
 
+  s.add_development_dependency 'yard'
   s.add_development_dependency 'json'
   s.add_development_dependency 'httparty'
   s.add_development_dependency 'rspec'

data/spec/nutshell-crm_spec.rb

@@ -1,169 +1,3 @@
-=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
@@ -179,9 +13,12 @@ describe NutshellCrm::Client do
       lambda { NutshellCrm::Client.new('invalid@example.com', 'APIKEY123456') }.should raise_error
     end
 
+=begin
     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
+      nutshell = NutshellCrm::Client.new(@api_username, 'APIKEY123456')
+      lambda { nutshell.find_leads({status: 0}) }.should raise_error
     end
+=end
   end
 
   subject { @nutshell }
@@ -208,5 +45,41 @@ describe NutshellCrm::Client do
     it 'should get update times for each provisioning bin' do
       @nutshell.get_update_times.should_not be_empty
     end
+
+    it 'should return universal search results' do
+      @nutshell.search_universal('A').should_not be_empty
+    end
+
+    it 'should create a new tag and find it' do
+      lambda {
+        @nutshell.new_tag({name: 'FOO2', entityType: 'Leads'})
+        @nutshell.new_tag({name: 'FOO2', entityType: 'Leads'})
+      }.should raise_error
+    end
+
+    it 'should return product info' do
+      product = @nutshell.get_product(1)
+      product.should_not be_empty
+    end
+
+    it 'should return mobile settings' do
+      mobile_settings = @nutshell.get_mobile_settings
+      mobile_settings.should_not be_empty
+    end
+
+    it 'should return the logged in user' do
+      user = @nutshell.get_user
+    end
+
+    it 'should get and edit a lead' do
+      lead_id = 1001
+      lead = @nutshell.get_lead(lead_id)
+      rev = lead['rev']
+      @nutshell.edit_lead(lead_id, rev, {:description => 'Testing edit.'})
+    end
+
+    it 'should return the sources' do
+      @nutshell.search_sources('Cold')
+    end
   end
 end