callrail 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd73d225bdbb90aa0d860e9d9ba37f941e64c462
-  data.tar.gz: 839626a6a127edd4fefc5120aab59d712cd9dd83
+  metadata.gz: 5c9cd2fba229327d4939c9bd9f2589ea5726d723
+  data.tar.gz: 27e3c89b69a800d909ce2599ea46560426c8f6c2
 SHA512:
-  metadata.gz: e7ffeeb5932ddf2bbd4ba02481a09296d65370e00f5a9c922f09412821fa2052564e67016d360bfcfb6925fe4d0ef9ce0b05b467c2e1105418524519ab8aaeaf
-  data.tar.gz: 63b7abc2bac27d3ab965455e53aee3c17e449c3e91fd24a707a654ec0da335e8941ea75d8d0d2093f2e8bf6fd801b3177693b8b5b698b4c9d905901cba61fbb0
+  metadata.gz: d1b76a79bf2c890de8ef7d2a83ac89835b10af5147170fe78b39a576c02666897a889d1150a86ea81416e6de214494e844e7205e78c31f87923bea2e140a7adf
+  data.tar.gz: a7e93903741442bbf01cd0ee18cf64106ea84db7925dc45ab67f389ad3650b10076afa58474f55e0fdf21b239ba0b1de0661d4fe812ec966b15a4e02e3960434

data/.gitignore

@@ -10,4 +10,5 @@
 # rspec failure tracking
 .rspec_status
 
-test.rb
+test.rb
+*.gem

data/README.md

@@ -22,7 +22,140 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+* *Examples of what is currently enabled
+
+###### Setting Connection
+```ruby
+opts = {}
+opts[:key] = "<Your Callrail API Key>"
+opts[:account_id] = <your_account_id> 
+```
+* * Account ID is optional for the initial connection. You can set the account id later if you need to retrieve it first.
+
+``` testcon = Callrail::Api.new(:key => opts[:key]) ```
+
+
+
+###### Get Accounts
+``` testcon.get_accounts ```
+
+
+###### Set Specific Account
+
+```
+opts[:account_id] = <your_account_id>
+testcon.set_account_id(:account_id => opts[:account_id])
+```
+** Account ID must be set for everything but Get Accounts
+
+###### Get Companies
+
+```testcon.get_companies() ```
+
+###### Get a specific Company 
+``` opts[:company_id] = <company_id> ```
+``` testcon.get_companies(:company_id => opts[:company_id]) ```
+
+###### Create a Company
+```
+opts = {}
+opts[:name] = "XXX - Test Company 1"
+opts[:time_zone] = "America/Los_Angeles" # 
+testcon.create_company(:name => opts[:name])
+```
+
+
+###### Update a Company
+```
+opts = {}
+opts[:name] = "XXX - Test Company 2"
+opts[:company_id] = <company_id> 
+# opts[:time_zone] = "America/Phoenix"
+# opts[:callscore_enabled] = false
+# opts[:keyword_spotting_enabled] = false
+# opts[:callscribe_enabled] = false
+# opts[:swap_exclude_jquery] = true
+# opts[:swap_ppc_override] = false
+# opts[:swap_landing_override] = nil
+# opts[:swap_cookie_duration] = 90
+testcon.update_company(:company_id => opts[:company_id], :time_zone => opts[:time_zone] )
+```
+
+###### Disable a Company
+```
+opts = {}
+opts[:company_id] = <company_id>
+testcon.disable_company(:company_id => opts[:company_id] = <company_id>)
+```
+###### Get Users
+``` testcon.get_users ```
+
+###### Get Specific User
+```
+opts[:user_id] = <user_id>
+testcon.get_users(:user_id => opts[:user_id] )
+```
+
+###### Create User
+```
+user_opts ={}
+user_opts[:first_name] = "User"
+user_opts[:last_name] = "Test"
+user_opts[:email] = "test@test.com"
+user_opts[:role] = "reporting"      
+user_opts[:password] = '<password>'
+user_opts[:companies] = [<company_id>, <company_id2>, <company_id3>]
+testcon.create_user(user_opts)
+```
+
+###### Update a user
+```
+user_opts[:user_id] = <user_id>
+user_opts[:last_name] = "Test2"
+testcon.update_user(user_opts)
+```
+
+###### Get Trackers
+```
+tracker_options = {}
+testcon.get_trackers(tracker_options)
+```
+
+###### Get Trackers for a Company
+```
+tracker_options[:company_id] = <company_id>
+testcon.get_trackers(tracker_options)
+```
+
+###### Get a specific tracker
+```
+tracker_options = {}
+tracker_options[:tracker_id] = <tracker_id>
+testcon.get_trackers(tracker_options)
+```
+
+###### Tracker Filtering
+```
+tracker_options = {}
+tracker_options[:filtering] = [{:field => "type", :value => "source"},{:field => "status", :value => "active"}]
+puts "Filters: 1. #{tracker_options[:filtering][0][:field]} =  #{tracker_options[:filtering][0][:value]} 2. #{tracker_options[:filtering][1][:field]} =  #{tracker_options[:filtering][1][:value]}  "
+testcon.get_trackers(tracker_options)
+```
+
+###### Create a Source Tracker
+```
+tracker_options = {}
+tracker_options[:name] = "Test Source tracker"
+tracker_options[:type] = "source"
+tracker_options[:company_id] = <company_id>
+tracker_options[:call_flow] = {:type => "basic", :recording_enabled => true, :destination_number => "+15555555555", :greeting_text => nil, :greeting_recording_url => nil}
+tracker_options[:tracking_number] = {:area_code => "555", :local => "+15555555555"}
+tracker_options[:source] = {:type => "all"}
+tracker_options[:sms_enabled] = true
+tracker_options[:whisper_message] = "This is a test number call"
+testcon.create_tracker(tracker_options)
+```
+
 
 ## Development
 

data/lib/callrail.rb

@@ -20,7 +20,7 @@ module Callrail
     end    
 
     def parse_json(response)
-      body = JSON.parse(response.to_str) if response.code == 200
+      body = JSON.parse(response.to_str) if response.code == 200 || response.code == 201
       OpenStruct.new(code: response.code, body: body)
     end
 
@@ -144,7 +144,7 @@ module Callrail
       params = set_params(opts)
       path = "/" + @account_id + "/companies.json"
       response = parse_json(RestClient.post(@url+path, params ,:Authorization => @auth))
-      return response.code    
+      return response   
     end
 
     def update_company(opts = {})
@@ -170,7 +170,7 @@ module Callrail
       params = set_params(opts)
       path = "/" + @account_id + "/users.json"
       response = parse_json(RestClient.post(@url+path, params ,:Authorization => @auth))
-      return response.code  
+      return response 
     end
 
     def update_user(opts = {})
@@ -190,7 +190,7 @@ module Callrail
       opts[:path] = "/" + @account_id + "/trackers.json"
       params = set_params(opts)
       response = parse_json(RestClient.post(@url+opts[:path], params ,:Authorization => @auth))
-      return response.code  
+      return response 
     end
 
     def update_tracker(opts={})

data/lib/callrail/version.rb

@@ -1,3 +1,3 @@
 module Callrail
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: callrail
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Michael Hoskison
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-27 00:00:00.000000000 Z
+date: 2018-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler