vivialconnect 0.0.1

data/lib/vivialconnect/configuration.rb

@@ -0,0 +1,172 @@
+module VivialConnect 
+  ##
+  #=== .all
+  #
+  #Returns an array containing ruby objects corresponding to all Configuration resources on your account
+  #
+  #
+  # Example usage:
+  #
+  #
+  # VivialConnect::Configuration.all
+  # => [#<VivialConnect::Configuration account_id=1XXXX, active=true, date_created="2017-02-06T16:00:52-05:00", date_modified="2017-04-10T11:15:33-04:00", id=12, message_status_callback=nil, name="Message App Config", sms_fallback_method=nil, sms_fallback_url=nil, sms_method="POST", sms_url="http://requestb.in/174w8nz1">] 
+  # 
+  #
+  #
+  #===  .count
+  #
+  #Returns the amount of Configurations set up on your account
+  #
+  # Example usage:
+  #
+  #
+  # VivialConnect::Configuration.count
+  # => 1
+  #
+  #
+  ##
+  #=== .create(options={})
+  #
+  #Creates and returns a new Configuration 
+  #
+  #
+  # Required parameter:                                                                  
+  #  
+  # name  | String | "Taxi App Config"                   
+  #
+  #
+  # Optional parameters: for MMS                               
+  #
+  # phone_number            | String | "+1XXXXXXXXXX"
+  # message_status_callback | String | "https://myserver.example.com/status"
+  # sms_url                 | String | "https://myserver.example.com/url-for-fielding-incoming-message"
+  # sms_method              | String | "POST" or "GET" (default is POST)
+  # sms_fallback_url        | String | "https://myserver.example.com/url-if-sms_url-fails"
+  # sms_fallback_method     | String | "POST" or "GET" (default is POST)
+  #
+  # Example Usage
+  #
+  #
+  # VivialConnect::Configuration.create(name: "Taxi Messaging", message_status_callback: "https://myserver.example.com/status")
+  # => #<VivialConnect::Configuration account_id=1XXXXX, active=true, date_created="2017-04-21T15:44:28-04:00", date_modified="2017-04-21T15:44:28-04:00", id=55, message_status_callback="https://myserver.example.com/status", name="Taxi Messaging", sms_fallback_method=nil, sms_fallback_url=nil, sms_method=nil, sms_url=nil> 
+  #  
+  #
+  ##
+  #=== .find(id)
+  #
+  #Returns the a Configuration object referenced by the `id` value.
+  #
+  # Required parameter:
+  #
+  # id | Fixnum | the id of the configuration you would like to retrieve
+  #   
+  #
+  # Example usage:
+  #
+  #
+  # VivialConnect::Configuration.find(55)
+  # => #<VivialConnect::Configuration account_id=1XXXX, active=true, date_created="2017-04-21T15:44:28-04:00", date_modified="2017-04-21T15:44:28-04:00", id=55, message_status_callback="https://myserver.example.com/status", name="Taxi Messaging", sms_fallback_method=nil, sms_fallback_url=nil, sms_method=nil, sms_url=nil> 
+  #
+  #
+  ##
+  #=== .find_each(start: 1, finish: nil, batch_size: 150) 
+  #
+  #Iterates through all of the configurations on your account in N sized batches beginning at the `start: value` and ending at the `finish: value`. 
+  #
+  #
+  # When a block is given this method yields an individual Configuration object. 
+  # Without a block, this method returns an Enumerator. 
+  #
+  #
+  # By default, it will begin at the first configuration and end at the last configuration
+  # 
+  # 
+  # With default batch_size: 150, if you wanted to get your records from
+  # 150 to 300 you would start at 2 and finish at 2.
+  #
+  #
+  #Returns an Array of objects corresponding to the `start` and `finish` values. Default is all objects.
+  #
+  # Optional parameters:
+  #
+  # start      | Fixnum | batch to start with
+  # finish     | Fixnum | batch to end with
+  # batch_size | Fixnum | between 1..150
+  #
+  #   
+  #
+  # Example usage:
+  #
+  #
+  # VivialConnect::Configuration.find_each {|configuration| puts configuration.name}
+  # Taxi Messaging
+  # => [#<VivialConnect::Configuration account_id=1XXXX, active=true, date_created="2017-04-21T15:44:28-04:00", date_modified="2017-04-21T15:44:28-04:00", id=55, message_status_callback="https://myserver.example.com/status", name="Taxi Messaging", sms_fallback_method=nil, sms_fallback_url=nil, sms_method=nil, sms_url=nil>,  ...]
+  #
+  #
+  #
+  #
+  ##
+  #===  .find_in_batches(start: 1, finish: nil, batch_size: 150)  
+  # 
+  #Iterates through all of the configurations on your account in N sized batches beginning at the `start: value` and ending at the `finish: value`. 
+  # 
+  #
+  # When a block is given this method yields an array of batch_size resource objects. 
+  # Without a block, it returns an Enumerator.
+  #
+  #
+  # By default, it will begin at the first configuration and end at the last configuration
+  # 
+  # 
+  # With default batch_size: 150, if you wanted to get your records from
+  # 150 to 300 you would start at 2 and finish at 2.
+  #
+  # 
+  # Returns an Array of objects corresponding to the `start` and `finish` values. Default is all objects.
+  #
+  #  Optional parameters:
+  #
+  #  start      | Fixnum | batch to start with
+  #  finish     | Fixnum | batch to end with
+  #  batch_size | Fixnum | between 1..150
+  #   
+  #
+  #  Example usage:
+  #
+  #
+  #  VivialConnect::Configuration.find_in_batches {|batch| do_something_with_an_array(batch)}
+  #  => [#<VivialConnect::Configuration account_id=1XXXX, active=true, date_created="2017-04-21T15:44:28-04:00", date_modified="2017-04-21T15:44:28-04:00", id=55, message_status_callback="https://myserver.example.com/status", name="Taxi Messaging", sms_fallback_method=nil, sms_fallback_url=nil, sms_method=nil, sms_url=nil>,  ...]
+  #
+  #
+  #===  \#delete
+  #
+  # Deletes a Configuration object
+  #
+  #
+  # Example usage:
+  #
+  #
+  # configuration = VivialConnect::Configuration.find(55)
+  # configuration.delete
+  # => true
+  #
+  #   
+  #===  \#save
+  #
+  # Creates a Configuration or updates an existing one
+  #
+  #
+  # Example usage:
+  #
+  #
+  # configuration = VivialConnect::Configuration.new
+  # configuration.name = "Taxi Messaging"
+  # configuration.message_status_callback = "https://myserver.example.com/status"
+  # configuration.save 
+  # => #<VivialConnect::Configuration account_id=1XXXX, active=true, date_created="2017-04-21T15:44:28-04:00", date_modified="2017-04-21T15:44:28-04:00", id=55, message_status_callback="https://myserver.example.com/status", name="Taxi Messaging", sms_fallback_method=nil, sms_fallback_url=nil, sms_method=nil, sms_url=nil>
+  #
+  #
+
+  class Configuration < Resource
+  end
+end

data/lib/vivialconnect/contact.rb

@@ -0,0 +1,4 @@
+module VivialConnect 
+  class Contact < Resource # :nodoc:  
+  end
+end

data/lib/vivialconnect/log.rb

@@ -0,0 +1,71 @@
+module VivialConnect 
+  #=== .find_aggregate_by_time(options = {})
+  #
+  #Returns an array where index 0 is the last_key and index 1 is the array of log_items requested 
+  #
+  #
+  # Required parameters:                                                                  
+  #  
+  # start_time        | String | "20170424T134023Z" <-- ISO 8601 strftime('%Y%m%dT%H%M%SZ') 
+  # end_time          | String | "20170425T134023Z" <-- ISO 8601 strftime('%Y%m%dT%H%M%SZ') 
+  #
+  # 
+  # Optional parameters:
+  #
+  # logtype           | String | The log type, as a string. log-types are typically of the form ITEM_TYPE.ACTION, where ITEM_TYPE is the type of item that was affected and ACTION is what happened to it. For example, message.queued.
+  # aggregator_type   | String | If present with valid values ("minutes", "hours", "days", "months", "years"), then it will give aggregate map. Else it will give aggregate total counts. Valid values are: minutes, hours, days, months, years
+  # operator_id       | Fixnum | Unique id of operator that caused this log.
+  # limit             | Fixnum | Used for pagination, number of log records to return
+  # start_key         | Fixnum | Used for pagination, value of last_key from previous response
+  #
+  # Example usage:
+  #
+  # last_key, log_items = VivialConnect::Log.find_aggregate_by_time(start_time: "20170220T204352Z", end_time: "20170421T204352Z", aggregator_type: "minutes")
+  # => ['7b226163...', [ #<VivialConnect::Log>, #<VivialConnect::Log>, #<VivialConnect::Log> ]]
+  #
+  ##
+  #=== .find_by_time(options = {})
+  #
+  #Returns an array where index 0 is the last_key and index 1 is the array of log_items requested 
+  # 
+  #
+  # Required parameters:                                                                  
+  #  
+  # start_time  | String | "20170424T134023Z" <-- ISO 8601 strftime('%Y%m%dT%H%M%SZ')
+  # end_time    | String | "20170425T134023Z" <-- ISO 8601 strftime('%Y%m%dT%H%M%SZ')
+  #
+  # 
+  # Optional parameters:
+  #
+  # logtype     | String | The log type, as a string. log-types are typically of the form ITEM_TYPE.ACTION, where ITEM_TYPE is the type of item that was affected and ACTION is what happened to it. For example, message.queued.
+  # item_id     | Fixnum | Unique id of item that was affected.
+  # operator_id | Fixnum | Unique id of operator that caused this log.
+  # limit       | Fixnum | Used for pagination, number of log records to return
+  # start_key   | Fixnum | Used for pagination, value of last_key from previous response
+  #
+  # 
+  # last_key, log_items = VivialConnect::Log.find_by_time(start_time: "20170220T204352Z", end_time: "20170421T204352Z")
+  # => [ 7b226163...', [ #<VivialConnect::Log>, #<VivialConnect::Log>, #<VivialConnect::Log> ]]
+  #
+  #
+  
+  class Log < Resource
+
+    def self.find_by_time(options = {}) #:nodoc:
+      uri = '/logs.json'
+      numbers_template = Addressable::Template.new("#{uri}{?query*}")
+      uri = numbers_template.expand(query: options).to_s
+      VivialConnect::Client.instance.make_request('GET', uri)
+    end
+
+    def self.find_aggregate_by_time(options = {}) #:nodoc:
+      uri = '/logs/aggregate.json'
+      numbers_template = Addressable::Template.new("#{uri}{?query*}")
+      uri = numbers_template.expand(query: options).to_s
+      VivialConnect::Client.instance.make_request('GET', uri)
+    end 
+
+  end
+
+end
+

data/lib/vivialconnect/message.rb

@@ -0,0 +1,222 @@
+module VivialConnect 
+  ##
+  #=== .all
+  #
+  #Returns an array containing ruby objects corresponding to all Message resources on your account
+  #
+  #
+  # Example usage:
+  #
+  #
+  # VivialConnect::Message.all
+  # => [#<VivialConnect::Message to_number="#", from_number="#", body="example message", account_id=1XXXX, date_created="2017-04-19T15:18:12-04:00", date_modified="2017-04-19T15:18:12-04:00", direction="outbound-api", error_code=nil, error_message=nil, id=17219, master_account_id=1XXXX, message_status_callback=nil, message_type="local_sms", num_media=0, num_segments=1, price=75, price_currency="USD", sent=nil, sms_configuration_id=nil, status="accepted">]
+  #
+  #
+  #===  .count
+  #
+  #Returns the amount of Messages sent from your account
+  #
+  # Example usage:
+  #
+  #
+  # VivialConnect::Message.count
+  # => 5072
+  #
+  #
+  ##
+  #=== .create(options={})
+  #
+  #Creates a record of the message and sends it to the `to_number`. This method is also aliased as VivialConnect::Message.send(options={})
+  #
+  #
+  # Required parameters:                                                                  
+  #
+  #
+  # to_number   | String | "+16125551212"  <--NOTE: "+1" in front of the number.                     
+  # from_number | String | "+16125554444"                     
+  # body        | String | "My test message"                  
+  #
+  #
+  # Optional parameter: for MMS                               
+  #
+  # media_urls  | Array  | ["www.yourhost.com/path/to/image"] <--NOTE: Array datatype is required, even if only passing one piece of media
+  #
+  # 
+  # Example Usage
+  #
+  #
+  # SMS
+  #
+  # VivialConnect::Message.send(to_number: "+1##########", from_number: "+1##########", body: "example message") 
+  # VivialConnect::Message.create(to_number: "+1##########", from_number: "+1##########", body: "example message") 
+  # => #<VivialConnect::Message to_number="+1##########", from_number="+1##########", body="example message", account_id=1XXXX, date_created="2017-04-19T15:18:12-04:00", date_modified="2017-04-19T15:18:12-04:00", direction="outbound-api", error_code=nil, error_message=nil, id=17219, master_account_id=1XXXX, message_status_callback=nil, message_type="local_sms", num_media=0, num_segments=1, price=75, price_currency="USD", sent=nil, sms_configuration_id=nil, status="accepted"> 
+  #
+  #
+  # MMS
+  #
+  # VivialConnect::Message.send(to_number: "+1##########", from_number: "+1##########", body: "example mms", content_urls: ['www.yourhost/path/to/media']) 
+  # VivialConnect::Message.create(to_number: "+1##########", from_number: "+1##########", body: "example mms", content_urls: ['www.yourhost/path/to/media']) 
+  # => #<VivialConnect::Message account_id=1XXXXX, body="example mms", date_created="2017-04-19T11:18:11-04:00", date_modified="2017-04-19T11:18:34-04:00", direction="outbound-api", error_code=nil, error_message=nil, from_number="+1##########", id=6399, master_account_id=1XXXX message_status_callback=nil, message_type="local_mms", num_media=1, num_segments=1, price=100, price_currency="USD", sent="2017-04-19T11:18:16-04:00", sms_configuration_id=nil, status="delivered", to_number="+1##########"> 
+  #
+  #
+  # 
+  #  
+  #
+  ##
+  #=== .find(id)
+  #
+  #Returns the a Messsage object referenced by the `id` value.
+  #
+  # Required parameter:
+  #
+  # id | Fixnum | the id of the message you would like to retrieve
+  #   
+  #
+  # Example usage:
+  #
+  #
+  # VivialConnect::Message.find(17219)
+  # => #<VivialConnect::Message to_number="+1##########", from_number="+1##########", body="example message", account_id=1XXXX, date_created="2017-04-19T15:18:12-04:00", date_modified="2017-04-19T15:18:12-04:00", direction="outbound-api", error_code=nil, error_message=nil, id=17219, master_account_id=1XXXX, message_status_callback=nil, message_type="local_sms", num_media=0, num_segments=1, price=75, price_currency="USD", sent=nil, sms_configuration_id=nil, status="accepted"> 
+  #
+  #
+  ##
+  #=== .find_each(start: 1, finish: nil, batch_size: 150) 
+  #
+  #Iterates through all of the messages on your account in N sized batches beginning at the `start: value` and ending at the `finish: value`. 
+  #
+  #
+  # When a block is given this method yields an individual Message object. 
+  # Without a block, this method returns an Enumerator. 
+  #
+  #
+  # By default, it will begin at the first message and end at the last message
+  # 
+  # 
+  # With default batch_size: 150, if you wanted to get your records from
+  # 150 to 300 you would start at 2 and finish at 2.
+  #
+  # 
+  # Returns an Array of objects corresponding to the `start` and `finish` values. Default is all objects.
+  #
+  # Optional parameters:
+  #
+  # start      | Fixnum | batch to start with
+  # finish     | Fixnum | batch to end with
+  # batch_size | Fixnum | between 1..150
+  #   
+  #
+  # Example usage:
+  #
+  #
+  # VivialConnect::Message.find_each {|message| puts message.body}
+  # example message
+  # => [#<VivialConnect::Message to_number="#", from_number="#", body="example message", account_id=1XXXX, date_created="2017-04-19T15:18:12-04:00", date_modified="2017-04-19T15:18:12-04:00", direction="outbound-api", error_code=nil, error_message=nil, id=17219, master_account_id=1XXXX, message_status_callback=nil, message_type="local_sms", num_media=0, num_segments=1, price=75, price_currency="USD", sent=nil, sms_configuration_id=nil, status="accepted">, ...]
+  #
+  #
+  #
+  #
+  ##
+  #===  .find_in_batches(start: 1, finish: nil, batch_size: 150)  
+  # 
+  #Iterates through all of the messages on your account in N sized batches beginning at the `start: value` and ending at the `finish: value`. 
+  # 
+  #
+  # When a block is given this method yields an array of batch_size resource objects. 
+  # Without a block, it returns an Enumerator.
+  #
+  #
+  # By default, it will begin at the first message and end at the last message
+  # 
+  # 
+  # With default batch_size: 150, if you wanted to get your records from
+  # 150 to 300 you would start at 2 and finish at 2.
+  #
+  # 
+  # Returns an Array of objects corresponding to the `start` and `finish` values. Default is all objects.
+  #
+  # Optional parameters:
+  #
+  # start      | Fixnum | batch to start with
+  # finish     | Fixnum | batch to end with
+  # batch_size | Fixnum | between 1..150
+  #   
+  #
+  # Example usage:
+  #
+  #
+  # VivialConnect::Message.find_in_batches {|batch| do_something_with_an_array(batch)}
+  # => [#<VivialConnect::Message to_number="#", from_number="#", body="example message", account_id=1XXXX, date_created="2017-04-19T15:18:12-04:00", date_modified="2017-04-19T15:18:12-04:00", direction="outbound-api", error_code=nil, error_message=nil, id=17219, master_account_id=1XXXX, message_status_callback=nil, message_type="local_sms", num_media=0, num_segments=1, price=75, price_currency="USD", sent=nil, sms_configuration_id=nil, status="accepted">, ...]
+  #
+  #
+  #
+  #
+  ##
+  #=== .redact(id)
+  #
+  # Deletes the message body of the Message corresponding to the id provided.
+  #
+  # Example usage:
+  #
+  #
+  # VivialConnect::Message.redact(1)
+  # => #<VivialConnect::Message to_number="+1##########", from_number="+1##########", body="", account_id=1XXXX, date_created="2017-04-19T15:18:12-04:00", date_modified="2017-04-19T15:18:12-04:00", direction="outbound-api", error_code=nil, error_message=nil, id=17219, master_account_id=1XXXX, message_status_callback=nil, message_type="local_sms", num_media=0, num_segments=1, price=75, price_currency="USD", sent=nil, sms_configuration_id=nil, status="accepted"> 
+  #
+  #
+  ##
+  #===  \#save
+  #
+  #Creates a message and sends it.
+  #
+  #
+  # Example usage:
+  #
+  # message = VivialConnect::Message.new
+  # message.to_number = "+1##########"
+  # message.from_number = "+1##########"
+  # message.body = "Example message"
+  # message.save 
+  # => #<VivialConnect::Message to_number="+1##########", from_number="+1##########", body="Example message", account_id=1XXXX, date_created="2017-04-19T16:18:12-04:00", date_modified="2017-04-19T16:18:12-04:00", direction="outbound-api", error_code=nil, error_message=nil, id=17220, master_account_id=1XXXX, message_status_callback=nil, message_type="local_sms", num_media=0, num_segments=1, price=75, price_currency="USD", sent=nil, sms_configuration_id=nil, status="accepted"> 
+  #
+  #
+  ##
+  #===  \#redact
+  #
+  #Deletes the message body on a Message object.
+  #
+  #
+  # Example usage:
+  #
+  #
+  # message.redact
+  # => #<VivialConnect::Message to_number="+1##########", from_number="+1##########", body="", account_id=1XXXX, date_created="2017-04-19T15:18:12-04:00", date_modified="2017-04-19T15:18:12-04:00", direction="outbound-api", error_code=nil, error_message=nil, id=17219, master_account_id=1XXXX, message_status_callback=nil, message_type="local_sms", num_media=0, num_segments=1, price=75, price_currency="USD", sent=nil, sms_configuration_id=nil, status="accepted"> 
+  #
+  #
+
+  class Message < Resource
+
+    singleton_class.send(:alias_method, :send, :create)
+
+    def self.redact(id) # :nodoc:
+      data = {}
+      data['message'] = {id: id, body: ""}
+      data = data.to_json
+      VivialConnect::Client.instance.make_request('PUT',"/messages/#{id}.json", data) 
+    end
+
+
+    def redact # :nodoc:
+      raise VivialConnectClientError, "your message object has no id and therefore cannot be redacted" if self.id.nil?
+      id = self.id
+      data = {}
+      data['message'] = {id: id, body: ""}
+      data = data.to_json
+      VivialConnect::Client.instance.make_request('PUT',"/messages/#{id}.json", data) 
+    end
+
+
+  end
+
+end 
+
+
+