switchvoxFix 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d01113df5ddc4d4075d53c4df153c38c741795c
-  data.tar.gz: a009db4e203fcc92c028d62c3def9ee236ba180d
+  metadata.gz: 2c75f4b5a22db8e34414ddf7838a6050bcd7370a
+  data.tar.gz: a0ede2a6ff9eead761b10a4b2e1dc661fc72b7a9
 SHA512:
-  metadata.gz: c587468b85cfcf57b5f34cd319b162f57e6e6f2bd915f89af7b72168248dc587e1592e2f6876067dee3cd4835687ca124e636ca0becf84a653a03cd16ae66d33
-  data.tar.gz: 5bebde59c6a0357b10904dd00d315adfb283689657af11aa77acab7872e1068a78eafe4b6db97df613f53c76f84837dae3d073ce86d4c67ef8f8819d2429a179
+  metadata.gz: 64f4649f231ed26e4c6eab1b359c6cf7594dcb77cf006fb742334ba904a5f731958d694094ccc2659bd25064e56bd2c086119ede723852c32f7068844ec28f2f
+  data.tar.gz: 8a73aa06bf1cede51956da3f74307989d9deb8f6a1c25e63d1e109e04b40247e5246ff2b5ffa40d0d136a67e12c9c11f6fba7af4a0243fac6ce77f43f4a92aed

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-04-22
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,16 @@
+History.txt
+Manifest.txt
+README.md
+Rakefile
+lib/switchvoxFix.rb
+lib/switchvoxFix/array.rb
+lib/switchvoxFix/base.rb
+lib/switchvoxFix/hash.rb
+lib/switchvoxFix/net_http_digest_auth.rb
+lib/switchvoxFix/object.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_json_to_obj.rb
+test/test_switchvox.rb

data/lib/switchvoxFix.rb

@@ -8,5 +8,5 @@ require 'switchvoxFix/net_http_digest_auth'
 require 'switchvoxFix/base'
 
 module SwitchvoxFix
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 end

data/lib/switchvoxFix/array.rb

@@ -0,0 +1,14 @@
+# A fancy way of iterating over an array and converting hashes to objects
+class Array
+  def to_obj
+    # Make a deep copy of the array
+    a = Marshal.load(Marshal.dump(self))
+    a.each do |i|
+      case i.class.to_s
+        when "Hash" then i = i.to_obj
+        when "Array" then i = i.to_obj
+      end
+    end
+    a
+  end
+end

data/lib/switchvoxFix/base.rb

@@ -0,0 +1,146 @@
+#! /usr/bin/env ruby
+
+module SwitchvoxFix
+
+require 'uri'
+require 'net/https'
+require 'openssl'
+require 'digest/md5'
+require 'rubygems'
+require 'json'
+
+# Raised when credentials are incorrect
+class LoginError < RuntimeError
+end
+
+# Raised when the response.body is empty
+class EmptyResponse < RuntimeError
+end
+
+# Raised when a response is returned that we don't know how to handle
+class UnhandledResponse < RuntimeError
+end
+
+# The primary class used to interact with Switchvox.
+class Base 
+
+  URL = "/json"
+  attr :host, true
+  attr :url, true
+  attr :user, false
+  attr :pass, false
+  attr :connection, true
+  attr :session, true
+  attr :debug, true
+  attr :auth_header, true
+
+  def initialize(host, user, pass, port, options={})
+    {:debug => false}.merge! options
+    @debug = options[:debug]
+
+    @host = host
+    @user = user
+    @pass = pass
+    @url  = URI.parse("https://" + @host + URL)
+    @url.port = port
+   
+    @ssl  = true 
+        
+    @connection  = false
+    @auth_header = false
+    login!
+    raise LoginError, "Invalid Username or Password" unless logged_in?
+  end
+
+  # A standard REST call to get a list of entries
+  def request(method, parameters={})
+    login! unless logged_in?
+    json = wrap_json(method, parameters)
+    
+    # Send the request
+    header   = {'Content-Type' => "application/json"}
+    request  = Net::HTTP::Post.new(@url.path, header)
+    request.digest_auth(@user, @pass, @auth_header)
+    request.body = json
+    response = @connection.request(request)
+
+    if @debug
+      puts "#{method}: Request"
+      puts json
+      puts "\n"
+    end
+
+    case response
+      when Net::HTTPOK
+        raise EmptyResponse unless response.body
+        response_json = JSON.parse response.body
+        if @debug
+          puts "#{method}: Response:"
+          pp response_json 
+          puts "\n\n"
+        end
+        response_obj = response_json["response"]["result"].to_obj
+        return response_obj
+      when Net::HTTPUnauthorized
+        login!
+        request(method, parameters)
+      when Net::HTTPForbidden
+        raise LoginError, "Invalid Username or Password" 
+      else raise UnhandledResponse, "Can't handle response #{response}"
+    end
+  end
+
+  protected
+
+    # Check to see if we are logged in
+    def logged_in?
+      return false unless @auth_header
+      true
+    end
+  
+    # Attempt HTTP Digest Authentication with Switchvox
+    def login!
+      connect! unless connected?
+      @auth_header = @connection.head(@url.path)
+    end
+
+    # Check to see if we have an HTTP/S Connection
+    def connected?
+      return false unless @connection
+      return false unless @connection.started?
+      true
+    end
+
+    # Connect to the remote Switchvox system.  If SSL is enabled, ignore certificate checking.
+    def connect!
+      @connection = Net::HTTP.new(@url.host, @url.port)
+      if @ssl
+        @connection.use_ssl = true
+        @connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      if @debug
+        #@connection.set_debug_output $stderr
+      end
+      @connection.start
+    end
+
+    # Wrap a JSON method and parameters in a Switchvox compatible request body.
+    def wrap_json(method, parameters={})
+      json = <<-"EOF"
+        {
+          \"request\": {
+            \"method\": \"#{method}\",
+            \"parameters\": #{parameters.to_json}
+          }
+        }
+      EOF
+      json.gsub!(/^\s{8}/,'')
+    end
+
+end
+  
+end
+
+
+
+

data/lib/switchvoxFix/hash.rb

@@ -0,0 +1,17 @@
+# A fancy way of iterating over a hash and converting hashes to objects
+class Hash
+  def to_obj
+    o = Object.new
+    self.each do |k,v|
+      # If we're looking at a hash or array, we need to look through them and convert any hashes to objects as well
+      case v.class.to_s
+        when "Hash"  then v = v.to_obj
+        when "Array" then v = v.to_obj
+      end
+      o.instance_variable_set("@#{k}", v)  ## create and initialize an instance variable for this key/value pair
+      o.class.send(:define_method, k, proc{o.instance_variable_get("@#{k}")})  ## create the getter that returns the instance variable
+      o.class.send(:define_method, "#{k}=", proc{|v| o.instance_variable_set("@#{k}", v)})  ## create the setter that sets the instance variable
+    end
+    o
+  end
+end

data/lib/switchvoxFix/net_http_digest_auth.rb

@@ -0,0 +1,34 @@
+module Net
+  module HTTPHeader
+    require 'digest/md5'
+    require 'net/http'
+    
+    @@nonce_count = -1
+    CNONCE = Digest::MD5.new.update("%x" % (Time.now.to_i + rand(65535))).hexdigest
+    def digest_auth(user, password, response)
+      # based on http://segment7.net/projects/ruby/snippets/digest_auth.rb
+      @@nonce_count += 1
+
+      response['www-authenticate'] =~ /^(\w+) (.*)/
+
+      params = {}
+      $2.gsub(/(\w+)="(.*?)"/) { params[$1] = $2 }
+
+      a_1 = "#{user}:#{params['realm']}:#{password}"
+      a_2 = "#{@method}:#{@path}"
+      request_digest = ''
+      request_digest << Digest::MD5.new.update(a_1).hexdigest
+      request_digest << ':' << params['nonce']
+      request_digest << ':' << Digest::MD5.new.update(a_2).hexdigest
+
+      header = []
+      header << "Digest username=\"#{user}\""
+      header << "realm=\"#{params['realm']}\""
+      header << "uri=\"#{@path}\""
+      header << "nonce=\"#{params['nonce']}\""
+      header << "response=\"#{Digest::MD5.new.update(request_digest).hexdigest}\""
+
+      @header['Authorization'] = header
+    end
+  end
+end

data/lib/switchvoxFix/object.rb

@@ -0,0 +1,5 @@
+class Object
+  def to_obj
+    self
+  end
+end

data/lib/switchvoxFix/version.rb

@@ -1,3 +1,3 @@
 module SwitchvoxFix
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/switchvoxFix.rb'}"
+puts "Loading switchvoxFix gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: switchvoxFix
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Mitchell Thompson
@@ -48,13 +48,23 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- History.txt
 - LICENSE.txt
+- Manifest.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/switchvoxFix.rb
+- lib/switchvoxFix/array.rb
+- lib/switchvoxFix/base.rb
+- lib/switchvoxFix/hash.rb
+- lib/switchvoxFix/net_http_digest_auth.rb
+- lib/switchvoxFix/object.rb
 - lib/switchvoxFix/version.rb
+- script/console
+- script/destroy
+- script/generate
 - switchvoxFix.gemspec
 homepage: https://github.com/wrenchell/switchvoxFix
 licenses: