routengn-client 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 806113a37cf70dcb69d16ae7855f7d0bb002aa17
+  data.tar.gz: 4e958c370005c926a951c4f6618b0a07421d209f
+SHA512:
+  metadata.gz: 1ff754329b66454609e84401e491a934b8a790d35aab88a68be7f74dc01b3fd21384e9fcf64b0f22516933020a7358da2189cc935b85664f1c0448dccd52f09c
+  data.tar.gz: 025fb4be299d2efc8055934a7941da4b9aa85808d2eb67e49f1d573803c68f3e397cda6c85ad02165b511142439f2057751fbe70174a1178bc8f3d27cccc5e84

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in routengn-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,34 @@
+# RouteNGNClient
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'routengn-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install routengn-client
+
+## Usage
+
+```ruby
+MultiJson.use :yajl # set your prefered JSON library
+Faraday.default_adapter = :excon # set your preferred HTTP adapter
+
+RouteNGNClient.connect :uri => 'http://web.clusterx.routengn.com', :api_key => 'yourkey' # connect to RouteNGN
+
+carriers = Carrier.all # profit!
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/routengn_client/connection.rb

@@ -0,0 +1,77 @@
+module RouteNGNClient
+  class Connection
+
+    USER_AGENT = "routengn-client v#{RouteNGNClient::VERSION}"
+
+    attr_accessor :options, :faraday
+
+    def initialize(options = {})
+      @options = options
+      @faraday = self.create_faraday(@options[:uri], @options[:api_key]) if @options[:uri]
+    end
+
+    def create_faraday(uri, api_key = nil)
+      @faraday = Faraday.new uri do |c|
+        c.headers['User-Agent'] = USER_AGENT
+      
+        c.request :oauth2, api_key, :param_name => 'api_key' if api_key
+        c.request :multipart
+        c.request :url_encoded
+        c.request :multi_json
+
+        c.response :xml,  :content_type => /\bxml$/
+        c.response :multi_json, symbolize_keys: true, :content_type => /\bjson$/
+        c.response :routengn_response
+        c.response :logger, RouteNGNClient.logger
+
+        c.use :instrumentation
+        c.adapter Faraday.default_adapter
+      end
+    end
+
+    def request(method, path, params, options, &callback)
+      sent_at = nil
+      
+      response = @faraday.send(method) { |request|        
+        sent_at = Time.now
+        request = config_request(request, method, path, params, options)        
+      }.on_complete { |env|
+        env[:total_time] = Time.now.utc.to_f - sent_at.utc.to_f if sent_at
+        env[:request_params] = params
+        env[:request_options] = options        
+        callback.call(env) if callback
+      }
+
+      response
+    end
+
+    def config_request(request, method, path, params, options)
+      case method.to_sym
+      when :delete, :get
+        request.url(path, params)
+      when :post, :put
+        request.path = path
+        request.body = params unless params.empty?
+      end
+
+      request
+    end
+
+    def get(path, params={}, options={}, &callback)
+      request(:get, path, params, options, &callback)
+    end
+
+    def delete(path, params={}, options={}, &callback)
+      request(:delete, path, params, options, &callback)
+    end
+
+    def post(path, params={}, options={}, &callback)
+      request(:post, path, params, options, &callback)
+    end
+
+    def put(path, params={}, options={}, &callback)
+      request(:put, path, params, options, &callback)
+    end
+
+  end
+end

data/lib/routengn_client/exceptions.rb

@@ -0,0 +1,8 @@
+module RouteNGNClient
+  class RateNGNClientException < StandardError; end
+  class UnexpectedHTTPException < RateNGNClientException; end
+  class PermissionDeniedException < RateNGNClientException; end
+  class NonExistentRecord < RateNGNClientException; end
+  class RateNGNClientConnectionException < RateNGNClientException; end
+  class RouteNGNResponseException < RateNGNClientException; end
+end

data/lib/routengn_client/logging.rb

@@ -0,0 +1,23 @@
+module RouteNGNClient
+  module Logging
+    def logger
+      @logger ||= init_logger(STDOUT, :debug)
+    end
+
+    def init_logger(io, level)
+      logger = unless io
+        Logger.new(STDOUT)
+      else
+        Logger.new(io)
+      end
+
+      if level == :debug
+        logger.level = Logger::DEBUG
+      else
+        logger.level = Logger::INFO
+      end
+
+      logger
+    end
+  end
+end

data/lib/routengn_client/middleware/routengn_response_middleware.rb

@@ -0,0 +1,23 @@
+module RouteNGNClient
+  class RouteNGNResponseMiddleware < Faraday::Response::Middleware
+    include RouteNGNClient::Logging
+
+    ERROR_STATUSES = (400...600)
+
+    def on_complete(env)
+      case env[:status]
+      when 401
+        raise PermissionDeniedException
+      when 404        
+        raise NonExistentRecord
+      when 0
+        raise UnexpectedHTTPException, "recieved an unexpected HTTP response code #{env[:status]}"
+      when ERROR_STATUSES
+        raise UnexpectedHTTPException, "recieved an unexpected HTTP response code #{env[:status]}"
+      end
+
+      env
+    end
+
+  end
+end

data/lib/routengn_client/model.rb

@@ -0,0 +1,177 @@
+module RouteNGNClient
+  class Model
+    include Logging
+
+    attr_accessor :attributes, :request_account_id
+
+    def initialize(attributes = {})
+      @attributes = OpenStruct.new(attributes)
+      @request_account_id = nil
+      self.create_parent_accessors
+      self.create_child_accessors
+      self.create_only_child_accessors
+    end
+
+    def to_hash
+      @attributes.marshal_dump
+    end
+
+    def to_json(pretty = false)
+      MultiJson.dump(self.to_hash, :pretty => pretty)      
+    end
+
+    def to_log(options = {})
+      self.to_json(true)
+    end
+
+    module ClassMethods
+
+      attr_accessor :parents
+      attr_accessor :children
+      attr_accessor :only_children
+
+      def from_hash(h)
+        new h
+      end
+
+      def from_json(s)
+        from_hash MultiJson.load(s, :symbolize_keys => true)
+      end
+
+      def belongs_to(*args)
+        @parents = args.collect do |arg|
+          "RouteNGNClient::#{arg.to_s.classify}".constantize
+        end
+      end
+
+      def has_many(*args)
+        @children = args.collect do |arg|
+          "RouteNGNClient::#{arg.to_s.classify}".constantize
+        end
+      end
+
+      def has_one(*args)
+        @only_children = args.collect do |arg|
+          "RouteNGNClient::#{arg.to_s.classify}".constantize
+        end
+      end
+      
+    end
+
+    extend ClassMethods
+
+    protected
+
+    def create_only_child_accessors
+      return if self.class.only_children.blank?
+
+      p = self.class.to_s.demodulize.underscore.singularize.to_sym
+      instance = self
+
+      self.class.only_children.each do |klass|
+        c = klass.to_s.demodulize.underscore.singularize.to_sym
+        instance_var = "@#{klass.to_s.demodulize.underscore.singularize}".to_sym
+
+        (class << self; self; end).class_eval do
+          define_method(c) do |options = {}|
+            if model = instance_variable_get(instance_var)
+              return model
+            else
+              if attributes.send(c).is_a?(klass)
+                model = attributes.send(c)
+              elsif attributes.send(c).kind_of?(Hash)
+                model = klass.send :from_hash, attributes.send(c)
+              else            
+                child_id = attributes.send("#{c.to_s}_id".to_sym)
+                model = klass.send(:find, child_id, :account_id => instance.request_account_id) unless options[:no_fetch] || !child_id
+              end
+
+              return unless model
+
+              model.request_account_id = instance.request_account_id
+
+              instance_variable_set(instance_var, model)
+
+              model
+            end
+          end
+        end
+      end
+    end
+
+    def create_child_accessors
+      return if self.class.children.blank?
+
+      p = self.class.to_s.demodulize.underscore.singularize.to_sym
+      instance = self
+
+      self.class.children.each do |klass|
+        c = klass.to_s.demodulize.underscore.pluralize.to_sym
+        instance_var = "@#{klass.to_s.demodulize.underscore.pluralize}".to_sym
+
+        (class << self; self; end).class_eval do
+          define_method(c) do |options = {}|
+            if models = instance_variable_get(instance_var)
+              return models
+            else
+              collection = attributes.send(c) || []
+
+              models = collection.collect do |h|
+                if h.kind_of?(Hash) && h[c.to_s.singularize.to_sym]
+                  model = klass.send :from_hash, h[c.to_s.singularize.to_sym]
+                elsif h.kind_of?(Hash)
+                  model = klass.send :from_hash, h
+                else
+                  model = h
+                end
+                
+                model.request_account_id = instance.request_account_id
+
+                model
+              end
+
+              instance_variable_set(instance_var, models)
+
+              models
+            end
+          end
+        end
+      end
+
+    end
+
+    def create_parent_accessors
+      return if self.class.parents.blank?
+
+      self.class.parents.each do |klass|
+        p = klass.to_s.demodulize.underscore.singularize.to_sym
+        instance_var = "@#{klass.to_s.demodulize.underscore.singularize}".to_sym
+        instance = self
+
+        (class << self; self; end).class_eval do
+          define_method(p) do |options = {}|
+            if model = instance_variable_get(instance_var)
+              return model
+            else
+              if v = attributes.send(p)
+                model = v.kind_of?(Hash) ? klass.send(:from_hash, v) : v
+                model.request_account_id = instance.request_account_id
+                instance_variable_set(instance_var, model)
+                model
+              elsif !(id = attributes.send("#{p.to_s}_id".to_sym)).blank?
+                model = attributes.send(p) if attributes.send(p).is_a?(klass)
+                
+                model = klass.send(:find, id, :account_id => instance.request_account_id) unless model || options[:no_fetch]                
+
+                instance_variable_set(instance_var, model)
+
+                model
+              end
+            end
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/routengn_client/models/account.rb

@@ -0,0 +1,23 @@
+module RouteNGNClient
+  class Account < RemoteModel
+
+    set_resource_attributes({
+                              :path_base => 'system_admin/accounts',
+                              :collection_name => 'accounts',
+                              :per_page => 50,
+                              :request_options => {
+                              }
+                            })
+
+    has_many :users, :rate_sheets, :code_sheets, :carriers
+
+    attr_accessor :inbound_end_point_groups
+
+    def initialize(attributes = {})
+      super
+
+      @inbound_end_point_groups ||= []
+    end
+
+  end
+end

data/lib/routengn_client/models/allow_list.rb

@@ -0,0 +1,38 @@
+module RouteNGNClient
+  class AllowList < Model
+
+    belongs_to :inbound_end_point_group
+
+    def initialize(attributes = {})
+      super attributes
+
+      @attributes.uri_matchers = (@attributes.uri_matchers || []).collect { |h| RouteNGNClient::URIMatcher.from_hash h }
+      self.order_uri_matchers!
+    end
+
+    def order_uri_matchers!
+      @attributes.uri_matchers.sort!
+    end
+
+    def best_uri_match(header, uri)
+      return nil unless header && uri && @attributes.uri_matchers.find { |uri_matcher| uri_matcher.matches_header? header }
+
+      prefix = uri.user.prefix(self.inbound_end_point_group.dialcode_prefix_regexp) unless uri.user.blank?
+      user_params = uri.user.params.collect { |k,v| "#{k}=#{v}" } unless uri.user.params.blank?
+      uri_params = uri.params.collect { |k,v| "#{k}=#{v}" } unless uri.params.blank?
+
+      h = {}.with_indifferent_access
+      h[:header] = header
+      h[:prefix] = prefix unless prefix.blank?
+      h[:user_params] = user_params unless user_params.blank?
+      h[:uri_params] = uri_params unless uri_params.blank?
+
+      @attributes.uri_matchers.each do |uri_matcher|
+        return uri_matcher if uri_matcher.matches? h
+      end
+
+      nil
+    end
+
+  end
+end

data/lib/routengn_client/models/carrier.rb

@@ -0,0 +1,14 @@
+module RouteNGNClient
+  class Carrier < RemoteModel
+
+    set_resource_attributes({
+                              :path_base => 'metallic/carriers',
+                              :collection_name => 'carriers',
+                              :per_page => 25
+                            })
+
+    belongs_to :account
+    has_many :outbound_end_point_groups, :inbound_end_point_groups
+
+  end
+end

data/lib/routengn_client/models/code.rb

@@ -0,0 +1,32 @@
+module RouteNGNClient
+  class Code < RemoteModel
+
+    set_resource_attributes({
+                              :path_base => 'metallic/codes',
+                              :collection_name => 'codes',
+                              :per_page => 200,
+                              :request_options => {
+                              }
+                            })
+
+    class << self
+
+      def find_by_exploded_dialcode(dialcode, options = {}, &callback)
+        subsets = Utils.string_subsets dialcode
+        find_by_dialcodes subsets, options, &callback
+      end
+
+      def find_by_dialcodes(dialcodes, options = {}, &callback)
+        options = {:page => 1, :per_page => (dialcodes.length + 1)}.merge(self.resource_attributes[:request_options]).merge(options)
+
+        models = all({:code => {:dialcode => {'$in' => dialcodes}}}, options)
+
+        callback.call(models) if callback
+
+        models
+      end
+
+    end
+
+  end
+end

data/lib/routengn_client/models/code_sheet.rb

@@ -0,0 +1,11 @@
+module RouteNGNClient
+  class CodeSheet < RemoteModel
+
+    set_resource_attributes({
+                              :collection_name => 'code_sheets',
+                              :per_page => 25
+                            })
+    belongs_to :account
+
+  end
+end

data/lib/routengn_client/models/contact.rb

@@ -0,0 +1,124 @@
+module RouteNGNClient
+  class Contact < Model
+
+    def route
+      @attributes.route
+    end
+
+    def end_point
+      @attributes.end_point
+    end
+
+    def inbound_rate
+      self.route ? self.route.inbound_rate : nil
+    end
+
+    def outbound_rate
+      self.route ? self.route.outbound_rate : nil
+    end
+
+    def outbound_end_point_group
+      self.route.outbound_end_point_group if self.route
+    end
+
+    def aor
+      @attributes.aor
+    end
+
+    def build_aor(sip_request, inbound_end_point_group, options = {})
+      options = options.with_indifferent_access
+
+      uri = self.build_uri(sip_request)
+
+      template = Template.new(inbound_end_point_group.attributes.contact_template)
+      template.sub!(self, uri, :inbound_end_point_host => options[:inbound_end_point_host], :inbound_end_point_port => options[:inbound_end_point_port])
+
+      @attributes.aor = template.contact_template
+    end
+
+    def build_uri(sip_request, options = {})
+      options = options.with_indifferent_access
+
+      request_uri = sip_request.request_uri
+      sip_uri = request_uri.clone
+      oepg = self.outbound_end_point_group
+      oepg_parts = oepg ? oepg.build_uri_parts : {}
+      oep_parts = self.end_point ? self.end_point.build_uri_parts : {}
+
+      dialcode = oepg && oepg.attributes.dialcode_expression ? sip_uri.user.dialcode(oepg.dialcode_regexp) : sip_uri.user.user
+      dialcode = oepg.attributes.dialcode_template.gsub("${dialcode_match}", dialcode) if dialcode && oepg && oepg.attributes.dialcode_template
+
+      blacklisted_user_params = oepg.attributes.uri_user_params_blacklist || [] if oepg
+      blacklisted_params = oepg.attributes.uri_params_blacklist || [] if oepg
+      merge_user_params, merge_params = {}, {}
+
+      merge_user_params['rn'] = sip_request.rn if sip_request.rn && !sip_request.request_uri.params.keys.include?('rn') && !sip_request.request_uri.params.keys.include?('rn')
+      merge_user_params['npdi'] = sip_request.npdi if sip_request.npdi && !sip_request.request_uri.params.keys.include?('npdi') && !sip_request.request_uri.params.keys.include?('npdi')
+      merge_user_params.merge! oepg_parts[:uri_user_params]
+      merge_params['rn'] = sip_request.rn if sip_request.rn && !merge_user_params.has_key?('rn')
+      merge_params['npdi'] = sip_request.npdi if sip_request.npdi && !merge_user_params.has_key?('npdi')
+      merge_params.merge! oepg_parts[:uri_params]
+
+      sip_uri.regenerate(:user => {
+                                   :user => dialcode,
+                                   :merge_params => merge_user_params,
+                                   :blacklisted_params => blacklisted_user_params
+                                  },
+                         :host => oep_parts[:host],
+                         :port => oep_parts[:port],
+                         :merge_params => merge_params,
+                         :blacklisted_params => blacklisted_params)
+    end
+
+    class Template
+
+      attr_accessor :contact_template
+
+      def initialize(contact_template)
+        @contact_template = contact_template.clone
+      end
+
+      def sub!(contact, sip_uri, options = {})
+        options = options.with_indifferent_access
+
+        iep_host = options[:inbound_end_point_host]
+        iep_port = options[:inbound_end_point_port]
+
+        #@contact_template.gsub!("${oepg.prefix}", '') # legacy as of 10/24/12
+        @contact_template.gsub!("${ruri.dialcode}", sip_uri.user.user_string)
+        @contact_template.gsub!("${ruri.user_params}", !sip_uri.user.params.blank? ? ";#{sip_uri.user.params_string}" : '')
+        @contact_template.gsub!("${ruri.params}", !sip_uri.params.blank? ? ";#{sip_uri.params_string}" : '')
+        @contact_template.gsub!("${iep.host}", !iep_host.blank? ? iep_host : '')
+        @contact_template.gsub!("${iep.port}", !iep_port.blank? ? ":#{iep_port}" : '')
+        @contact_template.gsub!("${oep.host}", sip_uri.host)
+        @contact_template.gsub!("${oep.port}", ":#{sip_uri.port}")
+        @contact_template.gsub!("${oepg.prefix}", '')  # legacy as of 10/24/12
+        @contact_template.gsub!("${oepg.uri_user_params}", '') #legacy as of 3/29/13 (params already merged in)
+        @contact_template.gsub!("${oepg.uri_params}", '') #legacy as of 3/29/13 (params already merged in)
+
+        self.sub_outbound_rate! contact.outbound_rate
+        self.sub_inbound_rate! contact.inbound_rate
+      end
+
+      def sub_outbound_rate!(rate)
+        @contact_template.gsub!("${or.price}", rate && rate.attributes.price ? rate.attributes.price.to_s : '?')
+        @contact_template.gsub!("${or.type}", rate && rate.attributes.type ? rate.attributes.type : '?')
+        @contact_template.gsub!("${or.dialcode}", rate && rate.attributes.dialcode ? rate.attributes.dialcode : '?')
+        @contact_template.gsub!("${or.lata}", rate && rate.attributes.lata ? rate.attributes.lata : '?')
+        @contact_template.gsub!("${or.ocn}", rate && rate.attributes.ocn ? rate.attributes.ocn : '?')
+        @contact_template.gsub!("${or.billing_increment}", rate && rate.attributes.billing_increment ? rate.attributes.billing_increment.to_s : '?')
+      end
+
+      def sub_inbound_rate!(rate)
+        @contact_template.gsub!("${ir.price}", rate && rate.attributes.price ? rate.attributes.price.to_s : '?')
+        @contact_template.gsub!("${ir.type}", rate && rate.attributes.type ? rate.attributes.type : '?')
+        @contact_template.gsub!("${ir.dialcode}", rate && rate.attributes.dialcode ? rate.attributes.dialcode : '?')
+        @contact_template.gsub!("${ir.billing_increment}", rate && rate.attributes.billing_increment ? rate.attributes.billing_increment.to_s : '?')
+        @contact_template.gsub!("${ir.lata}", rate && rate.attributes.lata ? rate.attributes.lata : '?')
+        @contact_template.gsub!("${ir.ocn}", rate && rate.attributes.ocn ? rate.attributes.ocn : '?')
+      end
+
+    end
+
+  end
+end

data/lib/routengn_client/models/end_point.rb

@@ -0,0 +1,18 @@
+module RouteNGNClient
+  class EndPoint < Model
+
+    belongs_to :outbound_end_point_group, :inbound_end_point_group
+
+    def build_uri_parts(options = {})
+      {
+        :host => (self.attributes.host ? self.attributes.host.strip : ''),
+        :port => (self.attributes.port ? self.attributes.port.to_s : '')
+      }
+    end
+
+    def random_priority(max = 1000)
+      rand(max)
+    end
+
+  end
+end