onsip 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e86219349aaabe949b5c8d61fa83a7532fec8049
-  data.tar.gz: 5e2a2ce635807c8e79db668e63cd5ab3f9e54346
+  metadata.gz: d756dbee6749a9399eefa71653ff605ce1181167
+  data.tar.gz: 777b636d24fcf319c711edf35a79f2b0cf7650f2
 SHA512:
-  metadata.gz: 775131b7aad62549de28d8d0d600d443faa312cc38dd88f83a4f8c5dbc799c2cb9cbdd335e5f4048b5fa3b01f8249a6dbed5528949c0fa5bdd587c979da10c59
-  data.tar.gz: 29ccf0628368492cfd8ce9c97c68b4b7eb00d25bec4d01a6dd8b8ba1fd3d2b5bc8f11edbac0cccd5500336feb8491acd8ac5666f2ff9b85d16fc66db78d3e017
+  metadata.gz: e5358759f94c71ac2e61f02738d613e5c6d7d2988f81a6b54f778085425202beec664018d9b1cc301519c905af2fa40c1e5781aa71b2548c322e598ec14725ec
+  data.tar.gz: c2be2aead48b8afc2ad3378543f0f8ec74bd7016a11784bc4d3354d90b4e5cddd5c8ea927fff17ea93ee1c3a75f48c9138660372b85eaf7ef25dad8ce8b41702

data/.rspec

@@ -1,2 +1,3 @@
 --color
+--format documentation
 --require spec_helper

data/lib/onsip/exceptions.rb

@@ -1,17 +1,17 @@
 module OnSIP
-  class OnSIPException < StandardError
-    attr_accessor :options, :exception
+  module Exceptions
+    class OnSIPError < StandardError
+      attr_reader :object
 
-    def initialize(options = {})
-      @options = options
-      @message = @options[:message]
-      @exception = @options[:exception]
+      def initialize(object)
+        @object = object
+      end
     end
-  end
 
-  class OnSIPRequestException < OnSIPException
-    def response
-      @options[:response]
+    class OnSIPRequestError < OnSIPError
+      def response
+        @object[:response]
+      end
     end
   end
 end

data/lib/onsip/response_parser.rb

@@ -2,21 +2,44 @@ module OnSIP
   module ResponseParser
 
     module ClassMethods
+      include ::OnSIP::Exceptions
+
       def parse_response(response, key_path = [], ignore_result_keys = [])
-        result = []
+        begin
+
+          if valid_response?(response)
+            value_at_key_path(response.env.body, key_path, ignore_result_keys)
+          else
+            raise StandardError, 'Problem validating OnSIP response'
+          end
+
+        rescue StandardError => e
+          raise OnSIPRequestError.new(:message => 'Problem with parsing response',
+                                      :exception => e,
+                                      :response => response)
+        end
+      end
 
-        return result unless response && !response.env.body.blank?
+      def valid_response?(response)
+        if response && response.env[:status] == 200 && !response.env.body.blank?
+          r = response.env.body
+          r['Response']['Context']['Action']['IsCompleted'] == 'false' ? false : true
+        else
+          false
+        end
+      end
 
-        r = response.env.body
+      def value_at_key_path(body, key_path = [], ignore_result_keys = [])
+        result = []
 
         key_path.each_with_index do |key, i|
-          if i < (key_path.length - 1) && r[key]
-            r = r[key]
-          elsif i == (key_path.length - 1) && r[key] && r[key].kind_of?(Array)
-            a = r[key]
+          if i < (key_path.length - 1) && body[key]
+            body = body[key]
+          elsif i == (key_path.length - 1) && body[key] && body[key].kind_of?(Array)
+            a = body[key]
             result = a.flatten.map { |h| h.delete_if { |k| ignore_result_keys.include?(k) }; h }
-          elsif i == (key_path.length - 1) && r[key] && r[key].kind_of?(Hash)
-            h = r[key]
+          elsif i == (key_path.length - 1) && body[key] && body[key].kind_of?(Hash)
+            h = body[key]
             h.delete_if { |k| ignore_result_keys.include?(k) }
             result = [h]
           else
@@ -25,11 +48,8 @@ module OnSIP
         end
 
         result
-      rescue StandardError => e
-        raise OnSIPRequestException.new(:message => 'Problem with parsing response',
-                                        :exception => e,
-                                        :response => response)
       end
+
     end
 
     extend ClassMethods

data/lib/onsip/session.rb

@@ -36,6 +36,7 @@ module OnSIP
     module ClassMethods
       def create(username, password)
         response = OnSIP.connection.get('/api', {'Action' => 'SessionCreate', 'Username' => username, 'Password' => password, 'Output' => 'json'}, {})
+        yield response if block_given?
         process_create_session_response response
       end
 
@@ -51,6 +52,7 @@ module OnSIP
 
       def destroy!(session_id)
         response = OnSIP.connection.get('/api', {'Action' => 'SessionDestroy', 'SessionId' => session_id, 'Output' => 'json'}, {})
+        yield response if block_given?
         process_destroy_session_response response
       end
 

data/lib/onsip/version.rb

@@ -1,3 +1,3 @@
 module OnSIP
-  VERSION = '0.0.9'
+  VERSION = '0.1.0'
 end

data/lib/onsip.rb

@@ -22,7 +22,7 @@ module OnSIP
   autoload :CDR, 'onsip/models/cdr'
 
   module ClassMethods
-    attr_writer :logger
+    attr_writer :logger, :session
 
     def logger
       @logger ||= init_logger

data/onsip.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rb-fsevent', '~> 0.9.3'
   spec.add_development_dependency 'simplecov', '~> 0.8.2'
   spec.add_development_dependency 'rspec', '>= 3.1.0'
-  spec.add_runtime_dependency 'activesupport', '>= 3.0.0'
+  spec.add_runtime_dependency 'activesupport', ['>= 3.0.0', '<= 4.0.0']
   spec.add_runtime_dependency 'trollop', '~> 2.0'
   spec.add_runtime_dependency 'multi_json', '~> 1.10.1'
   spec.add_runtime_dependency 'nokogiri', '~> 1.6.1'

data/spec/lib/onsip/models/account_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe OnSIP::Account do
+  before :each do
+
+    success_body = {"Response"=>{"Context"=>{"Action"=>{"IsCompleted"=>"true"}, "Request"=>{"IsValid"=>"true", "DateTime"=>"2014-12-04T20:34:18+00:00", "Duration"=>"50", "Parameters"=>{"Parameter"=>[{"Name"=>"AccountId", "Value"=>"27370"}, {"Name"=>"Action", "Value"=>"AccountRead"}, {"Name"=>"Output", "Value"=>"json"}, {"Name"=>"SessionId", "Value"=>"1vflpm8sa25vt88o6nsl60lgi5"}]}}, "Session"=>{"IsEstablished"=>"true", "SessionId"=>"1vflpm8sa25vt88o6nsl60lgi5", "UserId"=>"212762", "Roles"=>{"Role"=>{"Name"=>"Account Admin"}}}}, "Result"=>{"AccountRead"=>{"Account"=>{"AccountId"=>"27370", "Receivable"=>"0.00", "Promocode"=>{}, "Productcode"=>"platform", "PerUserPricing"=>"false", "ResellerBilling"=>"false", "BalanceSeconds"=>"0", "EscrowSecondsUpdate"=>"0", "EscrowSecondsCredit"=>"0", "Balance"=>"00.00", "CreditLimit"=>"0.00", "Recharge"=>"false", "RechargeLevel"=>"0.00", "RechargeThreshold"=>"0.00", "Modified"=>"2014-12-03T19:04:34+00:00", "Created"=>"2014-03-24T14:15:44+00:00", "Contact"=>{"Name"=>"Bar  Foo", "Organization"=>"IceHook Systems", "Address"=>"123 Main St", "City"=>"New York", "State"=>"NY", "Zipcode"=>"100000", "Country"=>"United States of America", "CountryId"=>"207", "Phone"=>"1-212-555-1212", "Email"=>"test@icehook.com", "Modified"=>"2014-03-24T14:15:44+00:00"}, "CreditCard"=>{"CreditCardId"=>"12345", "AccountId"=>"54321", "CreditCardType"=>"3", "Name"=>"Foo Bar", "LastFour"=>"****", "Expiration"=>"01/2017", "Modified"=>"2014-10-15T18:07:36+00:00", "FirstName"=>"Foo", "LastName"=>"Bar", "Address"=>"123 Main St", "City"=>"New York", "State"=>"NY", "Zipcode"=>"10000", "CountryId"=>"207", "Phone"=>"1-212-555-1212", "IPAddress"=>"127.0.0.1"}}}}}}.to_json
+    stub_request(:get, Regexp.new('http://success.onsip.com/api?.*AccountRead.*'))
+    .to_return({
+      :body => success_body,
+      :status => 200,
+      :headers => { 'Content-Type' => 'application/json; charset=utf-8' }
+    })
+
+    failed_body = {"Response"=>{"Context"=>{"Action"=>{"IsCompleted"=>"false", "Errors"=>{"Error"=>{"Code"=>"AccountAuthorization.Required", "Message"=>"Permission to perform the requested action has not been granted."}}}, "Request"=>{"IsValid"=>"true", "DateTime"=>"2014-12-04T21:36:21+00:00", "Duration"=>"41", "Parameters"=>{"Parameter"=>[{"Name"=>"AccountId", "Value"=>"12345"}, {"Name"=>"Action", "Value"=>"AccountRead"}, {"Name"=>"Output", "Value"=>"json"}, {"Name"=>"SessionId", "Value"=>"j3kmb4boemqnl6u1vsip210rp7"}]}}, "Session"=>{"IsEstablished"=>"true", "SessionId"=>"j3kmb4boemqnl6u1vsip210rp7", "UserId"=>"212762", "Roles"=>{"Role"=>{"Name"=>"Account Admin"}}}}}}.to_json
+    stub_request(:get, Regexp.new('http://fail.onsip.com/api?.*AccountRead.*'))
+    .to_return({
+      :body => failed_body,
+      :status => 200,
+      :headers => { 'Content-Type' => 'application/json; charset=utf-8' }
+    })
+
+    OnSIP.session = OnSIP::Session.new("IsEstablished" => "true")
+  end
+
+  describe "Onsip::Account.read" do
+    it "has a valid id" do
+      OnSIP.connect('http://success.onsip.com')
+      account = OnSIP::Account.read('27370')
+      expect(account.class).to eq OnSIP::Account
+    end
+
+    it "has an invalid id" do
+      OnSIP.connect('http://fail.onsip.com')
+      account = nil
+      expect { account = OnSIP::Account.read('12345') }.to raise_error(OnSIP::Exceptions::OnSIPRequestError)
+      expect(account).to be(nil)
+    end
+  end
+
+end

data/spec/lib/onsip/models/cdr_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe OnSIP::CDR do
+  before :each do
+
+    body = {"Response"=>{"Context"=>{"Action"=>{"IsCompleted"=>"true"}, "Request"=>{"IsValid"=>"true", "DateTime"=>"2014-12-04T17:39:53+00:00", "Duration"=>"30", "Parameters"=>{"Parameter"=>[{"Name"=>"Action", "Value"=>"SessionCreate"}, {"Name"=>"Output", "Value"=>"json"}, {"Name"=>"Password", "Value"=>"******"}, {"Name"=>"Username", "Value"=>"icehook"}]}}, "Session"=>{"IsEstablished"=>"true", "SessionId"=>"j2vtu1bk7rsdpklofplu07ocq1", "UserId"=>"212762", "Roles"=>{"Role"=>{"Name"=>"Account Admin"}}}}, "Result"=>{"SessionCreate"=>{}}}}.to_json
+    stub_request(:get, Regexp.new('http://api.onsip.com/api?.*CdrBrowse.*'))
+    .to_return({
+      :body => body,
+      :status => 200,
+      :headers => { 'Content-Type' => 'application/json; charset=utf-8' }
+    })
+    OnSIP.connect('http://api.onsip.com')
+  end
+
+end

data/spec/lib/onsip/models/external_address_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe OnSIP::ExternalAddress do
+  before :each do
+
+    body = {"Response"=>{"Context"=>{"Action"=>{"IsCompleted"=>"true"}, "Request"=>{"IsValid"=>"true", "DateTime"=>"2014-12-04T17:39:53+00:00", "Duration"=>"30", "Parameters"=>{"Parameter"=>[{"Name"=>"Action", "Value"=>"SessionCreate"}, {"Name"=>"Output", "Value"=>"json"}, {"Name"=>"Password", "Value"=>"******"}, {"Name"=>"Username", "Value"=>"icehook"}]}}, "Session"=>{"IsEstablished"=>"true", "SessionId"=>"j2vtu1bk7rsdpklofplu07ocq1", "UserId"=>"212762", "Roles"=>{"Role"=>{"Name"=>"Account Admin"}}}}, "Result"=>{"SessionCreate"=>{}}}}.to_json
+    stub_request(:get, Regexp.new('http://api.onsip.com/api?.*ExternalAddressAdd.*'))
+    .to_return({
+      :body => body,
+      :status => 200,
+      :headers => { 'Content-Type' => 'application/json; charset=utf-8' }
+    })
+    OnSIP.connect('http://api.onsip.com')
+  end
+
+end

data/spec/lib/onsip/models/organization_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe OnSIP::Organization do
+  before :each do
+
+    body = {"Response"=>{"Context"=>{"Action"=>{"IsCompleted"=>"true"}, "Request"=>{"IsValid"=>"true", "DateTime"=>"2014-12-04T17:39:53+00:00", "Duration"=>"30", "Parameters"=>{"Parameter"=>[{"Name"=>"Action", "Value"=>"SessionCreate"}, {"Name"=>"Output", "Value"=>"json"}, {"Name"=>"Password", "Value"=>"******"}, {"Name"=>"Username", "Value"=>"icehook"}]}}, "Session"=>{"IsEstablished"=>"true", "SessionId"=>"j2vtu1bk7rsdpklofplu07ocq1", "UserId"=>"212762", "Roles"=>{"Role"=>{"Name"=>"Account Admin"}}}}, "Result"=>{"SessionCreate"=>{}}}}.to_json
+    stub_request(:get, Regexp.new('http://api.onsip.com/api?.*OrganizationAdd.*'))
+    .to_return({
+      :body => body,
+      :status => 200,
+      :headers => { 'Content-Type' => 'application/json; charset=utf-8' }
+    })
+    OnSIP.connect('http://api.onsip.com')
+  end
+
+end

data/spec/lib/onsip/models/user_address_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe OnSIP::UserAddress do
+  before :each do
+
+    body = {"Response"=>{"Context"=>{"Action"=>{"IsCompleted"=>"true"}, "Request"=>{"IsValid"=>"true", "DateTime"=>"2014-12-04T17:39:53+00:00", "Duration"=>"30", "Parameters"=>{"Parameter"=>[{"Name"=>"Action", "Value"=>"SessionCreate"}, {"Name"=>"Output", "Value"=>"json"}, {"Name"=>"Password", "Value"=>"******"}, {"Name"=>"Username", "Value"=>"icehook"}]}}, "Session"=>{"IsEstablished"=>"true", "SessionId"=>"j2vtu1bk7rsdpklofplu07ocq1", "UserId"=>"212762", "Roles"=>{"Role"=>{"Name"=>"Account Admin"}}}}, "Result"=>{"SessionCreate"=>{}}}}.to_json
+    stub_request(:get, Regexp.new('http://api.onsip.com/api?.*UserAddressAdd.*'))
+    .to_return({
+      :body => body,
+      :status => 200,
+      :headers => { 'Content-Type' => 'application/json; charset=utf-8' }
+    })
+    OnSIP.connect('http://api.onsip.com')
+  end
+
+end

data/spec/lib/onsip/models/user_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe OnSIP::User do
+  before :each do
+
+    body = {"Response"=>{"Context"=>{"Action"=>{"IsCompleted"=>"true"}, "Request"=>{"IsValid"=>"true", "DateTime"=>"2014-12-04T20:17:17+00:00", "Duration"=>"46", "Parameters"=>{"Parameter"=>[{"Name"=>"Action", "Value"=>"UserRead"}, {"Name"=>"Output", "Value"=>"json"}, {"Name"=>"SessionId", "Value"=>"bvb4thhuk1d7tb2bddf09teqr4"}, {"Name"=>"UserId", "Value"=>"260161"}]}}, "Session"=>{"IsEstablished"=>"true", "SessionId"=>"bvb4thhuk1d7tb2bddf09teqr4", "UserId"=>"212762", "Roles"=>{"Role"=>{"Name"=>"Account Admin"}}}}, "Result"=>{"UserRead"=>{"User"=>{"UserId"=>"260161", "OrganizationId"=>"30096", "AccountId"=>"27370", "Flags"=>"32", "Status"=>"disabled", "Domain"=>"sip.firertc.com", "Username"=>"test3_firertc", "Password"=>"**********", "AuthUsername"=>"test3_firertc", "Modified"=>"2014-11-24T19:24:03+00:00", "Created"=>"2014-11-03T19:30:08+00:00", "Ack911"=>"1970-01-01T00:00:00+00:00", "SurveyCompleted"=>"1970-01-01T00:00:00+00:00", "AckTrunkingTerms"=>"1970-01-01T00:00:00+00:00", "AckTrunkingE911"=>"1970-01-01T00:00:00+00:00", "AckHostedTerms"=>"1970-01-01T00:00:00+00:00", "AckHostedE911"=>"1970-01-01T00:00:00+00:00", "ExtendedDialing"=>"false", "PSTNForwarding"=>"false", "E911Provisioning"=>"false", "PSTNTrunking"=>"false", "FreePSTNTrunking"=>"false", "BusyLampField"=>"true", "Contact"=>{"Name"=>"test", "Organization"=>"IceHook Systems", "Address"=>"123 Main St", "City"=>"New York", "State"=>"NY", "Zipcode"=>"10000", "Country"=>"United States of America", "CountryId"=>"207", "Phone"=>"1-212-555-1212", "Email"=>"test@icehook.com", "Modified"=>"2014-11-03T19:30:08+00:00"}, "Roles"=>{"Role"=>{"Name"=>"User"}}}}}}}.to_json
+    stub_request(:get, Regexp.new('http://api.onsip.com/api?.*UserRead.*'))
+    .to_return({
+      :body => body,
+      :status => 200,
+      :headers => { 'Content-Type' => 'application/json; charset=utf-8' }
+    })
+    OnSIP.connect('http://api.onsip.com')
+    OnSIP.session = OnSIP::Session.new("IsEstablished" => "true")
+  end
+
+  describe "with valid id" do
+    it "can be read" do
+      user = OnSIP::User.read('260161')
+      expect(user.class).to eq OnSIP::User
+    end
+
+  end
+
+end

data/spec/lib/onsip/session_spec.rb

@@ -27,3 +27,5 @@ describe OnSIP::Session do
   end
 
 end
+
+# {"Response"=>{"Context"=>{"Action"=>{"IsCompleted"=>"false"}, "Request"=>{"IsValid"=>"true", "DateTime"=>"2014-12-04T20:07:08+00:00", "Duration"=>"8", "Parameters"=>{"Parameter"=>[{"Name"=>"Action", "Value"=>"SessionCreate"}, {"Name"=>"Output", "Value"=>"json"}, {"Name"=>"Password", "Value"=>"7onsip6"}, {"Name"=>"Username", "Value"=>"klarrimore@icehook.com"}]}, "Errors"=>{"Error"=>{"Parameter"=>"Action", "Code"=>"Accessor.LoginLocked", "Message"=>"You have failed to log in too many times. Please wait 10 minutes then try again."}}}, "Session"=>{"IsEstablished"=>"false"}}}}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onsip
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Keith Larrimore
@@ -157,6 +157,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -164,6 +167,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
@@ -305,6 +311,13 @@ files:
 - lib/onsip/session.rb
 - lib/onsip/version.rb
 - onsip.gemspec
+- spec/lib/onsip/models/account_spec.rb
+- spec/lib/onsip/models/cdr_spec.rb
+- spec/lib/onsip/models/external_address_spec.rb
+- spec/lib/onsip/models/organization_spec.rb
+- spec/lib/onsip/models/user_address_spec.rb
+- spec/lib/onsip/models/user_spec.rb
+- spec/lib/onsip/response_parser_spec.rb
 - spec/lib/onsip/session_spec.rb
 - spec/spec_helper.rb
 homepage: http://icehook.com
@@ -332,5 +345,12 @@ signing_key:
 specification_version: 4
 summary: OnSIP ruby client.
 test_files:
+- spec/lib/onsip/models/account_spec.rb
+- spec/lib/onsip/models/cdr_spec.rb
+- spec/lib/onsip/models/external_address_spec.rb
+- spec/lib/onsip/models/organization_spec.rb
+- spec/lib/onsip/models/user_address_spec.rb
+- spec/lib/onsip/models/user_spec.rb
+- spec/lib/onsip/response_parser_spec.rb
 - spec/lib/onsip/session_spec.rb
 - spec/spec_helper.rb