routengn 0.2.9

data/README.rdoc

@@ -0,0 +1,61 @@
+= Introduction
+
+This is a Ruby API Wrapper for the RouteNGN SIP routing platform. For more information about
+RouteNGN, see http://www.routengn.com.
+
+*  Note: This is not the RouteNGN API itself.  This a wrapper designed to make it easier to integrate with the RouteNGN API.
+
+= Installation
+
+Install the "routengn" gem by typing
+
+  $ sudo gem sources -a http://gems.github.com
+  $ sudo gem install klarrimore-routengn
+
+The first line tells RubyGems to add the GitHub gem repository. You only need
+to run this command once.
+
+= Examples
+
+Using irb:
+
+  klarrimore@calculatorwristwatch:~$ irb
+  irb(main):001:0> require 'rubygems'
+  => true
+  irb(main):002:0> require 'routengn'
+  => true
+  irb(main):003:0> RouteNGN.connect! "http://routengn.net", "qcuL3YAw9ZXdmSdqprBw", "LDI2rgxIhJlNu5FBXh0UvtxJRtpr1OgnCIQ8Mpk"
+  => #<RouteNGN::Connection:0x7ffaadc3f578 @access_token=#<OAuth::AccessToken:0x....
+  irb(main):004:0> Carrier.all
+  => [#<Carrier:0x7f1c6e36ce28 @id=152, @saved=true, @name="test">]
+  irb(main):005:0> Carrier.first.groups
+  => [#<Group:0x7f1c6e335c70 @active_end_day=nil, @id=103, @add_type=nil, @carrier_id=152, @strip_digits=nil,
+  @active_begin_day=nil, @add_field=nil, @saved=true, @active_end_time=nil, @margin=0, @trunkgroup=nil,
+  @add_digits=nil, @active_begin_time=nil, @direction="in", @name="test2", @remove_rn=nil, @prefix=nil,
+  @rn_prefix=nil>, #<Group:0x7f1c6e335c48 @active_end_day=nil, @id=102, @add_type=nil, @carrier_id=152,
+  @strip_digits=nil, @active_begin_day=nil, @add_field=nil, @saved=true, @active_end_time=nil, @margin=0, @trunkgroup=nil,
+  @add_digits=nil, @active_begin_time=nil, @direction="out", @name="test", @remove_rn=nil, @prefix=nil, @rn_prefix=nil>]
+  irb(main):006:0> Carrier.first.groups.first.endpoints
+  => [#<Endpoint:0x7f1c6e2f21c8 @id=39, @saved=true, @ip="65.200.189.134">]
+  
+= Credits
+
+  klarrimore@gentel.net
+  qhoxie@gentel.net
+
+= License
+
+ Copyright 2008-2009 GT3 HOLDINGS, LLC
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/bin/ngncmd

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'thor'
+require File.dirname(__FILE__) + '/../lib/routengn'
+
+class NGNCommand < Thor
+  map "--configure" => :configure,
+      "--upload-regions" => :region_upload
+
+  desc "configure", "Set up your RouteNGN API config (.ngnconf)"
+  def configure
+    user = ENV['USER'] ? ENV['USER'] : `who am i`
+    say "Configuring ngncmd for #{user}...", :yellow
+    site = ask "RouteNGN Site (ex. http://routengn.net):", :magenta
+    key = ask "API Key:", :magenta
+    secret = ask "API Secret:", :magenta
+    say "Trying to connect... ", :yellow
+    begin
+      if RouteNGN.connect! site, key, secret
+        say "Success", :green
+        say "Writing config file... ", :yellow
+        RouteNGN.write_config
+        return say("Success", :green)
+      end
+    rescue Exception
+      # noop
+    end
+    say "Failed", :red
+    say "\nPlease check your site and credentials and try again.", :red
+    exit 1
+  end
+
+  desc "upload regions", "Upload a regions file"
+  def region_upload
+    file = ask "Path to file:", :magenta
+    unless File.readable? file
+      say "Error: file is not readable"
+      exit 1
+    end
+    connect
+    say "Uploading file... "
+    Region.upload(file)
+    say "Success"
+  end
+
+
+  no_tasks do
+    def connect
+      say "Establishing connection... "
+      RouteNGN.connect!
+      say "Success"
+    rescue Exception
+      say "Failed"
+      exit 1
+    end
+  end
+end
+
+
+NGNCommand.start
+

data/examples/cli.rb

@@ -0,0 +1,201 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'rubygems'
+require 'json'
+gem 'oauth'
+require 'oauth/consumer'
+require 'http/multipart'
+
+@consumer=OAuth::Consumer.new "qcuL3sYAw9ZXdmSdqprBw", #API key
+                              "LDI2rgxnIhJlNu5FBXh0UvtxJRtpr1OgnCIQ8Mpk", #API secret
+                              { :signature_method   => 'HMAC-SHA1',
+                                :site=>"http://127.0.0.1:3000" #EX: http://routengn.net
+                              }
+
+@request_token = @consumer.get_request_token
+
+@consumer.request(:get, @request_token.authorize_url)
+
+@access_token = @request_token.get_access_token
+@access_token.consumer.http.read_timeout = 5000
+
+def main_menu
+  puts "\nMain Menu:\n1. manage carriers\n2. manage regions\n3. upload regions or rates\n4. manage route tables\n"
+  str = gets.chomp
+  case str
+    when '1'
+      carrier_menu
+    when '2'
+      region_menu 
+    when '3'
+      upload_menu
+    when '4'
+      route_table_menu
+    else
+      puts 'wtf'
+  end
+end
+
+def carrier_menu
+  puts "\nCarrier Menu:\n1. list carriers\n2. list groups\n3. list end points\n4. add carriers\n5. add groups\n6. add end points\n7. delete carriers\n8. delete groups\n9. delete end points\n"
+  str = gets.chomp
+  case str
+    when '1' #list carriers
+      puts "\n" + JSON.parse(@access_token.get('/carrier/carrier').body).inspect
+    when '2' #list groups
+      print "carrier id: "
+      carrier_id = gets.chomp
+      puts "\n" + JSON.parse(@access_token.get("/carrier/group/#{carrier_id}").body).inspect
+      when '3' #list end points
+      print "group id: "
+      group_id = gets.chomp
+      puts "\n" + JSON.parse(@access_token.get("/carrier/endpoint/#{group_id}").body).inspect
+    when '4' #add carriers
+      print "carrier name: "
+      carrier_name = gets.chomp
+      puts "\n" + JSON.parse(@access_token.post("/carrier/carrier/#{carrier_name}").body).inspect
+    when '5' #add groups
+      print "carrier id: "
+      carrier_id = gets.chomp
+      print "group name: "
+      group_name = gets.chomp
+      puts "\n" + JSON.parse(@access_token.post("/carrier/group/#{group_name}/#{carrier_id}").body).inspect
+    when '6' #add end points
+      print "group id: "
+      group_id = gets.chomp
+      print "end point name: "
+      endpoint_name = gets.chomp
+      puts "\n" + JSON.parse(@access_token.post("/carrier/endpoint/#{endpoint_name}/#{group_id}").body).inspect
+    when '7' #delete carriers
+      print "carrier id: "
+      carrier_id = gets.chomp
+      puts "\n" + JSON.parse(@access_token.delete("/carrier/carrier/#{carrier_id}").body).inspect
+    when '8' #delete groups
+      print "group id: "
+      group_id = gets.chomp
+      puts "\n" + JSON.parse(@access_token.delete("/carrier/group/#{group_id}").body).inspect
+    when '9' #delete end points
+      print "end point id: "
+      endpoint_id = gets.chomp
+      puts "\n" + JSON.parse(@access_token.delete("/carrier/endpoint/#{endpoint_id}").body).inspect
+    when 'back'
+      return  
+  end
+end
+
+def region_menu
+  puts "\nRegion Menu:\n1. list regions\n2. list locales\n3. list dial codes\n4. add regions\n5. add locales\n6. add dial codes\n7. delete regions\n8. delete locales\n9. delete dial codes\n"
+  str = gets.chomp
+  case str
+    when '1' #list regions
+      puts "\n" + JSON.parse(@access_token.get('/region/region').body).inspect
+    when '2' #list locales
+      print "region id: "
+      region_id = gets.chomp
+      puts "\n" + JSON.parse(@access_token.get("/region/locale/#{region_id}").body).inspect
+    when '3' #list dial codes
+      print "locale id: "
+      locale_id = gets.chomp
+      puts "\n" + JSON.parse(@access_token.get("/region/dialcode/#{locale_id}").body).inspect
+    when '4' #add regions
+      print "region name: "
+      region_name = gets.chomp
+      puts "\n" + JSON.parse(@access_token.post("/region/region/#{region_name}").body).inspect
+    when '5' #add locales
+      print "region id: "
+      region_id = gets.chomp
+      print "locale name: "
+      locale_name = gets.chomp
+      puts "\n" + JSON.parse(@access_token.post("/region/locale/#{locale_name}/#{region_id}").body).inspect
+    when '6' #add dial codes
+      print "locale id: "
+      locale_id = gets.chomp
+      print "dialcode: "
+      dialcode = gets.chomp
+      puts "\n" + JSON.parse(@access_token.post("/region/dialcode/#{dialcode}/#{locale_id}").body).inspect
+    when '7' #delete regions
+      print "region id: "
+      region_id = gets.chomp
+      puts "\n" + JSON.parse(@access_token.delete("/region/region/#{region_id}").body).inspect
+    when '8' #delete locales
+      print "locale id: "
+      locale_id = gets.chomp
+      puts "\n" + JSON.parse(@access_token.delete("/region/locale/#{locale_id}").body).inspect
+    when '9' #delete dial codes
+      print "dialcode id: "
+      dialcode_id = gets.chomp
+      puts "\n" + JSON.parse(@access_token.delete("/region/dialcode/#{dialcode_id}").body).inspect 
+    when 'back'
+      return
+  end
+end
+
+def upload_menu
+  puts "\nUpload Menu:\n1. upload regions\n2. upload rates\n"
+  str = gets.chomp
+  case str
+    when '1'
+      print "path: "
+      path = gets.chomp
+      data, headers = Multipart::Post.prepare_query("title" => 'title', "uploaded_data" => File.new(path))
+      puts @access_token.put('/upload/regions', data, headers)
+    when '2'
+      print "path: "
+      path = gets.chomp
+      print "rate type: "
+      rate_type = gets.chomp
+      print "groups: "
+      groups = gets.chomp
+      data, headers = Multipart::Post.prepare_query("title" => 'title', "uploaded_data" => File.new(path))
+      puts @access_token.put("/upload/rates/#{rate_type}/#{groups}", data, headers)
+    when 'back'
+      return
+  end
+end
+
+def route_table_menu
+  puts "\nRoute Table Menu:\n1. list instances\n2. list routes\n3. create instance\n4. generate lcr\n5. search\n"
+  str = gets.chomp
+  case str
+    when '1'
+      puts @access_token.get('/route/instances').body      
+    when '2'
+      
+      puts @access_token.get('/route/routes/13').body
+    when '3'
+      print "table name: "
+      table_name = gets.chomp
+      print "table type: "
+      table_type = gets.chomp
+      puts @access_token.post("/route/table/#{table_name}/#{table_type}").body 
+    when '4'
+      print "table type: "
+      table_type = gets.chomp
+      print "instance id: "
+      instance_id = gets.chomp
+      print "groups: "
+      groups = gets.chomp
+      puts @access_token.put("/route/update/lcr/#{table_type}/#{instance_id}/#{groups}").body
+    when '5'
+      print "search type: "
+      search_type = gets.chomp
+      print "instance id: "
+      instance_id = gets.chomp
+      print "table type: "
+      table_type = gets.chomp
+      print "route type: "
+      route_type = gets.chomp
+      print "search: "
+      search = gets.chomp
+      puts @access_token.get("/route/search/#{search_type}/#{instance_id}/#{table_type}/#{route_type}/#{search}").body 
+    when 'back'
+      return
+  end
+end
+
+while true
+  main_menu
+end
+

data/examples/provision.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
+require 'routengn'
+
+RouteNGN.connect! "http://beta.routengn.net", "qcuL3sYAw9ZXdmSdqprBw", "LDI2rgxnIhJlNu5FBXh0UvtxJRtpr1OgnCIQ8Mpk"
+
+Region.upload('my_regions.csv')
+
+carrier = Carrier.new({'name' => 'api_test_carrier'})
+carrier.save
+puts carrier.inspect
+
+group = Group.new({'name' => 'api_test_group', 'direction' => 'out', 'carrier_id' => carrier.id})
+group.save
+puts group.inspect
+
+endpoint = Endpoint.new({'ip' => '3.3.3.3', 'epgroup_id' => group.id})
+endpoint.save
+puts endpoint.inspect
+
+type_id = Type.first('name'=> 'lcr').id
+
+instance = Instance.new('name' => 'api_test_table', 'type_id' => type_id)
+instance.save
+puts instance.inspect
+
+Rate.upload('my_rates.csv', 'group' => group.id, 'type_id' => type_id)
+
+Instance.first.generate(Group.all.collect{|x| x.id})
+
+RouteNGN.apply!

data/lib/routengn/console.rb

@@ -0,0 +1,18 @@
+HISTFILE = "~/.routengn.irb.hist"
+MAXHISTSIZE = 1000
+
+if defined? Readline::HISTORY
+  histfile = File.expand_path(HISTFILE)
+  if File.exists?(histfile)
+    lines = IO.readlines(histfile).collect { |line| line.chomp }
+    Readline::HISTORY.push(*lines)
+  end
+
+  Kernel.at_exit do
+    lines = Readline::HISTORY.to_a.reverse.uniq.reverse
+    lines = lines[-MAXHISTSIZE, MAXHISTSIZE] if lines.nitems > MAXHISTSIZE
+    File.open(histfile, File::WRONLY|File::CREAT|File::TRUNC) do |f|
+      lines.each { |line| f.puts line }
+    end
+  end
+end

data/lib/routengn/http/multipart.rb

@@ -0,0 +1,64 @@
+module RouteNGN
+  module HTTP
+    module Multipart
+      # From: http://deftcode.com/code/flickr_upload/multipartpost.rb
+      ## Helper class to prepare an HTTP POST request with a file upload
+      ## Mostly taken from
+      #http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/113774
+      ### WAS:
+      ## Anything that's broken and wrong probably the fault of Bill Stilwell
+      ##(bill@marginalia.org)
+      ### NOW:
+      ## Everything wrong is due to keith@oreilly.com     
+
+      BOUNDARY = 'larrimores-rule0000'
+      HEADER = {"Content-type" => "multipart/form-data, boundary=" + BOUNDARY + " "}
+
+      class Param
+        attr_accessor :k, :v
+
+        def initialize( k, v )
+          @k = k
+          @v = v
+        end
+
+        def to_multipart
+          #return "Content-Disposition: form-data; name=\"#{CGI::escape(k)}\"\r\n\r\n#{v}\r\n"
+          # Don't escape mine...
+          return "Content-Disposition: form-data; name=\"#{k}\"\r\n\r\n#{v}\r\n"
+        end
+      end
+
+      class FileParam
+        attr_accessor :k, :filename, :content
+
+        def initialize( k, filename, content )
+          @k = k
+          @filename = filename
+          @content = content
+        end
+
+        def to_multipart
+          #return "Content-Disposition: form-data; name=\"#{CGI::escape(k)}\"; filename=\"#{filename}\"\r\n" + "Content-Transfer-Encoding: binary\r\n" + "Content-Type: #{MIME::Types.type_for(@filename)}\r\n\r\n" + content + "\r\n "
+          # Don't escape mine
+          return "Content-Disposition: form-data; name=\"#{k}\"; filename=\"#{filename}\"\r\n" + "Content-Transfer-Encoding: binary\r\n" + "Content-Type: #{MIME::Types.type_for(@filename)}\r\n\r\n" + content + "\r\n"
+        end
+      end
+
+      def self.prepare_query(params)
+        fp = []
+        params.each {|k, v|
+          if v.respond_to?(:read)
+            fp.push(FileParam.new(k, v.path, v.read))
+          else
+            fp.push(Param.new(k, v))
+          end
+        }
+        query = fp.collect {|p| "--" + BOUNDARY + "\r\n" + p.to_multipart }.join("") + "--" + BOUNDARY + "--"
+        return query, HEADER
+      end
+    end
+  end
+end
+
+

data/lib/routengn/mapper.rb

@@ -0,0 +1,159 @@
+module RouteNGN
+  module Mapper
+    def self.included(model)
+      model.class_eval do
+        extend ClassMethods
+        include InstanceMethods
+      end
+    end
+  end
+
+  #TODO perhaps we can add some of the goodies provided through relationships like '<<'
+  module InstanceMethods
+    attr_accessor :saved
+
+    def attributes
+      self.class.fields.inject({}) do |_, field|
+        _[field] = send field
+        _
+      end
+    end
+
+    def attr_params
+      self.attributes.inject({}) do |params, (k, v)|
+        params["#{self.class.name.downcase}[#{k}]"] = v
+        params
+      end
+    end
+
+    def new?
+      !(@saved ||= false)
+    end
+
+    def save
+      response = if new?    
+        RouteNGN.post self.class.base_url, attr_params
+      else
+        RouteNGN.put self.class.base_url, attr_params
+      end
+
+      return false if !response.success?
+
+      @saved = true
+
+      # populates fields with data that was sent back
+      self.class.fields.each do |field|
+        element = response['data'].first
+        self.send :"#{field}=", element[field.to_s] if element[field.to_s]
+      end
+
+      true
+    end
+
+    def destroy
+      response = RouteNGN.delete self.class.base_url, :id => primary
+      response.success?
+    end
+  end # InstanceMethods
+
+  module ClassMethods
+    attr_reader :fields
+    attr_reader :primary_field
+
+    def new(opts = {})
+      instance = super() # don't want implicit args
+      @fields.each do |field|
+        field = field.to_s
+        next unless opts.has_key? field
+        instance.send :"#{field}=", opts[field]
+      end
+      raise PrimaryFieldException.new unless instance.respond_to? :primary
+      instance
+    end
+
+    def new_from_saved(opts = {})
+      instance = new opts
+      instance.saved = true
+      instance
+    end
+
+    def base_url
+      "/#{name.downcase.pluralize}"
+    end
+
+    def field(name, opts = {})
+      @fields ||= []
+      return if @fields.include? name
+      @fields << name
+      define_method(name) { instance_variable_get :"@#{name}" }
+      define_method(:"#{name}=") { |val| instance_variable_set :"@#{name}", val }
+      if opts[:primary]
+        raise MultiplePrimaryFieldsException.new if @primary_field
+        alias_method :primary, name
+        @primary_field = name
+      end
+    end
+
+    def belongs_to(klass, opts = {})  # This isn't really a klass (in the traditional sense) but a symbol rather... so we need to_s
+      attr = opts[:column] ? opts[:column] : :"#{klass}_id"
+      field attr
+      define_method(klass) { klass.to_s.camelize.constantize.first :id => send(attr) }
+    end
+
+    def has_one(klass, opts = {})  # This isn't really a klass (in the traditional sense) but a symbol rather... so we need to_s
+      attr = opts[:column] ? opts[:column] : :"#{name.downcase}_id"
+      define_method(klass) { klass.to_s.camelize.constantize.first attr => primary }
+    end
+
+    def has_many(klass, opts = {})  # This isn't really a klass (in the traditional sense) but a symbol rather... so we need to_s
+      attr = opts[:column] ? opts[:column] : :"#{name.downcase}_id"
+      define_method(klass.to_s.pluralize.to_sym) { klass.to_s.singularize.camelize.constantize.all attr => primary }
+    end
+
+    def delete(id)
+      response = RouteNGN.delete base_url, :id => id
+      response.success?
+    end
+
+    def find(*args)
+      case args.first
+      when :all
+        all(*args[1..-1])
+      else
+        first(*args[1..-1])
+      end
+    end
+
+    def all(opts = {})
+      result = []
+
+      response = RouteNGN.get base_url, opts
+
+      data = response['data']
+
+      return [new_from_saved(data)] unless data.is_a? Array
+
+      data.each do |d|
+        result << new_from_saved(d)
+      end
+
+      result
+    end
+
+    def first(opts = {})
+      all(opts).first # optimize/simplify?
+    end
+  end # ClassMethods
+
+  class PrimaryFieldException < Exception
+    def initialize(msg = "Model does not specify a primary field.")
+      super
+    end
+  end
+
+  class MultiplePrimaryFieldsException < Exception
+    def initialize(msg = "Model specifies too many primary fields.")
+      super
+    end
+  end
+end # RouteNGN

data/lib/routengn/models/carrier.rb

@@ -0,0 +1,8 @@
+class Carrier
+  include RouteNGN::Mapper
+
+  field :id, :primary => true
+  field :name
+
+  has_many :groups
+end

data/lib/routengn/models/dialcode.rb

@@ -0,0 +1,8 @@
+class Dialcode
+  include RouteNGN::Mapper
+
+  field :id, :primary => true
+  field :digits
+
+  belongs_to :locale
+end

data/lib/routengn/models/endpoint.rb

@@ -0,0 +1,8 @@
+class Endpoint
+  include RouteNGN::Mapper
+
+  field :id, :primary => true
+  field :ip
+
+  belongs_to :group, :column => :epgroup_id
+end

data/lib/routengn/models/group.rb

@@ -0,0 +1,31 @@
+class Group
+  include RouteNGN::Mapper
+
+  #TODO: fixure out a fix for abnormal foreign key 'epgroup_id'
+
+  field :id, :primary => true
+  field :name
+  field :direction
+  field :margin
+  field :prefix
+  field :strip_digits
+  field :rn_prefix
+  field :add_digits
+  field :add_field
+  field :add_type
+  field :blocked_region_id
+  field :route_on_type_id
+  field :remove_rn
+  field :trunkgroup
+  field :active_begin_day
+  field :active_end_day
+  field :active_begin_time
+  field :active_end_time 
+
+  belongs_to :instance
+  belongs_to :carrier
+  
+  has_many :endpoints, :column => :epgroup_id
+  has_many :rates
+
+end

data/lib/routengn/models/instance.rb

@@ -0,0 +1,21 @@
+class Instance
+  include RouteNGN::Mapper
+
+  field :id, :primary => true
+  field :name
+
+  belongs_to :type
+
+  # custom method
+  # TODO make this more generic... possibly add functionality to the mapper that will allow for custom actions  
+  def generate(groups)
+    groups_params = groups.inject({}) do |params, (k, v)|
+        params["groups[#{k}]"] = 1
+        params
+    end
+
+    response = RouteNGN.put self.class.base_url, {:id => self.id}.merge!(groups_params)
+    response.success?
+  end
+
+end

data/lib/routengn/models/locale.rb

@@ -0,0 +1,11 @@
+class Locale
+  include RouteNGN::Mapper
+
+  field :id, :primary => true
+  field :name
+
+  belongs_to :region
+
+  has_many :dialcodes
+  has_many :rates
+end

data/lib/routengn/models/rate.rb

@@ -0,0 +1,11 @@
+class Rate
+  include RouteNGN::Mapper
+  include RouteNGN::Uploader
+
+  field :id, :primary => true
+  field :rate
+
+  belongs_to :type
+  belongs_to :locale
+  belongs_to :group, :column => :epgroup_id
+end

data/lib/routengn/models/record.rb

@@ -0,0 +1,17 @@
+class Record
+  include RouteNGN::Mapper
+
+  field :dialcode, :primary => true
+  field :account_id
+  field :rn
+  field :locale_id
+  field :sent
+  field :received
+  field :detail
+  field :server
+  field :response_time
+  field :created_at_in_seconds
+  field :created_at
+  field :updated_at
+
+end

data/lib/routengn/models/region.rb

@@ -0,0 +1,9 @@
+class Region
+  include RouteNGN::Mapper
+  include RouteNGN::Uploader
+
+  field :id, :primary => true
+  field :name
+
+  has_many :locales
+end

data/lib/routengn/models/route.rb

@@ -0,0 +1,8 @@
+class Route
+  include RouteNGN::Mapper
+
+  field :id, :primary => true
+  
+  belongs_to :instance
+  belongs_to :type
+end

data/lib/routengn/models/type.rb

@@ -0,0 +1,7 @@
+class Type
+  include RouteNGN::Mapper
+
+  field :id, :primary => true
+  field :name
+
+end

data/lib/routengn/uploader.rb

@@ -0,0 +1,17 @@
+module RouteNGN
+  module Uploader
+    def self.included(model)
+      model.class_eval do
+        extend ClassMethods
+      end
+    end
+  end
+
+  module ClassMethods
+    def upload(file, opts = {})
+      args = {:uploaded_data => File.new(file)}.merge! opts
+      data, headers = HTTP::Multipart.prepare_query(args)
+      RouteNGN.upload("/upload#{base_url}", data, headers)
+    end
+  end
+end

data/lib/routengn.rb

@@ -0,0 +1,151 @@
+require 'rubygems'
+gem 'oauth'
+require 'oauth/consumer'
+require 'json'
+
+$: << File.expand_path(File.join File.dirname(__FILE__), 'routengn')
+require 'mime/types'
+require 'cgi'
+require 'http/multipart'
+require 'mapper'
+require 'uploader'
+require 'active_support'
+
+module RouteNGN
+  Dir.glob(File.dirname(__FILE__) + "/routengn/models/*.rb").each do |model|
+    require File.expand_path(model)
+  end
+
+  CONF_FILE = File.join ENV['HOME'], ".ngnconf"
+
+  class Connection
+    attr_accessor :access_token
+
+    def initialize(*args)
+      @site, @key, @secret = args.empty? ? file_config : args
+      @consumer = OAuth::Consumer.new @key, @secret, {
+        :signature_method => 'HMAC-SHA1',
+        :site => @site
+      }
+
+      @request_token = @consumer.get_request_token
+      @consumer.request(:get, @request_token.authorize_url)
+
+      @access_token = @request_token.get_access_token
+      @access_token.consumer.http.read_timeout = 5000
+    end
+
+    def to_json
+      {:site => @site, :key => @key, :secret => @secret}.to_json
+    end
+
+    private
+    def file_config
+      data = File.open(CONF_FILE).read
+      data = JSON.parse data
+      [data['site'], data['key'], data['secret']]
+    end
+  end
+
+  class << self
+    def connect!(*args)
+      @connection = Connection.new *args
+    end
+
+    def connection
+      @connection
+    end
+
+    def write_config
+      File.open(CONF_FILE, 'w') do |f|
+        f << connection.to_json
+      end
+    end
+
+    [:get, :delete].each do |http_method|
+      define_method(http_method) do |*args|
+        uri, params = args
+        params ||= {}        
+        #TODO remove the trailing '&' from url
+        url = params.inject("#{uri}?") do |_, (k, v)|
+          if v.is_a? Hash # Handle nesting of depth 1
+            _ << v.collect { |nested_k, nested_v| "#{k}[#{nested_k}]=#{nested_v}&" }.join
+          else
+            _ << "#{k}=#{v}&"
+          end
+        end
+        check_connection!
+        raw = @connection.access_token.send http_method, url
+        Response.new raw
+      end
+    end
+
+    [:post, :put].each do |http_method|
+      define_method(http_method) do |*args|
+        uri, params = args
+        params ||= {}
+        params = params.inject({}) do |_, (k, v)|
+          _[k.to_s] = v.to_s
+          _
+        end
+        check_connection!
+        raw = @connection.access_token.send http_method, uri, params
+        Response.new raw
+      end
+    end
+
+    define_method :upload do |*args|
+      uri, data, headers = args
+      raw = @connection.access_token.send :post, uri, data, headers
+    end
+
+    # TODO: find a better place to do this
+    def apply!
+      response = post '/apply'
+      response.success?
+    end
+
+    private
+    def check_connection!
+      raise ConnectionException.new unless @connection
+      raise OAuthException.new unless @connection.access_token
+    end
+  end
+
+  # TODO: validation errors are now stored in failure message's data...  we should figure out what to do with it
+  class Response
+    SUCCESS_RANGE = (200..399)
+
+    attr_reader :data, :status
+
+    def initialize(raw)
+      @status = raw.code.to_i
+      # TODO: if it's not a success code we probably shouldn't bother parsing the JSON
+      @data = JSON.parse raw.body
+    end
+
+    def [](key)
+      @data[key]
+    end
+
+    def success?
+      SUCCESS_RANGE.include? @status
+    end
+
+    def failure?
+      !success?
+    end
+  end
+
+  class ConnectionException < Exception
+    def initialize(msg = "No connection to RouteNGN established.")
+      super
+    end
+  end
+
+  class OAuthException < Exception
+    def initialize(msg = "Invalid RouteNGN OAuth credentials.")
+      super
+    end
+  end
+end

data/routengn.gemspec

@@ -0,0 +1,76 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{routengn}
+  s.version = "0.2.9"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Keith Larrimore", "Quin Hoxie"]
+  s.date = %q{2009-09-30}
+  s.default_executable = %q{ngncmd}
+  s.description = %q{RouteNGN is an Advanced SIP Redirect Routing Platform.}
+  s.email = %q{keithlarrimore+github@gmail.com}
+  s.executables = ["ngncmd"]
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "README.rdoc",
+     "bin/ngncmd",
+     "docs/RouteNGN-Gems-Install.doc",
+     "examples/cli.rb",
+     "examples/provision.rb",
+     "lib/routengn.rb",
+     "lib/routengn/console.rb",
+     "lib/routengn/http/multipart.rb",
+     "lib/routengn/mapper.rb",
+     "lib/routengn/models/carrier.rb",
+     "lib/routengn/models/dialcode.rb",
+     "lib/routengn/models/endpoint.rb",
+     "lib/routengn/models/group.rb",
+     "lib/routengn/models/instance.rb",
+     "lib/routengn/models/locale.rb",
+     "lib/routengn/models/rate.rb",
+     "lib/routengn/models/record.rb",
+     "lib/routengn/models/region.rb",
+     "lib/routengn/models/route.rb",
+     "lib/routengn/models/type.rb",
+     "lib/routengn/uploader.rb",
+     "routengn.gemspec",
+     "script/console"
+  ]
+  s.homepage = %q{http://github.com/klarrimore/routengn}
+  s.rdoc_options = ["--inline-source", "--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{RouteNGN is an Advanced SIP Redirect Routing Platform.}
+  s.test_files = [
+    "examples/provision.rb",
+     "examples/cli.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<mime-types>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<oauth>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<mime-types>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<oauth>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<mime-types>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<oauth>, [">= 0"])
+  end
+end

data/script/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+
+exec "#{irb} -I \"#{File.dirname(__FILE__)}/../lib\" -r \"routengn\" -I \"#{File.dirname(__FILE__)}/../lib/routengn\" -r \"console\" --simple-prompt"

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification 
+name: routengn
+version: !ruby/object:Gem::Version 
+  version: 0.2.9
+platform: ruby
+authors: 
+- Keith Larrimore
+- Quin Hoxie
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-30 00:00:00 -04:00
+default_executable: ngncmd
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: RouteNGN is an Advanced SIP Redirect Routing Platform.
+email: keithlarrimore+github@gmail.com
+executables: 
+- ngncmd
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- bin/ngncmd
+- docs/RouteNGN-Gems-Install.doc
+- examples/cli.rb
+- examples/provision.rb
+- lib/routengn.rb
+- lib/routengn/console.rb
+- lib/routengn/http/multipart.rb
+- lib/routengn/mapper.rb
+- lib/routengn/models/carrier.rb
+- lib/routengn/models/dialcode.rb
+- lib/routengn/models/endpoint.rb
+- lib/routengn/models/group.rb
+- lib/routengn/models/instance.rb
+- lib/routengn/models/locale.rb
+- lib/routengn/models/rate.rb
+- lib/routengn/models/record.rb
+- lib/routengn/models/region.rb
+- lib/routengn/models/route.rb
+- lib/routengn/models/type.rb
+- lib/routengn/uploader.rb
+- routengn.gemspec
+- script/console
+has_rdoc: true
+homepage: http://github.com/klarrimore/routengn
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: RouteNGN is an Advanced SIP Redirect Routing Platform.
+test_files: 
+- examples/provision.rb
+- examples/cli.rb