ruby-transmitsms 0.0.1

data/fixtures/vcr_cassettes/sms_api_test_send.yml

@@ -0,0 +1,49 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://api.burst.dev.local/send-sms.json?message=Testing%20API%20to%20field&to=61422222222
+    body:
+      encoding: UTF-8
+      string: 'null'
+    headers:
+      User-Agent:
+      - ruby-swagger-4.06.08
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Api-Key:
+      - ''
+      Authorization:
+      - |
+        Basic MTVhZDI2NmM1MzhmYjM2YzRkOTBmMDEwNTVhZWY0OTQ6bW9vc2U=
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.1.19
+      Date:
+      - Mon, 14 Sep 2015 07:06:22 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Powered-By:
+      - PHP/5.4.44-1+deb.sury.org~precise+1
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+      X-Mashape-Billing:
+      - Queries=1; Messages=1
+    body:
+      encoding: UTF-8
+      string: '{"message_id":50694,"send_at":"2015-09-14 07:06:21","recipients":1,"cost":0.054,"sms":1,"delivery_stats":{"delivered":0,"pending":0,"bounced":0,"responses":0,"optouts":0},"error":{"code":"SUCCESS","description":"OK"}}'
+    http_version: 
+  recorded_at: Mon, 14 Sep 2015 07:06:22 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/sms_api_test_send_missing_to_and_list_id.yml

@@ -0,0 +1,50 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://api.burst.dev.local/send-sms.json?message=Test%20error%20sending
+    body:
+      encoding: UTF-8
+      string: 'null'
+    headers:
+      User-Agent:
+      - ruby-swagger-4.06.08
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Api-Key:
+      - ''
+      Authorization:
+      - |
+        Basic MTVhZDI2NmM1MzhmYjM2YzRkOTBmMDEwNTVhZWY0OTQ6bW9vc2U=
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Server:
+      - nginx/1.1.19
+      Date:
+      - Mon, 14 Sep 2015 07:25:23 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Powered-By:
+      - PHP/5.4.44-1+deb.sury.org~precise+1
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+      X-Mashape-Billing:
+      - Queries=1
+    body:
+      encoding: UTF-8
+      string: '{"error":{"code":"FIELD_INVALID","description":"You must provide either
+        ''list_id'' or ''to''"}}'
+    http_version: 
+  recorded_at: Mon, 14 Sep 2015 07:25:23 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/sms_api_test_send_with_list_id.yml

@@ -0,0 +1,50 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://api.burst.dev.local/send-sms.json?list_id=55314&message=Testing%20API%20with%20list_id%20field
+    body:
+      encoding: UTF-8
+      string: 'null'
+    headers:
+      User-Agent:
+      - ruby-swagger-4.06.08
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Api-Key:
+      - ''
+      Authorization:
+      - |
+        Basic MTVhZDI2NmM1MzhmYjM2YzRkOTBmMDEwNTVhZWY0OTQ6bW9vc2U=
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.1.19
+      Date:
+      - Mon, 14 Sep 2015 07:23:03 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Powered-By:
+      - PHP/5.4.44-1+deb.sury.org~precise+1
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+      X-Mashape-Billing:
+      - Queries=1; Messages=1075
+    body:
+      encoding: UTF-8
+      string: '{"message_id":50695,"send_at":"2015-09-14 07:23:03","recipients":1075,"cost":58.05,"sms":1075,"list":{"id":55314,"name":"untitled
+        list"},"delivery_stats":{"delivered":0,"pending":0,"bounced":0,"responses":0,"optouts":0},"error":{"code":"SUCCESS","description":"OK"}}'
+    http_version: 
+  recorded_at: Mon, 14 Sep 2015 07:23:03 GMT
+recorded_with: VCR 2.9.3

data/geminstall.sh

@@ -0,0 +1 @@
+gem build ruby-transmitsms.gemspec && sudo gem install ruby-transmitsms--0.0.1.gem && rm ruby-transmitsms-0.0.1.gem

data/lib/account_api.rb

@@ -0,0 +1,80 @@
+require "uri"
+
+class AccountApi
+  basePath = "http://api.burst.dev.local/"
+  # apiInvoker = APIInvoker
+
+  def initialize(api_key, api_secret)
+    @api_key = api_key
+    @api_secret = api_secret
+    @sms_api = SmsApi
+
+    @api_key_secret = create_api_key_secret()
+
+    config_swagger()
+  end
+
+  def create_api_key_secret()
+    api_key_secret = Base64.encode64("#{@api_key}:#{@api_secret}")
+    "Basic #{api_key_secret}"
+  end 
+
+  def config_swagger()
+    Swagger.configure do |config|
+      config.host = "http://api.burst.dev.local/".gsub("http://", "").gsub("/", "")
+      config.base_path = "/"
+      config.format = "x-www-form-urlencoded"
+      config.camelize_params = false
+    end
+  end
+
+
+  # Get a summary of your account balance.
+  # 
+  # @return void
+  def get_balance (opts={})
+    query_param_keys = []
+    headerParams = {}
+
+    
+    
+    # set default values and merge with input
+    options = {
+      
+    }.merge(opts)
+
+    #resource path
+    path = "/get-balance.json".sub('{format}','json')
+    
+    # pull querystring keys from options
+    queryopts = options.select do |key,value|
+      query_param_keys.include? key
+    end
+
+    # header parameters
+    headers = {}
+
+    _header_accept = 'application/json'
+    if _header_accept != ''
+      headerParams['Accept'] = _header_accept
+    end 
+    _header_content_type = ['application/x-www-form-urlencoded']
+    headerParams['Content-Type'] = _header_content_type.length > 0 ? _header_content_type[0] : 'application/json'
+
+    
+    
+    headers[:'Authorization'] = @api_key_secret
+
+    # http body (model)
+    post_body = nil
+    
+    # form parameters
+    form_parameter_hash = {}
+    
+    
+    
+    Swagger::Request.new(:POST, path, {:params=>queryopts,:headers=>headers, :body=>post_body, :form_params => form_parameter_hash }).make
+    
+  
+  end
+end

data/lib/email_api.rb

@@ -0,0 +1,137 @@
+require "uri"
+
+class EmailApi
+  basePath = "http://api.burst.dev.local/"
+  # apiInvoker = APIInvoker
+
+  def initialize(api_key, api_secret)
+    @api_key = api_key
+    @api_secret = api_secret
+    @sms_api = SmsApi
+
+    @api_key_secret = create_api_key_secret()
+
+    config_swagger()
+  end
+
+  def create_api_key_secret()
+    api_key_secret = Base64.encode64("#{@api_key}:#{@api_secret}")
+    "Basic #{api_key_secret}"
+  end 
+
+  def config_swagger()
+    Swagger.configure do |config|
+      config.host = "http://api.burst.dev.local/".gsub("http://", "").gsub("/", "")
+      config.base_path = "/"
+      config.format = "x-www-form-urlencoded"
+      config.camelize_params = false
+    end
+  end
+
+
+  # Authorise an email address for sending Email to SMS
+  # 
+  # @param email Email address to register. You may also register a wild-card email which allows any user on the same domain to use Email to SMS.
+  # @param max_sms The maximum number of SMS messages to send from one email message sent from this email address.
+  # @param number Optional dedicated virtual number virtual number
+  # @return void
+  def add_email (email = nil, max_sms = nil, number = nil, opts={})
+    query_param_keys = [:email,:max_sms,:number]
+    headerParams = {}
+
+    
+    
+    # set default values and merge with input
+    options = {
+      :'email' => email,
+      :'max_sms' => max_sms,
+      :'number' => number
+      
+    }.merge(opts)
+
+    #resource path
+    path = "/add-email.json".sub('{format}','json')
+    
+    # pull querystring keys from options
+    queryopts = options.select do |key,value|
+      query_param_keys.include? key
+    end
+
+    # header parameters
+    headers = {}
+
+    _header_accept = 'application/json'
+    if _header_accept != ''
+      headerParams['Accept'] = _header_accept
+    end 
+    _header_content_type = ['application/x-www-form-urlencoded']
+    headerParams['Content-Type'] = _header_content_type.length > 0 ? _header_content_type[0] : 'application/json'
+
+    
+    
+    headers[:'Authorization'] = @api_key_secret
+
+    # http body (model)
+    post_body = nil
+    
+    # form parameters
+    form_parameter_hash = {}
+    
+    
+    
+    Swagger::Request.new(:POST, path, {:params=>queryopts,:headers=>headers, :body=>post_body, :form_params => form_parameter_hash }).make
+    
+  
+  end
+
+  # Remove an email address from the Email to SMS authorised list.
+  # 
+  # @param email Email address to remove. You may also use a wild-card email which removes all emails on that domain.
+  # @return void
+  def delete_email (email = nil, opts={})
+    query_param_keys = [:email]
+    headerParams = {}
+
+    
+    
+    # set default values and merge with input
+    options = {
+      :'email' => email
+      
+    }.merge(opts)
+
+    #resource path
+    path = "/delete-email.json".sub('{format}','json')
+    
+    # pull querystring keys from options
+    queryopts = options.select do |key,value|
+      query_param_keys.include? key
+    end
+
+    # header parameters
+    headers = {}
+
+    _header_accept = 'application/json'
+    if _header_accept != ''
+      headerParams['Accept'] = _header_accept
+    end 
+    _header_content_type = ['application/x-www-form-urlencoded']
+    headerParams['Content-Type'] = _header_content_type.length > 0 ? _header_content_type[0] : 'application/json'
+
+    
+    
+    headers[:'Authorization'] = @api_key_secret
+
+    # http body (model)
+    post_body = nil
+    
+    # form parameters
+    form_parameter_hash = {}
+    
+    
+    
+    Swagger::Request.new(:POST, path, {:params=>queryopts,:headers=>headers, :body=>post_body, :form_params => form_parameter_hash }).make
+    
+  
+  end
+end

data/lib/keywords_api.rb

@@ -0,0 +1,224 @@
+require "uri"
+
+class KeywordsApi
+  basePath = "http://api.burst.dev.local/"
+  # apiInvoker = APIInvoker
+
+  def initialize(api_key, api_secret)
+    @api_key = api_key
+    @api_secret = api_secret
+    @sms_api = SmsApi
+
+    @api_key_secret = create_api_key_secret()
+
+    config_swagger()
+  end
+
+  def create_api_key_secret()
+    api_key_secret = Base64.encode64("#{@api_key}:#{@api_secret}")
+    "Basic #{api_key_secret}"
+  end 
+
+  def config_swagger()
+    Swagger.configure do |config|
+      config.host = "http://api.burst.dev.local/".gsub("http://", "").gsub("/", "")
+      config.base_path = "/"
+      config.format = "x-www-form-urlencoded"
+      config.camelize_params = false
+    end
+  end
+
+
+  # Add a keyword to an existing virtual number
+  # 
+  # @param keyword The first word of a text message
+  # @param number The dedicated virtual number that the keyword belongs to
+  # @param reference Your own reference (up to 100 characters)
+  # @param list_id ID of a list to add respondents to, list ID's can be found in the title of a list or in the list page URL
+  # @param welcome_message SMS message to send to new members
+  # @param members_message SMS message to existing members
+  # @param activate Whether to make the keyword active immediately.
+  # @param forward_url Forward messages to a URL
+  # @param forward_email Forward messages to a set of email addresses
+  # @param forward_sms Forward messages to a set of msisdns
+  # @return void
+  def add_keyword (keyword = nil, number = nil, reference = nil, list_id = nil, welcome_message = nil, members_message = nil, activate = nil, forward_url = nil, forward_email = nil, forward_sms = nil, opts={})
+    query_param_keys = [:keyword,:number,:reference,:list_id,:welcome_message,:members_message,:activate,:forward_url,:forward_email,:forward_sms]
+    headerParams = {}
+
+    
+    
+    # set default values and merge with input
+    options = {
+      :'keyword' => keyword,
+      :'number' => number,
+      :'reference' => reference,
+      :'list_id' => list_id,
+      :'welcome_message' => welcome_message,
+      :'members_message' => members_message,
+      :'activate' => activate,
+      :'forward_url' => forward_url,
+      :'forward_email' => forward_email,
+      :'forward_sms' => forward_sms
+      
+    }.merge(opts)
+
+    #resource path
+    path = "/add-keyword.json".sub('{format}','json')
+    
+    # pull querystring keys from options
+    queryopts = options.select do |key,value|
+      query_param_keys.include? key
+    end
+
+    # header parameters
+    headers = {}
+
+    _header_accept = 'application/json'
+    if _header_accept != ''
+      headerParams['Accept'] = _header_accept
+    end 
+    _header_content_type = ['application/x-www-form-urlencoded']
+    headerParams['Content-Type'] = _header_content_type.length > 0 ? _header_content_type[0] : 'application/json'
+
+    
+    
+    headers[:'Authorization'] = @api_key_secret
+
+    # http body (model)
+    post_body = nil
+    
+    # form parameters
+    form_parameter_hash = {}
+    
+    
+    
+    Swagger::Request.new(:POST, path, {:params=>queryopts,:headers=>headers, :body=>post_body, :form_params => form_parameter_hash }).make
+    
+  
+  end
+
+  # Add a keyword to an existing virtual number
+  # 
+  # @param keyword The first word of a text message
+  # @param number The dedicated virtual number that the keyword belongs to
+  # @param reference Your own reference (up to 100 characters)
+  # @param list_id ID of a list to add respondents to, list ID's can be found in the title of a list or in the list page URL
+  # @param welcome_message SMS message to send to new members
+  # @param members_message SMS message to existing members
+  # @param activate Whether to make the keyword active immediately.
+  # @param forward_url Forward messages to a URL
+  # @param forward_email Forward messages to a set of email addresses
+  # @param forward_sms Forward messages to a set of msisdns
+  # @return void
+  def edit_keyword (keyword = nil, number = nil, reference = nil, list_id = nil, welcome_message = nil, members_message = nil, activate = nil, forward_url = nil, forward_email = nil, forward_sms = nil, opts={})
+    query_param_keys = [:keyword,:number,:reference,:list_id,:welcome_message,:members_message,:activate,:forward_url,:forward_email,:forward_sms]
+    headerParams = {}
+
+    
+    
+    # set default values and merge with input
+    options = {
+      :'keyword' => keyword,
+      :'number' => number,
+      :'reference' => reference,
+      :'list_id' => list_id,
+      :'welcome_message' => welcome_message,
+      :'members_message' => members_message,
+      :'activate' => activate,
+      :'forward_url' => forward_url,
+      :'forward_email' => forward_email,
+      :'forward_sms' => forward_sms
+      
+    }.merge(opts)
+
+    #resource path
+    path = "/edit-keyword.json".sub('{format}','json')
+    
+    # pull querystring keys from options
+    queryopts = options.select do |key,value|
+      query_param_keys.include? key
+    end
+
+    # header parameters
+    headers = {}
+
+    _header_accept = 'application/json'
+    if _header_accept != ''
+      headerParams['Accept'] = _header_accept
+    end 
+    _header_content_type = ['application/x-www-form-urlencoded']
+    headerParams['Content-Type'] = _header_content_type.length > 0 ? _header_content_type[0] : 'application/json'
+
+    
+    
+    headers[:'Authorization'] = @api_key_secret
+
+    # http body (model)
+    post_body = nil
+    
+    # form parameters
+    form_parameter_hash = {}
+    
+    
+    
+    Swagger::Request.new(:POST, path, {:params=>queryopts,:headers=>headers, :body=>post_body, :form_params => form_parameter_hash }).make
+    
+  
+  end
+
+  # Get a list of existing keywords.
+  # 
+  # @param number Filter the list by virtual number
+  # @param page Page number, for pagination
+  # @param max   Maximum results returned per page
+  # @return void
+  def get_keywords (number = nil, page = nil, max = nil, opts={})
+    query_param_keys = [:number,:page,:max]
+    headerParams = {}
+
+    
+    
+    # set default values and merge with input
+    options = {
+      :'number' => number,
+      :'page' => page,
+      :'max' => max
+      
+    }.merge(opts)
+
+    #resource path
+    path = "/get-keywords.json".sub('{format}','json')
+    
+    # pull querystring keys from options
+    queryopts = options.select do |key,value|
+      query_param_keys.include? key
+    end
+
+    # header parameters
+    headers = {}
+
+    _header_accept = 'application/json'
+    if _header_accept != ''
+      headerParams['Accept'] = _header_accept
+    end 
+    _header_content_type = ['application/x-www-form-urlencoded']
+    headerParams['Content-Type'] = _header_content_type.length > 0 ? _header_content_type[0] : 'application/json'
+
+    
+    
+    headers[:'Authorization'] = @api_key_secret
+
+    # http body (model)
+    post_body = nil
+    
+    # form parameters
+    form_parameter_hash = {}
+    
+    
+    
+    Swagger::Request.new(:POST, path, {:params=>queryopts,:headers=>headers, :body=>post_body, :form_params => form_parameter_hash }).make
+    
+  
+  end
+end