marchex 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0dd04c01da60af405506c24cc747523fdb9a8808
-  data.tar.gz: 4fedaf92eb9ffa1a8db6fd9e063587d191e60030
+  metadata.gz: 9d8f6534c0873d81a815890a1bd5cd739c8a99fa
+  data.tar.gz: d589ec0ecd5f51b50c2b9973c55408321d3298ce
 SHA512:
-  metadata.gz: 6ce053b434135452bbf8a474e9ae5d0d23ca53a3b1b8b85388892181cd6efa5ec86408c687907e3277d0b5d182cbffa76703db5619e30e4c845f74dc7cd6190c
-  data.tar.gz: 54f5ac131288ea78fbca2b9251f027cf1bb99043ef722948fd7f3fa8c08b58a56cf5ec50c837d85bcf243dbe2876c81034c4c8936912b99d49cd64209e323685
+  metadata.gz: 607dff4dc79e1f0f9497d88c37bc0de99fbacf3c6e7edcc1af26c0b29afdd9074e6b4501d6eee0929de1f8e6117b0ee669ae5d8ba2c2df67bad14a433a1fdd49
+  data.tar.gz: 1d72909a0e9acb711285f01fa41b41464d1cd743559127e5df428e1d07b6573ea087da6b71a2717e0fcc8647bcb511a051f63fdfcb7d43ba53cac2b3bb6d90d4

data/README.md

@@ -20,34 +20,43 @@ Or install it yourself as:
 
 ## Usage
 Create a connection using your Marchex account email address and password:
-
+```ruby
 @testcon = Marchex::Marchexapi.new("user@marchex.com", "password")
+```
+```@testcon.account_list ```
 
-# @testcon.account_list
     Retrieves all accounts       
 
-# @testcon.client_ad_list(client_id, status)
+``` @testcon.client_ad_list(client_id, status) ```
+
     Retrieves all ad campaigns for a client account. If disabled or active is passed for the status, only those ads will be returned. 
       
-# @testcon.ad_forward_list(campaign_id)
+``` @testcon.ad_forward_list(campaign_id) ```
+
     Retrieves all forwarding numbers for a single ad campaign
 
-# @testcon.ad_record_status(campaign_id)
+``` @testcon.ad_record_status(campaign_id) ```
+
     Checks if an ad campaign is set to record
        
-# @testcon.user_list(account_id)
+``` @testcon.user_list(account_id)```
+
     List all users in a client account
       
-# @testcon.user_permissions(user_id)
+``` @testcon.user_permissions(user_id) ```
+
     Grab permissions to see if a user is an admin
       
-# @testcon.ad_custom_define(acc_id,field_number, field_name, field_type, field_values)
+``` @testcon.ad_custom_define(acc_id,field_number, field_name, field_type, field_values) ```
+    
     Define a custom field for an ad 
 
-# @testcon.ad_custom_set(acc_id, campaign_id, field_name, field_value)   
+``` @testcon.ad_custom_set(acc_id, campaign_id, field_name, field_value)   ```
+ 
     Set the value of a custom field. For boolean, use yes/no
 
-# @testcon.call_search(search_options)
+``` @testcon.call_search(search_options) ```
+
         search_options = {}
         search_options[:acct_id] Required string. The unique, system-generated account ID of the specified account.
 
@@ -93,10 +102,12 @@ Create a connection using your Marchex account email address and password:
 
         search_options[:subacct] Optional boolean. true to search all calls in all client accounts of the specified parent account.
 
-# @testcon.get_call(call_id)
+``` @testcon.get_call(call_id) ```
+
     Return details for a single call
 
-# @testcon.get_call_audio(call_id, audio_format)
+``` @testcon.get_call_audio(call_id, audio_format) ```
+
     Gets a Base64-encoded string that contains the audio data of the specified call, in the specified format. (mp3 or wav)
 
 ## Development

data/lib/marchex.rb

@@ -11,21 +11,21 @@ require 'rest-client'
 module Marchex
   class Marchexapi
 
-      #RestClient.log = 'stdout' #Debugging API calls
+      RestClient.log = 'stdout' #Debugging API calls
 
       def initialize(u, p)
         @url = 'https://userapi.voicestar.com/api/jsonrpc/1'
-        $auth = 'Basic ' + Base64.encode64(u + ':' + p).chomp      
+        @auth = 'Basic ' + Base64.encode64(u + ':' + p).chomp      
       end
 
 
       def account_list()
-        response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'acct.list', 'params' => [] }.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => $auth))
+        response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'acct.list', 'params' => [] }.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => @auth))
         
       end
 
       def client_ad_list(client_id, status ='')
-        response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'ad.list.all', 'params' => [client_id, {'status' => status.downcase}]}.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => $auth))
+        response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'ad.list.all', 'params' => [client_id, {'status' => status.downcase}]}.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => @auth))
 
       end  
       
@@ -35,31 +35,31 @@ module Marchex
       end
 
       def ad_forward_list(campaign_id)
-       response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'ad.forw.list', 'params' => [campaign_id]}.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => $auth))
+       response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'ad.forw.list', 'params' => [campaign_id]}.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => @auth))
       end 
 
       def ad_record_status(campaign_id)
-       response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'ad.recordcall.get', 'params' => [campaign_id]}.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => $auth))
+       response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'ad.recordcall.get', 'params' => [campaign_id]}.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => @auth))
        return response.body["result"]
       end
 
       def user_list(account_id)
-       response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'user.list', 'params' => [account_id]}.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => $auth))
+       response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'user.list', 'params' => [account_id]}.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => @auth))
        return response.body["result"]
       end
 
       def user_permissions(user_id)
-       response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'user.permissions.get', 'params' => [user_id]}.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => $auth))
+       response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'user.permissions.get', 'params' => [user_id]}.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => @auth))
        return response.body["result"]
       end
 
       def ad_custom_define(acc_id,field_number, field_name, field_type, field_values)
-        response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'ad.custom.define', 'params' => [acc_id,field_number, field_name, field_type, field_values]}.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => $auth))
+        response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'ad.custom.define', 'params' => [acc_id,field_number, field_name, field_type, field_values]}.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => @auth))
        return response.body["result"]
       end
 
       def ad_custom_set(acc_id, campaign_id, field_name, field_value)
-        response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'ad.custom.set', 'params' => [acc_id,campaign_id, field_name, field_value]}.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => $auth))
+        response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'ad.custom.set', 'params' => [acc_id,campaign_id, field_name, field_value]}.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => @auth))
         return response.body["result"]
       end 
 
@@ -84,17 +84,17 @@ module Marchex
         search_options[:status] = opts[:status] if opts[:status]
         search_options[:spotted_keywords] = opts[:spotted_keywords] if opts[:spotted_keywords]
         search_options[:subacct] = opts[:subacct] if opts[:subacct]
-        response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'call.search', 'params' => [opts[:acct_id], search_options ]}.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => $auth))
+        response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'call.search', 'params' => [opts[:acct_id], search_options ]}.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => @auth))
         return response.body["result"]
       end
 
       def get_call (call_id)      
-        response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'call.get', 'params' => [call_id]}.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => $auth))
+        response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'call.get', 'params' => [call_id]}.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => @auth))
         return response.body["result"]
       end
 
       def get_call_audio(call_id, audio_format)
-        response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'call.audio', 'params' => [call_id, audio_format]}.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => $auth))
+        response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'call.audio', 'params' => [call_id, audio_format]}.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => @auth))
         return response.body["result"]
       end
 

data/lib/marchex/version.rb

@@ -1,3 +1,3 @@
 module Marchex
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/marchex.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
 
-  spec.add_dependency "rest-client", "~> 1.8.0"
-  spec.add_dependency "json", "~> 1.8.1"
+  spec.add_dependency "rest-client", "~> 2.0.2"
+  spec.add_dependency "json", "~> 2.1.0"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marchex
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Michael Hoskison
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-06 00:00:00.000000000 Z
+date: 2017-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 2.1.0
 description: Marchex JSON API
 email:
 - mhoskison@etnainteractive.com
@@ -105,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Used to work with the Marchex API