ctm 0.4.4 → 0.5.0

data/README.md

@@ -11,115 +11,384 @@ Usage
 -----
 
 ```ruby
-
 require 'ctm'
 
-# get an access token
+# Authentication
+
 access_token = CTM::Auth.authenticate(ENV['CTM_TOKEN'], ENV['CTM_SECRET'])
 
-# see the list of accounts
-puts CTM::Account.list(access_token).inspect
+account = access_token.accounts.first
+number  = account.numbers.first
+
+# Accounts
 
-# use this access token globally, instead of passing it to each method
-CTM::Auth.token = access_token
+puts "Accounts you have access to (#{access_token.accounts.total_entries}):"
+access_token.accounts.each do|a|
+  puts "  #{a.name} -> #{a.status}, #{a.balance}"
+end
+
+puts
+puts "Select an account:"
+account = access_token.accounts.first
+puts "  First account: #{account.name}"
 
-# get my first account
-account = CTM::Account.first
+account = access_token.accounts.find('name' => 'CallTrackingMetrics').first
+puts "  Found by name: #{account.name}"
 
-# get an account by name
-account = CTM::Account.find("name" => "My Account Name")
+# Tracking Numbers
 
-# get a list of numbers within this account, returns 10 at a time by default
+puts
 numbers = account.numbers
-puts numbers.first.inspect
-puts numbers.total_entries.inspect
-puts numbers.page.inspect
-puts numbers.per_page.inspect
-numbers.each {|number|
-  puts number.id
-  puts "#{number.name} #{number.number} -> #{number.formatted}"
-}
-
-# get the next 20 numbers on page 2
-numbers = account.numbers(:page => 2, :per_page => 20)
-
-# search for new numbers to purchase
-numbers = account.numbers.search("+1", :areacode => "410")
-numbers = account.numbers.search("+1", :tollfree => true, :areacode => "888")
-numbers = account.number.search("+44", :contains => "55")
-
-# purchase a new number
-number = account.numbers.buy(numbers.first.digits)
-if number.purchased?
-  puts "successfully purchased the number: #{number.digits_formated}"
-else
-  puts "failed to purchase that number"
+puts "Tracking Numbers within the Account (#{numbers.total_entries}):"
+
+puts "  Page %-67s %-14s Formatted" % ["ID", "Number"]
+numbers.each_with_index do|n, i|
+  break if i > 4
+  puts "  %-4d %s %-14s %s" % [numbers.page, n.id, n.number, n.formatted]
+end
+
+puts '  ...'
+
+numbers.page = numbers.total_pages
+numbers.entries.reverse.each_with_index do|n, i|
+  break if i > 4
+  puts "  %-4d %s %-14s %s" % [numbers.page, n.id, n.number, n.formatted]
+end
+
+puts
+puts "Modify routing preferences"
+[:round_robin, :least_connected, :simultaneous].each do |routing|
+  number.routing = routing
+  puts "  #{number.formatted} currently uses #{number.routing} routing"
+end
+
+# Receiving Numbers
+
+numbers = account.receiving_numbers
+puts
+puts "Receiving Numbers within the Account (#{numbers.total_entries}):"
+
+puts "  Page %-67s %-14s Formatted" % ["ID", "Number"]
+numbers.each_with_index do|n, i|
+  break if i > 4
+  puts "  %-4d %s %-14s %s" % [numbers.page, n.id, n.number, n.formatted]
+end
+
+puts '  ...'
+
+numbers.page = numbers.total_pages
+numbers.entries.reverse.each_with_index do|n, i|
+  break if i > 4
+  puts "  %-4d %s %-14s %s" % [numbers.page, n.id, n.number, n.formatted]
 end
 
-# release the number, removing it from the account
-number.release!
+receiving_number = account.receiving_numbers.create(
+  name: 'demo number', number: '+18008675309'
+)
 
-# create a source from a predefined source
-source = account.sources.create(predefined: 'google_adwords')
+puts
+puts "Adding #{receiving_number.formatted}"
+number.receiving_numbers.add receiving_number
 
-# list predefined sources
-predefined = account.predefined
+puts "Receiving Numbers for #{number.formatted}"
+number.receiving_numbers.each_page do |page|
+  page.each.map {|n| puts "  #{n.formatted}"}
+end
+
+puts
+puts "Removing #{receiving_number.formatted}"
+number.receiving_numbers.rem receiving_number
+
+puts "Receiving Numbers for #{number.formatted}"
+number.receiving_numbers.each_page do |page|
+  page.each {|n| puts "  #{n.formatted}"}
+end
+
+puts "Releasing #{number.formatted}"
+receiving_number.release!
 
-# customize a source
-source = account.sources.find(:name => "Google Adwords")
-source.landing_url = "utm_campaign=MyCampaign"
-source.save
+# Purchasing Numbers
 
-# assign a source to a number
-source.numbers.add(number)
+puts
+puts "Search for numbers to buy:"
 
-# get a list of receiving numbers
-receiving_numbers = account.receiving_numbers
+puts "  Country Region PostalCode TollFree Number"
+matches = account.numbers.search("US", searchby: 'tollfree')
 
-# add a receiving number, note +1 country code is required
-receiving_number = account.receiving_numbers.create(name: "my number", number:"+15555555555")
+total_tollfree = matches.total_entries
 
-# assign a receiving number to the tracking number
-number.receiving_numbers.add(receiving_number)
-# get the list of receiving numbers for this number
-puts number.receiving_numbers.inspect
-number.save
+matches.each_with_index do |n, i|
+  break if i > 10
+  puts "  %-7s %-6s %-10s %-8s %s" % [n.iso_country,
+                                      n.region, n.postal_code,
+                                      'Yes', n.friendly_name]
+end
+puts '  ...'
 
-# modify the routing preference for the number
-number.routing = :simultaneous # :round_robin, :least_connected
-number.save
+matches = account.numbers.search("US",
+  region: 'SC',
+  areacode: 910,
+  pattern: '802'
+)
 
-# add a new user to the account
-account.users.create(first_name: 'First', last_name: 'Last', email: 'email@example.com', notify: true)
+total_local = matches.total_entries
+
+matches.each_with_index do |n,i|
+  break if i > 10
+  puts "  %-7s %-6s %-10s %-8s %s" % [n.iso_country,
+                                  n.region, n.postal_code,
+                                  'No', n.friendly_name]
+end
+puts '  ...'
+
+puts
+puts "Found #{total_local} local numbers."
+puts "Found #{total_tollfree} toll-free numbers."
+
+puts
+puts "Purchase a number"
+begin
+  number = account.numbers.buy matches.first.phone_number
+  puts "Successfully purchased the number: #{number.number}"
+
+  similar_numbers = account.numbers('number' => number.number)
+  puts "  Search for active numbers matching %s gives %d results:" % [
+    number.number, similar_numbers.total_entries
+  ]
+  similar_numbers.each_page do |p| p.each {|n| puts "    #{n.number}" }
+  end
+
+  number.release!
+  puts "Released number: #{number.number}"
+
+  similar_numbers = account.numbers('number' => number.number)
+  puts "  Search for active numbers matching %s gives %d results:" % [
+    number.number, similar_numbers.total_entries
+  ]
+  similar_numbers.each_page do |p| p.each {|n| puts "    #{n.number}" }
+  end
+
+rescue CTM::Error::Buy => e
+  puts "Failed to purchase number (#{number.number}): #{e.message}"
+end
+
+# Tracking Sources
+
+sources = account.sources
+
+puts
+puts "Tracking Sources within the Account (#{sources.total_entries})"
+puts "  Page %-5s %-30s Referring URL -> Landing URL" % ["ID","Name"]
+1.upto(sources.total_pages) do |page|
+  sources.page = page
+  sources.each do|source|
+    puts "  %-4d %-5d %-30s '%s' -> '%s'" % [
+      sources.page, source.id,
+      source.name,
+      source.referring_url, source.landing_url]
+  end
+end
+
+src = account.sources.find(name: 'Direct').first
+id  = src.id
+
+puts
+puts "Customizing a source #{sources.filters.inspect}"
+
+puts "  Step   %-5s %-30s Referring URL -> Landing URL" % ["ID","Name"]
+puts "  Find   %-5d %-30s '%s' -> '%s'" % [src.id, src.name, src.referring_url, src.landing_url]
+
+src.landing_url   = "utm_campaign=DemoCampain"
+src.referring_url = "some_search_engine.com"
+src.name          = "Demo Source"
+puts "  Change %-5d %-30s '%s' -> '%s'" % [src.id, src.name, src.referring_url, src.landing_url]
+
+src.save
+src = sources.get(id)
+puts "  Save   %-5d %-30s '%s' -> '%s'" % [src.id, src.name, src.referring_url, src.landing_url]
+
+src.landing_url   = ""
+src.referring_url = ""
+src.name          = "Direct"
+src.save
+
+puts "  Revert %-5d %-30s '%s' -> '%s'" % [src.id, src.name, src.referring_url, src.landing_url]
+
+# Users
 
-# list the users
 users = account.users
 
-# create a webhook to send call data at the start of the call
-account.webhooks.create(weburl: "http://myhost.com/new_calls", position: 'start')
+puts
+puts "Creating User with email: the.brave.johnny@example.com"
+jbravo = users.create(
+  first_name: 'Johnny',
+  last_name: 'Bravo',
+  email: 'the.brave.johnny@example.com',
+  role: 'admin',
+  notify: false
+).id
+
+puts
+puts "Users within the Account (#{users.total_entries})"
+puts "  %-40s %-20s %-20s %s" % %w(ID Name Role Email)
+
+users.each_page do |page|
+  page.each do|user|
+    puts "  %-40s %-20s %-20s %s" % [user.id, user.name, user.role, user.email]
+  end
+end
+
+puts
+puts "Removing User: %s" % [ account.users.get(jbravo).release!['status'] ]
 
-# create a webhook to send call data at the end of the call
-account.webhooks.create(weburl: "http://myhost.com/new_calls", position: 'end')
+# Webhooks
 
-# list webhooks
-account.webhooks
+ids = []
 
-# calls - list the calls
-account.calls
+puts
+puts "Creating webhook at start and end"
+ids << account.webhooks.create(
+  weburl: "http://example.com/new_call/start",
+  position: 'start'
+).id
+
+ids << account.webhooks.create(
+  weburl: "http://example.com/new_call/end",
+  position: 'end'
+).id
+
+puts "Webhooks in account (#{account.webhooks.total_entries}):"
+puts "  %-5s Position WebURL" % ["ID"]
+account.webhooks.each_page do |page|
+  page.each do |hook|
+    puts "  %-5s %-8s %s" % [hook.id, hook.position, hook.weburl]
+  end
+end
+
+puts "Releasing webhooks"
+ids.each do |i|
+  res = account.webhooks.get(i).release!
+
+  puts "  %s: %s" % [ i, res['status'] == 'deleted' ? res['status'] : res.inspect ]
+end
+
+# Calls
 
 call = account.calls.first
+call_fmt_str = "  %-8s %-20s %-15s %-10s %-10s %-20s %-12s %-20s %-20s %s"
+
+puts
+puts "Call Information:"
+
+puts call_fmt_str % %w(ID Source Likelihood TalkTime RingTime CalledAt DialStatus CallerNumber CallerName Notes)
+puts call_fmt_str % [
+  call.id,
+  call.source,                               call.likelihood,
+  call.talk_time,                            call.ring_time,
+  call.called_at.split(' ')[0..1].join(' '), call.dial_status,
+  call.caller_number_format,                 call.name,
+  call.notes
+]
+
+puts
+puts "Adding note to call:"
+old_note = call.notes
+id = call.id
+call.notes = "Test Note!"
+
+puts call_fmt_str % %w(ID Source Likelihood TalkTime RingTime CalledAt
+DialStatus CallerNumber CallerName Notes)
+puts call_fmt_str % [
+  call.id,
+  call.source,                               call.likelihood,
+  call.talk_time,                            call.ring_time,
+  call.called_at.split(' ')[0..1].join(' '), call.dial_status,
+  call.caller_number_format,                 call.name,
+  call.notes
+]
 
-call.notes = "some notes to attach to the call"
 call.save
 
-# get sale record
-call.sale
+call = account.calls.get id
+puts
+puts "Deleting note from call:"
+puts call_fmt_str % %w(ID Source Likelihood TalkTime RingTime CalledAt
+DialStatus CallerNumber CallerName Notes)
+puts call_fmt_str % [
+  call.id,
+  call.source,                               call.likelihood,
+  call.talk_time,                            call.ring_time,
+  call.called_at.split(' ')[0..1].join(' '), call.dial_status,
+  call.caller_number_format,                 call.name,
+  call.notes
+]
+
+call.notes = old_note
+call.save
 
-# create sale record, marking the call as a conversion
-call.sale.create(name: "Who", score: 5, conversion: true, value: 34, date: '2013-04-24T00:00:00Z')
-# or update the sale record
-sale = call.sale
-sale.name = "Todd"
-sale.save
+# Call Sale Record
+
+old_sale = call.sale
+
+sale_fmt_str = "  %-10s %-10s %-15s %-5s %-5s %-10s"
+
+puts
+puts "Editing Sale on Call #{old_sale.call_id}"
+
+puts sale_fmt_str % ['', *%w(Date CSR Score Value Converted?)]
+puts sale_fmt_str % ['Existing',
+  old_sale.sale_date,
+  old_sale.name,
+  old_sale.score,
+  old_sale.value,
+  old_sale.conversion,
+]
+call.sale.release!
+
+new_sale = call.sale
+puts sale_fmt_str % ['Deleted',
+  new_sale.sale_date,
+  new_sale.name,
+  new_sale.score,
+  new_sale.value,
+  new_sale.conversion,
+]
+
+new_sale = call.sale
+new_sale.name = 'The Doctor'
+new_sale.score = 5
+new_sale.conversion = true
+new_sale.value = 12
+new_sale.sale_date = Date.today.to_s
+
+puts sale_fmt_str % ['Unsaved',
+  new_sale.sale_date,
+  new_sale.name,
+  new_sale.score,
+  new_sale.value,
+  new_sale.conversion,
+]
+
+new_sale.save
+
+new_sale = call.sale
+puts sale_fmt_str % ['Refresh',
+  new_sale.sale_date,
+  new_sale.name,
+  new_sale.score,
+  new_sale.value,
+  new_sale.conversion,
+]
+
+old_sale.save
+new_sale = call.sale
+
+puts sale_fmt_str % ['Restore',
+  new_sale.sale_date,
+  new_sale.name,
+  new_sale.score,
+  new_sale.value,
+  new_sale.conversion,
+]
 
 ```

data/ctm.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = "ctm"
-  s.version = "0.4.4"
-  s.authors = ["CallTrackingMetrics", "Todd Fisher"]
+  s.version = "0.5.0"
+  s.authors = ["CallTrackingMetrics", "Todd Fisher", "Morgen Peschke"]
   s.email = "info@calltrackingmetrics.com"
   s.files = `git ls-files`.split("\n")
   s.test_files = `git ls-files -- {test}/*`.split("\n")
@@ -17,4 +17,3 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'fakeweb', '~> 1.3.0'
   s.add_development_dependency "rake"
 end
-

data/examples/example.rb

@@ -1,38 +1,380 @@
 $:.unshift(File.expand_path(File.join(File.dirname(__FILE__),"..", "lib")))
 require 'ctm'
 
+# Authentication
+
 access_token = CTM::Auth.authenticate(ENV['CTM_TOKEN'], ENV['CTM_SECRET'])
-puts "Accounts you have access to:"
-access_token.accounts.each do|account|
-  puts "#{account.name} -> #{account.status}, #{account.balance}, #{account.stats.inspect}"
+
+account = access_token.accounts.first
+number  = account.numbers.first
+
+# Accounts
+
+puts "Accounts you have access to (#{access_token.accounts.total_entries}):"
+access_token.accounts.each do|a|
+  puts "  #{a.name} -> #{a.status}, #{a.balance}"
 end
+
+puts
+puts "Select an account:"
 account = access_token.accounts.first
+puts "  First account: #{account.name}"
 
+account = access_token.accounts.find('name' => 'CallTrackingMetrics').first
+puts "  Found by name: #{account.name}"
+
+# Tracking Numbers
+
+puts
 numbers = account.numbers
-puts "Tracking Numbers #{numbers.total_entries} within the Account"
-numbers.each do|number|
-  puts "#{number.id}: #{number.name} #{number.number} -> #{number.formatted}"
+puts "Tracking Numbers within the Account (#{numbers.total_entries}):"
+
+puts "  Page %-67s %-14s Formatted" % ["ID", "Number"]
+numbers.each_with_index do|n, i|
+  break if i > 4
+  puts "  %-4d %s %-14s %s" % [numbers.page, n.id, n.number, n.formatted]
+end
+
+puts '  ...'
+
+numbers.page = numbers.total_pages
+numbers.entries.reverse.each_with_index do|n, i|
+  break if i > 4
+  puts "  %-4d %s %-14s %s" % [numbers.page, n.id, n.number, n.formatted]
+end
+
+puts
+puts "Modify routing preferences"
+[:round_robin, :least_connected, :simultaneous].each do |routing|
+  number.routing = routing
+  puts "  #{number.formatted} currently uses #{number.routing} routing"
+end
+
+# Receiving Numbers
+
+numbers = account.receiving_numbers
+puts
+puts "Receiving Numbers within the Account (#{numbers.total_entries}):"
+
+puts "  Page %-67s %-14s Formatted" % ["ID", "Number"]
+numbers.each_with_index do|n, i|
+  break if i > 4
+  puts "  %-4d %s %-14s %s" % [numbers.page, n.id, n.number, n.formatted]
+end
+
+puts '  ...'
+
+numbers.page = numbers.total_pages
+numbers.entries.reverse.each_with_index do|n, i|
+  break if i > 4
+  puts "  %-4d %s %-14s %s" % [numbers.page, n.id, n.number, n.formatted]
+end
+
+receiving_number = account.receiving_numbers.create(
+  name: 'demo number', number: '+18008675309'
+)
+
+puts
+puts "Adding #{receiving_number.formatted}"
+number.receiving_numbers.add receiving_number
+
+puts "Receiving Numbers for #{number.formatted}"
+number.receiving_numbers.each_page do |page|
+  page.each.map {|n| puts "  #{n.formatted}"}
+end
+
+puts
+puts "Removing #{receiving_number.formatted}"
+number.receiving_numbers.rem receiving_number
+
+puts "Receiving Numbers for #{number.formatted}"
+number.receiving_numbers.each_page do |page|
+  page.each {|n| puts "  #{n.formatted}"}
+end
+
+puts "Releasing #{number.formatted}"
+receiving_number.release!
+
+# Purchasing Numbers
+
+puts
+puts "Search for numbers to buy:"
+
+puts "  Country Region PostalCode TollFree Number"
+matches = account.numbers.search("US", searchby: 'tollfree')
+
+total_tollfree = matches.total_entries
+
+matches.each_with_index do |n, i|
+  break if i > 10
+  puts "  %-7s %-6s %-10s %-8s %s" % [n.iso_country,
+                                      n.region, n.postal_code,
+                                      'Yes', n.friendly_name]
 end
-receiving_numbers = account.receiving_numbers
-puts "Receiving Numbers #{receiving_numbers.total_entries} within the Account"
-receiving_numbers.each do|number|
-  puts "#{number.id}: #{number.name} #{number.number} -> #{number.formatted}"
+puts '  ...'
+
+matches = account.numbers.search("US",
+  region: 'SC',
+  areacode: 910,
+  pattern: '802'
+)
+
+total_local = matches.total_entries
+
+matches.each_with_index do |n,i|
+  break if i > 10
+  puts "  %-7s %-6s %-10s %-8s %s" % [n.iso_country,
+                                  n.region, n.postal_code,
+                                  'No', n.friendly_name]
 end
+puts '  ...'
+
+puts
+puts "Found #{total_local} local numbers."
+puts "Found #{total_tollfree} toll-free numbers."
+
+puts
+puts "Purchase a number"
+begin
+  number = account.numbers.buy matches.first.phone_number
+  puts "Successfully purchased the number: #{number.number}"
+
+  similar_numbers = account.numbers('number' => number.number)
+  puts "  Search for active numbers matching %s gives %d results:" % [
+    number.number, similar_numbers.total_entries
+  ]
+  similar_numbers.each_page do |p| p.each {|n| puts "    #{n.number}" }
+  end
+
+  number.release!
+  puts "Released number: #{number.number}"
+
+  similar_numbers = account.numbers('number' => number.number)
+  puts "  Search for active numbers matching %s gives %d results:" % [
+    number.number, similar_numbers.total_entries
+  ]
+  similar_numbers.each_page do |p| p.each {|n| puts "    #{n.number}" }
+  end
+
+rescue CTM::Error::Buy => e
+  puts "Failed to purchase number (#{number.number}): #{e.message}"
+end
+
+# Tracking Sources
 
 sources = account.sources
-puts "Tracking Sources #{sources.total_entries} within the Account"
-sources.each do|source|
-  puts "#{source.id}: #{source.name} #{source.referring_url} -> #{source.landing_url}"
+
+puts
+puts "Tracking Sources within the Account (#{sources.total_entries})"
+puts "  Page %-5s %-30s Referring URL -> Landing URL" % ["ID","Name"]
+1.upto(sources.total_pages) do |page|
+  sources.page = page
+  sources.each do|source|
+    puts "  %-4d %-5d %-30s '%s' -> '%s'" % [
+      sources.page, source.id,
+      source.name,
+      source.referring_url, source.landing_url]
+  end
 end
 
+src = account.sources.find(name: 'Direct').first
+id  = src.id
+
+puts
+puts "Customizing a source #{sources.filters.inspect}"
+
+puts "  Step   %-5s %-30s Referring URL -> Landing URL" % ["ID","Name"]
+puts "  Find   %-5d %-30s '%s' -> '%s'" % [src.id, src.name, src.referring_url, src.landing_url]
+
+src.landing_url   = "utm_campaign=DemoCampain"
+src.referring_url = "some_search_engine.com"
+src.name          = "Demo Source"
+puts "  Change %-5d %-30s '%s' -> '%s'" % [src.id, src.name, src.referring_url, src.landing_url]
+
+src.save
+src = sources.get(id)
+puts "  Save   %-5d %-30s '%s' -> '%s'" % [src.id, src.name, src.referring_url, src.landing_url]
+
+src.landing_url   = ""
+src.referring_url = ""
+src.name          = "Direct"
+src.save
+
+puts "  Revert %-5d %-30s '%s' -> '%s'" % [src.id, src.name, src.referring_url, src.landing_url]
+
+# Users
+
 users = account.users
-puts "Users #{users.total_entries} within the Account"
-users.each do|user|
-  puts "#{user.id}: #{user.name} #{user.email} -> #{user.role}"
+
+puts
+puts "Creating User with email: the.brave.johnny@example.com"
+jbravo = users.create(
+  first_name: 'Johnny',
+  last_name: 'Bravo',
+  email: 'the.brave.johnny@example.com',
+  role: 'admin',
+  notify: false
+).id
+
+puts
+puts "Users within the Account (#{users.total_entries})"
+puts "  %-40s %-20s %-20s %s" % %w(ID Name Role Email)
+
+users.each_page do |page|
+  page.each do|user|
+    puts "  %-40s %-20s %-20s %s" % [user.id, user.name, user.role, user.email]
+  end
 end
 
-webhooks = account.webhooks
-puts "Webhooks #{webhooks.total_entries} within the Account"
-webhooks.each do|wh|
-  puts "#{wh.id}: #{wh.weburl} #{wh.with_resource_url} -> #{wh.position}"
+puts
+puts "Removing User: %s" % [ account.users.get(jbravo).release!['status'] ]
+
+# Webhooks
+
+ids = []
+
+puts
+puts "Creating webhook at start and end"
+ids << account.webhooks.create(
+  weburl: "http://example.com/new_call/start",
+  position: 'start'
+).id
+
+ids << account.webhooks.create(
+  weburl: "http://example.com/new_call/end",
+  position: 'end'
+).id
+
+puts "Webhooks in account (#{account.webhooks.total_entries}):"
+puts "  %-5s Position WebURL" % ["ID"]
+account.webhooks.each_page do |page|
+  page.each do |hook|
+    puts "  %-5s %-8s %s" % [hook.id, hook.position, hook.weburl]
+  end
+end
+
+puts "Releasing webhooks"
+ids.each do |i|
+  res = account.webhooks.get(i).release!
+
+  puts "  %s: %s" % [ i, res['status'] == 'deleted' ? res['status'] : res.inspect ]
 end
+
+# Calls
+
+call = account.calls.first
+call_fmt_str = "  %-8s %-20s %-15s %-10s %-10s %-20s %-12s %-20s %-20s %s"
+
+puts
+puts "Call Information:"
+
+puts call_fmt_str % %w(ID Source Likelihood TalkTime RingTime CalledAt DialStatus CallerNumber CallerName Notes)
+puts call_fmt_str % [
+  call.id,
+  call.source,                               call.likelihood,
+  call.talk_time,                            call.ring_time,
+  call.called_at.split(' ')[0..1].join(' '), call.dial_status,
+  call.caller_number_format,                 call.name,
+  call.notes
+]
+
+puts
+puts "Adding note to call:"
+old_note = call.notes
+id = call.id
+call.notes = "Test Note!"
+
+puts call_fmt_str % %w(ID Source Likelihood TalkTime RingTime CalledAt
+DialStatus CallerNumber CallerName Notes)
+puts call_fmt_str % [
+  call.id,
+  call.source,                               call.likelihood,
+  call.talk_time,                            call.ring_time,
+  call.called_at.split(' ')[0..1].join(' '), call.dial_status,
+  call.caller_number_format,                 call.name,
+  call.notes
+]
+
+call.save
+
+call = account.calls.get id
+puts
+puts "Deleting note from call:"
+puts call_fmt_str % %w(ID Source Likelihood TalkTime RingTime CalledAt
+DialStatus CallerNumber CallerName Notes)
+puts call_fmt_str % [
+  call.id,
+  call.source,                               call.likelihood,
+  call.talk_time,                            call.ring_time,
+  call.called_at.split(' ')[0..1].join(' '), call.dial_status,
+  call.caller_number_format,                 call.name,
+  call.notes
+]
+
+call.notes = old_note
+call.save
+
+# Call Sale Record
+
+old_sale = call.sale
+
+sale_fmt_str = "  %-10s %-10s %-15s %-5s %-5s %-10s"
+
+puts
+puts "Editing Sale on Call #{old_sale.call_id}"
+
+puts sale_fmt_str % ['', *%w(Date CSR Score Value Converted?)]
+puts sale_fmt_str % ['Existing',
+  old_sale.sale_date,
+  old_sale.name,
+  old_sale.score,
+  old_sale.value,
+  old_sale.conversion,
+]
+call.sale.release!
+
+new_sale = call.sale
+puts sale_fmt_str % ['Deleted',
+  new_sale.sale_date,
+  new_sale.name,
+  new_sale.score,
+  new_sale.value,
+  new_sale.conversion,
+]
+
+new_sale = call.sale
+new_sale.name = 'The Doctor'
+new_sale.score = 5
+new_sale.conversion = true
+new_sale.value = 12
+new_sale.sale_date = Date.today.to_s
+
+puts sale_fmt_str % ['Unsaved',
+  new_sale.sale_date,
+  new_sale.name,
+  new_sale.score,
+  new_sale.value,
+  new_sale.conversion,
+]
+
+new_sale.save
+
+new_sale = call.sale
+puts sale_fmt_str % ['Refresh',
+  new_sale.sale_date,
+  new_sale.name,
+  new_sale.score,
+  new_sale.value,
+  new_sale.conversion,
+]
+
+old_sale.save
+new_sale = call.sale
+
+puts sale_fmt_str % ['Restore',
+  new_sale.sale_date,
+  new_sale.name,
+  new_sale.score,
+  new_sale.value,
+  new_sale.conversion,
+]

data/examples/record_sale.rb

@@ -5,6 +5,6 @@ require 'set'
 access_token = CTM::Auth.authenticate(ENV['CTM_TOKEN'], ENV['CTM_SECRET'])
 account = access_token.accounts.first
 
-call =  account.calls.get(692389)
+call =  account.calls.get(3446138)
 
 call.record_sale({value:100, conversion: true})

data/lib/ctm/account.rb

@@ -5,7 +5,7 @@ module CTM
 
     def initialize(data, token=nil)
       super(data, token)
-      puts data.inspect
+      #puts data.inspect
       @id = data['id']
       @name = data['name']
       @status = data['status']

data/lib/ctm/auth.rb

@@ -1,7 +1,7 @@
 module CTM
   class Auth
     include HTTParty
-    base_uri ENV["CTM_URL"] || "api.calltrackingmetrics.com"
+    base_uri "https://#{(ENV["CTM_URL"] || "api.calltrackingmetrics.com")}"
 
     def self.token=(token)
       @token = token

data/lib/ctm/base.rb

@@ -12,7 +12,7 @@ module CTM
     end
 
     include HTTParty
-    base_uri ENV["CTM_URL"] || "api.calltrackingmetrics.com"
+    base_uri "https://#{(ENV["CTM_URL"] || "api.calltrackingmetrics.com")}"
 
     attr_reader :token, :account_id
 
@@ -20,7 +20,11 @@ module CTM
     def initialize(data, token=nil)
       @token = token || CTM::Auth.token
       @account_id = data['account_id']
-      @list_token_type = self.class.to_s.sub(/CTM::/,'').underscore.pluralize
+      @list_token_type = case self.class.to_s
+                         when 'CTM::Sale' then 'calls'
+                         else
+                           self.class.to_s.sub(/CTM::/,'').underscore.pluralize
+                         end
       if @account_id
         @list_type_path = "accounts/#{@account_id}/#{@list_token_type}"
       else
@@ -29,15 +33,16 @@ module CTM
     end
 
     def save(options={})
-      puts "save: #{options.inspect}"
+      #puts "save: #{options.inspect}"
       path_str = "/api/v1/#{@list_type_path}/#{@id}.json"
-      puts path_str
-      res = self.class.put(path_str, :body => options.merge(:auth_token => @token))
+      #puts path_str
+      self.class.put(path_str, :body => options.merge(:auth_token => @token))
     end
 
     def release!
       path_str = "/api/v1/#{@list_type_path}/#{@id}.json"
       res = self.class.delete(path_str, :body => {:auth_token => @token})
+      res.parsed_response
     end
 
     def self.create(options)
@@ -46,10 +51,10 @@ module CTM
       account_id = options.delete(:account_id)
       token = options.delete(:token)
       path_str = "/api/v1/#{list_type_path}.json"
-      puts "create: #{self}(#{path_str}) -> #{options.inspect}"
+      #puts "create: #{self}(#{path_str}) -> #{options.inspect}"
       res = self.post(path_str, :body => options.merge(:auth_token => token))
-      puts "result: #{res.parsed_response.inspect}"
-      puts "properties: #{list_type_path.inspect} -> #{list_token_type.inspect} -> #{account_id}"
+      #puts "result: #{res.parsed_response.inspect}"
+      #puts "properties: #{list_type_path.inspect} -> #{list_token_type.inspect} -> #{account_id}"
       if res.parsed_response['status'] == 'error'
         raise CTM::Error::Create.new(res.parsed_response['reason'])
       else

data/lib/ctm/call.rb

@@ -4,12 +4,12 @@ module CTM
       :id, :account_id, :search, :referrer, :location, :source,
       :likelihood, :duration, :talk_time, :ring_time, :called_at, :tracking_number, :business_number,
       :dial_status, :caller_number_split, :excluded, :tracking_number_format, :business_number_format,
-      :caller_number_format, :audio, :tag_list, :latitude, :longitude, :extended_lookup, :sale
+      :caller_number_format, :audio, :tag_list, :latitude, :longitude, :extended_lookup
     ]
     ReadWriteFields = [
       :name, :email, :street, :city, :state, :country, :postal_code, :notes
     ]
-    attr_reader *ReadOnlyFields 
+    attr_reader   *ReadOnlyFields
     attr_accessor *ReadWriteFields
 
     # {"id":729485,"account_id":25,"name":"Escondido    Ca","search":null,"referrer":null,"location":null,"source":"Facebook","source_id":36,"likelihood":null,"duration":25,
@@ -29,20 +29,33 @@ module CTM
       end
     end
 
-    def record_sale(sale_detail)
-      path_str = "/api/v1/#{@list_type_path}/#{self.id}/sale.json"
-      post_options = {}
-      sale_detail.each do|k,v|
-        if k.to_s == 'conversion'
-          v = v ? 'on' : 'off'
-        end
-        post_options[k] = v
+    def save(options={})
+      #puts "save: #{options.inspect}"
+      path_str = "/api/v1/#{@list_type_path}/#{@id}/modify.json"
+
+      save_options = {}
+      ReadWriteFields.each do |field|
+        save_options[field == :notes ? :comments : field] = self.send field
       end
-      res = self.class.post(path_str, :body => post_options.merge(:auth_token => @token))
-      (res && res['status'] == 'success')
+
+      options[:call] = (options[:call] || {}).merge save_options
+
+      #puts path_str
+      self.class.put(path_str, :body => options.merge(:auth_token => @token))
     end
 
-    def update_sale(sale_detail)
+    def sale
+      path_str = "/api/v1/#{@list_type_path}/#{self.id}/sale.json"
+
+      res  = self.class.get path_str, query: {auth_token: @token}
+      data = res.parsed_response
+      if data["status"] && data["status"] == "error"
+        raise CTM::Error::Sale.new(data["message"] || data ["reason"])
+      end
+
+      data['account_id'] = @account_id
+      data['call_id'] ||= self.id
+      CTM::Sale.new(data, @token)
     end
 
   end

data/lib/ctm/error.rb

@@ -12,5 +12,7 @@ module CTM
     end
     class Rem < Exception
     end
+    class Sale < Exception
+    end
   end
 end

data/lib/ctm/list.rb

@@ -4,9 +4,12 @@ module CTM
     include Enumerable
 
     include HTTParty
-    base_uri ENV["CTM_URL"] || "api.calltrackingmetrics.com"
+    base_uri "https://#{(ENV["CTM_URL"] || "api.calltrackingmetrics.com")}"
 
-    attr_reader :list_type, :token, :per_page, :page, :total_entries, :objects
+    attr_reader :list_type, :token, :total_entries, :objects
+    attr_reader :per_page, :page, :total_pages
+
+    attr_reader :filters
 
     # e.g. Account, token
     def initialize(list_type, options={}, token=nil, fetched_objects=nil)
@@ -23,16 +26,32 @@ module CTM
 
       @fetched_objects = fetched_objects
       @options = options
+      @filters = {}
+      load_records
+    end
+
+    def page=(num)
+      @options[:page] = num.to_i
+      fetch_page(@options) unless @options[:page] == @page
+      @page
     end
 
-    def each &block
+    def each_page
+      # Trick to allow .each_page.each_with_index from:
+      # http://stackoverflow.com/a/18089712
+      return to_enum(:each_page) unless block_given?
+
+      1.upto(@total_pages) do |pnum|
+        self.page = pnum
+        yield self
+      end
+    end
+
+    def each
+      return to_enum(:each) unless block_given?
       load_records
       @objects.each do |obj|
-        if block_given?
-          block.call obj
-        else
-          yield obj
-        end
+        yield obj
       end
     end
 
@@ -43,12 +62,16 @@ module CTM
                                          token: @token))
     end
 
-    def find(options)
+    def find(options = {})
+      return self unless options.class == Hash
+
       first_name = options.delete(:first_name)
       last_name  = options.delete(:last_name)
       options[:filter] = options.delete(:filter) || "#{first_name} #{last_name}".strip if first_name || last_name
 
-      fetch_page(options)
+      @filters = options
+
+      self.page = 1
       self
     end
 
@@ -56,7 +79,7 @@ module CTM
       path_str = "/api/v1/#{@list_type_path}/#{recordid}.json"
       res = self.class.get(path_str, query: options.merge(auth_token: @token))
       data = res.parsed_response
-      @object_klass.new(data, @token) 
+      @object_klass.new(data, @token)
     end
 
   protected
@@ -70,7 +93,7 @@ module CTM
     end
 
     def fetch_page(options={})
-      options = {per_page: 10, page: 1}.merge(options)
+      options = {per_page: 10, page: 1}.merge(options).merge(@filters)
       path_str = "/api/v1/#{@list_type_path}.json"
       res = self.class.get(path_str, query: options.merge(auth_token: @token))
       data = res.parsed_response
@@ -78,15 +101,17 @@ module CTM
         puts data.inspect
         raise CTM::Error::List.new(data["message"] || data["reason"])
       end
+
+      @page = options[:page]
+      @per_page = options[:per_page]
       map_data(data)
     end
 
     def map_data(data)
-      @page = data['page']
-      @per_page = data['per_page']
       @total_entries = data['total_entries']
+      @total_pages   = data['total_pages']
       @objects = data[@list_token_type].map {|obj|
-        @object_klass.new(obj, @token) 
+        @object_klass.new(obj, @token)
       }
     end
 

data/lib/ctm/number_list.rb

@@ -42,7 +42,7 @@ module CTM
     # add trackng number to tracking source
     def add(number)
       path_str = "/api/v1/#{@list_type_path}/#{number.id}/add.json"
-      puts "Add to #{@account_id}:#{@source_id} -> #{number.id} -> #{path_str}"
+      #puts "Add to #{@account_id}:#{@source_id} -> #{number.id} -> #{path_str}"
       #         accounts/25          /sources/5012     /numbers
       # /api/v1/accounts/:account_id/sources/:source_id/numbers/:id/add
       res = self.class.post(path_str, :body => {}.merge(:auth_token => @token))
@@ -54,10 +54,10 @@ module CTM
       end
     end
 
-    def rem
-      puts "Rem to #{@account_id}:#{@source_id} -> #{number.id} -> #{@list_type_path}"
-      # /api/v1/accounts/:account_id/sources/:source_id/numbers/:id/rem
-    end
+    # def rem(number)
+    #   puts "Rem to #{@account_id}:#{@source_id} -> #{number.id} -> #{@list_type_path}"
+    #   # /api/v1/accounts/:account_id/sources/:source_id/numbers/:id/rem
+    # end
 
   end
 end

data/lib/ctm/sale.rb

@@ -1,7 +1,53 @@
 module CTM
-  class Sale
+  class Sale < Base
+    ReadWriteFields = [:conversion,
+                       :sale_date,        :score,
+                       :service_rep_name, :value]
 
-    def initialize
+    attr_reader :call_id
+    attr_accessor(*ReadWriteFields)
+
+    def initialize(data, token=nil)
+      super(data, token)
+
+      [ :call_id, *ReadWriteFields].each do |k|
+        instance_variable_set "@#{k}", data[k.to_s]
+      end
+    end
+
+    def name
+      @service_rep_name
+    end
+
+    def name=(n)
+      @service_rep_name = n
+      @service_rep_name
+    end
+
+    def release!
+      path_str ="/api/v1/#{@list_type_path}/#{@call_id}/sale.json"
+      res = self.class.delete path_str, body: {auth_token: @token}
+      res.parsed_response
+    end
+
+    def save(options = {})
+      path_str = "/api/v1/#{@list_type_path}/#{@call_id}/sale.json"
+      options = {}
+      ReadWriteFields.each do |k|
+        v = self.send k
+        case k.to_s
+        when 'conversion' then v = v ? 'on' : 'off'
+        when 'service_rep_name' then k = :name
+        end
+        options[k] = v
+      end
+      options[:id] = @call_id
+
+      #self.class.debug_output $stderr
+      res = self.class.post path_str, body: options.merge(auth_token: @token)
+      #self.class.debug_output nil
+      return nil unless res
+      (res['status'] == 'success') ? true : (res['message'] || res['reason'])
     end
 
   end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: ctm
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
 - CallTrackingMetrics
 - Todd Fisher
+- Morgen Peschke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-05 00:00:00.000000000 Z
+date: 2014-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phony