klarrimore-routengn 0.22 → 0.23

data/lib/http/multipart.rb

@@ -0,0 +1,80 @@
+# Takes a hash of string and file parameters and returns a string of text
+# formatted to be sent as a multipart form post.
+#
+# Author:: Cody Brimhall <mailto:cbrimhall@ucdavis.edu>
+# Created:: 22 Feb 2008
+
+require 'rubygems'
+require 'mime/types'
+require 'cgi'
+
+
+module Multipart
+	VERSION = "1.0.0" unless const_defined?(:VERSION)
+	
+	# Formats a given hash as a multipart form post
+	# If a hash value responds to :string or :read messages, then it is
+	# interpreted as a file and processed accordingly; otherwise, it is assumed
+	# to be a string
+	class Post
+		# We have to pretend like we're a web browser...
+		USERAGENT = "Mozilla/5.0 (Macintosh; U; PPC Mac OS X; en-us) AppleWebKit/523.10.6 (KHTML, like Gecko) Version/3.0.4 Safari/523.10.6" unless const_defined?(:USERAGENT)
+		BOUNDARY = "0123456789ABLEWASIEREISAWELBA9876543210" unless const_defined?(:BOUNDARY)
+		CONTENT_TYPE = "multipart/form-data; boundary=#{ BOUNDARY }" unless const_defined?(:CONTENT_TYPE)
+		HEADER = { "Content-Type" => CONTENT_TYPE, "User-Agent" => USERAGENT } unless const_defined?(:HEADER)
+		
+		def self.prepare_query(params)
+			fp = []
+			
+			params.each do |k, v|
+				# Are we trying to make a file parameter?
+				if v.respond_to?(:path) and v.respond_to?(:read) then
+					fp.push(FileParam.new(k, v.path, v.read))
+				# We must be trying to make a regular parameter
+				else
+					fp.push(StringParam.new(k, v))
+				end
+			end
+			
+			# Assemble the request body using the special multipart format
+			query = fp.collect {|p| "--" + BOUNDARY + "\r\n" + p.to_multipart }.join("")	+ "--" + BOUNDARY + "--"
+			return query, HEADER
+		end
+	end
+	
+	private
+	
+	# Formats a basic string key/value pair for inclusion with a multipart post
+	class StringParam
+		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"
+		end
+	end
+	
+	# Formats the contents of a file or string for inclusion with a multipart
+	# form post
+	class FileParam
+		attr_accessor :k, :filename, :content
+		
+		def initialize(k, filename, content)
+			@k = k
+			@filename = filename
+			@content = content
+		end
+		
+		def to_multipart
+			# If we can tell the possible mime-type from the filename, use the
+			# first in the list; otherwise, use "application/octet-stream"
+			mime_type = MIME::Types.type_for(filename)[0] || MIME::Types["application/octet-stream"][0]
+			return "Content-Disposition: form-data; name=\"#{CGI::escape(k)}\"; filename=\"#{ filename }\"\r\n" +
+						 "Content-Type: #{ mime_type.simplified }\r\n\r\n#{ content }\r\n"
+		end
+	end
+end

data/lib/routengn.rb

@@ -0,0 +1,108 @@
+require 'rubygems'
+gem 'oauth'
+require 'oauth/consumer'
+require 'json'
+require 'http/multipart'
+require 'routengn/mapper'
+require 'routengn/uploader'
+require 'active_support'
+
+module RouteNGN
+  Dir.glob(File.dirname(__FILE__) + "/routengn/models/*.rb").each do |model|
+    require File.expand_path(model)
+  end
+
+  class Connection
+    attr_accessor :access_token
+
+    def initialize(site, key, secret)
+      @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
+  end
+
+  class << self
+    def connect!(site, key, secret)
+      @connection = Connection.new site, key, secret
+    end
+
+    def connection
+      @connection
+    end
+
+    [:get, :delete].each do |http_method|
+      define_method(http_method) do |*args|
+        uri, params = args
+        params ||= {}
+        url = params.inject("#{uri}?") { |_, (k, v)| _ << "#{k}=#{v}" }
+        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
+
+    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/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/mapper.rb

@@ -0,0 +1,152 @@
+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] # TODO prevent multiple primaries
+        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}_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}_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
+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,9 @@
+class Instance
+  include RouteNGN::Mapper
+
+  field :id, :primary => true
+  field :name
+
+  belongs_to :type
+
+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
+end

data/lib/routengn/models/record.rb

@@ -0,0 +1,15 @@
+class Record
+  include RouteNGN::Mapper
+
+  field :dialcode, :primary => true
+  field :rn
+  field :locale_id
+  field :sent
+  field :received
+  field :detail
+  field :server
+  field :response_time 
+  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,5 @@
+class Route
+  include RouteNGN::Mapper
+
+  field :id, :primary => true
+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,16 @@
+module RouteNGN
+  module Uploader
+    def self.included(model)
+      model.class_eval do
+        extend ClassMethods
+      end
+    end
+  end
+
+  module ClassMethods
+    def upload
+      # STUB
+      puts "data, headers = Multipart::Post.prepare_query(\"title\" => 'title', \"uploaded_data\" => File.new(path))"  
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: klarrimore-routengn
 version: !ruby/object:Gem::Version 
-  version: "0.22"
+  version: "0.23"
 platform: ruby
 authors: 
 - Keith Larrimore
@@ -43,6 +43,25 @@ extra_rdoc_files: []
 files: 
 - README.rdoc
 - lib/
+- lib/routengn.rb
+- lib/http
+- lib/http/multipart.rb
+- lib/routengn
+- lib/routengn/uploader.rb
+- lib/routengn/console.rb
+- lib/routengn/models
+- lib/routengn/models/route.rb
+- lib/routengn/models/locale.rb
+- lib/routengn/models/endpoint.rb
+- lib/routengn/models/carrier.rb
+- lib/routengn/models/region.rb
+- lib/routengn/models/rate.rb
+- lib/routengn/models/dialcode.rb
+- lib/routengn/models/instance.rb
+- lib/routengn/models/record.rb
+- lib/routengn/models/group.rb
+- lib/routengn/models/type.rb
+- lib/routengn/mapper.rb
 has_rdoc: false
 homepage: http://github.com/mojombo/grit
 licenses: