vivialconnect 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 828c9a5c3422698044222a0d637bf1993c27014e
-  data.tar.gz: ac62e677b700bb6a7a653ea44d0fcf76933001c8
+  metadata.gz: 9e65db123633edbb42c7bb154aaa83b71074e126
+  data.tar.gz: a1e4578831432c28d121f12ea6a5f0f0bc078d39
 SHA512:
-  metadata.gz: f2a45113770f5c43391cef5484983713f24ecd6f69717c1f2b88c2844ad72bc49fc85ca030c9c651446c6ad36669808eecef8c200dc3c952314bcc31fccdb816
-  data.tar.gz: 3363eb281a9da8c0bfe760843b80ace6d0705138fa136ef64502dd27a7e53a1bc2489f539cb494f72af7180b5aae7fb2343f7237aaf0b92110934b9967003bba
+  metadata.gz: 3e338e4bbd2d960f563717311b10c21b4ef10c9c1f55ff80c3805917c7574779fb700da2e4d1df0c6495db5dcd178ab4e22ad7ad95db21ef72149d40ca53d97f
+  data.tar.gz: 1dd0267470a00d5861c7d122cdd6e8bf311f0e7f5c54819e5052be5736232b00ce413c1f013249b18924a5ccd14cdc02d61a0862db479846a5ffd77b47fb31aa

data/lib/vivialconnect/account.rb

@@ -1,66 +1,8 @@
 module VivialConnect
-  ##
-  #=== .add_main_contact_to_subaccount(options={})
-  #
-  #Creates a new contact and adds it as the main contact to a subaccount.
-  #
-  # Required parameters:
-  #
-  # account_id   | Fixnum | 123456 (subaccount id)
-  # company_name | String | "App Developer Inc." 
-  # first_name   | String | "Bob"
-  # last_name    | String | "Tester"
-  # email        | String | "btester@vivialconnect"                   
-  #
-  # 
-  # Optional parameters:
-  #
-  # address1     | String | "500 Office Building Ln"
-  # address2     | String | "Suite 300"
-  # address3     | String | "c/o Front Desk"
-  # city         | String | "Columbia Heights"
-  # country      | String | "United States"
-  # state        | String | "Minnesota"
-  # postal_code  | String | "55421"
-  # title        | String | "CMO"
-  # work_phone   | String | "+1XXXXXXXXXX"
-  # mobile_phone | String | "+1XXXXXXXXXX"
-  # fax          | String | "+1XXXXXXXXXX"
-  #
-  # Example Usage
-  #
-  #
-  # VivialConnect::Account.add_main_contact_to_subaccount(email: "btester@vivialconnect", contact_type:"main", company_name: "Acme")
-  # => #<VivialConnect::Contact account_id=1XXXX, active=true, address1=nil, address2=nil, address3=nil, city=nil, company_name="Acme", contact_type="main", country="United States", date_created="2017-04-21T10:51:50-04:00", date_modified="2017-04-21T10:51:50-04:00", email="btester@vivialconnect", fax=nil, first_name="Bob", id=89, last_name="Tester", mobile_phone=nil, postal_code="55421", state=nil, title=nil, work_phone="+1XXXXXXXXXX"> 
-  #
-  #
-  ##
-  #=== .add_user_to_subaccount(options={})
-  #
-  #Creates a new User and adds it to a subaccount.
-  #
-  #
-  # Required parameters:                                                             
-  #
-  #
-  # first_name   | String | "Bob"
-  # last_name    | String | "Tester"
-  # email        | String | "btester@vivialconnect"                     
-  # username     | String | "btester"
-  # password     | String | "dlrowolleh"
-  # 
-  #
-  # Example Usage
-  #
-  #
-  # VivialConnect::Account.add_user_to_subaccount(account_id: 1XXXX, email: "btester@vivialconnect.net", username: "btester", first_name: "Bob", last_name: "Tester", password: "XXXXXXX")
-  # => #<VivialConnect::User account_id=1XXXX, active=true, api_key="XYZYXZYXYZXYXZYXZYXYZYXYZYXYZYXYZYX", date_created="2017-04-21T11:27:16-04:00", date_modified="2017-04-21T11:27:16-04:00", email="btester@vivialconnect.net", first_name="Bob", id=10093, last_name="Tester", roles=[{"active"=>true, "date_created"=>"2016-09-30T19:42:59-04:00", "date_modified"=>"2016-09-30T19:42:59-04:00", "description"=>"User role", "id"=>4, "name"=>"User", "role_type"=>"client"}], timezone="US/Eastern", username="btester", verified=false> 
-  #
-  # Note: This method triggers an email to the created user's account. They need to answer this confirmation email before they will be able to log in.
   ##
   #=== .all
   #
-  #Returns an array containing ruby objects corresponding to all Account resources associated with your account i.e. main account and associated subaccounts
+  #Returns an array containing ruby objects corresponding to all Account resources associated with your account
   #
   #
   # Example usage:
@@ -82,28 +24,6 @@ module VivialConnect
   #
   #
   ##
-  #=== .create(options={})
-  #
-  #Creates a subaccount tied to your main account
-  #
-  #
-  # Required parameters:                                                                  
-  #
-  #
-  # company_name | String | "App Developer Inc."                    
-  #
-  # 
-  # Example Usage
-  #
-  #
-  # VivialConnect::Account.create(company_name: "App Developer Inc.")
-  # => #<VivialConnect::Account account_id=1XXXX, accounts=[], active=true, company_name="App Developer Inc.", contacts=[], date_created="2017-04-20T17:07:08-04:00", date_modified="2017-04-20T17:07:08-04:00", id=10086, services=[{"active"=>true, "date_created"=>"2016-09-30T19:42:58-04:00", "date_modified"=>"2016-09-30T19:42:58-04:00", "description"=>"SMS service", "id"=>1, "name"=>"sms", "service_type"=>"client"}, {"active"=>true, "date_created"=>"2016-09-30T19:42:58-04:00", "date_modified"=>"2016-09-30T19:42:58-04:00", "description"=>"Account service", "id"=>2, "name"=>"accounts", "service_type"=>"client"}, {"active"=>true, "date_created"=>"2016-09-30T19:42:58-04:00", "date_modified"=>"2016-09-30T19:42:58-04:00", "description"=>"Public service", "id"=>3, "name"=>"public", "service_type"=>"client"}]> 
-  #
-  #
-  # Note: When creating subaccounts, the `id` refers to the subaccount id, whereas the `account_id` refers to the main account.
-  #  
-  #
-  ##
   #=== .find(id)
   #
   #Returns the a Account object referenced by the `id` value.
@@ -191,19 +111,6 @@ module VivialConnect
   #
   #
   ##
-  #=== .subaccounts
-  #
-  #Returns an array containing ruby objects containing all associated subaccounts
-  #
-  #
-  # Example usage:
-  #
-  #
-  # VivialConnect::Account.subaccounts
-  # => [#<VivialConnect::Account>, #<VivialConnect::Account>, #<VivialConnect::Account>]
-  #
-  #
-  ##
   #=== .update(id, options={})
   #
   #  Required parameters:
@@ -218,59 +125,8 @@ module VivialConnect
   # => #<VivialConnect::Account account_id=1XXXX, accounts=[], active=true, company_name="New Name", contacts=[], date_created="2017-04-20T17:07:08-04:00", date_modified="2017-04-20T17:07:08-04:00", id=10086, services=[{"active"=>true, "date_created"=>"2016-09-30T19:42:58-04:00", "date_modified"=>"2016-09-30T19:42:58-04:00", "description"=>"SMS service", "id"=>1, "name"=>"sms", "service_type"=>"client"}, {"active"=>true, "date_created"=>"2016-09-30T19:42:58-04:00", "date_modified"=>"2016-09-30T19:42:58-04:00", "description"=>"Account service", "id"=>2, "name"=>"accounts", "service_type"=>"client"}, {"active"=>true, "date_created"=>"2016-09-30T19:42:58-04:00", "date_modified"=>"2016-09-30T19:42:58-04:00", "description"=>"Public service", "id"=>3, "name"=>"public", "service_type"=>"client"}]> 
   #
   #
-  ##
-  #===  \#save
-  #
-  # Creates a subaccount associated with your main account or updates an existing one
-  #
-  #
-  # Example usage:
-  #
-  # account = VivialConnect::Account.new
-  # account.company_name = "B Tester QA Inc."
-  # account.save 
-  # => #<VivialConnect::Account account_id=1XXXX, accounts=[], active=true, company_name="B Tester QA Inc.", contacts=[], date_created="2017-04-20T17:07:08-04:00", date_modified="2017-04-20T17:07:08-04:00", id=10086, services=[{"active"=>true, "date_created"=>"2016-09-30T19:42:58-04:00", "date_modified"=>"2016-09-30T19:42:58-04:00", "description"=>"SMS service", "id"=>1, "name"=>"sms", "service_type"=>"client"}, {"active"=>true, "date_created"=>"2016-09-30T19:42:58-04:00", "date_modified"=>"2016-09-30T19:42:58-04:00", "description"=>"Account service", "id"=>2, "name"=>"accounts", "service_type"=>"client"}, {"active"=>true, "date_created"=>"2016-09-30T19:42:58-04:00", "date_modified"=>"2016-09-30T19:42:58-04:00", "description"=>"Public service", "id"=>3, "name"=>"public", "service_type"=>"client"}]> 
-  #
-  #
-  class Account < Resource
-
-    def self.subaccounts # :nodoc:
-      uri = '/subaccounts.json'
-      VivialConnect::Client.instance.make_request('GET', uri)
-    end
-
-    def self.add_main_contact_to_subaccount(options={}) # :nodoc:
-      raise VivialConnectClientError, "you must include an account_id parameter" if !options.keys.include?(:account_id)
-
-      # This call must be made from the subaccount, so the client's account_id has to be updated
-      main_account_id = VivialConnect::Client.instance.account_id
-  
-      VivialConnect::Client.instance.account_id = options[:account_id]
-      uri = '/contacts.json'
-      options[:contact_type] = 'main'
-      data = {}
-      data[:contact] = options 
-      data = data.to_json
 
-      begin 
-        response = VivialConnect::Client.instance.make_request('POST', uri, data)
-      ensure
-        # client's account_id must be set back for future calls to work 
-        VivialConnect::Client.instance.account_id = main_account_id
-      end
-
-      response
-    end
-
-    def self.add_user_to_subaccount(options={}) # :nodoc:
-      raise VivialConnectClientError, "you must include an account_id parameter" if !options.keys.include?(:account_id)
-      uri = '/users/register.json'
-      options[:role] = 'User'
-      data = {}
-      data[:user] = options 
-      data = data.to_json
-      response = VivialConnect::Client.instance.make_request('POST', uri, data)
-    end
+  class Account < Resource
 
   end
 end

data/lib/vivialconnect/client.rb

@@ -34,7 +34,7 @@ module VivialConnect
   # => true
   #
   # NOTE: .configure does not check if your credentials are good, it merely checks that you have entered values for them
-  #===  .reset
+  #===  #reset
   #
   #Resets all of the configuration values to nil. This gives you a blank slate client to call .configure on.
   #
@@ -42,7 +42,7 @@ module VivialConnect
   # Example usage
   #
   #
-  # VivialConnect::Client.reset
+  # VivialConnect::Client.instance.reset
   # => true
   #
   #
@@ -72,7 +72,6 @@ module VivialConnect
     def initialize
       begin 
         @base_api_path = host + "#{api_version}/"
-        connection
       rescue NameError => e
         raise VivialConnectClientError, "Please configure client before making requests. You can do this like so: .configure(api_key, api_secret, account_id) to "
       end
@@ -88,14 +87,16 @@ module VivialConnect
       true
     end
 
-    def self.reset
+    def reset
       @@api_key= nil
       @@api_secret = nil
       @@account_id = nil
       @@host = nil
       @@api_version = nil
       @@configured = false
-      @base_api_path = nil
+      self.instance_variables.each do |ivar|
+        self.remove_instance_variable(ivar)
+      end
       true
     end
 
@@ -126,7 +127,6 @@ module VivialConnect
       @base_api_path
     end 
 
-
     def self.configured?
       @@configured == true
     end
@@ -268,10 +268,6 @@ module VivialConnect
             #return an array of resource objects
             response_array = api_response[api_response.keys.first]
             api_response = process_array(response_array, response_class)
-          elsif url.path.split("/")[-1] == "subaccounts.json"
-            #handle subaccounts array
-            response_array = api_response[api_response.keys.first]['accounts']
-            api_response = process_array(response_array, response_class)
           elsif api_response[api_response.keys[1]].is_a?(Array)
             #handle Log resource, return last key and an array full of log objects
             last_key = api_response['last_key']
@@ -308,8 +304,6 @@ module VivialConnect
         return Account 
       elsif url.include?('attachments')
         return Attachment
-      elsif url.include?('subaccounts')
-        return Account
       else 
         api_resource = url[5]
         #exceptions needed for resources requiring camelcase

data/lib/vivialconnect/number.rb

@@ -254,6 +254,33 @@ module VivialConnect
   # VivialConnect::Number.update(875, name: "Dr. Jones")
   # => #<VivialConnect::Number account_id=10096, active=true, address_requirements="none", capabilities={"mms"=>true, "sms"=>true, "voice"=>true}, city="ALMELUND", date_created="2017-04-25T10:22:07-04:00", date_modified="2017-04-25T10:41:16-04:00", id=69, lata=nil, master_account_id=1XXXX, message_status_callback=nil, name="Dr. Jones", phone_number="+16123151041", phone_number_type="local", rate_center="TWINCITIES", region="MN", sms_configuration_id=nil, sms_fallback_method=nil, sms_fallback_url=nil, sms_method=nil, sms_url=nil, voice_forwarding_number=nil> #<VivialConnect::Number account_id=1XXXX, active=true, address_requirements="none", capabilities={"mms"=>true, "sms"=>true, "voice"=>true}, city="PITTSBURGH ", date_created="2017-04-25T09:56:04-04:00", date_modified="2017-04-25T09:56:04-04:00", id=66, lata=nil, master_account_id=10096, message_status_callback=nil, name="(412) 433-0365", phone_number="+14124330365", phone_number_type="local", rate_center="PTTSBGZON1", region="PA", sms_configuration_id=nil, sms_fallback_method=nil, sms_fallback_url=nil, sms_method=nil, sms_url=nil, voice_forwarding_number=nil>
   #
+  #
+  #===  \#delete
+  #
+  # Deletes a Number object. WARNING: this cannot be undone. Once the number is released from your account it can be aquired by other users.
+  #
+  #
+  # Example usage:
+  #
+  #
+  # number = VivialConnect::Number.find(1)
+  # number.delete
+  # => true
+  #
+  #   
+  #===  \#save
+  #
+  # Creates a number associated with your main account or updates an existing one
+  #
+  #
+  # Example usage:
+  #
+  # number = VivialConnect::Number.find(2)
+  # number.name = "new name for this number"
+  # number.save
+  # => #<VivialConnect::Number account_id=1XXXX, active=true, address_requirements="none", capabilities={"mms"=>true, "sms"=>true, "voice"=>true}, city="PITTSBURGH ", date_created="2017-04-25T09:56:04-04:00", date_modified="2017-04-25T09:56:04-04:00", id=66, lata=nil, master_account_id=10096, message_status_callback=nil, name="new name for this number", phone_number="+14124330365", phone_number_type="local", rate_center="PTTSBGZON1", region="PA", sms_configuration_id=nil, sms_fallback_method=nil, sms_fallback_url=nil, sms_method=nil, sms_url=nil, voice_forwarding_number=nil>
+  #
+  #
  
   class Number < Resource
 

data/lib/vivialconnect/version.rb

@@ -1,3 +1,3 @@
 module Vivialconnect # :nodoc:
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vivialconnect
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Justin LeFurjah
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-27 00:00:00.000000000 Z
+date: 2017-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -162,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: This is an API wrapper gem for integrating with the Vivial Connect text messaging