forest-client 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 90a20be4c22f75bed4993a231b0a15e45fca7591
+  data.tar.gz: f5cfd6a1f9948f0825bd65a9bd35e8df3b12c82f
+SHA512:
+  metadata.gz: 5f1f587926f51400ae690347c0a0887bfaf9f3260916ae3a8913bf6dcab7fbecde067af13c781149149061961e5089c2ce776d7ce419872fd54fa1893f8b9fd7
+  data.tar.gz: 1bc693424fe77dfe9401e97e0cdbe0e58ddf71ec4bebe86ed2f41c6875acded1fa9afccacd06ff0935f30b9fc7671873281925a7747c22fa70e3fb738eedcdd8

data/lib/forest-client/printer.rb

@@ -0,0 +1,199 @@
+require 'forest-client'
+require 'snmp'
+
+module ForestClient
+    class Printer
+        
+        # Create a new instance of Printer by passing its IP address
+        def initialize(ip)
+            @ip = ip
+        end
+
+        # Return the IP address of the printer
+        def get_ip
+            return @ip
+        end
+
+        # Get the value of an SNMP OID
+        def snmp_get(oid)
+            SNMP::Manager.open(:host => @ip) do |manager|
+                query = SNMP::ObjectId.new(oid)
+                response = manager.get(query)
+                response.each_varbind do |res|
+                    return res.value
+                end
+            end
+        end
+
+        # Walk the SNMP tree starting at the given OID
+        def snmp_walk(oid)
+            SNMP::Manager.open(:host => @ip) do |manager|
+                query = SNMP::ObjectId.new(oid)
+                ret = Array.new
+                manager.walk(oid) { |vb| ret.push(vb.value) }
+                return ret
+            end
+        end
+
+        # Query the printer for its model number
+        def get_model
+            return snmp_get('1.3.6.1.2.1.25.3.2.1.3.1')
+        end
+
+        # Query the printer for its serial
+        def get_serial
+            return snmp_walk('1.3.6.1.2.1.43.5.1.1.17').at(0)
+        end
+
+        # Query the printer for its message
+        def get_messages
+            return snmp_walk('1.3.6.1.2.1.43.18.1.1.8').at(0)
+        end
+
+        # Query the printer for its pagecount
+        def get_page_count
+            return Integer(snmp_get('1.3.6.1.2.1.43.10.2.1.4.1.1'))
+        end
+
+        # Query the printer for its display
+        def get_display
+            return snmp_walk('1.3.6.1.2.1.43.16.5.1.2.1').at(0)
+        end
+
+        # Query the printer for its status
+        # The printer will return an integer which we convert
+        # into a meaninful string
+        def get_status
+            case snmp_get('1.3.6.1.2.1.25.3.5.1.1.1')
+            when 1
+                return 'Other'
+            when 3
+                return 'Idle'
+            when 4
+                return 'Printing'
+            when 5
+                return 'Warmup'
+            else
+                return 'Unknown'
+            end
+        end
+
+        # Returns an array of all device IDs
+        def get_device_ids
+            return snmp_walk('1.3.6.1.2.1.25.3.2.1.1')
+        end
+
+        # Returns the name and status of the specified device as a hash
+        def get_device(id)
+            
+            # Get the device name
+            name = snmp_get("1.3.6.1.2.1.25.3.2.1.3.#{id}")
+            
+            # Make the status human-readable
+            case snmp_get("1.3.6.1.2.1.25.3.2.1.5.#{id}")
+            when 1
+                status = 'Unknown'
+            when 2
+                status = 'Running'
+            when 3
+                status = 'Warning'
+            when 4
+                status = 'Testing'
+            when 5
+                status = 'Down'
+            else
+                status = 'Unknown'
+            end
+
+            return {:name => name, :status => status}
+        end
+
+        # Returns an array of the results of get_device_status for all of the
+        # printer's devices
+        def get_devices
+            devices = get_device_ids
+            ret = Array.new
+            devices.each do |device|
+                ret.push(get_device(device))
+            end
+            return ret
+        end
+
+        def get_consumable(id)
+            color = snmp_get("1.3.6.1.2.1.43.12.1.1.4.1.#{id}").to_s
+            level = Integer(snmp_get("1.3.6.1.2.1.43.11.1.1.9.1.#{id}"))
+            capacity = Integer(snmp_get("1.3.6.1.2.1.43.11.1.1.8.1.#{id}"))
+            percentage = Float(level) * 100 / Float(capacity)
+            return {:color => color,
+                :level => level,
+                :capacity => capacity,
+                :percentage => percentage}
+        end
+
+        def get_consumable_names
+            return snmp_walk('1.3.6.1.2.1.43.11.1.1.6.1').each { |item| item.chop! }
+        end
+
+        def get_consumables
+            consumables = get_consumable_names
+
+            ret = Array.new
+
+            consumables.length.times do |id|
+                cons = get_consumable(id + 1)
+                cons[:name] = consumables.at(id)
+                ret.push(cons)
+            end
+
+            return ret
+        end
+
+        def get_trays
+            trays = Array.new
+            snmp_walk('1.3.6.1.2.1.43.8.2.1.10.1').length.times do |id|
+                tray = id + 1
+                name = snmp_get("1.3.6.1.2.1.43.8.2.1.13.1.#{tray}")
+
+                rem = snmp_get("1.3.6.1.2.1.43.8.2.1.10.1.#{tray}")
+                case rem
+                when -3
+                    status = 'OK'
+                when -2
+                    status = 'Unknown'
+                when 0
+                    status = 'Empty'
+                else
+                    status = "#{rem} sheets remaining"
+                end
+
+                feed_dim = snmp_get("1.3.6.1.2.1.43.8.2.1.4.1.#{tray}")
+                xfeed_dim = snmp_get("1.3.6.1.2.1.43.8.2.1.5.1.#{tray}")
+                dim_units = snmp_get("1.3.6.1.2.1.43.8.2.1.3.1.#{tray}")
+
+                if Integer(dim_units) == 3
+                    feed_dim = Float(feed_dim) / 10000
+                    xfeed_dim = Float(xfeed_dim) / 10000
+                elsif Integer(dim_units) == 4
+                    feed_dim = Float(feed_dim) * 0.0000393700787
+                    xfeed_dim = Float(xfeed_dim) * 0.0000393700787
+                end
+
+                capacity = Integer(snmp_get("1.3.6.1.2.1.43.8.2.1.9.1.#{tray}"))
+
+                trays.push({:name => name, :status => status, :y => feed_dim, :x => xfeed_dim, :capacity => capacity})
+            end
+
+            return trays
+        end
+
+        def get_location
+            return snmp_get('1.3.6.1.2.1.1.6.0')
+        end
+
+        def get_name
+            return snmp_get('1.3.6.1.2.1.1.5.0')
+        end
+
+        private :snmp_get, :snmp_walk
+    end
+end

data/lib/forest-client.rb

@@ -0,0 +1,103 @@
+require 'json'
+require 'net/http'
+require 'uri'
+require 'forest-client/printer'
+
+module ForestClient
+    class Forest
+
+        def api_call(url)
+            url = "https://forest-api.herokuapp.com/api/#{url}"
+            url = URI.escape(url)
+            url = URI.parse(url)
+            content = Net::HTTP.get(url)
+            return JSON.parse(content)
+        end
+
+        def initialize(org_id)
+            @org_id = org_id
+        end
+
+        def get_printers
+            url = "printerList?organizationId=#{@org_id}"
+            printers = api_call(url)
+            return printers['printers']
+        end
+
+        def get_printer(id)
+            url = "printerGet?organizationId=#{@org_id}&printerId=#{id}"
+            printer = api_call(url)
+            return printer
+        end
+
+        def update_printer(printer)
+            id = printer['id']
+            ip = printer['ipAddress']
+
+            p = Printer.new(ip)
+            url = 'printerUpdate'
+            url += '?printerId=' + id
+            url += '&model=' + p.get_model
+            url += '&location=' + p.get_location
+            url += '&serial=' + p.get_serial
+            api_call(url)
+            return
+        end
+
+        def update_status(printer)
+            id = printer['id']
+            ip = printer['ipAddress']
+            p = Printer.new(ip)
+
+            url = 'statusCreate'
+            url += '?printerId=' + id
+            url += '&status=' + p.get_status
+            url += '&pageCount=' + p.get_page_count.to_s
+
+            trays = Array.new
+
+            p.get_trays.each { |tray|
+                trays.push({
+                    'name' => tray[:name],
+                    'xdim' => tray[:x],
+                    'ydim' => tray[:y],
+                    'capacity' => tray[:capacity]})
+            }
+
+            url += '&trays=' + trays.to_s.gsub!('=>', ':')
+
+            consumables = Array.new
+
+            p.get_consumables.each { |cons|
+                consumables.push({
+                    'name' => cons[:name],
+                    'level' => cons[:level],
+                    'capacity' => cons[:capacity],
+                    'percentage' => cons[:percentage]
+                    })
+            }
+
+            url += '&consumables=' + consumables.to_s.gsub!('=>', ':')
+
+            api_call url
+        end
+
+    end
+
+    class QueryAgent
+
+        def initialize(org_id)
+            @org_id = org_id
+        end
+
+        def run
+            forest = Forest.new(@org_id)
+
+            printers = forest.get_printers
+            printers.each do |printer|    
+                forest.update_printer(printer)
+                forest.update_status(printer)
+            end
+        end
+    end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: forest-client
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+platform: ruby
+authors:
+- Ben Burwell
+- Andrew Trautman
+- Macauley Breault
+- Mike Borowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-15 00:00:00.000000000 Z
+dependencies: []
+description: The LAN printer query agent for the Forest printer management system.
+email: printer.fungineers@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/forest-client.rb
+- lib/forest-client/printer.rb
+homepage: https://github.com/printerSystemCSI210
+licenses:
+- Unknown
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Forest Printer Management Query Agent
+test_files: []